GET api/OuterGateAgencyService/GetAgencyReportDraft?membershipEmail={membershipEmail}&startDate={startDate}&endDate={endDate}

Ritorna il rendiconto per agenzia di tutte le transazioni in bozza, dato l'id della agenzia, l'operatore ed eventualmente dell'intervallo temporale definito dal StartDate e EndDate. Esempio di chiamate valide al metodo API: [api/OuterGate/GetAgencyReportDraft] -> ritorna la rendicontazione in funzione dell'agenzia [api/OuterGate/GetAgencyReportDraft?membershipUserName=admin@nomail.com] -> ritorna la rendicontazione in funzione dell'agenzia e dell'operatore [api/OuterGate/GetAgencyReportDraft?membershipUserName=admin@nomail.com&startDate=2019-10-24&endDate=2019-10-25] -> ritorna la rendicontazione in funzione dell'agenzia, dell'operatore e dell'intervallo di tempo [startDate, endDate] con startDate minore uguale a endDate entrambe diversi da null [api/OuterGate/GetAgencyReportDraft?startDate=2019-10-24&endDate=2019-10-25] -> ritorna la rendicontazione in funzione dell'agenzia e dell'intervallo di tempo [startDate, endDate] con startDate minore uguale a endDate entrambe diverse da null Le date passate devono rispettare il formato ISO-8601 es. 2019-10-25 (AAAA-MM-GG) rif. https://en.wikipedia.org/wiki/ISO_8601 . Questo metodo non potrà mostrare il profitto del punto operativo in quanto le transazioni ritornate non sono state ancora rendicontate.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
membershipEmail

indirizzo email o username dell'operatore che ha eseguito i pagamenti

string

None.

startDate

filtro per data di inizio

date time

None.

endDate

filtro per data di fine

date time

None.

Body Parameters

None.

Response Information

Resource Description

Collection of OuterAgencyReportDraftModelOut
NameDescriptionTypeAdditional information
GroupName

Nome del raggruppamento

string

None.

UserNameOperator

Username dell'operatore che ha eseguito i pagamenti

string

None.

AgencyId

Id dell'agenzia

integer

None.

AgencyDenomination

Denominazione del Punto

string

None.

TypeOfBulletin

Tipologia di servizio di pagamento

TypesOfBulletin

None.

TypesOfBulletinDesc

Tipologia di servizio di pagamento in formato descrittivo

string

None.

PaymentType

Tipo di pagamento, contanti, POS

PaymentType

None.

PaymentTypeDesc

Tipo di pagamento in formato descrittivo

string

None.

PaymentsNumber

Numero totale di pagamenti

integer

None.

PaymentsGrandTotal

Ammontare totale netto dei pagamenti

decimal number

None.

FeesGrandTotal

Ammontare totale delle commissioni addebitate al punto operativo

decimal number

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "GroupName": "sample string 1",
    "UserNameOperator": "sample string 2",
    "AgencyId": 3,
    "AgencyDenomination": "sample string 4",
    "TypeOfBulletin": 0,
    "TypesOfBulletinDesc": "MAV",
    "PaymentType": 0,
    "PaymentTypeDesc": "Contanti",
    "PaymentsNumber": 5,
    "PaymentsGrandTotal": 6.0,
    "FeesGrandTotal": 7.0
  },
  {
    "GroupName": "sample string 1",
    "UserNameOperator": "sample string 2",
    "AgencyId": 3,
    "AgencyDenomination": "sample string 4",
    "TypeOfBulletin": 0,
    "TypesOfBulletinDesc": "MAV",
    "PaymentType": 0,
    "PaymentTypeDesc": "Contanti",
    "PaymentsNumber": 5,
    "PaymentsGrandTotal": 6.0,
    "FeesGrandTotal": 7.0
  }
]

application/xml, text/xml

Sample:
<ArrayOfOuterAgencyReportDraftModelOut xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/tocode.Sepafin.Api.OuterModels">
  <OuterAgencyReportDraftModelOut>
    <AgencyDenomination>sample string 4</AgencyDenomination>
    <AgencyId>3</AgencyId>
    <FeesGrandTotal>7</FeesGrandTotal>
    <GroupName>sample string 1</GroupName>
    <PaymentType>Cash</PaymentType>
    <PaymentsGrandTotal>6</PaymentsGrandTotal>
    <PaymentsNumber>5</PaymentsNumber>
    <TypeOfBulletin>Mav</TypeOfBulletin>
    <UserNameOperator>sample string 2</UserNameOperator>
  </OuterAgencyReportDraftModelOut>
  <OuterAgencyReportDraftModelOut>
    <AgencyDenomination>sample string 4</AgencyDenomination>
    <AgencyId>3</AgencyId>
    <FeesGrandTotal>7</FeesGrandTotal>
    <GroupName>sample string 1</GroupName>
    <PaymentType>Cash</PaymentType>
    <PaymentsGrandTotal>6</PaymentsGrandTotal>
    <PaymentsNumber>5</PaymentsNumber>
    <TypeOfBulletin>Mav</TypeOfBulletin>
    <UserNameOperator>sample string 2</UserNameOperator>
  </OuterAgencyReportDraftModelOut>
</ArrayOfOuterAgencyReportDraftModelOut>