Digipoort

OpenAPI V2

Deliver the XBRL report (.xbrl/.ixbrl) to Digipoort.

post

Deliver the XBRL report (.xbrl/.ixbrl) to the gateway known as Digipoort (NL) for delivery to the regulatory authority.

Authorizations

Header parameters

x-api-versionstringrequired

ApplicationNameanyoptional

Name of the application to integrates with API’s to Semansys.Next.

PartnerNameanyoptional

Contract owner (organization) name that have embedded the API’s.

PartnerIDanyoptional

Business Identification Number (BIN) of the contract owner (organization) to embeds the API’s.

CustomerNameanyoptional

Customer (organization) name (ie. accounting firm, intermediary, ....).

CustomerIDanyoptional

Business Identification Number (BIN) of the customer.

ClientNameanyoptional

Client (organization) name of the customer of the accounting firm, intermediary...

ClientIDanyoptional

Business Identification Number (BIN) of the client.

Body

certificateIdstring | nullableoptional

When not provided the default system certificate will be used.

Example: https://api-certp...

fileNamestring | nullableoptional

The name of XBRL instance document.

Example: Test file.xbrl

contentstring · byte | nullableoptional

The content of the instance document, as Base64 formatted string.

Example: PD94bWwgdmVyc...

identifierstring | nullableoptional

The business number of the reported entity.

Example: 5858..

messageTypestring | nullableoptional

The relevant message type for the deposit.

Example: Jaarrekening

nameOfStakeholderstring | nullableoptional

The regulator to which the instance should be deposited.

Example: KvK

typeOfSenderstring | nullableoptional

The type of sender (Accountant, Intermediar).

Example: Intermediar

idOfStakeholderstring | nullableread-onlyoptional

attachmentsobject[] | nullableoptional

Responses

application/json

objectoptional

application/json

post

HTTPcURLJavaScriptPython

POST /delivery/digipoort HTTP/1.1
Host: 
Authorization: Bearer JWT
x-api-version: text
Content-Type: application/json
Accept: */*
Content-Length: 256

{
  "certificateId": "https://api-certp...",
  "fileName": "Test file.xbrl",
  "content": "PD94bWwgdmVyc...",
  "identifier": "5858..",
  "messageType": "Jaarrekening",
  "nameOfStakeholder": "KvK",
  "typeOfSender": "Intermediar",
  "attachments": [
    {
      "name": "text",
      "content": "Ynl0ZXM="
    }
  ]
}

{
  "aanleverResponse": {
    "kenmerk": "dacc9159-d...",
    "berichtsoort": "Jaarrekening",
    "aanleverkenmerk": "84-c85...",
    "eerderAanleverkenmerk": null,
    "tijdstempelAangeleverd": "2021-09-02T0",
    "identiteitBelanghebbende": {
      "nummer": "58589163",
      "type": "kvk"
    },
    "rolBelanghebbende": "Intermediair",
    "identiteitOntvanger": {
      "nummer": "0000000100...",
      "type": "OIN"
    },
    "rolOntvanger": null,
    "autorisatieAdres": "http://gee...",
    "statuscode": null,
    "tijdstempelStatusSpecified": true,
    "statusomschrijving": null,
    "statusFoutcode": null,
    "statusdetails": null,
    "identiteitAanleveraar": {
      "nummer": "0000000100...",
      "type": "OIN"
    },
    "softwarePakket": null
  },
  "errorMessage": "text",
  "errorCode": "text"
}