The SalesOrder object

{
  "id": "string",
  "remote_id": "string",
  "created_at": "2023-01-01T00:00:00Z",
  "modified_at": "2023-01-01T00:00:00Z",
  "customer": "string",
  "currency": "XUA",
  "exchange_rate": "string",
  "company": "string",
  "status": "DRAFT",
  "payment_term": "string",
  "memo": "string",
  "shipping_address": "string",
  "tracking_categories": [
    "string"
  ],
  "issue_date": "2023-01-01T00:00:00Z",
  "transaction_number": "string",
  "total": 1,
  "lines": [
    {
      "id": "string",
      "remote_id": "string",
      "created_at": "2023-01-01T00:00:00Z",
      "modified_at": "2023-01-01T00:00:00Z",
      "description": "string",
      "unit_price": "string",
      "quantity": "string",
      "item": "string",
      "tax_rate": "string",
      "tracking_categories": [
        "string"
      ],
      "company": "string",
      "remote_created_at": "2023-01-01T00:00:00Z",
      "remote_updated_at": "2023-01-01T00:00:00Z",
      "remote_was_deleted": true,
      "remote_fields": [
        {
          "remote_field_class": {
            "id": "string",
            "display_name": "string",
            "remote_key_name": "string",
            "description": "string",
            "is_custom": true,
            "is_common_model_field": true,
            "is_required": true,
            "field_type": "string",
            "field_format": "string",
            "field_choices": [
              "string"
            ],
            "item_schema": {
              "item_type": "string",
              "item_format": "string",
              "item_choices": [
                "string"
              ]
            }
          },
          "value": {
            "string": {}
          }
        }
      ]
    }
  ],
  "remote_created_at": "2023-01-01T00:00:00Z",
  "remote_updated_at": "2023-01-01T00:00:00Z",
  "remote_was_deleted": true,
  "field_mappings": {},
  "remote_data": [
    {
      "path": "string",
      "data": {}
    }
  ],
  "remote_fields": [
    {
      "remote_field_class": {
        "id": "string",
        "display_name": "string",
        "remote_key_name": "string",
        "description": "string",
        "is_custom": true,
        "is_common_model_field": true,
        "is_required": true,
        "field_type": "string",
        "field_format": "string",
        "field_choices": [
          "string"
        ],
        "item_schema": {
          "item_type": "string",
          "item_format": "string",
          "item_choices": [
            "string"
          ]
        }
      },
      "value": {
        "string": {}
      }
    }
  ]
}

The SalesOrder object represents a seller’s formal record and confirmation of a customer’s purchase request.

idstringOptionalRead-onlyformat: "uuid"

remote_idstring or nullOptional

The third-party API ID of the matching object.

created_atdatetimeOptionalRead-only

The datetime that this object was created by Merge.

modified_atdatetimeOptionalRead-only

The datetime that this object was modified by Merge.

customerstring or nullOptionalformat: "uuid"

The customer associated with the sales order.

currencyenum or nullOptional

The currency code for the order. The currency code in ISO 4217 format.

exchange_ratestring or nullOptionalformat: "decimal"

The exchange rate applied if the order currency differs from the base currency.

companystring or nullOptionalformat: "uuid"

The subsidiary associated with the order.

statusenum or nullOptional

The status of the sales order.

DRAFT - DRAFT
PENDING_APPROVAL - PENDING_APPROVAL
OPEN - OPEN
PARTIALLY_COMPLETED - PARTIALLY_COMPLETED
COMPLETED - COMPLETED
CLOSED - CLOSED

payment_termstring or nullOptionalformat: "uuid"

The payment terms applied to this order.

memostring or nullOptional

Notes or comments attached to the order.

shipping_addressstring or nullOptionalformat: "uuid"

The shipping address for the order.

tracking_categorieslist of stringsOptional

issue_datedatetime or nullOptional

The date the sales order was issued.

transaction_numberstring or nullOptional

The human-readable sales order number or transaction reference.

totaldouble or nullOptional

Total amount of order.

lineslist of objectsOptionalRead-only

remote_created_atdatetime or nullOptional

When the third party's sales order was created.

remote_updated_atdatetime or nullOptional

When the third party's sales order was updated.

remote_was_deletedbooleanOptionalRead-only

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.

field_mappingsobject or nullOptionalRead-only

remote_datalist of objects or nullOptionalRead-only

remote_fieldslist of objectsOptionalRead-only