Zum Hauptinhalt springen
GET
Get DDS Statement
articles[].plots enthält die eindeutigen Parzellen der Artikelzeile ohne Geometrie, höchstens 1000 Einträge (nach id sortiert); articles[].plotsTruncated: true zeigt an, dass es mehr gibt. Die Geometrie einer Parzelle liefert GET /api/v1/plots/{id}.

Autorisierungen

Authorization
string
header
erforderlich

API key generated in Settings > API Keys. Include as Authorization: Bearer <key>.

Pfadparameter

id
string<uuid>
erforderlich

Abfrageparameter

fields
string

Comma-separated list of the resource's top-level keys to return (per element for a list), e.g. id,name; omit for the full body. Top-level only; whitespace is trimmed and duplicates count once. fields never adds keys: a selected optional key that is absent on a row stays absent. 400 when passed more than once, when empty, or when it names an unknown key (the error names it and lists the allowed ones).

Antwort

DDS statement details including articles, volumes, and linked orders

id
string
erforderlich

UUID of the DDS statement.

companyId
string
erforderlich

UUID of your company.

createdByUserId
string | null
erforderlich

UUID of the user who created the statement, or null.

name
string | null
erforderlich

Name of the statement, or null.

country
string | null
erforderlich

Country of your company as recorded on its address when the statement was created, or null.

referenceNumber
string | null
erforderlich

TRACES reference number (assigned after submission)

verificationNumber
string | null
erforderlich

TRACES verification number (assigned after validation)

tracesUuid
string | null
erforderlich

Identifier TRACES assigned on submission; null before submission and for external statements.

submittedOn
string | null
erforderlich

When the statement was submitted to TRACES (ISO 8601, UTC), or null.

type
string
erforderlich

Activity type: import, export, domestic_production or trade (see DdsType).

source
string
erforderlich

One of: internal, external.

articles
object[]
erforderlich

The declared article lines.

orders
object[]
erforderlich

Orders assigned to this DDS statement

status
string
erforderlich

One of: draft, processing, submitted, validated, rejected, under_control, correction_requested, deleted, failed, external, withdrawn, archived, grouped.

statusUpdatedAt
string | null
erforderlich

When status last changed (ISO 8601, UTC), or null.

errorMessage
string | null
erforderlich

Error message if submission failed

declaration
boolean
erforderlich

Whether the due-diligence declaration has been confirmed for this statement.

fullName
string | null
erforderlich

Name of the person who signed the declaration, or null.

notes
string | null
erforderlich

Free-text notes, or null.

totalVolume
number | null
erforderlich

Sum of the lines' volume, in kilograms; null when any line has a null volume.

totalAssignedVolume
number
erforderlich

Sum of the lines' assignedVolume, in kilograms.

totalRemainingVolume
number | null
erforderlich

totalVolume minus totalAssignedVolume, in kilograms; null when totalVolume is null.

verificationResult
string | null
erforderlich

External statements only: the last TRACES check of the reference and verification number — existing_usable, existing_non_usable or non_existent; null when never checked. Only existing_usable means the statement may be relied on.

verificationCheckedAt
string | null
erforderlich

When verificationResult was obtained (ISO 8601, UTC), or null.

groupHeadId
string | null
erforderlich

On a member of a TRACES statement group: UUID of the group head. null on every other statement.

memberCount
number
erforderlich

Number of member statements when this statement is a group head; 0 otherwise.

members
any[]

By-id read of a group head only: its member statements. The item shape is not part of the v1 contract and may change — do not depend on it.

groupHeadReferenceNumber
string | null

By-id read of a group member only: the TRACES reference number of its group head, or null.