GET api/DocumentProcessings/{id}

Get all the information about the document, excluding the document Authorisation(s) : Portal application with an active usage entry in the tenant.

Request Information

URI Parameters

Name	Description	Type	Additional information
id	document ID	globally unique identifier	Required

Body Parameters

None.

Response Information

Resource Description

Document

Name	Description	Type	Additional information
Id	Unique id of the document	globally unique identifier	None.
Tenant	Unique id of the document	ExternalProviderSettings	None.
ProcessingStatus	Current status of this document	ProcessingStatus	None.
States	A history of the document	Collection of StateLog	None.
CommandState	Can contain null, Cancel, ForceApproval	string	None.
Modified		date	None.
Created		date	None.
ExternalReference		string	Max length: 10000
Description		string	Max length: 255
Sender		Sender	None.
Employees	Employees of the intermediary's office	Collection of Employee	None.
Contacts	People that have to sign the document	Collection of Contact	None.
IdentificationNumbers		Collection of IdentificationNumber	None.
Timetable		Timetable	None.
Archiving	If left as null when creating a document, tenant settings will be used as default	ProviderSetting	None.
Approval	If left as null when creating a document, tenant settings will be used as default	ProviderSetting	None.
Sending	If left as null when creating a document, tenant settings will be used as default	ProviderSetting	None.
MessageType	Type of document ie: Ib, vpb, sba, loonheffing, icp	string	Max length: 255
MimeType	Content-Type of the document. Must be a valid mime type. ie application/pdf, application/x-zip-compressed, xbrl is either application/xml or text/xml. Default is 'application/octet-stream'. Will be set automatically when you upload a document using the upload service.	string	Max length: 255

Response Formats

application/json, text/json

Sample:

{
  "Id": "107b137b-30e7-4f22-9c39-b5d9bdc96fc4",
  "Tenant": {
    "Usages": [
      "Archiving",
      "Archiving"
    ],
    "TenantId": "sample string 1"
  },
  "ProcessingStatus": "Pending",
  "States": [
    {
      "Source": "sample string 1",
      "Status": "sample string 2",
      "Description": "sample string 3",
      "Timestamp": "2022-07-06T07:58:41.7303851Z"
    },
    {
      "Source": "sample string 1",
      "Status": "sample string 2",
      "Description": "sample string 3",
      "Timestamp": "2022-07-06T07:58:41.7303851Z"
    }
  ],
  "CommandState": "sample string 2",
  "Modified": "2022-07-06T07:58:41.7303851Z",
  "Created": "2022-07-06T07:58:41.7303851Z",
  "ExternalReference": "sample string 5",
  "Description": "sample string 6",
  "Sender": {
    "SenderId": "sample string 1",
    "SenderDescription": "sample string 2",
    "SenderRsin": "sample string 3"
  },
  "Employees": [
    {
      "Number": "sample string 1",
      "Name": "sample string 2"
    },
    {
      "Number": "sample string 1",
      "Name": "sample string 2"
    }
  ],
  "Contacts": [
    {
      "Number": "sample string 1",
      "Name": "sample string 2"
    },
    {
      "Number": "sample string 1",
      "Name": "sample string 2"
    }
  ],
  "IdentificationNumbers": [
    {
      "Type": 0,
      "Number": "sample string 1"
    },
    {
      "Type": 0,
      "Number": "sample string 1"
    }
  ],
  "Timetable": {
    "Code": 1,
    "Year": 2
  },
  "Archiving": {
    "Enabled": true,
    "Deadline": "2022-07-06T07:58:41.7303851Z",
    "Provider": "sample string 1"
  },
  "Approval": {
    "Enabled": true,
    "Deadline": "2022-07-06T07:58:41.7303851Z",
    "Provider": "sample string 1"
  },
  "Sending": {
    "Enabled": true,
    "Deadline": "2022-07-06T07:58:41.7303851Z",
    "Provider": "sample string 1"
  },
  "MessageType": "sample string 7",
  "MimeType": "sample string 8"
}

application/xml, text/xml

Sample:

<Document xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MessageExpresse.Models">
  <Approval>
    <Deadline>2022-07-06T07:58:41.7303851Z</Deadline>
    <Enabled>true</Enabled>
    <Provider>sample string 1</Provider>
  </Approval>
  <Archiving>
    <Deadline>2022-07-06T07:58:41.7303851Z</Deadline>
    <Enabled>true</Enabled>
    <Provider>sample string 1</Provider>
  </Archiving>
  <Contacts>
    <Contact>
      <Name>sample string 2</Name>
      <Number>sample string 1</Number>
    </Contact>
    <Contact>
      <Name>sample string 2</Name>
      <Number>sample string 1</Number>
    </Contact>
  </Contacts>
  <Description>sample string 6</Description>
  <Employees>
    <Employee>
      <Name>sample string 2</Name>
      <Number>sample string 1</Number>
    </Employee>
    <Employee>
      <Name>sample string 2</Name>
      <Number>sample string 1</Number>
    </Employee>
  </Employees>
  <ExternalReference>sample string 5</ExternalReference>
  <IdentificationNumbers>
    <IdentificationNumber>
      <Number>sample string 1</Number>
      <Type>Rsin</Type>
    </IdentificationNumber>
    <IdentificationNumber>
      <Number>sample string 1</Number>
      <Type>Rsin</Type>
    </IdentificationNumber>
  </IdentificationNumbers>
  <MessageType>sample string 7</MessageType>
  <MimeType>sample string 8</MimeType>
  <Sender>
    <SenderDescription>sample string 2</SenderDescription>
    <SenderId>sample string 1</SenderId>
    <SenderRsin>sample string 3</SenderRsin>
  </Sender>
  <Sending>
    <Deadline>2022-07-06T07:58:41.7303851Z</Deadline>
    <Enabled>true</Enabled>
    <Provider>sample string 1</Provider>
  </Sending>
  <Timetable>
    <Code>1</Code>
    <Year>2</Year>
  </Timetable>
  <CommandState>sample string 2</CommandState>
  <Created>2022-07-06T07:58:41.7303851Z</Created>
  <Id>107b137b-30e7-4f22-9c39-b5d9bdc96fc4</Id>
  <Modified>2022-07-06T07:58:41.7303851Z</Modified>
  <ProcessingStatus>Pending</ProcessingStatus>
  <States>
    <StateLog>
      <Description>sample string 3</Description>
      <Source>sample string 1</Source>
      <Status>sample string 2</Status>
      <Timestamp>2022-07-06T07:58:41.7303851Z</Timestamp>
    </StateLog>
    <StateLog>
      <Description>sample string 3</Description>
      <Source>sample string 1</Source>
      <Status>sample string 2</Status>
      <Timestamp>2022-07-06T07:58:41.7303851Z</Timestamp>
    </StateLog>
  </States>
  <Tenant>
    <TenantId>sample string 1</TenantId>
    <Usages>
      <ProviderUsages>Archiving</ProviderUsages>
      <ProviderUsages>Archiving</ProviderUsages>
    </Usages>
  </Tenant>
</Document>