POST /api/invoices/trans/:transactionId — vivenu-api

latestOpenAPI 3.0.32026-08-215925112.0 MB

36be0dca14e7

api

invoices

Create Invoice for Transaction (deprecated - use POST /invoices with query parameter transactionId instead)

post/api/invoices/trans/{transactionId}

Path parameters

transactionIdstring required

The ID of the transaction.

Response

Created

_idstring required

The ID of the invoice.

type'invoice' | 'cancellation'

The type of the invoice.

sellerIdstring required

The ID of the seller associated with the invoice.

transactionIdstring

The ID of the transaction the invoice originated from.

cancellationIdstring

The ID of the associated cancellation.

counternumber float required

The counter used to create no.

nostring required

A unique number for the invoice consisting of the creation date and an increasing counter.

totalnumber float

The invoice total after discounts and taxes.

discountSumnumber float

The total of all discounts applied.

includedTaxnumber float

The total of all taxes included.

taxRatenumber float

The default tax rate applied on items.

includedOuterChargeTaxnumber float

The total of all taxes on included outer charges.

outerChargeTaxRatenumber float

The tax rate applied on outer charges.

origin'onlinesale' | 'pos'

Whether the invoice has been created through an online or offline transaction.

currency'EUR' | 'USD' | 'GBP' | 'AUD' | 'CHF' | 'THB' | 'ILS' | 'COP' | 'MXN' | 'DKK' | 'NOK' | 'SEK' | 'QAR' | 'CAD' | 'ISK' | 'GTQ' | 'INR' | 'DOP' | 'SGD' | 'PLN' | 'SAR' | 'TTD' | 'ZAR' | 'KYD' | 'HKD' | 'CZK' | 'KRW' | 'JPY' | 'NZD' | 'AED' | 'MAD' | 'TWD' | 'BRL' | 'BWP' | 'NAD' | 'KES' | 'SCR' | 'TRY' | 'SZL' | 'LSL' | 'TZS' | 'UGX' | 'ZMW' | 'ZWG' | 'GHS' | 'NGN' | 'SLE' | 'LRD' | 'XOF' | 'XAF' | 'GEL' | 'IDR' | 'ARS' | 'CRC' | 'HUF' | 'EGP' | 'MYR' | 'VND' | 'PHP' | 'MWK' required

An ISO 4217 3-character code of the currency.

extraFieldsobject

The extra fields of the invoice.

secretstring

The secret of the invoice.

referenceInvoiceIdstring

The reference invoice which the invoice evolved from.

footerTextstring[]

The custom footer columns of the invoice.

createdAtstring date-time

An ISO Timestamp indicating when the invoice was created.

updatedAtstring date-time

An ISO Timestamp indicating when the invoice was last updated.