Sign in

v1

latestOpenAPI 3.1.02026-07-242325051.4 MB
Invoices

Invoice:Info

This API returns a detailed summary information for a specific clearing. If you want to retrieve also the clearing lines, please use the Clearing:Lines endpoint. You need to have access to the merchant if you request a clearing.

get/v2/invoices/{invoiceId}/info

Path parameters

invoiceIdstring required

The invoice ID.

Response

OK

idstring
periodstring
periodTypestring
invoiceDatestring date-time
periodStartstring date-time
periodEndstring date-time
status'OPEN' | 'FAILED' | 'PAID'
paymentDatestring date-time nullable

Example response

{
  "merchant": {
    "code": "M-1234-4321",
    "name": "GMS Demo Merchant",
    "contractPackage": "Corporate",
    "postalAddress": {
      "code": "CA-1234-4312",
      "streetName": "Delivery-Lane",
      "streetNumber": "70",
      "zipCode": "1234CD",
      "city": "Amsterdam",
      "countryCode": "NL"
    }
  },
  "costs": {
    "value": 100,
    "currency": "EUR"
  }
}