Sign in

v1

latestOpenAPI 3.1.02026-07-24416405768.8 KB
x) Accounts

Add a new sale

Creates a new sale under the account. A sale starts in BASKET status and progresses through the sale lifecycle via events.

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

Path parameters

tenantIdinteger required
organisationIdinteger required
accountIdinteger required

Request body

accountIdinteger required
currencystring
modestring
organisationIdinteger required
paymentDuestring date-time
tenantIdinteger required
uniqueIdstring

Example request

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

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