v1

latestOpenAPI 3.1.02026-07-242325051.4 MB

Invoices

Invoices:Browse

This API returns a summary of the invoices. You can filter on a merchant code, so if you are a partner and you have right to that merchants you can retrieve the invoice information for your merchant.

get/v2/invoices

Query parameters

pageinteger

The collection page number

limitinteger

The number of items per page

eqstring

Get results that equal the given value

Provides filtering based on merchant code.

{
  "eq": "M-1234-4321"
}

eqstring

Filter on the exact turnover group code.

neqstring

Filter out the specified turnover group code.

instring

Filter for any of the turnover group codes.

Filter invoices by turnover group.

{
  "eq": "CT-1234-4321",
  "neq": "CT-1234-4321",
  "in": "CT-1234-4321"
}

gtstring date

Filter on invoice date greater than the given value.

gtestring date

Filter on invoice date greater than or equal to the given value.

ltstring date

Filter on invoice date less than the given value.

ltestring date

Filter on invoice date less than or equal to the given value.

Filter invoices by date.

{
  "gt": "2024-06-04",
  "gte": "2024-06-04",
  "lt": "2024-06-04",
  "lte": "2024-06-04"
}

eq'OPEN' | 'FAILED' | 'PAID'

Filter on the exact status.

neq'OPEN' | 'FAILED' | 'PAID'

Filter out the specified status.

Filter status.

Response

countinteger

The amount of items the collection contains

pagesinteger

The amount of pages available

totalinteger nullable

The total items the collection contains

Example response

{
  "invoices": [
    {
      "turnoverGroup": {
        "code": "CT-1234-4321",
        "name": "E-Commerce"
      },
      "merchant": {
        "code": "M-1234-4321",
        "name": "GMS Demo Merchant",
        "contractPackage": "E-Commerce"
      },
      "costs": {
        "value": 100,
        "currency": "EUR"
      }
    }
  ],
  "count": 5,
  "pages": 2,
  "total": 10
}