BObokio
invoices

Get invoice payments

Retrieves all payment records for the specified invoice.

Scope: invoices:read

get/companies/{companyId}/invoices/{invoiceId}/payments

Request

  • Base URL
    https://api.bokio.se/v1
  • URL
    https://api.bokio.se/v1/companies/{companyId}/invoices/{invoiceId}/payments
  • Auth
    • HTTP bearer
    • or OAuth 2
      Authorization code: /authorize
      Client credentials
      Token URL: /token scopes: invoices:read

Query parameters

pageinteger

Page number

pageSizeinteger

Number of items per page

querystring

Optional query to filter the data set with supported fields listed below and available operations.

FieldType
datedate
sumBaseCurrencydecimal

Response

Payments found

totalItemsinteger
totalPagesinteger
currentPageinteger

Example response

{
  "totalItems": 1,
  "totalPages": 1,
  "currentPage": 1,
  "items": [
    {
      "id": "b529df79-eb7f-5ef0-a8dc-c2b71f953554",
      "invoiceId": "a419cf69-db6f-4de9-992c-b1a60942a443",
      "date": "2024-10-15",
      "sumBaseCurrency": 200,
      "bookkeepingAccountNumber": 1930,
      "journalEntryRef": {
        "id": "55c899c5-82b2-4a09-899e-9dc03342b5dc"
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 2 revisions of this API.