Generation

OpenAPI V2

Was this helpful?

Generate an XBRL report (.xbrl) from JSON.

post

Generate an XBRL report (.xbrl) from JSON-structured data file containing the reporting data. 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:

{ 
    "InstanceContentBase64": "JVBERxLjQKMSAw...", 
    "TaxonomyEntrypoint": "http://www.nltaxonomie.nl/nt15/kvk/20201209/entrypoints/kvk-rpt-jaarverantwoording-2020-nlgaap-middelgroot.xsd", 
    "FactsCount": 4, 
    "TuplesCount": 3, 
    "UnitsCount": 2, 
    "ContextsCount": 1, 
    "hashResult": { 
        "Hash_Result": "nKDBo115PBhw3U3Y= " 
    } 
}

Authorizations

Query parameters

isHashedbooleanOptional

Optional. Specifies whether to have a hashcode included in the output. By default the value is false.

Default: 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

schemaRefstring | nullableOptional

Taxonomy entrypoint

Example: http://www.nltaxonomie.nl/nt15/kvk/20201209/entrypoints/kvk-rpt-jaarverantwoording-2020-nlgaap-middelgroot.xsd

langstring | nullableOptional

Specify xml:lang attribute in 'xbrl' element

Example: en

entityIdentifierstring | nullableOptional

Reporting entity identifier

Example: 12345678

entitySchemestring | nullableOptional

A scheme URI for identifying business entities

Example: http://www.kvk.nl/kvk-id

unitstring | nullableOptional

Default unit identifier. Used when no unit specified on data row level

Example: iso4217:EUR

periodstring | nullableOptional

Default reporting period as start date/end date in yyyy-MM-dd format. Used when no period specified on data row leve

Example: 2020-01-01/2020-12-31

decimalsstring | nullableOptional

Default decimals for numeric facts. Used when no decimals specified on data row level. If omitted, default is 'INF'

Example: INF

fileNamestring | nullableOptional

The name of the file.

Example: My report.xbrl

Responses

200

application/json

400

Bad Request

application/json

401

Unauthorized

post

POST /input-import/instance/generation HTTP/1.1
Host: 
Authorization: Bearer JWT
x-api-version: text
Content-Type: application/json
Accept: */*
Content-Length: 816

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

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