CustomerInvoice

Update Customer Invoice

Changed on
patch/provider/customer_invoices/{id}

Request

  • Base URL
    https://api.sandbox.hint.com/api
  • URL
    https://api.sandbox.hint.com/api/provider/customer_invoices/{id}
  • Auth
    API key in header AUTHORIZATION

Path parameters

idstring required

Unique Customer Invoice ID

Request body

integration_record_idstring

Response

Successful response

idstring
amount_in_centsinteger
charges_countinteger
created_atstring date-time
datestring date
due_in_centsinteger
human_statusstring
integration_record_idstring
invoice_numberinteger
last_sent_atstring date-time
last_viewed_atstring date-time
paid_atstring date-time
paid_in_centsinteger
payment_statusstring
payments_countinteger
provider_web_linkstring
received_in_centsinteger
status'draft' | 'sent' | 'issued' | 'paid' | 'cancelled' | 'bad_debt' | 'disputed' | 'retrying'

cancelled is the status of a voided invoice. There is no refunded status: a refund on a paid invoice moves it back to issued or sent.

subtotal_in_centsinteger
tax_in_centsinteger
total_in_centsinteger
updated_atstring date-time

Changes

    • warning

      added the new bad_debt enum value to the response property for the response status

    • warning

      added the new cancelled enum value to the response property for the response status

    • warning

      added the new disputed enum value to the response property for the response status

    • warning

      added the new draft enum value to the response property for the response status

    • warning

      added the new issued enum value to the response property for the response status

    • warning

      added the new paid enum value to the response property for the response status

    • warning

      added the new retrying enum value to the response property for the response status

    • warning

      added the new sent enum value to the response property for the response status

    • 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 optional property // to the response with the status

    • 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 optional property /// to the response with the status

    • 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 optional property /// to the response with the status

    • 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 optional property / to the response with the status

    • 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 optional property // to the response with the status

    • 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 optional property // to the response with the status

    • info

      response property charges/patient/patient_agreement_accepted deprecated

    • info

      response property charges/patient/patient_agreement_accepted_at deprecated

    • info

      response property charges/patient/terms_accepted deprecated

    • info

      response property charges/patient/terms_accepted_at deprecated

    • info

      response property owner/patient_agreement_accepted deprecated

    • info

      response property owner/patient_agreement_accepted_at deprecated

    • info

      response property owner/terms_accepted deprecated

    • info

      response property owner/terms_accepted_at deprecated