Sign in

v1

latestOpenAPI 3.0.02026-07-13314761.7 KB
Document

Cancel a document

Cancel a document. Returns a cancellation document object if the cancellation is succeded.

post/documents/{id}/cancel

Path parameters

idinteger required

Response

Document cancellation successfully. Cancel document returned.

idinteger

The document's unique identifier.

invoice_numberstring

The document's invoice number.

type'advance' | 'canceled' | 'cancellation' | 'draft' | 'invoice' | 'proforma'
cancelledboolean
block_idinteger

DocumentBlock's identifier.

payment_status'expired' | 'none' | 'outstanding' | 'paid' | 'partially_paid'
payment_method'aruhitel' | 'bankcard' | 'barion' | 'barter' | 'cash' | 'cash_on_delivery' | 'coupon' | 'elore_utalas' | 'ep_kartya' | 'kompenzacio' | 'levonas' | 'online_bankcard' | 'payoneer' | 'paypal' | 'paypal_utolag' | 'payu' | 'pick_pack_pont' | 'postai_csekk' | 'postautalvany' | 'skrill' | 'szep_card' | 'transferwise' | 'upwork' | 'utalvany' | 'valto' | 'wire_transfer'
gross_totalnumber float

The document's gross total price.

currency'AUD' | 'BGN' | 'BRL' | 'CAD' | 'CHF' | 'CNY' | 'CZK' | 'DKK' | 'EUR' | 'GBP' | 'HKD' | 'HRK' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'ISK' | 'JPY' | 'KRW' | 'LTL' | 'LVL' | 'MXN' | 'MYR' | 'NOK' | 'NZD' | 'PHP' | 'PLN' | 'RON' | 'RSD' | 'RUB' | 'SEK' | 'SGD' | 'THB' | 'TRY' | 'UAH' | 'USD' | 'ZAR'
conversion_ratenumber float
invoice_datestring date
fulfillment_datestring date
due_datestring date
paid_datestring date
electronicboolean
commentstring
tagsstring[]
notification_status'closed' | 'downloaded' | 'failed' | 'none' | 'opened' | 'readed'
language'de' | 'en' | 'fr' | 'hr' | 'hu' | 'it' | 'ro' | 'sk'

Example response

{
  "invoice_number": "PREFIX / 2020-000001"
}