GET api/OuterGateAgencyService/GetAgencyReport?membershipEmail={membershipEmail}&startDate={startDate}&endDate={endDate}
Ritorna il rendiconto per agenzia 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/GetAgencyReport] -> ritorna la rendicontazione in funzione dell'agenzia [api/OuterGate/GetAgencyReport?membershipEmail=admin@nomail.com] -> ritorna la rendicontazione in funzione dell'agenzia e dell'operatore [api/OuterGate/GetAgencyReport?membershipEmail=admin@nomail.com&startDate=2000-05-25&endDate=2017-05-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/GetAgencyReport?startDate=2000-05-25&endDate=2017-05-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. 2017-05-23 (AAAA-MM-GG) rif. https://en.wikipedia.org/wiki/ISO_8601
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
membershipEmail |
indirizzo email 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 OuterAgencyReportModelOutName | Description | Type | Additional information |
---|---|---|---|
GroupName |
Denominazione |
string |
None. |
AgencyId |
Id dell'agenzia |
integer |
None. |
BulletinType |
Tipo di bollettino, MAV, RAV, bollettino, PagoPa, bollo, Servizio scolastico, ricariche telefoniche |
string |
None. |
PaymentType |
Tipo di pagamento, contanti, POS |
PaymentType |
None. |
PaymentsNumber |
Numero totale di pagamenti |
integer |
None. |
PaymentsGrandTotal |
Ammontare totale dei pagamenti |
decimal number |
None. |
FeesGrandTotal |
Ammontare totale delle fee |
decimal number |
None. |
Response Formats
application/json, text/json
[ { "GroupName": "sample string 1", "AgencyId": 2, "BulletinType": "sample string 3", "PaymentType": 0, "PaymentsNumber": 4, "PaymentsGrandTotal": 5.0, "FeesGrandTotal": 6.0 }, { "GroupName": "sample string 1", "AgencyId": 2, "BulletinType": "sample string 3", "PaymentType": 0, "PaymentsNumber": 4, "PaymentsGrandTotal": 5.0, "FeesGrandTotal": 6.0 } ]
application/xml, text/xml
<ArrayOfOuterAgencyReportModelOut xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/tocode.Sepafin.Api.OuterModels"> <OuterAgencyReportModelOut> <AgencyId>2</AgencyId> <BulletinType>sample string 3</BulletinType> <FeesGrandTotal>6</FeesGrandTotal> <GroupName>sample string 1</GroupName> <PaymentType>Cash</PaymentType> <PaymentsGrandTotal>5</PaymentsGrandTotal> <PaymentsNumber>4</PaymentsNumber> </OuterAgencyReportModelOut> <OuterAgencyReportModelOut> <AgencyId>2</AgencyId> <BulletinType>sample string 3</BulletinType> <FeesGrandTotal>6</FeesGrandTotal> <GroupName>sample string 1</GroupName> <PaymentType>Cash</PaymentType> <PaymentsGrandTotal>5</PaymentsGrandTotal> <PaymentsNumber>4</PaymentsNumber> </OuterAgencyReportModelOut> </ArrayOfOuterAgencyReportModelOut>