Releases: xentral/api-spec-public
Releases · xentral/api-spec-public
API Update
v23.15.5 API Update
(Improvement) Delivery Note API
The delivery notes can now be filtered by the status and date via the API
(Improvement) Sales Order API
Sales Order API
The Created At field will now be filled with the current date for new sales orders, and with the earliest logged date from the protocol for existing orders.
### List sales orders
# @name salesOrder.list
GET {{base_url}}/salesOrders?page[number]=1&page[size]=10
Accept: application/vnd.xentral.default.v1-beta+json
Authorization: Bearer {{auth_token}}
### Response
...
"log": {
"createdAt": "2022-02-23 11:09:50",
"createdBy": {
"id": "1",
"name": "Administrator"
}
}
}
Webhooks and Sales Order API
- You can now subscribe to an event that will be generated whenever the product is created using webhooks.
- External developers can now create, read, update and delete a product's purchase prices via the API.
- We have streamlined the statuses in the sales order API's LIST and VIEW endpoints to be consistent with other document types like invoices.
- We have improved the structure of the LIST and GET endpoints for sales orders.
{
"data": {
"id": "string",
"orderNumber": "string",
"externalOrderNumber": "string",
"customerOrderNumber": "string",
"date": "2023-03-22",
"status": "completed",
"customer": {
"id": "string",
"number": "string"
},
"comment": "string",
"project": {
"id": "string"
},
"description": "string",
"language": "string",
"payment": {
"method": "string",
"currency": "string",
"paymentTerms": {
"earlyPaymentDiscount": 0,
"dueDate": 0,
"earlyPaymentDate": 0
},
"billingAddress": {
"name": "string",
"department": "string",
"subDepartment": "string",
"street": "string",
"zipCode": "string",
"city": "string",
"state": "string",
"country": "string",
"gln": "string"
}
},
"delivery": {
"email": "string",
"conditions": "string",
"autoShipping": true,
"fastLane": true,
"shippingAddress": {
"name": "string",
"department": "string",
"subDepartment": "string",
"street": "string",
"zipCode": "string",
"city": "string",
"state": "string",
"country": "string",
"gln": "string"
}
},
"positions": [
{
"id": "string",
"quantity": 0,
"comment": "string",
"product": {
"id": "string",
"number": "string",
"name": "string",
"description": "string"
},
"tax": {
"rate": 0,
"vatCategory": "string",
"fiscalText": "string"
},
"price": {
"amount": "string",
"currency": "EUR",
"discount": "string"
}
}
]
}
}
Credit Notes API
We created an API endpoint to deliver all related documents for a specific credit note. This endpoint is currently in Beta.
Products API, Sales Order API and Standard API
Products API and Liabilities API
Products API
Filtering for freefields in GET /api/products
It is now possible to filter for specific freefields in the GET /api/products endpoint.
Example
POST https://xentralId.xentral.biz/api/products?filter[0][key]=freeField1&filter[0][op]=contains&filter[0][value]=beer
Liabilities API
GET /api/liabilities(in beta)
We are testing the new liabilities endpoint for fetching liabilities:
Example
GET https://xentralId.xentral.biz/api/liabilities
Products and Invoices API
Added two new endpoints:
POST /api/products
for creating new productsGET /api/invoices
for listing invoices