Invoices

Get an invoice

One invoice.

get/v1/invoices/{id}

Request

  • Base URL: https://api.dynt.ai/v1/dynt-server.onrender.com
  • URL: https://api.dynt.ai/v1/dynt-server.onrender.com/v1/invoices/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

The resource id.

Response

OK

idstring required
numberstring required

Dynt's sequence number for the document.

custom_idstring nullable required

The organization's own document number, when set.

approval_statusstring required
currencystring required
net_amountstring required

Total before VAT.

vat_amountstring required

Decimal amount as a string with the currency's own decimals (ISO 4217: 2 for EUR, 0 for JPY, 3 for BHD, 4 for CLF), e.g. "1234.50"; eur_amount always has 2.

total_amountstring required

Total including VAT.

eur_amountstring nullable required

Decimal amount as a string with the currency's own decimals (ISO 4217: 2 for EUR, 0 for JPY, 3 for BHD, 4 for CLF), e.g. "1234.50"; eur_amount always has 2.

fx_ratestring nullable required

The stored exchange rate used for eur_amount, as a decimal string; null when none is stored.

issue_datestring date-time nullable required

RFC 3339 date-time in UTC.

due_datestring date-time required

RFC 3339 date-time in UTC.

purchase_order_referencestring nullable required
created_atstring date-time required

RFC 3339 date-time in UTC.

updated_atstring date-time required

RFC 3339 date-time in UTC.

status'draft' | 'sent' | 'paid' | 'cancelled' | 'overdue' | 'scheduled' required
type_codestring required

UNCL1001 document type: 380 invoice, 381 credit note.

buyer_referencestring nullable required
original_invoice_idstring nullable required

For a credit note, the invoice it credits.

sent_atstring date-time nullable required

RFC 3339 date-time in UTC.

Changes

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