accounting
salesorder

Update a salesorder

Changed on
patch/accounting/{connection_id}/salesorder/{id}

Request

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

Path parameters

connection_idstring required

ID of the connection

idstring required

ID of the Salesorder

Query parameters

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

Request body

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

rawobject

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

rawobject

Changes

  • 669f9277e173Revision changes
    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

  • 1c744a7590b4Revision changes
    • warning

      added the new CANCELED enum value to the response property for the response status

    • warning

      added the new COMPLETED enum value to the response property for the response status

    • warning

      added the new OPEN enum value to the response property for the response status

    • warning

      added the new SERVICE_CHARGE enum value to the // response property for the response status

    • warning

      added the new SERVICE_CHARGE enum value to the //// response property for the response status

    • warning

      added the new TIP enum value to the // response property for the response status

    • warning

      added the new TIP enum value to the //// response property for the response status

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the enum value closed_at to the property items/ of the query request parameter fields

    • info

      added the enum value device_id to the property items/ of the query request parameter fields

    • info

      added the enum value discount_amount to the property items/ of the query request parameter fields

    • info

      added the enum value employee_user_id to the property items/ of the query request parameter fields

    • info

      added the enum value fulfillment_type to the property items/ of the query request parameter fields

    • info

      added the enum value guest_count to the property items/ of the query request parameter fields

    • info

      added the enum value location_id to the property items/ of the query request parameter fields

    • info

      added the enum value metadata to the property items/ of the query request parameter fields

    • info

      added the enum value order_number to the property items/ of the query request parameter fields

    • info

      added the enum value payments to the property items/ of the query request parameter fields

    • info

      added the enum value refunded_amount to the property items/ of the query request parameter fields

    • info

      added the enum value service_charge_amount to the property items/ of the query request parameter fields

    • info

      added the enum value subscription_id to the property items/ of the query request parameter fields

    • info

      added the enum value subtotal_amount to the property items/ of the query request parameter fields

    • info

      added the enum value tax_amount to the property items/ of the query request parameter fields

    • info

      added the enum value tip_amount to the property items/ of the query request parameter fields

    • info

      added the new CANCELED enum value to the request property

    • info

      added the new COMPLETED enum value to the request property

    • info

      added the new OPEN enum value to the request property

    • info

      added the new SERVICE_CHARGE enum value to the request property //

    • info

      added the new SERVICE_CHARGE enum value to the request property ////

    • info

      added the new TIP enum value to the request property //

    • info

      added the new TIP enum value to the request property ////

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status