Parameters

OpenAPI V2

Retrieve taxonomy parameters by entrypoint.

get

Retrieve taxonomy parameters by entrypoint URL (SBR-NL).

Authorizations

Bearer

AuthorizationstringRequired

Please enter token

Query parameters

schemaRefstringRequired

The taxonomy entrypoint.

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.

Responses

200

OK

application/json

namestring · nullableOptional

Parameter name

Example: BasisOfPreparationParam

defaultValuestring · nullableOptional

Default value defined for the parameter.

Example: Commercieel

factstring · nullableOptional

The concept identification of the fact used to match the parameter

Example: jenv-bw2-i:BasisOfPreparation

asstring · nullableOptional

Data type of fact value

Example: QName

400

Bad Request

application/json

401

Unauthorized

get

/taxonomy/entrypoints/parameters

HTTPcURLJavaScriptPython

GET /taxonomy/entrypoints/parameters?schemaRef=text HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
x-api-version: text
Accept: */*

{
  "name": "BasisOfPreparationParam",
  "defaultValue": "Commercieel",
  "options": [
    {
      "key": "Fiscaal",
      "value": "jenv-bw2-dm:FiscalMember",
      "labels": [
        {
          "lang": "de",
          "value": "Fiskal"
        }
      ]
    }
  ],
  "fact": "jenv-bw2-i:BasisOfPreparation",
  "as": "QName"
}

Retrieve taxonomy parameters by entrypoint ID.

get

Retrieve taxonomy parameters by entrypoint ID (SBR-NL).

Authorizations

Bearer

AuthorizationstringRequired

Please enter token

Path parameters

idstringRequired

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.

Responses

200

OK

application/json

namestring · nullableOptional

Parameter name

Example: BasisOfPreparationParam

defaultValuestring · nullableOptional

Default value defined for the parameter.

Example: Commercieel

factstring · nullableOptional

The concept identification of the fact used to match the parameter

Example: jenv-bw2-i:BasisOfPreparation

asstring · nullableOptional

Data type of fact value

Example: QName

400

Bad Request

application/json

401

Unauthorized

get

/taxonomy/entrypoints/{id}/parameters

HTTPcURLJavaScriptPython

GET /taxonomy/entrypoints/{id}/parameters HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
x-api-version: text
Accept: */*

[
  {
    "name": "BasisOfPreparationParam",
    "defaultValue": "Commercieel",
    "options": [
      {
        "key": "Fiscaal",
        "value": "jenv-bw2-dm:FiscalMember",
        "labels": [
          {
            "lang": "de",
            "value": "Fiskal"
          }
        ]
      }
    ],
    "fact": "jenv-bw2-i:BasisOfPreparation",
    "as": "QName"
  }
]