Report extension

OpenAPI V2

Generate report extension.

post

Generate report extension package based on taxonomy metadata and taxonomy extension elements (extension linkroles, extension concepts, extension arcs, extension labels and extension references), instance data (language, entity identifier, entity scheme, unit, period, decimals and data rows) and package metadata (name, identifier, description, version, report package language, publisher, publisher uri, publisher country, report package name, report base64 content, report name, entrypoint, base64 zip files, base64 report package json). For 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. User can validate the hash value in hash validation functionality and to know if any changes are applied. By default the file hash is disabled, but it can be controlled from the dropdown below. Response body will be for example:

{ 
    "Content": "JVBERxLjQKMSAw...", 
    "ReportingPackageHash": "nKDBo115PBhw3U3Y= " 
}

Authorizations

Query parameters

isHashedbooleanoptionalDefault: false

Header parameters

x-api-versionstringrequired

ApplicationNameanyoptional

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

PartnerNameanyoptional

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

PartnerIDanyoptional

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

CustomerNameanyoptional

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

CustomerIDanyoptional

Business Identification Number (BIN) of the customer.

ClientNameanyoptional

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

ClientIDanyoptional

Business Identification Number (BIN) of the client.

Body

extensionsDataobjectoptional

instanceDataobjectoptional

packageDataobjectoptional

Responses

text/plainapplication/jsontext/json

anyoptional

text/plainapplication/jsontext/json

post

HTTPcURLJavaScriptPython

POST /taxonomy/report-extension HTTP/1.1
Host: 
Authorization: Bearer JWT
x-api-version: text
Content-Type: application/json
Accept: */*
Content-Length: 3636

{
  "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
  }
}

SlZCRVJ4TGpRS01TQXcuLi4=