Read sales orders

GET /salesorders

Read existing sales orders with optional filters.

Headers

Query parameters

  • limit number(int32)

    The maximum number of sales orders to retrieve.

  • A token for continuing the retrieval of sales orders.

  • date string(date)

    A specific date to filter sales orders.

  • dateFrom string(date)

    A start date to filter sales orders.

  • dateTo string(date)

    An end date to filter sales orders.

  • status string

    Filter sales orders by their status.

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

  • Filter sales orders by customer ID.

  • Filter sales orders by invoice number.

  • createdFrom string(date-time)

    A start date-time to filter sales orders by creation time.

  • createdTo string(date-time)

    An end date-time to filter sales orders by creation time.

  • modifiedFrom string(date-time)

    A start date-time to filter sales orders by modification time.

  • modifiedTo string(date-time)

    An end date-time to filter sales orders by modification time.

Responses

  • OK

    Hide headers attributes Show headers attributes
    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.

      Additional properties are allowed.

      Hide customer attributes Show customer attributes object
      • id number

        A unique identifier for the customer within 24SevenOffice CRM.

      • 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.

      • The postal code for the address.

        Maximum length is 50.

      • The postal area for the address.

        Maximum length is 50.

      • city string

        The city for the address.

        Maximum length is 50.

      • The geographical subdivision for the address, like a county ("fylke" in Norway) or a state.

        Maximum length is 50.

      • 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.

    • Delivery details for the sales order.

      Additional properties are allowed.

      Hide deliveryCustomer attributes Show deliveryCustomer attributes object
      • 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.

      • The postal code for the address.

        Maximum length is 16.

      • The postal area for the address.

        Maximum length is 200.

      • city string

        The city name for the address.

        Maximum length is 50.

      • The geographical subdivision for the address, like a county ("fylke" in Norway) or a state.

        Maximum length is 100.

      • 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.

      Additional properties are allowed.

      Hide invoice attributes Show invoice attributes object
      • 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.

      • A reference number for the invoice used for remittance purposes, like "KID"-number in Norway, or OCR.

      • Details of the transaction associated with the invoice.

        Additional properties are allowed.

        Hide transaction attribute Show transaction attribute object
        • id string(guid)

          A unique identifier for the transaction within 24SevenOffice ERP.

    • date string(date)

      The date when the sales order was issued.

    • An internal memo for the sales order.

      Maximum length is 300.

    • memo string

      A memo or comments for the sales order.

    • The sales type for the sales order.

      Additional properties are allowed.

      Hide salesType attribute Show salesType attribute object
      • 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.

    Hide response attribute Show response attribute object
    • Additional properties are allowed.

      Hide _embedded attribute Show _embedded attribute object
      • salesorders array[object]
        Hide salesorders attributes Show salesorders 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.

          Additional properties are allowed.

          Hide customer attributes Show customer attributes object
          • id number

            A unique identifier for the customer within 24SevenOffice CRM.

          • 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.

          • The postal code for the address.

            Maximum length is 50.

          • The postal area for the address.

            Maximum length is 50.

          • city string

            The city for the address.

            Maximum length is 50.

          • The geographical subdivision for the address, like a county ("fylke" in Norway) or a state.

            Maximum length is 50.

          • 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.

        • Delivery details for the sales order.

          Additional properties are allowed.

          Hide deliveryCustomer attributes Show deliveryCustomer attributes object
          • 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.

          • The postal code for the address.

            Maximum length is 16.

          • The postal area for the address.

            Maximum length is 200.

          • city string

            The city name for the address.

            Maximum length is 50.

          • The geographical subdivision for the address, like a county ("fylke" in Norway) or a state.

            Maximum length is 100.

          • 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.

          Additional properties are allowed.

          Hide invoice attributes Show invoice attributes object
          • 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.

          • A reference number for the invoice used for remittance purposes, like "KID"-number in Norway, or OCR.

          • Details of the transaction associated with the invoice.

            Additional properties are allowed.

            Hide transaction attribute Show transaction attribute object
            • id string(guid)

              A unique identifier for the transaction within 24SevenOffice ERP.

        • date string(date)

          The date when the sales order was issued.

        • An internal memo for the sales order.

          Maximum length is 300.

        • memo string

          A memo or comments for the sales order.

        • The sales type for the sales order.

          Additional properties are allowed.

          Hide salesType attribute Show salesType attribute object
          • 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.

GET /salesorders
curl \
 -X GET https://rest.api.24sevenoffice.com/v1/salesorders \
 -H "Authorization: string"
Response examples (200)
[
  {
    "id": 1234,
    "date": "2023-06-01",
    "memo": "Urgent delivery.",
    "status": "Invoice",
    "invoice": {
      "date": "2023-06-01",
      "number": 123,
      "dueDate": "2023-06-15",
      "remittanceReference": "ABC12345"
    },
    "customer": {
      "id": 12345,
      "gln": "1234567890123",
      "city": "Fornebu",
      "name": "ABC Corporation",
      "street": "Hovedgata 1",
      "postalArea": "Fornebu",
      "postalCode": "0123",
      "countryCode": "NO",
      "countrySubdivision": "Viken",
      "organizationNumber": "123456789"
    },
    "createdAt": "2023-06-01T12:00:00Z",
    "salesType": {
      "id": 10
    },
    "modifiedAt": "2023-06-02T15:30:00Z",
    "internalMemo": "Customer requested special packaging.",
    "deliveryCustomer": {
      "id": 12345,
      "city": "Fornebu",
      "name": "ABC Corporation",
      "street": "Hovedgata 1",
      "postalArea": "Fornebu",
      "postalCode": "0123",
      "countryCode": "NO",
      "countrySubdivision": "Viken"
    }
  },
  {
    "id": 5678,
    "date": "2023-07-01",
    "memo": "Express delivery.",
    "status": "Draft",
    "invoice": {
      "date": "2023-07-01",
      "dueDate": "2023-07-15"
    },
    "customer": {
      "id": 67890,
      "gln": "9876543210987",
      "city": "Oslo",
      "name": "ZYX Ltd.",
      "street": "Sentralplass 5",
      "postalArea": "Oslo",
      "postalCode": "0456",
      "countryCode": "NO",
      "countrySubdivision": "Oslo",
      "organizationNumber": "987654321"
    },
    "createdAt": "2023-07-01T08:30:00Z",
    "salesType": {
      "id": 20
    },
    "modifiedAt": "2023-07-02T10:00:00Z",
    "internalMemo": "Customer needs delivery before end of month.",
    "deliveryCustomer": {
      "id": 67890,
      "city": "Oslo",
      "name": "John Smith at ZYX Ltd.",
      "street": "Sentralplass 5",
      "postalArea": "Oslo",
      "postalCode": "0456",
      "countryCode": "NO",
      "countrySubdivision": "Oslo"
    }
  },
  {
    "id": 91011,
    "date": "2023-08-01",
    "memo": "Handle with care.",
    "status": "AdvanceInvoice",
    "invoice": {
      "date": "2023-08-01",
      "number": 789,
      "dueDate": "2023-08-15",
      "remittanceReference": "DEF78901"
    },
    "customer": {
      "id": 11223,
      "gln": "5647382910234",
      "city": "Bergen",
      "name": "DEF Industries",
      "street": "Industriveien 10",
      "postalArea": "Bergen",
      "postalCode": "5001",
      "countryCode": "NO",
      "countrySubdivision": "Vestland",
      "organizationNumber": "564738291"
    },
    "createdAt": "2023-08-01T09:00:00Z",
    "salesType": {
      "id": 30
    },
    "modifiedAt": "2023-08-02T11:15:00Z",
    "internalMemo": "Customer has specific handling instructions.",
    "deliveryCustomer": {
      "id": 11223,
      "city": "Bergen",
      "name": "DEF Industries",
      "street": "Industriveien 10",
      "postalArea": "Bergen",
      "postalCode": "5001",
      "countryCode": "NO",
      "countrySubdivision": "Vestland"
    }
  }
]
Response examples (200)
# Headers
Link: string
Access-Control-Allow-Origin: string
Access-Control-Allow-Credentials: string
X-Trace-Id: string

# Payload
{
  "_embedded": {
    "salesorders": [
      {
        "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",
          "transaction": {
            "id": "63293496-884f-4358-b489-f641fe51cdaa"
          }
        },
        "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"
      }
    ]
  }
}