API ReferenceRoadmap
improved

23.0.30

Sales Order 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"
        }
      }
    ]
  }
}