Sign in
accounting
salesorder

Update a salesorder

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

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
updated_atstring date-time
posted_atstring date-time
contact_idstring
account_idstring
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
location_idstring
employee_user_idstring
device_idstring
fulfillment_type'DINE_IN' | 'TAKEOUT' | 'DELIVERY' | 'PICKUP' | 'CURBSIDE' | 'SHIPPING' | 'DIGITAL' | 'OTHER'
guest_countnumber
subtotal_amountnumber
tax_amountnumber
discount_amountnumber
tip_amountnumber
service_charge_amountnumber
refunded_amountnumber
closed_atstring date-time
subscription_idstring
rawobject

Response

Successful

idstring
created_atstring date-time
updated_atstring date-time
posted_atstring date-time
contact_idstring
account_idstring
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
location_idstring
employee_user_idstring
device_idstring
fulfillment_type'DINE_IN' | 'TAKEOUT' | 'DELIVERY' | 'PICKUP' | 'CURBSIDE' | 'SHIPPING' | 'DIGITAL' | 'OTHER'
guest_countnumber
subtotal_amountnumber
tax_amountnumber
discount_amountnumber
tip_amountnumber
service_charge_amountnumber
refunded_amountnumber
closed_atstring date-time
subscription_idstring
rawobject

Changes

Changed in 2 of the 25 revisions of this API.758

  • 1c744a7590b4755See the full diff
    • ●

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

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      added the new optional request property

      new-optional-request-property

    • ○

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

      request-parameter-property-enum-value-added

    • ○

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

      request-parameter-property-enum-value-added

    • ○

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

      request-parameter-property-enum-value-added

    • ○

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

      request-parameter-property-enum-value-added

    • ○

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

      request-parameter-property-enum-value-added

    • ○

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

      request-parameter-property-enum-value-added

    • ○

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

      request-parameter-property-enum-value-added

    • ○

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

      request-parameter-property-enum-value-added

    • ○

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

      request-parameter-property-enum-value-added

    • ○

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

      request-parameter-property-enum-value-added

    • ○

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

      request-parameter-property-enum-value-added

    • ○

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

      request-parameter-property-enum-value-added

    • ○

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

      request-parameter-property-enum-value-added

    • ○

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

      request-parameter-property-enum-value-added

    • ○

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

      request-parameter-property-enum-value-added

    • ○

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

      request-parameter-property-enum-value-added

    • ○

      added the new CANCELED enum value to the request property

      request-property-enum-value-added

    • ○

      added the new COMPLETED enum value to the request property

      request-property-enum-value-added

    • ○

      added the new OPEN enum value to the request property

      request-property-enum-value-added

    • ○

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

      request-property-enum-value-added

    • ○

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

      request-property-enum-value-added

    • ○

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

      request-property-enum-value-added

    • ○

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

      request-property-enum-value-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

  • 963bcc74f9e33See the full diff
    • ○

      added the new optional request property

      new-optional-request-property

    • ○

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

      request-parameter-property-enum-value-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added