{ "opencollection": "1.0.0", "info": { "name": "Xentral Account SalesOrder API", "version": "v0.1" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "SalesOrder", "type": "folder" }, "items": [ { "info": { "name": "List sales orders V3", "type": "http" }, "http": { "method": "GET", "url": "https://{xentralId}.xentral.biz/api/v3/salesOrders", "headers": [ { "name": "x-pagination", "value": "" } ], "params": [ { "name": "filter", "value": "", "type": "query", "description": "The filter parameter is used to filter the results of the given endpoint. \n\n\n**Supported filter operators by key:** \n\n`id`: *equals*, *notEquals*, *in*, *notIn* \n\n`documentNumber`: *equals*, *notEquals*, *in*, *notIn*, *contains*, *notContains*, *startsWith*, *endsWith* \n\n`documentDate`: *equals*, *notEquals*, *lessThan*, *lessThanOrEquals*, *greaterThan*, *greaterThanOrEquals* \n\n`writeProtection`: *equals*, *notEquals* \n\n`address.id`: *equals*, *notEquals*, *in*, *notIn* \n\n`project.id`: *equals*, *notEquals*, *in*, *notIn* \n\n`tags`: *equals*, *notEquals*, *in*, *notIn*, *contains*, *notContains*, *startsWith*, *endsWith* \n\n`tags.id`: *equals*, *notEquals*, *in*, *notIn* \n\n`language`: *equals*, *notEquals*, *in*, *notIn* \n\n`bodyIntroduction`: *equals*, *notEquals*, *in*, *notIn*, *contains*, *notContains*, *startsWith*, *endsWith* \n\n`bodyOutroduction`: *equals*, *notEquals*, *in*, *notIn*, *contains*, *notContains*, *startsWith*, *endsWith* \n\n`project.abbreviation`: *equals*, *notEquals*, *in*, *notIn*, *contains*, *notContains*, *startsWith*, *endsWith* \n\n`internalDesignation`: *equals*, *notEquals*, *in*, *notIn*, *contains*, *notContains*, *startsWith*, *endsWith* \n\n`vatId`: *equals*, *notEquals*, *in*, *notIn*, *contains*, *notContains*, *startsWith*, *endsWith* \n\n`deliveryTerms`: *equals*, *notEquals*, *in*, *notIn*, *contains*, *notContains*, *startsWith*, *endsWith* \n\n`internalComment`: *equals*, *notEquals*, *in*, *notIn*, *contains*, *notContains*, *startsWith*, *endsWith* \n\n`isDocumentSent`: *equals*, *notEquals* \n\n`editor.id`: *equals*, *notEquals*, *in*, *notIn* \n\n`createdAt`: *equals*, *notEquals*, *lessThan*, *lessThanOrEquals*, *greaterThan*, *greaterThanOrEquals*, *isNull*, *isNotNull* \n\n`updatedAt`: *equals*, *notEquals*, *lessThan*, *lessThanOrEquals*, *greaterThan*, *greaterThanOrEquals*, *isNull*, *isNotNull* \n\n`documentAddress.name`: *equals*, *notEquals*, *in*, *notIn*, *contains*, *notContains*, *startsWith*, *endsWith* \n\n`documentAddress.title`: *equals*, *notEquals*, *in*, *notIn*, *contains*, *notContains*, *startsWith*, *endsWith* \n\n`documentAddress.contactPerson`: *equals*, *notEquals*, *in*, *notIn*, *contains*, *notContains*, *startsWith*, *endsWith* \n\n`documentAddress.department`: *equals*, *notEquals*, *in*, *notIn*, *contains*, *notContains*, *startsWith*, *endsWith* \n\n`documentAddress.subDepartment`: *equals*, *notEquals*, *in*, *notIn*, *contains*, *notContains*, *startsWith*, *endsWith* \n\n`documentAddress.addressSupplement`: *equals*, *notEquals*, *in*, *notIn*, *contains*, *notContains*, *startsWith*, *endsWith* \n\n`documentAddress.street`: *equals*, *notEquals*, *in*, *notIn*, *contains*, *notContains*, *startsWith*, *endsWith* \n\n`documentAddress.zipCode`: *equals*, *notEquals*, *in*, *notIn*, *contains*, *notContains*, *startsWith*, *endsWith* \n\n`documentAddress.city`: *equals*, *notEquals*, *in*, *notIn*, *contains*, *notContains*, *startsWith*, *endsWith* \n\n`documentAddress.state`: *equals*, *notEquals*, *in*, *notIn*, *contains*, *notContains*, *startsWith*, *endsWith* \n\n`documentAddress.country`: *equals*, *notEquals*, *in*, *notIn*, *contains*, *notContains*, *startsWith*, *endsWith* \n\n`documentAddress.gln`: *equals*, *notEquals*, *in*, *notIn*, *contains*, *notContains*, *startsWith*, *endsWith* \n\n`documentAddress.email`: *equals*, *notEquals*, *in*, *notIn*, *contains*, *notContains*, *startsWith*, *endsWith* \n\n`documentAddress.phone`: *equals*, *notEquals*, *in*, *notIn*, *contains*, *notContains*, *startsWith*, *endsWith* \n\n`documentAddress.fax`: *equals*, *notEquals*, *in*, *notIn*, *contains*, *notContains*, *startsWith*, *endsWith* \n\n`financials.paymentMethod.id`: *equals*, *notEquals*, *in*, *notIn* \n\n`financials.tax.disableTaxNotice`: *equals*, *notEquals* \n\n`financials.tax.taxRates.standard`: *equals*, *notEquals*, *lessThan*, *lessThanOrEquals*, *greaterThan*, *greaterThanOrEquals* \n\n`financials.tax.taxRates.reduced`: *equals*, *notEquals*, *lessThan*, *lessThanOrEquals*, *greaterThan*, *greaterThanOrEquals* \n\n`financials.tax.taxation`: *equals*, *notEquals*, *in*, *notIn* \n\n`totals.net.amount`: *equals*, *notEquals*, *lessThan*, *lessThanOrEquals*, *greaterThan*, *greaterThanOrEquals* \n\n`totals.net.currency`: *equals*, *notEquals*, *in*, *notIn*, *contains*, *notContains*, *startsWith*, *endsWith* \n\n`financials.paymentTerms.paymentTargetDays`: *equals*, *notEquals*, *lessThan*, *lessThanOrEquals*, *greaterThan*, *greaterThanOrEquals* \n\n`financials.paymentTerms.paymentTargetDiscount`: *equals*, *notEquals*, *lessThan*, *lessThanOrEquals*, *greaterThan*, *greaterThanOrEquals* \n\n`financials.paymentTerms.paymentTargetDiscountDays`: *equals*, *notEquals*, *lessThan*, *lessThanOrEquals*, *greaterThan*, *greaterThanOrEquals* \n\n`totals.gross.amount`: *equals*, *notEquals*, *lessThan*, *lessThanOrEquals*, *greaterThan*, *greaterThanOrEquals* \n\n`trafficLights.stock`: *equals*, *notEquals* \n\n`trafficLights.vat`: *equals*, *notEquals* \n\n`trafficLights.cashOnDelivery`: *equals*, *notEquals* \n\n`trafficLights.autoShipping`: *equals*, *notEquals* \n\n`trafficLights.customerCheck`: *equals*, *notEquals* \n\n`trafficLights.dateOfDelivery`: *equals*, *notEquals* \n\n`trafficLights.creditLimit`: *equals*, *notEquals* \n\n`trafficLights.deliveryBlock`: *equals*, *notEquals* \n\n`trafficLights.addressValidation`: *equals*, *notEquals* \n\n`trafficLights.production`: *equals*, *notEquals*, *in*, *notIn* \n\n`trafficLights.payment`: *equals*, *notEquals*, *in*, *notIn* \n\n`trafficLights.stockAvailableOpenSupply`: *equals*, *notEquals*, *in*, *notIn* \n\n`trafficLights.stockAvailableFifo`: *equals*, *notEquals*, *in*, *notIn* \n\n`status`: *equals*, *notEquals*, *in*, *notIn* \n\n`sales.id`: *equals*, *notEquals*, *in*, *notIn* \n\n`costCenter`: *equals*, *notEquals*, *in*, *notIn*, *contains*, *notContains*, *startsWith*, *endsWith* \n\n`customerNumber`: *equals*, *notEquals*, *in*, *notIn*, *contains*, *notContains*, *startsWith*, *endsWith* \n\n`supplierNumber`: *equals*, *notEquals*, *in*, *notIn*, *contains*, *notContains*, *startsWith*, *endsWith* \n\n`deviatingDeliveryAddress.name`: *equals*, *notEquals*, *in*, *notIn*, *contains*, *notContains*, *startsWith*, *endsWith* \n\n`deviatingDeliveryAddress.title`: *equals*, *notEquals*, *in*, *notIn*, *contains*, *notContains*, *startsWith*, *endsWith* \n\n`deviatingDeliveryAddress.contactPerson`: *equals*, *notEquals*, *in*, *notIn*, *contains*, *notContains*, *startsWith*, *endsWith* \n\n`deviatingDeliveryAddress.department`: *equals*, *notEquals*, *in*, *notIn*, *contains*, *notContains*, *startsWith*, *endsWith* \n\n`deviatingDeliveryAddress.subDepartment`: *equals*, *notEquals*, *in*, *notIn*, *contains*, *notContains*, *startsWith*, *endsWith* \n\n`deviatingDeliveryAddress.addressSupplement`: *equals*, *notEquals*, *in*, *notIn*, *contains*, *notContains*, *startsWith*, *endsWith* \n\n`deviatingDeliveryAddress.street`: *equals*, *notEquals*, *in*, *notIn*, *contains*, *notContains*, *startsWith*, *endsWith* \n\n`deviatingDeliveryAddress.zipCode`: *equals*, *notEquals*, *in*, *notIn*, *contains*, *notContains*, *startsWith*, *endsWith* \n\n`deviatingDeliveryAddress.city`: *equals*, *notEquals*, *in*, *notIn*, *contains*, *notContains*, *startsWith*, *endsWith* \n\n`deviatingDeliveryAddress.state`: *equals*, *notEquals*, *in*, *notIn*, *contains*, *notContains*, *startsWith*, *endsWith* \n\n`deviatingDeliveryAddress.country`: *equals*, *notEquals*, *in*, *notIn*, *contains*, *notContains*, *startsWith*, *endsWith* \n\n`deviatingDeliveryAddress.gln`: *equals*, *notEquals*, *in*, *notIn*, *contains*, *notContains*, *startsWith*, *endsWith* \n\n`deviatingDeliveryAddress.email`: *equals*, *notEquals*, *in*, *notIn*, *contains*, *notContains*, *startsWith*, *endsWith* \n\n`deviatingDeliveryAddress.phone`: *equals*, *notEquals*, *in*, *notIn*, *contains*, *notContains*, *startsWith*, *endsWith* \n\n`deviatingDeliveryAddress.fax`: *equals*, *notEquals*, *in*, *notIn*, *contains*, *notContains*, *startsWith*, *endsWith* \n\n`isSalesOrderToSupplier`: *equals*, *notEquals* \n\n`externalOrderNumber`: *equals*, *notEquals*, *in*, *notIn*, *contains*, *notContains*, *startsWith*, *endsWith* \n\n`customerOrderNumber`: *equals*, *notEquals*, *in*, *notIn*, *contains*, *notContains*, *startsWith*, *endsWith* \n\n`transactionNumber`: *equals*, *notEquals*, *in*, *notIn*, *contains*, *notContains*, *startsWith*, *endsWith* \n\n`externalOrderId`: *equals*, *notEquals*, *in*, *notIn*, *contains*, *notContains*, *startsWith*, *endsWith* \n\n`masterReferenceNumber`: *equals*, *notEquals*, *in*, *notIn*, *contains*, *notContains*, *startsWith*, *endsWith* \n\n`desiredDeliveryDate`: *equals*, *notEquals*, *lessThan*, *lessThanOrEquals*, *greaterThan*, *greaterThanOrEquals* \n\n`desiredDeliveryDateAsCalendarWeek`: *equals*, *notEquals* \n\n`earliestFulfillmentDate`: *equals*, *notEquals*, *lessThan*, *lessThanOrEquals*, *greaterThan*, *greaterThanOrEquals* \n\n`reservationDate`: *equals*, *notEquals*, *lessThan*, *lessThanOrEquals*, *greaterThan*, *greaterThanOrEquals* \n\n`preferredWarehouse.id`: *equals*, *notEquals*, *in*, *notIn* \n\n`commissionConsignmentWarehouse.id`: *equals*, *notEquals*, *in*, *notIn* \n\n`storageCountry`: *equals*, *notEquals*, *in*, *notIn* \n\n`useAlternativeDocumentTitle`: *equals*, *notEquals* \n\n`autoDispatch`: *equals*, *notEquals* \n\n`vatChecked`: *equals*, *notEquals* \n\n`createDocuments`: *equals*, *notEquals*, *in*, *notIn* \n\n`manualPaymentApproval`: *equals*, *notEquals* \n\n`manualShippingCostApproval`: *equals*, *notEquals* \n\n`manualDeliveryBlockApproval`: *equals*, *notEquals* \n\n`fastLane`: *equals*, *notEquals* \n\n`disableCancellationEmail`: *equals*, *notEquals* \n\n`disableTrackingEmail`: *equals*, *notEquals* \n\n`disablePaymentEmail`: *equals*, *notEquals* \n\n`directDebitDate`: *equals*, *notEquals*, *lessThan*, *lessThanOrEquals*, *greaterThan*, *greaterThanOrEquals* \n\n`shippingMethod.id`: *equals*, *notEquals*, *in*, *notIn* \n\n`lineItems.externalNumber`: *equals*, *notEquals*, *in*, *notIn*, *contains*, *notContains*, *startsWith*, *endsWith* \n\n`hasInvoice`: *equals*, *notEquals*" }, { "name": "sort", "value": "", "type": "query", "description": "Sort via id, -id, documentNumber, -documentNumber, documentDate, -documentDate, customerNumber, -customerNumber, documentAddress.country, -documentAddress.country, project.id, -project.id, createdAt, -createdAt, updatedAt and -updatedAt. Default sort is id" }, { "name": "search", "value": "", "type": "query", "description": "Full-text-style search across predefined columns." }, { "name": "include", "value": "", "type": "query" }, { "name": "perPage", "value": "", "type": "query", "description": "Number of items per page. Default: 15, Max: 1000" }, { "name": "page", "value": "", "type": "query", "description": "Page number. Only used with simple and table pagination." }, { "name": "cursor", "value": "", "type": "query", "description": "The cursor to use for the paginated call. Only used with cursor pagination. Not compatible with page parameter" } ] }, "docs": "This endpoint requires the following scopes: `salesOrder:read`.\n\nPaginated list of Sales Orders" }, { "info": { "name": "🔒 Create sales order V3", "type": "http" }, "http": { "method": "POST", "url": "https://{xentralId}.xentral.biz/api/v3/salesOrders", "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues.\n\nThis endpoint requires the following scopes: `salesOrder:create`.\n\nCreate a new sales order." }, { "info": { "name": "View sales order V3", "type": "http" }, "http": { "method": "GET", "url": "https://{xentralId}.xentral.biz/api/v3/salesOrders/:id", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "include", "value": "", "type": "query" } ] }, "docs": "This endpoint requires the following scopes: `salesOrder:read`.\n\nView a single sales order\n\n**Content Negotiation:** This endpoint supports additional response formats: `application/pdf`. Use the `Accept` header to request a specific format." }, { "info": { "name": "🔒 Update sales order V3", "type": "http" }, "http": { "method": "PATCH", "url": "https://{xentralId}.xentral.biz/api/v3/salesOrders/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues.\n\nThis endpoint requires the following scopes: `salesOrder:update`.\n\nUpdate a sales order." }, { "info": { "name": "Delete sales order V3", "type": "http" }, "http": { "method": "DELETE", "url": "https://{xentralId}.xentral.biz/api/v3/salesOrders/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "This endpoint requires the following scopes: `salesOrder:delete`.\n\nDelete a sales order in status draft." }, { "info": { "name": "Cancel sales order V3", "type": "http" }, "http": { "method": "PATCH", "url": "https://{xentralId}.xentral.biz/api/v3/salesOrders/:id/actions/cancel", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "This endpoint requires the following scopes: `salesOrder:cancel`.\n\nCancel a sales order. Sales orders in status draft or completed cannot be cancelled." }, { "info": { "name": "Complete sales order V3", "type": "http" }, "http": { "method": "PATCH", "url": "https://{xentralId}.xentral.biz/api/v3/salesOrders/:id/actions/complete", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "This endpoint requires the following scopes: `salesOrder:complete`.\n\nComplete a sales order. Sales orders in status draft, cancelled or already completed cannot be completed." }, { "info": { "name": "Log custom sales order activity V3", "type": "http" }, "http": { "method": "PATCH", "url": "https://{xentralId}.xentral.biz/api/v3/salesOrders/:id/actions/logActivity", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint requires the following scopes: `salesOrder:update`.\n\nRecord a custom activity log entry for a sales order." }, { "info": { "name": "Release sales order V3", "type": "http" }, "http": { "method": "PATCH", "url": "https://{xentralId}.xentral.biz/api/v3/salesOrders/:id/actions/release", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint requires the following scopes: `salesOrder:release`.\n\nRelease a sales order." }, { "info": { "name": "Remove sales order write protection V3", "type": "http" }, "http": { "method": "PATCH", "url": "https://{xentralId}.xentral.biz/api/v3/salesOrders/:id/actions/removeWriteProtection", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "This endpoint requires the following scopes: `salesOrder:removeWriteProtection`.\n\nRemove write protection from a sales order." }, { "info": { "name": "Send sales order V3", "type": "http" }, "http": { "method": "PATCH", "url": "https://{xentralId}.xentral.biz/api/v3/salesOrders/:id/actions/send", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint requires the following scopes: `salesOrder:send`.\n\nSend a sales order." }, { "info": { "name": "Set sales order write protection V3", "type": "http" }, "http": { "method": "PATCH", "url": "https://{xentralId}.xentral.biz/api/v3/salesOrders/:id/actions/setWriteProtection", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "This endpoint requires the following scopes: `salesOrder:setWriteProtection`.\n\nSet write protection for a sales order." }, { "info": { "name": "Attach file to sales order V3", "type": "http" }, "http": { "method": "POST", "url": "https://{xentralId}.xentral.biz/api/v3/salesOrders/:id/files", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint requires the following scopes: `salesOrder:update`.\n\nAttach a file to a sales order." }, { "info": { "name": "Update file on sales order V3", "type": "http" }, "http": { "method": "PATCH", "url": "https://{xentralId}.xentral.biz/api/v3/salesOrders/:id/files/:fileId", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "fileId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint requires the following scopes: `salesOrder:update`.\n\nUpdate a file attached to a sales order." }, { "info": { "name": "Delete file from sales order V3", "type": "http" }, "http": { "method": "DELETE", "url": "https://{xentralId}.xentral.biz/api/v3/salesOrders/:id/files/:fileId", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "fileId", "value": "", "type": "path" } ] }, "docs": "This endpoint requires the following scopes: `salesOrder:update`.\n\nDelete a file attached to a sales order." }, { "info": { "name": "🔒 Create sales order line item V3", "type": "http" }, "http": { "method": "POST", "url": "https://{xentralId}.xentral.biz/api/v3/salesOrders/:id/lineItems", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues.\n\nThis endpoint requires the following scopes: `salesOrder:update`.\n\nCreate a new sales order line item." }, { "info": { "name": "View sales order line item V3", "type": "http" }, "http": { "method": "GET", "url": "https://{xentralId}.xentral.biz/api/v3/salesOrders/:id/lineItems/:lineItemId", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "lineItemId", "value": "", "type": "path" }, { "name": "include", "value": "", "type": "query" } ] }, "docs": "This endpoint requires the following scopes: `salesOrder:read`.\n\nView a single sales order line item." }, { "info": { "name": "🔒 Update sales order line item V3", "type": "http" }, "http": { "method": "PATCH", "url": "https://{xentralId}.xentral.biz/api/v3/salesOrders/:id/lineItems/:lineItemId", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "lineItemId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues.\n\nThis endpoint requires the following scopes: `salesOrder:update`.\n\nUpdate a line item in a sales order." }, { "info": { "name": "Delete sales order line item V3", "type": "http" }, "http": { "method": "DELETE", "url": "https://{xentralId}.xentral.biz/api/v3/salesOrders/:id/lineItems/:lineItemId", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "lineItemId", "value": "", "type": "path" } ] }, "docs": "This endpoint requires the following scopes: `salesOrder:update`.\n\nDelete a line item of a sales order." } ] } ], "bundled": true }