latestOpenAPI 3.0.0Apache 2.02026-08-201250995.7 KB

bd9694db5fce

Invoices

List all Invoices

Permissions needed: VIEW_INVOICES_CASHING Returns list of Invoices

get/api/v1/invoices

Query parameters

filter[pet_id]integer

Pet ID

filter[sale_id]integer

Sale ID

filter[series]string

Invoice series

filter[number]integer

Invoice number (Required if series is provided)

filter[updated_from]string date-time

Updated after the datetime (use iso8601 format - 2020-08-16T08:56:44.000000Z). Updated at and created at are returned in UTC in the response

filter[updated_to]string date-time

Updated at less or equal than the datetime (use iso8601 format - 2020-08-16T08:56:44.000000Z). Updated at and created at are returned in UTC in the response

sortstring

Order by field(s) (created_at,updated_at) Use a minus before for descending order -updated_at

includestring

Additional info to include. You can use multiple, comma separated. Options: sale, sale.vet, sale.customer, sale.customer.legalEntity, sale.customer.country, sale.payments, sale.file, sale.treatments, sale.soldServices, sale.record

detailedboolean

Set to true to get the full invoice details (this significantly increases the response size and response time)

Parameters

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

Response

successful operation

linksLinks — unresolved $ref
metaMeta — unresolved $ref