Sign in

v1

latestOpenAPI 3.1.02026-07-24416405768.8 KB
x) Accounts

List sales for an account

Returns sales matching the given filters. Supports filtering by status, date range, and mode. Pass fields=accountHolder to include account holder details.

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

Path parameters

tenantIdinteger required
organisationIdinteger required
accountIdinteger required

Query parameters

ascendingboolean

If sorted, sort in ascending order. default is descending

dateFromInclstring

Start of the date range (inclusive). ISO date string.

dateToExclstring

End of the date range (exclusive). ISO date string.

fieldsstring

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

limitinteger
modestring
offsetinteger
orderBystring

Column to order by if ordering is required. E.g. created

saleStatus'BASKET' | 'CANCELLED' | 'FULFILLED' | 'INVOICED' | 'QUOTE'

Filter by sale status, e.g. BASKET, QUOTE, CANCELLED.

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"
      }
    ]
  }
]