Light APIv1.0.0

API / Reference / Invoice Payables

List invoice payable payments

GET https://api.light.inc/v1/invoice-payables/{invoicePayableId}/payments

Returns all clearings (bank payments and credit notes) linked to the invoice payable. Each entry carries a type discriminator (BP for bank payments, CN for credit notes) so consumers can filter client-side if only one kind is needed. Reversed clearings are excluded.

A plain array. The top-level id is the clearing event, not the document: to reverse a payment, pass payment.accountingDocumentId and the matching type (BP or CN) to reverse-clearing. amount is the cleared amount in the invoice currency. payment is null for clearing types the API doesn't model.

Authorization

Send one of these on every request. See Authentication for how to get credentials.

  • API key

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

  • Bearer token

Path parameters

  • invoicePayableId string · uuidrequired

Response

  • id string · uuid

    Unique identifier for the payment

  • invoicePayableId string · uuid

    ID of the invoice payable this payment cleared

  • amount integer · int64

    Payment amount in the smallest currency denomination (e.g. cents), in the invoice payable's currency

  • currency string

  • paymentDate string · date

    Date the payment was made

  • payment ExternalInvoicePayablePaymentEntryV1Model

    Type of payment entry for an invoice payable payment

  • createdAt string · date-time

    Timestamp when the payment was created