Get Entities

Edit Data of the Entity (Company) via API

GET Endpoint (all entities/companies)

  • Endpoint: Host + "/v1/einvoices/registrations"

This GET request to the specified endpoint will provide a response containing details of all companies linked to your master account such as company data, active integrations, networks, and their respective status.

Below an example where 2 companies are registered. The first has no integrations, the second has one integration. The result only contains a summary, in order to get more details see further.

{
    "Companies": [
        {
            "CompanyID": 12345678,
            "CompanyDetails": {
                "TaxIdentifier": "BE1234567890",
                "CompanyName": "Tech Corp",
                "Addresses": [],
                "TaxDeductable": true,
                "TaxLiable": true,
                "Identifiers": []
            },
            "Integrations": []
        },
        {
            "CompanyID": 987654,
            "CompanyDetails": {
                "TaxIdentifier": "BE1234567890",
                "CompanyName": "Food Corp",
                "Addresses": [],
                "TaxDeductable": true,
                "TaxLiable": true,
                "Identifiers": []
            },
            "Integrations": [
                {
                    "IntegrationID": 1234,
                    "Integration": "Peppol",
                    "IntegrationStatus": "Active",
                    "IntegrationStatusDescription": "",
                    "IntegrationDocumentToSign": ""
                }
            ]
        }
    ]
}

GET Endpoint (one entity/company)

  • Endpoint: Host + "/v1/einvoices/registrations/{registrationID}"

This GET request to the specified endpoint will provide a response containing details of 1 specific entity/company.

Example:

Example result below.

"Companies": [
        {
            "RegistrationID": 588999,
            "CompanyDetails": {
                "TaxIdentifier": "BE0454299999",
                "CompanyName": "TESTCOMPANY1,
                "Addresses": [
                    {
                        "AddressType": "InvoiceAddress"
                    },
                    {
                        "AddressType": "DeliveryAddress"
                    }
                ],
                "TaxDeductable": true,
                "TaxLiable": true,
                "Identifiers": []
            },
            "Integrations": [
                {
                    "IntegrationID": 9599,
                    "Integration": "Peppol",
                    "IntegrationStatus": "Active",
                    "IntegrationStatusDescription": "",
                    "IntegrationDocumentToSign": ""
                },
                {
                    "IntegrationID": 9599,
                    "Integration": "SDI",
                    "IntegrationStatus": "Active",
                    "IntegrationStatusDescription": "Registered",
                    "IntegrationDocumentToSign": ""
                }
            ]
        }
    ]
}