Skip to main content
GET
Get administration invoice by id

Authorizations

Authorization
string
header
required

OAuth2 access token or static API token. See Authorization for how to obtain one.

Path Parameters

id
string
required

Invoice identifier

Query Parameters

administration_id
string
required

Administration identifier

identifier_type
string

Type of invoice identifier to use (can be 'invoice_number', 'invoice_identifier' or left blank to use internal id)

fields
string

JSON object defining fields to receive (e.g {"only": ["field1", {"field2": ["field3"]}]})

Response

Invoice

CustomerApi_V1_InvoiceEntity model

currency_code
string
required

Currency code in ISO 4217 format

invoice_number
string
required

Invoice number

payment_method
enum<string>
required

The method of payment as intended, not necessarily the actual method of payment

Available options:
bank_transfer,
direct_debit,
cash,
none,
unknown
administration_id
string
required

Owning administration identifier

debtor_id
string
required

Internal debtor identifier

id
string
required

Unique identifier

due_date
string
required

Due date

invoice_date
string
required

Invoice date

administration_costs_total
string
required

Total administration costs amount in invoice currency

administration_costs_open
string
required

Open administration costs amount in invoice currency

total_amount
string
required

Total amount in invoice currency

open_amount
string
required

Open amount in invoice currency

book_open_amount
string
required

Open amount in administration currency

book_total_amount
string
required

Total amount in administration currency

updated_at
string<date-time>
required

Timestamp at which the invoice was last updated

category
string

Category

description
string

Description

public_url
string

Link to the debtor portal (request with the 'fields' parameter)

URL to the invoice in the debtor management interface (request with the 'fields' parameter)

flow_code
string

Code of current flow (request with the 'fields' parameter)

document_url
string

URL to the invoice document (request with the 'fields' parameter)

ubl_document_url
string

URL to the UBL invoice document (request with the 'fields' parameter)

internal_note_email_address
string

Internal note email address (request with the 'fields' parameter)

invoice_lines
object[]

Invoice lines (request with the 'fields' parameter)

purchase_order_number
string

Purchase order number

labels
object[]

Labels (request with the 'fields' parameter)

order_number
string

Order number

invoice_identifier
string

Invoice identifier from accounting software

peppol_identifier
string

Peppol identifier (request with the 'fields' parameter)

credit_case_id
string

DEPRECATED, use active_credit_case_id instead

active_credit_case_id
string

Associated active credit case.

debtor_number
string

Number of the debtor

payment_plan_id
string

DEPRECATED, use active_payment_plan_id instead

active_payment_plan_id
string

Associated active payment plan.

payment_date
string

Date the invoice was fully paid

paused_by_user
boolean

Whether the invoice was paused by a user

bailiff_at
string<date-time>

Timestamp at which the invoice was forwarded to a bailiff

collectable_at
string<date-time>

Timestamp after which the invoice became ready for debt collection

debt_collection_at
string<date-time>

Timestamp at which the invoice was sent to debt collection

end_of_service_announcement_at
string<date-time>

Timestamp at which the end of service was announced

end_of_service_at
string<date-time>

Timestamp at which the service was ended

final_reminder_at
string<date-time>

Timestamp at which the final reminder was sent

pre_reminder_at
string<date-time>

Timestamp at which the pre_reminder was sent. This is a reminder sent on or before the due_date and is not considered a true reminder.

first_reminder_at
string<date-time>

DEPRECATED: use reminder_1_at instead

reminder_1_at
string<date-time>

Timestamp at which the first reminder was sent

reminder_2_at
string<date-time>

Timestamp at which the second reminder was sent

reminder_3_at
string<date-time>

Timestamp at which the third reminder was sent

reminder_4_at
string<date-time>

Timestamp at which the fourth reminder was sent

latest_reminder_at
string<date-time>

Timestamp at which the latest reminder was sent. This value will be higher than the highest reminder_X_at when the invoice is mentioned in a final reminder, or when more than 4 bundled reminders have been sent. A pre_reminder is not considered a true reminder so sending one will not result in the latest_reminder_at being set.

latest_summons_at
string<date-time>

Timestamp at which the latest summons was sent. This value will be higher than the highest summons_X_at when the credit_case of the invoice is mentioned in a notice of default.

notice_of_default_at
string<date-time>

Timestamp at which the notice of default was sent

paused_at
string<date-time>

Timestamp at which the invoice was paused

pre_judicial_at
string<date-time>

Timestamp at which the pre-judicial phase started

pre_summons_at
string<date-time>

Timestamp at which the debt collection notice was performed

sent_at
string<date-time>

Timestamp at which the invoice was sent to the debtor

first_summons_at
string<date-time>

DEPRECATED: use summons_1_at instead

summons_1_at
string<date-time>

Timestamp at which the first summons was sent

summons_2_at
string<date-time>

Timestamp at which the second summons was sent

summons_3_at
string<date-time>

Timestamp at which the third summons was sent

summons_4_at
string<date-time>

Timestamp at which the fourth summons was sent

Last modified on August 13, 2026