TAtap

Update an Invoice

put/{invoice_id}

Request

  • Base URL
    https://api.tap.company/v2/invoices
  • URL
    https://api.tap.company/v2/invoices/{invoice_id}
  • Auth
    API key in header Authorization

Path parameters

invoice_idstring required

[Required]

Headers

lang_codestring

optional

Request body

draftboolean

Merchant can save the invoice without creating the actual invoice. The default value will be false.

dueinteger required

Invoice Due Date; measured in seconds since the Unix epoch.

expiryinteger required

Invoice Expiry Date; measured in seconds since the Unix epoch.

descriptionstring

Invoice description

modestring

Invoice mode- how the invoice page is showed to customers (INVOICE - Open invoice page, PAY - Open payment page, INVOICEPAY - Open invoice page and payment page.

notestring

It will be added in the invoice footer.

channelsstring[]

Notifications channels.

dispatchboolean

Merchant can specify the field, dispatch the invoice or not.

currenciesstring[]

Charge currency object. If you pass null or empty, all currencies will show.

payment_methodsstring[]

Charge payment method object, if you pass null or empty, then all payment methods will show.

Response

200

object required

Changes

No recorded changes to this operation across all 1 revision of this API.