Create a sales order

POST /salesorders

Create a new sales order with customer details and order information.

Headers

Authorization string Required

Authorization header

application/json

Body

customer object

Customer details for the sales order. Note that the customer object for the /salesOrders endpoint is not the same as the customer that can be retrieved from the /customers endpoint, even though both share the same ID reference and their schemas are similar. The customer object in the context of /salesOrders contains the customer details as they were at the time the sales order was created. In contrast, the /customers endpoint always provides the latest state values for the customer properties.
Hide customer attributes Show customer attributes
- id number
  
  A unique identifier for the customer within 24SevenOffice CRM.
- organizationNumber string
  
  The organization number issued by authorities, like a VAT number, of the customer if the customer is a company.
  
  Maximum length is 20.
- gln string
  
  The Global Location Number (GLN) for the customer.
  
  Minimum length is 13, maximum length is 13.
- name string
  
  The customer name as it appears on the sales order and an invoice associated with the sales order.
  
  Maximum length is 200.
- street string
  
  The street for the address. Can contain a street name, building and apartment number, a PO box number, or similar.
  
  Maximum length is 250.
- postalCode string
  
  The postal code for the address.
  
  Maximum length is 50.
- postalArea string
  
  The postal area for the address.
  
  Maximum length is 50.
- city string
  
  The city for the address.
  
  Maximum length is 50.
- countrySubdivision string
  
  The geographical subdivision for the address, like a county ("fylke" in Norway) or a state.
  
  Maximum length is 50.
- countryCode string
  
  The two-letter country code for the address, as in ISO 3166-1 alpha-2 standard.
  
  Maximum length is 2.
status string

Current status of the sales order.

Values are Draft, Proposal, Confirmed, Invoice, or AdvanceInvoice.
deliveryCustomer object

Delivery details for the sales order.
Hide deliveryCustomer attributes Show deliveryCustomer attributes
- id number
  
  A unique identifier for the customer within 24SevenOffice CRM.
- name string
  
  A human-readable name or label for a customer, making it easily identifiable to users.
  
  Maximum length is 250.
- street string
  
  The street for the address. Can contain a street name, building and apartment number, a PO box number, or similar.
  
  Maximum length is 250.
- postalCode string
  
  The postal code for the address.
  
  Maximum length is 16.
- postalArea string
  
  The postal area for the address.
  
  Maximum length is 200.
- city string
  
  The city name for the address.
  
  Maximum length is 50.
- countrySubdivision string
  
  The geographical subdivision for the address, like a county ("fylke" in Norway) or a state.
  
  Maximum length is 100.
- countryCode string
  
  The two-letter country code for the address, as in ISO 3166-1 alpha-2 standard.
  
  Maximum length is 2.
invoice object

Details of an invoice associated with a sales order.
Hide invoice attributes Show invoice attributes
- number integer(int32)
  
  A unique number for the invoice within 24SevenOffice ERP.
- date string(date)
  
  The date when the invoice was issued.
- dueDate string(date)
  
  The due date by which the invoice must be paid.
- remittanceReference string
  
  A reference number for the invoice used for remittance purposes, like "KID"-number in Norway, or OCR.
date string(date)

The date when the sales order was issued.
internalMemo string

An internal memo for the sales order.

Maximum length is 300.
memo string

A memo or comments for the sales order.
salesType object

The sales type for the sales order.
Hide salesType attribute Show salesType attribute
- id number
  
  The unique identifier for the sales type. A negative value stands for a system-defined ID.
createdAt string(date-time)

A timestamp for when a record was created, in ISO 8601 format.
modifiedAt string(date-time)

A timestamp for when one of the properties of a record was last modified, in ISO 8601 format.

Responses

200 application/json

OK
Hide headers attributes Show headers attributes
- Access-Control-Allow-Origin string
- Access-Control-Allow-Credentials string
- X-Trace-Id string
Hide response attributes Show response attributes object
- id number
  
  A unique identifier for the sales order within 24SevenOffice ERP.
- customer object
  
  Customer details for the sales order. Note that the customer object for the /salesOrders endpoint is not the same as the customer that can be retrieved from the /customers endpoint, even though both share the same ID reference and their schemas are similar. The customer object in the context of /salesOrders contains the customer details as they were at the time the sales order was created. In contrast, the /customers endpoint always provides the latest state values for the customer properties.
  
  Hide customer attributes Show customer attributes
  
  id number
  
  A unique identifier for the customer within 24SevenOffice CRM.
  
  organizationNumber string
  
  The organization number issued by authorities, like a VAT number, of the customer if the customer is a company.
  
  Maximum length is 20.
  
  gln string
  
  The Global Location Number (GLN) for the customer.
  
  Minimum length is 13, maximum length is 13.
  
  name string
  
  The customer name as it appears on the sales order and an invoice associated with the sales order.
  
  Maximum length is 200.
  
  street string
  
  The street for the address. Can contain a street name, building and apartment number, a PO box number, or similar.
  
  Maximum length is 250.
  
  postalCode string
  
  The postal code for the address.
  
  Maximum length is 50.
  
  postalArea string
  
  The postal area for the address.
  
  Maximum length is 50.
  
  city string
  
  The city for the address.
  
  Maximum length is 50.
  
  countrySubdivision string
  
  The geographical subdivision for the address, like a county ("fylke" in Norway) or a state.
  
  Maximum length is 50.
  
  countryCode string
  
  The two-letter country code for the address, as in ISO 3166-1 alpha-2 standard.
  
  Maximum length is 2.
- status string
  
  Current status of the sales order.
  
  Values are Draft, Proposal, Confirmed, Invoice, or AdvanceInvoice.
- deliveryCustomer object
  
  Delivery details for the sales order.
  
  Hide deliveryCustomer attributes Show deliveryCustomer attributes
  
  id number
  
  A unique identifier for the customer within 24SevenOffice CRM.
  
  name string
  
  A human-readable name or label for a customer, making it easily identifiable to users.
  
  Maximum length is 250.
  
  street string
  
  The street for the address. Can contain a street name, building and apartment number, a PO box number, or similar.
  
  Maximum length is 250.
  
  postalCode string
  
  The postal code for the address.
  
  Maximum length is 16.
  
  postalArea string
  
  The postal area for the address.
  
  Maximum length is 200.
  
  city string
  
  The city name for the address.
  
  Maximum length is 50.
  
  countrySubdivision string
  
  The geographical subdivision for the address, like a county ("fylke" in Norway) or a state.
  
  Maximum length is 100.
  
  countryCode string
  
  The two-letter country code for the address, as in ISO 3166-1 alpha-2 standard.
  
  Maximum length is 2.
- invoice object
  
  Details of an invoice associated with a sales order.
  
  Hide invoice attributes Show invoice attributes
  
  number integer(int32)
  
  A unique number for the invoice within 24SevenOffice ERP.
  
  date string(date)
  
  The date when the invoice was issued.
  
  dueDate string(date)
  
  The due date by which the invoice must be paid.
  
  remittanceReference string
  
  A reference number for the invoice used for remittance purposes, like "KID"-number in Norway, or OCR.
- date string(date)
  
  The date when the sales order was issued.
- internalMemo string
  
  An internal memo for the sales order.
  
  Maximum length is 300.
- memo string
  
  A memo or comments for the sales order.
- salesType object
  
  The sales type for the sales order.
  
  Hide salesType attribute Show salesType attribute
  
  id number
  
  The unique identifier for the sales type. A negative value stands for a system-defined ID.
- createdAt string(date-time)
  
  A timestamp for when a record was created, in ISO 8601 format.
- modifiedAt string(date-time)
  
  A timestamp for when one of the properties of a record was last modified, in ISO 8601 format.
400 application/json

Bad request
Hide headers attributes Show headers attributes
- Access-Control-Allow-Origin string
- Access-Control-Allow-Credentials string
- X-Trace-Id string
One of:
BadRequestError object ValidationError object
Hide attributes Show attributes

error object

Bad request error details.

Hide error attributes Show error attributes

name string

The name for the error.

Value is BadRequestError. Default value is BadRequestError.

payload object

The payload for the bad request error.

Hide payload attribute Show payload attribute

errors array[object]

A list of errors.

Hide errors attributes Show errors attributes object

type string

The type of the error.

Values are DepartmentMissing, ProjectMissing, or NoLines.

message string

An error message.

arguments array[string]

Arguments for the error message.

trackingId string

A tracking identifier for the bad request error.
Hide attributes Show attributes

error object

Validation error details.

Hide error attributes Show error attributes

name string

The name for the error.

Value is ValidationError. Default value is ValidationError.

payload object

The payload for the validation error.

Hide payload attribute Show payload attribute

validationErrors array[object]

A list of validation errors.

Hide validationErrors attributes Show validationErrors attributes object

path string

A path for the invalid field.

keyword string

A validation keyword.

trackingId string

A tracking identifier for the validation error.

POST /salesorders

curl \
 -X POST https://rest.api.24sevenoffice.com/v1/salesorders \
 -H "Content-Type: application/json" \
 -H "Authorization: string" \
 -d '{"customer":{"id":12345,"organizationNumber":"123456789","gln":"1234567890123","name":"ABC Corporation","street":"Hovedgata 1","postalCode":"0123","postalArea":"Fornebu","city":"Fornebu","countrySubdivision":"Viken","countryCode":"NO"},"status":"Invoice","deliveryCustomer":{"id":12345,"name":"ABC Corporation","street":"Hovedgata 1","postalCode":"0123","postalArea":"Fornebu","city":"Fornebu","countrySubdivision":"Viken","countryCode":"NO"},"invoice":{"number":123,"date":"2023-06-01","dueDate":"2023-06-15","remittanceReference":"ABC12345"},"date":"2023-06-01","internalMemo":"Customer requested special packaging.","memo":"Urgent delivery.","salesType":{"id":10},"createdAt":"2023-06-01T12:00:00Z","modifiedAt":"2023-06-02T15:30:00Z"}'

Request examples

# Headers
Authorization: string

# Payload
{
  "customer": {
    "id": 12345,
    "organizationNumber": "123456789",
    "gln": "1234567890123",
    "name": "ABC Corporation",
    "street": "Hovedgata 1",
    "postalCode": "0123",
    "postalArea": "Fornebu",
    "city": "Fornebu",
    "countrySubdivision": "Viken",
    "countryCode": "NO"
  },
  "status": "Invoice",
  "deliveryCustomer": {
    "id": 12345,
    "name": "ABC Corporation",
    "street": "Hovedgata 1",
    "postalCode": "0123",
    "postalArea": "Fornebu",
    "city": "Fornebu",
    "countrySubdivision": "Viken",
    "countryCode": "NO"
  },
  "invoice": {
    "number": 123,
    "date": "2023-06-01",
    "dueDate": "2023-06-15",
    "remittanceReference": "ABC12345"
  },
  "date": "2023-06-01",
  "internalMemo": "Customer requested special packaging.",
  "memo": "Urgent delivery.",
  "salesType": {
    "id": 10
  },
  "createdAt": "2023-06-01T12:00:00Z",
  "modifiedAt": "2023-06-02T15:30:00Z"
}

Response examples (200)

# Headers
Access-Control-Allow-Origin: string
Access-Control-Allow-Credentials: string
X-Trace-Id: string

# Payload
{
  "id": 1234,
  "customer": {
    "id": 12345,
    "organizationNumber": "123456789",
    "gln": "1234567890123",
    "name": "ABC Corporation",
    "street": "Hovedgata 1",
    "postalCode": "0123",
    "postalArea": "Fornebu",
    "city": "Fornebu",
    "countrySubdivision": "Viken",
    "countryCode": "NO"
  },
  "status": "Invoice",
  "deliveryCustomer": {
    "id": 12345,
    "name": "ABC Corporation",
    "street": "Hovedgata 1",
    "postalCode": "0123",
    "postalArea": "Fornebu",
    "city": "Fornebu",
    "countrySubdivision": "Viken",
    "countryCode": "NO"
  },
  "invoice": {
    "number": 123,
    "date": "2023-06-01",
    "dueDate": "2023-06-15",
    "remittanceReference": "ABC12345"
  },
  "date": "2023-06-01",
  "internalMemo": "Customer requested special packaging.",
  "memo": "Urgent delivery.",
  "salesType": {
    "id": 10
  },
  "createdAt": "2023-06-01T12:00:00Z",
  "modifiedAt": "2023-06-02T15:30:00Z"
}

Response examples (400)

# Headers
Access-Control-Allow-Origin: string
Access-Control-Allow-Credentials: string
X-Trace-Id: string

# Payload
{
  "error": {
    "name": "BadRequestError",
    "payload": {
      "errors": [
        {
          "type": "NoLines",
          "message": "No lines in the sales order",
          "arguments": [
            "lineItems"
          ]
        }
      ]
    }
  },
  "trackingId": "ghi789"
}

# Headers
Access-Control-Allow-Origin: string
Access-Control-Allow-Credentials: string
X-Trace-Id: string

# Payload
{
  "error": {
    "name": "ValidationError",
    "payload": {
      "validationErrors": [
        {
          "path": "customer.name",
          "keyword": "required"
        }
      ]
    }
  },
  "trackingId": "def456"
}