POST api/V3/Payment/UploadLedgers

Upload Ledgers (Max 2000 records can be updated in one request)

Request Information

URI Parameters

None.

Body Parameters

Ledgers to be uploaded

Collection of V3.OutletPayments
NameDescriptionTypeAdditional information
OutletERPId

SAP or ERP id of the outlet/customer

 string

Required

String length: inclusive between 5 and 50
OutstandingAmount

decimal number

None.
OverdueAmount

decimal number

None.
Ageing

integer

None.
CreditLimit

decimal number

None.
ShippableCreditLimit

decimal number

None.
CashDiscountAvailable

decimal number

None.
LastYearTillDateSales

decimal number

None.
YearTillDateSales

decimal number

None.
LastYearTotalSales

decimal number

None.
Invoices

Collection of V3.Invoice

None.

Request Formats

application/json, text/json

Sample: 
[
  {
    "OutletERPId": "sample string 1",
    "OutstandingAmount": 1.0,
    "OverdueAmount": 1.0,
    "Ageing": 1,
    "CreditLimit": 1.0,
    "ShippableCreditLimit": 1.0,
    "CashDiscountAvailable": 1.0,
    "LastYearTillDateSales": 1.0,
    "YearTillDateSales": 1.0,
    "LastYearTotalSales": 1.0,
    "Invoices": [
      {
        "InvoiceDate": "2026-01-07T07:09:15.1153821+00:00",
        "DueDate": "2026-01-07T07:09:15.1153821+00:00",
        "InvoiceId": "sample string 2",
        "InvoiceAmount": 3.0,
        "AmountOutstanding": 1.0,
        "Aging": 1,
        "Description": "sample string 4"
      },
      {
        "InvoiceDate": "2026-01-07T07:09:15.1153821+00:00",
        "DueDate": "2026-01-07T07:09:15.1153821+00:00",
        "InvoiceId": "sample string 2",
        "InvoiceAmount": 3.0,
        "AmountOutstanding": 1.0,
        "Aging": 1,
        "Description": "sample string 4"
      }
    ]
  },
  {
    "OutletERPId": "sample string 1",
    "OutstandingAmount": 1.0,
    "OverdueAmount": 1.0,
    "Ageing": 1,
    "CreditLimit": 1.0,
    "ShippableCreditLimit": 1.0,
    "CashDiscountAvailable": 1.0,
    "LastYearTillDateSales": 1.0,
    "YearTillDateSales": 1.0,
    "LastYearTotalSales": 1.0,
    "Invoices": [
      {
        "InvoiceDate": "2026-01-07T07:09:15.1153821+00:00",
        "DueDate": "2026-01-07T07:09:15.1153821+00:00",
        "InvoiceId": "sample string 2",
        "InvoiceAmount": 3.0,
        "AmountOutstanding": 1.0,
        "Aging": 1,
        "Description": "sample string 4"
      },
      {
        "InvoiceDate": "2026-01-07T07:09:15.1153821+00:00",
        "DueDate": "2026-01-07T07:09:15.1153821+00:00",
        "InvoiceId": "sample string 2",
        "InvoiceAmount": 3.0,
        "AmountOutstanding": 1.0,
        "Aging": 1,
        "Description": "sample string 4"
      }
    ]
  }
]

application/xml, text/xml

Sample: 
<ArrayOfOutletPayments xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ExternalApis.V3.Models">
  <OutletPayments>
    <Ageing>1</Ageing>
    <CashDiscountAvailable>1</CashDiscountAvailable>
    <CreditLimit>1</CreditLimit>
    <Invoices>
      <Invoice>
        <Aging>1</Aging>
        <AmountOutstanding>1</AmountOutstanding>
        <Description>sample string 4</Description>
        <DueDate>2026-01-07T07:09:15.1153821+00:00</DueDate>
        <InvoiceAmount>3</InvoiceAmount>
        <InvoiceDate>2026-01-07T07:09:15.1153821+00:00</InvoiceDate>
        <InvoiceId>sample string 2</InvoiceId>
      </Invoice>
      <Invoice>
        <Aging>1</Aging>
        <AmountOutstanding>1</AmountOutstanding>
        <Description>sample string 4</Description>
        <DueDate>2026-01-07T07:09:15.1153821+00:00</DueDate>
        <InvoiceAmount>3</InvoiceAmount>
        <InvoiceDate>2026-01-07T07:09:15.1153821+00:00</InvoiceDate>
        <InvoiceId>sample string 2</InvoiceId>
      </Invoice>
    </Invoices>
    <LastYearTillDateSales>1</LastYearTillDateSales>
    <LastYearTotalSales>1</LastYearTotalSales>
    <OutletERPId>sample string 1</OutletERPId>
    <OutstandingAmount>1</OutstandingAmount>
    <OverdueAmount>1</OverdueAmount>
    <ShippableCreditLimit>1</ShippableCreditLimit>
    <YearTillDateSales>1</YearTillDateSales>
  </OutletPayments>
  <OutletPayments>
    <Ageing>1</Ageing>
    <CashDiscountAvailable>1</CashDiscountAvailable>
    <CreditLimit>1</CreditLimit>
    <Invoices>
      <Invoice>
        <Aging>1</Aging>
        <AmountOutstanding>1</AmountOutstanding>
        <Description>sample string 4</Description>
        <DueDate>2026-01-07T07:09:15.1153821+00:00</DueDate>
        <InvoiceAmount>3</InvoiceAmount>
        <InvoiceDate>2026-01-07T07:09:15.1153821+00:00</InvoiceDate>
        <InvoiceId>sample string 2</InvoiceId>
      </Invoice>
      <Invoice>
        <Aging>1</Aging>
        <AmountOutstanding>1</AmountOutstanding>
        <Description>sample string 4</Description>
        <DueDate>2026-01-07T07:09:15.1153821+00:00</DueDate>
        <InvoiceAmount>3</InvoiceAmount>
        <InvoiceDate>2026-01-07T07:09:15.1153821+00:00</InvoiceDate>
        <InvoiceId>sample string 2</InvoiceId>
      </Invoice>
    </Invoices>
    <LastYearTillDateSales>1</LastYearTillDateSales>
    <LastYearTotalSales>1</LastYearTotalSales>
    <OutletERPId>sample string 1</OutletERPId>
    <OutstandingAmount>1</OutstandingAmount>
    <OverdueAmount>1</OverdueAmount>
    <ShippableCreditLimit>1</ShippableCreditLimit>
    <YearTillDateSales>1</YearTillDateSales>
  </OutletPayments>
</ArrayOfOutletPayments>

Response Information

Resource Description

ApiResponse
NameDescriptionTypeAdditional information
Message

Message Indicating the Overall Response Summary of the Requested API

 string

None.
ResponseList

List of Errors

 Collection of ApiResponseMessage

None.
Response

Enum Indicating the Response status

 ResponseStatus

None.
ResponseStatusCount

Summary containing Number of SuccessFull And Failed Tasks

 ResponseStatusCount

None.

Response Formats

application/json, text/json

Sample: 
{
  "Message": "sample string 1",
  "ResponseList": [
    {
      "ERPId": "sample string 1",
      "Message": "sample string 2",
      "ResponseStatus": "Failure",
      "GUID": "sample string 3"
    },
    {
      "ERPId": "sample string 1",
      "Message": "sample string 2",
      "ResponseStatus": "Failure",
      "GUID": "sample string 3"
    }
  ],
  "Response": "Failure",
  "ResponseStatusCount": {
    "Updated": 1,
    "Failed": 2,
    "Ignored": 3,
    "Name": "sample string 1",
    "Total": 6,
    "StatusMessage": "sample string 1: Total-6, Updated-1, Failed-2, Ignored-3",
    "ResponseStatus": "PartialSuccess"
  }
}

application/xml, text/xml

Sample: 
<ApiResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ExternalApis.Models.Common">
  <Message>sample string 1</Message>
  <Response>Failure</Response>
  <ResponseList>
    <ApiResponseMessage>
      <ERPId>sample string 1</ERPId>
      <GUID>sample string 3</GUID>
      <Message>sample string 2</Message>
      <ResponseStatus>Failure</ResponseStatus>
    </ApiResponseMessage>
    <ApiResponseMessage>
      <ERPId>sample string 1</ERPId>
      <GUID>sample string 3</GUID>
      <Message>sample string 2</Message>
      <ResponseStatus>Failure</ResponseStatus>
    </ApiResponseMessage>
  </ResponseList>
  <ResponseStatusCount>
    <Failed>2</Failed>
    <Ignored>3</Ignored>
    <Name>sample string 1</Name>
    <Updated>1</Updated>
  </ResponseStatusCount>
</ApiResponse>