AI agent? Read this page as Markdown at /accounting/salesorder/model.md — append .md to any docs URL, or start from /llms.txt.

Salesorder data model

View field support, webhooks, and list parameters for each integration on the Supported Integrations page.

Data Model

idstring
created_atdate
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atdate
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
posted_atdate
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
contact_idstring
Customer, Supplier (reference to AccountingContact)
account_idstring
(reference to AccountingAccount)
currencystring
total_amountnumber
shipping_addressobject
billing_addressobject
status enum
Valid values:
"DRAFT"
"VOIDED"
"AUTHORIZED"
"PAID"
"PARTIALLY_PAID"
lineitems array
sales_channelstring
organization_idstring
fees array
category_idsstring array
(reference to AccountingCategory)
metadata array
order_numberstring
human-facing receipt/ticket/check number, distinct from id
location_idstring
store/site; reference to a commerce_location or hris_location
employee_user_idstring
selling/serving HR employee (server, cashier) (reference to HrisEmployee)
device_idstring
POS register/terminal/device (HRIS Device)
fulfillment_type enum
Valid values:
"DINE_IN"
"TAKEOUT"
"DELIVERY"
"PICKUP"
"CURBSIDE"
guest_countnumber
subtotal_amountnumber
pre-tax, pre-tip amount
tax_amountnumber
discount_amountnumber
tip_amountnumber
service_charge_amountnumber
refunded_amountnumber
closed_atdate
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
subscription_idstring
payment_subscription that generated this order, if recurring
payments array
read-only reciprocal of PaymentPayment.allocations; payments applied to this sales order
Are we missing anything? Let us know
Was this page helpful?