POST api/V3/RetailerCollection/RetailerLedger/list

API can be used to fetch Outlet wise payment details.

Request Information

URI Parameters

None.

Body Parameters

Collection of string

Request Formats

application/json, text/json

Sample: 
[
  "sample string 1",
  "sample string 2"
]

application/xml, text/xml

Sample: 
<ArrayOfstring xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
  <string>sample string 1</string>
  <string>sample string 2</string>
</ArrayOfstring>

Response Information

Resource Description

Collection of RetailerLedger
NameDescriptionTypeAdditional information
OutletERPId

ERPId of outlet

 string

None.
TotalInvoiceAmount

Total invoice amount(considering only those invoices which has some outstanding amount)

 string

None.
TotalOutstandingAmount

Total outstanding amount of all invoices

 string

None.
NoOfPendingInvoice

No of invoices for which there is non-zero outstanding amount

 string

None.
OldestPendingInvoice

Creation date of oldest pending invoice

 date

None.
BeatERPId

ERP id of the beat in which outlet is located

 string

None.

Response Formats

application/json, text/json

Sample: 
[
  {
    "OutletERPId": "sample string 1",
    "TotalInvoiceAmount": "sample string 2",
    "TotalOutstandingAmount": "sample string 3",
    "NoOfPendingInvoice": "sample string 4",
    "OldestPendingInvoice": "2025-04-27T12:32:04.4806418+00:00",
    "BeatERPId": "sample string 6"
  },
  {
    "OutletERPId": "sample string 1",
    "TotalInvoiceAmount": "sample string 2",
    "TotalOutstandingAmount": "sample string 3",
    "NoOfPendingInvoice": "sample string 4",
    "OldestPendingInvoice": "2025-04-27T12:32:04.4806418+00:00",
    "BeatERPId": "sample string 6"
  }
]

application/xml, text/xml

Sample: 
<ArrayOfRetailerLedger xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ExternalApis.Models.V3">
  <RetailerLedger>
    <BeatERPId>sample string 6</BeatERPId>
    <NoOfPendingInvoice>sample string 4</NoOfPendingInvoice>
    <OldestPendingInvoice>2025-04-27T12:32:04.4806418+00:00</OldestPendingInvoice>
    <OutletERPId>sample string 1</OutletERPId>
    <TotalInvoiceAmount>sample string 2</TotalInvoiceAmount>
    <TotalOutstandingAmount>sample string 3</TotalOutstandingAmount>
  </RetailerLedger>
  <RetailerLedger>
    <BeatERPId>sample string 6</BeatERPId>
    <NoOfPendingInvoice>sample string 4</NoOfPendingInvoice>
    <OldestPendingInvoice>2025-04-27T12:32:04.4806418+00:00</OldestPendingInvoice>
    <OutletERPId>sample string 1</OutletERPId>
    <TotalInvoiceAmount>sample string 2</TotalInvoiceAmount>
    <TotalOutstandingAmount>sample string 3</TotalOutstandingAmount>
  </RetailerLedger>
</ArrayOfRetailerLedger>