JOjoincandidhealth
v1

Import Invoice

Changed on

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

post/api/import-invoice/v1

Request

  • Base URL
    https://pre-api.joincandidhealth.com
  • URL
    https://pre-api.joincandidhealth.com/api/import-invoice/v1
  • Auth
    HTTP bearer

Request body

external_payment_account_config_idstring uuid required
patient_external_idstring required
external_customer_identifierstring required

Id of the customer in the source system

notestring
due_datestring date

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

status'DRAFT' | 'OPEN' | 'PAID' | 'VOID' | 'UNCOLLECTIBLE' | 'HELD' required
external_identifierstring required

Id of the invoice being imported in the source system. Warning - This field CANNOT be updated.

customer_invoice_urlstring

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

Response

Response with status 200

idstring uuid required
created_atstring date-time required
updated_atstring date-time required
patient_external_idstring required
external_customer_identifierstring required

Id of the customer in the source system

status'DRAFT' | 'OPEN' | 'PAID' | 'VOID' | 'UNCOLLECTIBLE' | 'HELD' required
external_identifierstring required

Id of the invoice being imported in the source system

notestring
customer_invoice_urlstring

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

due_datestring date required
amount_centsinteger required

Total monetary amount (in cents) of all Invoice Items

Changes

  • 24b2d80d577aRevision changes
    • breaking

      added the new required request property

    • breaking

      added the new required request property

    • breaking

      added the new required request property

    • breaking

      added the new required request property

    • breaking

      added the new required request property

    • breaking

      added the new required request property

    • breaking

      the request's body type changed from no type to object

    • breaking

      the response's body type changed from no type to object for status

    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security OAuthScheme was added to the API

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

  • 3a81ee81d4edRevision changes
    • info

      api operation id import_invoice removed and replaced with v1_import_invoice