GET api/V3/RetailerCollection/getPaged?lastCollectionId={lastCollectionId}&pageSize={pageSize}

API can be used to fetch 100 incremental Collection records and relevant collection information by seeding a particular Collection ID.

Request Information

URI Parameters

Name	Description	Type	Additional information
lastCollectionId	For a given lastCollectionId, the next 100 values for the company are sent.	integer	Required
pageSize	For specifying the number of records to be extracted. Default value is set to 100.	integer	Default value is 100

Body Parameters

None.

Response Information

Resource Description

Collection of PagedRetailerCollections

Name	Type	Additional information
CollectionId	integer	None.
CollectedAmount	decimal number	None.
CollectionDate	date	None.
Dispatch	integer	None.
InvoiceDate	date	None.
InvoiceId	string	None.
ModeOfPayment	string	None.
OrderDate	date	None.
OrderId	integer	None.
InvoiceAmount	decimal number	None.
OutstandingValue	decimal number	None.
CNCode	string	None.
Image	string	None.
PaymentDetails	string	None.
OutletErpId	string	None.
OutletName	string	None.
EmployeeErpId	string	None.
UserDesignation	string	None.
BeatName	string	None.
BeatErpId	string	None.
VanRegistrationNumber	string	None.
VanName	string	None.
DistributorErpId	string	None.
BillToAddressERP	string	None.
BillToIntegrationID1	string	None.
BillToIntegrationID2	string	None.
ShipToAddressERP	string	None.
ShipToIntegrationID1	string	None.
ShipToIntegrationID2	string	None.
BankCode	string	None.
RunningSequence	string	None.
VanChassisNumber	string	None.
SettlementId	globally unique identifier	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "CollectionId": 1,
    "CollectedAmount": 2.1,
    "CollectionDate": "2025-04-08T13:49:58.0034838+00:00",
    "Dispatch": 4,
    "InvoiceDate": "2025-04-08T13:49:58.0034838+00:00",
    "InvoiceId": "sample string 6",
    "ModeOfPayment": "sample string 7",
    "OrderDate": "2025-04-08T13:49:58.0034838+00:00",
    "OrderId": 9,
    "InvoiceAmount": 1.1,
    "OutstandingValue": 1.1,
    "CNCode": "sample string 10",
    "Image": "sample string 11",
    "PaymentDetails": "sample string 12",
    "OutletErpId": "sample string 13",
    "OutletName": "sample string 14",
    "EmployeeErpId": "sample string 15",
    "UserDesignation": "sample string 16",
    "BeatName": "sample string 17",
    "BeatErpId": "sample string 18",
    "VanRegistrationNumber": "sample string 19",
    "VanName": "sample string 20",
    "DistributorErpId": "sample string 21",
    "BillToAddressERP": "sample string 22",
    "BillToIntegrationID1": "sample string 23",
    "BillToIntegrationID2": "sample string 24",
    "ShipToAddressERP": "sample string 25",
    "ShipToIntegrationID1": "sample string 26",
    "ShipToIntegrationID2": "sample string 27",
    "BankCode": "sample string 28",
    "RunningSequence": "sample string 29",
    "VanChassisNumber": "sample string 30",
    "SettlementId": "667d8c4d-8415-40b0-b511-5c13498a97d0"
  },
  {
    "CollectionId": 1,
    "CollectedAmount": 2.1,
    "CollectionDate": "2025-04-08T13:49:58.0034838+00:00",
    "Dispatch": 4,
    "InvoiceDate": "2025-04-08T13:49:58.0034838+00:00",
    "InvoiceId": "sample string 6",
    "ModeOfPayment": "sample string 7",
    "OrderDate": "2025-04-08T13:49:58.0034838+00:00",
    "OrderId": 9,
    "InvoiceAmount": 1.1,
    "OutstandingValue": 1.1,
    "CNCode": "sample string 10",
    "Image": "sample string 11",
    "PaymentDetails": "sample string 12",
    "OutletErpId": "sample string 13",
    "OutletName": "sample string 14",
    "EmployeeErpId": "sample string 15",
    "UserDesignation": "sample string 16",
    "BeatName": "sample string 17",
    "BeatErpId": "sample string 18",
    "VanRegistrationNumber": "sample string 19",
    "VanName": "sample string 20",
    "DistributorErpId": "sample string 21",
    "BillToAddressERP": "sample string 22",
    "BillToIntegrationID1": "sample string 23",
    "BillToIntegrationID2": "sample string 24",
    "ShipToAddressERP": "sample string 25",
    "ShipToIntegrationID1": "sample string 26",
    "ShipToIntegrationID2": "sample string 27",
    "BankCode": "sample string 28",
    "RunningSequence": "sample string 29",
    "VanChassisNumber": "sample string 30",
    "SettlementId": "667d8c4d-8415-40b0-b511-5c13498a97d0"
  }
]

application/xml, text/xml

Sample:

<ArrayOfPagedRetailerCollections xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ExternalApis.Models.V3">
  <PagedRetailerCollections>
    <BankCode>sample string 28</BankCode>
    <BeatErpId>sample string 18</BeatErpId>
    <BeatName>sample string 17</BeatName>
    <BillToAddressERP>sample string 22</BillToAddressERP>
    <BillToIntegrationID1>sample string 23</BillToIntegrationID1>
    <BillToIntegrationID2>sample string 24</BillToIntegrationID2>
    <CNCode>sample string 10</CNCode>
    <CollectedAmount>2.1</CollectedAmount>
    <CollectionDate>2025-04-08T13:49:58.0034838+00:00</CollectionDate>
    <CollectionId>1</CollectionId>
    <Dispatch>4</Dispatch>
    <DistributorErpId>sample string 21</DistributorErpId>
    <EmployeeErpId>sample string 15</EmployeeErpId>
    <Image>sample string 11</Image>
    <InvoiceAmount>1.1</InvoiceAmount>
    <InvoiceDate>2025-04-08T13:49:58.0034838+00:00</InvoiceDate>
    <InvoiceId>sample string 6</InvoiceId>
    <ModeOfPayment>sample string 7</ModeOfPayment>
    <OrderDate>2025-04-08T13:49:58.0034838+00:00</OrderDate>
    <OrderId>9</OrderId>
    <OutletErpId>sample string 13</OutletErpId>
    <OutletName>sample string 14</OutletName>
    <OutstandingValue>1.1</OutstandingValue>
    <PaymentDetails>sample string 12</PaymentDetails>
    <RunningSequence>sample string 29</RunningSequence>
    <SettlementId>667d8c4d-8415-40b0-b511-5c13498a97d0</SettlementId>
    <ShipToAddressERP>sample string 25</ShipToAddressERP>
    <ShipToIntegrationID1>sample string 26</ShipToIntegrationID1>
    <ShipToIntegrationID2>sample string 27</ShipToIntegrationID2>
    <UserDesignation>sample string 16</UserDesignation>
    <VanChassisNumber>sample string 30</VanChassisNumber>
    <VanName>sample string 20</VanName>
    <VanRegistrationNumber>sample string 19</VanRegistrationNumber>
  </PagedRetailerCollections>
  <PagedRetailerCollections>
    <BankCode>sample string 28</BankCode>
    <BeatErpId>sample string 18</BeatErpId>
    <BeatName>sample string 17</BeatName>
    <BillToAddressERP>sample string 22</BillToAddressERP>
    <BillToIntegrationID1>sample string 23</BillToIntegrationID1>
    <BillToIntegrationID2>sample string 24</BillToIntegrationID2>
    <CNCode>sample string 10</CNCode>
    <CollectedAmount>2.1</CollectedAmount>
    <CollectionDate>2025-04-08T13:49:58.0034838+00:00</CollectionDate>
    <CollectionId>1</CollectionId>
    <Dispatch>4</Dispatch>
    <DistributorErpId>sample string 21</DistributorErpId>
    <EmployeeErpId>sample string 15</EmployeeErpId>
    <Image>sample string 11</Image>
    <InvoiceAmount>1.1</InvoiceAmount>
    <InvoiceDate>2025-04-08T13:49:58.0034838+00:00</InvoiceDate>
    <InvoiceId>sample string 6</InvoiceId>
    <ModeOfPayment>sample string 7</ModeOfPayment>
    <OrderDate>2025-04-08T13:49:58.0034838+00:00</OrderDate>
    <OrderId>9</OrderId>
    <OutletErpId>sample string 13</OutletErpId>
    <OutletName>sample string 14</OutletName>
    <OutstandingValue>1.1</OutstandingValue>
    <PaymentDetails>sample string 12</PaymentDetails>
    <RunningSequence>sample string 29</RunningSequence>
    <SettlementId>667d8c4d-8415-40b0-b511-5c13498a97d0</SettlementId>
    <ShipToAddressERP>sample string 25</ShipToAddressERP>
    <ShipToIntegrationID1>sample string 26</ShipToIntegrationID1>
    <ShipToIntegrationID2>sample string 27</ShipToIntegrationID2>
    <UserDesignation>sample string 16</UserDesignation>
    <VanChassisNumber>sample string 30</VanChassisNumber>
    <VanName>sample string 20</VanName>
    <VanRegistrationNumber>sample string 19</VanRegistrationNumber>
  </PagedRetailerCollections>
</ArrayOfPagedRetailerCollections>

GET api/V3/RetailerCollection/getPaged?lastCollectionId={lastCollectionId}&pageSize={pageSize}

Request Information

URI Parameters

Body Parameters

Response Information

Resource Description

Response Formats

application/json, text/json

application/xml, text/xml

URI parameters

Headers | Add header

Body