Skip to content

Releases: xentral/api-spec-public

API Update

25 Sep 11:10
Compare
Choose a tag to compare
v23.15.5

API Update

(Improvement) Delivery Note API

16 Jun 12:47
Compare
Choose a tag to compare

The delivery notes can now be filtered by the status and date via the API

(Improvement) Sales Order API

25 Apr 15:09
Compare
Choose a tag to compare

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

24 Mar 13:49
Compare
Choose a tag to compare
  1. You can now subscribe to an event that will be generated whenever the product is created using webhooks.
  2. External developers can now create, read, update and delete a product's purchase prices via the API.
  3. We have streamlined the statuses in the sales order API's LIST and VIEW endpoints to be consistent with other document types like invoices.
  4. 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

01 Mar 10:39
Compare
Choose a tag to compare

We created an API endpoint to deliver all related documents for a specific credit note. This endpoint is currently in Beta.

Credit Notes View

Products API, Sales Order API and Standard API

16 Feb 14:29
Compare
Choose a tag to compare

Products API and Liabilities API

18 Jan 09:11
Compare
Choose a tag to compare

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

13 Jan 10:38
Compare
Choose a tag to compare

Added two new endpoints:

  1. POST /api/products for creating new products
  2. GET /api/invoices for listing invoices