POST api/V3/RetailerCollection/UploadExternalCollection

API can be used to upload Extenal Collection details with or without order Id.

Request Information

URI Parameters

None.

Body Parameters

Collection of ExternalPaymentCollection
NameDescriptionTypeAdditional information
TransactionERPId

Transanction id of the external system for the collection

 string

None.
OrderId

Order against which payment is recieved

 integer

None.
InvoiceNumber

Invoice number against which payment was made

 string

None.
CollectionAmount

Amount which was collected

 decimal number

None.
CollectedBy

User who has collected payment

 string

None.
CollectionDate

Date on which collection was made (Format: "YYYY-MM-DD")

 date

None.
ModeofPayment

Whether payment was made using Cash, Cheque, Credit Note

 string

None.
Image

Link of image captured during collection

 string

None.
PaymentDetails

Additional details of payment (if any)

 string

None.
CreditNoteId

Credit Note Id

 string

None.
CreditNoteValue

Credit Note Value

 decimal number

None.

Request Formats

application/json, text/json

Sample: 
[
  {
    "TransactionERPId": "sample string 1",
    "OrderId": 1,
    "InvoiceNumber": "sample string 2",
    "CollectionAmount": 1.1,
    "CollectedBy": "sample string 3",
    "CollectionDate": "2025-04-04T05:37:27.9690611+00:00",
    "ModeofPayment": "sample string 5",
    "Image": "sample string 6",
    "PaymentDetails": "sample string 7",
    "CreditNoteId": "sample string 8",
    "CreditNoteValue": 1.1
  },
  {
    "TransactionERPId": "sample string 1",
    "OrderId": 1,
    "InvoiceNumber": "sample string 2",
    "CollectionAmount": 1.1,
    "CollectedBy": "sample string 3",
    "CollectionDate": "2025-04-04T05:37:27.9690611+00:00",
    "ModeofPayment": "sample string 5",
    "Image": "sample string 6",
    "PaymentDetails": "sample string 7",
    "CreditNoteId": "sample string 8",
    "CreditNoteValue": 1.1
  }
]

application/xml, text/xml

Sample: 
<ArrayOfExternalPaymentCollection xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ExternalApis.Models.V3">
  <ExternalPaymentCollection>
    <CollectedBy>sample string 3</CollectedBy>
    <CollectionAmount>1.1</CollectionAmount>
    <CollectionDate>2025-04-04T05:37:27.9690611+00:00</CollectionDate>
    <CreditNoteId>sample string 8</CreditNoteId>
    <CreditNoteValue>1.1</CreditNoteValue>
    <Image>sample string 6</Image>
    <InvoiceNumber>sample string 2</InvoiceNumber>
    <ModeofPayment>sample string 5</ModeofPayment>
    <OrderId>1</OrderId>
    <PaymentDetails>sample string 7</PaymentDetails>
    <TransactionERPId>sample string 1</TransactionERPId>
  </ExternalPaymentCollection>
  <ExternalPaymentCollection>
    <CollectedBy>sample string 3</CollectedBy>
    <CollectionAmount>1.1</CollectionAmount>
    <CollectionDate>2025-04-04T05:37:27.9690611+00:00</CollectionDate>
    <CreditNoteId>sample string 8</CreditNoteId>
    <CreditNoteValue>1.1</CreditNoteValue>
    <Image>sample string 6</Image>
    <InvoiceNumber>sample string 2</InvoiceNumber>
    <ModeofPayment>sample string 5</ModeofPayment>
    <OrderId>1</OrderId>
    <PaymentDetails>sample string 7</PaymentDetails>
    <TransactionERPId>sample string 1</TransactionERPId>
  </ExternalPaymentCollection>
</ArrayOfExternalPaymentCollection>

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>