Merge · Schema

SalesOrder

# 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
id string
remote_id stringnull The third-party API ID of the matching object.
created_at string The datetime that this object was created by Merge.
modified_at string The datetime that this object was modified by Merge.
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
remote_created_at stringnull When the third party's sales order was created.
remote_updated_at stringnull When the third party's sales order was updated.
remote_was_deleted boolean Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited cove
field_mappings object
remote_data arraynull
remote_fields array
View JSON Schema on GitHub

JSON Schema

merge-salesorder-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/SalesOrder",
  "title": "SalesOrder",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid"
    },
    "remote_id": {
      "type": [
        "string",
        "null"
      ],
      "description": "The third-party API ID of the matching object."
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "The datetime that this object was created by Merge."
    },
    "modified_at": {
      "type": "string",
      "format": "date-time",
      "description": "The datetime that this object was modified by Merge."
    },
    "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/SalesOrderLine"
      }
    },
    "remote_created_at": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time",
      "description": "When the third party's sales order was created."
    },
    "remote_updated_at": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time",
      "description": "When the third party's sales order was updated."
    },
    "remote_was_deleted": {
      "type": "boolean",
      "description": "Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/)."
    },
    "field_mappings": {
      "oneOf": [
        {
          "$ref": "#/components/schemas/SalesOrderFieldMappings"
        },
        {
          "type": "null"
        }
      ]
    },
    "remote_data": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "$ref": "#/components/schemas/RemoteData"
      }
    },
    "remote_fields": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/RemoteField"
      }
    }
  },
  "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."
}