Tenant

Manage tenant settings. This is used to map tenants accross different domains and controls how sending to external parties will be done. See that at every API-call there is a statment -- Authorisation(s) : indicating who is allowed to perform the API-call the only authorize party for the whole Tenant-API is FiscaalGemak.

APIDescription
GET api/Tenants/{id}/settings

Request Tenant setting information for the tenant provided in the id param. If a provider is null no information is returned.Authorisation(s) : Cliënt application (FiscaalGemak)

POST api/Tenants/{id}/settings

Request change of Tenant setting for tenant provided in the id param. If a provider is null it will not be updated or deleted.To turn off a provider set the usages to null or any other value.Optionallly the TenantId to null.Authorisation(s) : Cliënt application (FiscaalGemak)

PUT api/Tenants/{id}/settings

Request change of Tenant setting for tenant provided in the id param. If a provider is null it will not be updated or deleted.To turn off a provider set the usages to null or any other value.Optionallly the TenantId to null.Authorisation(s) : Cliënt application (FiscaalGemak)

Document

Document Processing. This API is used for handling the documents and there metadata. See that at every API-call there is a statment -- Authorisation(s) : indicating who is allowed to perform the API-call. The possible users are the Cliënt application (Only Fiscaal Gemak) and Portal application (Applications that want to communicate with Fiscaal Gemak via MessageExpresse). Only the API-Calls marked as Portal application are for new parties implement to connect to MessageExpresse

APIDescription
POST api/DocumentProcessings

Create a document that holds all the information what to do with the document and where it needs to go. File upload should be called after this. The document will not start processing (pending) until a file has been attached.Authorisation(s) : Cliënt application (FiscaalGemak)

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.

POST api/DocumentProcessings/{id}/CancelProcessing

Mark the document to be canceled if already in progress, or stop processing if not picked up yet by the marked providers Authorisation(s) : Cliënt application (FiscaalGemak)

POST api/DocumentProcessings/{id}/Documents

Upload a file to the document to be proccessed. This should be a ZIP file, usually containing a PDF and a XBRL file.The document will not start processing (pending) until a file has been attached.Content-Type should be multipart/form-data or any other type, See MimeType of Document for more details.Uploading the document will set the MimeType property from Content-Type in the POST.Authorisation(s) : Cliënt application (FiscaalGemak)

GET api/DocumentProcessings/{id}/Documents/{documentId}

Gets the content of a zip file. ME does not look at the contents. Do not open this link in a browser as the Content-Type is whatever got set in MimeType. Authorisation(s) : Portal application with an active usage entry in the tenant.

POST api/DocumentProcessings/{id}/ForcedApproval

Mark the document to be approved. Only has effect if the document is marked for approval. Authorisation(s) : Cliënt application (FiscaalGemak)

GET api/DocumentProcessings?status={status}&tenantId={tenantId}&changedAfter={changedAfter}

Get a list of all documents. filters: status: Only give back documents with this state. tenantId : Only give back documents for tenant identified by this Tenantid. changedAfter: Only give back documents changed after this time.Leaving a filter will give back everything unresticted of the filter.When leaving the filter tenantId all information of all tenants will be returned which are linked to the requesting provider.The requesting Provider is determined by certificate validation.Authorisation(s) : Cliënt application (FiscaalGemak)

Polling

Polling is there for Portal Applications, to fetch a list of documents that need to be processed by them and return the status. See that at every API-calls there is a statment -- Authorisation(s) : indicating who is allowed to perform the API-call. These API-calls are key to the Portal application (Applications that want to communicate with Fiscaal Gemak via MessageExpresse), inorder to start the document processing proces. WARNING when receiving instead of a 200 OK a 400 BadRequest when setting the status of the document. You have to request the actual status of the document in order to update the actual status of the document in your application. When the status is already in an end status in your application do not try to set the status again. The 400 is returned when you try to set the status of a document but the processing flow of that document has already reached the end-status. (Disapproved/Error/Finished/DigipoortError). An end state indicates that the content of the document has been removed because it's only stored/present during the document processing flow.

APIDescription
POST api/External/{id}

Append logs to the document. If the update contains the status "Finished" or "Error" or "Disapproved" the status will be updated of the document.Finished: Marks the currect activity(archiving/sending/approval) as done.Error: Aborts the whole document process because the message could not be handled by the providerDisapproved: Aborts the whole document process because the message is not approved by the customerAuthorisation(s) : Portal application with an active usage entry in the tenant.

GET api/External?status={status}&tenantId={tenantId}&changedAfter={changedAfter}

Returns a list of documents that need to be processed. Digipoort only sees Digipoort items, but it is possible for items to disapear from this list when the client cancells or force approves the document. filters: status: Only give back documents with this state. tenantId : Only give back documents for tenant identified by this Tenantid. changedAfter: Only give back documents changed after this time.Leaving a filter will give back everything unresticted of the filter.When leaving the filter tenantId all information of all tenants will be returned which are linked to the requesting provider.The requesting Provider is determined by certificate validation.Authorisation(s) : Portal application with an active usage entry in the tenant.