Invoice

Retrieves the collection of Invoice resources.

get

Retrieves the collection of Invoice resources.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

id[between]stringOptional

id[gt]stringOptional

id[gte]stringOptional

id[lt]stringOptional

id[lte]stringOptional

Responses

200

Invoice collection

application/ld+jsontext/html

hydra:totalItemsintegerOptional

get

/api/invoices

HTTPcURLJavaScriptPython

GET /api/invoices HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Invoice collection

{
  "hydra:member": [
    {
      "@id": "text",
      "@type": "text",
      "@context": "text",
      "id": 1,
      "number": 1,
      "date": "2026-03-03T04:31:04.996Z",
      "state": "booked",
      "orderNumber": "text",
      "internalDepartment": "text",
      "internalCostcenter": "text",
      "reverseChargeState": "none",
      "additionalText": "text",
      "frame": "/entitiy/1",
      "responsiblePerson": "/entitiy/1",
      "paymentMethod": "/entitiy/1",
      "address": {
        "@context": "text",
        "@id": "text",
        "@type": "text",
        "id": 1,
        "street": "text",
        "zip": "text",
        "city": "text",
        "phone": "text",
        "mobilePhone": "text",
        "fax": "text",
        "company": "text",
        "department": "text",
        "aux": "text",
        "state": "text",
        "country": "text",
        "email": "text",
        "careOf": "text",
        "url": "text",
        "vatId": "text"
      },
      "shippingAddress": {
        "@context": "text",
        "@id": "text",
        "@type": "text",
        "id": 1,
        "street": "text",
        "zip": "text",
        "city": "text",
        "phone": "text",
        "mobilePhone": "text",
        "fax": "text",
        "company": "text",
        "department": "text",
        "aux": "text",
        "state": "text",
        "country": "text",
        "email": "text",
        "careOf": "text",
        "url": "text",
        "vatId": "text"
      },
      "versions": [
        "/entitiy/1"
      ]
    }
  ],
  "hydra:totalItems": 1,
  "hydra:view": {
    "@id": "string",
    "type": "string",
    "hydra:first": "string",
    "hydra:last": "string",
    "hydra:previous": "string",
    "hydra:next": "string"
  },
  "hydra:search": {
    "@type": "text",
    "hydra:template": "text",
    "hydra:variableRepresentation": "text",
    "hydra:mapping": [
      {
        "@type": "text",
        "variable": "text",
        "property": "text",
        "required": true
      }
    ]
  }
}

Retrieves a Invoice resource.

get

Retrieves a Invoice resource.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Resource identifier

Responses

200

Invoice resource

application/ld+jsontext/html

Invoice

@idstringRead-onlyOptional

@typestringRead-onlyOptional

@contextone ofRead-onlyOptional

stringOptional

or

idintegerOptional

The unique identifier

numberintegerOptional

datestring · date-time · nullableOptional

statestring · enumOptionalPossible values:

orderNumberstringOptional

internalDepartmentstringOptional

internalCostcenterstringOptional

reverseChargeStatestring · enumOptionalPossible values:

additionalTextstringOptional

framestring · iri-referenceOptional

responsiblePersonstring · iri-referenceOptional

Person that is responsible for this invoice

paymentMethodstring · iri-reference · nullableOptional

Link to payment method

shippingAddressany of · nullableOptional

The shipping address used within the invoice

versionsstring · iri-reference[]Optional

404

Resource not found

get

/api/invoices/{id}

HTTPcURLJavaScriptPython

GET /api/invoices/{id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "@id": "text",
  "@type": "text",
  "@context": "text",
  "id": 1,
  "number": 1,
  "date": "2026-03-03T04:31:04.996Z",
  "state": "booked",
  "orderNumber": "text",
  "internalDepartment": "text",
  "internalCostcenter": "text",
  "reverseChargeState": "none",
  "additionalText": "text",
  "frame": "/entitiy/1",
  "responsiblePerson": "/entitiy/1",
  "paymentMethod": "/entitiy/1",
  "address": {
    "@context": "text",
    "@id": "text",
    "@type": "text",
    "id": 1,
    "street": "text",
    "zip": "text",
    "city": "text",
    "phone": "text",
    "mobilePhone": "text",
    "fax": "text",
    "company": "text",
    "department": "text",
    "aux": "text",
    "state": "text",
    "country": "text",
    "email": "text",
    "careOf": "text",
    "url": "text",
    "vatId": "text"
  },
  "shippingAddress": {
    "@context": "text",
    "@id": "text",
    "@type": "text",
    "id": 1,
    "street": "text",
    "zip": "text",
    "city": "text",
    "phone": "text",
    "mobilePhone": "text",
    "fax": "text",
    "company": "text",
    "department": "text",
    "aux": "text",
    "state": "text",
    "country": "text",
    "email": "text",
    "careOf": "text",
    "url": "text",
    "vatId": "text"
  },
  "versions": [
    "/entitiy/1"
  ]
}