--- title: "List offers V3" method: GET path: "/api/v3/offers" tags: ["Offer"] --- # List offers V3 `GET /api/v3/offers` This endpoint requires the following scopes: `offer:read`. List offers. ## Query parameters - `filter` object[] - `key` 'id' | 'documentNumber' | 'documentDate' | 'writeProtection' | 'address.id' | 'project.id' | 'tags' | 'tags.id' | 'language' | 'bodyIntroduction' | 'bodyOutroduction' | 'project.abbreviation' | 'internalDesignation' | 'vatId' | 'deliveryTerms' | 'internalComment' | 'isDocumentSent' | 'editor.id' | 'createdAt' | 'updatedAt' | 'documentAddress.name' | 'documentAddress.title' | 'documentAddress.contactPerson' | 'documentAddress.department' | 'documentAddress.subDepartment' | 'documentAddress.addressSupplement' | 'documentAddress.street' | 'documentAddress.zipCode' | 'documentAddress.city' | 'documentAddress.state' | 'documentAddress.country' | 'documentAddress.gln' | 'documentAddress.email' | 'documentAddress.phone' | 'documentAddress.fax' | 'financials.paymentMethod.id' | 'financials.tax.disableTaxNotice' | 'financials.tax.taxRates.standard' | 'financials.tax.taxRates.reduced' | 'financials.tax.taxation' | 'totals.net.amount' | 'totals.net.currency' | 'financials.paymentTerms.paymentTargetDays' | 'financials.paymentTerms.paymentTargetDiscount' | 'financials.paymentTerms.paymentTargetDiscountDays' | 'status' | 'sales.id' | 'costCenter' | 'customerNumber' | 'deviatingDeliveryAddress.name' | 'deviatingDeliveryAddress.title' | 'deviatingDeliveryAddress.contactPerson' | 'deviatingDeliveryAddress.department' | 'deviatingDeliveryAddress.subDepartment' | 'deviatingDeliveryAddress.addressSupplement' | 'deviatingDeliveryAddress.street' | 'deviatingDeliveryAddress.zipCode' | 'deviatingDeliveryAddress.city' | 'deviatingDeliveryAddress.state' | 'deviatingDeliveryAddress.country' | 'deviatingDeliveryAddress.gln' | 'deviatingDeliveryAddress.email' | 'deviatingDeliveryAddress.phone' | 'deviatingDeliveryAddress.fax' | 'customerReference' | 'desiredDeliveryDate' | 'desiredDeliveryDateAsCalendarWeek' | 'validUntilDate' | 'plannedOrderDate' | 'useAlternativeDocumentTitle' | 'manualShippingCostApproval' | 'printSettings.withoutLetterhead' | 'printSettings.withoutProductText' | 'printSettings.withoutTotalAmount' | 'shippingMethod.id' - `op` 'equals' | 'notEquals' | 'in' | 'notIn' | 'contains' | 'notContains' | 'startsWith' | 'endsWith' | 'lessThan' | 'lessThanOrEquals' | 'greaterThan' | 'greaterThanOrEquals' | 'isNull' | 'isNotNull' — operator - `value` union — The property value. - string - string[] - `sort` string[] - `search` string - `include` string[] - `perPage` integer - `page` integer - `cursor` string ## Headers - `x-pagination` 'simple' | 'table' | 'cursor' ## Response `200` List offers. - union - 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 - `withoutTotalAmount` boolean — For PDFs or physical documents, hide the total amount - `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 - `financials` object — Financials properties of the document - `paymentMethod` object — Payment method of the document. This is a reference to the payment method used for the document. - `id` string - `paymentTerms` object — Payment terms of the document - `paymentTargetDays` integer - `paymentTargetDiscount` number, float - `paymentTargetDiscountDays` integer - `tax` object — Tax properties of the document - `taxation` 'domestic' | 'eu' | 'export' | 'exempt' — Taxation of the document, e.g. "domestic" or "eu". - `disableTaxNotice` boolean — Indicates if the tax notice should be disabled for this document. - `taxRates` object — Tax rates of the document. These values cannot be edited directly via the Xentral UI, and are set based on the tax settings and the delivery or billing region. - `standard` number, float - `reduced` number, float - `currency` string — Currency of the document as an ISO 4217 code, e.g. "EUR" or "USD". - `exchangeRate` unknown - `totals` object — Totals of the document. These values cannot be set directly, but are calculated based on the line items - `net` object — Money - `amount` union - string - number - `currency` string — Currency - `gross` object — Money - `amount` union - string - number - `currency` string — Currency - `contributionMargin` number, float — Contribution margin of the document. - `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' | 'commissioned' | 'completed' | 'ordered' | 'released' | 'accepted' | 'declined' | 'expired' | 'sent' | 'cancelled' — Status of the document - `deviatingShipToAddress` 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 - `customerReference` string — Customer reference for the offer. This is a reference provided by the customer, e.g., a request or inquiry number. - `desiredDeliveryDate` string, date — Desired delivery date of the offer. This is the date when the customer wants to receive the goods. - `desiredDeliveryDateAsCalendarWeek` boolean — Indicates if the desired delivery date is expressed as a calendar week. If true, the `desiredDeliveryDate` should be interpreted as the start of the calendar week. - `validUntilDate` string, date — Validity date of the offer. After this date, the offer is considered expired. - `plannedOrderDate` string, date — Planned order date for the offer. This is the date when the order is planned to be created from the offer. - `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. - `manualShippingCostApproval` boolean — Use this field to manually approve the shipping costs of the offer. Depending on the shipping method configuration, this might be required before the offer can be dispatched. - `lineItems` union[] - union - object — Offer 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. - … - `countryOfOrigin` unknown - `hsCode` unknown - `customFields` object[] — Custom fields with their values and metadata. - … - `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. - `taxRate` union — Tax rate type applied to this line item - … - `effectiveTaxRate` number, float — Effective tax rate for this line item - `price` object — Price information for this line item - … - `discount` number, float — Discount percentage applied to this line item - `itemRevenue` object — Total revenue for all quantities of this line item - … - `lineItemRevenue` object — Revenue for a single unit of this line item - … - `purchasePrice` object — Purchase price information for this line item - … - `contributionMargin` number, float — Contribution margin for this line item - `taxLegalNotice` string — Legal notice regarding tax for this line item - `printSettings` object — Print settings for this line item. - … - `parentLineItem` object — If this line item is a child line item, this will contain the parent line item ID. - … - 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 - … - `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 offer. - `id` string - `name` string - `effectiveAddresses` object — Effective addresses of the offer. These (read-only) postal addresses will always be set, regardless of whether a deviating ship-to address is set or not. Use these fields if you need to easily determine the ship-to and bill-to addresses of the offer. For updating, use the `documentAddress` and `deviatingShipToAddress` fields. - `billTo` 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 - `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. - `meta` object — Pagination meta data - `currentPage` integer — The current page number - `from` integer, nullable — The first item being returned in the current page - `path` string — The base path for the paginated results - `perPage` integer — The number of items shown per page - `to` integer, nullable — The last item being returned in the current page - `links` object — Pagination links - `first` string, nullable — URL to the first page - `last` string, nullable — URL to the last page - `prev` string, nullable — URL to the previous page - `next` string, nullable — URL to the next page - 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 - `withoutTotalAmount` boolean — For PDFs or physical documents, hide the total amount - `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 - `financials` object — Financials properties of the document - `paymentMethod` object — Payment method of the document. This is a reference to the payment method used for the document. - `id` string - `paymentTerms` object — Payment terms of the document - `paymentTargetDays` integer - `paymentTargetDiscount` number, float - `paymentTargetDiscountDays` integer - `tax` object — Tax properties of the document - `taxation` 'domestic' | 'eu' | 'export' | 'exempt' — Taxation of the document, e.g. "domestic" or "eu". - `disableTaxNotice` boolean — Indicates if the tax notice should be disabled for this document. - `taxRates` object — Tax rates of the document. These values cannot be edited directly via the Xentral UI, and are set based on the tax settings and the delivery or billing region. - `standard` number, float - `reduced` number, float - `currency` string — Currency of the document as an ISO 4217 code, e.g. "EUR" or "USD". - `exchangeRate` unknown - `totals` object — Totals of the document. These values cannot be set directly, but are calculated based on the line items - `net` object — Money - `amount` union - string - number - `currency` string — Currency - `gross` object — Money - `amount` union - string - number - `currency` string — Currency - `contributionMargin` number, float — Contribution margin of the document. - `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' | 'commissioned' | 'completed' | 'ordered' | 'released' | 'accepted' | 'declined' | 'expired' | 'sent' | 'cancelled' — Status of the document - `deviatingShipToAddress` 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 - `customerReference` string — Customer reference for the offer. This is a reference provided by the customer, e.g., a request or inquiry number. - `desiredDeliveryDate` string, date — Desired delivery date of the offer. This is the date when the customer wants to receive the goods. - `desiredDeliveryDateAsCalendarWeek` boolean — Indicates if the desired delivery date is expressed as a calendar week. If true, the `desiredDeliveryDate` should be interpreted as the start of the calendar week. - `validUntilDate` string, date — Validity date of the offer. After this date, the offer is considered expired. - `plannedOrderDate` string, date — Planned order date for the offer. This is the date when the order is planned to be created from the offer. - `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. - `manualShippingCostApproval` boolean — Use this field to manually approve the shipping costs of the offer. Depending on the shipping method configuration, this might be required before the offer can be dispatched. - `lineItems` union[] - union - object — Offer 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. - … - `countryOfOrigin` unknown - `hsCode` unknown - `customFields` object[] — Custom fields with their values and metadata. - … - `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. - `taxRate` union — Tax rate type applied to this line item - … - `effectiveTaxRate` number, float — Effective tax rate for this line item - `price` object — Price information for this line item - … - `discount` number, float — Discount percentage applied to this line item - `itemRevenue` object — Total revenue for all quantities of this line item - … - `lineItemRevenue` object — Revenue for a single unit of this line item - … - `purchasePrice` object — Purchase price information for this line item - … - `contributionMargin` number, float — Contribution margin for this line item - `taxLegalNotice` string — Legal notice regarding tax for this line item - `printSettings` object — Print settings for this line item. - … - `parentLineItem` object — If this line item is a child line item, this will contain the parent line item ID. - … - 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 - … - `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 offer. - `id` string - `name` string - `effectiveAddresses` object — Effective addresses of the offer. These (read-only) postal addresses will always be set, regardless of whether a deviating ship-to address is set or not. Use these fields if you need to easily determine the ship-to and bill-to addresses of the offer. For updating, use the `documentAddress` and `deviatingShipToAddress` fields. - `billTo` 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 - `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. - `links` object - `first` string, nullable — URL to the first page - `last` string, nullable — URL to the last page - `prev` string, nullable — URL to the previous page - `next` string, nullable — URL to the next page - `meta` object - `currentPage` integer — The current page number - `from` integer, nullable — The first item being returned in the current page - `lastPage` integer — The last page number - `path` string — The base path for the paginated results - `perPage` integer — The number of items shown per page - `to` integer, nullable — The last item being returned in the current page - `total` integer — The total number of items - 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 - `withoutTotalAmount` boolean — For PDFs or physical documents, hide the total amount - `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 - `financials` object — Financials properties of the document - `paymentMethod` object — Payment method of the document. This is a reference to the payment method used for the document. - `id` string - `paymentTerms` object — Payment terms of the document - `paymentTargetDays` integer - `paymentTargetDiscount` number, float - `paymentTargetDiscountDays` integer - `tax` object — Tax properties of the document - `taxation` 'domestic' | 'eu' | 'export' | 'exempt' — Taxation of the document, e.g. "domestic" or "eu". - `disableTaxNotice` boolean — Indicates if the tax notice should be disabled for this document. - `taxRates` object — Tax rates of the document. These values cannot be edited directly via the Xentral UI, and are set based on the tax settings and the delivery or billing region. - `standard` number, float - `reduced` number, float - `currency` string — Currency of the document as an ISO 4217 code, e.g. "EUR" or "USD". - `exchangeRate` unknown - `totals` object — Totals of the document. These values cannot be set directly, but are calculated based on the line items - `net` object — Money - `amount` union - string - number - `currency` string — Currency - `gross` object — Money - `amount` union - string - number - `currency` string — Currency - `contributionMargin` number, float — Contribution margin of the document. - `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' | 'commissioned' | 'completed' | 'ordered' | 'released' | 'accepted' | 'declined' | 'expired' | 'sent' | 'cancelled' — Status of the document - `deviatingShipToAddress` 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 - `customerReference` string — Customer reference for the offer. This is a reference provided by the customer, e.g., a request or inquiry number. - `desiredDeliveryDate` string, date — Desired delivery date of the offer. This is the date when the customer wants to receive the goods. - `desiredDeliveryDateAsCalendarWeek` boolean — Indicates if the desired delivery date is expressed as a calendar week. If true, the `desiredDeliveryDate` should be interpreted as the start of the calendar week. - `validUntilDate` string, date — Validity date of the offer. After this date, the offer is considered expired. - `plannedOrderDate` string, date — Planned order date for the offer. This is the date when the order is planned to be created from the offer. - `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. - `manualShippingCostApproval` boolean — Use this field to manually approve the shipping costs of the offer. Depending on the shipping method configuration, this might be required before the offer can be dispatched. - `lineItems` union[] - union - object — Offer 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. - … - `countryOfOrigin` unknown - `hsCode` unknown - `customFields` object[] — Custom fields with their values and metadata. - … - `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. - `taxRate` union — Tax rate type applied to this line item - … - `effectiveTaxRate` number, float — Effective tax rate for this line item - `price` object — Price information for this line item - … - `discount` number, float — Discount percentage applied to this line item - `itemRevenue` object — Total revenue for all quantities of this line item - … - `lineItemRevenue` object — Revenue for a single unit of this line item - … - `purchasePrice` object — Purchase price information for this line item - … - `contributionMargin` number, float — Contribution margin for this line item - `taxLegalNotice` string — Legal notice regarding tax for this line item - `printSettings` object — Print settings for this line item. - … - `parentLineItem` object — If this line item is a child line item, this will contain the parent line item ID. - … - 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 - … - `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 offer. - `id` string - `name` string - `effectiveAddresses` object — Effective addresses of the offer. These (read-only) postal addresses will always be set, regardless of whether a deviating ship-to address is set or not. Use these fields if you need to easily determine the ship-to and bill-to addresses of the offer. For updating, use the `documentAddress` and `deviatingShipToAddress` fields. - `billTo` 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 - `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. - `links` object — Pagination links - `first` string, nullable — URL to the first page - `last` string, nullable — URL to the last page - `prev` string, nullable — URL to the previous page - `next` string, nullable — URL to the next page - `meta` object — Pagination meta data - `path` string — The base path for the paginated results - `perPage` integer — The number of items shown per page - `nextCursor` string, nullable — Cursor for the next page - `prevCursor` string, nullable — Cursor for the previous page ## Other responses - `401` — Unauthorized - `403` — Forbidden - `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/versions/8a27ba392442/schema)