Read sales order lines

GET /salesorders/{id}/lines

Read all lines associated with a specific sales order.

Headers

Path parameters

  • id integer(int32) Required

    The unique identifier for the sales order, to which the sales order lines pertain.

Responses

  • 200 application/json

    OK

    Hide headers attributes Show headers attributes
    Hide response attributes Show response attributes object
    • id number

      The unique identifier for the sales order line item within 24SevenOffice ERP.

    • type string

      A specification for the type of the line item, whether this is a product or a text entry.

      Values are product or text.

    • product object

      Product details, if the line item type is 'product'. Note that the product object for the /salesorders/{id}/lines endpoint is not the same as the product that can be retrieved from the /products endpoint, even though both share the same ID reference and their schemas are similar. The product object in the context of /salesorders/{id}/lines contains the product details as they were at the time the sales order line item was created. In contrast, the /products endpoint always provides the latest state values for the product properties.

      Additional properties are allowed.

      Hide product attribute Show product attribute object
      • id number

        A unique identifier for the product within 24SevenOffice ERP-modules.

    • description string

      A description for the line item.

      Minimum length is 1, maximum length is 300.

    • quantity number

      The quantity of the product in the line item.

    • price number

      The price of a single unit of the product in the line item.

    • discountRate number

      The discount rate applied to the line item, expressed as a whole number. For example, a discount rate of 10% is represented as 10.

      Minimum value is 0, maximum value is 100.

    • tax object

      Details for the tax applied to the line item.

      Additional properties are allowed.

      Hide tax attributes Show tax attributes object
      • id number

        A unique identifier for the tax code within 24SevenOffice ERP modules, associated with the line item.

      • number integer(int32)

        The tax code reference number visible for users.

      • rate number

        The tax rate percentage, expressed as a whole number. For example, a tax rate of 25% is represented as 25.

        Minimum value is 0, maximum value is 100.

    • account object

      Details for the account to which the sale is posted.

      Additional properties are allowed.

      Hide account attributes Show account attributes object
      • id number

        A unique identifier for the account within 24SevenOffice accounting module.

      • number integer(int32)

        The unique number that indicates which type of account it belongs to.

      • name string

        The human-readable name that describes the purpose or nature of the account.

        Maximum length is 75.
GET /salesorders/{id}/lines 
curl \
 -X GET https://rest.api.24sevenoffice.com/v1/salesorders/{id}/lines \
 -H "Authorization: string"
Response examples (200) 
[
  {
    "id": 1,
    "tax": {
      "id": 1,
      "rate": 25,
      "number": 1
    },
    "type": "product",
    "price": 49.99,
    "account": {
      "id": 200001,
      "name": "Accounts Receivable",
      "number": 1500
    },
    "product": {
      "id": 101
    },
    "quantity": 2,
    "description": "Leather handbag with adjustable strap.",
    "discountRate": 10
  },
  {
    "id": 2,
    "tax": {
      "id": 1,
      "rate": 25,
      "number": 1
    },
    "type": "text",
    "price": 4.99,
    "account": {
      "id": 200001,
      "name": "Accounts Receivable",
      "number": 1500
    },
    "quantity": 5,
    "description": "Customized gift wrapping service.",
    "discountRate": 0
  },
  {
    "id": 3,
    "tax": {
      "id": 1,
      "rate": 25,
      "number": 1
    },
    "type": "product",
    "price": 39.99,
    "account": {
      "id": 200001,
      "name": "Accounts Receivable",
      "number": 1500
    },
    "product": {
      "id": 103
    },
    "quantity": 1,
    "description": "Silk scarves with intricate floral patterns.",
    "discountRate": 0
  }
]