Skip to main content
POST
Create a declaration upload

Authorizations

Authorization
string
header
required

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

Body

application/x-www-form-urlencoded
administration_id
string
required

Administration identifier

order[file]
file
required

Multipart file containing declaration details. Deprecated: use declaration_file instead

declaration_file[file]
file
required

Multipart file containing declaration details

Response

Declaration upload created

CustomerApi_V1_DeclarationUploadEntity model

id
string
required

Unique identifier

status
enum<string>
required

Processing status of the upload (queued, retry, started, failure, success, system_error)

Available options:
queued,
retry,
started,
failure,
success,
system_error
declaration_type
string
required

Type of the uploaded declaration file

success_count
integer<int32>
required

Number of rows processed successfully

warning_count
integer<int32>
required

Number of rows processed with a warning

failed_count
integer<int32>
required

Number of rows that failed

created_at
string<date-time>
required

Timestamp at which the file was uploaded

status_reason
string

Reason for the status, set when processing failed

debtors_created_count
integer<int32>

Number of debtors created

debtors_updated_count
integer<int32>

Number of debtors updated

invoices_created_count
integer<int32>

Number of invoices created

declarations_total_amount
string

Total amount of the declarations in the file

URL to the declaration upload in the debtor management interface

log_lines
object[]

Failed and warning rows (derived, request with the 'fields' parameter)

started_at
string<date-time>

Timestamp at which processing started

finished_at
string<date-time>

Timestamp at which processing finished