latestOpenAPI 3.0.0Apache 2.02026-08-201250995.7 KB

bd9694db5fce

Credit Notes

Get a list of Credit notes

Returns list of Credit notes

get/api/v1/credit-notes

Query parameters

filter[status]integer[]

Status (array: <i>opened, closed, partially_applied</i>)

filter[type]string[]

Type (array: <i>product_return, ad_hoc</i>)

includestring

Additional relations to include(comma separated attributes. Ex.: customer,customer.chatUser,sale,vet,charge,charge.sales,charge.sales.file)

appendstring

Additional attributes to include(comma separated attributes. Ex: <i>credit_applied,tax_amounts_by_rate<i/>)

filter[made_at]string[]

Dates between when credit note was added in the platform

[
  "2024-04-26T06:39:10.000000Z,2024-04-30T06:39:10.000000Z"
]
sort'made_at' | 'total' | 'credit'

Parameters

#/paths/~1api~1v1~1pets/get/parameters/0 — unresolved $ref
#/paths/~1api~1v1~1sales/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