accounting
order

List all orders

get/accounting/{connection_id}/order

Path parameters

connection_idstring required

ID of the connection

Query parameters

limitnumber
offsetnumber
updated_gtestring

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

sortstring
orderstring
querystring

Query string to search. eg. email address or name

contact_idstring

The contact ID to filter by (reference to AccountingContact)

typestring
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
updated_atstring date-time
posted_atstring date-time
contact_idstring
account_idstring
type'SALES' | 'PURCHASE'
currencystring
total_amountnumber
status'DRAFT' | 'VOIDED' | 'AUTHORIZED' | 'PAID' | 'PARTIALLY_PAID' | 'PARTIALLY_REFUNDED' | 'REFUNDED' | 'SUBMITTED' | 'DELETED' | 'OPEN' | 'COMPLETED' | 'CANCELED'
organization_idstring
rawobject

Changes

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

  • 1c744a7590b452See 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 TIP enum value to the ///// response property for the response status

      response-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 optional property / to the response with the status

      response-optional-property-added

    • added the enum value organization_id 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