For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Logo
Resources
Log inGet a demo
Get startedAPI referenceImplementation
Get startedAPI referenceImplementation
    • Overview
          • The SalesOrder object
          • GET/sales-orders
          • POST/sales-orders
          • GET/sales-orders/{id}
          • GET/sales-orders/lines/remote-field-classes
          • GET/sales-orders/meta/post
          • GET/sales-orders/remote-field-classes
          • POST/sales-orders/bulk
          • GET/sales-orders/bulk/{batch_id}

Get started

  • Overview
  • Introduction
  • Unified API
  • Linked Account
  • Merge Link
  • Use cases

Implementation

  • Sandboxes
  • SDKs
  • API access
  • Syncing data
  • Writing data
  • Data minimization
  • Supplemental data
  • Errors
  • Integration metadata

API reference

  • ATS
  • HRIS
  • Accounting
  • Ticketing
  • CRM
  • File Storage
  • Knowledge Base
  • Chat

Resources

  • Help Center
  • Merge.dev
  • Changelog
© Merge 2026Terms of usePrivacy policy
UnifiedAgent HandlerGateway
UnifiedAgent HandlerGateway
Resources
Log inGet a demo
Common ModelsSales Orders

The SalesOrder object

Beta
The SalesOrder Object
1{
2  "id": "string",
3  "remote_id": "string",
4  "created_at": "2023-01-01T00:00:00Z",
5  "modified_at": "2023-01-01T00:00:00Z",
6  "customer": "string",
7  "currency": "XUA",
8  "exchange_rate": "string",
9  "company": "string",
10  "status": "DRAFT",
11  "payment_term": "string",
12  "memo": "string",
13  "shipping_address": "string",
14  "tracking_categories": [
15    "string"
16  ],
17  "issue_date": "2023-01-01T00:00:00Z",
18  "transaction_number": "string",
19  "total": 1,
20  "lines": [
21    {
22      "id": "string",
23      "remote_id": "string",
24      "created_at": "2023-01-01T00:00:00Z",
25      "modified_at": "2023-01-01T00:00:00Z",
26      "description": "string",
27      "unit_price": "string",
28      "quantity": "string",
29      "item": "string",
30      "tax_rate": "string",
31      "tracking_categories": [
32        "string"
33      ],
34      "company": "string",
35      "remote_created_at": "2023-01-01T00:00:00Z",
36      "remote_updated_at": "2023-01-01T00:00:00Z",
37      "remote_was_deleted": true,
38      "remote_fields": [
39        {
40          "remote_field_class": {
41            "id": "string",
42            "display_name": "string",
43            "remote_key_name": "string",
44            "description": "string",
45            "is_custom": true,
46            "is_common_model_field": true,
47            "is_required": true,
48            "field_type": "string",
49            "field_format": "string",
50            "field_choices": [
51              "string"
52            ],
53            "item_schema": {
54              "item_type": "string",
55              "item_format": "string",
56              "item_choices": [
57                "string"
58              ]
59            }
60          },
61          "value": {
62            "string": {}
63          }
64        }
65      ]
66    }
67  ],
68  "remote_created_at": "2023-01-01T00:00:00Z",
69  "remote_updated_at": "2023-01-01T00:00:00Z",
70  "remote_was_deleted": true,
71  "field_mappings": {
72    "organization_defined_targets": {
73      "string": {}
74    },
75    "linked_account_defined_targets": {
76      "string": {}
77    }
78  },
79  "remote_data": [
80    {
81      "path": "string",
82      "data": {}
83    }
84  ],
85  "remote_fields": [
86    {
87      "remote_field_class": {
88        "id": "string",
89        "display_name": "string",
90        "remote_key_name": "string",
91        "description": "string",
92        "is_custom": true,
93        "is_common_model_field": true,
94        "is_required": true,
95        "field_type": "string",
96        "field_format": "string",
97        "field_choices": [
98          "string"
99        ],
100        "item_schema": {
101          "item_type": "string",
102          "item_format": "string",
103          "item_choices": [
104            "string"
105          ]
106        }
107      },
108      "value": {
109        "string": {}
110      }
111    }
112  ]
113}
Was this page helpful?
Previous

/purchase-orders/remote-field-classes

Next

/sales-orders

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.
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