ITOrder

Retrieves the collection of ITOrder resources.

Retrieves the collection of ITOrder resources.

SecurityBearer
Request
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 30 ]
Default: 30

The number of items per page

senderName
string
senderId
string
senderId[]
Array of strings
recipientName
string
recipientId
string
recipientId[]
Array of strings
documentNumber
string
documentNumber[]
Array of strings
sortBy[createdAt]
string
Default: "desc"
Enum: "asc" "desc"
sortBy[documentDate]
string
Default: "asc"
Enum: "asc" "desc"
sortBy[senderName]
string
Default: "asc"
Enum: "asc" "desc"
sortBy[recipientName]
string
Default: "asc"
Enum: "asc" "desc"
createdAt[before]
string
createdAt[strictly_before]
string
createdAt[after]
string
createdAt[strictly_after]
string
documentDate[before]
string
documentDate[strictly_before]
string
documentDate[after]
string
documentDate[strictly_after]
string
downloaded
boolean
direction
string
Enum: "outgoing" "incoming"
Responses
200

ITOrder collection

get/it/orders
Request samples 
Response samples 
{
  • "hydra:member": [
    ],
  • "hydra:totalItems": 0,
  • "hydra:view": {
    },
  • "hydra:search": {
    }
}
Mark the documents as downloaded
This is useful to keep track of the document that have been received by the user.


SecurityBearer 
Request 
Request Body schema: application/json
required
The new ITOrder resource


downloaded
required
boolean
 
uuids
required
Array of strings  non-empty 
 
Responses 
204
ITOrder resource created


400
Invalid input


422
An error occurred


post/it/orders/downloaded
Request samples 
application/json
{
  • "downloaded": true,
  • "uuids": [
    ]
}
Response samples 
null
Import a new incoming NSO order in UBL format
Import a received NSO order in either the original XML format or the JSON transposition.
You must send the XML or JSON as the request body along with the right Content-Type header (application/xml or application/json).


SecurityBearer 
Request 
Request Body schema: 
required
The new ITOrder resource


ownerId
integer
Owner ID.


 
direction
integer
0 outgoing order
1 incoming order.


 
payloadPathXml
string
 
payloadPathJson
string
 
payloadFormat
string
Document original incoming format (UBL XML 2.1, UBL JSON 2.1).


 
documentNumber
string or null
 
documentDate
string or null <date-time> 
 
senderId
string or null
 
senderName
string or null
 
recipientId
string or null
 
recipientName
string or null
 
createdAt
string <date-time> 
 
PeppolMessage (object) or null
 
processType
string or null
 
orderDocumentType
string
 
documentReference
string or null <iri-reference> 
 
orderResponses
Array of strings <iri-reference> 
 
Array of objects (DocumentACLInterface) 
 
orderStatus
string or null
 
downloadedAt
string or null <date-time> 
 
downloaded
boolean
 Default:  false
 
uuid
string <uuid> 
 
tenantIdentifier
string
 Enum: "BE" "IT" "ZZ"  
Responses 
201
ITOrder resource created


400
Invalid input


422
An error occurred


post/it/orders/incoming/ubl
Request samples 
{
  • "ownerId": 0,
  • "direction": 0,
  • "payloadPathXml": "string",
  • "payloadPathJson": "string",
  • "payloadFormat": "string",
  • "documentNumber": "string",
  • "documentDate": "2019-08-24T14:15:22Z",
  • "senderId": "string",
  • "senderName": "string",
  • "recipientId": "string",
  • "recipientName": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "peppolMessage": {
    },
  • "processType": "string",
  • "orderDocumentType": "string",
  • "documentReference": "https://example.com/",
  • "orderResponses": [],
  • "acl": [
    ],
  • "orderStatus": "string",
  • "downloadedAt": "2019-08-24T14:15:22Z",
  • "downloaded": false,
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "tenantIdentifier": "BE"
}
Response samples 
{
  • "uuid": "string",
  • "direction": "outgoing",
  • "format": "UBL 2.1 XML",
  • "number": "string",
  • "date": "string",
  • "sender": {
    },
  • "recipient": {
    },
  • "createdAt": "string",
  • "downloaded": true,
  • "processType": "order only",
  • "peppolMessage": { },
  • "processInformation": { },
  • "responses": [
    ]
}
Create a new NSO order in UBL format
Send a NSO order in either the original XML format or the JSON transposition.
You must send the XML or JSON as the request body along with the right Content-Type header (application/xml or application/json).


Optionally you can send the X-Validation-Rule: {validation-rule-code} where {validation-rule-code} is one of the available validation rules you can use.
You can retrieve a list of the available validation rules using the API GET /validation-rules.
By default the validation rule is autodetected using the latest rule available for the given document.


SecurityBearer 
Responses 
202
ITOrder resource created


400
Invalid input


422
An error occurred


post/it/orders/outgoing/ubl
Request samples 
Response samples 
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "uuid": "string",
  • "direction": "outgoing",
  • "format": "UBL 2.1 XML",
  • "number": "string",
  • "date": "string",
  • "sender": {
    },
  • "recipient": {
    },
  • "createdAt": "string",
  • "downloaded": true,
  • "processType": "order only",
  • "peppolMessage": { },
  • "processInformation": { },
  • "responses": [
    ]
}
Retrieves a ITOrder resource.
Retrieves a ITOrder resource.


SecurityBearer 
Request 
path Parameters
uuid
required
string
ITOrder identifier


 
Responses 
200
ITOrder resource


404
Not found


get/it/orders/{uuid}
Request samples 
Response samples 
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "uuid": "string",
  • "direction": "outgoing",
  • "format": "UBL 2.1 XML",
  • "number": "string",
  • "date": "string",
  • "sender": {
    },
  • "recipient": {
    },
  • "createdAt": "string",
  • "downloaded": true,
  • "processType": "order only",
  • "peppolMessage": { },
  • "processInformation": { },
  • "responses": [
    ]
}
Get the printed version of the document
You will receive a 302 redirect response with the Location header pointing to the downloadable file. Additionally you get the URL to the downloaded file in the JSON response body.
You can ask for the HTML or the PDF version of the printed document by sending header Accept: text/html or Accept: application/pdf.
You can avoid the 302 redirect response by sending header X-WithRedirect: false


SecurityBearer 
Request 
path Parameters
uuid
required
string
ITOrder identifier


 
Responses 
302
ITOrder resource


404
Not found


get/it/orders/{uuid}/print
Request samples 
Response samples 
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "title": "string",
  • "detail": "string",
  • "status": 404,
  • "instance": "string",
  • "type": "string",
  • "description": "string"
}
Get the original source document
You can retrieve the original source document in either XML or JSON format.


SecurityBearer 
Request 
path Parameters
uuid
required
string
ITOrder identifier


 
Responses 
204
ITOrder resource


404
Not found


get/it/orders/{uuid}/source
Request samples 
Response samples 
No sample