Light APIv1.0.0

API / Reference / Invoice Receivables

List invoice payments

GET https://api.light.inc/v1/invoice-receivables/{invoiceReceivableId}/payments

Returns a list of payments for an invoice receivable

A plain array, not paginated. Each entry is a clearing on the ledger: amount and paymentDate are in the invoice currency; a bank payment (payment.type: BP) also carries the bank amount and currency, while a customer credit (CC) carries its document number. To reverse one, pass payment.accountingDocumentId to reverse-clearing; the top-level id is the clearing event and is not accepted there.

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

  • invoiceReceivableId string · uuidrequired

Response

  • id string · uuid

    Unique identifier for the payment

  • invoiceReceivableId string · uuid

    ID of the invoice receivable

  • amount integer · int64

    Payment amount in smallest denomination

  • paymentDate string · date

    Date the payment was made

  • currency string

  • payment ExternalInvoiceReceivablePaymentEntryV1Model

    Type of payment entry for an invoice receivable payment

  • createdAt string · date-time

    Timestamp when the payment was created