accounting
salesorder

List all salesorders

get/accounting/{connection_id}/salesorder

Request

  • Base URL: http://api.unified.to
  • URL: http://api.unified.to/accounting/{connection_id}/salesorder
  • Auth: API key in header authorization

Path parameters

connection_idstring required

ID of the connection

Query parameters

limitnumber
offsetnumber
updated_gtestring date-time

Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

sort'name' | 'updated_at' | 'created_at'
order'asc' | 'desc'
querystring

Query string to search. eg. email address or name

contact_idstring

The contact ID to filter by (reference to AccountingContact)

org_idstring

The org ID to filter by (reference to AccountingOrganization)

fieldsstring[]

Fields to return

rawstring

Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar

Response

Successful

idstring
created_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

updated_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

posted_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

contact_idstring

Customer, Supplier (reference to AccountingContact)

account_idstring

(reference to AccountingAccount)

currencystring
total_amountnumber
status'DRAFT' | 'VOIDED' | 'AUTHORIZED' | 'PAID' | 'PARTIALLY_PAID' | 'PARTIALLY_REFUNDED' | 'REFUNDED' | 'SUBMITTED' | 'DELETED' | 'OPEN' | 'COMPLETED' | 'CANCELED'
sales_channelstring
organization_idstring
category_idsstring[]
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'DINE_IN' | 'TAKEOUT' | 'DELIVERY' | 'PICKUP' | 'CURBSIDE' | 'SHIPPING' | 'DIGITAL' | 'OTHER'
guest_countnumber
subtotal_amountnumber

pre-tax, pre-tip amount

tax_amountnumber
discount_amountnumber
tip_amountnumber
service_charge_amountnumber
refunded_amountnumber
closed_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

subscription_idstring

payment_subscription that generated this order, if recurring

rawunknown

Changes

No recorded changes to this operation across all 1 revision of this API.