Introductie 

Hieronder vindt u de functionele beschrijving van de berichtsoortenservice. Ook de OpenAPI definities kunnen geraadpleegd worden. De beschrijving is ook hieronder aanwezig in PDF  

Request

De service is een REST service en als volgt aangeroepen worden: 

https://<biv-host>/filers-information/messagetypes-details

<biv-host> dient vervangen te worden door de host die gebruikt wordt voor de betreffende BIV-omgeving:

• btt-frcportaal.nl  (voor testomgeving)
• btba-frcportaal.nl  (voor acceptatieomgeving)
• btp-frcportaal.nl    (voor productieomgeving)

Om een call te maken is een header property vereist in de GET methode:

Response

De service retourneert de resultaten in JSON formaat. Omdat de inhoud van de resultaten kunnen wijzigen, is een versienummering aangebracht. 

Version 2024.1.0

• The description of the messagetype can be expected to have a value up to 2048 characters;

• The allowedReceivers are expanded with the url of an image that can be used in a UI for selecting the receiving party;

• The allowedAttachments are expanded with a boolean indicating whether attachments of this type must be signed with a detached signature.

[
    {
        "name": "Krediet",
        "description": "Krediet rapportage",
        "maximumNumberOfAttachments": 2,
        "allowedReceivers": [
            {
                "name": "Bank",
                "iconUrl": "https://www.sbrnexus.nl/content/bank1.png",
                "identityType": "ID-ontvanger",
                "identityNumber": "00000003900000010000"
            }
        ],
        "allowedEntrypoints": [
            {
                "name": "Beperkte inrichtingsjaarrekening 2019",
                "entrypoint": "https://www.sbrbanken.nl/ft14/frc/20191204/entrypoints/frc-rpt-nt-inrichtingsjaarrekening-beperkt-2019.xsd",
                "expirationDate": "2023-03-31T22:00:00Z",
                "allowedAsContent": true,
                "allowedAsAttachment": false
            }
        ],
        "allowedAttachments": [
            {
                "dataType": "XBRL",
                "minimumNumberOfAttachments": 0,
                "maximumNumberOfAttachments": 0,
                "signatureRequired": true
            },
            {
                "dataType": "XML",
                "minimumNumberOfAttachments": 0,
                "maximumNumberOfAttachments": 0,
                "signatureRequired": true
            },
            {
                "dataType": "PDF",
                "minimumNumberOfAttachments": 0,
                "maximumNumberOfAttachments": 0,
                "signatureRequired": true
            }             
		]
    },
    {
        "name": "SBV",
        "description": "SBV",
        "maximumNumberOfAttachments": 2, 
        "allowedReceivers": [], 
        "allowedEntrypoints": [], 
        "allowedAttachments": [
            {
                "dataType": "XBRL",
                "minimumNumberOfAttachments": 0,
                "maximumNumberOfAttachments": 0,
                "signatureRequired": false
            },
            {
                "dataType": "XML",
                "minimumNumberOfAttachments": 0,
                "maximumNumberOfAttachments": 0,
                "signatureRequired": false
            },
            {
                "dataType": "PDF",
                "minimumNumberOfAttachments": 0,
                "maximumNumberOfAttachments": 0,
                "signatureRequired": false
            }             
		]
    },
    {
        "name": "Jaarrekening_AV",
        "description": "Jaarrekening op ID-ontvanger met verklaring",
        "maximumNumberOfAttachments": 2, 
        "allowedReceivers": [
            {
                "naam": "Bank",
                "iconUrl": "https://www.sbrnexus.nl/content/bank1.png",
                "identiteitType": "ID-ontvanger",
                "identiteitNummer": "00000003900000010000"
            }
        ],
        "allowedEntrypoints": [
            {
                "name": "SBR jaarrekening (rechtspersonen) beperkt 2024",
                "entrypoint": "https://www.sbrnexus.nl/ft19/frc/20241211/entrypoints/frc-rpt-nt-sbr-jaarrekening-beperkt-2024.xsd",
                "expirationDate": "2030-12-30T23:00:00Z",
                "allowedAsContent": true,
                "allowedAsAttachment": false
            },
			{
				"name": "NBAT 2.1 Controleverklaring",
				"entrypoint": "http://www.nltaxonomie.nl/nba/2.1/entrypoints/nba-rpt-controleverklaring.xsd",
				"expirationDate": "2030-12-30T23:00:00Z",
				"allowedAsContent": false,
				"allowedAsAttachment": true
			}
        ],
        "allowedAttachments": [
            {
                "dataType": "XBRL",
                "minimumNumberOfAttachments": 1,
                "maximumNumberOfAttachments": 1,
                "signatureRequired": true
            },
            {
                "dataType": "XML",
                "minimumNumberOfAttachments": 1,
                "maximumNumberOfAttachments": 1,
                "signatureRequired": false
            },
            {
                "dataType": "PDF",
                "minimumNumberOfAttachments": 0,
                "maximumNumberOfAttachments": 0,
                "signatureRequired": false
            }
         ]
    }
]

Version 2020.3.1 (previous version)

The attachment information for each message type is returned with the minimum and maximum attachments per data type, including PDF.

Service description:

De OpenAPI definities van de service kun je hieronder downloaden: