Invoice
Update the invoice
Update the invoice
PUT
/
v1
/
invoices
/
{invoice_id}
Headers
X-BUSINESS-API-KEY
string
requiredPath Parameters
invoice_id
string
requiredIt's required field
Body
application/json
customer
object
customer_id
string
Customer id and it's required field if the customer's email and name are not present/
invoice_date
string
requiredThe format(Y-m-d) is 2024-12-21
due_date
string
Invoice Due Date, format Y-m-d. Example: 2024-12-21
auto_invoice_number
string
auto_invoice_number
invoice_number
string
Invoice Number, required if auto_invoice_number set 0
currency
string
requiredInvoice currency
amount
number
requiredInvoice amount, only required for payment by amount
subtotal
number
The subtotal field is required when payment by is amount.
payment_by
string
requiredPayment is by product or amount
tax_setting
string
Tax id
send_email
integer
default: 0HitPay to send email receipts to the customer. Default value is 0
webhook
string
Optional URL value to which HitPay will send a POST request when there is a new charge or if there is an error charging the card
reference
string
Invoice Description
footer
string
Invoice Footer
allow_partial_payments
string
default: 0allow partial payment of invoice (0 or 1)
partial_payments
object[]
products
object[]
stackable_discounts
object[]
recipients
object[]
Was this page helpful?