Update a Draft Invoice

put

https://api-test.qualpay.com/platform/invoice/{invoice_id}/draft

Updates a draft invoice. Only the fields sent in the request body are updated. If updating JSON object fields, you should send the complete JSON in the request body.

Note: This operation requires special permissions for vendor account use. Contact Qualpay Support to enable it.

Path Params

invoice_id

int64

required

The invoice ID, returned as the invoice_id value in a 'Create an Invoice' response.

Body Params

Invoice

customer_id

string

required

Format: Variable length, up to 32 AN
Description: The customer ID associated with this invoice. This should be associated with a valid customer profile stored in Customer Vault.

invoice_number

string

required

Format: Variable length, up to 25 AN
Description: The invoice number (also referred to as the purchase identifier) generated by the merchant.

from_contact

object

billing_contact

object

profile_id

string

Format: Variable length, up to 20 AN
Description: The unique Payment Gateway profile ID to be used when making an invoice payment. If profile_id is not provided, the system uses the currency specified in tran_currency. If both profile_id and tran_currency are sent, the system uses the currency and settings associated with the profile_id.

tran_currency

string

Format: Variable length, up to 3 AN
Description: The ISO numeric currency code. This must be a currency code associated with one of your payment profiles; contact Qualpay to add currencies. Refer to Currency Codes for a list of currency codes. If both profile_id and tran_currency fields are provided, the currency associated with the profile_id is used, and tran_currency is updated to match the profile_id currency.
Default: 840

footer_note

string

Format: Variable length, up to 750 AN
Description: The note displayed in the footer of the invoice.

payment_terms_note

string

Format: Variable length, up to 500 AN
Description: The invoice payment terms description.

checkout_settings

object

sales_tax

object

payment_terms

object

date_invoice

string

Format: Fixed length, 10 AN, in YYYY-MM-DD format
Description: The invoice date.

line_items

array of objects

The invoice line item details.

line_items

Responses

200Success

400Request Validation Failed

500Internal Error