Sign in

v1

latestOpenAPI 3.1.02026-07-24416405768.8 KB
x) Accounts

Get a sale by ID

Pass fields=accountHolder to include account holder details in the response.

get/eclipse-conductor/rest/v1/tenants/{tenantId}/organisations/{organisationId}/accounts/{accountId}/sales/{saleId}

Path parameters

tenantIdinteger required
organisationIdinteger required
accountIdinteger required
saleIdinteger required

Query parameters

fieldsstring

Field data to be included: Support for comma-delimited strings. Pass 'accountHolder' to include account holders details in the response.

Response

OK

accountIdinteger required
createdstring date-time
currencystring
lastModifiedstring date-time
modestring
organisationIdinteger required
outstandingnumber
paymentDuestring date-time
previousStatus'BASKET' | 'CANCELLED' | 'FULFILLED' | 'INVOICED' | 'QUOTE'
saleIdinteger
saleTotalDiscountExclnumber
saleTotalDiscountInclnumber
saleTotalExclnumber
saleTotalInclnumber
saleTotalTaxnumber
status'BASKET' | 'CANCELLED' | 'FULFILLED' | 'INVOICED' | 'QUOTE'
tenantIdinteger required
uniqueIdstring
versioninteger

Example response

{
  "created": "2022-03-10T12:15:50-04:00",
  "lastModified": "2022-03-10T12:15:50-04:00",
  "paymentDue": "2022-03-10T12:15:50-04:00",
  "saleLines": [
    {
      "created": "2022-03-10T12:15:50-04:00"
    }
  ],
  "salePayments": [
    {
      "created": "2022-03-10T12:15:50-04:00"
    }
  ]
}