Sign in
latestOpenAPI 3.0.0Apache 2.02026-08-201250995.7 KB

bd9694db5fce

Sales

List all Sales

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

get/api/v1/sales

Query parameters

filter[id]integer

Sale ID

filter[customer_id]integer
Example:1

Client/Owner Id

filter[status]string

Status (comma separated statuses: <i>0 - No Sale; 1 - Pending, 2 - Paid, 3 - Partial, 4 - Overdraft</i>)

filter[include_consolidated]boolean

Include consolidated Sales - those with consolidated=1 (default <i>false</i>)

includestring

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

appendstring

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

filter[has_client_subscription]boolean

Sale has or not a client subscription to a plan

filter[has_monetization]boolean

Belongs to a Record that has attached a service or treatment (total > 0);Used to include/ignore Draft Records; Default value: <i>true</i>

filter[has_outstanding]0 | 1

Sale has or not outstanding balance

filter[taxable_at]string[]

Dates between when sale was added in the platform

[
  "2023-07-26T06:39:10.000000Z"
]
filter[created_at]string[]

Dates between when sale was added in the platform

[
  "2023-07-26T06:39:10.000000Z"
]
filter[updated_at]string[]

Dates between when sale was last updated in the platform

[
  "2023-07-26T06:39:10.000000Z"
]

Parameters

#/paths/~1api~1v1~1pets/get/parameters/0 — unresolved $ref
#/paths/~1api~1v1~1invoices/get/parameters/2 — unresolved $ref
#/paths/~1api~1v1~1pets/get/parameters/1 — unresolved $ref
#/paths/~1api~1v1~1tags/get/parameters/5 — unresolved $ref
#/paths/~1api~1v1~1pets/get/parameters/11 — unresolved $ref

Response

successful operation

dataData[] — unresolved $ref
linksLinks — unresolved $ref
metaMeta — unresolved $ref