GET api/V3/RetailerCollection/list?id={id}

API can be used to fetch 100 incremental records of payment collected against invoice/order thorugh SFA.This is Live API and data will be available as soon as it get synched to FA Database.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

For a given Id, the next 100 values for the company are sent. DATA FOR THE PARAM ID IS NOT INCLUDED.If id is empty then it is assumed 0 and first 100 values are sent.

 integer

Default value is 0

Body Parameters

None.

Response Information

Resource Description

Collection of RetailerCollection
NameDescriptionTypeAdditional information
Id

Id of the payment entry.

 integer

None.
InvoiceNumber

Invoice number against which payment was collected

 string

None.
InvoiceDate

Date on which Invoice was generated

 date

None.
CollectedAmount

Amount Collected.

 decimal number

None.
CollectedBy

ERPID of user who collected the payment.

 string

None.
UserDesignation

Designation of user who added the payment details

 string

None.
CollectionDate

Date on which collection was done

 date

None.
ModeofPayment

Payment Mode(UPI, Cash, Cheque etc.)

 string

None.
OutletERPId

ERP id of the outlet

 string

None.
OrderId

Order ID as Per the FieldAssist system.

 integer

None.
OrderDate

Date on which order was punched

 date

None.
DistributorERPId

Erp Id of The distributor from where this invoice was generated

 string

None.
BeatERPId

ERP id of the beat in which outlet is located

 string

None.
Image

ImageURL as captured by user in SFA

 string

None.
PaymentDetails

Additional details of Payment as filled by user in SFA

 string

None.
BillToAddressERP

Additional details of Bill to address ERP

 string

None.
BillToIntegrationID1

Additional details of Bill to IntegrationID1

 string

None.
BillToIntegrationID2

Additional details of Bill to IntegrationID2

 string

None.
ShipToAddressERP

Additional details of Ship to address ERP

 string

None.
ShipToIntegrationID1

Additional details of Ship to IntegrationID1

 string

None.
ShipToIntegrationID2

Additional details of Ship to IntegrationID2

 string

None.
BankCode

Additional Bank Code

 string

None.
TransactionReferenceNo

Transaction reference number

 string

None.

Response Formats

application/json, text/json

Sample: 
[
  {
    "Id": 1,
    "InvoiceNumber": "sample string 2",
    "InvoiceDate": "2025-10-19T23:43:24.1915246+00:00",
    "CollectedAmount": 4.1,
    "CollectedBy": "sample string 5",
    "UserDesignation": "sample string 6",
    "CollectionDate": "2025-10-19T23:43:24.1915246+00:00",
    "ModeofPayment": "sample string 8",
    "OutletERPId": "sample string 9",
    "OrderId": 10,
    "OrderDate": "2025-10-19T23:43:24.1915246+00:00",
    "DistributorERPId": "sample string 12",
    "BeatERPId": "sample string 13",
    "Image": "sample string 14",
    "PaymentDetails": "sample string 15",
    "BillToAddressERP": "sample string 16",
    "BillToIntegrationID1": "sample string 17",
    "BillToIntegrationID2": "sample string 18",
    "ShipToAddressERP": "sample string 19",
    "ShipToIntegrationID1": "sample string 20",
    "ShipToIntegrationID2": "sample string 21",
    "BankCode": "sample string 22",
    "TransactionReferenceNo": "sample string 23"
  },
  {
    "Id": 1,
    "InvoiceNumber": "sample string 2",
    "InvoiceDate": "2025-10-19T23:43:24.1915246+00:00",
    "CollectedAmount": 4.1,
    "CollectedBy": "sample string 5",
    "UserDesignation": "sample string 6",
    "CollectionDate": "2025-10-19T23:43:24.1915246+00:00",
    "ModeofPayment": "sample string 8",
    "OutletERPId": "sample string 9",
    "OrderId": 10,
    "OrderDate": "2025-10-19T23:43:24.1915246+00:00",
    "DistributorERPId": "sample string 12",
    "BeatERPId": "sample string 13",
    "Image": "sample string 14",
    "PaymentDetails": "sample string 15",
    "BillToAddressERP": "sample string 16",
    "BillToIntegrationID1": "sample string 17",
    "BillToIntegrationID2": "sample string 18",
    "ShipToAddressERP": "sample string 19",
    "ShipToIntegrationID1": "sample string 20",
    "ShipToIntegrationID2": "sample string 21",
    "BankCode": "sample string 22",
    "TransactionReferenceNo": "sample string 23"
  }
]

application/xml, text/xml

Sample: 
<ArrayOfRetailerCollection xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ExternalApis.Models.V3">
  <RetailerCollection>
    <BankCode>sample string 22</BankCode>
    <BeatERPId>sample string 13</BeatERPId>
    <BillToAddressERP>sample string 16</BillToAddressERP>
    <BillToIntegrationID1>sample string 17</BillToIntegrationID1>
    <BillToIntegrationID2>sample string 18</BillToIntegrationID2>
    <CollectedAmount>4.1</CollectedAmount>
    <CollectedBy>sample string 5</CollectedBy>
    <CollectionDate>2025-10-19T23:43:24.1915246+00:00</CollectionDate>
    <DistributorERPId>sample string 12</DistributorERPId>
    <Id>1</Id>
    <Image>sample string 14</Image>
    <InvoiceDate>2025-10-19T23:43:24.1915246+00:00</InvoiceDate>
    <InvoiceNumber>sample string 2</InvoiceNumber>
    <ModeofPayment>sample string 8</ModeofPayment>
    <OrderDate>2025-10-19T23:43:24.1915246+00:00</OrderDate>
    <OrderId>10</OrderId>
    <OutletERPId>sample string 9</OutletERPId>
    <PaymentDetails>sample string 15</PaymentDetails>
    <ShipToAddressERP>sample string 19</ShipToAddressERP>
    <ShipToIntegrationID1>sample string 20</ShipToIntegrationID1>
    <ShipToIntegrationID2>sample string 21</ShipToIntegrationID2>
    <TransactionReferenceNo>sample string 23</TransactionReferenceNo>
    <UserDesignation>sample string 6</UserDesignation>
  </RetailerCollection>
  <RetailerCollection>
    <BankCode>sample string 22</BankCode>
    <BeatERPId>sample string 13</BeatERPId>
    <BillToAddressERP>sample string 16</BillToAddressERP>
    <BillToIntegrationID1>sample string 17</BillToIntegrationID1>
    <BillToIntegrationID2>sample string 18</BillToIntegrationID2>
    <CollectedAmount>4.1</CollectedAmount>
    <CollectedBy>sample string 5</CollectedBy>
    <CollectionDate>2025-10-19T23:43:24.1915246+00:00</CollectionDate>
    <DistributorERPId>sample string 12</DistributorERPId>
    <Id>1</Id>
    <Image>sample string 14</Image>
    <InvoiceDate>2025-10-19T23:43:24.1915246+00:00</InvoiceDate>
    <InvoiceNumber>sample string 2</InvoiceNumber>
    <ModeofPayment>sample string 8</ModeofPayment>
    <OrderDate>2025-10-19T23:43:24.1915246+00:00</OrderDate>
    <OrderId>10</OrderId>
    <OutletERPId>sample string 9</OutletERPId>
    <PaymentDetails>sample string 15</PaymentDetails>
    <ShipToAddressERP>sample string 19</ShipToAddressERP>
    <ShipToIntegrationID1>sample string 20</ShipToIntegrationID1>
    <ShipToIntegrationID2>sample string 21</ShipToIntegrationID2>
    <TransactionReferenceNo>sample string 23</TransactionReferenceNo>
    <UserDesignation>sample string 6</UserDesignation>
  </RetailerCollection>
</ArrayOfRetailerCollection>