This page was automatically generated from tracezilla’s Swagger API documentation 2026-09-22

GET /documents/{documentId}

Get document

Description

Returns document resource

Parameters (path)

Name Required Description Values
documentId required Target document.  

Responses

200

successful operation

406

not acceptable

500

internal server error

PUT /documents/{documentId}

Update existing document

Parameters (path)

Name Required Description Values
documentId required Target document.  

Request body

Description

Target order.

Required

This parameter is required.

Request body JSON schema 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135

{
  "properties": {
    "id": {
      "description": "Id of the record",
      "type": "string",
      "format": "uuid",
      "readOnly": true,
      "example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
    },
    "created_by_id": {
      "description": "Id of user that created the document",
      "type": "integer",
      "format": "int32",
      "readOnly": true,
      "example": 1234
    },
    "filters": {
      "description": "Filters that was applied to the document",
      "format": "",
      "readOnly": true,
      "example": ""
    },
    "language": {
      "description": "ISO 639-1 Code 2 letter language code",
      "type": "string",
      "format": "string",
      "readOnly": true,
      "example": "da"
    },
    "last_sent_at": {
      "description": "Timestamp of when this document was last sent",
      "type": "string",
      "format": "date-time",
      "example": "2019-01-01T13:25:32.312Z"
    },
    "last_sent_by_id": {
      "description": "Id of user that last sent the document",
      "type": "integer",
      "format": "int32",
      "readOnly": true,
      "example": 1234
    },
    "last_sent_note": {
      "description": "Note on how this document was most recently sent",
      "type": "string",
      "format": "string",
      "example": "Sent by APP XYS"
    },
    "last_sent_using": {
      "description": "Channel that was used for sending this document",
      "type": "string",
      "format": "string",
      "readOnly": true,
      "example": "email"
    },
    "locked": {
      "description": "If the document is locked and cannot be deleted",
      "type": "boolean",
      "format": "boolean",
      "readOnly": true,
      "example": true
    },
    "number": {
      "description": "Number of the document",
      "type": "integer",
      "format": "int32",
      "readOnly": true,
      "example": 1234
    },
    "origin_entity_id": {
      "description": "Id of the entity where this document originates from",
      "type": "string",
      "format": "uuid",
      "readOnly": true,
      "example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
    },
    "origin_model_name": {
      "description": "Name of model where this document originates from",
      "type": "string",
      "format": "string",
      "readOnly": true,
      "example": "Order"
    },
    "recipient_location_id": {
      "description": "Id of the partner location that is meant as the recipient of this document",
      "type": "string",
      "format": "uuid",
      "readOnly": true,
      "example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
    },
    "recipient_partner_id": {
      "description": "Id of the partner that is meant as the recipient of this document",
      "type": "string",
      "format": "uuid",
      "readOnly": true,
      "example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
    },
    "status": {
      "description": "Status of this document",
      "type": "string",
      "format": "string",
      "readOnly": true,
      "example": "valid"
    },
    "type": {
      "description": "Type of document",
      "type": "string",
      "format": "string",
      "readOnly": true,
      "example": "OrderProformaInvoice"
    },
    "version": {
      "description": "Version number of this document",
      "type": "integer",
      "format": "int32",
      "readOnly": true,
      "example": 1234
    },
    "created_at": {
      "description": "The time when the record was created in UTC date & time (Iso8601 ZuluString)",
      "type": "string",
      "format": "date-time",
      "readOnly": true,
      "example": "2025-01-01T13:25:32.312Z"
    },
    "updated_at": {
      "description": "The time when the record was last updated in UTC date & time (Iso8601 ZuluString)",
      "type": "string",
      "format": "date-time",
      "readOnly": true,
      "example": "2026-08-01T13:25:32.312Z"
    }
  },
  "type": "object"
}

Responses

403

Unauthorized request

406

not acceptable

500

Internal server error