v1

latestOpenAPI 3.0.02026-07-2455104.8 MB
Invoice

View related documents for invoice

Returns details for related documents of a single invoice.

get/api/v1/invoices/{id}/documents

Path parameters

idstring required

Resource identifier.

Example:17

The resource's identifier.

Response

Operation completed successfully.

Example response

{
  "data": {
    "salesOrder": [
      {
        "id": "1",
        "status": "completed",
        "documentNumber": "2022-200000",
        "documentUrl": "https://example.xentral.biz?module=auftrag&action=pdf&id=1",
        "documentDate": "2024-02-22"
      }
    ],
    "deliveryNotes": [
      {
        "id": "3",
        "status": "sent",
        "documentNumber": "2022-300002",
        "documentUrl": "https://example.xentral.biz?module=lieferschein&action=pdf&id=3",
        "documentDate": "2023-08-06"
      }
    ],
    "creditNotes": [
      {
        "id": "19",
        "status": "created",
        "documentNumber": "2022-300002",
        "documentUrl": "https://example.xentral.biz?module=rechnung&action=pdffromarchive&id=19",
        "documentDate": "2022-08-10"
      }
    ],
    "returns": [
      {
        "id": "19",
        "status": "created",
        "documentNumber": "2022-300002",
        "documentUrl": "https://example.xentral.biz?module=rechnung&action=pdffromarchive&id=19",
        "documentDate": "2022-08-10"
      }
    ],
    "pdfArchives": [
      {
        "id": "19",
        "documentName": "0be068caab8e89774948bbd719453e1b_3_20220810_RE2022-400002.pdf",
        "createdBy": {
          "name": "Administrator"
        },
        "documentUrl": "https://example.xentral.biz?module=rechnung&action=pdffromarchive&id=19",
        "documentDate": "2022-08-10 10:41:17"
      }
    ]
  }
}