--- title: "View delivery note V3" method: GET path: "/api/v3/deliveryNotes/{id}" tags: ["DeliveryNote"] --- # View delivery note V3 `GET /api/v3/deliveryNotes/{id}` This endpoint requires the following scopes: `deliveryNote:read`. View a single delivery note. **Content Negotiation:** This endpoint supports additional response formats: `application/pdf`. Use the `Accept` header to request a specific format. ## Path parameters - `id` string, required ## Query parameters - `include` string[] ## Response `200` View a single delivery note. - object - `data` object - `id` string — ID of the document - `documentNumber` string — Document number. For drafts, this will be null. - `documentDate` string, date — Main date of the document. - `writeProtection` boolean — Indicates if the document is write protected. - `customerNumber` string — Customer number of the document. - `address` union — Address entity of the document. By default, only the ID is returned. To get the full Address object, use the `include` parameter. - object - `id` string, required - `isDeleted` boolean — Flagged if the entry was deleted. - `createdAt` string, date-time, required — Creation timestamp - `updatedAt` string, date-time, required — Last update timestamp - object - `id` string - `project` union — Project entity of the document. By default, only the ID is returned. To get the full Project object, use the `include` parameter. - object - `id` string, required - `name` string, required - `abbreviation` string, required - object - `id` string - `tags` object[] — Tags assigned to the document. This property is only returned if the `tags` include is used. - `id` string — ID of the tag - `title` string — Title of the tag - `documentAddress` object — The recipients postal address of the document. This is is usually the postal address of the document's address entitiy, (e.g. customer), or is populated based on the preceding document. As this address is persisted on the document level, it can however be modified independently, and does not reflect changes that occurred since the document was created. - `name` string, required — Represents an address consisting of a physical address and contact information. It is used in various documents, such as invoices, delivery notes, etc. - `type` 'mrs' | 'mr' | 'company' | 'other' - `title` string - `contactPerson` string - `department` string - `subDepartment` string - `addressSupplement` string - `street` string - `zipCode` string - `city` string - `state` string - `country` string - `salutation` string - `gln` string - `email` string - `phone` string - `fax` string - `mobile` string - `internalDesignation` string — Internal designation, might be displayed in the letterhead. - `isDocumentSent` boolean — Indicates if the document has been sent to the recipient. - `language` string — ISO 639-1 Language of the document. - `bodyIntroduction` string — Text displayed on the document before the line items. - `bodyOutroduction` string — Text displayed on the document after the line items. - `vatId` string — VAT ID of the document. - `deliveryTerms` string — Delivery terms of the document. - `internalComment` string — Internal comment, does not show up on the document. Intended to be used for company-internal notes. - `editor` object - `id` string — ID of the user who is responsible for the document. - `printSettings` object - `withoutLetterhead` boolean — For PDFs or physical documents, hide the letterhead - `withoutProductText` boolean — For PDFs or physical documents, hide the product text - `activity` object[] — Activity log entries associated with the document. To get activity object, use the `include` parameter. - `message` string, required - `causer` string, required - `causedAt` string, date-time, required - `customFields` object[] — Custom fields with their values and metadata - `key` string - `value` string - `label` string - `updatedAt` string, date-time - `createdAt` string, date-time - `salesOrder` object — Sales order reference. - `id` string — ID of the sales order - `preferredWarehouse` object — Preferred warehouse for the document. - `id` string — ID of the preferred warehouse - `sales` object — Sales person responsible for the document. - `id` string - `status` 'draft' | 'released' | 'sent' | 'cancelled' | 'completed' — Status of the document - `customerOrderNumber` string — Customer order number of the delivery note, e.g. the customer's order number - `commissionConsignmentWarehouse` object — Commission/consignment warehouse for the sales order. This is used by the commission/consignment module. - `id` string - `useAlternativeDocumentTitle` boolean — Indicates if the alternative document title should be used. The alternative document title can be configured per document type in the system settings. - `isDeliveryNoteToSupplier` boolean — Indicates if the delivery note is for a supplier. - `supplierNumber` string — Supplier number of the supplier delivery note. - `invoice` object — Invoice connected to the delivery note. - `id` string - `orderPicking` object — Order picking connected to the delivery note - `id` string - `lineItems` union[] - union - object — Delivery Note Line Item - `type` 'product' - `id` string — ID of the line item. - `number` string — The Number of the line item. Usually the product SKU, but can be adjusted if required. - `name` string — The name of the line item. Usually the product name, but can be adjusted if required. - `description` string — The description of the line item. Usually the product description, but can be adjusted if required. - `quantity` number, float — The quantity of the line item. - `product` union — The product of the line item. - object - … - object - … - `countryOfOrigin` unknown - `hsCode` unknown - `customFields` object[] — Custom fields with their values and metadata. - `key` string - `value` string - `label` string - `unit` string — The unit of the line item. - `deliveryDate` string, date — The delivery date of the line item. - `deliveryDateAsCalendarWeek` boolean — Whether to show the delivery date as calendar week or explicit. - `packagingUnit` string — The unit of packaging for the line item. - `internalComment` string — Internal comment, does not show up on the document. Intended to be used for company-internal notes. - `customerProductNumber` string — Customer product number for the line item. - `order` integer — The ordering sequence of the line item. - `updatedAt` string, date-time — The date and time when the line item was last updated. - `createdAt` string, date-time — The date and time when the line item was created. - `salesOrderLineItem` object — sales order line item reference. - `id` string — ID of the line item - `deliveredQuantity` number, float — The quantity delivered until now. - `hasChildLineItems` boolean — Indicates if this line item has child line items (exploded line items). - `parentLineItem` object — If this line item is a child line item, this will contain the parent line item ID. - `id` string - `desiredQualityControlAttributes` object — Desired quality control attributes for the line item. - `bestBeforeDate` string, date — Preferred best before date for the line item. - `batch` string — Preferred batch for the line item. - `customs` object — Customs information for the line item. - `valueSingle` object — Money - … - `valueTotal` object — Money - … - `weightSingle` number, float — Customs weight per single item. - `weightTotal` number, float — Total customs weight. - `sscc` string — The SSCC (Serial Shipping Container Code) for this line item. - `package` string — The package identifier for this line item. - `packagingUnitQuantity` number, float — The quantity of packaging units for this line item. - `individualPieceQuantity` number, float — The quantity of individual pieces for this line item. - `printSettings` object — Print settings for this line item. - `hidden` boolean — Hide this line item when printing. - object - `id` string, required - `order` integer — The ordering sequence of the line item - `type` 'heading', required - `name` string - `description` string - object - `id` string, required - `order` integer — The ordering sequence of the line item - `type` 'subtotal', required - `name` string - `description` string - object - `id` string, required - `order` integer — The ordering sequence of the line item - `type` 'group_total', required - `name` string - `description` string - object - `id` string, required - `order` integer — The ordering sequence of the line item - `type` 'image', required - `name` string - `description` string - `image` object - `id` string - `imageHeight` unknown - `imageWidth` unknown - object - `id` string, required - `order` integer — The ordering sequence of the line item - `type` 'page_break', required - `shippingMethod` object — Shipping method of the delivery note. - `id` string - `name` string - `masterReferenceNumber` string — Master reference number of the document - `effectiveAddresses` object — Effective addresses of the delivery note. The ship-to (read-only) postal address will always be set. Use this field if you need to easily determine the ship-to address of the delivery note. - `shipTo` object — Represents a postal address with contact information. - `name` string, required — Represents an address consisting of a physical address and contact information. It is used in various documents, such as invoices, delivery notes, etc. - `type` 'mrs' | 'mr' | 'company' | 'other' - `title` string - `contactPerson` string - `department` string - `subDepartment` string - `addressSupplement` string - `street` string - `zipCode` string - `city` string - `state` string - `country` string - `salutation` string - `gln` string - `email` string - `phone` string - `fax` string - `mobile` string - `costCenter` string — Cost center of the document. ## Other responses - `401` — Unauthorized - `403` — Forbidden - `404` — Not Found - `429` — Too Many Requests --- [API](https://skmtc.net/xentral/apis/xentral-api.md) · [All operations](https://skmtc.net/xentral/apis/xentral-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/xentral/xentral-api/revisions/8a27ba392442/schema)