Skip to main content
POST
Send an invoice

Authorizations

Authorization
string
header
required

OAuth 2.0 client credentials. The token request also needs the audience form field (the Account ID), which OAuth tooling does not always send; see POST /v1/oauth/token.

Headers

Idempotency-Key
string
required

Required on every POST, at most 255 characters. Use a new UUID for each logical operation. The first request with a key runs, and its answer (any status below 500) is stored for 7 days. A retry with the same key, method, path and body gets the stored answer again with Idempotency-Replayed: true, and nothing runs twice. The same key with a different body or path is 422 idempotency-key-reused; the same key while the first request is still running is 409 idempotency-key-in-progress. A 5xx answer is not stored, so the same key may be retried. A key belongs to the API client's grant (one environment).

Maximum string length: 255

Path Parameters

id
string<uuid>
required

The draft invoice's id.

Response

The sent invoice.

An invoice or credit note.

id
string<uuid>
required

The invoice's id.

type
string
required

invoice or credit_note.

status
string
required

draft, sent, viewed, paid, overdue, reminded, collection_warning, credited or bounced.

issueDate
string<date>
required

The invoice date.

dueDate
string<date>
required

The due date.

reference
string
required

Your reference, for example an order number; empty when none.

client
object
required

The client on an invoice: the name and address the invoice is made out to.

currency
string
required

Always NOK in v1.

subtotal
number
required

Total without VAT.

vat
number
required

Total VAT.

total
number
required

Total with VAT.

paidAmount
number
required

How much has been paid.

outstandingAmount
number
required

How much is still owed.

lines
object[]
required

The invoice lines.

payments
object[]
required

The payments recorded on it.

createdAt
string<date-time>
required

When it was created (UTC).

updatedAt
string<date-time>
required

When it last changed (UTC).

creditedAmount
number
required

The issued credit notes against the invoice; outstandingAmount is net of it.

number
string | null

The invoice number, or null on a draft (it gets one when it is sent).

kid
string | null

The KID (payment reference), or null when there is none (always on a draft).

paidAt
string<date> | null

The date it was paid in full, or null.

notes
string | null

A note printed on the invoice, or null.