v1

latestOpenAPI 3.0.02026-07-2455104.8 MB
Credit Note

View related documents for credit note

Returns details for related documents of a single credit note.

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

Path parameters

idstring required

Resource identifier.

Example:17

The resource's identifier.

Response

Operation completed successfully.

Example response

{
  "data": {
    "salesOrder": [
      {
        "id": "1011",
        "status": "completed",
        "number": "200735",
        "url": "https://example.xentral.biz?module=auftrag&action=pdf&id=1011",
        "date": "2022-01-23"
      }
    ],
    "deliveryNotes": [
      {
        "id": "729",
        "status": "sent",
        "number": "300704",
        "url": "https://example.xentral.biz?module=lieferschein&action=pdf&id=729",
        "date": "2022-01-24"
      }
    ],
    "invoices": [
      {
        "id": "125",
        "status": "canceled",
        "number": "1200712",
        "url": "https://example.xentral.biz?module=rechnung&action=pdf&id=125",
        "date": "2022-01-24"
      }
    ],
    "pdfArchives": [
      {
        "id": "8571",
        "name": "125_20220203_GS9000110.pdf",
        "createdBy": {
          "name": "John Doe"
        },
        "url": "https://example.xentral.biz?module=gutschrift&action=pdffromarchive&id=8571",
        "date": "2022-02-03 10:19:27"
      }
    ]
  }
}