Import InvoiceV1

Import Invoice

Beta
POST
Import an existing invoice from a third party service to reflect state in Candid.

Request

This endpoint expects an object.
external_payment_account_config_id
UUIDRequired
patient_external_id
stringRequired
external_customer_identifier
stringRequired
Id of the customer in the source system
items
list of objectsRequired
status
enumRequired
external_identifier
stringRequired
Id of the invoice being imported in the source system. Warning - This field CANNOT be updated.
note
stringOptional
due_date
dateOptional

If given as None, days_until_due in the payment config will be used to create a default date

customer_invoice_url
stringOptional
Link to the patient view of the invoice in the third-party service

Response

This endpoint returns an object
id
UUID
created_at
datetime
updated_at
datetime
items
object
The InvoiceItem rollup which contains all claim and service line invoice items
patient_external_id
string
external_customer_identifier
string
Id of the customer in the source system
status
enum
external_identifier
string
Id of the invoice being imported in the source system
due_date
date
amount_cents
integer
Total monetary amount (in cents) of all Invoice Items
note
stringOptional
customer_invoice_url
stringOptional
Link to the patient view of the invoice in the third-party service