Merge · Schema

SalesOrderRequestRequest

# The SalesOrder Object ### Description The `SalesOrder` object represents a seller's formal record and confirmation of a customer's purchase request. ### Usage Example Fetch from the `LIST SalesOrders` endpoint and view a company's sales orders.

IntegrationsPlatformUnified APIAgent HandlerLLM Gateway

Properties

Name	Type	Description
customer	stringnull	The customer associated with the sales order.
currency	object	The currency code for the order. The currency code in ISO 4217 format.
exchange_rate	stringnull	The exchange rate applied if the order currency differs from the base currency.
company	stringnull	The subsidiary associated with the order.
status	object	The status of the sales order.
payment_term	stringnull	The payment terms applied to this order.
memo	stringnull	Notes or comments attached to the order.
shipping_address	stringnull	The shipping address for the order.
tracking_categories	array
issue_date	stringnull	The date the sales order was issued.
transaction_number	stringnull	The human-readable sales order number or transaction reference.
total	numbernull	Total amount of order.
lines	array
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/SalesOrderRequestRequest",
  "title": "SalesOrderRequestRequest",
  "type": "object",
  "properties": {
    "customer": {
      "type": [
        "string",
        "null"
      ],
      "format": "uuid",
      "description": "The customer associated with the sales order."
    },
    "currency": {
      "oneOf": [
        {
          "$ref": "#/components/schemas/TransactionCurrencyEnum"
        },
        {
          "type": "null"
        }
      ],
      "description": "The currency code for the order. The currency code in ISO 4217 format."
    },
    "exchange_rate": {
      "type": [
        "string",
        "null"
      ],
      "format": "decimal",
      "description": "The exchange rate applied if the order currency differs from the base currency."
    },
    "company": {
      "type": [
        "string",
        "null"
      ],
      "format": "uuid",
      "description": "The subsidiary associated with the order."
    },
    "status": {
      "oneOf": [
        {
          "$ref": "#/components/schemas/SalesOrderStatusEnum"
        },
        {
          "type": "null"
        }
      ],
      "description": "The status of the sales order."
    },
    "payment_term": {
      "type": [
        "string",
        "null"
      ],
      "format": "uuid",
      "description": "The payment terms applied to this order."
    },
    "memo": {
      "type": [
        "string",
        "null"
      ],
      "description": "Notes or comments attached to the order."
    },
    "shipping_address": {
      "type": [
        "string",
        "null"
      ],
      "format": "uuid",
      "description": "The shipping address for the order."
    },
    "tracking_categories": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "uuid"
      }
    },
    "issue_date": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time",
      "description": "The date the sales order was issued."
    },
    "transaction_number": {
      "type": [
        "string",
        "null"
      ],
      "description": "The human-readable sales order number or transaction reference."
    },
    "total": {
      "type": [
        "number",
        "null"
      ],
      "format": "double",
      "description": "Total amount of order."
    },
    "lines": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SalesOrderLineRequest"
      }
    },
    "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 SalesOrder Object\n### Description\nThe `SalesOrder` object represents a seller's formal record and confirmation of a customer's purchase request.\n\n### Usage Example\nFetch from the `LIST SalesOrders` endpoint and view a company's sales orders."
}