Beta
Import Invoice
Import an existing invoice from a third party service to reflect state in Candid.
Headers
Authorization
OAuth authentication of the form <token>.
Request
This endpoint expects an object.
external_payment_account_config_id
patient_external_id
external_customer_identifier
Id of the customer in the source system
items
status
external_identifier
Id of the invoice being imported in the source system. Warning - This field CANNOT be updated.
note
due_date
If given as None, days_until_due in the payment config will be used to create a default date
customer_invoice_url
Link to the patient view of the invoice in the third-party service
Response
This endpoint returns an object.
id
created_at
updated_at
items
The InvoiceItem rollup which contains all claim and service line invoice items
patient_external_id
external_customer_identifier
Id of the customer in the source system
status
external_identifier
Id of the invoice being imported in the source system
due_date
amount_cents
Total monetary amount (in cents) of all Invoice Items
note
customer_invoice_url
Link to the patient view of the invoice in the third-party service