api
invoices

Changed on

Update an Invoice

put/api/invoices/{id}

Request

  • Base URL: https://vivenu.com
  • URL: https://vivenu.com/api/invoices/{id}
  • Auth: one of:
    • HTTP bearer
    • API key in header Authorization

Path parameters

idstring required

The ID of the invoice.

Request body

extraFieldsobject

The extra fields of the invoice.

mode'update' | 'reissue' required

The mode for editing the invoice

Response

OK

_idstring required

The ID of the invoice.

type'invoice' | 'cancellation'

The type of the invoice. A cancellation invoice negates its reference invoice with mirrored negative amounts.

sellerIdstring required

The ID of the seller associated with the invoice.

transactionIdstring

The ID of the transaction the invoice originated from.

customerIdstring

The ID of the customer associated with the invoice.

cancellationIdstring

The ID of the associated cancellation.

cancellationReason'REQUESTED_BY_CUSTOMER' | 'CLAIM' | 'COMMUNICATION_ERROR' | 'TRAINING/TEST'

The reason of the cancellation.

refundTarget'origin' | 'voucher' | 'customer_balance'

Where the cancelled amount was refunded to.

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, as a fraction (0.19 = 19%).

includedOuterChargeTaxnumber float

The total of all taxes on included outer charges.

outerChargeTaxRatenumber float

The tax rate applied on outer charges, as a fraction (0.19 = 19%).

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 ID of the invoice this invoice references, e.g. the negated invoice for a cancellation invoice.

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.

Changes

  • 0dcc8073945dRevision changes
    • breaking

      the response property // became optional for the status

    • breaking

      the response property became optional for the status

    • breaking

      the response property / became optional for the status

    • breaking

      the response property / became optional for the status

    • breaking

      the // response property's min was decreased from 1.00 to 0.00 for the response status

    • breaking

      the // response property's min was decreased from 1.00 to 0.00 for the response status

    • info

      the request property / became optional

    • info

      the request property / became optional

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • bafd26ef1fbeRevision changes
    • warning

      added the new MWK enum value to the response property for the response status