Invoices
List invoices
GET /v1/invoices
Scope: invoices:read
| Parameter | In | Required |
|---|
owner | query | No |
clientId | query | No |
locationId | query | No |
staffId | query | No |
status | query | No |
from | query | No |
to | query | No |
q | query | No |
sort | query | No |
dir | query | No |
limit | query | No |
offset | query | No |
creditNotes | query | No |
topUps | query | No |
ids | query | No |
Get an invoice
GET /v1/invoices/{id}
Scope: invoices:read
| Parameter | In | Required |
|---|
id | path | Yes |
Check out: issue an invoice and take payment
POST /v1/checkout
Scope: invoices:create
| Parameter | In | Required |
|---|
Idempotency-Key | header | No |
| Body field | Type | Required |
|---|
locationId | string uuid | Yes |
clientId | | Yes |
appointmentId | | No |
lines | array | Yes |
payments | array | No |
note | | No |
promoCode | | No |
billToThirdPartyId | | No |
insurancePolicyId | | No |
insuranceCaseId | | No |
billToClientId | | No |
priceListId | | No |
issuingCompanyId | | No |
invoiceTemplateId | | No |
serviceChargeIds | array | No |
walletId | | No |