Version: 1.0.0

Search by filter

Information

This API allow you to search for an business entity by filters.

This endpoint is synchronous

The role admin is needed in order to use this endpoint

Endpoints

GET/v1/config/business/entity

Query parameters

qstring - OptionalRefer to page filter

offsetnumber (int) - Optional

The "offset" parameter specifies the initial position in the result set from which the API should start retrieving data. It works together with the "limit" parameter to enable pagination. For instance, when the offset is set to 500 and the limit is set to 100, the API will skip the first 500 rows and provide the next 100 rows.

limitnumber (int) - Optional

The "limit" parameter defines the maximum number of rows to be included in the response.

Request

GET /v1/config/business/entity

bash
javascript
.NET

  curl -X 'GET'
  'https://api.ppd.iopole.fr//v1/config/business/entity/search?q=name%3A%2A&limit=50'
  -H 'accept: application/json'
  -H 'Authorization: Bearer ${TOKEN}'

    const got = require('got');
    const url = 'https://api.ppd.iopole.fr//v1/config/business/entity/search?q=name%3A%2A&limit=50';
    const token = 'your_token_here';
    (async () => {
        try {
        const response = await got(url, {
            headers: {
                    accept: 'application/json',
                    Authorization: `Bearer ${token}`,
            },
                responseType: 'json',
            });
         console.log(response.body);
        } catch (error) {
            console.error('Error:', error.message);
        }
    })();

    using System;
    using System.Net.Http;
    using System.Net.Http.Headers;
    using System.Threading.Tasks;
    class Program
    {
        static async Task Main(string[] args)
        {
        string url = "https://api.ppd.iopole.fr//v1/config/business/entity/search?q=name%3A%2A&limit=50";
        string token = "your_token_here";
        using HttpClient client = new HttpClient();
        client.DefaultRequestHeaders.Accept.Add(new MediaTypeWithQualityHeaderValue("application/json"));
        client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", token);
        try
        {
            HttpResponseMessage response = await client.GetAsync(url);
            response.EnsureSuccessStatusCode();
            string responseBody = await response.Content.ReadAsStringAsync();
            Console.WriteLine(responseBody);
        }
        catch (HttpRequestException e)
        {
            Console.WriteLine("Error: {e.Message}");
        }
    }
    }

Response

Status: 200 - application/json

Description: Retrieve list of business entity matching given criteria

Schema:

businessEntityId: string
Unique identifier for the business entity.
name: string
Name of the business entity.
country: enum
type: enum
The type of the business entity
scope: enum
Scope of the office or legal unit business entity.
identifierScheme: string
The EAS code (Endpoint Address Scheme) identifies the type of identifier used for parties in electronic invoicing
identifierValue: string
The value of the electronic address.
postalAddress: object
operatorRelation: object
identifiers: array
List of business entity identifiers.

Examples:

{
  "data": [
    {
      "businessEntityId": "01944585-4c91-7602-8def-c7072c80648d",
      "name": "HELIO PROJETS",
      "type": "OFFICE",
      "scope": "PRIMARY",
      "country": "FR",
      "identifierScheme": "0009",
      "identifierValue": "00735010100031",
      "countryIdentifier": {
        "siren": "007350101",
        "siret": "00735010100031"
      },
      "postalAddress": {
        "city": "MONTPELLIER",
        "postalCode": "34000",
        "addressLine1": "RUE EUGENE LISBONNE"
      },
      "legalUnit": {
        "businessEntityId": "01944583-ae33-7285-b62d-91737a7dcf56",
        "name": "HELIO PROJETS"
      },
      "identifiers": [
        {
          "businessEntityIdentifierId": "01944585-4c93-7598-8a39-953f8538586c",
          "type": "OFFICE_IDENTIFIER",
          "scheme": "0009",
          "value": "00735010100031"
        },
        {
          "businessEntityIdentifierId": "01944a40-1d21-767f-9045-40ae138f7cf4",
          "type": "ROUTING_CODE",
          "scheme": "0224",
          "value": "Service A",
          "postalAddress": {
            "countrySubdivision": "Herault",
            "city": "Montpellier",
            "postalCode": "34000",
            "addressLine1": "line 1",
            "addressLine2": "line 2",
            "addressLine3": "line 3"
          }
        }
      ]
    },
    {
      "businessEntityId": "01944583-aec0-70e8-96e0-6c3e5c0fadbe",
      "name": "DE COPROPRIETE",
      "type": "LEGAL_UNIT",
      "scope": "PRIVATE_TAX_PAYER",
      "country": "FR",
      "identifierScheme": "0002",
      "identifierValue": "017402504",
      "countryIdentifier": {
        "siren": "017402504",
        "siret": "017402504"
      },
      "identifiers": [
        {
          "businessEntityIdentifierId": "01944583-aec3-778f-a63e-5983a01cf3b6",
          "type": "LEGAL_IDENTIFIER",
          "scheme": "0002",
          "value": "017402504"
        }
      ]
    },
    {
      "businessEntityId": "01944acd-a412-71b9-856d-f583c74a2236",
      "name": "IOPOLE Belgique",
      "type": "LEGAL_UNIT",
      "scope": "PRIVATE_TAX_PAYER",
      "country": "BE",
      "identifierScheme": "0208",
      "identifierValue": "0114445670 (BCE)",
      "identifiers": [
        {
          "businessEntityIdentifierId": "01944acd-a431-750e-9510-d8f454b0002d",
          "type": "OFFICE_IDENTIFIER",
          "scheme": "0208",
          "value": "0114445670 (BCE)"
        }
      ]
    },
    {
      "businessEntityId": "01944583-afca-77d8-b33f-88de7bc1b258",
      "name": "COPRO *SEIZE AV D ASSAS",
      "type": "LEGAL_UNIT",
      "scope": "PRIVATE_TAX_PAYER",
      "country": "FR",
      "identifierScheme": "0002",
      "identifierValue": "017407297",
      "countryIdentifier": {
        "siren": "017407297",
        "siret": "017407297"
      },
      "identifiers": [
        {
          "businessEntityIdentifierId": "01944583-afcb-7018-ab6b-12afd2800a5d",
          "type": "LEGAL_IDENTIFIER",
          "scheme": "0002",
          "value": "017407297"
        }
      ]
    },
    {
      "businessEntityId": "01944583-af43-71ff-986c-0e1b98c8eefd",
      "name": "LE BARTHELEMY",
      "type": "LEGAL_UNIT",
      "scope": "PRIVATE_TAX_PAYER",
      "country": "FR",
      "identifierScheme": "0002",
      "identifierValue": "017403692",
      "countryIdentifier": {
        "siren": "017403692",
        "siret": "017403692"
      },
      "identifiers": [
        {
          "businessEntityIdentifierId": "01944583-af46-7406-bc16-97613ae37765",
          "type": "LEGAL_IDENTIFIER",
          "scheme": "0002",
          "value": "017403692"
        }
      ]
    },
    {
      "businessEntityId": "01944b67-4517-76df-9e56-2411eb37f2ac",
      "name": "TEST",
      "type": "LEGAL_UNIT",
      "scope": "PRIVATE_TAX_PAYER",
      "country": "BE",
      "identifierScheme": "0002",
      "identifierValue": "aazdazdazdazd",
      "identifiers": [
        {
          "businessEntityIdentifierId": "01944b67-451f-73b6-97b3-4c40ed2c6a16",
          "type": "OFFICE_IDENTIFIER",
          "scheme": "0002",
          "value": "aazdazdazdazd"
        }
      ]
    },
    {
      "businessEntityId": "01944b67-a146-7018-b65e-5bfecbafd111",
      "name": "TEST",
      "type": "LEGAL_UNIT",
      "scope": "PRIVATE_TAX_PAYER",
      "country": "BE",
      "identifierScheme": "0003",
      "identifierValue": "rrrzdazdazdazd",
      "identifiers": [
        {
          "businessEntityIdentifierId": "01944b67-a149-767d-bc91-b6fc7ae2322a",
          "type": "OFFICE_IDENTIFIER",
          "scheme": "0003",
          "value": "rrrzdazdazdazd"
        }
      ]
    },
    {
      "businessEntityId": "01944b6d-c1d1-77ed-bd36-c5f09e36364f",
      "name": "TEST",
      "type": "OFFICE",
      "scope": "PRIVATE_TAX_PAYER",
      "country": "BE",
      "identifierScheme": "0002",
      "identifierValue": "azdazdazd",
      "postalAddress": {
        "countrySubdivision": "azdazd",
        "city": "azdazd",
        "postalCode": "",
        "addressLine1": "",
        "addressLine2": "",
        "addressLine3": ""
      },
      "legalUnit": {},
      "identifiers": [
        {
          "businessEntityIdentifierId": "01944b6d-c1dd-745f-84bb-3c3cb402c287",
          "type": "OFFICE_IDENTIFIER",
          "scheme": "0002",
          "value": "azdazdazd"
        }
      ]
    },
    {
      "businessEntityId": "01944583-ae33-7285-b62d-91737a7dcf56",
      "name": "HELIO PROJETS",
      "type": "LEGAL_UNIT",
      "scope": "PRIVATE_TAX_PAYER",
      "country": "FR",
      "identifierScheme": "0002",
      "identifierValue": "007350101",
      "countryIdentifier": {
        "siren": "007350101",
        "siret": "007350101"
      },
      "identifiers": [
        {
          "businessEntityIdentifierId": "01944583-ae40-770c-bd8c-7f7f801a18b0",
          "type": "LEGAL_IDENTIFIER",
          "scheme": "0002",
          "value": "007350101"
        }
      ]
    },
    {
      "businessEntityId": "01944b6f-8532-74bf-8bfd-a75b9cb84e7c",
      "name": "TEST",
      "type": "LEGAL_UNIT",
      "scope": "PRIVATE_TAX_PAYER",
      "country": "BE",
      "identifierScheme": "0004",
      "identifierValue": "aaaa",
      "identifiers": [
        {
          "businessEntityIdentifierId": "01944b6f-8535-7726-98c6-64520c17465f",
          "type": "OFFICE_IDENTIFIER",
          "scheme": "0004",
          "value": "aaaa"
        }
      ]
    }
  ],
  "meta": {
    "offset": 0,
    "limit": 50,
    "count": 10
  }
}

Status: 401

Description: Unauthorized - Authentication is required and has failed or has not yet been provided.

Status: 403

Description: Forbidden - The server understood the request, but it refuses to authorize it. Note: This endpoint requires an admin account.