API Reference
GuidesAPI ReferenceRoadmap
API Reference
API Reference

List sales orders V3

get
https://{xentralId}.xentral.biz/api/v3/salesOrders

This endpoint requires the following scopes: salesOrder:read.

Paginated list of Sales Orders

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
filter
array of objects

The filter parameter is used to filter the results of the given endpoint.

Supported filter operators by key:

id: equals, notEquals, in, notIn

documentNumber: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith

documentDate: equals, notEquals, lessThan, lessThanOrEquals, greaterThan, greaterThanOrEquals

writeProtection: equals, notEquals

address.id: equals, notEquals, in, notIn

project.id: equals, notEquals, in, notIn

tags: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith

tags.id: equals, notEquals, in, notIn

language: equals, notEquals, in, notIn

bodyIntroduction: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith

bodyOutroduction: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith

project.abbreviation: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith

internalDesignation: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith

vatId: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith

deliveryTerms: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith

internalComment: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith

isDocumentSent: equals, notEquals

createdAt: equals, notEquals, lessThan, lessThanOrEquals, greaterThan, greaterThanOrEquals, isNull, isNotNull

updatedAt: equals, notEquals, lessThan, lessThanOrEquals, greaterThan, greaterThanOrEquals, isNull, isNotNull

documentAddress.name: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith

documentAddress.title: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith

documentAddress.contactPerson: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith

documentAddress.department: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith

documentAddress.subDepartment: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith

documentAddress.addressSupplement: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith

documentAddress.street: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith

documentAddress.zipCode: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith

documentAddress.city: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith

documentAddress.state: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith

documentAddress.country: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith

documentAddress.gln: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith

documentAddress.email: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith

documentAddress.phone: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith

documentAddress.fax: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith

financials.paymentMethod.id: equals, notEquals, in, notIn

financials.tax.disableTaxNotice: equals, notEquals

financials.tax.taxRates.standard: equals, notEquals, lessThan, lessThanOrEquals, greaterThan, greaterThanOrEquals

financials.tax.taxRates.reduced: equals, notEquals, lessThan, lessThanOrEquals, greaterThan, greaterThanOrEquals

financials.tax.taxation: equals, notEquals, in, notIn

totals.net.amount: equals, notEquals, lessThan, lessThanOrEquals, greaterThan, greaterThanOrEquals

totals.net.currency: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith

financials.paymentTerms.paymentTargetDays: equals, notEquals, lessThan, lessThanOrEquals, greaterThan, greaterThanOrEquals

financials.paymentTerms.paymentTargetDiscount: equals, notEquals, lessThan, lessThanOrEquals, greaterThan, greaterThanOrEquals

financials.paymentTerms.paymentTargetDiscountDays: equals, notEquals, lessThan, lessThanOrEquals, greaterThan, greaterThanOrEquals

totals.gross.amount: equals, notEquals, lessThan, lessThanOrEquals, greaterThan, greaterThanOrEquals

trafficLights.stock: equals, notEquals

trafficLights.vat: equals, notEquals

trafficLights.cashOnDelivery: equals, notEquals

trafficLights.autoShipping: equals, notEquals

trafficLights.customerCheck: equals, notEquals

trafficLights.dateOfDelivery: equals, notEquals

trafficLights.creditLimit: equals, notEquals

trafficLights.deliveryBlock: equals, notEquals

trafficLights.addressValidation: equals, notEquals

trafficLights.production: equals, notEquals, in, notIn

trafficLights.payment: equals, notEquals, in, notIn

trafficLights.stockAvailableOpenSupply: equals, notEquals, in, notIn

trafficLights.stockAvailableFifo: equals, notEquals, in, notIn

status: equals, notEquals, in, notIn

editor.id: equals, notEquals, in, notIn

sales.id: equals, notEquals, in, notIn

costCenter: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith

customerNumber: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith

supplierNumber: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith

deviatingDeliveryAddress.name: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith

deviatingDeliveryAddress.title: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith

deviatingDeliveryAddress.contactPerson: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith

deviatingDeliveryAddress.department: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith

deviatingDeliveryAddress.subDepartment: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith

deviatingDeliveryAddress.addressSupplement: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith

deviatingDeliveryAddress.street: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith

deviatingDeliveryAddress.zipCode: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith

deviatingDeliveryAddress.city: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith

deviatingDeliveryAddress.state: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith

deviatingDeliveryAddress.country: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith

deviatingDeliveryAddress.gln: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith

deviatingDeliveryAddress.email: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith

deviatingDeliveryAddress.phone: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith

deviatingDeliveryAddress.fax: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith

isSalesOrderToSupplier: equals, notEquals

externalOrderNumber: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith

customerOrderNumber: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith

transactionNumber: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith

externalOrderId: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith

masterReferenceNumber: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith

desiredDeliveryDate: equals, notEquals, lessThan, lessThanOrEquals, greaterThan, greaterThanOrEquals

desiredDeliveryDateAsCalendarWeek: equals, notEquals

earliestFulfillmentDate: equals, notEquals, lessThan, lessThanOrEquals, greaterThan, greaterThanOrEquals

reservationDate: equals, notEquals, lessThan, lessThanOrEquals, greaterThan, greaterThanOrEquals

preferredWarehouse.id: equals, notEquals, in, notIn

commissionConsignmentWarehouse.id: equals, notEquals, in, notIn

storageCountry: equals, notEquals, in, notIn

useAlternativeDocumentTitle: equals, notEquals

autoDispatch: equals, notEquals

vatChecked: equals, notEquals

createDocuments: equals, notEquals, in, notIn

manualPaymentApproval: equals, notEquals

manualShippingCostApproval: equals, notEquals

manualDeliveryBlockApproval: equals, notEquals

fastLane: equals, notEquals

disableCancellationEmail: equals, notEquals

disableTrackingEmail: equals, notEquals

disablePaymentEmail: equals, notEquals

directDebitDate: equals, notEquals, lessThan, lessThanOrEquals, greaterThan, greaterThanOrEquals

shippingMethod.id: equals, notEquals, in, notIn

lineItems.externalNumber: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith

hasInvoice: equals, notEquals

filter
sort
array

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

sort
include
array of strings
include
integer

Number of items per page. Default: 15, Max: 1000

integer

Page number. Only used with simple and table pagination.

string

The cursor to use for the paginated call. Only used with cursor pagination. Not compatible with page parameter

Headers
string
enum

Controls the pagination format. Available types: simple, table, cursor. Defaults to 'simple' if not specified.

Allowed:
Responses

401

Unauthorized

403

Forbidden

Updated 3 months ago

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago