List all Sales

1 min

GET

https://developer.digitail.io/api/v1/sales

Permissions needed: any of (CREATE_CHECKUPS, VIEW_COUNTER_SALE) Returns list of Sales

filter[id]integerSale ID

filter[customer_id]integerClient/Owner Id

filter[status]stringStatus (comma separated statuses: 0 - No Sale; 1 - Pending, 2 - Paid, 3 - Partial, 4 - Overdraft)

filter[include_consolidated]booleanInclude consolidated Sales - those with consolidated=1 (default false)

includestringAdditional relations to include. Ex.: invoice,file,clientSubscription,clientSubscription.plan,clientSubscription.pet,visit

appendstringAdditional fields to append. Ex.: directChargesCredit,taxAmountsByRate,hasClientSubscription

filter[has_client_subscription]booleanSale has or not a client subscription to a plan

filter[has_monetization]booleanBelongs to a Record that has attached a service or treatment (total > 0);Used to include/ignore Draft Records; Default value: true

filter[has_outstanding]integerSale has or not outstanding balance

filter[taxable_at]arrayDates between when sale was added in the platform

filter[created_at]arrayDates between when sale was added in the platform

filter[updated_at]arrayDates between when sale was last updated in the platform

acceptstringGenerated from available response content types

200successful operation

curl --request GET \
     --url https://developer.digitail.io/api/v1/sales \
     --header 'accept: application/json'