BIbigchange
Invoices

Gets a paged list of payments that belong to the specified invoice

Changed on

Retrieve a paged list of payments for an invoice (required scope finance:read)

get/v1/finance/invoices/{invoiceId}/payments

Request

  • Base URL
    https://api.bigchange.com
  • URL
    https://api.bigchange.com/v1/finance/invoices/{invoiceId}/payments
  • Auth
    HTTP bearer

Path parameters

invoiceIdinteger required

The unique identifier of the invoice

Query parameters

pageNumberinteger

The page number being requested (minimum: 1, maximum: 2147483)

pageSizeinteger

The page size being requested (minimum: 1, maximum: 1000)

Headers

Customer-Idinteger required

The customer identifier

Response

OK

pageNumberinteger

The page number of the response where 1 is the first page

pageSizeinteger

The number of items requested for the current page

pageItemCountinteger

The number of items returned in the current page

Example response

{
  "items": [
    {
      "id": 12345,
      "invoiceId": 54321,
      "amount": 500,
      "vatAmount": 100,
      "reference": "INV-REF-001",
      "method": "Unknown",
      "onlineReference": "pi_3OxXXXXXXXXXXXXXX"
    }
  ],
  "pageNumber": 2,
  "pageSize": 100,
  "pageItemCount": 55
}

Changes