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

Returns a list of Payments Received.

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

Response Description with Error messages and GUIDs

Collection of PaymentsReceived
NameDescriptionTypeAdditional information
Id

Id of the payment entry.

 integer

None.
UserERPId

Erp Id of User who added the payment details.

 string

None.
UserDesignation

Designation of User who added the payment details.

 string

None.
OutletERPId

Erp Id of the outlet against who the payment details were added.

 string

None.
DistributorERPId

Erp Id of the Distributor against who the payment details were added.

 string

None.
BeatERPId

Outlet Beat Erp Id.

 string

None.
RegionERPId

Outlet Region Erp Id.

 string

None.
ModeofPayment

Mode of payment.

 string

None.
InvoiceNumber

Number of the invoice on which the payment was done.

 string

None.
Amount

Amount paid.

 decimal number

None.
Image

Invoice Image.

 string

None.
Remarks

User remarks.

 string

None.
ChequeNumber

Cheque number if the payment was done by cheque.

 string

None.
BankDetails

Bank details if the payment method required it.

 string

None.
Date

Date of payment.

 date

None.

Response Formats

application/json, text/json

Sample: 
[
  {
    "Id": 1,
    "UserERPId": "sample string 2",
    "UserDesignation": "sample string 3",
    "OutletERPId": "sample string 4",
    "DistributorERPId": "sample string 5",
    "BeatERPId": "sample string 6",
    "RegionERPId": "sample string 7",
    "ModeofPayment": "sample string 8",
    "InvoiceNumber": "sample string 9",
    "Amount": 1.0,
    "Image": "sample string 10",
    "Remarks": "sample string 11",
    "ChequeNumber": "sample string 12",
    "BankDetails": "sample string 13",
    "Date": "2025-04-04T05:06:37.856345+00:00"
  },
  {
    "Id": 1,
    "UserERPId": "sample string 2",
    "UserDesignation": "sample string 3",
    "OutletERPId": "sample string 4",
    "DistributorERPId": "sample string 5",
    "BeatERPId": "sample string 6",
    "RegionERPId": "sample string 7",
    "ModeofPayment": "sample string 8",
    "InvoiceNumber": "sample string 9",
    "Amount": 1.0,
    "Image": "sample string 10",
    "Remarks": "sample string 11",
    "ChequeNumber": "sample string 12",
    "BankDetails": "sample string 13",
    "Date": "2025-04-04T05:06:37.856345+00:00"
  }
]

application/xml, text/xml

Sample: 
<ArrayOfPaymentsReceived xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ExternalApis.V3.Models">
  <PaymentsReceived>
    <Amount>1</Amount>
    <BankDetails>sample string 13</BankDetails>
    <BeatERPId>sample string 6</BeatERPId>
    <ChequeNumber>sample string 12</ChequeNumber>
    <Date>2025-04-04T05:06:37.856345+00:00</Date>
    <DistributorERPId>sample string 5</DistributorERPId>
    <Id>1</Id>
    <Image>sample string 10</Image>
    <InvoiceNumber>sample string 9</InvoiceNumber>
    <ModeofPayment>sample string 8</ModeofPayment>
    <OutletERPId>sample string 4</OutletERPId>
    <RegionERPId>sample string 7</RegionERPId>
    <Remarks>sample string 11</Remarks>
    <UserDesignation>sample string 3</UserDesignation>
    <UserERPId>sample string 2</UserERPId>
  </PaymentsReceived>
  <PaymentsReceived>
    <Amount>1</Amount>
    <BankDetails>sample string 13</BankDetails>
    <BeatERPId>sample string 6</BeatERPId>
    <ChequeNumber>sample string 12</ChequeNumber>
    <Date>2025-04-04T05:06:37.856345+00:00</Date>
    <DistributorERPId>sample string 5</DistributorERPId>
    <Id>1</Id>
    <Image>sample string 10</Image>
    <InvoiceNumber>sample string 9</InvoiceNumber>
    <ModeofPayment>sample string 8</ModeofPayment>
    <OutletERPId>sample string 4</OutletERPId>
    <RegionERPId>sample string 7</RegionERPId>
    <Remarks>sample string 11</Remarks>
    <UserDesignation>sample string 3</UserDesignation>
    <UserERPId>sample string 2</UserERPId>
  </PaymentsReceived>
</ArrayOfPaymentsReceived>