Skip to main content
POST

Autorisaties

x-api-key
string
header
vereist

Identifies the partner software. Issued by Codaclean. Required on every call, including POST /token.

Authorization
string
header
vereist

Identifies the user and their accounting firm. Send the idToken returned by POST /token as Authorization: Bearer <idToken>. Valid for 1 hour.

Body

application/json
redownload
boolean
standaard:false

By default, files already acknowledged with this API key and user are hidden. Set to true to list them again.

customer
string

Customer name.

enterpriseNumber
string

Belgian enterprise number, formatted 0123.456.789.

payrollProvider
string

Payroll provider name as written in the files, as reported in payrollProviders[].payrollProvider (for example Twinntax).

accountPeriod
integer

Exact match on the account period of the file, as YYYYMM (for example 202609).

statementDate
object

Range (inclusive) on the generation date of the file (YYYY-MM-DD).

processingDate
object

Range (inclusive) on the date Codaclean processed the file.

statementNumber
object

Range (inclusive) on the sequence number of the file.

includePdf
boolean
standaard:false

Also return a download URL for the PDF version of each file.

Respons

Matching files, grouped by customer.

id
string

Customer identifier.

name
string
accountingRef
string
enterpriseNumber
string

Belgian enterprise number, formatted 0123.456.789.

isConfidential
boolean
payrollProviders
object[]

One entry per payroll provider and year.