Merge · Schema

SalesOrderLineRequest

# The SalesOrderLine Object ### Description The `SalesOrderLine` object represents a specific line item on a sales order. ### Usage Example Fetch from the `GET SalesOrder` endpoint and view a company's sales order line items.

IntegrationsPlatformUnified APIAgent HandlerLLM Gateway

Properties

Name	Type	Description
remote_id	stringnull	The third-party API ID of the matching object.
description	stringnull	Description of the line item.
unit_price	stringnull	The unit price of the item.
quantity	stringnull	Quantity ordered for this line.
item	stringnull
tax_rate	stringnull	The tax rate of the line item.
tracking_categories	array	The dimensions or classification tags.
company	stringnull	The subsidiary associated with the order.
remote_created_at	stringnull	When the third party's sales order line item was created.
remote_updated_at	stringnull	When the third party's sales order line item was updated.
integration_params	objectnull
linked_account_params	objectnull
remote_fields	array

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/SalesOrderLineRequest",
  "title": "SalesOrderLineRequest",
  "type": "object",
  "properties": {
    "remote_id": {
      "type": [
        "string",
        "null"
      ],
      "description": "The third-party API ID of the matching object."
    },
    "description": {
      "type": [
        "string",
        "null"
      ],
      "description": "Description of the line item."
    },
    "unit_price": {
      "type": [
        "string",
        "null"
      ],
      "format": "decimal",
      "description": "The unit price of the item."
    },
    "quantity": {
      "type": [
        "string",
        "null"
      ],
      "format": "decimal",
      "description": "Quantity ordered for this line."
    },
    "item": {
      "type": [
        "string",
        "null"
      ],
      "format": "uuid"
    },
    "tax_rate": {
      "type": [
        "string",
        "null"
      ],
      "format": "uuid",
      "description": "The tax rate of the line item."
    },
    "tracking_categories": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "uuid"
      },
      "description": "The dimensions or classification tags."
    },
    "company": {
      "type": [
        "string",
        "null"
      ],
      "format": "uuid",
      "description": "The subsidiary associated with the order."
    },
    "remote_created_at": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time",
      "description": "When the third party's sales order line item was created."
    },
    "remote_updated_at": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time",
      "description": "When the third party's sales order line item was updated."
    },
    "integration_params": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": {
        "description": "Any type"
      }
    },
    "linked_account_params": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": {
        "description": "Any type"
      }
    },
    "remote_fields": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/RemoteFieldRequest"
      }
    }
  },
  "description": "# The SalesOrderLine Object\n### Description\nThe `SalesOrderLine` object represents a specific line item on a sales order.\n\n### Usage Example\nFetch from the `GET SalesOrder` endpoint and view a company's sales order line items."
}