{ "openapi": "3.0.1", "info": { "title": "Semansys.Web.Api", "description": "SemansysNext APIs", "termsOfService": "https://semansys.com/terms-and-conditions", "license": { "name": "Contact us", "url": "https://semansys.com/contact/" }, "version": "8.13.3.0" }, "paths": { "/instance/balance-sheet": { "post": { "tags": [ "Analyse" ], "summary": "Processes an XBRL report (.xbrl) and analyzes its balance sheet.", "description": "Processes an XBRL report (.xbrl) and analyzes its balance sheet and enables various views (tables and graphs) of the data.", "parameters": [ { "name": "x-api-version", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "ApplicationName", "in": "header", "description": "Name of the application to integrates with API’s to Semansys.Next." }, { "name": "PartnerName", "in": "header", "description": "Contract owner (organization) name that have embedded the API’s." }, { "name": "PartnerID", "in": "header", "description": "Business Identification Number (BIN) of the contract owner (organization) to embeds the API’s." }, { "name": "CustomerName", "in": "header", "description": "Customer (organization) name (ie. accounting firm, intermediary, ....)." }, { "name": "CustomerID", "in": "header", "description": "Business Identification Number (BIN) of the customer." }, { "name": "ClientName", "in": "header", "description": "Client (organization) name of the customer of the accounting firm, intermediary..." }, { "name": "ClientID", "in": "header", "description": "Business Identification Number (BIN) of the client." } ], "requestBody": { "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomErrorDto" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V6AnalyzeTableModel" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/instance/pivot": { "post": { "tags": [ "Analyse" ], "summary": "Processes an XBRL report (.xbrl) and retrieve all facts in a pivot structure.", "description": "Processes an XBRL report (.xbrl) and retrieve all facts in a pivot structure for further processing and data handling.", "parameters": [ { "name": "x-api-version", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "ApplicationName", "in": "header", "description": "Name of the application to integrates with API’s to Semansys.Next." }, { "name": "PartnerName", "in": "header", "description": "Contract owner (organization) name that have embedded the API’s." }, { "name": "PartnerID", "in": "header", "description": "Business Identification Number (BIN) of the contract owner (organization) to embeds the API’s." }, { "name": "CustomerName", "in": "header", "description": "Customer (organization) name (ie. accounting firm, intermediary, ....)." }, { "name": "CustomerID", "in": "header", "description": "Business Identification Number (BIN) of the customer." }, { "name": "ClientName", "in": "header", "description": "Client (organization) name of the customer of the accounting firm, intermediary..." }, { "name": "ClientID", "in": "header", "description": "Business Identification Number (BIN) of the client." } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PivotRequestDto" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomErrorDto" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/instance/compare": { "post": { "tags": [ "Analyse" ], "summary": "Compare two instances and show the difference between them.", "description": "Compare two instances and show the difference between them.", "parameters": [ { "name": "x-api-version", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "ApplicationName", "in": "header", "description": "Name of the application to integrates with API’s to Semansys.Next." }, { "name": "PartnerName", "in": "header", "description": "Contract owner (organization) name that have embedded the API’s." }, { "name": "PartnerID", "in": "header", "description": "Business Identification Number (BIN) of the contract owner (organization) to embeds the API’s." }, { "name": "CustomerName", "in": "header", "description": "Customer (organization) name (ie. accounting firm, intermediary, ....)." }, { "name": "CustomerID", "in": "header", "description": "Business Identification Number (BIN) of the customer." }, { "name": "ClientName", "in": "header", "description": "Client (organization) name of the customer of the accounting firm, intermediary..." }, { "name": "ClientID", "in": "header", "description": "Business Identification Number (BIN) of the client." } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ComparisonRequest" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomErrorDto" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ComparisonResult" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/instance/inline-compare": { "post": { "tags": [ "Analyse" ], "summary": "Compare two inline files and show the difference between them.", "description": "Compare two inline files and show the difference between them.", "parameters": [ { "name": "x-api-version", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "ApplicationName", "in": "header", "description": "Name of the application to integrates with API’s to Semansys.Next." }, { "name": "PartnerName", "in": "header", "description": "Contract owner (organization) name that have embedded the API’s." }, { "name": "PartnerID", "in": "header", "description": "Business Identification Number (BIN) of the contract owner (organization) to embeds the API’s." }, { "name": "CustomerName", "in": "header", "description": "Customer (organization) name (ie. accounting firm, intermediary, ....)." }, { "name": "CustomerID", "in": "header", "description": "Business Identification Number (BIN) of the customer." }, { "name": "ClientName", "in": "header", "description": "Client (organization) name of the customer of the accounting firm, intermediary..." }, { "name": "ClientID", "in": "header", "description": "Business Identification Number (BIN) of the client." } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ComparisonRequest" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomErrorDto" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ComparisonResult" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/askyourpdf/upload": { "post": { "tags": [ "Analyse" ], "summary": "Uploads a document to the AskYourPDF service.", "description": "Uploads the digital report to chat with.", "parameters": [ { "name": "x-api-version", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "ApplicationName", "in": "header", "description": "Name of the application to integrates with API’s to Semansys.Next." }, { "name": "PartnerName", "in": "header", "description": "Contract owner (organization) name that have embedded the API’s." }, { "name": "PartnerID", "in": "header", "description": "Business Identification Number (BIN) of the contract owner (organization) to embeds the API’s." }, { "name": "CustomerName", "in": "header", "description": "Customer (organization) name (ie. accounting firm, intermediary, ....)." }, { "name": "CustomerID", "in": "header", "description": "Business Identification Number (BIN) of the customer." }, { "name": "ClientName", "in": "header", "description": "Client (organization) name of the customer of the accounting firm, intermediary..." }, { "name": "ClientID", "in": "header", "description": "Business Identification Number (BIN) of the client." } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AskYourPdfUploadRequest" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomErrorDto" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AskYourPdfUploadResponse" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/askyourpdf/chat": { "post": { "tags": [ "Analyse" ], "summary": "Chat with your digital report.", "description": "Chat with your digital report.", "parameters": [ { "name": "x-api-version", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "ApplicationName", "in": "header", "description": "Name of the application to integrates with API’s to Semansys.Next." }, { "name": "PartnerName", "in": "header", "description": "Contract owner (organization) name that have embedded the API’s." }, { "name": "PartnerID", "in": "header", "description": "Business Identification Number (BIN) of the contract owner (organization) to embeds the API’s." }, { "name": "CustomerName", "in": "header", "description": "Customer (organization) name (ie. accounting firm, intermediary, ....)." }, { "name": "CustomerID", "in": "header", "description": "Business Identification Number (BIN) of the customer." }, { "name": "ClientName", "in": "header", "description": "Client (organization) name of the customer of the accounting firm, intermediary..." }, { "name": "ClientID", "in": "header", "description": "Business Identification Number (BIN) of the client." } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AskYourPdfChatRequest" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomErrorDto" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AskYourPdfChatResponse" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/askyourpdf/delete/{documentId}": { "delete": { "tags": [ "Analyse" ], "summary": "Deletes the document to chat with.", "description": "Deletes the document to chat with.", "parameters": [ { "name": "documentId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "x-api-version", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "ApplicationName", "in": "header", "description": "Name of the application to integrates with API’s to Semansys.Next." }, { "name": "PartnerName", "in": "header", "description": "Contract owner (organization) name that have embedded the API’s." }, { "name": "PartnerID", "in": "header", "description": "Business Identification Number (BIN) of the contract owner (organization) to embeds the API’s." }, { "name": "CustomerName", "in": "header", "description": "Customer (organization) name (ie. accounting firm, intermediary, ....)." }, { "name": "CustomerID", "in": "header", "description": "Business Identification Number (BIN) of the customer." }, { "name": "ClientName", "in": "header", "description": "Client (organization) name of the customer of the accounting firm, intermediary..." }, { "name": "ClientID", "in": "header", "description": "Business Identification Number (BIN) of the client." } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomErrorDto" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "string" }, "example": "Your data has been processed successfully" } } }, "401": { "description": "Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/customer-corner/delivery/messages": { "get": { "tags": [ "CustomerCorner" ], "summary": "Retrieve message types (delivery).", "description": "Retrieve all the message types appropriate for the delivery process for both portals SBR Nexus and Digipoort.", "parameters": [ { "name": "x-api-version", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "ApplicationName", "in": "header", "description": "Name of the application to integrates with API’s to Semansys.Next." }, { "name": "PartnerName", "in": "header", "description": "Contract owner (organization) name that have embedded the API’s." }, { "name": "PartnerID", "in": "header", "description": "Business Identification Number (BIN) of the contract owner (organization) to embeds the API’s." }, { "name": "CustomerName", "in": "header", "description": "Customer (organization) name (ie. accounting firm, intermediary, ....)." }, { "name": "CustomerID", "in": "header", "description": "Business Identification Number (BIN) of the customer." }, { "name": "ClientName", "in": "header", "description": "Client (organization) name of the customer of the accounting firm, intermediary..." }, { "name": "ClientID", "in": "header", "description": "Business Identification Number (BIN) of the client." } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomErrorDto" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MessageResponseDto" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/customer-corner/users": { "get": { "tags": [ "CustomerCorner" ], "summary": "Check user domain.", "description": "Check the domains the user had access to Admin functionality only.", "parameters": [ { "name": "x-api-version", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "ApplicationName", "in": "header", "description": "Name of the application to integrates with API’s to Semansys.Next." }, { "name": "PartnerName", "in": "header", "description": "Contract owner (organization) name that have embedded the API’s." }, { "name": "PartnerID", "in": "header", "description": "Business Identification Number (BIN) of the contract owner (organization) to embeds the API’s." }, { "name": "CustomerName", "in": "header", "description": "Customer (organization) name (ie. accounting firm, intermediary, ....)." }, { "name": "CustomerID", "in": "header", "description": "Business Identification Number (BIN) of the customer." }, { "name": "ClientName", "in": "header", "description": "Client (organization) name of the customer of the accounting firm, intermediary..." }, { "name": "ClientID", "in": "header", "description": "Business Identification Number (BIN) of the client." } ], "responses": { "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomErrorDto" } } } }, "200": { "description": "The domains that user has access to.", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "post": { "tags": [ "CustomerCorner" ], "summary": "Check user.", "description": "Check if user exists on the platform and if no updates the system.", "parameters": [ { "name": "x-api-version", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "ApplicationName", "in": "header", "description": "Name of the application to integrates with API’s to Semansys.Next." }, { "name": "PartnerName", "in": "header", "description": "Contract owner (organization) name that have embedded the API’s." }, { "name": "PartnerID", "in": "header", "description": "Business Identification Number (BIN) of the contract owner (organization) to embeds the API’s." }, { "name": "CustomerName", "in": "header", "description": "Customer (organization) name (ie. accounting firm, intermediary, ....)." }, { "name": "CustomerID", "in": "header", "description": "Business Identification Number (BIN) of the customer." }, { "name": "ClientName", "in": "header", "description": "Client (organization) name of the customer of the accounting firm, intermediary..." }, { "name": "ClientID", "in": "header", "description": "Business Identification Number (BIN) of the client." } ], "requestBody": { "description": "The email of the user.", "content": { "application/json": { "schema": { "type": "string" }, "example": "http://www.nltaxonomie.nl/nt18/kvk/20231213/entrypoints/kvk-rpt-jaarverantwoording-2023-nlgaap-micro.xsd" }, "text/json": { "schema": { "type": "string" }, "example": "http://www.nltaxonomie.nl/nt18/kvk/20231213/entrypoints/kvk-rpt-jaarverantwoording-2023-nlgaap-micro.xsd" }, "application/*+json": { "schema": { "type": "string" }, "example": "http://www.nltaxonomie.nl/nt18/kvk/20231213/entrypoints/kvk-rpt-jaarverantwoording-2023-nlgaap-micro.xsd" } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomErrorDto" } } } }, "200": { "description": "OK" }, "401": { "description": "Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/customer-corner/certificate": { "get": { "tags": [ "CustomerCorner" ], "summary": "List user certificates.", "description": "Gives the list of certificates owned by the user defined by the user email.", "parameters": [ { "name": "userEmail", "in": "query", "description": "The user email passed as query string.", "required": true, "schema": { "type": "string" }, "example": "user@gmail.com" }, { "name": "x-api-version", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "ApplicationName", "in": "header", "description": "Name of the application to integrates with API’s to Semansys.Next." }, { "name": "PartnerName", "in": "header", "description": "Contract owner (organization) name that have embedded the API’s." }, { "name": "PartnerID", "in": "header", "description": "Business Identification Number (BIN) of the contract owner (organization) to embeds the API’s." }, { "name": "CustomerName", "in": "header", "description": "Customer (organization) name (ie. accounting firm, intermediary, ....)." }, { "name": "CustomerID", "in": "header", "description": "Business Identification Number (BIN) of the customer." }, { "name": "ClientName", "in": "header", "description": "Client (organization) name of the customer of the accounting firm, intermediary..." }, { "name": "ClientID", "in": "header", "description": "Business Identification Number (BIN) of the client." } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomErrorDto" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SeNeCertificate" } } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "post": { "tags": [ "CustomerCorner" ], "summary": "Upload certificate.", "description": "Upload certificate to the platform in .pfx or .p12 format.", "parameters": [ { "name": "x-api-version", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "ApplicationName", "in": "header", "description": "Name of the application to integrates with API’s to Semansys.Next." }, { "name": "PartnerName", "in": "header", "description": "Contract owner (organization) name that have embedded the API’s." }, { "name": "PartnerID", "in": "header", "description": "Business Identification Number (BIN) of the contract owner (organization) to embeds the API’s." }, { "name": "CustomerName", "in": "header", "description": "Customer (organization) name (ie. accounting firm, intermediary, ....)." }, { "name": "CustomerID", "in": "header", "description": "Business Identification Number (BIN) of the customer." }, { "name": "ClientName", "in": "header", "description": "Client (organization) name of the customer of the accounting firm, intermediary..." }, { "name": "ClientID", "in": "header", "description": "Business Identification Number (BIN) of the client." } ], "requestBody": { "description": "The certificate that needs to be uploaded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CertificateUploadDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CertificateUploadDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CertificateUploadDto" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomErrorDto" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "string" }, "example": "Your data has been processed successfully" } } }, "401": { "description": "Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "delete": { "tags": [ "CustomerCorner" ], "summary": "Delete certificate.", "description": "Delete certificate from the platform.", "parameters": [ { "name": "x-api-version", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "ApplicationName", "in": "header", "description": "Name of the application to integrates with API’s to Semansys.Next." }, { "name": "PartnerName", "in": "header", "description": "Contract owner (organization) name that have embedded the API’s." }, { "name": "PartnerID", "in": "header", "description": "Business Identification Number (BIN) of the contract owner (organization) to embeds the API’s." }, { "name": "CustomerName", "in": "header", "description": "Customer (organization) name (ie. accounting firm, intermediary, ....)." }, { "name": "CustomerID", "in": "header", "description": "Business Identification Number (BIN) of the customer." }, { "name": "ClientName", "in": "header", "description": "Client (organization) name of the customer of the accounting firm, intermediary..." }, { "name": "ClientID", "in": "header", "description": "Business Identification Number (BIN) of the client." } ], "requestBody": { "description": "The ID (represented as URL from the storage) of the certificate, retrieved when certificate is successfully uploaded (\"https://portal...\")", "content": { "application/json": { "schema": { "type": "string" }, "example": "http://www.nltaxonomie.nl/nt18/kvk/20231213/entrypoints/kvk-rpt-jaarverantwoording-2023-nlgaap-micro.xsd" }, "text/json": { "schema": { "type": "string" }, "example": "http://www.nltaxonomie.nl/nt18/kvk/20231213/entrypoints/kvk-rpt-jaarverantwoording-2023-nlgaap-micro.xsd" }, "application/*+json": { "schema": { "type": "string" }, "example": "http://www.nltaxonomie.nl/nt18/kvk/20231213/entrypoints/kvk-rpt-jaarverantwoording-2023-nlgaap-micro.xsd" } }, "required": true }, "responses": { "400": { "description": "The reson why the certificate could not be deleted.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomErrorDto" } } } }, "200": { "description": "" }, "401": { "description": "Unauthorized" }, "404": { "description": "" } }, "security": [ { "Bearer": [ ] } ] } }, "/customer-corner/product-files/download/{id}": { "get": { "tags": [ "CustomerCorner" ], "summary": "Download documentation.", "description": "Download documentation by file ID.", "parameters": [ { "name": "id", "in": "path", "description": "The ID of file to be downloaded.", "required": true, "schema": { "type": "string" }, "example": "38caa766-9dcd-4681-a955-cb3d9028b18f" }, { "name": "x-api-version", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "ApplicationName", "in": "header", "description": "Name of the application to integrates with API’s to Semansys.Next." }, { "name": "PartnerName", "in": "header", "description": "Contract owner (organization) name that have embedded the API’s." }, { "name": "PartnerID", "in": "header", "description": "Business Identification Number (BIN) of the contract owner (organization) to embeds the API’s." }, { "name": "CustomerName", "in": "header", "description": "Customer (organization) name (ie. accounting firm, intermediary, ....)." }, { "name": "CustomerID", "in": "header", "description": "Business Identification Number (BIN) of the customer." }, { "name": "ClientName", "in": "header", "description": "Client (organization) name of the customer of the accounting firm, intermediary..." }, { "name": "ClientID", "in": "header", "description": "Business Identification Number (BIN) of the client." } ], "responses": { "400": { "description": "Bad Request", "content": { "application/octet-stream": { "schema": { "$ref": "#/components/schemas/CustomErrorDto" } } } }, "200": { "description": "OK" }, "401": { "description": "Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/customer-corner/product-files/release/{id}": { "get": { "tags": [ "CustomerCorner" ], "summary": "Retrieve release information.", "description": "Retrieve release information by release ID.", "parameters": [ { "name": "id", "in": "path", "description": "Release ID", "required": true, "schema": { "type": "string" }, "example": "89" }, { "name": "x-api-version", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "ApplicationName", "in": "header", "description": "Name of the application to integrates with API’s to Semansys.Next." }, { "name": "PartnerName", "in": "header", "description": "Contract owner (organization) name that have embedded the API’s." }, { "name": "PartnerID", "in": "header", "description": "Business Identification Number (BIN) of the contract owner (organization) to embeds the API’s." }, { "name": "CustomerName", "in": "header", "description": "Customer (organization) name (ie. accounting firm, intermediary, ....)." }, { "name": "CustomerID", "in": "header", "description": "Business Identification Number (BIN) of the customer." }, { "name": "ClientName", "in": "header", "description": "Client (organization) name of the customer of the accounting firm, intermediary..." }, { "name": "ClientID", "in": "header", "description": "Business Identification Number (BIN) of the client." } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomErrorDto" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProductFileResponseDto" } } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/customer-corner/file/{id}/download": { "get": { "tags": [ "CustomerCorner" ], "summary": "Download file.", "description": "Download file by file ID.", "parameters": [ { "name": "id", "in": "path", "description": "The ID of the file to be downloaded.", "required": true, "schema": { "type": "string" }, "example": "38caa766-9dcd-4681-a955-cb3d9028b18f" }, { "name": "x-api-version", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "ApplicationName", "in": "header", "description": "Name of the application to integrates with API’s to Semansys.Next." }, { "name": "PartnerName", "in": "header", "description": "Contract owner (organization) name that have embedded the API’s." }, { "name": "PartnerID", "in": "header", "description": "Business Identification Number (BIN) of the contract owner (organization) to embeds the API’s." }, { "name": "CustomerName", "in": "header", "description": "Customer (organization) name (ie. accounting firm, intermediary, ....)." }, { "name": "CustomerID", "in": "header", "description": "Business Identification Number (BIN) of the customer." }, { "name": "ClientName", "in": "header", "description": "Client (organization) name of the customer of the accounting firm, intermediary..." }, { "name": "ClientID", "in": "header", "description": "Business Identification Number (BIN) of the client." } ], "responses": { "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomErrorDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomErrorDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomErrorDto" } } } }, "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "404": { "description": "File not found." } }, "security": [ { "Bearer": [ ] } ] } }, "/customer-corner/file/{fileIds}": { "get": { "tags": [ "CustomerCorner" ], "summary": "Retrieve file list.", "description": "Retrieve the list of files as ID's within your domain.", "parameters": [ { "name": "fileIds", "in": "query", "description": "IDs of the files to be returned.", "schema": { "type": "array", "items": { "type": "string" } }, "example": [ "38caa766-9dcd-4681-a955-cb3d9028b18f", "963be853-fdcd-4681-a955-cb3d9028b18f" ] }, { "name": "fileIds", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "x-api-version", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "ApplicationName", "in": "header", "description": "Name of the application to integrates with API’s to Semansys.Next." }, { "name": "PartnerName", "in": "header", "description": "Contract owner (organization) name that have embedded the API’s." }, { "name": "PartnerID", "in": "header", "description": "Business Identification Number (BIN) of the contract owner (organization) to embeds the API’s." }, { "name": "CustomerName", "in": "header", "description": "Customer (organization) name (ie. accounting firm, intermediary, ....)." }, { "name": "CustomerID", "in": "header", "description": "Business Identification Number (BIN) of the customer." }, { "name": "ClientName", "in": "header", "description": "Client (organization) name of the customer of the accounting firm, intermediary..." }, { "name": "ClientID", "in": "header", "description": "Business Identification Number (BIN) of the client." } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomErrorDto" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SeNeFile" } } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/customer-corner/file/{id}/history": { "get": { "tags": [ "CustomerCorner" ], "summary": "Retrieve file properties.", "description": "Retrieve all properties of an file.", "parameters": [ { "name": "id", "in": "path", "description": "The ID of the preferred file", "required": true, "schema": { "type": "string" }, "example": "063be713-f..." }, { "name": "x-api-version", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "ApplicationName", "in": "header", "description": "Name of the application to integrates with API’s to Semansys.Next." }, { "name": "PartnerName", "in": "header", "description": "Contract owner (organization) name that have embedded the API’s." }, { "name": "PartnerID", "in": "header", "description": "Business Identification Number (BIN) of the contract owner (organization) to embeds the API’s." }, { "name": "CustomerName", "in": "header", "description": "Customer (organization) name (ie. accounting firm, intermediary, ....)." }, { "name": "CustomerID", "in": "header", "description": "Business Identification Number (BIN) of the customer." }, { "name": "ClientName", "in": "header", "description": "Client (organization) name of the customer of the accounting firm, intermediary..." }, { "name": "ClientID", "in": "header", "description": "Business Identification Number (BIN) of the client." } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomErrorDto" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileHistory" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/customer-corner/instance/properties": { "get": { "tags": [ "CustomerCorner" ], "summary": "Retrieve file property.", "description": "Retrieve one of the properties of an file (for example for number of facts from a XBRL report).", "parameters": [ { "name": "type", "in": "query", "description": "Filters to be applied.", "schema": { "type": "string" }, "example": "372609e8-af2f-43ac-9" }, { "name": "key", "in": "query", "description": "Filters to be applied.", "schema": { "type": "string" }, "example": "share" }, { "name": "x-api-version", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "ApplicationName", "in": "header", "description": "Name of the application to integrates with API’s to Semansys.Next." }, { "name": "PartnerName", "in": "header", "description": "Contract owner (organization) name that have embedded the API’s." }, { "name": "PartnerID", "in": "header", "description": "Business Identification Number (BIN) of the contract owner (organization) to embeds the API’s." }, { "name": "CustomerName", "in": "header", "description": "Customer (organization) name (ie. accounting firm, intermediary, ....)." }, { "name": "CustomerID", "in": "header", "description": "Business Identification Number (BIN) of the customer." }, { "name": "ClientName", "in": "header", "description": "Client (organization) name of the customer of the accounting firm, intermediary..." }, { "name": "ClientID", "in": "header", "description": "Business Identification Number (BIN) of the client." } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomErrorDto" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SeNeProperty" } } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "post": { "tags": [ "CustomerCorner" ], "summary": "Save file summary.", "description": "Save the properties of an file (for example for number of facts from a XBRL report).", "parameters": [ { "name": "x-api-version", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "ApplicationName", "in": "header", "description": "Name of the application to integrates with API’s to Semansys.Next." }, { "name": "PartnerName", "in": "header", "description": "Contract owner (organization) name that have embedded the API’s." }, { "name": "PartnerID", "in": "header", "description": "Business Identification Number (BIN) of the contract owner (organization) to embeds the API’s." }, { "name": "CustomerName", "in": "header", "description": "Customer (organization) name (ie. accounting firm, intermediary, ....)." }, { "name": "CustomerID", "in": "header", "description": "Business Identification Number (BIN) of the customer." }, { "name": "ClientName", "in": "header", "description": "Client (organization) name of the customer of the accounting firm, intermediary..." }, { "name": "ClientID", "in": "header", "description": "Business Identification Number (BIN) of the client." } ], "requestBody": { "description": "Properties to be stored in the system.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SeNeProperty" } } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomErrorDto" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "boolean" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "delete": { "tags": [ "CustomerCorner" ], "summary": "Remove file summary.", "description": "Remove the properties of an file (for example for number of facts from a XBRL report).", "parameters": [ { "name": "type", "in": "query", "description": "Property to be deleted.", "schema": { "type": "string" }, "example": "372609e8-af2f-43ac-9" }, { "name": "key", "in": "query", "description": "Property to be deleted.", "schema": { "type": "string" }, "example": "share" }, { "name": "x-api-version", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "ApplicationName", "in": "header", "description": "Name of the application to integrates with API’s to Semansys.Next." }, { "name": "PartnerName", "in": "header", "description": "Contract owner (organization) name that have embedded the API’s." }, { "name": "PartnerID", "in": "header", "description": "Business Identification Number (BIN) of the contract owner (organization) to embeds the API’s." }, { "name": "CustomerName", "in": "header", "description": "Customer (organization) name (ie. accounting firm, intermediary, ....)." }, { "name": "CustomerID", "in": "header", "description": "Business Identification Number (BIN) of the customer." }, { "name": "ClientName", "in": "header", "description": "Client (organization) name of the customer of the accounting firm, intermediary..." }, { "name": "ClientID", "in": "header", "description": "Business Identification Number (BIN) of the client." } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomErrorDto" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "boolean" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/customer-corner/file": { "get": { "tags": [ "CustomerCorner" ], "summary": "List user files.", "description": "Gives the list of files owned by the user defined by the user email.", "parameters": [ { "name": "id", "in": "query", "description": "The user email.", "schema": { "type": "string" }, "example": "user@gmail.com" }, { "name": "includeHistory", "in": "query", "description": "Whether to include the history for each of the files.", "schema": { "type": "boolean", "default": false } }, { "name": "includeProperties", "in": "query", "description": "Whether to include the properties for each of the files.", "schema": { "type": "boolean", "default": false } }, { "name": "x-api-version", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "ApplicationName", "in": "header", "description": "Name of the application to integrates with API’s to Semansys.Next." }, { "name": "PartnerName", "in": "header", "description": "Contract owner (organization) name that have embedded the API’s." }, { "name": "PartnerID", "in": "header", "description": "Business Identification Number (BIN) of the contract owner (organization) to embeds the API’s." }, { "name": "CustomerName", "in": "header", "description": "Customer (organization) name (ie. accounting firm, intermediary, ....)." }, { "name": "CustomerID", "in": "header", "description": "Business Identification Number (BIN) of the customer." }, { "name": "ClientName", "in": "header", "description": "Client (organization) name of the customer of the accounting firm, intermediary..." }, { "name": "ClientID", "in": "header", "description": "Business Identification Number (BIN) of the client." } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomErrorDto" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SeNeFile" } } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "post": { "tags": [ "CustomerCorner" ], "summary": "Upload a file", "description": "Upload a file to the platform.", "parameters": [ { "name": "x-api-version", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "ApplicationName", "in": "header", "description": "Name of the application to integrates with API’s to Semansys.Next." }, { "name": "PartnerName", "in": "header", "description": "Contract owner (organization) name that have embedded the API’s." }, { "name": "PartnerID", "in": "header", "description": "Business Identification Number (BIN) of the contract owner (organization) to embeds the API’s." }, { "name": "CustomerName", "in": "header", "description": "Customer (organization) name (ie. accounting firm, intermediary, ....)." }, { "name": "CustomerID", "in": "header", "description": "Business Identification Number (BIN) of the customer." }, { "name": "ClientName", "in": "header", "description": "Client (organization) name of the customer of the accounting firm, intermediary..." }, { "name": "ClientID", "in": "header", "description": "Business Identification Number (BIN) of the client." } ], "requestBody": { "description": "The file to be uploaded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileUploadDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FileUploadDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/FileUploadDto" } } }, "required": true }, "responses": { "400": { "description": "The reason why file could not be uploaded, represented as string.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomErrorDto" } } } }, "200": { "description": "The ID of the file (\"38caa766-9dcd-4681-a955-cb3d9028b18f\")", "content": { "application/json": { "schema": { "type": "string" }, "example": "http://www.nltaxonomie.nl/nt18/kvk/20231213/entrypoints/kvk-rpt-jaarverantwoording-2023-nlgaap-micro.xsd" } } }, "401": { "description": "Unauthorized" }, "404": { "description": "File not found." }, "415": { "description": "Unsupported file type." } }, "security": [ { "Bearer": [ ] } ] }, "delete": { "tags": [ "CustomerCorner" ], "summary": "Delete file.", "description": "Delete one or more file from the platform by ID.", "parameters": [ { "name": "x-api-version", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "ApplicationName", "in": "header", "description": "Name of the application to integrates with API’s to Semansys.Next." }, { "name": "PartnerName", "in": "header", "description": "Contract owner (organization) name that have embedded the API’s." }, { "name": "PartnerID", "in": "header", "description": "Business Identification Number (BIN) of the contract owner (organization) to embeds the API’s." }, { "name": "CustomerName", "in": "header", "description": "Customer (organization) name (ie. accounting firm, intermediary, ....)." }, { "name": "CustomerID", "in": "header", "description": "Business Identification Number (BIN) of the customer." }, { "name": "ClientName", "in": "header", "description": "Client (organization) name of the customer of the accounting firm, intermediary..." }, { "name": "ClientID", "in": "header", "description": "Business Identification Number (BIN) of the client." } ], "requestBody": { "description": "IDs of the files to be deleted.", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } }, "example": [ "063be713-f...", "963be853-f..." ] }, "text/json": { "schema": { "type": "array", "items": { "type": "string" } }, "example": [ "063be713-f...", "963be853-f..." ] }, "application/*+json": { "schema": { "type": "array", "items": { "type": "string" } }, "example": [ "063be713-f...", "963be853-f..." ] } } }, "responses": { "400": { "description": "Delete files failed.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomErrorDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomErrorDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomErrorDto" } } } }, "200": { "description": "The files were successfully deleted.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "http://www.nltaxonomie.nl/nt18/kvk/20231213/entrypoints/kvk-rpt-jaarverantwoording-2023-nlgaap-micro.xsd" }, "application/json": { "schema": { "type": "string" }, "example": "http://www.nltaxonomie.nl/nt18/kvk/20231213/entrypoints/kvk-rpt-jaarverantwoording-2023-nlgaap-micro.xsd" }, "text/json": { "schema": { "type": "string" }, "example": "http://www.nltaxonomie.nl/nt18/kvk/20231213/entrypoints/kvk-rpt-jaarverantwoording-2023-nlgaap-micro.xsd" } } }, "401": { "description": "Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/customer-corner/pdf/pdf-provider": { "post": { "tags": [ "CustomerCorner" ], "summary": "Returns a PDF results based on the HTML content provided.", "description": "Returns a PDF results based on the HTML content provided.", "parameters": [ { "name": "x-api-version", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "ApplicationName", "in": "header", "description": "Name of the application to integrates with API’s to Semansys.Next." }, { "name": "PartnerName", "in": "header", "description": "Contract owner (organization) name that have embedded the API’s." }, { "name": "PartnerID", "in": "header", "description": "Business Identification Number (BIN) of the contract owner (organization) to embeds the API’s." }, { "name": "CustomerName", "in": "header", "description": "Customer (organization) name (ie. accounting firm, intermediary, ....)." }, { "name": "CustomerID", "in": "header", "description": "Business Identification Number (BIN) of the customer." }, { "name": "ClientName", "in": "header", "description": "Client (organization) name of the customer of the accounting firm, intermediary..." }, { "name": "ClientID", "in": "header", "description": "Business Identification Number (BIN) of the client." } ], "requestBody": { "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } }, "required": true }, "responses": { "400": { "description": "The reason for operaion failure.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomErrorDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomErrorDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomErrorDto" } } } }, "200": { "description": "OK" }, "401": { "description": "Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/customer-corner/file/upload-big-file": { "post": { "tags": [ "CustomerCorner" ], "summary": "Upload (large) file.", "description": "Upload a (large) file to the platform.", "parameters": [ { "name": "x-api-version", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "ApplicationName", "in": "header", "description": "Name of the application to integrates with API’s to Semansys.Next." }, { "name": "PartnerName", "in": "header", "description": "Contract owner (organization) name that have embedded the API’s." }, { "name": "PartnerID", "in": "header", "description": "Business Identification Number (BIN) of the contract owner (organization) to embeds the API’s." }, { "name": "CustomerName", "in": "header", "description": "Customer (organization) name (ie. accounting firm, intermediary, ....)." }, { "name": "CustomerID", "in": "header", "description": "Business Identification Number (BIN) of the customer." }, { "name": "ClientName", "in": "header", "description": "Client (organization) name of the customer of the accounting firm, intermediary..." }, { "name": "ClientID", "in": "header", "description": "Business Identification Number (BIN) of the client." } ], "requestBody": { "description": "The file to be uploaded (represented as chunks).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BigFileUploadDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BigFileUploadDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BigFileUploadDto" } } }, "required": true }, "responses": { "400": { "description": "The reason why file could not be uploaded, represented as string.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomErrorDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomErrorDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomErrorDto" } } } }, "201": { "description": "Created" }, "401": { "description": "Unauthorized" }, "415": { "description": "Unsupported file type." } }, "security": [ { "Bearer": [ ] } ] } }, "/customer-corner/file/multiple": { "post": { "tags": [ "CustomerCorner" ], "summary": "Download multiple files.", "description": "Download multiple files from the platform by ID.", "parameters": [ { "name": "x-api-version", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "ApplicationName", "in": "header", "description": "Name of the application to integrates with API’s to Semansys.Next." }, { "name": "PartnerName", "in": "header", "description": "Contract owner (organization) name that have embedded the API’s." }, { "name": "PartnerID", "in": "header", "description": "Business Identification Number (BIN) of the contract owner (organization) to embeds the API’s." }, { "name": "CustomerName", "in": "header", "description": "Customer (organization) name (ie. accounting firm, intermediary, ....)." }, { "name": "CustomerID", "in": "header", "description": "Business Identification Number (BIN) of the customer." }, { "name": "ClientName", "in": "header", "description": "Client (organization) name of the customer of the accounting firm, intermediary..." }, { "name": "ClientID", "in": "header", "description": "Business Identification Number (BIN) of the client." } ], "requestBody": { "description": "IDs of the files to be returned.", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } }, "example": [ "063be713-fdcd-4681-a955-cb3d9028b18f", "963be853-fdcd-4681-a955-cb3d9028b18f" ] }, "text/json": { "schema": { "type": "array", "items": { "type": "string" } }, "example": [ "063be713-fdcd-4681-a955-cb3d9028b18f", "963be853-fdcd-4681-a955-cb3d9028b18f" ] }, "application/*+json": { "schema": { "type": "array", "items": { "type": "string" } }, "example": [ "063be713-fdcd-4681-a955-cb3d9028b18f", "963be853-fdcd-4681-a955-cb3d9028b18f" ] } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomErrorDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomErrorDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomErrorDto" } } } }, "200": { "description": "OK" }, "401": { "description": "Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/customer-corner/file/chunk": { "post": { "tags": [ "CustomerCorner" ], "summary": "Upload (large) file.", "description": "Upload a (large) file to the platform.", "parameters": [ { "name": "x-api-version", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "ApplicationName", "in": "header", "description": "Name of the application to integrates with API’s to Semansys.Next." }, { "name": "PartnerName", "in": "header", "description": "Contract owner (organization) name that have embedded the API’s." }, { "name": "PartnerID", "in": "header", "description": "Business Identification Number (BIN) of the contract owner (organization) to embeds the API’s." }, { "name": "CustomerName", "in": "header", "description": "Customer (organization) name (ie. accounting firm, intermediary, ....)." }, { "name": "CustomerID", "in": "header", "description": "Business Identification Number (BIN) of the customer." }, { "name": "ClientName", "in": "header", "description": "Client (organization) name of the customer of the accounting firm, intermediary..." }, { "name": "ClientID", "in": "header", "description": "Business Identification Number (BIN) of the client." } ], "requestBody": { "description": "Chunked file.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileChunk" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FileChunk" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/FileChunk" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomErrorDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomErrorDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomErrorDto" } } } }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "string" }, "example": "http://www.nltaxonomie.nl/nt18/kvk/20231213/entrypoints/kvk-rpt-jaarverantwoording-2023-nlgaap-micro.xsd" }, "application/json": { "schema": { "type": "string" }, "example": "http://www.nltaxonomie.nl/nt18/kvk/20231213/entrypoints/kvk-rpt-jaarverantwoording-2023-nlgaap-micro.xsd" }, "text/json": { "schema": { "type": "string" }, "example": "http://www.nltaxonomie.nl/nt18/kvk/20231213/entrypoints/kvk-rpt-jaarverantwoording-2023-nlgaap-micro.xsd" } } }, "401": { "description": "Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/customer-corner/file/history": { "post": { "tags": [ "CustomerCorner" ], "summary": "Get file history.", "description": "Get file history by file ID.", "parameters": [ { "name": "x-api-version", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "ApplicationName", "in": "header", "description": "Name of the application to integrates with API’s to Semansys.Next." }, { "name": "PartnerName", "in": "header", "description": "Contract owner (organization) name that have embedded the API’s." }, { "name": "PartnerID", "in": "header", "description": "Business Identification Number (BIN) of the contract owner (organization) to embeds the API’s." }, { "name": "CustomerName", "in": "header", "description": "Customer (organization) name (ie. accounting firm, intermediary, ....)." }, { "name": "CustomerID", "in": "header", "description": "Business Identification Number (BIN) of the customer." }, { "name": "ClientName", "in": "header", "description": "Client (organization) name of the customer of the accounting firm, intermediary..." }, { "name": "ClientID", "in": "header", "description": "Business Identification Number (BIN) of the client." } ], "requestBody": { "description": "A JSON object of the file history.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileHistory" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomErrorDto" } } } }, "200": { "description": "OK" }, "401": { "description": "Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/customer-corner/delivery/messages/get-all-with-filter": { "post": { "tags": [ "CustomerCorner" ], "summary": "Get message types (delivery).", "description": "Gets all the message types appropriate for the delivery process according to filters applied (SBR Nexus/Digipoort)(NL)", "parameters": [ { "name": "x-api-version", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "ApplicationName", "in": "header", "description": "Name of the application to integrates with API’s to Semansys.Next." }, { "name": "PartnerName", "in": "header", "description": "Contract owner (organization) name that have embedded the API’s." }, { "name": "PartnerID", "in": "header", "description": "Business Identification Number (BIN) of the contract owner (organization) to embeds the API’s." }, { "name": "CustomerName", "in": "header", "description": "Customer (organization) name (ie. accounting firm, intermediary, ....)." }, { "name": "CustomerID", "in": "header", "description": "Business Identification Number (BIN) of the customer." }, { "name": "ClientName", "in": "header", "description": "Client (organization) name of the customer of the accounting firm, intermediary..." }, { "name": "ClientID", "in": "header", "description": "Business Identification Number (BIN) of the client." } ], "requestBody": { "description": "Filters to be applied.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MessageFilterRequestDto" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomErrorDto" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MessageResponseShortDto" } } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/customer-corner/delivery/messages/upload-excel/{sheetNumber}/{skipRows}": { "post": { "tags": [ "CustomerCorner" ], "summary": "Add message types Excel (delivery).", "description": "Add message types (delivery) to the system by Excel structure. It stores only the non-existing records. Admin functionality only.", "parameters": [ { "name": "sheetNumber", "in": "path", "description": "The shhet to be processed.", "required": true, "schema": { "type": "integer", "format": "int32" }, "example": 1 }, { "name": "skipRows", "in": "path", "description": "The rows to be skipped.", "required": true, "schema": { "type": "integer", "format": "int32" }, "example": 3 }, { "name": "x-api-version", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "ApplicationName", "in": "header", "description": "Name of the application to integrates with API’s to Semansys.Next." }, { "name": "PartnerName", "in": "header", "description": "Contract owner (organization) name that have embedded the API’s." }, { "name": "PartnerID", "in": "header", "description": "Business Identification Number (BIN) of the contract owner (organization) to embeds the API’s." }, { "name": "CustomerName", "in": "header", "description": "Customer (organization) name (ie. accounting firm, intermediary, ....)." }, { "name": "CustomerID", "in": "header", "description": "Business Identification Number (BIN) of the customer." }, { "name": "ClientName", "in": "header", "description": "Client (organization) name of the customer of the accounting firm, intermediary..." }, { "name": "ClientID", "in": "header", "description": "Business Identification Number (BIN) of the client." } ], "requestBody": { "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomErrorDto" } } } }, "200": { "description": "A JSON object with detailed description of actions performed.", "content": { "application/json": { "schema": { "type": "string" }, "example": "http://www.nltaxonomie.nl/nt18/kvk/20231213/entrypoints/kvk-rpt-jaarverantwoording-2023-nlgaap-micro.xsd" } } }, "401": { "description": "Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/customer-corner/delivery/messages/upload-json": { "post": { "tags": [ "CustomerCorner" ], "summary": "Add message types JSON (delivery).", "description": "Add message types (delivery) to the system by JSON structure. It stores only the non-existing records. Admin functionality only.", "parameters": [ { "name": "x-api-version", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "ApplicationName", "in": "header", "description": "Name of the application to integrates with API’s to Semansys.Next." }, { "name": "PartnerName", "in": "header", "description": "Contract owner (organization) name that have embedded the API’s." }, { "name": "PartnerID", "in": "header", "description": "Business Identification Number (BIN) of the contract owner (organization) to embeds the API’s." }, { "name": "CustomerName", "in": "header", "description": "Customer (organization) name (ie. accounting firm, intermediary, ....)." }, { "name": "CustomerID", "in": "header", "description": "Business Identification Number (BIN) of the customer." }, { "name": "ClientName", "in": "header", "description": "Client (organization) name of the customer of the accounting firm, intermediary..." }, { "name": "ClientID", "in": "header", "description": "Business Identification Number (BIN) of the client." } ], "requestBody": { "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomErrorDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomErrorDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomErrorDto" } } } }, "200": { "description": "A JSON object with detailed description of actions performed.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "http://www.nltaxonomie.nl/nt18/kvk/20231213/entrypoints/kvk-rpt-jaarverantwoording-2023-nlgaap-micro.xsd" }, "application/json": { "schema": { "type": "string" }, "example": "http://www.nltaxonomie.nl/nt18/kvk/20231213/entrypoints/kvk-rpt-jaarverantwoording-2023-nlgaap-micro.xsd" }, "text/json": { "schema": { "type": "string" }, "example": "http://www.nltaxonomie.nl/nt18/kvk/20231213/entrypoints/kvk-rpt-jaarverantwoording-2023-nlgaap-micro.xsd" } } }, "401": { "description": "Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/customer-corner/product-files": { "post": { "tags": [ "CustomerCorner" ], "summary": "Add documentation.", "description": "Add documentation to the platform for users to access. Admin functionality only.", "parameters": [ { "name": "x-api-version", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "ApplicationName", "in": "header", "description": "Name of the application to integrates with API’s to Semansys.Next." }, { "name": "PartnerName", "in": "header", "description": "Contract owner (organization) name that have embedded the API’s." }, { "name": "PartnerID", "in": "header", "description": "Business Identification Number (BIN) of the contract owner (organization) to embeds the API’s." }, { "name": "CustomerName", "in": "header", "description": "Customer (organization) name (ie. accounting firm, intermediary, ....)." }, { "name": "CustomerID", "in": "header", "description": "Business Identification Number (BIN) of the customer." }, { "name": "ClientName", "in": "header", "description": "Client (organization) name of the customer of the accounting firm, intermediary..." }, { "name": "ClientID", "in": "header", "description": "Business Identification Number (BIN) of the client." } ], "requestBody": { "description": "JSON object with the required information for uploading a product file (documentation).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductFileRequestDto" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomErrorDto" } } } }, "201": { "description": "Created" }, "401": { "description": "Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/customer-corner/send": { "post": { "tags": [ "CustomerCorner" ], "summary": "Invite user.", "description": "Invite a user to the platform by email address.", "parameters": [ { "name": "x-api-version", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "ApplicationName", "in": "header", "description": "Name of the application to integrates with API’s to Semansys.Next." }, { "name": "PartnerName", "in": "header", "description": "Contract owner (organization) name that have embedded the API’s." }, { "name": "PartnerID", "in": "header", "description": "Business Identification Number (BIN) of the contract owner (organization) to embeds the API’s." }, { "name": "CustomerName", "in": "header", "description": "Customer (organization) name (ie. accounting firm, intermediary, ....)." }, { "name": "CustomerID", "in": "header", "description": "Business Identification Number (BIN) of the customer." }, { "name": "ClientName", "in": "header", "description": "Client (organization) name of the customer of the accounting firm, intermediary..." }, { "name": "ClientID", "in": "header", "description": "Business Identification Number (BIN) of the client." } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvitationRequestDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/InvitationRequestDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/InvitationRequestDto" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomErrorDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomErrorDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomErrorDto" } } } }, "200": { "description": "OK" }, "401": { "description": "Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/customer-corner/delivery/messages/{id}": { "delete": { "tags": [ "CustomerCorner" ], "summary": "Delete message type (delivery).", "description": "Delete message type (delivery module) by ID from the platform. Admin functionality only.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "x-api-version", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "ApplicationName", "in": "header", "description": "Name of the application to integrates with API’s to Semansys.Next." }, { "name": "PartnerName", "in": "header", "description": "Contract owner (organization) name that have embedded the API’s." }, { "name": "PartnerID", "in": "header", "description": "Business Identification Number (BIN) of the contract owner (organization) to embeds the API’s." }, { "name": "CustomerName", "in": "header", "description": "Customer (organization) name (ie. accounting firm, intermediary, ....)." }, { "name": "CustomerID", "in": "header", "description": "Business Identification Number (BIN) of the customer." }, { "name": "ClientName", "in": "header", "description": "Client (organization) name of the customer of the accounting firm, intermediary..." }, { "name": "ClientID", "in": "header", "description": "Business Identification Number (BIN) of the client." } ], "responses": { "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomErrorDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomErrorDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomErrorDto" } } } }, "200": { "description": "", "content": { "text/plain": { "schema": { "type": "string" }, "example": "http://www.nltaxonomie.nl/nt18/kvk/20231213/entrypoints/kvk-rpt-jaarverantwoording-2023-nlgaap-micro.xsd" }, "application/json": { "schema": { "type": "string" }, "example": "http://www.nltaxonomie.nl/nt18/kvk/20231213/entrypoints/kvk-rpt-jaarverantwoording-2023-nlgaap-micro.xsd" }, "text/json": { "schema": { "type": "string" }, "example": "http://www.nltaxonomie.nl/nt18/kvk/20231213/entrypoints/kvk-rpt-jaarverantwoording-2023-nlgaap-micro.xsd" } } }, "401": { "description": "Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/customer-corner/product-files/{id}": { "delete": { "tags": [ "CustomerCorner" ], "summary": "Deletes documentation by ID.", "description": "Delete documentation for ID from the platform. Admin functionality only.", "parameters": [ { "name": "id", "in": "path", "description": "ID of the product file.", "required": true, "schema": { "type": "string" } }, { "name": "x-api-version", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "ApplicationName", "in": "header", "description": "Name of the application to integrates with API’s to Semansys.Next." }, { "name": "PartnerName", "in": "header", "description": "Contract owner (organization) name that have embedded the API’s." }, { "name": "PartnerID", "in": "header", "description": "Business Identification Number (BIN) of the contract owner (organization) to embeds the API’s." }, { "name": "CustomerName", "in": "header", "description": "Customer (organization) name (ie. accounting firm, intermediary, ....)." }, { "name": "CustomerID", "in": "header", "description": "Business Identification Number (BIN) of the customer." }, { "name": "ClientName", "in": "header", "description": "Client (organization) name of the customer of the accounting firm, intermediary..." }, { "name": "ClientID", "in": "header", "description": "Business Identification Number (BIN) of the client." } ], "responses": { "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomErrorDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomErrorDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomErrorDto" } } } }, "202": { "description": "Accepted" }, "401": { "description": "Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/customer-corner/accept/{token}": { "get": { "tags": [ "CustomerCorner" ], "parameters": [ { "name": "token", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "x-api-version", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "ApplicationName", "in": "header", "description": "Name of the application to integrates with API’s to Semansys.Next." }, { "name": "PartnerName", "in": "header", "description": "Contract owner (organization) name that have embedded the API’s." }, { "name": "PartnerID", "in": "header", "description": "Business Identification Number (BIN) of the contract owner (organization) to embeds the API’s." }, { "name": "CustomerName", "in": "header", "description": "Customer (organization) name (ie. accounting firm, intermediary, ....)." }, { "name": "CustomerID", "in": "header", "description": "Business Identification Number (BIN) of the customer." }, { "name": "ClientName", "in": "header", "description": "Client (organization) name of the customer of the accounting firm, intermediary..." }, { "name": "ClientID", "in": "header", "description": "Business Identification Number (BIN) of the client." } ], "responses": { "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomErrorDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomErrorDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomErrorDto" } } } }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ContentResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ContentResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ContentResult" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/customer-corner/user-role": { "post": { "tags": [ "CustomerCorner" ], "summary": "User role.", "description": "Set the role of a user on the platform. Admin functionality only.", "parameters": [ { "name": "x-api-version", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "ApplicationName", "in": "header", "description": "Name of the application to integrates with API’s to Semansys.Next." }, { "name": "PartnerName", "in": "header", "description": "Contract owner (organization) name that have embedded the API’s." }, { "name": "PartnerID", "in": "header", "description": "Business Identification Number (BIN) of the contract owner (organization) to embeds the API’s." }, { "name": "CustomerName", "in": "header", "description": "Customer (organization) name (ie. accounting firm, intermediary, ....)." }, { "name": "CustomerID", "in": "header", "description": "Business Identification Number (BIN) of the customer." }, { "name": "ClientName", "in": "header", "description": "Client (organization) name of the customer of the accounting firm, intermediary..." }, { "name": "ClientID", "in": "header", "description": "Business Identification Number (BIN) of the client." } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthUserDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AuthUserDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AuthUserDto" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomErrorDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomErrorDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomErrorDto" } } } }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "string" }, "example": "http://www.nltaxonomie.nl/nt18/kvk/20231213/entrypoints/kvk-rpt-jaarverantwoording-2023-nlgaap-micro.xsd" }, "application/json": { "schema": { "type": "string" }, "example": "http://www.nltaxonomie.nl/nt18/kvk/20231213/entrypoints/kvk-rpt-jaarverantwoording-2023-nlgaap-micro.xsd" }, "text/json": { "schema": { "type": "string" }, "example": "http://www.nltaxonomie.nl/nt18/kvk/20231213/entrypoints/kvk-rpt-jaarverantwoording-2023-nlgaap-micro.xsd" } } }, "401": { "description": "Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/delivery/digipoort": { "post": { "tags": [ "Delivery" ], "summary": "Deliver the XBRL report (.xbrl/.ixbrl) to Digipoort.", "description": "Deliver the XBRL report (.xbrl/.ixbrl) to the gateway known as Digipoort (NL) for delivery to the regulatory authority.", "parameters": [ { "name": "x-api-version", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "ApplicationName", "in": "header", "description": "Name of the application to integrates with API’s to Semansys.Next." }, { "name": "PartnerName", "in": "header", "description": "Contract owner (organization) name that have embedded the API’s." }, { "name": "PartnerID", "in": "header", "description": "Business Identification Number (BIN) of the contract owner (organization) to embeds the API’s." }, { "name": "CustomerName", "in": "header", "description": "Customer (organization) name (ie. accounting firm, intermediary, ....)." }, { "name": "CustomerID", "in": "header", "description": "Business Identification Number (BIN) of the customer." }, { "name": "ClientName", "in": "header", "description": "Client (organization) name of the customer of the accounting firm, intermediary..." }, { "name": "ClientID", "in": "header", "description": "Business Identification Number (BIN) of the client." } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeliveryDigipoortRequest" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeliveryResponse" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeliveryResponse" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/delivery/sbr-nexus": { "post": { "tags": [ "Delivery" ], "summary": "Deliver the XBRL report (.xbrl/.ixbrl) to SBR Nexus.", "description": "Deliver the XBRL report (.xbrl/.ixbrl) to the gateway known as SBR Nexus (NL) for delivery to the regulatory authority.", "parameters": [ { "name": "x-api-version", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "ApplicationName", "in": "header", "description": "Name of the application to integrates with API’s to Semansys.Next." }, { "name": "PartnerName", "in": "header", "description": "Contract owner (organization) name that have embedded the API’s." }, { "name": "PartnerID", "in": "header", "description": "Business Identification Number (BIN) of the contract owner (organization) to embeds the API’s." }, { "name": "CustomerName", "in": "header", "description": "Customer (organization) name (ie. accounting firm, intermediary, ....)." }, { "name": "CustomerID", "in": "header", "description": "Business Identification Number (BIN) of the customer." }, { "name": "ClientName", "in": "header", "description": "Client (organization) name of the customer of the accounting firm, intermediary..." }, { "name": "ClientID", "in": "header", "description": "Business Identification Number (BIN) of the client." } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeliverySbrNexusRequest" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeliveryResponse" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeliveryResponse" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/status/digipoort": { "post": { "tags": [ "Delivery" ], "summary": "Retrieve the status of an delivered XBRL report at Digipoort.", "description": "Retrieve the latest status overview of an delivered XBRL report at Digipoort.", "parameters": [ { "name": "x-api-version", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "ApplicationName", "in": "header", "description": "Name of the application to integrates with API’s to Semansys.Next." }, { "name": "PartnerName", "in": "header", "description": "Contract owner (organization) name that have embedded the API’s." }, { "name": "PartnerID", "in": "header", "description": "Business Identification Number (BIN) of the contract owner (organization) to embeds the API’s." }, { "name": "CustomerName", "in": "header", "description": "Customer (organization) name (ie. accounting firm, intermediary, ....)." }, { "name": "CustomerID", "in": "header", "description": "Business Identification Number (BIN) of the customer." }, { "name": "ClientName", "in": "header", "description": "Client (organization) name of the customer of the accounting firm, intermediary..." }, { "name": "ClientID", "in": "header", "description": "Business Identification Number (BIN) of the client." } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StatusDigipoortRequest" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StatusProcessResponseDto" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StatusProcessResponseDto" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/status/sbr-nexus": { "post": { "tags": [ "Delivery" ], "summary": "Retrieve the status of an delivered XBRL report at SBR Nexus.", "description": "Retrieve the latest status overview of an delivered XBRL report at SBR Nexus.", "parameters": [ { "name": "x-api-version", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "ApplicationName", "in": "header", "description": "Name of the application to integrates with API’s to Semansys.Next." }, { "name": "PartnerName", "in": "header", "description": "Contract owner (organization) name that have embedded the API’s." }, { "name": "PartnerID", "in": "header", "description": "Business Identification Number (BIN) of the contract owner (organization) to embeds the API’s." }, { "name": "CustomerName", "in": "header", "description": "Customer (organization) name (ie. accounting firm, intermediary, ....)." }, { "name": "CustomerID", "in": "header", "description": "Business Identification Number (BIN) of the customer." }, { "name": "ClientName", "in": "header", "description": "Client (organization) name of the customer of the accounting firm, intermediary..." }, { "name": "ClientID", "in": "header", "description": "Business Identification Number (BIN) of the client." } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StatusSbrNexusRequest" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StatusProcessResponse" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StatusProcessResponse" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/report-package": { "post": { "tags": [ "Delivery" ], "summary": "Create taxonomy report package", "description": "Create taxonomy report package.\r\nFor each of the functionality where in our API is produced result file we produce hash of the file that identifies the contents of the file. \r\nUser can validate the hash value in hash validation functionality and to know if any changes are applied. \r\nBy default the file hash is disabled, but it can be controlled from the dropdown below. \r\nResponse body will be for example: \r\n\r\n { \r\n \"zipContentBase64\": \"JVBERxLjQKMSAw...\", \r\n \"hashResult\": { \r\n \"Hash_Result\": \"nKDBo115PBhw3U3Y= \" \r\n } \r\n }", "parameters": [ { "name": "isHashed", "in": "query", "description": "Specifies whether to have a hashcode included in the output. By default the value is false", "schema": { "type": "boolean", "default": false } }, { "name": "x-api-version", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "ApplicationName", "in": "header", "description": "Name of the application to integrates with API’s to Semansys.Next." }, { "name": "PartnerName", "in": "header", "description": "Contract owner (organization) name that have embedded the API’s." }, { "name": "PartnerID", "in": "header", "description": "Business Identification Number (BIN) of the contract owner (organization) to embeds the API’s." }, { "name": "CustomerName", "in": "header", "description": "Customer (organization) name (ie. accounting firm, intermediary, ....)." }, { "name": "CustomerID", "in": "header", "description": "Business Identification Number (BIN) of the customer." }, { "name": "ClientName", "in": "header", "description": "Client (organization) name of the customer of the accounting firm, intermediary..." }, { "name": "ClientID", "in": "header", "description": "Business Identification Number (BIN) of the client." } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomReportPackageData" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomErrorDto" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportPackageResponse" }, "examples": { "Without Hash": { "value": {"zipContentBase64":"JVBERxLjQKMSAw..."} }, "With Hash": { "value": {"zipContentBase64":"JVBERxLjQKMSAw...","hashResults":{"ReportPackage_Hash_Result":"nKDBo115PBhw3U3Y="}} } } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/input-import/instance/generation": { "post": { "tags": [ "InputImport" ], "summary": "Generate an XBRL report (.xbrl) from JSON.", "description": "Generate an XBRL report (.xbrl) from JSON-structured data file containing the reporting data.\r\nFor each of the functionality where in our API is produced result file we produce hash of the file that identifies the contents of the file. \r\nUser can validate the hash value in hash validation functionality and to know if any changes are applied. \r\nBy default the file hash is disabled, but it can be controlled from the dropdown below. \\\r\nResponse body will be for example: \r\n\r\n { \r\n \"InstanceContentBase64\": \"JVBERxLjQKMSAw...\", \r\n \"TaxonomyEntrypoint\": \"http://www.nltaxonomie.nl/nt15/kvk/20201209/entrypoints/kvk-rpt-jaarverantwoording-2020-nlgaap-middelgroot.xsd\", \r\n \"FactsCount\": 4, \r\n \"TuplesCount\": 3, \r\n \"UnitsCount\": 2, \r\n \"ContextsCount\": 1, \r\n \"hashResult\": { \r\n \"Hash_Result\": \"nKDBo115PBhw3U3Y= \" \r\n } \r\n }", "parameters": [ { "name": "isHashed", "in": "query", "description": "Optional. Specifies whether to have a hashcode included in the output. By default the value is false.", "schema": { "type": "boolean", "default": false } }, { "name": "x-api-version", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "ApplicationName", "in": "header", "description": "Name of the application to integrates with API’s to Semansys.Next." }, { "name": "PartnerName", "in": "header", "description": "Contract owner (organization) name that have embedded the API’s." }, { "name": "PartnerID", "in": "header", "description": "Business Identification Number (BIN) of the contract owner (organization) to embeds the API’s." }, { "name": "CustomerName", "in": "header", "description": "Customer (organization) name (ie. accounting firm, intermediary, ....)." }, { "name": "CustomerID", "in": "header", "description": "Business Identification Number (BIN) of the customer." }, { "name": "ClientName", "in": "header", "description": "Client (organization) name of the customer of the accounting firm, intermediary..." }, { "name": "ClientID", "in": "header", "description": "Business Identification Number (BIN) of the client." } ], "requestBody": { "description": "Data source JSON object", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonDataSource" }, "examples": { "Without Hash": { "value": {"schemaRef":"http://www.nltaxonomie.nl/nt15/kvk/20201209/entrypoints/kvk-rpt-jaarverantwoording-2020-nlgaap-middelgroot.xsd","lang":"en","entityIdentifier":"12345678","entityScheme":"http://www.kvk.nl/kvk-id","unit":"iso4217:EUR","period":"2020-01-01/2020-12-31","decimals":"INF","dataRows":[{"value":"600000","concept":"jenv-bw2-i:IntangibleAssets","conceptNamespaceUri":"https://www.xbrl.org/2008/reference","unit":"iso4217:EUR","scenarioContent":["jenv-bw2-dim:BasisOfPreparationAxis#jenv-bw2-dm:CommercialMember","jenv-bw2-dim:FinancialStatementsTypeAxis#jenv-bw2-dm:SeparateMember"],"segmentContent":["Segment information here"],"decimals":"INF","period":"2020-01-01/2020-12-31","tupleUniqueId":"tuple-123","tupleConceptIds":{"additionalProp1":"value1","additionalProp2":"value2","additionalProp3":"value3"}}]} }, "With Hash": { "value": {"schemaRef":"http://www.nltaxonomie.nl/nt15/kvk/20201209/entrypoints/kvk-rpt-jaarverantwoording-2020-nlgaap-middelgroot.xsd","lang":"en","entityIdentifier":"12345678","entityScheme":"http://www.kvk.nl/kvk-id","unit":"iso4217:EUR","period":"2020-01-01/2020-12-31","decimals":"INF","dataRows":[{"value":"600000","concept":"jenv-bw2-i:IntangibleAssets","conceptNamespaceUri":"https://www.xbrl.org/2008/reference","unit":"iso4217:EUR","scenarioContent":["jenv-bw2-dim:BasisOfPreparationAxis#jenv-bw2-dm:CommercialMember","jenv-bw2-dim:FinancialStatementsTypeAxis#jenv-bw2-dm:SeparateMember"],"segmentContent":["Segment information here"],"decimals":"INF","period":"2020-01-01/2020-12-31","tupleUniqueId":"tuple-123","tupleConceptIds":{"additionalProp1":"value1","additionalProp2":"value2","additionalProp3":"value3"}}],"fileName":"My report.xbrl"} } } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomErrorDto" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenerationResponseDto" }, "examples": { "Without Hash": { "value": {"instanceContentBase64":"JVBERxLjQKMSAw...","taxonomyEntrypoint":"http://www.nltaxonomie.nl/nt15/kvk/20201209/entrypoints/kvk-rpt-jaarverantwoording-2020-nlgaap-middelgroot.xsd","factsCount":3,"tuplesCount":3,"unitsCount":6,"contextsCount":5} }, "With Hash": { "value": {"instanceContentBase64":"JVBERxLjQKMSAw...","taxonomyEntrypoint":"http://www.nltaxonomie.nl/nt15/kvk/20201209/entrypoints/kvk-rpt-jaarverantwoording-2020-nlgaap-middelgroot.xsd","factsCount":3,"tuplesCount":3,"unitsCount":6,"contextsCount":5,"hashResults":{"InstanceContentBase64_Hash_Result":"nKDBo115PBhw3U3Y="}} } } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/input-import/instance/csv-import": { "post": { "tags": [ "InputImport" ], "summary": "Generate an XBRL report (.xbrl) from CSV.", "description": "Generate an XBRL report (.xbrl) from xBRL-CSV-structured data file containing the reporting data.\r\nFor each of the functionality where in our API is produced result file we produce hash of the file that identifies the contents of the file. \r\nUser can validate the hash value in hash validation functionality and to know if any changes are applied. \r\nBy default the file hash is disabled, but it can be controlled from the dropdown below. \\\r\nResponse body will be for example: \r\n\r\n { \r\n \"InstanceContentBase64\": \"JVBERxLjQKMSAw...\", \r\n \"TaxonomyEntrypoint\": \"http://www.nltaxonomie.nl/nt15/kvk/20201209/entrypoints/kvk-rpt-jaarverantwoording-2020-nlgaap-middelgroot.xsd\", \r\n \"FactsCount\": 4, \r\n \"TuplesCount\": 3, \r\n \"UnitsCount\": 2, \r\n \"ContextsCount\": 1, \r\n \"hashResult\": { \r\n \"InstanceContentBase64_Hash_Result\": \"nKDBo115PBhw3U3Y= \" \r\n } \r\n }", "parameters": [ { "name": "isHashed", "in": "query", "description": "Optional. Specifies whether to have a hashcode included in the output. By default the value is false.", "schema": { "type": "boolean", "default": false } }, { "name": "packageName", "in": "query", "description": "Required if isHashed is true. Specifies the name of the package.", "schema": { "type": "string" } }, { "name": "x-api-version", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "ApplicationName", "in": "header", "description": "Name of the application to integrates with API’s to Semansys.Next." }, { "name": "PartnerName", "in": "header", "description": "Contract owner (organization) name that have embedded the API’s." }, { "name": "PartnerID", "in": "header", "description": "Business Identification Number (BIN) of the contract owner (organization) to embeds the API’s." }, { "name": "CustomerName", "in": "header", "description": "Customer (organization) name (ie. accounting firm, intermediary, ....)." }, { "name": "CustomerID", "in": "header", "description": "Business Identification Number (BIN) of the customer." }, { "name": "ClientName", "in": "header", "description": "Client (organization) name of the customer of the accounting firm, intermediary..." }, { "name": "ClientID", "in": "header", "description": "Business Identification Number (BIN) of the client." } ], "requestBody": { "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomErrorDto" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenerationResponseDto" }, "examples": { "Without Hash": { "value": {"instanceContentBase64":"JVBERxLjQKMSAw...","taxonomyEntrypoint":"http://www.nltaxonomie.nl/nt15/kvk/20201209/entrypoints/kvk-rpt-jaarverantwoording-2020-nlgaap-middelgroot.xsd","factsCount":3,"tuplesCount":3,"unitsCount":6,"contextsCount":5} }, "With Hash": { "value": {"instanceContentBase64":"JVBERxLjQKMSAw...","taxonomyEntrypoint":"http://www.nltaxonomie.nl/nt15/kvk/20201209/entrypoints/kvk-rpt-jaarverantwoording-2020-nlgaap-middelgroot.xsd","factsCount":3,"tuplesCount":3,"unitsCount":6,"contextsCount":5,"hashResults":{"InstanceContentBase64_Hash_Result":"nKDBo115PBhw3U3Y="}} } } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/input-import/instance/data": { "post": { "tags": [ "InputImport" ], "summary": "Extract report data in JSON format.", "description": "Generate an JSON output file based on the value available in an digital report in XBRL format.", "parameters": [ { "name": "x-api-version", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "ApplicationName", "in": "header", "description": "Name of the application to integrates with API’s to Semansys.Next." }, { "name": "PartnerName", "in": "header", "description": "Contract owner (organization) name that have embedded the API’s." }, { "name": "PartnerID", "in": "header", "description": "Business Identification Number (BIN) of the contract owner (organization) to embeds the API’s." }, { "name": "CustomerName", "in": "header", "description": "Customer (organization) name (ie. accounting firm, intermediary, ....)." }, { "name": "CustomerID", "in": "header", "description": "Business Identification Number (BIN) of the customer." }, { "name": "ClientName", "in": "header", "description": "Client (organization) name of the customer of the accounting firm, intermediary..." }, { "name": "ClientID", "in": "header", "description": "Business Identification Number (BIN) of the client." } ], "requestBody": { "description": "Data source JSON object", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InstanceImportRequestData" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomErrorDto" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InstanceImportResponseData" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/input-import/hash-creation": { "post": { "tags": [ "InputImport" ], "summary": "Calculates Hash Codes of a Report Package.", "description": "Generate hash code for a reporting package and outputs it in JSON format for all file enclosed in the package.", "parameters": [ { "name": "x-api-version", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "ApplicationName", "in": "header", "description": "Name of the application to integrates with API’s to Semansys.Next." }, { "name": "PartnerName", "in": "header", "description": "Contract owner (organization) name that have embedded the API’s." }, { "name": "PartnerID", "in": "header", "description": "Business Identification Number (BIN) of the contract owner (organization) to embeds the API’s." }, { "name": "CustomerName", "in": "header", "description": "Customer (organization) name (ie. accounting firm, intermediary, ....)." }, { "name": "CustomerID", "in": "header", "description": "Business Identification Number (BIN) of the customer." }, { "name": "ClientName", "in": "header", "description": "Client (organization) name of the customer of the accounting firm, intermediary..." }, { "name": "ClientID", "in": "header", "description": "Business Identification Number (BIN) of the client." } ], "requestBody": { "description": "Data source JSON object", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportPackageHashRequestData" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomErrorDto" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportPackageHashResponseData" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/input-import/hash-creation/single-file": { "post": { "tags": [ "InputImport" ], "summary": "Create hash code for (single) file.", "description": "Generate hash code for a (single) file.", "parameters": [ { "name": "x-api-version", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "ApplicationName", "in": "header", "description": "Name of the application to integrates with API’s to Semansys.Next." }, { "name": "PartnerName", "in": "header", "description": "Contract owner (organization) name that have embedded the API’s." }, { "name": "PartnerID", "in": "header", "description": "Business Identification Number (BIN) of the contract owner (organization) to embeds the API’s." }, { "name": "CustomerName", "in": "header", "description": "Customer (organization) name (ie. accounting firm, intermediary, ....)." }, { "name": "CustomerID", "in": "header", "description": "Business Identification Number (BIN) of the customer." }, { "name": "ClientName", "in": "header", "description": "Client (organization) name of the customer of the accounting firm, intermediary..." }, { "name": "ClientID", "in": "header", "description": "Business Identification Number (BIN) of the client." } ], "requestBody": { "description": "Data source JSON object", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportPackageHashRequestData" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomErrorDto" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportPackageHashResponseData" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/input-import/instance/reported-facts-ai": { "post": { "tags": [ "InputImport" ], "summary": "Create mapping from source and taxonomy using AI analytics.", "description": "Generate mapping, based on AI analytics, of the unstrucutred import source and a taxonomy.", "parameters": [ { "name": "x-api-version", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "ApplicationName", "in": "header", "description": "Name of the application to integrates with API’s to Semansys.Next." }, { "name": "PartnerName", "in": "header", "description": "Contract owner (organization) name that have embedded the API’s." }, { "name": "PartnerID", "in": "header", "description": "Business Identification Number (BIN) of the contract owner (organization) to embeds the API’s." }, { "name": "CustomerName", "in": "header", "description": "Customer (organization) name (ie. accounting firm, intermediary, ....)." }, { "name": "CustomerID", "in": "header", "description": "Business Identification Number (BIN) of the customer." }, { "name": "ClientName", "in": "header", "description": "Client (organization) name of the customer of the accounting firm, intermediary..." }, { "name": "ClientID", "in": "header", "description": "Business Identification Number (BIN) of the client." } ], "requestBody": { "description": "Data source JSON object", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetReportedFactsWithAIRequest" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomErrorDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomErrorDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomErrorDto" } } } }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ConceptElement" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ConceptElement" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ConceptElement" } } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/input-import/instance/generation-ai": { "post": { "tags": [ "InputImport" ], "summary": "Generate XBRLreport from source using AI analitcs.", "description": "Generate an XBRL report (.xbrl) from xBRL-CSV-structured data file containing the reporting data.\r\nFor each of the functionality where in our API is produced result file we produce hash of the file that identifies the contents of the file. \r\nUser can validate the hash value in hash validation functionality and to know if any changes are applied. \r\nBy default the file hash is disabled, but it can be controlled from the dropdown below. \\\r\nResponse body will be for example: \r\n\r\n { \r\n \"InstanceContentBase64\": \"JVBERxLjQKMSAw...\", \r\n \"TaxonomyEntrypoint\": \"http://www.nltaxonomie.nl/nt15/kvk/20201209/entrypoints/kvk-rpt-jaarverantwoording-2020-nlgaap-middelgroot.xsd\", \r\n \"FactsCount\": 4, \r\n \"TuplesCount\": 3, \r\n \"UnitsCount\": 2, \r\n \"ContextsCount\": 1, \r\n \"hashResult\": { \r\n \"InstanceContentBase64_Hash_Result\": \"nKDBo115PBhw3U3Y= \" \r\n } \r\n }", "parameters": [ { "name": "isHashed", "in": "query", "description": "Optional. Specifies whether to have a hashcode included in the output. By default the value is false.", "schema": { "type": "boolean", "default": false } }, { "name": "x-api-version", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "ApplicationName", "in": "header", "description": "Name of the application to integrates with API’s to Semansys.Next." }, { "name": "PartnerName", "in": "header", "description": "Contract owner (organization) name that have embedded the API’s." }, { "name": "PartnerID", "in": "header", "description": "Business Identification Number (BIN) of the contract owner (organization) to embeds the API’s." }, { "name": "CustomerName", "in": "header", "description": "Customer (organization) name (ie. accounting firm, intermediary, ....)." }, { "name": "CustomerID", "in": "header", "description": "Business Identification Number (BIN) of the customer." }, { "name": "ClientName", "in": "header", "description": "Client (organization) name of the customer of the accounting firm, intermediary..." }, { "name": "ClientID", "in": "header", "description": "Business Identification Number (BIN) of the client." } ], "requestBody": { "description": "Data source JSON object", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenerateInstanceWithAIRequest" }, "examples": { "Without Hash": { "value": {"conceptElements":[{"name":"string","concept":"string","period":"string","periodType":"string","unit":"string","value":"string","confidence":0,"typeQName":"string","typedMembers":[{"dimension":"string","member":"string","isTypedMember":true,"contextElement":"string","dimensionLabel":"string","memberLabel":"string","dimensionLabelCollection":[{"label":"string","language":"string","labelRole":"string","conceptId":"string"}],"memberLabelCollection":[{"label":"string","language":"string","labelRole":"string","conceptId":"string"}]}],"explicitMembers":[{"dimension":"string","value":"string","members":["string"]}],"scenarioContent":["string"],"enumerations":[{"name":"string","labels":[{"lang":"string","role":"string","xLinkLabel":"string","labelText":"string"}]}]}],"entityIdentifier":"string","entityScheme":"string","schemaRef":"string","decimals":"string","unit":"string","period":"string","lang":"string"} }, "With Hash": { "value": {"conceptElements":[{"name":"string","concept":"string","period":"string","periodType":"string","unit":"string","value":"string","confidence":0,"typeQName":"string","typedMembers":[{"dimension":"string","member":"string","isTypedMember":true,"contextElement":"string","dimensionLabel":"string","memberLabel":"string","dimensionLabelCollection":[{"label":"string","language":"string","labelRole":"string","conceptId":"string"}],"memberLabelCollection":[{"label":"string","language":"string","labelRole":"string","conceptId":"string"}]}],"explicitMembers":[{"dimension":"string","value":"string","members":["string"]}],"scenarioContent":["string"],"enumerations":[{"name":"string","labels":[{"lang":"string","role":"string","xLinkLabel":"string","labelText":"string"}]}]}],"entityIdentifier":"string","entityScheme":"string","schemaRef":"string","decimals":"string","unit":"string","period":"string","lang":"string","fileName":"My report.xbrl"} } } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomErrorDto" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenerationResponseDto" }, "examples": { "Without Hash": { "value": {"instanceContentBase64":"JVBERxLjQKMSAw...","taxonomyEntrypoint":"http://www.nltaxonomie.nl/nt15/kvk/20201209/entrypoints/kvk-rpt-jaarverantwoording-2020-nlgaap-middelgroot.xsd","factsCount":3,"tuplesCount":3,"unitsCount":6,"contextsCount":5} }, "With Hash": { "value": {"instanceContentBase64":"JVBERxLjQKMSAw...","taxonomyEntrypoint":"http://www.nltaxonomie.nl/nt15/kvk/20201209/entrypoints/kvk-rpt-jaarverantwoording-2020-nlgaap-middelgroot.xsd","factsCount":3,"tuplesCount":3,"unitsCount":6,"contextsCount":5,"hashResults":{"InstanceContentBase64_Hash_Result":"nKDBo115PBhw3U3Y="}} } } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/rendering/instance/render": { "post": { "tags": [ "Rendering" ], "summary": "Render the XBRL report (.xbrl) into a readable report.", "description": "Render the XBRL report (.xbrl) into a readable report according the taxonomy definitions (datapoint model, presentation or table structure).\r\nFor each of the functionality where in our API is produced result file we produce hash of the file that identifies the contents of the file. \r\nUser can validate the hash value in hash validation functionality and to know if any changes are applied. \r\nBy default the file hash is disabled, but it can be controlled from the dropdown below. \r\nResponse body will be for example: \r\n\r\n { \r\n \"htmlContent\": \"JVBERxLjQKMSAw...\", \r\n \"pdfContent\": \"GdsWdcdxDsaFgSd...\", \r\n \"hashResult\": { \r\n \"Hash_Result\": \"nKDBo115PBhw3U3Y= \" \r\n } \r\n }", "parameters": [ { "name": "output", "in": "query", "description": "Optional. Specifies output format. If missing result is in both html and pdf format.", "schema": { "type": "string" } }, { "name": "isHashed", "in": "query", "description": "Specifies whether to have a hashcode included in the output. By default the value is false.", "schema": { "type": "boolean", "default": false } }, { "name": "x-api-version", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "ApplicationName", "in": "header", "description": "Name of the application to integrates with API’s to Semansys.Next." }, { "name": "PartnerName", "in": "header", "description": "Contract owner (organization) name that have embedded the API’s." }, { "name": "PartnerID", "in": "header", "description": "Business Identification Number (BIN) of the contract owner (organization) to embeds the API’s." }, { "name": "CustomerName", "in": "header", "description": "Customer (organization) name (ie. accounting firm, intermediary, ....)." }, { "name": "CustomerID", "in": "header", "description": "Business Identification Number (BIN) of the customer." }, { "name": "ClientName", "in": "header", "description": "Client (organization) name of the customer of the accounting firm, intermediary..." }, { "name": "ClientID", "in": "header", "description": "Business Identification Number (BIN) of the client." } ], "requestBody": { "description": "A JSON object containing XBRL instance document content as base64 string", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportArgs" }, "examples": { "Without Hash": { "value": {"reportContentBase64":"SlZCRVJ4TGpRS01TQXcuLi4=","renderingSettings":{"mode":"Presentation","language":"en","colorBackground":"String","colorFont":"String","imageLogo":"String","header":"This is a header","footer":"This is a footer","showEmptyTables":true,"showEmptyRows":false,"showEmptyColumns":true,"applyFilingIndicators":false,"showToC":true,"levelOfDepth":3}} }, "With Hash": { "value": {"reportContentBase64":"SlZCRVJ4TGpRS01TQXcuLi4=","renderingSettings":{"mode":"Presentation","language":"en","colorBackground":"String","colorFont":"String","imageLogo":"String","header":"This is a header","footer":"This is a footer","showEmptyTables":true,"showEmptyRows":false,"showEmptyColumns":true,"applyFilingIndicators":false,"showToC":true,"levelOfDepth":3},"fileName":"file.xbrl"} } } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReportArgs" }, "examples": { "Without Hash": { "value": {"reportContentBase64":"SlZCRVJ4TGpRS01TQXcuLi4=","renderingSettings":{"mode":"Presentation","language":"en","colorBackground":"String","colorFont":"String","imageLogo":"String","header":"This is a header","footer":"This is a footer","showEmptyTables":true,"showEmptyRows":false,"showEmptyColumns":true,"applyFilingIndicators":false,"showToC":true,"levelOfDepth":3}} }, "With Hash": { "value": {"reportContentBase64":"SlZCRVJ4TGpRS01TQXcuLi4=","renderingSettings":{"mode":"Presentation","language":"en","colorBackground":"String","colorFont":"String","imageLogo":"String","header":"This is a header","footer":"This is a footer","showEmptyTables":true,"showEmptyRows":false,"showEmptyColumns":true,"applyFilingIndicators":false,"showToC":true,"levelOfDepth":3},"fileName":"file.xbrl"} } } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ReportArgs" }, "examples": { "Without Hash": { "value": {"reportContentBase64":"SlZCRVJ4TGpRS01TQXcuLi4=","renderingSettings":{"mode":"Presentation","language":"en","colorBackground":"String","colorFont":"String","imageLogo":"String","header":"This is a header","footer":"This is a footer","showEmptyTables":true,"showEmptyRows":false,"showEmptyColumns":true,"applyFilingIndicators":false,"showToC":true,"levelOfDepth":3}} }, "With Hash": { "value": {"reportContentBase64":"SlZCRVJ4TGpRS01TQXcuLi4=","renderingSettings":{"mode":"Presentation","language":"en","colorBackground":"String","colorFont":"String","imageLogo":"String","header":"This is a header","footer":"This is a footer","showEmptyTables":true,"showEmptyRows":false,"showEmptyColumns":true,"applyFilingIndicators":false,"showToC":true,"levelOfDepth":3},"fileName":"file.xbrl"} } } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomErrorDto" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportResultDTO" }, "examples": { "Without Hash": { "value": {"htmlContent":"JVBERxLjQKMSAw...","pdfContent":"SlZCRVJ4TGpRS01TQXcuLi4="} }, "With Hash": { "value": {"htmlContent":"JVBERxLjQKMSAw...","pdfContent":"SlZCRVJ4TGpRS01TQXcuLi4=","hashResults":{"Html_Hash_Result":"nKDBo115PBhw3U3Y=","PDF_Hash_Result":"nKDBo115PBhw3U3Y="}} } } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/rendering/instance/xhtml": { "post": { "tags": [ "Rendering" ], "summary": "Render the XBRL report (.xbrl) into a readable report in inline.", "description": "Render the XBRL report (.xbrl) into a readable report formatted as inline XBRL.\r\nFor each of the functionality where in our API is produced result file we produce hash of the file that identifies the contents of the file. \r\nUser can validate the hash value in hash validation functionality and to know if any changes are applied. \r\nBy default the file hash is disabled, but it can be controlled from the dropdown below. \r\nResponse body will be for example: \r\n\r\n { \r\n \"htmlContent\": \"JVBERxLjQKMSAw...\", \r\n \"pdfContent\": \"GdsWdcdxDsaFgSd...\", \r\n \"hashResult\": { \r\n \"Hash_Result\": \"nKDBo115PBhw3U3Y= \" \r\n } \r\n }", "parameters": [ { "name": "output", "in": "query", "description": "Optional. Specifies output format. If missing result is in both html and pdf format.", "schema": { "type": "string" } }, { "name": "isHashed", "in": "query", "description": "Specifies whether to have a hashcode included in the output. By default the value is false.", "schema": { "type": "boolean", "default": false } }, { "name": "x-api-version", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "ApplicationName", "in": "header", "description": "Name of the application to integrates with API’s to Semansys.Next." }, { "name": "PartnerName", "in": "header", "description": "Contract owner (organization) name that have embedded the API’s." }, { "name": "PartnerID", "in": "header", "description": "Business Identification Number (BIN) of the contract owner (organization) to embeds the API’s." }, { "name": "CustomerName", "in": "header", "description": "Customer (organization) name (ie. accounting firm, intermediary, ....)." }, { "name": "CustomerID", "in": "header", "description": "Business Identification Number (BIN) of the customer." }, { "name": "ClientName", "in": "header", "description": "Client (organization) name of the customer of the accounting firm, intermediary..." }, { "name": "ClientID", "in": "header", "description": "Business Identification Number (BIN) of the client." } ], "requestBody": { "description": "A JSON object containing XBRL instance document content as base64 string", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportArgs" }, "examples": { "Without Hash": { "value": {"reportContentBase64":"SlZCRVJ4TGpRS01TQXcuLi4="} }, "With Hash": { "value": {"reportContentBase64":"SlZCRVJ4TGpRS01TQXcuLi4=","fileName":"file.xbrl"} } } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReportArgs" }, "examples": { "Without Hash": { "value": {"reportContentBase64":"SlZCRVJ4TGpRS01TQXcuLi4="} }, "With Hash": { "value": {"reportContentBase64":"SlZCRVJ4TGpRS01TQXcuLi4=","fileName":"file.xbrl"} } } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ReportArgs" }, "examples": { "Without Hash": { "value": {"reportContentBase64":"SlZCRVJ4TGpRS01TQXcuLi4="} }, "With Hash": { "value": {"reportContentBase64":"SlZCRVJ4TGpRS01TQXcuLi4=","fileName":"file.xbrl"} } } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomErrorDto" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportResultDTO" }, "examples": { "Without Hash": { "value": {"htmlContent":"JVBERxLjQKMSAw...","pdfContent":"SlZCRVJ4TGpRS01TQXcuLi4="} }, "With Hash": { "value": {"htmlContent":"JVBERxLjQKMSAw...","pdfContent":"SlZCRVJ4TGpRS01TQXcuLi4=","hashResults":{"Html_Hash_Result":"nKDBo115PBhw3U3Y=","PDF_Hash_Result":"nKDBo115PBhw3U3Y="}} } } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/rendering/instance/html-to-inline-package": { "post": { "tags": [ "Rendering" ], "summary": "Render HTML report to inline XBRL format.", "description": "Render HTML report to inline XBRL format maintaining the format (look and feel) of the HTML report). Content is provided in an archive (.zip).\r\nFor each of the functionality where in our API is produced result file we produce hash of the file that identifies the contents of the file. \r\nUser can validate the hash value in hash validation functionality and to know if any changes are applied. \r\nBy default the file hash is disabled, but it can be controlled from the dropdown below. \r\nResponse body will be for example: \r\n\r\n { \r\n \"inlineXbrl\": \"JVBERxLjQKMSAw...\", \r\n \"hashResult\": { \r\n \"Hash_Result\": \"nKDBo115PBhw3U3Y= \" \r\n } \r\n }", "parameters": [ { "name": "isHashed", "in": "query", "description": "Specifies whether to have a hashcode included in the output. By default the value is false.", "schema": { "type": "boolean", "default": false } }, { "name": "packageName", "in": "query", "description": "Required if ishashed is set to true. Specifices the name of the name of the .zip package", "schema": { "type": "string" } }, { "name": "x-api-version", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "ApplicationName", "in": "header", "description": "Name of the application to integrates with API’s to Semansys.Next." }, { "name": "PartnerName", "in": "header", "description": "Contract owner (organization) name that have embedded the API’s." }, { "name": "PartnerID", "in": "header", "description": "Business Identification Number (BIN) of the contract owner (organization) to embeds the API’s." }, { "name": "CustomerName", "in": "header", "description": "Customer (organization) name (ie. accounting firm, intermediary, ....)." }, { "name": "CustomerID", "in": "header", "description": "Business Identification Number (BIN) of the customer." }, { "name": "ClientName", "in": "header", "description": "Client (organization) name of the customer of the accounting firm, intermediary..." }, { "name": "ClientID", "in": "header", "description": "Business Identification Number (BIN) of the client." } ], "requestBody": { "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomErrorDto" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RenderXbrlInline" }, "examples": { "Without Hash": { "value": {"inlineXbrl":"JVBERxLjQKMSAw..."} }, "With Hash": { "value": {"inlineXbrl":"JVBERxLjQKMSAw...","hashResults":{"Inline_Hash_Result":"nKDBo115PBhw3U3Y="}} } } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/rendering/instance/consistent": { "post": { "tags": [ "Rendering" ], "summary": "Render the XBRL report (.xbrl) into a readable consistent presentation report.", "description": "Render the XBRL report (.xbrl) into a readable consistent presentation report in accordance to the 'CP' specification rule set.\r\nFor each of the functionality where in our API is produced result file we produce hash of the file that identifies the contents of the file. \r\nUser can validate the hash value in hash validation functionality and to know if any changes are applied. \r\nBy default the file hash is disabled, but it can be controlled from the dropdown below. \r\nResponse body will be for example: \r\n\r\n { \r\n \"htmlContent\": \"JVBERxLjQKMSAw...\", \r\n \"pdfContent\": \"GdsWdcdxDsaFgSd...\", \r\n \"hashResult\": { \r\n \"Hash_Result\": \"nKDBo115PBhw3U3Y= \" \r\n } \r\n }", "parameters": [ { "name": "html or pdf", "in": "query", "description": "Optional. Specifies output format. If missing result is in both html and pdf format.", "schema": { "type": "string" } }, { "name": "isHashed", "in": "query", "description": "Specifies whether to have a hashcode included in the output. By default the value is false.", "schema": { "type": "boolean", "default": false } }, { "name": "x-api-version", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "ApplicationName", "in": "header", "description": "Name of the application to integrates with API’s to Semansys.Next." }, { "name": "PartnerName", "in": "header", "description": "Contract owner (organization) name that have embedded the API’s." }, { "name": "PartnerID", "in": "header", "description": "Business Identification Number (BIN) of the contract owner (organization) to embeds the API’s." }, { "name": "CustomerName", "in": "header", "description": "Customer (organization) name (ie. accounting firm, intermediary, ....)." }, { "name": "CustomerID", "in": "header", "description": "Business Identification Number (BIN) of the customer." }, { "name": "ClientName", "in": "header", "description": "Client (organization) name of the customer of the accounting firm, intermediary..." }, { "name": "ClientID", "in": "header", "description": "Business Identification Number (BIN) of the client." } ], "requestBody": { "description": "A JSON object containing XBRL instance document content as base64 string", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportConsistentArgs" }, "examples": { "Without Hash": { "value": {"reportContentBase64":"SlZCRVJ4TGpRS01TQXcuLi4="} }, "With Hash": { "value": {"reportContentBase64":"SlZCRVJ4TGpRS01TQXcuLi4=","fileName":"file.xbrl"} } } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReportConsistentArgs" }, "examples": { "Without Hash": { "value": {"reportContentBase64":"SlZCRVJ4TGpRS01TQXcuLi4="} }, "With Hash": { "value": {"reportContentBase64":"SlZCRVJ4TGpRS01TQXcuLi4=","fileName":"file.xbrl"} } } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ReportConsistentArgs" }, "examples": { "Without Hash": { "value": {"reportContentBase64":"SlZCRVJ4TGpRS01TQXcuLi4="} }, "With Hash": { "value": {"reportContentBase64":"SlZCRVJ4TGpRS01TQXcuLi4=","fileName":"file.xbrl"} } } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomErrorDto" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportResultDTO" }, "examples": { "Without Hash": { "value": {"htmlContent":"JVBERxLjQKMSAw...","pdfContent":"SlZCRVJ4TGpRS01TQXcuLi4="} }, "With Hash": { "value": {"htmlContent":"JVBERxLjQKMSAw...","pdfContent":"SlZCRVJ4TGpRS01TQXcuLi4=","hashResults":{"Html_Hash_Result":"nKDBo115PBhw3U3Y=","PDF_Hash_Result":"nKDBo115PBhw3U3Y="}} } } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/rendering/instance/consistent-plus": { "post": { "tags": [ "Rendering" ], "summary": "Render the XBRL Report (.xbrl) into a consistent presentation report that includes assertion validation (business rules) results.", "description": "Render the XBRL Report (.xbrl) into a consistent presentation report that includes assertion validation (business rules) results.\r\nFor each of the functionality where in our API is produced result file we produce hash of the file that identifies the contents of the file. \r\nUser can validate the hash value in hash validation functionality and to know if any changes are applied. \r\nBy default the file hash is disabled, but it can be controlled from the dropdown below. \r\nResponse body will be for example: \r\n\r\n { \r\n \"htmlContent\": \"JVBERxLjQKMSAw...\", \r\n \"pdfContent\": \"GdsWdcdxDsaFgSd...\", \r\n \"hashResult\": { \r\n \"Hash_Result\": \"nKDBo115PBhw3U3Y= \" \r\n } \r\n }", "parameters": [ { "name": "html or pdf", "in": "query", "description": "Optional. Specifies output format. If missing result is in both html and pdf format.", "schema": { "type": "string" } }, { "name": "isHashed", "in": "query", "description": "Specifies whether to have a hashcode included in the output. By default the value is false.", "schema": { "type": "boolean", "default": false } }, { "name": "x-api-version", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "ApplicationName", "in": "header", "description": "Name of the application to integrates with API’s to Semansys.Next." }, { "name": "PartnerName", "in": "header", "description": "Contract owner (organization) name that have embedded the API’s." }, { "name": "PartnerID", "in": "header", "description": "Business Identification Number (BIN) of the contract owner (organization) to embeds the API’s." }, { "name": "CustomerName", "in": "header", "description": "Customer (organization) name (ie. accounting firm, intermediary, ....)." }, { "name": "CustomerID", "in": "header", "description": "Business Identification Number (BIN) of the customer." }, { "name": "ClientName", "in": "header", "description": "Client (organization) name of the customer of the accounting firm, intermediary..." }, { "name": "ClientID", "in": "header", "description": "Business Identification Number (BIN) of the client." } ], "requestBody": { "description": "A JSON object containing XBRL instance document content as base64 string", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportPlusArgs" }, "examples": { "Without Hash": { "value": {"reportContentBase64":"SlZCRVJ4TGpRS01TQXcuLi4="} }, "With Hash": { "value": {"reportContentBase64":"SlZCRVJ4TGpRS01TQXcuLi4=","fileName":"file.xbrl"} } } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReportPlusArgs" }, "examples": { "Without Hash": { "value": {"reportContentBase64":"SlZCRVJ4TGpRS01TQXcuLi4="} }, "With Hash": { "value": {"reportContentBase64":"SlZCRVJ4TGpRS01TQXcuLi4=","fileName":"file.xbrl"} } } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ReportPlusArgs" }, "examples": { "Without Hash": { "value": {"reportContentBase64":"SlZCRVJ4TGpRS01TQXcuLi4="} }, "With Hash": { "value": {"reportContentBase64":"SlZCRVJ4TGpRS01TQXcuLi4=","fileName":"file.xbrl"} } } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomErrorDto" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportResultDTO" }, "examples": { "Without Hash": { "value": {"htmlContent":"JVBERxLjQKMSAw...","pdfContent":"SlZCRVJ4TGpRS01TQXcuLi4="} }, "With Hash": { "value": {"htmlContent":"JVBERxLjQKMSAw...","pdfContent":"SlZCRVJ4TGpRS01TQXcuLi4=","hashResults":{"Html_Hash_Result":"nKDBo115PBhw3U3Y=","PDF_Hash_Result":"nKDBo115PBhw3U3Y="}} } } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/rendering/instance/convert-inline-to-xbrl": { "post": { "tags": [ "Rendering" ], "summary": "Render the inline XBRL report into a XBRL report (.xbrl).", "description": "Render the inline XBRL report into a 'plain vanilla' XBRL report (.xbrl).\r\nFor each of the functionality where in our API is produced result file we produce hash of the file that identifies the contents of the file. \r\nUser can validate the hash value in hash validation functionality and to know if any changes are applied. \r\nBy default the file hash is disabled, but it can be controlled from the dropdown below. \r\nResponse body will be for example: \r\n\r\n { \r\n \"xbrlReportContent\": \"JVBERxLjQKMSAw...\", \r\n \"entrypoint\": \"http://www.nltaxonomie.nl/nt15/kvk/20201209/entrypoints/kvk-rpt-jaarverantwoording-2020-nlgaap-middelgroot.xsd\", \r\n \"facts\": \"3\", \r\n \"contexts\": \"2\", \r\n \"units\": \"1\", \r\n \"hashResult\": { \r\n \"Hash_Result\": \"nKDBo115PBhw3U3Y= \" \r\n } \r\n }", "parameters": [ { "name": "isHashed", "in": "query", "description": "Specifies whether to have a hashcode included in the output. By default the value is false.", "schema": { "type": "boolean", "default": false } }, { "name": "x-api-version", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "ApplicationName", "in": "header", "description": "Name of the application to integrates with API’s to Semansys.Next." }, { "name": "PartnerName", "in": "header", "description": "Contract owner (organization) name that have embedded the API’s." }, { "name": "PartnerID", "in": "header", "description": "Business Identification Number (BIN) of the contract owner (organization) to embeds the API’s." }, { "name": "CustomerName", "in": "header", "description": "Customer (organization) name (ie. accounting firm, intermediary, ....)." }, { "name": "CustomerID", "in": "header", "description": "Business Identification Number (BIN) of the customer." }, { "name": "ClientName", "in": "header", "description": "Client (organization) name of the customer of the accounting firm, intermediary..." }, { "name": "ClientID", "in": "header", "description": "Business Identification Number (BIN) of the client." } ], "requestBody": { "description": "A JSON object containing XBRL instance document content as base64 string", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomInlineToXbrlRequest" }, "examples": { "Without Hash": { "value": {"reportContentBase64":"JVBERxLjQKMSAw..."} }, "With Hash": { "value": {"reportContentBase64":"JVBERxLjQKMSAw...","fileName":"file.xbrl"} } } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomInlineToXbrlRequest" }, "examples": { "Without Hash": { "value": {"reportContentBase64":"JVBERxLjQKMSAw..."} }, "With Hash": { "value": {"reportContentBase64":"JVBERxLjQKMSAw...","fileName":"file.xbrl"} } } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CustomInlineToXbrlRequest" }, "examples": { "Without Hash": { "value": {"reportContentBase64":"JVBERxLjQKMSAw..."} }, "With Hash": { "value": {"reportContentBase64":"JVBERxLjQKMSAw...","fileName":"file.xbrl"} } } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomErrorDto" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomInlineToXbrlResponse" }, "examples": { "Without Hash": { "value": {"entrypoint":"http://www.nltaxonomie.nl/nt15/kvk/20201209/entrypoints/kvk-rpt-jaarverantwoording-2020-nlgaap-middelgroot.xsd","xbrlReportContent":"JVBERxLjQKMSAw...","facts":"3","contexts":"2","units":"1"} }, "With Hash": { "value": {"entrypoint":"http://www.nltaxonomie.nl/nt15/kvk/20201209/entrypoints/kvk-rpt-jaarverantwoording-2020-nlgaap-middelgroot.xsd","xbrlReportContent":"JVBERxLjQKMSAw...","facts":"3","contexts":"2","units":"1","hashResults":{"Xbrl_Hash_Result":"nKDBo115PBhw3U3Y="}} } } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/rendering/instance/tax-report-sbr-nl": { "post": { "tags": [ "Rendering" ], "summary": "Render the XBRL report (.xbrl) into a readable report (.PDF) for tax reports.", "description": "Render the XBRL report (.xbrl) into a readable report (.PDF) for tax reports (OB/OB-Sub/ICP)(NL).\r\nFor each of the functionality where in our API is produced result file we produce hash of the file that identifies the contents of the file. \r\nUser can validate the hash value in hash validation functionality and to know if any changes are applied. \r\nBy default the file hash is disabled, but it can be controlled from the dropdown below. \r\nResponse body will be for example: \r\n\r\n { \r\n \"type\": \"n/a\", \r\n \"htmlContent\": \"JVBERxLjQKMSAw...\", \r\n \"pdfContent\": \"GdsWdcdxDsaFgSd...\", \r\n \"hashResult\": { \r\n \"Hash_Result\": \"nKDBo115PBhw3U3Y= \" \r\n } \r\n }", "parameters": [ { "name": "isHashed", "in": "query", "description": "Specifies whether to have a hashcode included in the output. By default the value is false.", "schema": { "type": "boolean", "default": false } }, { "name": "x-api-version", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "ApplicationName", "in": "header", "description": "Name of the application to integrates with API’s to Semansys.Next." }, { "name": "PartnerName", "in": "header", "description": "Contract owner (organization) name that have embedded the API’s." }, { "name": "PartnerID", "in": "header", "description": "Business Identification Number (BIN) of the contract owner (organization) to embeds the API’s." }, { "name": "CustomerName", "in": "header", "description": "Customer (organization) name (ie. accounting firm, intermediary, ....)." }, { "name": "CustomerID", "in": "header", "description": "Business Identification Number (BIN) of the customer." }, { "name": "ClientName", "in": "header", "description": "Client (organization) name of the customer of the accounting firm, intermediary..." }, { "name": "ClientID", "in": "header", "description": "Business Identification Number (BIN) of the client." } ], "requestBody": { "description": "A JSON object containing XBRL instance document content as base64 string", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportSupplementArgs" }, "examples": { "Without Hash": { "value": {"reportContentBase64":"SlZCRVJ4TGpRS01TQXcuLi4=","isOutputInline":true,"includePdfOutput":true} }, "With Hash": { "value": {"reportContentBase64":"SlZCRVJ4TGpRS01TQXcuLi4=","isOutputInline":true,"includePdfOutput":true,"fileName":"file.xbrl"} } } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomErrorDto" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportSupplementResultDto" }, "examples": { "Without Hash": { "value": {"type":"n/a","htmlContent":"JVBERxLjQKMSAw...","pdfContent":"SlZCRVJ4TGpRS01TQXcuLi4="} }, "With Hash": { "value": {"type":"n/a","htmlContent":"JVBERxLjQKMSAw...","pdfContent":"SlZCRVJ4TGpRS01TQXcuLi4=","hashResults":{"Html_Hash_Result":"nKDBo115PBhw3U3Y=","PDF_Hash_Result":"nKDBo115PBhw3U3Y="}} } } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/rendering/instance/uniform": { "post": { "tags": [ "Rendering" ], "summary": "Render the XBRL report (.xbrl) and apply uniformation in the process.", "description": "Render the XBRL report (.xbrl) and apply uniformation changes (best practices) to the XBRL report in the process and create a new version of the XBRL report (.xbrl).\r\nFor each of the functionality where in our API is produced result file we produce hash of the file that identifies the contents of the file. \r\nUser can validate the hash value in hash validation functionality and to know if any changes are applied. \r\nBy default the file hash is disabled, but it can be controlled from the dropdown below. \r\nResponse body will be for example: \r\n\r\n { \r\n \"uniformedXbrlInstance\": \"JVBERxLjQKMSAw...\", \r\n \"uniformLog\": \"GdsWdcdxDsaFgSd...\", \r\n \"hashResult\": { \r\n \"Hash_Result\": \"nKDBo115PBhw3U3Y= \" \r\n } \r\n }", "parameters": [ { "name": "isHashed", "in": "query", "description": "Specifies whether to have a hashcode included in the output. By default the value is false.", "schema": { "type": "boolean", "default": false } }, { "name": "x-api-version", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "ApplicationName", "in": "header", "description": "Name of the application to integrates with API’s to Semansys.Next." }, { "name": "PartnerName", "in": "header", "description": "Contract owner (organization) name that have embedded the API’s." }, { "name": "PartnerID", "in": "header", "description": "Business Identification Number (BIN) of the contract owner (organization) to embeds the API’s." }, { "name": "CustomerName", "in": "header", "description": "Customer (organization) name (ie. accounting firm, intermediary, ....)." }, { "name": "CustomerID", "in": "header", "description": "Business Identification Number (BIN) of the customer." }, { "name": "ClientName", "in": "header", "description": "Client (organization) name of the customer of the accounting firm, intermediary..." }, { "name": "ClientID", "in": "header", "description": "Business Identification Number (BIN) of the client." } ], "requestBody": { "description": "A JSON object containing XBRL instance document content as base64 string", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RenderUniformRequest" }, "examples": { "Without Hash": { "value": {"xbrlInstance":"SlZCRVJ4TGpRS01TQXcuLi4=","uniformOptions":{"language":"nl","unusedContexts":true,"unusedUnits":true,"duplicatedContexts":true,"duplicatedUnits":true,"duplicatedFacts":true,"nonCanonicalNamespaces":true,"unusedNamespaces":true,"unclassifiedCharacters":true}} }, "With Hash": { "value": {"xbrlInstance":"SlZCRVJ4TGpRS01TQXcuLi4=","uniformOptions":{"language":"nl","unusedContexts":true,"unusedUnits":true,"duplicatedContexts":true,"duplicatedUnits":true,"duplicatedFacts":true,"nonCanonicalNamespaces":true,"unusedNamespaces":true,"unclassifiedCharacters":true},"fileName":"file.xbrl"} } } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomErrorDto" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RenderUniformResponse" }, "examples": { "Without Hash": { "value": {"uniformedXbrlInstance":"SlZCRVJ4TGpRS01TQXcuLi4=","uniformLog":""} }, "With Hash": { "value": {"uniformedXbrlInstance":"SlZCRVJ4TGpRS01TQXcuLi4=","uniformLog":"","hashResults":{"Uniformed_Xbrl_Instance_Hash_Result":"nKDBo115PBhw3U3Y=","Uniform_Log_Hash_Result":"nKDBo115PBhw3U3Y="}} } } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/rendering/instance/merge": { "post": { "tags": [ "Rendering" ], "summary": "Render two XBRL reports and merge them into one new XBRL report (.xbrl).", "description": "Render two XBRL reports and merge them into one new XBRL report (.xbrl) and a log with not merged content is available.\r\nFor each of the functionality where in our API is produced result file we produce hash of the file that identifies the contents of the file. \r\nUser can validate the hash value in hash validation functionality and to know if any changes are applied. \r\nBy default the file hash is disabled, but it can be controlled from the dropdown below. \r\nResponse body will be for example: \r\n\r\n { \r\n \"MergedContent\": \"JVBERxLjQKMSAw...\", \r\n \"UnmergedContent\": \"GdsWdcdxDsaFgSd...\", \r\n \"hashResult\": { \r\n \"Hash_Result\": \"nKDBo115PBhw3U3Y= \" \r\n } \r\n }", "parameters": [ { "name": "isHashed", "in": "query", "description": "Specifies whether to have a hashcode included in the output. By default the value is false.", "schema": { "type": "boolean", "default": false } }, { "name": "x-api-version", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "ApplicationName", "in": "header", "description": "Name of the application to integrates with API’s to Semansys.Next." }, { "name": "PartnerName", "in": "header", "description": "Contract owner (organization) name that have embedded the API’s." }, { "name": "PartnerID", "in": "header", "description": "Business Identification Number (BIN) of the contract owner (organization) to embeds the API’s." }, { "name": "CustomerName", "in": "header", "description": "Customer (organization) name (ie. accounting firm, intermediary, ....)." }, { "name": "CustomerID", "in": "header", "description": "Business Identification Number (BIN) of the customer." }, { "name": "ClientName", "in": "header", "description": "Client (organization) name of the customer of the accounting firm, intermediary..." }, { "name": "ClientID", "in": "header", "description": "Business Identification Number (BIN) of the client." } ], "requestBody": { "description": "A JSON object of the dictionary with files.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MergeRequest" }, "examples": { "Without Hash": { "value": {"filesToBeMerged":{"master":"SlZCRVJ4TGpRS01TQXcuLi4=","child":"SlZCRVJ4TGpRS01TQXcuLi4="}} }, "With Hash": { "value": {"filesToBeMerged":{"master":"SlZCRVJ4TGpRS01TQXcuLi4=","child":"SlZCRVJ4TGpRS01TQXcuLi4="},"fileName":"filename"} } } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomErrorDto" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MergeResponse" }, "examples": { "Without Hash": { "value": {"mergedContent":"JVBERxLjQKMSAw...","unmergedContent":"JVBERxLjQKMSAw..."} }, "With Hash": { "value": {"mergedContent":"JVBERxLjQKMSAw...","unmergedContent":"JVBERxLjQKMSAw...","hashResults":{"Rendering_Merged_Instance_Hash_Result":"nKDBo115PBhw3U3Y="}} } } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/rendering/instance/allowed-render-options/{fileId}": { "get": { "tags": [ "Rendering" ], "summary": "Gets valid rendering modes for report.", "description": "Provides a list of render options that are available for the report provided.", "parameters": [ { "name": "fileId", "in": "path", "description": "Id of the file.", "required": true, "schema": { "type": "string" } }, { "name": "x-api-version", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "ApplicationName", "in": "header", "description": "Name of the application to integrates with API’s to Semansys.Next." }, { "name": "PartnerName", "in": "header", "description": "Contract owner (organization) name that have embedded the API’s." }, { "name": "PartnerID", "in": "header", "description": "Business Identification Number (BIN) of the contract owner (organization) to embeds the API’s." }, { "name": "CustomerName", "in": "header", "description": "Customer (organization) name (ie. accounting firm, intermediary, ....)." }, { "name": "CustomerID", "in": "header", "description": "Business Identification Number (BIN) of the customer." }, { "name": "ClientName", "in": "header", "description": "Client (organization) name of the customer of the accounting firm, intermediary..." }, { "name": "ClientID", "in": "header", "description": "Business Identification Number (BIN) of the client." } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomErrorDto" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AllowedRenderModesResponse" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/taxonomy/entrypoints": { "get": { "tags": [ "Taxonomy" ], "summary": "Retrieve the taxonomies available on the platform.", "description": "Retrieve the list of taxonomy entrypoints available on the SemansysNext platform.", "parameters": [ { "name": "x-api-version", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "ApplicationName", "in": "header", "description": "Name of the application to integrates with API’s to Semansys.Next." }, { "name": "PartnerName", "in": "header", "description": "Contract owner (organization) name that have embedded the API’s." }, { "name": "PartnerID", "in": "header", "description": "Business Identification Number (BIN) of the contract owner (organization) to embeds the API’s." }, { "name": "CustomerName", "in": "header", "description": "Customer (organization) name (ie. accounting firm, intermediary, ....)." }, { "name": "CustomerID", "in": "header", "description": "Business Identification Number (BIN) of the customer." }, { "name": "ClientName", "in": "header", "description": "Client (organization) name of the customer of the accounting firm, intermediary..." }, { "name": "ClientID", "in": "header", "description": "Business Identification Number (BIN) of the client." } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomErrorDto" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomTaxonomyResponse" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/taxonomy/entrypoints/{id}": { "get": { "tags": [ "Taxonomy" ], "summary": "Retrieve taxonomy details.", "description": "Retrieve based on the taxonomy ID the entrypoint details and meta data related to it.", "parameters": [ { "name": "id", "in": "path", "description": "The taxonomy entry point id (UUID).", "required": true, "schema": { "type": "string" } }, { "name": "x-api-version", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "ApplicationName", "in": "header", "description": "Name of the application to integrates with API’s to Semansys.Next." }, { "name": "PartnerName", "in": "header", "description": "Contract owner (organization) name that have embedded the API’s." }, { "name": "PartnerID", "in": "header", "description": "Business Identification Number (BIN) of the contract owner (organization) to embeds the API’s." }, { "name": "CustomerName", "in": "header", "description": "Customer (organization) name (ie. accounting firm, intermediary, ....)." }, { "name": "CustomerID", "in": "header", "description": "Business Identification Number (BIN) of the customer." }, { "name": "ClientName", "in": "header", "description": "Client (organization) name of the customer of the accounting firm, intermediary..." }, { "name": "ClientID", "in": "header", "description": "Business Identification Number (BIN) of the client." } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomErrorDto" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaxonomyEntrypointDto" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/taxonomy/entrypoint": { "post": { "tags": [ "Taxonomy" ], "summary": "Add taxonomy to the platform.", "description": "Add a new taxonomy to the SemanysNext platform by URL.", "parameters": [ { "name": "x-api-version", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "ApplicationName", "in": "header", "description": "Name of the application to integrates with API’s to Semansys.Next." }, { "name": "PartnerName", "in": "header", "description": "Contract owner (organization) name that have embedded the API’s." }, { "name": "PartnerID", "in": "header", "description": "Business Identification Number (BIN) of the contract owner (organization) to embeds the API’s." }, { "name": "CustomerName", "in": "header", "description": "Customer (organization) name (ie. accounting firm, intermediary, ....)." }, { "name": "CustomerID", "in": "header", "description": "Business Identification Number (BIN) of the customer." }, { "name": "ClientName", "in": "header", "description": "Client (organization) name of the customer of the accounting firm, intermediary..." }, { "name": "ClientID", "in": "header", "description": "Business Identification Number (BIN) of the client." } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaxonomyEntrypointDto" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomErrorDto" } } } }, "202": { "description": "Accepted" }, "401": { "description": "Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/taxonomy/package": { "post": { "tags": [ "Taxonomy" ], "summary": "Add taxonomy to the platform by taxonomy package.", "description": "Add a new taxonomy to the SemanysNext platform by taxonomy package.", "parameters": [ { "name": "x-api-version", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "ApplicationName", "in": "header", "description": "Name of the application to integrates with API’s to Semansys.Next." }, { "name": "PartnerName", "in": "header", "description": "Contract owner (organization) name that have embedded the API’s." }, { "name": "PartnerID", "in": "header", "description": "Business Identification Number (BIN) of the contract owner (organization) to embeds the API’s." }, { "name": "CustomerName", "in": "header", "description": "Customer (organization) name (ie. accounting firm, intermediary, ....)." }, { "name": "CustomerID", "in": "header", "description": "Business Identification Number (BIN) of the customer." }, { "name": "ClientName", "in": "header", "description": "Client (organization) name of the customer of the accounting firm, intermediary..." }, { "name": "ClientID", "in": "header", "description": "Business Identification Number (BIN) of the client." } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaxonomyPackageDto" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomErrorDto" } } } }, "202": { "description": "Accepted" }, "401": { "description": "Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/taxonomy/entrypoints/{id}/schema-set": { "get": { "tags": [ "Taxonomy" ], "summary": "Retrieve taxonomy set of schemas based on the entrypoint.", "description": "Retrieve the set of taxnomy schema based on the reporting entrypoint that is provided.", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "x-api-version", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "ApplicationName", "in": "header", "description": "Name of the application to integrates with API’s to Semansys.Next." }, { "name": "PartnerName", "in": "header", "description": "Contract owner (organization) name that have embedded the API’s." }, { "name": "PartnerID", "in": "header", "description": "Business Identification Number (BIN) of the contract owner (organization) to embeds the API’s." }, { "name": "CustomerName", "in": "header", "description": "Customer (organization) name (ie. accounting firm, intermediary, ....)." }, { "name": "CustomerID", "in": "header", "description": "Business Identification Number (BIN) of the customer." }, { "name": "ClientName", "in": "header", "description": "Client (organization) name of the customer of the accounting firm, intermediary..." }, { "name": "ClientID", "in": "header", "description": "Business Identification Number (BIN) of the client." } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomErrorDto" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaxonomySchemaSetResponse" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/taxonomy/entrypoints/parameters": { "get": { "tags": [ "Taxonomy" ], "summary": "Retrieve taxonomy parameters by entrypoint.", "description": "Retrieve taxonomy parameters by entrypoint URL (SBR-NL).", "parameters": [ { "name": "schemaRef", "in": "query", "description": "The taxonomy entrypoint.", "required": true, "schema": { "type": "string" } }, { "name": "x-api-version", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "ApplicationName", "in": "header", "description": "Name of the application to integrates with API’s to Semansys.Next." }, { "name": "PartnerName", "in": "header", "description": "Contract owner (organization) name that have embedded the API’s." }, { "name": "PartnerID", "in": "header", "description": "Business Identification Number (BIN) of the contract owner (organization) to embeds the API’s." }, { "name": "CustomerName", "in": "header", "description": "Customer (organization) name (ie. accounting firm, intermediary, ....)." }, { "name": "CustomerID", "in": "header", "description": "Business Identification Number (BIN) of the customer." }, { "name": "ClientName", "in": "header", "description": "Client (organization) name of the customer of the accounting firm, intermediary..." }, { "name": "ClientID", "in": "header", "description": "Business Identification Number (BIN) of the client." } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomErrorDto" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Parameter" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/taxonomy/entrypoints/{id}/parameters": { "get": { "tags": [ "Taxonomy" ], "summary": "Retrieve taxonomy parameters by entrypoint ID.", "description": "Retrieve taxonomy parameters by entrypoint ID (SBR-NL).", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "x-api-version", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "ApplicationName", "in": "header", "description": "Name of the application to integrates with API’s to Semansys.Next." }, { "name": "PartnerName", "in": "header", "description": "Contract owner (organization) name that have embedded the API’s." }, { "name": "PartnerID", "in": "header", "description": "Business Identification Number (BIN) of the contract owner (organization) to embeds the API’s." }, { "name": "CustomerName", "in": "header", "description": "Customer (organization) name (ie. accounting firm, intermediary, ....)." }, { "name": "CustomerID", "in": "header", "description": "Business Identification Number (BIN) of the customer." }, { "name": "ClientName", "in": "header", "description": "Client (organization) name of the customer of the accounting firm, intermediary..." }, { "name": "ClientID", "in": "header", "description": "Business Identification Number (BIN) of the client." } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomErrorDto" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Parameter" } } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/taxonomy/entrypoints/table-of-content": { "post": { "tags": [ "Taxonomy" ], "summary": "Retrieve taxonomy table of content by entrypoint URL.", "description": "Retrieve taxonomy table of content (TOC) by entrypoint URL.", "parameters": [ { "name": "x-api-version", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "ApplicationName", "in": "header", "description": "Name of the application to integrates with API’s to Semansys.Next." }, { "name": "PartnerName", "in": "header", "description": "Contract owner (organization) name that have embedded the API’s." }, { "name": "PartnerID", "in": "header", "description": "Business Identification Number (BIN) of the contract owner (organization) to embeds the API’s." }, { "name": "CustomerName", "in": "header", "description": "Customer (organization) name (ie. accounting firm, intermediary, ....)." }, { "name": "CustomerID", "in": "header", "description": "Business Identification Number (BIN) of the customer." }, { "name": "ClientName", "in": "header", "description": "Client (organization) name of the customer of the accounting firm, intermediary..." }, { "name": "ClientID", "in": "header", "description": "Business Identification Number (BIN) of the client." } ], "requestBody": { "description": "The taxonomy entrypoint.", "content": { "application/json": { "schema": { "type": "string" }, "example": "http://www.nltaxonomie.nl/nt18/kvk/20231213/entrypoints/kvk-rpt-jaarverantwoording-2023-nlgaap-micro.xsd" }, "text/json": { "schema": { "type": "string" }, "example": "http://www.nltaxonomie.nl/nt18/kvk/20231213/entrypoints/kvk-rpt-jaarverantwoording-2023-nlgaap-micro.xsd" }, "application/*+json": { "schema": { "type": "string" }, "example": "http://www.nltaxonomie.nl/nt18/kvk/20231213/entrypoints/kvk-rpt-jaarverantwoording-2023-nlgaap-micro.xsd" } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomErrorDto" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TableOfContentModel" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/taxonomy/entrypoints/{id}/table-of-content": { "get": { "tags": [ "Taxonomy" ], "summary": "Retrieve taxonomy table of content by entrypoint ID.", "description": "Retrieve taxonomy table of content (TOC) by entrypoint ID.", "parameters": [ { "name": "id", "in": "path", "description": "The taxonomy entry point id (UUID).", "required": true, "schema": { "type": "string" } }, { "name": "x-api-version", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "ApplicationName", "in": "header", "description": "Name of the application to integrates with API’s to Semansys.Next." }, { "name": "PartnerName", "in": "header", "description": "Contract owner (organization) name that have embedded the API’s." }, { "name": "PartnerID", "in": "header", "description": "Business Identification Number (BIN) of the contract owner (organization) to embeds the API’s." }, { "name": "CustomerName", "in": "header", "description": "Customer (organization) name (ie. accounting firm, intermediary, ....)." }, { "name": "CustomerID", "in": "header", "description": "Business Identification Number (BIN) of the customer." }, { "name": "ClientName", "in": "header", "description": "Client (organization) name of the customer of the accounting firm, intermediary..." }, { "name": "ClientID", "in": "header", "description": "Business Identification Number (BIN) of the client." } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomErrorDto" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "string", "format": "byte" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/taxonomy/entrypoints/{id}/tables": { "post": { "tags": [ "Taxonomy" ], "summary": "Retrieve taxonomy tables by entrypoint ID.", "description": "Retrieve all taxonomy tables by entrypoint ID.", "parameters": [ { "name": "id", "in": "path", "description": "The taxonomy entry point id (UUID)", "required": true, "schema": { "type": "string" } }, { "name": "x-api-version", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "ApplicationName", "in": "header", "description": "Name of the application to integrates with API’s to Semansys.Next." }, { "name": "PartnerName", "in": "header", "description": "Contract owner (organization) name that have embedded the API’s." }, { "name": "PartnerID", "in": "header", "description": "Business Identification Number (BIN) of the contract owner (organization) to embeds the API’s." }, { "name": "CustomerName", "in": "header", "description": "Customer (organization) name (ie. accounting firm, intermediary, ....)." }, { "name": "CustomerID", "in": "header", "description": "Business Identification Number (BIN) of the customer." }, { "name": "ClientName", "in": "header", "description": "Client (organization) name of the customer of the accounting firm, intermediary..." }, { "name": "ClientID", "in": "header", "description": "Business Identification Number (BIN) of the client." } ], "requestBody": { "description": "A JSON object containing parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTablesForRequest" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomErrorDto" } } } }, "202": { "description": "Accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomTablesResponse" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/taxonomy/entrypoints/tables/status/{id}": { "get": { "tags": [ "Taxonomy" ], "summary": "Retrieve taxonomy tables by entrypoint ID.", "description": "Retrieve all taxonomy tables by entrypoint ID.", "parameters": [ { "name": "id", "in": "path", "description": "Job id provided by '/tables' endpoint", "required": true, "schema": { "type": "string" } }, { "name": "x-api-version", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "ApplicationName", "in": "header", "description": "Name of the application to integrates with API’s to Semansys.Next." }, { "name": "PartnerName", "in": "header", "description": "Contract owner (organization) name that have embedded the API’s." }, { "name": "PartnerID", "in": "header", "description": "Business Identification Number (BIN) of the contract owner (organization) to embeds the API’s." }, { "name": "CustomerName", "in": "header", "description": "Customer (organization) name (ie. accounting firm, intermediary, ....)." }, { "name": "CustomerID", "in": "header", "description": "Business Identification Number (BIN) of the customer." }, { "name": "ClientName", "in": "header", "description": "Client (organization) name of the customer of the accounting firm, intermediary..." }, { "name": "ClientID", "in": "header", "description": "Business Identification Number (BIN) of the client." } ], "responses": { "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomErrorDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomErrorDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomErrorDto" } } } }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/TaxonomyTablesResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TaxonomyTablesResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TaxonomyTablesResult" } } } }, "202": { "description": "Accepted" }, "401": { "description": "Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/taxonomy/entrypoints/{id}/presentation": { "post": { "tags": [ "Taxonomy" ], "summary": "Retrieve taxonomy presentation structure the entrypoint ID.", "description": "Retrieve taxonomy presentation structure based on the entrypoint ID.", "parameters": [ { "name": "id", "in": "path", "description": "The taxonomy entry point id (UUID)", "required": true, "schema": { "type": "string" } }, { "name": "x-api-version", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "ApplicationName", "in": "header", "description": "Name of the application to integrates with API’s to Semansys.Next." }, { "name": "PartnerName", "in": "header", "description": "Contract owner (organization) name that have embedded the API’s." }, { "name": "PartnerID", "in": "header", "description": "Business Identification Number (BIN) of the contract owner (organization) to embeds the API’s." }, { "name": "CustomerName", "in": "header", "description": "Customer (organization) name (ie. accounting firm, intermediary, ....)." }, { "name": "CustomerID", "in": "header", "description": "Business Identification Number (BIN) of the customer." }, { "name": "ClientName", "in": "header", "description": "Client (organization) name of the customer of the accounting firm, intermediary..." }, { "name": "ClientID", "in": "header", "description": "Business Identification Number (BIN) of the client." } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetPresentationStructureRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetPresentationStructureRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/GetPresentationStructureRequest" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomErrorDto" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BaseSetsResponse" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/taxonomy/entrypoints/presentation/base-set-response": { "post": { "tags": [ "Taxonomy" ], "summary": "Retrieve taxonomy base set presentation structure by the base-set ID.", "description": "Retrieve taxonomy base set presentation structure by the base-set ID.", "parameters": [ { "name": "x-api-version", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "ApplicationName", "in": "header", "description": "Name of the application to integrates with API’s to Semansys.Next." }, { "name": "PartnerName", "in": "header", "description": "Contract owner (organization) name that have embedded the API’s." }, { "name": "PartnerID", "in": "header", "description": "Business Identification Number (BIN) of the contract owner (organization) to embeds the API’s." }, { "name": "CustomerName", "in": "header", "description": "Customer (organization) name (ie. accounting firm, intermediary, ....)." }, { "name": "CustomerID", "in": "header", "description": "Business Identification Number (BIN) of the customer." }, { "name": "ClientName", "in": "header", "description": "Client (organization) name of the customer of the accounting firm, intermediary..." }, { "name": "ClientID", "in": "header", "description": "Business Identification Number (BIN) of the client." } ], "requestBody": { "description": "The taxonomy base set id", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetBaseSetPresentationStructure" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetBaseSetPresentationStructure" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/GetBaseSetPresentationStructure" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomErrorDto" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BaseSetsResponse" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/taxonomy/entrypoints/presentation/base-set-concept": { "post": { "tags": [ "Taxonomy" ], "summary": "Retrieve taxonomy concept node presentation structure by the base-set ID.", "description": "Retrieve taxonomy concept node presentation structure by the base-set ID.", "parameters": [ { "name": "x-api-version", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "ApplicationName", "in": "header", "description": "Name of the application to integrates with API’s to Semansys.Next." }, { "name": "PartnerName", "in": "header", "description": "Contract owner (organization) name that have embedded the API’s." }, { "name": "PartnerID", "in": "header", "description": "Business Identification Number (BIN) of the contract owner (organization) to embeds the API’s." }, { "name": "CustomerName", "in": "header", "description": "Customer (organization) name (ie. accounting firm, intermediary, ....)." }, { "name": "CustomerID", "in": "header", "description": "Business Identification Number (BIN) of the customer." }, { "name": "ClientName", "in": "header", "description": "Client (organization) name of the customer of the accounting firm, intermediary..." }, { "name": "ClientID", "in": "header", "description": "Business Identification Number (BIN) of the client." } ], "requestBody": { "description": "The taxonomy concept node id", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetConceptNodePresentationStructure" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetConceptNodePresentationStructure" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/GetConceptNodePresentationStructure" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomErrorDto" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConceptNode" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/taxonomy/entrypoints/{id}/calculation": { "post": { "tags": [ "Taxonomy" ], "summary": "Retrieve taxonomy calculation structure based on the entrypoint.", "description": "Retrieve taxonomy calculation structure based on the entrypoint ID.", "parameters": [ { "name": "id", "in": "path", "description": "The taxonomy entry point id (UUID)", "required": true, "schema": { "type": "string" } }, { "name": "x-api-version", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "ApplicationName", "in": "header", "description": "Name of the application to integrates with API’s to Semansys.Next." }, { "name": "PartnerName", "in": "header", "description": "Contract owner (organization) name that have embedded the API’s." }, { "name": "PartnerID", "in": "header", "description": "Business Identification Number (BIN) of the contract owner (organization) to embeds the API’s." }, { "name": "CustomerName", "in": "header", "description": "Customer (organization) name (ie. accounting firm, intermediary, ....)." }, { "name": "CustomerID", "in": "header", "description": "Business Identification Number (BIN) of the customer." }, { "name": "ClientName", "in": "header", "description": "Client (organization) name of the customer of the accounting firm, intermediary..." }, { "name": "ClientID", "in": "header", "description": "Business Identification Number (BIN) of the client." } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomErrorDto" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BaseSetsResponse" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/taxonomy/entrypoints/{id}/definition": { "post": { "tags": [ "Taxonomy" ], "summary": "Retrieve taxonomy definition structure based on the entrypoint.", "description": "Retrieve taxonomy defintion structure based on the entrypoint ID.", "parameters": [ { "name": "id", "in": "path", "description": "The taxonomy entry point id (UUID)", "required": true, "schema": { "type": "string" } }, { "name": "x-api-version", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "ApplicationName", "in": "header", "description": "Name of the application to integrates with API’s to Semansys.Next." }, { "name": "PartnerName", "in": "header", "description": "Contract owner (organization) name that have embedded the API’s." }, { "name": "PartnerID", "in": "header", "description": "Business Identification Number (BIN) of the contract owner (organization) to embeds the API’s." }, { "name": "CustomerName", "in": "header", "description": "Customer (organization) name (ie. accounting firm, intermediary, ....)." }, { "name": "CustomerID", "in": "header", "description": "Business Identification Number (BIN) of the customer." }, { "name": "ClientName", "in": "header", "description": "Client (organization) name of the customer of the accounting firm, intermediary..." }, { "name": "ClientID", "in": "header", "description": "Business Identification Number (BIN) of the client." } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomErrorDto" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BaseSetsResponse" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/taxonomy/entrypoints/{id}/csv": { "post": { "tags": [ "Taxonomy" ], "summary": "Retrieve taxonomy information by taxonomy ID in CSV.", "description": "Retrieve taxonomy information by taxonomy ID in CSV format.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "x-api-version", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "ApplicationName", "in": "header", "description": "Name of the application to integrates with API’s to Semansys.Next." }, { "name": "PartnerName", "in": "header", "description": "Contract owner (organization) name that have embedded the API’s." }, { "name": "PartnerID", "in": "header", "description": "Business Identification Number (BIN) of the contract owner (organization) to embeds the API’s." }, { "name": "CustomerName", "in": "header", "description": "Customer (organization) name (ie. accounting firm, intermediary, ....)." }, { "name": "CustomerID", "in": "header", "description": "Business Identification Number (BIN) of the customer." }, { "name": "ClientName", "in": "header", "description": "Client (organization) name of the customer of the accounting firm, intermediary..." }, { "name": "ClientID", "in": "header", "description": "Business Identification Number (BIN) of the client." } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetCsvStructureRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetCsvStructureRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/GetCsvStructureRequest" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomErrorDto" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaxonomyCsvSetResponse" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/taxonomy/entrypoints/{id}/csv-zip": { "post": { "tags": [ "Taxonomy" ], "summary": "Retrieve taxonomy content in xBRL-CSV structure.", "description": "Retrieve taxonomy content in xBRL-CSV (.csv + .JSON) as an archive package.", "parameters": [ { "name": "id", "in": "path", "description": "The taxonomy entry point id (UUID).", "required": true, "schema": { "type": "string" } }, { "name": "x-api-version", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "ApplicationName", "in": "header", "description": "Name of the application to integrates with API’s to Semansys.Next." }, { "name": "PartnerName", "in": "header", "description": "Contract owner (organization) name that have embedded the API’s." }, { "name": "PartnerID", "in": "header", "description": "Business Identification Number (BIN) of the contract owner (organization) to embeds the API’s." }, { "name": "CustomerName", "in": "header", "description": "Customer (organization) name (ie. accounting firm, intermediary, ....)." }, { "name": "CustomerID", "in": "header", "description": "Business Identification Number (BIN) of the customer." }, { "name": "ClientName", "in": "header", "description": "Client (organization) name of the customer of the accounting firm, intermediary..." }, { "name": "ClientID", "in": "header", "description": "Business Identification Number (BIN) of the client." } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetCsvStructureRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetCsvStructureRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/GetCsvStructureRequest" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/zip": { "schema": { "$ref": "#/components/schemas/CustomErrorDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomErrorDto" } } } }, "200": { "description": "OK", "content": { "application/zip": { "schema": { "type": "string", "format": "binary" } }, "application/json": { "schema": { "type": "string", "format": "binary" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/taxonomy/entrypoints/{id}/csv-placeholder-zip": { "post": { "tags": [ "Taxonomy" ], "summary": "Retrieve taxonomy content in xBRL-CSV structure for HTML mapping.", "description": "Retrieve taxonomy content in xBRL-CSV (.csv + .JSON) for HTML placeholder mapping as an archive package.", "parameters": [ { "name": "id", "in": "path", "description": "The taxonomy entry point id (UUID).", "required": true, "schema": { "type": "string" } }, { "name": "x-api-version", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "ApplicationName", "in": "header", "description": "Name of the application to integrates with API’s to Semansys.Next." }, { "name": "PartnerName", "in": "header", "description": "Contract owner (organization) name that have embedded the API’s." }, { "name": "PartnerID", "in": "header", "description": "Business Identification Number (BIN) of the contract owner (organization) to embeds the API’s." }, { "name": "CustomerName", "in": "header", "description": "Customer (organization) name (ie. accounting firm, intermediary, ....)." }, { "name": "CustomerID", "in": "header", "description": "Business Identification Number (BIN) of the customer." }, { "name": "ClientName", "in": "header", "description": "Client (organization) name of the customer of the accounting firm, intermediary..." }, { "name": "ClientID", "in": "header", "description": "Business Identification Number (BIN) of the client." } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetCsvStructureRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetCsvStructureRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/GetCsvStructureRequest" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/zip": { "schema": { "$ref": "#/components/schemas/CustomErrorDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomErrorDto" } } } }, "200": { "description": "OK", "content": { "application/zip": { "schema": { "type": "string", "format": "binary" } }, "application/json": { "schema": { "type": "string", "format": "binary" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/taxonomy/{id}/concepts": { "get": { "tags": [ "Taxonomy" ], "summary": "Retrieve taxonomy concepts for entrypoint id.", "description": "Retrieve list of concepts based on the entrypoint ID provided.", "parameters": [ { "name": "id", "in": "path", "description": "The taxonomy entry point id (UUID)", "required": true, "schema": { "type": "string" } }, { "name": "pageNumber", "in": "query", "description": "The page number of results. Optional parameter, if not provided the default value is 1.", "schema": { "type": "string" } }, { "name": "pageSize", "in": "query", "description": "The number of items per page, Optional parameter, if not provided the default value is 10", "schema": { "type": "string" } }, { "name": "conceptNameFilter", "in": "query", "description": "Filters the result concepts by name. Optional, if not provided the concept list will not be filtered by name.", "schema": { "type": "string" } }, { "name": "x-api-version", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "ApplicationName", "in": "header", "description": "Name of the application to integrates with API’s to Semansys.Next." }, { "name": "PartnerName", "in": "header", "description": "Contract owner (organization) name that have embedded the API’s." }, { "name": "PartnerID", "in": "header", "description": "Business Identification Number (BIN) of the contract owner (organization) to embeds the API’s." }, { "name": "CustomerName", "in": "header", "description": "Customer (organization) name (ie. accounting firm, intermediary, ....)." }, { "name": "CustomerID", "in": "header", "description": "Business Identification Number (BIN) of the customer." }, { "name": "ClientName", "in": "header", "description": "Client (organization) name of the customer of the accounting firm, intermediary..." }, { "name": "ClientID", "in": "header", "description": "Business Identification Number (BIN) of the client." } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomErrorDto" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaxonomyConceptList" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/taxonomy/{id}/link-roles": { "get": { "tags": [ "Taxonomy" ], "summary": "Retrieve taxonomy link roles for entrypoint id.", "description": "Retieve list of link roles based on the entrypoint ID provided.", "parameters": [ { "name": "id", "in": "path", "description": "The taxonomy entry point id (UUID)", "required": true, "schema": { "type": "string" } }, { "name": "pageNumber", "in": "query", "description": "The page number of results. Optional parameter, if not provided the default value is 1.", "schema": { "type": "string" } }, { "name": "pageSize", "in": "query", "description": "The number of items per page, Optional parameter, if not provided the default value is 10", "schema": { "type": "string" } }, { "name": "linkRoleNameFilter", "in": "query", "description": "Filters the result link roles by name. Optional, if not provided the link roles list will not be filtered by name.", "schema": { "type": "string" } }, { "name": "x-api-version", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "ApplicationName", "in": "header", "description": "Name of the application to integrates with API’s to Semansys.Next." }, { "name": "PartnerName", "in": "header", "description": "Contract owner (organization) name that have embedded the API’s." }, { "name": "PartnerID", "in": "header", "description": "Business Identification Number (BIN) of the contract owner (organization) to embeds the API’s." }, { "name": "CustomerName", "in": "header", "description": "Customer (organization) name (ie. accounting firm, intermediary, ....)." }, { "name": "CustomerID", "in": "header", "description": "Business Identification Number (BIN) of the customer." }, { "name": "ClientName", "in": "header", "description": "Client (organization) name of the customer of the accounting firm, intermediary..." }, { "name": "ClientID", "in": "header", "description": "Business Identification Number (BIN) of the client." } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomErrorDto" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaxonomyLinkRoleList" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/taxonomy/taxonomy-extension": { "post": { "tags": [ "Taxonomy" ], "summary": "Generate taxonomy extension.", "description": "Generate taxonomy extension based on taxonomy metadata information and taxonomy extension elements (extension linkroles, extension concepts, extension arcs, extension labels and extension references).", "parameters": [ { "name": "x-api-version", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "ApplicationName", "in": "header", "description": "Name of the application to integrates with API’s to Semansys.Next." }, { "name": "PartnerName", "in": "header", "description": "Contract owner (organization) name that have embedded the API’s." }, { "name": "PartnerID", "in": "header", "description": "Business Identification Number (BIN) of the contract owner (organization) to embeds the API’s." }, { "name": "CustomerName", "in": "header", "description": "Customer (organization) name (ie. accounting firm, intermediary, ....)." }, { "name": "CustomerID", "in": "header", "description": "Business Identification Number (BIN) of the customer." }, { "name": "ClientName", "in": "header", "description": "Client (organization) name of the customer of the accounting firm, intermediary..." }, { "name": "ClientID", "in": "header", "description": "Business Identification Number (BIN) of the client." } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExtensionRequest" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomErrorDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomErrorDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomErrorDto" } } } }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "string", "format": "byte" } }, "application/json": { "schema": { "type": "string", "format": "byte" } }, "text/json": { "schema": { "type": "string", "format": "byte" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/taxonomy/report-extension": { "post": { "tags": [ "Taxonomy" ], "summary": "Generate report extension.", "description": "Generate report extension package based on taxonomy metadata and taxonomy extension elements \r\n(extension linkroles, extension concepts, extension arcs, extension labels and extension references), \r\ninstance data (language, entity identifier, entity scheme, unit, period, decimals and data rows) and \r\npackage metadata (name, identifier, description, version, report package language, publisher, publisher uri, \r\npublisher country, report package name, report base64 content, report name, entrypoint, base64 zip files, base64 report package json).\r\nFor each of the functionality where in our API is produced result file we produce hash of the file that identifies the contents of the file. \r\nUser can validate the hash value in hash validation functionality and to know if any changes are applied. \r\nBy default the file hash is disabled, but it can be controlled from the dropdown below. \r\nResponse body will be for example: \r\n\r\n { \r\n \"Content\": \"JVBERxLjQKMSAw...\", \r\n \"ReportingPackageHash\": \"nKDBo115PBhw3U3Y= \" \r\n }", "parameters": [ { "name": "isHashed", "in": "query", "schema": { "type": "boolean", "default": false } }, { "name": "x-api-version", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "ApplicationName", "in": "header", "description": "Name of the application to integrates with API’s to Semansys.Next." }, { "name": "PartnerName", "in": "header", "description": "Contract owner (organization) name that have embedded the API’s." }, { "name": "PartnerID", "in": "header", "description": "Business Identification Number (BIN) of the contract owner (organization) to embeds the API’s." }, { "name": "CustomerName", "in": "header", "description": "Customer (organization) name (ie. accounting firm, intermediary, ....)." }, { "name": "CustomerID", "in": "header", "description": "Business Identification Number (BIN) of the customer." }, { "name": "ClientName", "in": "header", "description": "Client (organization) name of the customer of the accounting firm, intermediary..." }, { "name": "ClientID", "in": "header", "description": "Business Identification Number (BIN) of the client." } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportRequest" }, "example": {"extensionsData":{"taxonomyExtensionMetaData":{"targetNamespaceURI":"http://semansys.com//nlgaap-micro-ext.xsd","namespacePrefix":"extPr","baseTaxonomyEntryPoint":"http://www.nltaxonomie.nl/nt18/kvk/20231213/entrypoints/kvk-rpt-jaarverantwoording-2023-nlgaap-micro.xsd"},"extensionLinkRoles":[{"id":"TestLinkRole","definition":"Definition for presentation role","usedOnPresentation":true,"usedOnCalculation":false,"usedOnDefinition":false}],"extensionConcepts":[{"id":"extPr:Extensionconceptlabel","name":"Extensionconceptlabel","dataType":"xbrli:stringItemType","dataTypeNamespace":"http://www.xbrl.org/2003/instance","periodType":"instant","abstract":false,"prefix":null,"nillable":true,"balance":null,"schemaLocation":"http://www.xbrl.org/2003/xbrl-instance-2003-12-31.xsd"}],"extensionArcs":[{"usedOn":"presentationArc","id":"kvk-lr_BalanceSheetMicroEntities","role":"urn:kvk:linkrole:balance-sheet-micro-entities","arcrole":"http://www.xbrl.org/2003/arcrole/parent-child","from":"http://www.nltaxonomie.nl/nt18/jenv/20231213/dictionary/jenv-bw2-data.xsd#jenv-bw2-i_Equity","to":"extPr_Extensionconceptlabel","isProhibition":false,"priority":0,"order":1,"weight":0}],"labels":[{"label":"ExtensionConceptLabel","language":"en","labelRole":"http://www.xbrl.org/2008/role/label-extended","conceptId":"extPr_Extensionconceptlabel"}],"references":[]},"instanceData":{"schemaRef":"http://semansys.com//nlgaap-micro-ext.xsd","lang":"en","entityIdentifier":"12345678","entityScheme":"https://test-next.semansys.com/","unit":"iso4217:EUR","period":"2023-01-01/2023-12-31","decimals":"0","dataRows":[{"value":"Voor","concept":"jenv-bw2-i:BalanceSheetBeforeAfterAppropriationResults","conceptNamespaceUri":null,"unit":null,"scenarioContent":["jenv-bw2-dim:FinancialStatementsTypeAxis#jenv-bw2-dm:SeparateMember","jenv-bw2-dim:BasisOfPreparationAxis#jenv-bw2-dm:CommercialMember"],"segmentContent":null,"decimals":null,"period":"2023-01-01/2023-12-31","tupleUniqueId":"","tupleConceptIds":{}},{"value":"100","concept":"jenv-bw2-i:Assets","conceptNamespaceUri":null,"unit":"EUR","scenarioContent":["jenv-bw2-dim:FinancialStatementsTypeAxis#jenv-bw2-dm:SeparateMember","jenv-bw2-dim:BasisOfPreparationAxis#jenv-bw2-dm:CommercialMember"],"segmentContent":null,"decimals":"0","period":"2023-12-31","tupleUniqueId":"","tupleConceptIds":{}},{"value":"200","concept":"jenv-bw2-i:Assets","conceptNamespaceUri":null,"unit":"EUR","scenarioContent":["jenv-bw2-dim:FinancialStatementsTypeAxis#jenv-bw2-dm:SeparateMember","jenv-bw2-dim:BasisOfPreparationAxis#jenv-bw2-dm:CommercialMember"],"segmentContent":null,"decimals":"0","period":"2022-12-31","tupleUniqueId":"","tupleConceptIds":{}},{"value":"300","concept":"extPr:Extensionconceptlabel","conceptNamespaceUri":null,"unit":"EUR","scenarioContent":["jenv-bw2-dim:FinancialStatementsTypeAxis#jenv-bw2-dm:SeparateMember","jenv-bw2-dim:BasisOfPreparationAxis#jenv-bw2-dm:CommercialMember"],"segmentContent":null,"decimals":null,"period":"2023-12-31","tupleUniqueId":"","tupleConceptIds":{}}]},"packageData":{"name":"TestPackage","identifier":"123456","description":"Report extension description","version":"20230831","reportPackageLanguage":"en","publicationDate":"2023-08-23","publisher":"Test publisher","publisherUrl":"https://www.semansys.com/xbrl/2023","publisherCountry":"NL","reportPackageName":null,"reportBase64Content":null,"reportName":"TestReportName","entrypoints":[{"name":"","description":"entrypoint description","version":"20230831","entryPointDocument":{"href":"http://semansys.com//nlgaap-micro-ext.xsd"},"languages":["en","nl"]}],"base64ZipFiles":null,"base64ReportPackageJson":null}} } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomErrorDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomErrorDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomErrorDto" } } } }, "200": { "description": "OK", "content": { "text/plain": { "schema": { }, "examples": { "Without Hash": { "value": "SlZCRVJ4TGpRS01TQXcuLi4=" }, "With Hash": { "value": {"content":"SlZCRVJ4TGpRS01TQXcuLi4=","reportingPackageHash":"nKDBo115PBhw3U3Y="} } } }, "application/json": { "schema": { }, "examples": { "Without Hash": { "value": "SlZCRVJ4TGpRS01TQXcuLi4=" }, "With Hash": { "value": {"content":"SlZCRVJ4TGpRS01TQXcuLi4=","reportingPackageHash":"nKDBo115PBhw3U3Y="} } } }, "text/json": { "schema": { }, "examples": { "Without Hash": { "value": "SlZCRVJ4TGpRS01TQXcuLi4=" }, "With Hash": { "value": {"content":"SlZCRVJ4TGpRS01TQXcuLi4=","reportingPackageHash":"nKDBo115PBhw3U3Y="} } } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/validation/status/{id}": { "get": { "tags": [ "Validation" ], "summary": "Retrieve job status or job result.", "description": "Retrieve job status or job result based on the ID.", "parameters": [ { "name": "id", "in": "path", "description": "The validation job id (UUID)", "required": true, "schema": { "type": "string" } }, { "name": "x-api-version", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "ApplicationName", "in": "header", "description": "Name of the application to integrates with API’s to Semansys.Next." }, { "name": "PartnerName", "in": "header", "description": "Contract owner (organization) name that have embedded the API’s." }, { "name": "PartnerID", "in": "header", "description": "Business Identification Number (BIN) of the contract owner (organization) to embeds the API’s." }, { "name": "CustomerName", "in": "header", "description": "Customer (organization) name (ie. accounting firm, intermediary, ....)." }, { "name": "CustomerID", "in": "header", "description": "Business Identification Number (BIN) of the customer." }, { "name": "ClientName", "in": "header", "description": "Client (organization) name of the customer of the accounting firm, intermediary..." }, { "name": "ClientID", "in": "header", "description": "Business Identification Number (BIN) of the client." } ], "responses": { "202": { "description": "Accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomErrorDto" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationResult" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/validation/filtered-status/{id}": { "get": { "tags": [ "Validation" ], "summary": "Retrieves job status or job result with filtered validation messages.", "description": "Retrieve job status or job result that includes filtered validation messages.", "parameters": [ { "name": "id", "in": "path", "description": "The validation job id (UUID)", "required": true, "schema": { "type": "string" } }, { "name": "x-api-version", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "ApplicationName", "in": "header", "description": "Name of the application to integrates with API’s to Semansys.Next." }, { "name": "PartnerName", "in": "header", "description": "Contract owner (organization) name that have embedded the API’s." }, { "name": "PartnerID", "in": "header", "description": "Business Identification Number (BIN) of the contract owner (organization) to embeds the API’s." }, { "name": "CustomerName", "in": "header", "description": "Customer (organization) name (ie. accounting firm, intermediary, ....)." }, { "name": "CustomerID", "in": "header", "description": "Business Identification Number (BIN) of the customer." }, { "name": "ClientName", "in": "header", "description": "Client (organization) name of the customer of the accounting firm, intermediary..." }, { "name": "ClientID", "in": "header", "description": "Business Identification Number (BIN) of the client." } ], "responses": { "202": { "description": "Accepted" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomErrorDto" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationResult" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/validation/instance/xbrl-core": { "post": { "tags": [ "Validation" ], "summary": "Validate XBRL report to XBRL 2.1 (Core) specification.", "description": "Validate the XBRL report against XBRL 2.1 specification (Core).", "parameters": [ { "name": "x-api-version", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "ApplicationName", "in": "header", "description": "Name of the application to integrates with API’s to Semansys.Next." }, { "name": "PartnerName", "in": "header", "description": "Contract owner (organization) name that have embedded the API’s." }, { "name": "PartnerID", "in": "header", "description": "Business Identification Number (BIN) of the contract owner (organization) to embeds the API’s." }, { "name": "CustomerName", "in": "header", "description": "Customer (organization) name (ie. accounting firm, intermediary, ....)." }, { "name": "CustomerID", "in": "header", "description": "Business Identification Number (BIN) of the customer." }, { "name": "ClientName", "in": "header", "description": "Client (organization) name of the customer of the accounting firm, intermediary..." }, { "name": "ClientID", "in": "header", "description": "Business Identification Number (BIN) of the client." } ], "requestBody": { "description": "A JSON object containing instance file id (UUID) or content as base64 string", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationRequest" } } }, "required": true }, "responses": { "202": { "description": "Accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomErrorDto" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/validation/instance/xbrl-dimensions": { "post": { "tags": [ "Validation" ], "summary": "Validate XBRL report dimensionally.", "description": "Validate the XBRL report against XBRL Dimensional specification.", "parameters": [ { "name": "x-api-version", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "ApplicationName", "in": "header", "description": "Name of the application to integrates with API’s to Semansys.Next." }, { "name": "PartnerName", "in": "header", "description": "Contract owner (organization) name that have embedded the API’s." }, { "name": "PartnerID", "in": "header", "description": "Business Identification Number (BIN) of the contract owner (organization) to embeds the API’s." }, { "name": "CustomerName", "in": "header", "description": "Customer (organization) name (ie. accounting firm, intermediary, ....)." }, { "name": "CustomerID", "in": "header", "description": "Business Identification Number (BIN) of the customer." }, { "name": "ClientName", "in": "header", "description": "Client (organization) name of the customer of the accounting firm, intermediary..." }, { "name": "ClientID", "in": "header", "description": "Business Identification Number (BIN) of the client." } ], "requestBody": { "description": "A JSON object containing instance file id (UUID) or content as base64 string", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationRequest" } } }, "required": true }, "responses": { "202": { "description": "Accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomErrorDto" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/validation/instance/inline-xbrl": { "post": { "tags": [ "Validation" ], "summary": "Validate Inline XBRL report to inline specification.", "description": "Validate the Inline XBRL report against the XBRL Inline specification.", "parameters": [ { "name": "x-api-version", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "ApplicationName", "in": "header", "description": "Name of the application to integrates with API’s to Semansys.Next." }, { "name": "PartnerName", "in": "header", "description": "Contract owner (organization) name that have embedded the API’s." }, { "name": "PartnerID", "in": "header", "description": "Business Identification Number (BIN) of the contract owner (organization) to embeds the API’s." }, { "name": "CustomerName", "in": "header", "description": "Customer (organization) name (ie. accounting firm, intermediary, ....)." }, { "name": "CustomerID", "in": "header", "description": "Business Identification Number (BIN) of the customer." }, { "name": "ClientName", "in": "header", "description": "Client (organization) name of the customer of the accounting firm, intermediary..." }, { "name": "ClientID", "in": "header", "description": "Business Identification Number (BIN) of the client." } ], "requestBody": { "description": "A JSON object containing instance file id (UUID) or content as base64 string", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationRequest" } } }, "required": true }, "responses": { "202": { "description": "Accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomErrorDto" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/validation/instance/xbrl-calculation": { "post": { "tags": [ "Validation" ], "summary": "Validate XBRL report to calculation linkbase.", "description": "Validate the XBRL report against taxonomy defined Calculation linkbase.", "parameters": [ { "name": "x-api-version", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "ApplicationName", "in": "header", "description": "Name of the application to integrates with API’s to Semansys.Next." }, { "name": "PartnerName", "in": "header", "description": "Contract owner (organization) name that have embedded the API’s." }, { "name": "PartnerID", "in": "header", "description": "Business Identification Number (BIN) of the contract owner (organization) to embeds the API’s." }, { "name": "CustomerName", "in": "header", "description": "Customer (organization) name (ie. accounting firm, intermediary, ....)." }, { "name": "CustomerID", "in": "header", "description": "Business Identification Number (BIN) of the customer." }, { "name": "ClientName", "in": "header", "description": "Client (organization) name of the customer of the accounting firm, intermediary..." }, { "name": "ClientID", "in": "header", "description": "Business Identification Number (BIN) of the client." } ], "requestBody": { "description": "A JSON object containing instance file id (UUID) or content as base64 string", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationRequest" } } }, "required": true }, "responses": { "202": { "description": "Accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomErrorDto" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/validation/report-package/esma-esef": { "post": { "tags": [ "Validation" ], "summary": "Validate reporting package to ESMA conformance suite.", "description": "Validate the Report Package (XBRL inline report and extension taxonomy) against the ESMA/ESEF conformance suite.", "parameters": [ { "name": "x-api-version", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "ApplicationName", "in": "header", "description": "Name of the application to integrates with API’s to Semansys.Next." }, { "name": "PartnerName", "in": "header", "description": "Contract owner (organization) name that have embedded the API’s." }, { "name": "PartnerID", "in": "header", "description": "Business Identification Number (BIN) of the contract owner (organization) to embeds the API’s." }, { "name": "CustomerName", "in": "header", "description": "Customer (organization) name (ie. accounting firm, intermediary, ....)." }, { "name": "CustomerID", "in": "header", "description": "Business Identification Number (BIN) of the customer." }, { "name": "ClientName", "in": "header", "description": "Client (organization) name of the customer of the accounting firm, intermediary..." }, { "name": "ClientID", "in": "header", "description": "Business Identification Number (BIN) of the client." } ], "requestBody": { "description": "A JSON object containing instance file id (UUID) or content as base64 string", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationRequest" } } }, "required": true }, "responses": { "202": { "description": "Accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomErrorDto" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/validation/instance/formula-assertions": { "post": { "tags": [ "Validation" ], "summary": "Validate XBRL report to assertions.", "description": "Validate the XBRL report against taxonomy defined Formula Assertions (business rules).", "parameters": [ { "name": "x-api-version", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "ApplicationName", "in": "header", "description": "Name of the application to integrates with API’s to Semansys.Next." }, { "name": "PartnerName", "in": "header", "description": "Contract owner (organization) name that have embedded the API’s." }, { "name": "PartnerID", "in": "header", "description": "Business Identification Number (BIN) of the contract owner (organization) to embeds the API’s." }, { "name": "CustomerName", "in": "header", "description": "Customer (organization) name (ie. accounting firm, intermediary, ....)." }, { "name": "CustomerID", "in": "header", "description": "Business Identification Number (BIN) of the customer." }, { "name": "ClientName", "in": "header", "description": "Client (organization) name of the customer of the accounting firm, intermediary..." }, { "name": "ClientID", "in": "header", "description": "Business Identification Number (BIN) of the client." } ], "requestBody": { "description": "A JSON object containing instance file id (UUID) or content as base64 string", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationRequest" } } }, "required": true }, "responses": { "202": { "description": "Accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomErrorDto" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/validation/instance/uniform": { "post": { "tags": [ "Validation" ], "summary": "Validate XBRL report to uniformation rules.", "description": "Validate the XBRL report against uniformation rules.", "parameters": [ { "name": "x-api-version", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "ApplicationName", "in": "header", "description": "Name of the application to integrates with API’s to Semansys.Next." }, { "name": "PartnerName", "in": "header", "description": "Contract owner (organization) name that have embedded the API’s." }, { "name": "PartnerID", "in": "header", "description": "Business Identification Number (BIN) of the contract owner (organization) to embeds the API’s." }, { "name": "CustomerName", "in": "header", "description": "Customer (organization) name (ie. accounting firm, intermediary, ....)." }, { "name": "CustomerID", "in": "header", "description": "Business Identification Number (BIN) of the customer." }, { "name": "ClientName", "in": "header", "description": "Client (organization) name of the customer of the accounting firm, intermediary..." }, { "name": "ClientID", "in": "header", "description": "Business Identification Number (BIN) of the client." } ], "requestBody": { "description": "A JSON object containing instance file id (UUID) or content as base64 string", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationRequest" } } }, "required": true }, "responses": { "202": { "description": "Accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomErrorDto" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/validation/instance/duplicates": { "post": { "tags": [ "Validation" ], "summary": "Validate XBRL report on duplicates.", "description": "Validate the XBRL report on available duplicates (contexts, unit and facts).", "parameters": [ { "name": "x-api-version", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "ApplicationName", "in": "header", "description": "Name of the application to integrates with API’s to Semansys.Next." }, { "name": "PartnerName", "in": "header", "description": "Contract owner (organization) name that have embedded the API’s." }, { "name": "PartnerID", "in": "header", "description": "Business Identification Number (BIN) of the contract owner (organization) to embeds the API’s." }, { "name": "CustomerName", "in": "header", "description": "Customer (organization) name (ie. accounting firm, intermediary, ....)." }, { "name": "CustomerID", "in": "header", "description": "Business Identification Number (BIN) of the customer." }, { "name": "ClientName", "in": "header", "description": "Client (organization) name of the customer of the accounting firm, intermediary..." }, { "name": "ClientID", "in": "header", "description": "Business Identification Number (BIN) of the client." } ], "requestBody": { "description": "A JSON object containing instance file id (UUID) or content as base64 string", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationRequest" } } }, "required": true }, "responses": { "202": { "description": "Accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomErrorDto" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/validation/instance/utr": { "post": { "tags": [ "Validation" ], "summary": "Validate the XBRL report custom units used against the UTR list.", "parameters": [ { "name": "x-api-version", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "ApplicationName", "in": "header", "description": "Name of the application to integrates with API’s to Semansys.Next." }, { "name": "PartnerName", "in": "header", "description": "Contract owner (organization) name that have embedded the API’s." }, { "name": "PartnerID", "in": "header", "description": "Business Identification Number (BIN) of the contract owner (organization) to embeds the API’s." }, { "name": "CustomerName", "in": "header", "description": "Customer (organization) name (ie. accounting firm, intermediary, ....)." }, { "name": "CustomerID", "in": "header", "description": "Business Identification Number (BIN) of the customer." }, { "name": "ClientName", "in": "header", "description": "Client (organization) name of the customer of the accounting firm, intermediary..." }, { "name": "ClientID", "in": "header", "description": "Business Identification Number (BIN) of the client." } ], "requestBody": { "description": "A JSON object containing instance file id (UUID) or content as base64 string", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationRequest" } } }, "required": true }, "responses": { "202": { "description": "Accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomErrorDto" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/validation/instance/full": { "post": { "tags": [ "Validation" ], "summary": "Validate XBRL report to multiple types of validations.", "description": "Validate the XBRL report to various validation types (various XBRL specifications and conformance suites).", "parameters": [ { "name": "x-api-version", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "ApplicationName", "in": "header", "description": "Name of the application to integrates with API’s to Semansys.Next." }, { "name": "PartnerName", "in": "header", "description": "Contract owner (organization) name that have embedded the API’s." }, { "name": "PartnerID", "in": "header", "description": "Business Identification Number (BIN) of the contract owner (organization) to embeds the API’s." }, { "name": "CustomerName", "in": "header", "description": "Customer (organization) name (ie. accounting firm, intermediary, ....)." }, { "name": "CustomerID", "in": "header", "description": "Business Identification Number (BIN) of the customer." }, { "name": "ClientName", "in": "header", "description": "Client (organization) name of the customer of the accounting firm, intermediary..." }, { "name": "ClientID", "in": "header", "description": "Business Identification Number (BIN) of the client." } ], "requestBody": { "description": "A JSON object containing instance file id (UUID) or content as base64 string", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FullValidationRequest" }, "example": {"idOrBase64Content":"PD94bWwgdmVyc2lvbj...","fileName":"string","validationTypes":["xbrlCore","xbrlDimensions","inlineXbrl","xbrlCalculation","formulaAssertions","uniform","duplicates"]} } }, "required": true }, "responses": { "202": { "description": "Accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomErrorDto" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/validation/instance/filing-rules": { "post": { "tags": [ "Validation" ], "summary": "Validate XBRL report to filing rules (SBR-NL).", "description": "Validate the XBRL report to filing rules (SBR-NL).", "parameters": [ { "name": "x-api-version", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "ApplicationName", "in": "header", "description": "Name of the application to integrates with API’s to Semansys.Next." }, { "name": "PartnerName", "in": "header", "description": "Contract owner (organization) name that have embedded the API’s." }, { "name": "PartnerID", "in": "header", "description": "Business Identification Number (BIN) of the contract owner (organization) to embeds the API’s." }, { "name": "CustomerName", "in": "header", "description": "Customer (organization) name (ie. accounting firm, intermediary, ....)." }, { "name": "CustomerID", "in": "header", "description": "Business Identification Number (BIN) of the customer." }, { "name": "ClientName", "in": "header", "description": "Client (organization) name of the customer of the accounting firm, intermediary..." }, { "name": "ClientID", "in": "header", "description": "Business Identification Number (BIN) of the client." } ], "requestBody": { "description": "A JSON object containing instance file id (UUID) or content as base64 string", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationRequest" } } }, "required": true }, "responses": { "202": { "description": "Accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomErrorDto" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/validation/hash-codes": { "post": { "tags": [ "Validation" ], "summary": "Validate hash codes for a single file or a reporting package.", "description": "Validate the hash codes for a single file or per reporting package provided including reporting pakcage JSON hash file.", "parameters": [ { "name": "x-api-version", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "ApplicationName", "in": "header", "description": "Name of the application to integrates with API’s to Semansys.Next." }, { "name": "PartnerName", "in": "header", "description": "Contract owner (organization) name that have embedded the API’s." }, { "name": "PartnerID", "in": "header", "description": "Business Identification Number (BIN) of the contract owner (organization) to embeds the API’s." }, { "name": "CustomerName", "in": "header", "description": "Customer (organization) name (ie. accounting firm, intermediary, ....)." }, { "name": "CustomerID", "in": "header", "description": "Business Identification Number (BIN) of the customer." }, { "name": "ClientName", "in": "header", "description": "Client (organization) name of the customer of the accounting firm, intermediary..." }, { "name": "ClientID", "in": "header", "description": "Business Identification Number (BIN) of the client." } ], "requestBody": { "description": "Data source JSON object", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HashValidationRequest" } } }, "required": true }, "responses": { "401": { "description": "Unauthorized" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomErrorDto" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HashValidationResponse" } } } } }, "security": [ { "Bearer": [ ] } ] } }, "/validation/instance/non-present-facts": { "post": { "tags": [ "Validation" ], "summary": "Validate the XBRL report on non present facts", "parameters": [ { "name": "x-api-version", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "ApplicationName", "in": "header", "description": "Name of the application to integrates with API’s to Semansys.Next." }, { "name": "PartnerName", "in": "header", "description": "Contract owner (organization) name that have embedded the API’s." }, { "name": "PartnerID", "in": "header", "description": "Business Identification Number (BIN) of the contract owner (organization) to embeds the API’s." }, { "name": "CustomerName", "in": "header", "description": "Customer (organization) name (ie. accounting firm, intermediary, ....)." }, { "name": "CustomerID", "in": "header", "description": "Business Identification Number (BIN) of the customer." }, { "name": "ClientName", "in": "header", "description": "Client (organization) name of the customer of the accounting firm, intermediary..." }, { "name": "ClientID", "in": "header", "description": "Business Identification Number (BIN) of the client." } ], "requestBody": { "description": "A JSON object containing instance file id (UUID) or content as base64 string", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationRequest" } } }, "required": true }, "responses": { "202": { "description": "Accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomErrorDto" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } } }, "components": { "schemas": { "AanleverResponse": { "type": "object", "properties": { "kenmerk": { "type": "string", "nullable": true, "example": "dacc9159-d..." }, "berichtsoort": { "type": "string", "nullable": true, "example": "Jaarrekening" }, "aanleverkenmerk": { "type": "string", "nullable": true, "example": "84-c85..." }, "eerderAanleverkenmerk": { "nullable": true, "example": null }, "tijdstempelAangeleverd": { "type": "string", "nullable": true, "example": "2021-09-02T0" }, "identiteitBelanghebbende": { "$ref": "#/components/schemas/IdentiteitBelanghebbende" }, "rolBelanghebbende": { "type": "string", "nullable": true, "example": "Intermediair" }, "identiteitOntvanger": { "$ref": "#/components/schemas/IdentiteitOntvanger" }, "rolOntvanger": { "nullable": true, "example": null }, "autorisatieAdres": { "type": "string", "nullable": true, "example": "http://gee..." }, "statuscode": { "nullable": true, "example": null }, "tijdstempelStatusSpecified": { "type": "boolean", "example": true }, "statusomschrijving": { "nullable": true, "example": null }, "statusFoutcode": { "nullable": true, "example": null }, "statusdetails": { "nullable": true, "example": null }, "identiteitAanleveraar": { "$ref": "#/components/schemas/IdentiteitAanleveraar" }, "softwarePakket": { "type": "string", "nullable": true, "example": null } }, "additionalProperties": false }, "AllowedRenderModesResponse": { "type": "object", "properties": { "modes": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "AskYourPdfChatRequest": { "type": "object", "properties": { "documentId": { "type": "string", "description": "The ID of the document, uploaded in our system.", "nullable": true, "example": "155c0585-8309-40b4-8de3-fd0951021d80" }, "message": { "type": "string", "description": "The question that you want to ask your PDF.", "nullable": true, "example": "Provide me with summary of Report.pdf" } }, "additionalProperties": false }, "AskYourPdfChatResponse": { "type": "object", "properties": { "answer": { "type": "string", "description": "The answer of your question asked.", "nullable": true, "example": "The document is a financial report for last year. The report includes information about the company..." } }, "additionalProperties": false }, "AskYourPdfUploadRequest": { "type": "object", "properties": { "documentContent": { "type": "string", "description": "The PDF or XBRL file represented as Base64", "format": "byte", "nullable": true, "example": "PD94bWwgdmVyc..." }, "documentName": { "type": "string", "description": "The name of your PDF document", "nullable": true, "example": "Annual report.pdf" } }, "additionalProperties": false }, "AskYourPdfUploadResponse": { "type": "object", "properties": { "docId": { "type": "string", "description": "The ID of the document, uploaded in our system.", "nullable": true, "example": "155c0585-8309-40b4-8de3-fd0951021d80" } }, "additionalProperties": false }, "Attachment": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "content": { "type": "string", "format": "byte", "nullable": true }, "mimeType": { "type": "string", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "AuthUserDto": { "type": "object", "properties": { "email": { "pattern": "^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\\.[a-zA-Z0-9-.]+$", "type": "string", "description": "The user's email which role is going to be changed.", "nullable": true }, "role": { "$ref": "#/components/schemas/UserRole" } }, "additionalProperties": false }, "BaseSet": { "type": "object", "properties": { "roleType": { "type": "string", "nullable": true }, "arcRoleType": { "type": "string", "nullable": true }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/ConceptLabel" }, "nullable": true }, "nodes": { "type": "array", "items": { "$ref": "#/components/schemas/ConceptNode" }, "nullable": true }, "nodeReferences": { "type": "array", "items": { "$ref": "#/components/schemas/ReferenceValue" }, "nullable": true }, "hasChildren": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "BaseSetReferenceValue": { "type": "object", "properties": { "referenceId": { "type": "string", "nullable": true }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/ConceptLabel" }, "nullable": true }, "hasChildren": { "type": "boolean" }, "arcRoleType": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BaseSetsResponse": { "type": "object", "properties": { "taxonomyEntrypoint": { "type": "string", "nullable": true }, "baseSets": { "type": "array", "items": { "$ref": "#/components/schemas/BaseSet" }, "nullable": true }, "baseSetsReferences": { "type": "array", "items": { "$ref": "#/components/schemas/BaseSetReferenceValue" }, "nullable": true } }, "additionalProperties": false }, "BigFileUploadDto": { "type": "object", "properties": { "userId": { "type": "string", "nullable": true, "example": "user@gmail.com" }, "fileName": { "type": "string", "nullable": true, "example": "My file.xbrl" }, "file": { "$ref": "#/components/schemas/FileChunk" } }, "additionalProperties": false }, "CertificateUploadDto": { "type": "object", "properties": { "content": { "type": "string", "nullable": true, "example": "B63E7C115FA..." }, "password": { "type": "string", "nullable": true, "example": "My password" }, "name": { "type": "string", "nullable": true, "example": "My first certificate" }, "userEmail": { "type": "string", "nullable": true, "example": "user@gmail.com" }, "type": { "type": "string", "nullable": true, "example": "Digipoort" } }, "additionalProperties": false }, "ClsFile": { "type": "object", "properties": { "fileName": { "type": "string", "description": "The name of the file.", "nullable": true, "example": "My report.xbrl" }, "fileHash": { "type": "string", "description": "The name of the file.", "nullable": true, "example": "11xrvYBwFw5htgf=" }, "isFileHashValid": { "type": "string", "description": "Result of the hash validaiton, represented as string.\r\nPossible values are 3: Invalid, Valid, NotCalculated", "nullable": true, "example": "Invalid" }, "fileSize": { "type": "string", "description": "The size of the file in KB.", "nullable": true, "example": "3.212890625" }, "isFolder": { "type": "boolean", "description": "Indicates if a file is folder or not.", "example": true } }, "additionalProperties": false }, "ClsHashResult": { "type": "object", "properties": { "reportingPackageHash": { "type": "string", "description": "The overall hash code of the file/report package.", "nullable": true, "example": "nKDBo115PBhw3U3Y=" }, "isReportingPackageHashValid": { "type": "string", "description": "Result of the hash validaiton, represented as string.\r\nPossible values are 3: Invalid, Valid, NotCalculated", "nullable": true, "example": "Invalid" }, "fileList": { "type": "array", "items": { "$ref": "#/components/schemas/ClsFile" }, "nullable": true }, "folderStructure": { "$ref": "#/components/schemas/FolderNode" } }, "additionalProperties": false }, "ComparisonDetails": { "type": "object", "properties": { "arcRole": { "type": "string", "nullable": true }, "contextId": { "type": "string", "nullable": true }, "contextRef": { "type": "string", "nullable": true }, "continuationFrom": { "type": "string", "nullable": true }, "decimals": { "type": "string", "nullable": true }, "dimensionDetailsList": { "type": "array", "items": { "$ref": "#/components/schemas/DimensionDetails" }, "nullable": true }, "endDate": { "type": "string", "nullable": true }, "escape": { "type": "string", "nullable": true }, "extendedXLinkType": { "type": "string", "nullable": true }, "factName": { "type": "string", "nullable": true }, "factValue": { "type": "string", "nullable": true }, "footnoteId": { "type": "string", "nullable": true }, "footnoteRefs": { "type": "string", "nullable": true }, "footnoteValue": { "type": "array", "items": { "type": "string" }, "nullable": true }, "footnoteRole": { "type": "string", "nullable": true }, "format": { "type": "string", "nullable": true }, "fromRefs": { "type": "string", "nullable": true }, "id": { "type": "string", "nullable": true }, "identifierContent": { "type": "string", "nullable": true }, "identifierScheme": { "type": "string", "nullable": true }, "instantDate": { "type": "string", "nullable": true }, "linkRole": { "type": "string", "nullable": true }, "measurement": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "order": { "type": "string", "nullable": true }, "periodType": { "type": "string", "nullable": true }, "precision": { "type": "string", "nullable": true }, "scale": { "type": "string", "nullable": true }, "sign": { "type": "string", "nullable": true }, "startDate": { "type": "string", "nullable": true }, "target": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "toRefs": { "type": "string", "nullable": true }, "tupleID": { "type": "string", "nullable": true }, "tupleRef": { "type": "string", "nullable": true }, "unitId": { "type": "string", "nullable": true }, "unitRef": { "type": "string", "nullable": true }, "source": { "type": "string", "nullable": true }, "elementType": { "$ref": "#/components/schemas/ElementType" }, "taxonomyUri": { "type": "string", "nullable": true }, "namespaceUri": { "type": "string", "nullable": true }, "namespacePrefix": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ComparisonDetailsComparisonDetailsPair": { "type": "object", "properties": { "first": { "$ref": "#/components/schemas/ComparisonDetails" }, "second": { "$ref": "#/components/schemas/ComparisonDetails" } }, "additionalProperties": false }, "ComparisonMessage": { "type": "object", "properties": { "category": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true }, "messageText": { "type": "string", "nullable": true }, "pair": { "$ref": "#/components/schemas/ComparisonDetailsComparisonDetailsPair" } }, "additionalProperties": false }, "ComparisonRequest": { "type": "object", "properties": { "filesToBeCompared": { "type": "object", "additionalProperties": { "type": "string", "format": "byte", "nullable": true }, "description": "The main and child files that are going to be compared.", "nullable": true, "example": { "master": "base64 content", "child": "base64 content" } } }, "additionalProperties": false }, "ComparisonResult": { "type": "object", "properties": { "validationType": { "type": "string", "description": "The type of validation performed onto the XBRL instances.", "nullable": true, "example": "Compare" }, "compareResult": { "type": "string", "description": "The result from the comparison indicating whether differences were found or not.", "nullable": true, "example": "Differences found." }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ComparisonMessage" }, "description": "Detailed summary of all differences found.", "nullable": true }, "htmlContent": { "type": "string", "description": "Comparison report in HTML format.", "format": "byte", "nullable": true, "example": "base64 content" } }, "additionalProperties": false }, "ConceptElement": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "concept": { "type": "string", "nullable": true }, "period": { "type": "string", "nullable": true }, "periodType": { "type": "string", "nullable": true }, "unit": { "type": "string", "nullable": true }, "value": { "type": "string", "nullable": true }, "confidence": { "type": "integer", "format": "int32" }, "typeQName": { "type": "string", "nullable": true }, "typedMembers": { "type": "array", "items": { "$ref": "#/components/schemas/DimensionMember" }, "nullable": true }, "explicitMembers": { "type": "array", "items": { "$ref": "#/components/schemas/ExplicitDimensionMember" }, "nullable": true }, "scenarioContent": { "type": "array", "items": { "type": "string" }, "nullable": true }, "enumerations": { "type": "array", "items": { "$ref": "#/components/schemas/ConceptEnumeration" }, "nullable": true } }, "additionalProperties": false }, "ConceptEnumeration": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/WeTableModelLabel" }, "nullable": true } }, "additionalProperties": false }, "ConceptLabel": { "type": "object", "properties": { "label": { "type": "string", "nullable": true }, "language": { "type": "string", "nullable": true }, "labelRole": { "type": "string", "nullable": true }, "conceptId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ConceptNode": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "uniqueId": { "type": "string", "nullable": true }, "namespace": { "type": "string", "nullable": true }, "prefix": { "type": "string", "nullable": true }, "dataType": { "type": "string", "nullable": true }, "typeQName": { "type": "string", "nullable": true }, "periodType": { "type": "string", "nullable": true }, "isAbstract": { "type": "boolean" }, "isEnumeration": { "type": "boolean" }, "isTuple": { "type": "boolean" }, "enumerations": { "type": "array", "items": { "$ref": "#/components/schemas/ConceptEnumeration" }, "nullable": true }, "parentNodeUniqueId": { "type": "string", "nullable": true }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/ConceptLabel" }, "nullable": true }, "children": { "type": "array", "items": { "$ref": "#/components/schemas/ConceptNode" }, "nullable": true }, "childrenReferences": { "type": "array", "items": { "$ref": "#/components/schemas/ReferenceValue" }, "nullable": true }, "dimensionMembers": { "type": "array", "items": { "$ref": "#/components/schemas/DimensionMember" }, "nullable": true }, "hasChildren": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "ConceptNodeCsv": { "type": "object", "properties": { "uniqueId": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "label": { "type": "string", "nullable": true }, "namespace": { "type": "string", "nullable": true }, "prefix": { "type": "string", "nullable": true }, "dataType": { "type": "string", "nullable": true }, "periodType": { "type": "string", "nullable": true }, "period": { "type": "string", "nullable": true }, "dimensionMembers": { "type": "array", "items": { "$ref": "#/components/schemas/DimensionMember" }, "nullable": true } }, "additionalProperties": false }, "ContentResult": { "type": "object", "properties": { "content": { "type": "string", "nullable": true }, "contentType": { "type": "string", "nullable": true }, "statusCode": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "CustomErrorDto": { "type": "object", "properties": { "code": { "type": "string", "nullable": true, "example": "BadRequest" }, "message": { "type": "string", "nullable": true, "example": "A brief human-readable message" }, "description": { "type": "string", "nullable": true, "example": "More detailed human-readable error description" } }, "additionalProperties": false }, "CustomInlineToXbrlRequest": { "type": "object", "properties": { "reportContentBase64": { "type": "string", "description": "The inline XBRL (.xhtml) report represented as base64\r\nPD94bWwgdmVyc2lvbj...", "nullable": true }, "fileName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CustomInlineToXbrlResponse": { "type": "object", "properties": { "entrypoint": { "type": "string", "nullable": true }, "xbrlReportContent": { "type": "string", "nullable": true }, "facts": { "type": "string", "nullable": true }, "contexts": { "type": "string", "nullable": true }, "units": { "type": "string", "nullable": true }, "hashResults": { "type": "object", "additionalProperties": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "CustomReportPackageData": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "identifier": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "version": { "type": "string", "nullable": true }, "reportPackageLanguage": { "type": "string", "nullable": true }, "publicationDate": { "type": "string", "nullable": true }, "publisher": { "type": "string", "nullable": true }, "publisherUrl": { "type": "string", "nullable": true }, "publisherCountry": { "type": "string", "nullable": true }, "reportPackageName": { "type": "string", "nullable": true }, "reportBase64Content": { "type": "string", "nullable": true }, "reportName": { "type": "string", "nullable": true }, "entrypoints": { "type": "array", "items": { "$ref": "#/components/schemas/XmlEntryPointModel" }, "nullable": true }, "base64ZipFiles": { "type": "string", "nullable": true }, "base64ReportPackageJson": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CustomResponse": { "type": "object", "properties": { "location": { "type": "string", "description": "Job status location", "nullable": true, "example": "/status/292134BE13008671" }, "filteredLocation": { "type": "string", "description": "Job status for filtered messages location", "nullable": true, "example": "/status/292134BE13008671" }, "jobId": { "type": "string", "description": "Job identifier", "nullable": true, "example": "292134BE13008671" } }, "additionalProperties": false }, "CustomTablesResponse": { "type": "object", "properties": { "location": { "type": "string", "nullable": true }, "jobId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CustomTaxonomyResponse": { "type": "object", "properties": { "entrypoints": { "type": "array", "items": { "$ref": "#/components/schemas/TaxonomyEntrypointDto" }, "nullable": true } }, "additionalProperties": false }, "DataRow": { "type": "object", "properties": { "value": { "type": "string", "description": "Reported fact value", "nullable": true, "example": "600000" }, "concept": { "type": "string", "description": "XBRL concept qualified name", "nullable": true, "example": "jenv-bw2-i:IntangibleAssets" }, "conceptNamespaceUri": { "type": "string", "description": "XBRL concept namespace uri string", "nullable": true, "example": "\"https://www.xbrl.org/2008/reference\"" }, "unit": { "type": "string", "nullable": true, "example": "iso4217:EUR" }, "scenarioContent": { "type": "array", "items": { "type": "string" }, "description": "Dimensional members in format 'Dimension#member' qualified names for explicit dimension and 'Dimension/value' format for typed members", "nullable": true, "example": [ "jenv-bw2-dim:BasisOfPreparationAxis#jenv-bw2-dm:CommercialMember", "jenv-bw2-dim:FinancialStatementsTypeAxis#jenv-bw2-dm:SeparateMember" ] }, "segmentContent": { "type": "array", "items": { "type": "string" }, "description": "Dimensional members in format 'Dimension#member' qualified names for explicit dimension and 'Dimension/value' format for typed members", "nullable": true }, "decimals": { "type": "string", "description": "Decimals of reported fact value.", "nullable": true, "example": "INF" }, "period": { "type": "string", "description": "Reported period start date/end date in yyyy-MM-dd format. If omitted, default period is used.", "nullable": true, "example": "2020-01-01/2020-12-31" }, "tupleUniqueId": { "type": "string", "nullable": true }, "tupleConceptIds": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true } }, "additionalProperties": false }, "DeliveryDigipoortRequest": { "type": "object", "properties": { "certificateId": { "type": "string", "description": "When not provided the default system certificate will be used.", "nullable": true, "example": "https://api-certp..." }, "fileName": { "type": "string", "description": "The name of XBRL instance document.", "nullable": true, "example": "Test file.xbrl" }, "content": { "type": "string", "description": "The content of the instance document, as Base64 formatted string.", "format": "byte", "nullable": true, "example": "PD94bWwgdmVyc..." }, "identifier": { "type": "string", "description": "The business number of the reported entity.", "nullable": true, "example": "5858.." }, "messageType": { "type": "string", "description": "The relevant message type for the deposit.", "nullable": true, "example": "Jaarrekening" }, "nameOfStakeholder": { "type": "string", "description": "The regulator to which the instance should be deposited.", "nullable": true, "example": "KvK" }, "typeOfSender": { "type": "string", "description": "The type of sender (Accountant, Intermediar).", "nullable": true, "example": "Intermediar" }, "idOfStakeholder": { "type": "string", "nullable": true, "readOnly": true }, "attachments": { "type": "array", "items": { "$ref": "#/components/schemas/Attachment" }, "nullable": true } }, "additionalProperties": false }, "DeliveryResponse": { "type": "object", "properties": { "aanleverResponse": { "$ref": "#/components/schemas/AanleverResponse" }, "errorMessage": { "type": "string", "nullable": true }, "errorCode": { "type": "string", "nullable": true } }, "additionalProperties": false }, "DeliverySbrNexusRequest": { "type": "object", "properties": { "fileName": { "type": "string", "description": "The name of XBRL instance document.", "nullable": true, "example": "Test instance.xbrl" }, "content": { "type": "string", "description": "The content of the instance document, as Base64 formatted string.", "format": "byte", "nullable": true, "example": "PD94bW...." }, "identifier": { "type": "string", "description": "The business number of the reported entity.", "nullable": true, "example": "8525.." }, "messageType": { "type": "string", "description": "The relevant message type for the deposit.", "nullable": true, "example": "Inkomstenbelasting" }, "nameOfStakeholder": { "type": "string", "description": "The name of the receiving bank.", "nullable": true, "example": "The bank you want to send report" }, "idOfStakeholder": { "type": "string", "description": "The ID of the receiving bank.", "nullable": true, "example": "The ID of the target bank" }, "typeOfStakeholder": { "type": "string", "description": "ID-ontvanger", "nullable": true, "example": "ID-ontvanger" }, "typeOfSender": { "type": "string", "description": "The type of sender (intermediar, accountant etc).", "nullable": true, "example": "Intermediar" }, "idOfSupplier": { "type": "string", "description": "Mandatory when \"System certificate\" is used.", "nullable": true, "example": "8525." }, "certificateId": { "type": "string", "description": "When not provided the default system certificate will be used.", "nullable": true, "example": "https://api-certp.." }, "attachments": { "type": "array", "items": { "$ref": "#/components/schemas/Attachment" }, "nullable": true } }, "additionalProperties": false }, "DimensionDetails": { "type": "object", "properties": { "dimensionName": { "type": "string", "nullable": true }, "member": { "type": "string", "nullable": true }, "dimensionType": { "type": "string", "nullable": true } }, "additionalProperties": false }, "DimensionMember": { "type": "object", "properties": { "dimension": { "type": "string", "nullable": true }, "member": { "type": "string", "nullable": true }, "isTypedMember": { "type": "boolean" }, "contextElement": { "type": "string", "nullable": true }, "dimensionLabel": { "type": "string", "nullable": true }, "memberLabel": { "type": "string", "nullable": true }, "dimensionLabelCollection": { "type": "array", "items": { "$ref": "#/components/schemas/ConceptLabel" }, "nullable": true }, "memberLabelCollection": { "type": "array", "items": { "$ref": "#/components/schemas/ConceptLabel" }, "nullable": true } }, "additionalProperties": false }, "ElementType": { "enum": [ 0, 1, 2, 3, 4, 5 ], "type": "integer", "format": "int32" }, "EntryPointDocument": { "type": "object", "properties": { "href": { "type": "string", "nullable": true } }, "additionalProperties": false }, "EntryPointResponseDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "description": { "type": "string", "nullable": true }, "entrypoint": { "type": "string", "nullable": true }, "dateFrom": { "type": "string", "nullable": true }, "dateTo": { "type": "string", "nullable": true }, "messageId": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "ExplicitDimensionMember": { "type": "object", "properties": { "dimension": { "type": "string", "nullable": true }, "value": { "type": "string", "nullable": true }, "members": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "ExtensionArc": { "type": "object", "properties": { "usedOn": { "type": "string", "nullable": true }, "id": { "type": "string", "nullable": true }, "role": { "type": "string", "nullable": true }, "arcrole": { "type": "string", "nullable": true }, "from": { "type": "string", "nullable": true }, "to": { "type": "string", "nullable": true }, "isProhibition": { "type": "boolean" }, "priority": { "type": "number", "format": "double" }, "order": { "type": "number", "format": "double" }, "weight": { "type": "number", "format": "double" } }, "additionalProperties": false }, "ExtensionConcept": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "dataType": { "type": "string", "nullable": true }, "dataTypeNamespace": { "type": "string", "nullable": true }, "periodType": { "type": "string", "nullable": true }, "abstract": { "type": "boolean" }, "prefix": { "type": "string", "nullable": true }, "nillable": { "type": "boolean" }, "balance": { "type": "string", "nullable": true }, "schemaLocation": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ExtensionLinkRole": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "definition": { "type": "string", "nullable": true }, "usedOnPresentation": { "type": "boolean" }, "usedOnCalculation": { "type": "boolean" }, "usedOnDefinition": { "type": "boolean" } }, "additionalProperties": false }, "ExtensionMetaData": { "type": "object", "properties": { "targetNamespaceURI": { "type": "string", "nullable": true }, "namespacePrefix": { "type": "string", "nullable": true }, "baseTaxonomyEntryPoint": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ExtensionReference": { "type": "object", "properties": { "conceptId": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "content": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ExtensionRequest": { "type": "object", "properties": { "taxonomyExtensionMetaData": { "$ref": "#/components/schemas/ExtensionMetaData" }, "extensionLinkRoles": { "type": "array", "items": { "$ref": "#/components/schemas/ExtensionLinkRole" }, "nullable": true }, "extensionConcepts": { "type": "array", "items": { "$ref": "#/components/schemas/ExtensionConcept" }, "nullable": true }, "extensionArcs": { "type": "array", "items": { "$ref": "#/components/schemas/ExtensionArc" }, "nullable": true }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/ConceptLabel" }, "nullable": true }, "references": { "type": "array", "items": { "$ref": "#/components/schemas/ExtensionReference" }, "nullable": true } }, "additionalProperties": false }, "FileChunk": { "type": "object", "properties": { "data": { "type": "string", "format": "byte", "nullable": true, "example": "PD94bWwgdmVyc2lvbj0..." }, "fileNameNoPath": { "type": "string", "nullable": true, "example": "My file.xbrl" }, "offset": { "type": "integer", "format": "int64" }, "firstChunk": { "type": "boolean" }, "size": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "FileHistory": { "type": "object", "properties": { "id": { "type": "string", "description": "ID of the file history.", "format": "uuid", "example": "dbe33c92-8..." }, "fileId": { "type": "string", "description": "ID of the file.", "format": "uuid", "example": "063be713-f..." }, "action": { "type": "string", "description": "Name of the action (delivery, rendering).", "nullable": true, "example": "Downloaded" }, "atTime": { "type": "string", "description": "Date time of the action performed.", "format": "date-time", "example": "2019-05-20" }, "properties": { "type": "array", "items": { "$ref": "#/components/schemas/SeNeProperty" }, "nullable": true } }, "additionalProperties": false }, "FileUploadDto": { "type": "object", "properties": { "content": { "type": "string", "format": "byte", "nullable": true, "example": "PD94bWwgdmVyc2lvbj0..." }, "userId": { "type": "string", "nullable": true, "example": "user@gmail.com" }, "fileName": { "type": "string", "nullable": true, "example": "My file.xbrl" } }, "additionalProperties": false }, "FolderNode": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the folder.\r\nPossible values are 3 - Invalid = 0; Valid = 1; Invisible = 2", "nullable": true, "example": "My folder" }, "subFolders": { "type": "array", "items": { "$ref": "#/components/schemas/FolderNode" }, "description": "Folder representation.", "nullable": true }, "files": { "type": "array", "items": { "$ref": "#/components/schemas/ClsFile" }, "description": "All files placed in the folder.", "nullable": true } }, "additionalProperties": false }, "FoutType": { "type": "object", "properties": { "foutcode": { "type": "string", "nullable": true }, "foutbeschrijving": { "type": "string", "nullable": true } }, "additionalProperties": false }, "FullValidationRequest": { "required": [ "idOrBase64Content" ], "type": "object", "properties": { "idOrBase64Content": { "minLength": 1, "type": "string", "description": "file id (UUID) or instance content as base64 string", "example": "PD94bWwgdmVyc2lvbj..." }, "fileName": { "type": "string", "nullable": true }, "validationTypes": { "type": "array", "items": { "type": "string" }, "nullable": true, "example": [ "xbrlCore", "xbrlDimensions", "inlineXbrl", "xbrlCalculation", "formulaAssertions", "uniform", "duplicates" ] } }, "additionalProperties": false }, "GenerateInstanceWithAIRequest": { "type": "object", "properties": { "conceptElements": { "type": "array", "items": { "$ref": "#/components/schemas/ConceptElement" }, "nullable": true }, "entityIdentifier": { "type": "string", "nullable": true }, "entityScheme": { "type": "string", "nullable": true }, "schemaRef": { "type": "string", "nullable": true }, "decimals": { "type": "string", "nullable": true }, "unit": { "type": "string", "nullable": true }, "period": { "type": "string", "nullable": true }, "lang": { "type": "string", "nullable": true }, "fileName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "GenerationResponseDto": { "type": "object", "properties": { "instanceContentBase64": { "type": "string", "description": "Result XBRL instance document as base64 string", "nullable": true, "example": "PD94bWwgdmVyc2lvbj..." }, "taxonomyEntrypoint": { "type": "string", "description": "Taxonomy entripoint the report is based on", "nullable": true, "example": "http://www.nltaxonomie.nl/nt15/kvk/20201209/entrypoints/kvk-rpt-jaarverantwoording-2020-nlgaap-middelgroot.xsd" }, "factsCount": { "type": "integer", "description": "Count of facts in the result XBRL instance document", "format": "int32", "example": 3 }, "tuplesCount": { "type": "integer", "description": "Count of facts in the result XBRL instance document", "format": "int32", "example": 3 }, "unitsCount": { "type": "integer", "description": "Count of units in the result XBRL instance document", "format": "int32", "example": 1 }, "contextsCount": { "type": "integer", "description": "Count of contexts in the result XBRL instance document", "format": "int32", "example": 3 }, "hashResults": { "type": "object", "additionalProperties": { "type": "string" }, "description": "The hash code generated based on the result report.", "nullable": true } }, "additionalProperties": false }, "GetBaseSetPresentationStructure": { "type": "object", "properties": { "baseSetId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "GetConceptNodePresentationStructure": { "type": "object", "properties": { "conceptId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "GetCsvStructureRequest": { "type": "object", "properties": { "language": { "type": "string", "nullable": true, "example": "nl" }, "entitySchema": { "type": "string", "nullable": true, "example": "http://www.kvk.nl/kvk-id" }, "decimals": { "type": "string", "nullable": true, "example": "INF" }, "entityIdentifier": { "type": "string", "nullable": true, "example": "123456" }, "unit": { "type": "string", "nullable": true, "example": "EUR" }, "periods": { "type": "array", "items": { "$ref": "#/components/schemas/NonTablePeriod" }, "nullable": true }, "parameters": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "csvDelimiter": { "type": "string", "nullable": true } }, "additionalProperties": false }, "GetPresentationStructureRequest": { "type": "object", "properties": { "linkRoles": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "GetReportedFactsWithAIRequest": { "type": "object", "properties": { "entrypointId": { "type": "string", "nullable": true }, "language": { "type": "string", "nullable": true }, "pdfContentBase64": { "type": "string", "nullable": true }, "currentStartDate": { "type": "string", "nullable": true }, "currentEndDate": { "type": "string", "nullable": true }, "previousStartDate": { "type": "string", "nullable": true }, "previousEndDate": { "type": "string", "nullable": true }, "nonTablePeriodParameters": { "type": "array", "items": { "$ref": "#/components/schemas/NonTablePeriodParameter" }, "nullable": true } }, "additionalProperties": false }, "GetStatussenProcesResponse": { "type": "object", "properties": { "getStatussenProcesReturn": { "type": "array", "items": { "$ref": "#/components/schemas/GetStatussenProcesReturn" }, "nullable": true } }, "additionalProperties": false }, "GetStatussenProcesResponseDto": { "type": "object", "properties": { "getStatussenProcesReturn": { "type": "array", "items": { "$ref": "#/components/schemas/GetStatussenProcesReturnDto" }, "nullable": true } }, "additionalProperties": false }, "GetStatussenProcesReturn": { "type": "object", "properties": { "kenmerk": { "type": "string", "nullable": true }, "identiteitBelanghebbende": { "$ref": "#/components/schemas/IdentiteitBelanghebbende" }, "statuscode": { "type": "string", "nullable": true }, "tijdstempelStatus": { "type": "string", "format": "date-time" }, "statusomschrijving": { "type": "string", "nullable": true }, "statusFoutcode": { "$ref": "#/components/schemas/StatusFoutcode" }, "statusdetails": { "type": "string", "nullable": true } }, "additionalProperties": false }, "GetStatussenProcesReturnDto": { "type": "object", "properties": { "kenmerk": { "type": "string", "nullable": true }, "identiteitBelanghebbende": { "$ref": "#/components/schemas/IdentiteitBelanghebbende" }, "statuscode": { "type": "string", "nullable": true }, "tijdstempelStatus": { "type": "string", "format": "date-time" }, "statusomschrijving": { "type": "string", "nullable": true }, "statusFoutcode": { "$ref": "#/components/schemas/StatusFoutcodeDto" }, "statusdetails": { "type": "string", "nullable": true } }, "additionalProperties": false }, "GetTablesForRequest": { "type": "object", "properties": { "parameters": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "linkRoles": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "HashValidationRequest": { "required": [ "fileExtension", "fileName", "idOrBase64Content" ], "type": "object", "properties": { "idOrBase64Content": { "type": "string", "description": "The file content represented as Base64 string", "format": "byte", "example": "UEsDBBQ..." }, "fileName": { "minLength": 1, "type": "string", "description": "The name of the file.", "example": "My report.xbr" }, "fileExtension": { "minLength": 1, "type": "string", "description": "The extension of the file.", "example": ".xbr" }, "providedHash": { "type": "string", "description": "Either provide an Overall hash code or a Json file", "nullable": true }, "jsonIdOrBase64Content": { "type": "string", "description": "Either provide an Overall hash code or a Json file", "format": "byte", "nullable": true, "example": "UEsDBBQ..." } }, "additionalProperties": false }, "HashValidationResponse": { "type": "object", "properties": { "hashResult": { "$ref": "#/components/schemas/ClsHashResult" } }, "additionalProperties": false }, "IdentiteitAanleveraar": { "type": "object", "properties": { "nummer": { "type": "string", "nullable": true, "example": "0000000100..." }, "type": { "type": "string", "nullable": true, "example": "OIN" } }, "additionalProperties": false }, "IdentiteitBelanghebbende": { "type": "object", "properties": { "nummer": { "type": "string", "nullable": true, "example": "58589163" }, "type": { "type": "string", "nullable": true, "example": "kvk" } }, "additionalProperties": false }, "IdentiteitOntvanger": { "type": "object", "properties": { "nummer": { "type": "string", "nullable": true, "example": "0000000100..." }, "type": { "type": "string", "nullable": true, "example": "OIN" } }, "additionalProperties": false }, "ImportDataRow": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "tableRowId": { "type": "string", "nullable": true }, "tableId": { "type": "string", "nullable": true }, "tableModelTableId": { "type": "string", "nullable": true }, "concept": { "type": "string", "nullable": true }, "period": { "type": "string", "nullable": true }, "scenarioContent": { "type": "array", "items": { "type": "string" }, "nullable": true }, "value": { "type": "string", "nullable": true }, "unit": { "type": "string", "nullable": true }, "decimals": { "type": "string", "nullable": true } }, "additionalProperties": false }, "InstanceConcept": { "type": "object", "properties": { "linkRoleId": { "type": "string", "nullable": true }, "linkRole": { "type": "string", "nullable": true }, "caption": { "type": "string", "nullable": true }, "concept": { "type": "string", "nullable": true }, "model": { "type": "array", "items": { "$ref": "#/components/schemas/InstanceForm" }, "nullable": true }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/Label" }, "nullable": true }, "children": { "type": "array", "items": { "$ref": "#/components/schemas/InstanceConcept" }, "nullable": true } }, "additionalProperties": false }, "InstanceForm": { "type": "object", "properties": { "key": { "type": "string", "nullable": true }, "value": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true } }, "additionalProperties": false }, "InstanceImportRequestData": { "required": [ "base64Content" ], "type": "object", "properties": { "schemaRef": { "type": "string", "description": "Taxonomy entrypoint", "nullable": true, "example": "http://www.nltaxonomie.nl/nt15/kvk/20201209/entrypoints/kvk-rpt-jaarverantwoording-2020-nlgaap-middelgroot.xsd" }, "base64Content": { "minLength": 1, "type": "string", "description": "file id (UUID) or instance content as base64 string", "example": "PD94bWwgdmVyc2lvbj..." } }, "additionalProperties": false }, "InstanceImportResponseData": { "type": "object", "properties": { "entrypointFromInstance": { "type": "string", "nullable": true }, "entrypointForUpdate": { "type": "string", "nullable": true }, "dataRows": { "type": "array", "items": { "$ref": "#/components/schemas/ImportDataRow" }, "nullable": true }, "notPresentedDataRows": { "type": "array", "items": { "$ref": "#/components/schemas/NotPresentedDataRow" }, "nullable": true } }, "additionalProperties": false }, "InvitationRequestDto": { "type": "object", "properties": { "email": { "type": "string", "nullable": true }, "invitedBy": { "type": "string", "nullable": true }, "role": { "type": "string", "nullable": true } }, "additionalProperties": false }, "JsonDataSource": { "type": "object", "properties": { "schemaRef": { "type": "string", "description": "Taxonomy entrypoint", "nullable": true, "example": "http://www.nltaxonomie.nl/nt15/kvk/20201209/entrypoints/kvk-rpt-jaarverantwoording-2020-nlgaap-middelgroot.xsd" }, "lang": { "type": "string", "description": "Specify xml:lang attribute in 'xbrl' element", "nullable": true, "example": "en" }, "entityIdentifier": { "type": "string", "description": "Reporting entity identifier", "nullable": true, "example": "12345678" }, "entityScheme": { "type": "string", "description": "A scheme URI for identifying business entities", "nullable": true, "example": "http://www.kvk.nl/kvk-id" }, "unit": { "type": "string", "description": "Default unit identifier. Used when no unit specified on data row level", "nullable": true, "example": "iso4217:EUR" }, "period": { "type": "string", "description": "Default reporting period as start date/end date in yyyy-MM-dd format. Used when no period specified on data row leve", "nullable": true, "example": "2020-01-01/2020-12-31" }, "decimals": { "type": "string", "description": "Default decimals for numeric facts. Used when no decimals specified on data row level. If omitted, default is 'INF'", "nullable": true, "example": "INF" }, "dataRows": { "type": "array", "items": { "$ref": "#/components/schemas/DataRow" }, "nullable": true }, "fileName": { "type": "string", "description": "The name of the file.", "nullable": true, "example": "My report.xbrl" } }, "additionalProperties": false }, "Label": { "type": "object", "properties": { "text": { "type": "string", "nullable": true }, "lang": { "type": "string", "nullable": true }, "role": { "type": "string", "nullable": true } }, "additionalProperties": false }, "MergeRequest": { "type": "object", "properties": { "filesToBeMerged": { "type": "object", "additionalProperties": { "type": "string", "format": "byte", "nullable": true }, "description": "The main and child files that are going to be merged.", "nullable": true, "example": { "master": "base64 content", "child": "base64 content" } }, "fileName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "MergeResponse": { "type": "object", "properties": { "mergedContent": { "type": "string", "nullable": true }, "unmergedContent": { "type": "string", "nullable": true }, "hashResults": { "type": "object", "additionalProperties": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "MessageFilterRequestDto": { "type": "object", "properties": { "portal": { "type": "string", "description": "The preffered portal (SBR Nexus/Digipoort)", "nullable": true, "example": "Digipoort" }, "entrypoint": { "type": "string", "description": "Relevant taxonomy", "nullable": true, "example": "http://www.nltaxonomie.nl/nt15/kvk/20201209/entrypoints/kvk-rpt-jaarverantwoording-2020-nlgaap-middelgroot.xsd" } }, "additionalProperties": false }, "MessageResponseDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "portal": { "type": "string", "nullable": true }, "xbrlSupported": { "type": "boolean" }, "xmlSupported": { "type": "boolean" }, "receivers": { "type": "array", "items": { "$ref": "#/components/schemas/ReceiverResponseDto" }, "nullable": true }, "entryPoints": { "type": "array", "items": { "$ref": "#/components/schemas/EntryPointResponseDto" }, "nullable": true } }, "additionalProperties": false }, "MessageResponseShortDto": { "type": "object", "properties": { "name": { "type": "string", "description": "Public name of the message type", "nullable": true, "example": "Jaarrekening" }, "epDescription": { "type": "string", "description": "Public description of the message type", "nullable": true, "example": "Jaarverantwoording 2020 NLGAAP - middelgrote rechtspersonen" }, "receivers": { "type": "array", "items": { "$ref": "#/components/schemas/ReceiverResponseShortDto" }, "nullable": true } }, "additionalProperties": false }, "NonTablePeriod": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "startDate": { "type": "string", "nullable": true }, "endDate": { "type": "string", "nullable": true }, "instantDate": { "type": "string", "nullable": true } }, "additionalProperties": false }, "NonTablePeriodParameter": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "startDate": { "type": "string", "nullable": true }, "endDate": { "type": "string", "nullable": true }, "instantDate": { "type": "string", "nullable": true } }, "additionalProperties": false }, "NotPresentedDataRow": { "type": "object", "properties": { "factId": { "type": "string", "nullable": true }, "factValue": { "type": "string", "nullable": true }, "contextRef": { "type": "string", "nullable": true }, "unitRef": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Option": { "type": "object", "properties": { "key": { "type": "string", "description": "Parameter key", "nullable": true, "example": "Fiscaal" }, "value": { "type": "string", "description": "Parameter value", "nullable": true, "example": "jenv-bw2-dm:FiscalMember" }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/OptionLabel" }, "nullable": true } }, "additionalProperties": false }, "OptionLabel": { "type": "object", "properties": { "lang": { "type": "string", "description": "Label language", "nullable": true, "example": "de" }, "value": { "type": "string", "description": "Label content", "nullable": true, "example": "Fiskal" } }, "additionalProperties": false }, "PackageLicenseDto": { "type": "object", "properties": { "href": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Parameter": { "type": "object", "properties": { "name": { "type": "string", "description": "Parameter name", "nullable": true, "example": "BasisOfPreparationParam" }, "defaultValue": { "type": "string", "description": "Default value defined for the parameter.", "nullable": true, "example": "Commercieel" }, "options": { "type": "array", "items": { "$ref": "#/components/schemas/Option" }, "nullable": true }, "fact": { "type": "string", "description": "The concept identification of the fact used to match the parameter", "nullable": true, "example": "jenv-bw2-i:BasisOfPreparation" }, "as": { "type": "string", "description": "Data type of fact value", "nullable": true, "example": "QName" } }, "additionalProperties": false }, "PivotRequestDto": { "type": "object", "properties": { "content": { "type": "string", "description": "The xbrl instance document, represented as byte[]", "format": "byte", "nullable": true, "example": "PD94bWwgdmVyc2lobg..." }, "label": { "type": "string", "description": "The peffered label role that you want to the result to be filtered", "nullable": true, "example": "http://www.xbrl.org/2003/role/label" }, "language": { "type": "string", "description": "The preferred language, default is nl.", "nullable": true, "example": "nl" } }, "additionalProperties": false }, "ProductFileRequestDto": { "type": "object", "properties": { "author": { "type": "string", "description": "The author of the record", "nullable": true, "example": "admin@semansys.com" }, "releaseId": { "type": "string", "description": "The ID of the release which relates to.", "nullable": true, "example": "89" }, "type": { "type": "string", "description": "Type of files to be uploaded.", "nullable": true, "example": "application (.exe)" }, "kind": { "type": "string", "description": "The kind of the files.", "nullable": true, "example": "Manual" }, "createdOn": { "type": "string", "description": "The exact date when the file is stored.", "format": "date-time", "example": "2020-01-01/2020-12-31" }, "isPublic": { "type": "boolean" }, "domains": { "type": "array", "items": { "type": "string" }, "description": "The allowed domains to able to access the documentation.", "nullable": true }, "file": { "$ref": "#/components/schemas/FileChunk" }, "name": { "type": "string", "description": "Name of the file.", "nullable": true, "example": "My test manual" }, "description": { "type": "string", "description": "Additional description for the files.", "nullable": true, "example": "Useful guide for new SemansysNext features" } }, "additionalProperties": false }, "ProductFileResponseDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "author": { "type": "string", "nullable": true, "example": "user@semansys.com" }, "releaseId": { "type": "string", "nullable": true, "example": "89" }, "size": { "type": "integer", "format": "int64", "example": 9122 }, "type": { "type": "string", "nullable": true, "example": ".xbrl" }, "kind": { "type": "string", "nullable": true, "example": "manual" }, "sha256": { "type": "string", "nullable": true, "example": "620DE86.." }, "createdOn": { "type": "string", "format": "date-time", "example": "2021-12-21T05:48:57.253Z" }, "isPublic": { "type": "boolean" }, "domains": { "type": "array", "items": { "type": "string" }, "nullable": true, "example": [ "gmail.com", "semansys.com" ] }, "name": { "type": "string", "nullable": true, "example": "CoC rep..." }, "description": { "type": "string", "nullable": true, "example": "My first manual." } }, "additionalProperties": false }, "ReceiverResponseDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "identityType": { "type": "string", "nullable": true }, "identityNumber": { "type": "string", "nullable": true }, "messageId": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "ReceiverResponseShortDto": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the regulator", "nullable": true, "example": "KVK" }, "identityType": { "type": "string", "description": "Identity type of the regulator", "nullable": true, "example": "ID-ontvanger" }, "identityNumber": { "type": "string", "description": "ID of the regulator (in the example is provided a test ID)", "nullable": true, "example": "00000000123456780000" } }, "additionalProperties": false }, "ReferenceValue": { "type": "object", "properties": { "referenceId": { "type": "string", "nullable": true }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/ConceptLabel" }, "nullable": true }, "hasChildren": { "type": "boolean" } }, "additionalProperties": false }, "RenderUniformRequest": { "type": "object", "properties": { "xbrlInstance": { "type": "string", "format": "byte", "nullable": true, "example": "PD94bWwgdmVyc2lvbj..." }, "uniformOptions": { "$ref": "#/components/schemas/UniformOptions" }, "fileName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "RenderUniformResponse": { "type": "object", "properties": { "uniformedXbrlInstance": { "type": "string", "format": "byte", "nullable": true, "example": "PD94bWwgdmVyc2lvbj..." }, "uniformLog": { "type": "string", "format": "byte", "nullable": true, "example": "PD94bWwgdmVyc2lobg..." }, "hashResults": { "type": "object", "additionalProperties": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "RenderXbrlInline": { "type": "object", "properties": { "inlineXbrl": { "type": "string", "nullable": true, "example": "PD94bWwgdmVyc2lvbj..." }, "hashResults": { "type": "object", "additionalProperties": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "RenderingPlusSettings": { "type": "object", "properties": { "language": { "type": "string", "nullable": true }, "header": { "type": "string", "nullable": true }, "footer": { "type": "string", "nullable": true }, "showEmptyTables": { "type": "boolean" }, "showEmptyRows": { "type": "boolean" }, "showEmptyColumns": { "type": "boolean" }, "applyFilingIndicators": { "type": "boolean" }, "showToC": { "type": "boolean" }, "levelOfDepth": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "RenderingSettings": { "type": "object", "properties": { "mode": { "type": "string", "description": "Supported rendering representations of an XBRL instance are: \"Table\", \"Presentation\" or \"DPM\"", "nullable": true, "example": "Presentation" }, "language": { "type": "string", "nullable": true, "example": "en" }, "colorBackground": { "type": "string", "nullable": true }, "colorFont": { "type": "string", "nullable": true }, "imageLogo": { "type": "string", "nullable": true }, "header": { "type": "string", "nullable": true, "example": "This is a header" }, "footer": { "type": "string", "nullable": true, "example": "This is a footer" }, "showEmptyTables": { "type": "boolean", "example": false }, "showEmptyRows": { "type": "boolean", "example": false }, "showEmptyColumns": { "type": "boolean", "example": false }, "applyFilingIndicators": { "type": "boolean", "example": false }, "showToC": { "type": "boolean", "description": "Table of content", "example": false }, "levelOfDepth": { "type": "integer", "description": "Define the level of depth of the table of content", "format": "int32", "example": 3 } }, "additionalProperties": false }, "ReportArgs": { "type": "object", "properties": { "reportContentBase64": { "type": "string", "description": "Value of the parameter 'ReportContentBase64' must be base64content of the instance file (.xbrl)", "format": "byte", "nullable": true, "example": "PD94bWwgdmVyc2lvbj..." }, "renderingSettings": { "$ref": "#/components/schemas/RenderingSettings" }, "fileName": { "type": "string", "description": "The name of the file.", "nullable": true, "example": "My report.xbrl" } }, "additionalProperties": false }, "ReportConsistentArgs": { "type": "object", "properties": { "reportContentBase64": { "type": "string", "description": "Value of the parameter 'ReportContentBase64' must be base64content of the instance file (.xbrl)", "format": "byte", "nullable": true, "example": "PD94bWwgdmVyc2lvbj..." }, "renderingSettings": { "$ref": "#/components/schemas/RenderingSettings" }, "fileName": { "type": "string", "description": "The name of the file.", "nullable": true, "example": "My report.xbrl" } }, "additionalProperties": false }, "ReportPackageHashRequestData": { "required": [ "fileExtension", "fileName", "idOrBase64Content" ], "type": "object", "properties": { "idOrBase64Content": { "type": "string", "description": "The file content represented as Base64 string", "format": "byte", "example": "UEsDBBQ..." }, "fileName": { "minLength": 1, "type": "string", "description": "The name of the file.", "example": "My report.xbr" }, "fileExtension": { "minLength": 1, "type": "string", "description": "The extension of the file.", "example": ".xbr" } }, "additionalProperties": false }, "ReportPackageHashResponseData": { "type": "object", "properties": { "hashResult": { "$ref": "#/components/schemas/ClsHashResult" } }, "additionalProperties": false }, "ReportPackageResponse": { "type": "object", "properties": { "zipContentBase64": { "type": "string", "nullable": true }, "hashResults": { "type": "object", "additionalProperties": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "ReportPlusArgs": { "type": "object", "properties": { "reportContentBase64": { "type": "string", "description": "XBRL instance document content as base64 string", "format": "byte", "nullable": true, "example": "PD94bWwgdmVyc2lvbj..." }, "renderingPlusSettings": { "$ref": "#/components/schemas/RenderingPlusSettings" }, "fileName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ReportRequest": { "type": "object", "properties": { "extensionsData": { "$ref": "#/components/schemas/ExtensionRequest" }, "instanceData": { "$ref": "#/components/schemas/JsonDataSource" }, "packageData": { "$ref": "#/components/schemas/CustomReportPackageData" } }, "additionalProperties": false }, "ReportResultDTO": { "type": "object", "properties": { "htmlContent": { "type": "string", "nullable": true }, "pdfContent": { "type": "string", "format": "byte", "nullable": true, "example": "JVBERxLjQKMSAw..." }, "hashResults": { "type": "object", "additionalProperties": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "ReportSupplementArgs": { "type": "object", "properties": { "reportContentBase64": { "type": "string", "description": "XBRL instance document content as base64 string", "format": "byte", "nullable": true, "example": "PD94bWwgdmVyc2lvbj..." }, "isOutputInline": { "type": "boolean", "description": "Make the output HTML to inline HTML (also if true it'll lood taxonomy)", "example": true }, "includePdfOutput": { "type": "boolean", "description": "The response will have the pdf byteArray", "example": true }, "fileName": { "type": "string", "description": "Name of File being passed in", "nullable": true, "example": "file.xbrl" } }, "additionalProperties": false }, "ReportSupplementResultDto": { "type": "object", "properties": { "type": { "type": "string", "nullable": true }, "htmlContent": { "type": "string", "nullable": true }, "pdfContent": { "type": "string", "format": "byte", "nullable": true }, "hashResults": { "type": "object", "additionalProperties": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "ResultAttribute": { "type": "object", "properties": { "name": { "type": "string", "nullable": true, "example": "GenPreconditionTest" }, "value": { "type": "string", "nullable": true, "example": "$varArc_CashFlowStatement_PrtValueThnNoExistenceCovA12_CashFlowStatementMethodType eq 'Direct'" } }, "additionalProperties": false }, "ResultMessage": { "type": "object", "properties": { "category": { "type": "string", "nullable": true, "example": "Process object" }, "type": { "type": "string", "nullable": true, "example": "Notification" }, "code": { "type": "string", "nullable": true, "example": "2009" }, "message": { "type": "string", "nullable": true, "example": "An assertion with unsatisfied precondition found" }, "attributes": { "type": "array", "items": { "$ref": "#/components/schemas/ResultAttribute" }, "nullable": true } }, "additionalProperties": false }, "SeNeCertificate": { "type": "object", "properties": { "id": { "type": "string", "nullable": true, "example": "https://portal..." }, "userId": { "type": "string", "nullable": true, "example": "user@gmail.com" }, "name": { "type": "string", "nullable": true, "example": "My first certificate" }, "dbName": { "type": "string", "nullable": true, "example": "My first db certificate name" }, "type": { "type": "string", "nullable": true, "example": "Digipoort" } }, "additionalProperties": false }, "SeNeFile": { "type": "object", "properties": { "id": { "type": "string", "description": "The ID of the file.", "format": "uuid", "example": "063be713-f..." }, "userEmail": { "type": "string", "description": "The email of the user (owner of the file).", "nullable": true, "example": "user@gmail.com" }, "name": { "type": "string", "description": "Name of the file.", "nullable": true, "example": "My Test File" }, "size": { "type": "integer", "description": "File size.", "format": "int64", "example": 1253 }, "type": { "type": "string", "description": "File type.", "nullable": true, "example": ".xbrl" }, "sha256": { "type": "string", "description": "File checksum.", "nullable": true, "example": "5B63E7C115FA..." }, "createdOn": { "type": "string", "description": "Date time of file creation.", "format": "date-time", "example": "2019-05-17" }, "isDomain": { "type": "boolean" }, "isPublic": { "type": "boolean" }, "history": { "type": "array", "items": { "$ref": "#/components/schemas/FileHistory" }, "nullable": true }, "properties": { "type": "array", "items": { "$ref": "#/components/schemas/SeNeProperty" }, "nullable": true } }, "additionalProperties": false }, "SeNeProperty": { "type": "object", "properties": { "id": { "type": "string", "description": "File size.", "format": "uuid", "example": "063be713..." }, "type": { "type": "string", "description": "ID of the action.", "nullable": true, "example": "91063921-5..." }, "key": { "type": "string", "description": "Name of action.", "nullable": true, "example": "NumberOfFacts" }, "value": { "type": "string", "description": "Actual value.", "nullable": true, "example": "2" } }, "additionalProperties": false }, "StatusDigipoortRequest": { "type": "object", "properties": { "identifier": { "type": "string", "description": "The ID of the delivered XBRL instance.", "nullable": true, "example": "a06d0542-2..." }, "certificateId": { "type": "string", "description": "The ID of the certificate.", "nullable": true, "example": "https://api-certp..." } }, "additionalProperties": false }, "StatusFoutcode": { "type": "object", "properties": { "foutType": { "$ref": "#/components/schemas/FoutType" } }, "additionalProperties": false }, "StatusFoutcodeDto": { "type": "object", "properties": { "foutcode": { "type": "string", "nullable": true }, "foutbeschrijving": { "type": "string", "nullable": true } }, "additionalProperties": false }, "StatusProcessResponse": { "type": "object", "properties": { "getStatussenProcesResponse": { "$ref": "#/components/schemas/GetStatussenProcesResponse" }, "errorMessage": { "type": "string", "description": "Detailed message for the error", "nullable": true }, "errorCode": { "type": "string", "description": "The error code received from the regulator", "nullable": true } }, "additionalProperties": false }, "StatusProcessResponseDto": { "type": "object", "properties": { "getStatussenProcesResponse": { "$ref": "#/components/schemas/GetStatussenProcesResponseDto" }, "errorMessage": { "type": "string", "description": "Detailed message for the error", "nullable": true }, "errorCode": { "type": "string", "description": "The error code received from the regulator", "nullable": true } }, "additionalProperties": false }, "StatusSbrNexusRequest": { "type": "object", "properties": { "identifier": { "type": "string", "description": "The ID of the delivered XBRL instance", "nullable": true, "example": "BTP-210..." }, "certificateId": { "type": "string", "description": "When not provided the default system certificate will be used.", "nullable": true, "example": "https://api-certp..." }, "idOfSupplier": { "type": "string", "description": "Mandatory when \"System certificate\" is used.", "nullable": true, "example": "8525..." } }, "additionalProperties": false }, "TableOfContentModel": { "type": "object", "properties": { "tableOfContent": { "type": "array", "items": { "$ref": "#/components/schemas/InstanceConcept" }, "nullable": true } }, "additionalProperties": false }, "TaxonomyConcept": { "type": "object", "properties": { "uniqueId": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "namespaceUri": { "type": "string", "nullable": true }, "dataType": { "type": "string", "nullable": true }, "typeQName": { "type": "string", "nullable": true }, "prefix": { "type": "string", "nullable": true }, "periodType": { "type": "string", "nullable": true }, "isAbstract": { "type": "boolean" }, "substitutionGroupType": { "type": "string", "nullable": true }, "isDimension": { "type": "boolean" }, "isEnumeration": { "type": "boolean" }, "isNillable": { "type": "boolean" }, "balance": { "type": "string", "nullable": true }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/ConceptLabel" }, "nullable": true }, "enumerations": { "type": "array", "items": { "$ref": "#/components/schemas/ConceptEnumeration" }, "nullable": true }, "dimensionMembers": { "type": "array", "items": { "$ref": "#/components/schemas/DimensionMember" }, "nullable": true } }, "additionalProperties": false }, "TaxonomyConceptList": { "type": "object", "properties": { "count": { "type": "integer", "format": "int32" }, "taxonomyConcepts": { "type": "array", "items": { "$ref": "#/components/schemas/TaxonomyConcept" }, "nullable": true } }, "additionalProperties": false }, "TaxonomyCsvSetResponse": { "type": "object", "properties": { "taxonomy": { "type": "string", "nullable": true }, "language": { "type": "string", "nullable": true }, "entitySchema": { "type": "string", "nullable": true }, "decimals": { "type": "string", "nullable": true }, "entityIdentifier": { "type": "string", "nullable": true }, "unit": { "type": "string", "nullable": true }, "concepts": { "type": "array", "items": { "$ref": "#/components/schemas/ConceptNodeCsv" }, "nullable": true }, "csvDelimiter": { "type": "string", "nullable": true } }, "additionalProperties": false }, "TaxonomyDescriptionDto": { "type": "object", "properties": { "lang": { "type": "string", "nullable": true, "example": "nl" }, "description": { "type": "string", "nullable": true, "example": "Verantwoordingsmodel 2019" } }, "additionalProperties": false }, "TaxonomyEntrypointDto": { "required": [ "applyRewriteRules", "hasTables" ], "type": "object", "properties": { "id": { "type": "string", "nullable": true, "example": "063be713-fdcd-4681-a955-cb3d9028b18f" }, "uri": { "type": "string", "nullable": true, "example": "http://www.nltaxonomie.nl/nt14/bzk/20191211/entrypoints/bzk-rpt-wnt-verantwoordingsmodel-2019.xsd" }, "name": { "type": "array", "items": { "$ref": "#/components/schemas/TaxonomyNameDto" }, "nullable": true }, "description": { "type": "array", "items": { "$ref": "#/components/schemas/TaxonomyDescriptionDto" }, "nullable": true }, "version": { "type": "string", "nullable": true, "example": "20191211" }, "language": { "type": "array", "items": { "type": "string" }, "nullable": true, "example": [ "nl" ] }, "country": { "type": "string", "nullable": true, "example": "NL" }, "publicationDate": { "type": "string", "nullable": true, "example": "2019-11-07T00:00:00Z" }, "packageIdentifier": { "type": "string", "nullable": true, "example": "nt14" }, "publisherUrl": { "type": "string", "nullable": true, "example": "http://www.nltaxonomie.nl" }, "packageName": { "type": "array", "items": { "$ref": "#/components/schemas/TaxonomyNameDto" }, "nullable": true }, "packageDescription": { "type": "array", "items": { "$ref": "#/components/schemas/TaxonomyDescriptionDto" }, "nullable": true }, "packageVersion": { "type": "string", "nullable": true, "example": "20191107" }, "license": { "$ref": "#/components/schemas/PackageLicenseDto" }, "publisher": { "type": "array", "items": { "type": "string" }, "nullable": true, "example": [ "SBR Programma" ] }, "type": { "type": "string", "nullable": true, "example": "public" }, "applyRewriteRules": { "type": "boolean" }, "rewriteUri": { "type": "string", "nullable": true }, "hasTables": { "type": "boolean" } }, "additionalProperties": false }, "TaxonomyLinkRoleList": { "type": "object", "properties": { "count": { "type": "integer", "format": "int32" }, "taxonomyLinkRoles": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "TaxonomyNameDto": { "type": "object", "properties": { "lang": { "type": "string", "nullable": true, "example": "nl" }, "name": { "type": "string", "nullable": true, "example": "BZK Verantwoordingsmodel 2019" } }, "additionalProperties": false }, "TaxonomyPackageDto": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "packageBase64Content": { "type": "string", "nullable": true }, "packageName": { "type": "string", "nullable": true }, "applyRewriteRules": { "type": "boolean" }, "type": { "type": "string", "nullable": true } }, "additionalProperties": false }, "TaxonomySchemaResult": { "type": "object", "properties": { "uri": { "type": "string", "nullable": true }, "prefix": { "type": "string", "nullable": true }, "namespace": { "type": "string", "nullable": true }, "contentBase64": { "type": "string", "nullable": true }, "isPublic": { "type": "boolean" } }, "additionalProperties": false }, "TaxonomySchemaSetResponse": { "type": "object", "properties": { "entrypoint": { "type": "string", "nullable": true }, "taxonomySchemas": { "type": "array", "items": { "$ref": "#/components/schemas/TaxonomySchemaResult" }, "nullable": true } }, "additionalProperties": false }, "TaxonomyTablesResult": { "type": "object", "properties": { "jobStatus": { "type": "string", "nullable": true }, "startDateTime": { "type": "string", "nullable": true }, "endDateTime": { "type": "string", "nullable": true }, "tables": { "type": "array", "items": { "$ref": "#/components/schemas/WeTableModel" }, "nullable": true } }, "additionalProperties": false }, "UniformOptions": { "type": "object", "properties": { "language": { "type": "string", "nullable": true, "example": "nl" }, "unusedContexts": { "type": "boolean" }, "unusedUnits": { "type": "boolean" }, "duplicatedContexts": { "type": "boolean" }, "duplicatedUnits": { "type": "boolean" }, "duplicatedFacts": { "type": "boolean" }, "nonCanonicalNamespaces": { "type": "boolean" }, "unusedNamespaces": { "type": "boolean" }, "unclassifiedCharacters": { "type": "boolean" } }, "additionalProperties": false }, "UserRole": { "enum": [ 1, 2, 3, 4, 5 ], "type": "integer", "description": "The user's role values range from 1 to 5: 1 for admin, 2 for manager, 3 for user, 4 for guest and 5 for cc user.", "format": "int32" }, "V6AnalyzeTableModel": { "type": "object", "properties": { "id": { "type": "string", "nullable": true, "readOnly": true, "example": "kvk-t..." }, "title": { "type": "string", "nullable": true, "readOnly": true, "example": "Balance sheet" }, "unit": { "type": "string", "nullable": true, "readOnly": true, "example": "Euro" }, "series": { "type": "array", "items": { "$ref": "#/components/schemas/V6TableHeaderModel" }, "nullable": true, "readOnly": true }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/V6TableItemBaseModel" }, "nullable": true, "readOnly": true }, "roles": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "nullable": true, "readOnly": true, "example": [ "urn:kvk:linkr..", "urn:kvk:lin.." ] } }, "additionalProperties": false }, "V6Concept": { "type": "object", "properties": { "id": { "type": "string", "nullable": true, "readOnly": true, "example": "jenv-bw2-i:BalanceSheetBeforeAfterAppropriationResults" }, "isAbstract": { "type": "boolean", "nullable": true, "readOnly": true }, "isNumeric": { "type": "boolean", "nullable": true, "readOnly": true }, "isMonetary": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "V6LabelModel": { "type": "object", "properties": { "text": { "type": "string", "nullable": true, "example": "Current" }, "lang": { "type": "string", "nullable": true, "example": "en" }, "role": { "type": "string", "nullable": true, "example": "http://www.xb.." } }, "additionalProperties": false }, "V6TableHeaderModel": { "type": "object", "properties": { "caption": { "type": "string", "nullable": true, "readOnly": true, "example": "2020-12-31T00:00:00Z" }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/V6LabelModel" }, "nullable": true, "readOnly": true } }, "additionalProperties": false }, "V6TableItemBaseModel": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/V6TableItemBaseModel" }, "nullable": true, "readOnly": true }, "concept": { "$ref": "#/components/schemas/V6Concept" }, "values": { "type": "array", "items": { "type": "string" }, "nullable": true, "readOnly": true, "example": [ "Na", "-" ] } }, "additionalProperties": false }, "ValidationRequest": { "required": [ "idOrBase64Content" ], "type": "object", "properties": { "idOrBase64Content": { "minLength": 1, "type": "string", "description": "file id (UUID) or instance content as base64 string", "example": "PD94bWwgdmVyc2lvbj..." }, "fileName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ValidationResult": { "type": "object", "properties": { "jobStatus": { "type": "string", "nullable": true, "example": "success" }, "startDateTime": { "type": "string", "nullable": true, "example": "2021-08-03T13:45:30Z" }, "endDateTime": { "type": "string", "nullable": true, "example": "2021-08-03T13:55:30Z" }, "validations": { "type": "array", "items": { "$ref": "#/components/schemas/ValidationTypeResult" }, "nullable": true } }, "additionalProperties": false }, "ValidationType": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11 ], "type": "integer", "format": "int32" }, "ValidationTypeResult": { "type": "object", "properties": { "validationType": { "$ref": "#/components/schemas/ValidationType" }, "validationResult": { "type": "string", "nullable": true, "example": "valid" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true } }, "additionalProperties": false }, "WeTableModel": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "nSpace": { "type": "string", "nullable": true }, "weTableModelTableSets": { "type": "array", "items": { "$ref": "#/components/schemas/WeTableModelTableSet" }, "nullable": true } }, "additionalProperties": false }, "WeTableModelCell": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "decimals": { "type": "string", "nullable": true }, "concept": { "type": "string", "nullable": true }, "period": { "type": "string", "nullable": true }, "unitRef": { "type": "string", "nullable": true }, "factInstanceId": { "type": "string", "nullable": true }, "scenarioContent": { "type": "array", "items": { "type": "string" }, "nullable": true }, "constraints": { "type": "array", "items": { "$ref": "#/components/schemas/WeTableModelConstraint" }, "nullable": true }, "value": { "type": "string", "nullable": true } }, "additionalProperties": false }, "WeTableModelConcept": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "namespaceUri": { "type": "string", "nullable": true }, "uniqueId": { "type": "string", "nullable": true }, "typeQName": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true }, "periodType": { "type": "string", "nullable": true }, "labels": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/WeTableModelLabel" }, "nullable": true }, "isFraction": { "type": "boolean" }, "isBoolean": { "type": "boolean" }, "isDate": { "type": "boolean" }, "isNumeric": { "type": "boolean" }, "isMonetary": { "type": "boolean" }, "isTypedDimension": { "type": "boolean" }, "isExplicitDimension": { "type": "boolean" }, "isEnumeration": { "type": "boolean" }, "enumerations": { "type": "array", "items": { "$ref": "#/components/schemas/ConceptEnumeration" }, "nullable": true } }, "additionalProperties": false }, "WeTableModelConstraint": { "type": "object", "properties": { "aspect": { "type": "string", "nullable": true }, "value": { "type": "string", "nullable": true }, "concept": { "$ref": "#/components/schemas/WeTableModelConcept" } }, "additionalProperties": false }, "WeTableModelGroup": { "type": "object", "properties": { "labels": { "type": "array", "items": { "$ref": "#/components/schemas/WeTableModelLabel" }, "nullable": true }, "weTableModelGroupHeaders": { "type": "array", "items": { "$ref": "#/components/schemas/WeTableModelGroupHeader" }, "nullable": true } }, "additionalProperties": false }, "WeTableModelGroupHeader": { "type": "object", "properties": { "headerCells": { "type": "array", "items": { "$ref": "#/components/schemas/WeTableModelHeaderCell" }, "nullable": true } }, "additionalProperties": false }, "WeTableModelHeader": { "type": "object", "properties": { "axis": { "type": "string", "nullable": true }, "weTableModelGroup": { "type": "array", "items": { "$ref": "#/components/schemas/WeTableModelGroup" }, "nullable": true } }, "additionalProperties": false }, "WeTableModelHeaderCell": { "type": "object", "properties": { "colSpan": { "type": "string", "nullable": true }, "period": { "type": "string", "nullable": true }, "concept": { "type": "string", "nullable": true }, "scenarioContent": { "type": "array", "items": { "type": "string" }, "nullable": true }, "label": { "type": "array", "items": { "$ref": "#/components/schemas/WeTableModelLabel" }, "nullable": true }, "headerCellConstraint": { "type": "array", "items": { "$ref": "#/components/schemas/WeTableModelConstraint" }, "nullable": true } }, "additionalProperties": false }, "WeTableModelLabel": { "type": "object", "properties": { "lang": { "type": "string", "nullable": true }, "role": { "type": "string", "nullable": true }, "xLinkLabel": { "type": "string", "nullable": true }, "labelText": { "type": "string", "nullable": true } }, "additionalProperties": false }, "WeTableModelRow": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "colSpan": { "type": "integer", "format": "int32" }, "isTitle": { "type": "boolean" }, "isTotal": { "type": "boolean" }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/WeTableModelLabel" }, "nullable": true }, "factCells": { "type": "array", "items": { "$ref": "#/components/schemas/WeTableModelCell" }, "nullable": true }, "indent": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "WeTableModelTable": { "type": "object", "properties": { "weTableModelHeaders": { "type": "array", "items": { "$ref": "#/components/schemas/WeTableModelHeader" }, "nullable": true }, "weTableModelRows": { "type": "array", "items": { "$ref": "#/components/schemas/WeTableModelRow" }, "nullable": true }, "isOpenAxisX": { "type": "boolean" }, "isOpenAxisY": { "type": "boolean" }, "isOpenAxisZ": { "type": "boolean" }, "weTableModelTableOpenAxes": { "type": "array", "items": { "$ref": "#/components/schemas/WeTableModelTableOpenAxis" }, "nullable": true } }, "additionalProperties": false }, "WeTableModelTableOpenAxis": { "type": "object", "properties": { "key": { "type": "string", "nullable": true }, "values": { "type": "array", "items": { "$ref": "#/components/schemas/WeTableModelTableOpenAxisValue" }, "nullable": true } }, "additionalProperties": false }, "WeTableModelTableOpenAxisValue": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "concept": { "$ref": "#/components/schemas/WeTableModelConcept" }, "value": { "type": "string", "nullable": true } }, "additionalProperties": false }, "WeTableModelTableSet": { "type": "object", "properties": { "weTableModelLabels": { "type": "array", "items": { "$ref": "#/components/schemas/WeTableModelLabel" }, "nullable": true }, "weTableModelTable": { "type": "array", "items": { "$ref": "#/components/schemas/WeTableModelTable" }, "nullable": true } }, "additionalProperties": false }, "XmlEntryPointModel": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "version": { "type": "string", "nullable": true }, "entryPointDocument": { "$ref": "#/components/schemas/EntryPointDocument" }, "languages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false } }, "securitySchemes": { "Bearer": { "type": "http", "description": "Please enter token", "scheme": "bearer", "bearerFormat": "JWT" } } }, "security": [ { "Bearer": [ ] } ] }