Read a sales order line by ID

GET /salesorders/{id}/lines/{lineId}

Tfso

Read a specific line from a sales order by the line's ID.

Headers

Authorization string Required

Authorization header

Path parameters

id integer(int32) Required

The unique identifier for the sales order, to which all the sales order lines pertain.
lineId integer(int32) Required

The unique identifier of the sales order line.

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 integer
  
  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.
  
  Hide product attribute Show product attribute object
  
  id integer
  
  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.
  
  Hide tax attributes Show tax attributes object
  
  id integer
  
  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.
  
  Hide account attributes Show account attributes object
  
  id integer
  
  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.
- dimensions array[object]
  
  A list of dimensions such as department or project.
  
  Hide dimensions attributes Show dimensions attributes object
  
  dimensionType integer Required
  
  The unique identifier for the dimension within 24SevenOffice ERP modules.
  
  value string Required
  
  The value (ie key) for the dimension.
  
  name string Required
  
  The display name associated with the value of the dimension.

GET /salesorders/{id}/lines/{lineId}

curl \
 --request GET 'https://rest.api.24sevenoffice.com/v1/salesorders/{id}/lines/{lineId}' \
 --header "Authorization: string"

Response examples (200)

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

# Payload
{
  "id": 123456789,
  "type": "product",
  "product": {
    "id": 101
  },
  "description": "Leather handbag with adjustable strap.",
  "quantity": 2,
  "price": 49.99,
  "discountRate": 10,
  "tax": {
    "id": 1,
    "number": 1,
    "rate": 25
  },
  "account": {
    "id": 200001,
    "number": 1500,
    "name": "Accounts Receivable"
  },
  "dimensions": [
    {
      "dimensionType": 1,
      "value": "13",
      "name": "Project with ID 13"
    }
  ]
}