Create Manual Invoice

Create and send a manual one-off invoice to a patient.

post/billing/invoice/create

Headers

TENANTstring required

The tenant you are making this request on behalf of

API-KEYstring required

Your api key

patientIdstring required

Identifier of the patient to create the invoice for.

messagestring required

Custom message to be sent with the invoice.

The method used to send an invoice to a patient.

Successful Response

idstring required

The method used to send an invoice to a patient.

status'PENDING' | 'SENT' | 'FAILED' | 'PAUSED' | 'CANCELLED' required

The status of an invoice.

amountinteger required

sendTimestring date-time nullable

pausedDatestring date-time nullable

resumedDatestring date-time nullable

failedReasonstring nullable

pdfPathstring nullable

emailStatusstring nullable

smsContentstring nullable

callStatusstring nullable

No recorded changes to this endpoint across all 1 revision of this API.