HIhint
CustomerInvoice

List All Customer Invoices

Changed on

Returns invoices in every status, including draft and cancelled (voided). Invoices are returned newest first, by when they were created. To filter by several statuses, repeat the status parameter with brackets, such as status[]=issued&status[]=sent.

get/provider/customer_invoices

Request

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

Query parameters

limitinteger

Defaults to 10, maximum 100. A larger value returns 100.

offsetinteger

Defaults to 0.

sortstring

Sort by date, status, invoice_number, created_at or updated_at, such as sort=date; prefix - for descending, such as sort=-date. Ties break by creation order, newest first.

ownerstring

Filter by invoice owner, the patient who pays the invoice. This is not necessarily the patient on each charge: a dependent's charges are billed to their payer. A patient id, such as pat- (or sbx-pat- in sandbox).

locationstring

Filter by invoice location. A location id, such as loc- (or sbx-loc- in sandbox).

statusstring[]

Filter by invoice status. cancelled is a voided invoice.

updated_atstring date-time

Allows filtering by date or time. Accepts an object with allowed keys of [gte, gt, lte, lt] and a value of the date or time in iso8601 format. See advanced querying for more information.

created_atstring date-time

Allows filtering by date or time. Accepts an object with allowed keys of [gte, gt, lte, lt] and a value of the date or time in iso8601 format. See advanced querying for more information.

Response

Successful response

Changes

  • c9bda0d2dd87Revision 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 new optional query request parameter limit

    • info

      added the new optional query request parameter location

    • info

      added the new optional query request parameter offset

    • info

      added the new optional query request parameter owner

    • info

      added the new optional query request parameter sort

    • info

      added the new optional query request parameter 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 items/items/charges/patient/patient_agreement_accepted deprecated

    • info

      response property items/items/charges/patient/patient_agreement_accepted_at deprecated

    • info

      response property items/items/charges/patient/terms_accepted deprecated

    • info

      response property items/items/charges/patient/terms_accepted_at deprecated

    • info

      response property items/items/owner/patient_agreement_accepted deprecated

    • info

      response property items/items/owner/patient_agreement_accepted_at deprecated

    • info

      response property items/items/owner/terms_accepted deprecated

    • info

      response property items/items/owner/terms_accepted_at deprecated