Sign in

v1

latestOpenAPI 3.1.02026-07-24416405768.8 KB
x) Accounts

Find sales with or without an account ID

Returns sales matching the given filters. Unlike the account-scoped endpoint, this search can be performed without specifying an account ID.

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

Path parameters

tenantIdinteger required
organisationIdinteger required

Query parameters

accountIdinteger

Filter by account ID.

ascendingboolean

If sorted, sort in ascending order. default is descending

fieldsstring

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

fromDatestring

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

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.

toDatestring

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

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