Skip to main content
GET
/
v1
/
invoice-receivables
/
{invoiceReceivableId}
/
payments
List invoice payments
curl --request GET \
  --url https://api.light.inc/v1/invoice-receivables/{invoiceReceivableId}/payments \
  --header 'Authorization: <api-key>'
[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "invoiceReceivableId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "amount": 123,
    "paymentDate": "2023-12-25",
    "currency": "USD",
    "payment": {
      "type": "BP",
      "bankAccountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "endToEndId": "<string>",
      "originalAmount": 123,
      "originalCurrency": "USD",
      "accountingDocumentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    },
    "createdAt": "2023-11-07T05:31:56Z"
  }
]

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <api_key>, where <api_key> is your api key.

Path Parameters

​
invoiceReceivableId
string<uuid>
required

Response

default - application/json;charset=UTF-8

default response

​
id
string<uuid>

Unique identifier for the payment

​
invoiceReceivableId
string<uuid>

ID of the invoice receivable

​
amount
integer

Payment amount in cents

​
paymentDate
string<date>

Date the payment was made

​
currency
string
Example:

"USD"

​
payment
object
  • Bank payment
  • Customer credit
​
createdAt
string<date-time>

Timestamp when the payment was created