CustomerInvoiceCharge

Update CustomerInvoiceCharge

Changed on

Only the fields that are editable in the invoice's current status are applied. Fields that are not editable are ignored without an error: the response is 200 and shows the unchanged values, so compare the returned charge with what you sent. While the invoice is draft, every field is editable. Once the invoice has been issued, quantity, price_in_cents, name, and charge_item are ignored. description and taxable are always applied. patient, practitioner, category, location, and date are applied only while the charge's reporting period is unlocked. price_in_cents is also ignored on a draft invoice when the charge carries a coverage discount or is a package or prepaid item. Delete and re-create the charge to reprice it.

patch/provider/customer_invoices/{customer_invoice_id}/charges/{id}

Request

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

Path parameters

customer_invoice_idstring required

Unique Customer Invoice ID

idstring required

Unique Customer Invoice Charge ID

Request body

quantitynumber double

Applied only while the invoice is draft.

price_in_centsnumber double

Applied only while the invoice is draft and the charge has no coverage discount and is not a package or prepaid item.

namestring

Applied only while the invoice is draft.

descriptionstring
taxableboolean
datestring date

Response

Successful response

Changes

    • breaking

      added the new required request property /

    • info

      added the new optional request property

    • info

      the request property became optional

    • info

      the request property became optional

    • info

      the request property became optional