Skip to main content
API docs by Redocly

Party API - Apigee (1.13.0)

Download OpenAPI specification:Download

License: Apigee

Party API documentation

Authentication & Authorization

You will need to be identified before calling any endpoints.

In order to be recognized and authorized to access our Party API, we put in place 2 mechanisms:

  • Authentication mechanism is done with a client id dedicated to you.
    Remember that the client id provided should be shared with care.
    The client id must be inserted in the header of the request in the appropriate field
  • Authorization mechanism is done by a well-known authorization flow for REST Web API: Basic auth flow.

Customers

Customers operation with all operation types

Create retail customer.

This endpoint allows to create or update a retail customer.

Authorizations:
(OAuth2ApiKeyAuth)
Request Body schema: application/json
externalRef
required
string (externalRef) <= 255 characters

External reference identifier

membership
string (membership) <= 255 characters

Membership program of the party

title
string (title) <= 255 characters

The title of the contact (e.g., Mr., Mrs., Ms.)

firstName
string (firstName) <= 255 characters

The first name of the contact

lastName
string (lastName) <= 255 characters

The last name of the contact

secondLastName
string (secondLastName) <= 255 characters

The second last name of the contact

nationalIdentificationNumber
string (nationalIdentificationNumber) <= 255 characters

The national identification number of the contact

email
string (email) <= 255 characters

The email address of the contact

phoneNumber
string (phoneNumber) <= 255 characters

The phone number of the contact

mobilePhoneNumber
string (mobilePhoneNumber) <= 255 characters

Mobile phone number of the contact

birthDate
string <date> (birthDate)

The birth date of the contact

addressLine1
string (addressLine1) <= 255 characters

The first line of the address

addressLine2
string (addressLine2) <= 255 characters

The second line of the address

addressLine3
string (addressLine3) <= 255 characters

The third line of the address

postalCode
string (postalCode) <= 255 characters

The postal code of the address

city
string (city) <= 255 characters

The city of the address

subdivision
string (subdivision) <= 255 characters

The subdivision (e.g., state, province) of the address

countryCode
required
string (countryCode) <= 255 characters

The country code of the address

active
boolean (activeWithDefault)

Active flag

object

The contact's communication preferences

object (gdpr)

GDPR consent details.

Responses

Request samples

Content type
application/json
{
  • "externalRef": "12345678",
  • "membership": "Michelin",
  • "title": "M",
  • "firstName": "John",
  • "lastName": "DOE",
  • "secondLastName": "Smith",
  • "nationalIdentificationNumber": "12345678E",
  • "email": "mail@email.com",
  • "phoneNumber": "00 001 1111111",
  • "mobilePhoneNumber": "0612345678",
  • "birthDate": "1990-10-10",
  • "addressLine1": "Neumarkter Str.",
  • "addressLine2": "address 2",
  • "addressLine3": "address 3",
  • "postalCode": "44666",
  • "city": "City",
  • "subdivision": "subdivision",
  • "countryCode": "DE",
  • "active": true,
  • "communicationChannel": {
    },
  • "gdpr": {
    }
}

Response samples

Content type
application/json
{
  • "code": "10001111",
  • "partyCode": 10001643,
  • "contractorCode": 10613678
}

List of customers for which my company is contractor

List of customers for which my company is contractor. The response is sorted by name.

Authorizations:
(OAuth2ApiKeyAuth)
query Parameters
name
required
string (CustomerNameQueryParam) [ 1 .. 100 ] characters
Example: name=Euromaster

The value contained in the customer's name

type
string (TypeEnum)
Enum: "B2B" "B2C"
Example: type=B2B

Customer's type

limit
integer <int32> (Limit100QueryParam) [ 1 .. 100 ]
Default: 100
Example: limit=2

The limit size

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Get all contacts for a customer

List of contacts of a customer for which my company is contractor Only if there is a commercial relationship with these customers for which the user's party is contractor

Authorizations:
(OAuth2ApiKeyAuth)
path Parameters
partyCode
required
integer <int64> (PartyCodeQueryParam)
Example: 1000001

Refers to a customer.

query Parameters
search
string (SearchQueryParam) [ 3 .. 255 ] characters
Example: search=doe

Search using fuzzy search. The value is searched for simultaneously in: firstname, lastname, email, phoneNumber, mobilePhoneNumber

pageNumber
integer <int32> (PageNumberQueryParam) [ 1 .. 1000 ]
Default: 1
Example: pageNumber=2

The number of page requested, minimum 1

pageSize
integer <int32> (PageSizeQueryParam) [ 1 .. 1000 ]
Default: 1000
Example: pageSize=2

The page size

lastModifiedDateFrom
string <date-time> (LastModifiedDateFromQueryParam)
Example: lastModifiedDateFrom=2024-05-02T10:00:00

Filters contacts last modified on or after this date.

lastModifiedDateTo
string <date-time> (LastModifiedDateToQueryParam)
Example: lastModifiedDateTo=2024-05-02T10:00:00

Filters contacts last modified on or before this date.

withInactive
boolean (WithInactiveQueryParam)
Default: false
Example: withInactive=true

Set to true to include inactive contacts in the results. If false (default), only active contacts will be returned.

Responses

Response samples

Content type
application/json
Example
{
  • "pagination": {
    },
  • "contacts": [
    ]
}

Create a customer's contact

Create a contact for a specific customer (only if there is a commercial relationship with this customer for which the user's party is contractor). The contact will be linked only to the party.

Authorizations:
(OAuth2ApiKeyAuth)
path Parameters
partyCode
required
integer <int64> (PartyCodeQueryParam)
Example: 1000001

Refers to a customer (code of the customer into the Customer repository)

Request Body schema: application/json
title
string (title) <= 255 characters

The title of the contact (e.g., Mr., Mrs., Ms.)

firstName
string (firstName) <= 255 characters

The first name of the contact

lastName
required
string (lastName) <= 255 characters

The last name of the contact

secondLastName
string (secondLastName) <= 255 characters

The second last name of the contact

nationalIdentificationNumber
string (nationalIdentificationNumber) <= 255 characters

The national identification number of the contact

email
string (email) <= 255 characters

The email address of the contact

phoneNumber
string (phoneNumber) <= 255 characters

The phone number of the contact

mobilePhoneNumber
string (mobilePhoneNumber) <= 255 characters

Mobile phone number of the contact

birthDate
string <date> (birthDate)

The birth date of the contact

object (GlobalCommunicationChannelDTO)

The contact's communication preferences

object (gdpr)

GDPR consent details.

Responses

Request samples

Content type
application/json

Create a contact with the given informations

{
  • "title": "Mr.",
  • "firstName": "Joe",
  • "lastName": "Doe",
  • "secondLastName": "Smith",
  • "nationalIdentificationNumber": "12345678E",
  • "email": "joe.doe@company.com",
  • "phoneNumber": "+33473345678",
  • "mobilePhoneNumber": "+33612345678",
  • "birthDate": "1990-10-10",
  • "communicationChannel": {
    },
  • "gdpr": {
    }
}

Response samples

Content type
application/json
{
  • "code": 123456,
  • "partyCode": 1000032,
  • "title": "Mr.",
  • "firstName": "Joe",
  • "lastName": "Doe",
  • "secondLastName": "Smith",
  • "nationalIdentificationNumber": "12345678E",
  • "email": "joe.doe@company.com",
  • "phoneNumber": "+33473345678",
  • "mobilePhoneNumber": "+33612345678",
  • "birthDate": "1990-10-10",
  • "active": true,
  • "communicationChannel": {
    },
  • "gdpr": {
    },
  • "lastModifiedDate": "2024-12-27T12:23:23",
  • "lastModifiedBy": "user1"
}

Retrieves the list of sites associated with the customer identified by partyCode.

Access is limited to customers related to the user's party, and appropriate permissions must be verified.

Authorizations:
(OAuth2ApiKeyAuth)
path Parameters
partyCode
required
integer <int64> (PartyCodeQueryParam)
Example: 1000001

Targeted party code

query Parameters
pageNumber
integer <int32> (PageNumberQueryParam) [ 1 .. 1000 ]
Default: 1
Example: pageNumber=2

The page number

pageSize
integer <int32> (PageSizeQueryParam) [ 1 .. 1000 ]
Default: 1000
Example: pageSize=2

The page size

name
string (CustomerNameQueryParam) [ 1 .. 100 ] characters
Example: name=Euromaster

The value contained in the customer's name

withInactive
boolean (WithInactiveQueryParam)
Default: false
Example: withInactive=true

If filled then return active and inactive parties (default false)

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "sites": [
    ]
}

Create a new site for a specific customer.

Creates a new site associated with the customer identified by partyCode. Access is limited to customers related to the user's party, and appropriate permissions must be verified.

Authorizations:
(OAuth2ApiKeyAuth)
path Parameters
partyCode
required
integer <int64> (PartyCodeQueryParam)
Example: 1000001

Refers to a customer

Request Body schema: application/json
name
required
string (name) <= 255 characters

The name

object (SiteLegalIdentifierDTO)

Legal identifier information

functionalRef
string (functionalRef) <= 255 characters

Functional reference identifier

addressLine1
string (addressLine1) <= 255 characters

The first line of the address

addressLine2
string (addressLine2) <= 255 characters

The second line of the address

addressLine3
string (addressLine3) <= 255 characters

The third line of the address

postalCode
string (postalCode) <= 255 characters

The postal code of the address

city
string (city) <= 255 characters

The city of the address

subdivision
string (subdivision) <= 255 characters

The subdivision (e.g., state, province) of the address

countryCode
string (countryCode) <= 255 characters

The country code of the address

Responses

Request samples

Content type
application/json
{
  • "name": "Euromaster Kepler",
  • "legalIdentifier": {
    },
  • "functionalRef": "B1234",
  • "addressLine1": "Industrichone",
  • "addressLine2": "2 rue Kepler",
  • "addressLine3": "address 3",
  • "postalCode": "42697",
  • "city": "Solingen",
  • "subdivision": "subdivision",
  • "countryCode": "DE"
}

Response samples

Content type
application/json
{
  • "code": 100023,
  • "partyCode": 1000032,
  • "functionalRef": "B1234",
  • "active": true,
  • "name": "Euromaster Kepler",
  • "legalIdentifier": {
    },
  • "addressLine1": "Industrichone",
  • "addressLine2": "address 2",
  • "addressLine3": "address 3",
  • "postalCode": "42697",
  • "city": "Solingen",
  • "subdivision": "subdivision",
  • "countryCode": "DE",
  • "lastModifiedDate": "2024-12-27T12:23:23",
  • "lastModifiedBy": "user1"
}

Get my customers sites

Retrieve all my customers sites with pagination and filters. This endpoint returns sites of all customers linked to the current user.

Authorizations:
(OAuth2ApiKeyAuth)
query Parameters
pageNumber
integer <int32> (PageNumberQueryParam) [ 1 .. 1000 ]
Default: 1
Example: pageNumber=2

The page number

pageSize
integer <int32> (PageSizeQueryParam) [ 1 .. 1000 ]
Default: 1000
Example: pageSize=2

The page size

lastModifiedDateFrom
string <date-time> (LastModifiedDateFromQueryParam)
Example: lastModifiedDateFrom=2024-05-02T10:00:00

Filters sites last modified on or after this date. Supports 'YYYY-MM-DDThh:mm:hh' format.

lastModifiedDateTo
string <date-time> (LastModifiedDateToQueryParam)
Example: lastModifiedDateTo=2024-05-02T10:00:00

Filters sites last modified on or before this date. Supports 'YYYY-MM-DDThh:mm:hh' format.

externalRef
string (CustomerSiteExternalRefQueryParam) <= 255 characters
Example: externalRef=E0919590

Identifier of the site in the external source application

siret
string (siret) <= 255 characters
Example: siret=36252187900034

SIRET number of the company

type
string (TypeEnum)
Enum: "B2B" "B2C"
Example: type=B2B

Customer's type

withExternalRef
boolean (WithExternalRefQueryParam)
Default: false
Example: withExternalRef=true

Set to true to include external reference.

withInactive
boolean (WithInactiveQueryParam)
Default: false
Example: withInactive=true

Set to true to include inactive or expired sites in the results. If false (default), only active sites will be returned.

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "sites": [
    ]
}

Create, update of a customer from an external source

Authorizations:
(OAuth2ApiKeyAuth)
Request Body schema: application/json
externalRef
required
string (externalRef) <= 255 characters

External reference identifier

name
string (name) <= 255 characters

The name

functionalRef
string (functionalRef) <= 255 characters

Functional reference identifier

type
required
string (TypeEnum)
Enum: "B2B" "B2C"

The type of the party

active
boolean (activeWithDefault)

Active flag

consolidationReference
string (consolidationReference) <= 255 characters

Indicates the reference of the national party (if exists)

object (PartyLegalIdentifierDTO)

Legal identifier information

Responses

Request samples

Content type
application/json

Create a customer with the given informations

{
  • "externalRef": "PTY123",
  • "name": "EUROMASTER SERVICE ET MANAGEMENT",
  • "functionalRef": "B60406111",
  • "type": "B2B",
  • "active": true,
  • "consolidationReference": "102873",
  • "legalIdentifier": {
    }
}

Response samples

Content type
application/json
{
  • "code": 100001
}

List of customers for which my company is contractor

List of customers for which my company is contractor.

Authorizations:
(OAuth2ApiKeyAuth)
query Parameters
lastModifiedDateFrom
string <date-time> (LastModifiedDateFromQueryParam)
Example: lastModifiedDateFrom=2024-05-02T10:00:00

Date from for last update date of data

lastModifiedDateTo
string <date-time> (LastModifiedDateToQueryParam)
Example: lastModifiedDateTo=2024-05-02T10:00:00

Date to for last update date of data

pageNumber
integer <int32> (PageNumberQueryParam) [ 1 .. 1000 ]
Default: 1
Example: pageNumber=2

The page number

pageSize
integer <int32> (PageSizeQueryParam) [ 1 .. 1000 ]
Default: 1000
Example: pageSize=2

The page size

type
string (TypeEnum)
Enum: "B2B" "B2C"
Example: type=B2B

Customer's type

withExternalRef
boolean (WithExternalRefQueryParam)
Default: false
Example: withExternalRef=true

Set to true to include external reference.

withInactive
boolean (WithInactiveQueryParam)
Default: false
Example: withInactive=true

Set to true to include inactive or expired contacts in the results. If false (default), only active contacts will be returned

email
Array of strings (email) <= 100 items [ items <= 255 characters ]
Example: email=mail@email.com

List of emails separated by , (Max:100)

mobilePhoneNumber
Array of strings (mobilePhoneNumber) <= 100 items [ items <= 255 characters ]
Example: mobilePhoneNumber=0101010101

List of Mobile Phone Number separated by , (Max:100) - E.164 format

phoneNumber
Array of strings (phoneNumber) <= 100 items [ items <= 255 characters ]
Example: phoneNumber=00 001 1111111

List of phone numbers separated by , (Max:100) - E.164 format

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "contacts": [
    ]
}

Create site data for a customer

Create or update a site associated for the identified customer and from an external source.

Authorizations:
(OAuth2ApiKeyAuth)
path Parameters
partyCode
required
integer <int64> (PartyCodeQueryParam)
Example: 1000001

Targeted party code

Request Body schema: application/json
externalRef
required
string (externalRef) <= 255 characters

External reference identifier

name
required
string (name) <= 255 characters

The name

object (SiteLegalIdentifierDTO)

Legal identifier information

functionalRef
string (functionalRef) <= 255 characters

Functional reference identifier

active
boolean (activeWithDefault)

Active flag

addressLine1
string (addressLine1) <= 255 characters

The first line of the address

addressLine2
string (addressLine2) <= 255 characters

The second line of the address

addressLine3
string (addressLine3) <= 255 characters

The third line of the address

postalCode
string (postalCode) <= 255 characters

The postal code of the address

city
string (city) <= 255 characters

The city of the address

subdivision
string (subdivision) <= 255 characters

The subdivision (e.g., state, province) of the address

countryCode
string (countryCode) <= 255 characters

The country code of the address

communicationLanguage
string (communicationLanguage) = 2 characters

The preferred communication language for the customer

object (SiteBillToDTO)

Bill To information

Responses

Request samples

Content type
application/json

Create a site with the given information

{
  • "externalRef": "CTC123",
  • "name": "Euromaster Kepler",
  • "legalIdentifier": {
    },
  • "functionalRef": "B",
  • "active": true,
  • "addressLine1": "123 Main St Apt 4B",
  • "addressLine2": "Anytown, CA 90210",
  • "addressLine3": "USA",
  • "postalCode": "90210",
  • "city": "Anytown",
  • "subdivision": "subdivision",
  • "countryCode": "FR",
  • "communicationLanguage": "fr",
  • "billToAttributes": {
    }
}

Response samples

Content type
application/json
{
  • "code": 10001111
}

Create a POS for a specific customer from an external reference.

Create a POS for a specific customer from an external reference.

Authorizations:
(OAuth2ApiKeyAuth)
path Parameters
customerExternalRef
required
string (externalRef) <= 255 characters
Example: 12345678

Targeted customer external reference

Request Body schema: application/json
externalRef
required
string (externalRef) <= 255 characters

External reference identifier

name
required
string (name) <= 255 characters

The name

alias
string (alias) <= 255 characters

POS alias name used for communication

object (SiteLegalIdentifierDTO)

Legal identifier information

functionalRef
string (functionalRef) <= 255 characters

Functional reference identifier

active
boolean (active)

Active flag

addressLine1
string (addressLine1) <= 255 characters

The first line of the address

addressLine2
string (addressLine2) <= 255 characters

The second line of the address

addressLine3
string (addressLine3) <= 255 characters

The third line of the address

postalCode
string (postalCode) <= 255 characters

The postal code of the address

city
string (city) <= 255 characters

The city of the address

subdivision
string (subdivision) <= 255 characters

The subdivision (e.g., state, province) of the address

countryCode
string (countryCode) <= 255 characters

The country code of the address

object (GeolocationDTO)

Geographic coordinates of the Point of Sale, used for mapping and proximity searches.

phoneNumber
string (phoneNumber) <= 255 characters

The phone number of the contact

email
string (email) <= 255 characters

The email address of the contact

url
string (url) <= 255 characters

URL of the site's web page

Responses

Request samples

Content type
application/json

Create a point of sale with the given information

{
  • "externalRef": "CTC123",
  • "name": "Euromaster Kepler",
  • "alias": "Kepler Tyres",
  • "legalIdentifier": {
    },
  • "functionalRef": "B",
  • "active": true,
  • "addressLine1": "123 Main St Apt 4B",
  • "addressLine2": "Anytown, CA 90210",
  • "addressLine3": "USA",
  • "postalCode": "90210",
  • "city": "Anytown",
  • "subdivision": "subdivision",
  • "countryCode": "FR",
  • "geolocation": {
    },
  • "phoneNumber": "+33123456789",
  • "email": "contact@euromaster-kepler.fr",
  • "url": "https://www.mysite.com/kepler"
}

Response samples

Content type
application/json
{
  • "code": 10001111
}

UPSERT - Post an external contact for an existing customer

Create a contact associated to a customer from an external application, only for batch usage

Authorizations:
(OAuth2ApiKeyAuth)
path Parameters
customerExternalRef
required
string (externalRef) <= 255 characters
Example: 12345678

Party related to the new contact

Request Body schema: application/json
title
string (title) <= 255 characters

The title of the contact (e.g., Mr., Mrs., Ms.)

firstName
string (firstName) <= 255 characters

The first name of the contact

lastName
string (lastName) <= 255 characters

The last name of the contact

secondLastName
string (secondLastName) <= 255 characters

The second last name of the contact

nationalIdentificationNumber
string (nationalIdentificationNumber) <= 255 characters

The national identification number of the contact

email
string (email) <= 255 characters

The email address of the contact

phoneNumber
string (phoneNumber) <= 255 characters

The phone number of the contact

mobilePhoneNumber
string (mobilePhoneNumber) <= 255 characters

Mobile phone number of the contact

birthDate
string <date> (birthDate)

The birth date of the contact

object (GlobalCommunicationChannelDTO)

The contact's communication preferences

object (gdpr)

GDPR consent details.

externalRef
required
string (externalRef) <= 255 characters

External reference identifier

active
boolean (active)

Active flag

Array of objects (siteAssignment) <= 1000 items

Responses

Request samples

Content type
application/json

Create a contact associated to a customer from an external application only for batch usage

{
  • "externalRef": "CTC123",
  • "title": "Mr",
  • "firstName": "Firstname",
  • "lastName": "Lastname",
  • "secondLastName": "SecondLastName",
  • "nationalIdentificationNumber": "12345678E",
  • "email": "firstname.lastname@company.com",
  • "phoneNumber": "+33473345678",
  • "mobilePhoneNumber": "+33612345678",
  • "birthDate": "1970-01-01",
  • "active": true,
  • "communicationChannel": {
    },
  • "gdpr": {
    },
  • "sitesAssignment": [
    ]
}

Response samples

Content type
application/json
{
  • "code": 10001111
}

Specific export for eInvoicing exporting a full of customers to be loaded in Esker

Specific export for eInvoicing exporting a full of customers to be loaded in Esker. Returns a list of customers for which the user's company is assigned as Contractor

Authorizations:
(OAuth2ApiKeyAuth)

Responses

Response samples

Content type
text/csv
"billToSiteExternalRef";"billToSiteName";"customerSiren";"customerVatNumber";"billToSiteSiret";"billToSiteAddressLine1";"billToSiteAddressLine2";"billToSiteAddressLine3";"billToSitePostalCode";"billToSiteCity";"billToSiteSubdivision";"billToSiteCountryCode";"billToSiteCountry";"billToSiteCommunicationLanguage";"subscriptionCommercialContactMail";"subscriptionSupportMail";"subscriptionCustomerSizeTypology";"subscriptionCustomerMarketTypology";"creditProfileTotalRiskAmount";"creditProfileRiskClass";"creditProfileDunningGroup";"creditProfileSessionCode";"creditProfileBillToContactMail";"creditProfileBillToContactPhoneNumber";"creditProfileCreditManagerContactMail"

Specific export for eInvoicing exporting a full of contacts to be loaded in Esker

Specific export for eInvoicing exporting a full of contacts to be loaded in Esker. Returns a list of contacts for which the user's company is assigned as Contractor

Authorizations:
(OAuth2ApiKeyAuth)

Responses

Response samples

Content type
text/csv
"billToSiteExternalRef";"billToSiteName";"billToSiteBillingEmail";"billToSiteDunningEmail";"billToSiteInvoiceChannel";"billToSiteAddressLine1";"billToSiteAddressLine2";"billToSiteAddressLine3";"billToSitePostalCode";"billToSiteCity";"billToSiteSubdivision";"billToSiteCountryCode";"billToSiteCountry";"billToSiteCommunicationLanguage"

Get customers

Retrieve a list of customers for which my company is assign as Contractor (only if there is a commercial relationship with these customers for which my party is contractor)

Authorizations:
(OAuth2ApiKeyAuth)
query Parameters
pageNumber
integer <int32> (PageNumberQueryParam) [ 1 .. 1000 ]
Default: 1
Example: pageNumber=2

The page number

pageSize
integer <int32> (PageSizeQueryParam) [ 1 .. 1000 ]
Default: 1000
Example: pageSize=2

The page size

lastModifiedDateFrom
string <date-time> (LastModifiedDateFromQueryParam)
Example: lastModifiedDateFrom=2024-05-02T10:00:00

Filters parties last modified on or after this date. Supports 'YYYY-MM-DDThh:mm:hh' format.

lastModifiedDateTo
string <date-time> (LastModifiedDateToQueryParam)
Example: lastModifiedDateTo=2024-05-02T10:00:00

Filters parties last modified on or before this date. Supports 'YYYY-MM-DDThh:mm:hh' format.

codes
Array of integers <int64> (PartyCodeListQueryParameter) [ 1 .. 100 ] items [ items <int64 > ]
Example: codes=123,234

List of party code

externalRef
Array of strings (ExternalRefListQueryParam) [ 1 .. 100 ] items [ items <= 255 characters ]
Example: externalRef=1000045,1000046

List of external reference of parties

name
string (CustomerNameQueryParam) [ 1 .. 100 ] characters
Example: name=Euromaster

The value contained in the party's name

type
string (TypeEnum)
Enum: "B2B" "B2C"
Example: type=B2B

Type of party

withExternalRef
boolean (WithExternalRefQueryParam)
Default: false
Example: withExternalRef=true

If filled then return external references for each party (default false)

withInactive
boolean (WithInactiveQueryParam)
Default: false
Example: withInactive=true

If filled then return active and inactive parties (default false)

siren
string (siren) <= 255 characters ^\d{9}$
Example: siren=824393151

SIREN number of the company

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "customers": [
    ]
}

Creation of a customer. The commercial relationship will be created at the same time with the users'party as contractor

Authorizations:
(OAuth2ApiKeyAuth)
Request Body schema: application/json
name
required
string (name) <= 255 characters

The name

functionalRef
string (functionalRef) <= 255 characters

Functional reference identifier

type
required
string (TypeEnum)
Enum: "B2B" "B2C"

The type of the party

membership
string (membership) <= 255 characters

Membership program of the party

object (PartyLegalIdentifierDTO)

Legal identifier information

Responses

Request samples

Content type
application/json

Create a customer. The commercial relationship will be created at the same time with the users'party as contractor

{
  • "name": "EUROMASTER SERVICE ET MANAGEMENT",
  • "functionalRef": "B60406111",
  • "type": "B2B",
  • "membership": "Association Charade",
  • "legalIdentifier": {
    }
}

Response samples

Content type
application/json
{
  • "code": 100001,
  • "name": "EUROMASTER SERVICE ET MANAGEMENT",
  • "functionalRef": "B60406111",
  • "type": "B2B",
  • "active": true,
  • "membership": "Association Charade",
  • "legalIdentifier": {
    },
  • "lastModifiedDate": "2024-12-27T12:23:23",
  • "lastModifiedBy": "user1"
}

Partially updates the details of a customer identified by code, for which my company is assigned as contractor. Only the fields provided in the request body will be updated. Authorization is required.

Authorizations:
(OAuth2ApiKeyAuth)
path Parameters
partyCode
required
integer <int64> (PartyCodeQueryParam)
Example: 1000001

Targeted party code

Request Body schema: application/json
name
string (name) <= 255 characters

The name

functionalRef
string (functionalRef) <= 255 characters

Functional reference identifier

type
string (TypeEnum)
Enum: "B2B" "B2C"

The type of the party

membership
string (membership) <= 255 characters

Membership program of the party

object (PartyLegalIdentifierDTO)

Legal identifier information

Responses

Request samples

Content type
application/json

Update a customer

{
  • "name": "EUROMASTER SERVICE ET MANAGEMENT",
  • "functionalRef": "B60406111",
  • "type": "B2B",
  • "membership": "Association Charade",
  • "legalIdentifier": {
    }
}

Response samples

Content type
application/json
{
  • "code": 100001,
  • "name": "EUROMASTER SERVICE ET MANAGEMENT",
  • "functionalRef": "B60406111",
  • "type": "B2B",
  • "active": true,
  • "membership": "Association Charade",
  • "legalIdentifier": {
    },
  • "lastModifiedDate": "2024-12-27T12:23:23",
  • "lastModifiedBy": "user1"
}

Get a customer for which my company is assign as contractor. Authorization is required.

Authorizations:
(OAuth2ApiKeyAuth)
path Parameters
partyCode
required
integer <int64> (PartyCodeQueryParam)
Example: 1000001

Targeted party code

Responses

Response samples

Content type
application/json
{
  • "code": 100001,
  • "name": "EUROMASTER SERVICE ET MANAGEMENT",
  • "functionalRef": "B60406111",
  • "type": "B2B",
  • "active": true,
  • "membership": "Association Charade",
  • "legalIdentifier": {
    },
  • "lastModifiedDate": "2024-12-27T12:23:23",
  • "lastModifiedBy": "user1"
}

Update a specific site of a customer

Updates detailed information about the site identified by code belonging to the customer identified by partyCode. Access is limited to customers related to the user's party, and appropriate permissions must be verified. This PUT functions like a PATCH (partial update is possible).

Authorizations:
(OAuth2ApiKeyAuth)
path Parameters
partyCode
required
integer <int64> (PartyCodeQueryParam)
Example: 1000001

Targeted party code

siteCode
required
integer <int64> (siteCode)
Example: 1000032

Targeted site code

Request Body schema: application/json
name
string (name) <= 255 characters

The name

object (SiteLegalIdentifierDTO)

Legal identifier information

functionalRef
string (functionalRef) <= 255 characters

Functional reference identifier

addressLine1
string (addressLine1) <= 255 characters

The first line of the address

addressLine2
string (addressLine2) <= 255 characters

The second line of the address

addressLine3
string (addressLine3) <= 255 characters

The third line of the address

postalCode
string (postalCode) <= 255 characters

The postal code of the address

city
string (city) <= 255 characters

The city of the address

subdivision
string (subdivision) <= 255 characters

The subdivision (e.g., state, province) of the address

countryCode
string (countryCode) <= 255 characters

The country code of the address

Responses

Request samples

Content type
application/json

Updates detailed information about the site identified by code belonging to the customer identified by partyCode.

{
  • "name": "Euromaster Kepler",
  • "legalIdentifier": {
    },
  • "functionalRef": "B",
  • "addressLine1": "123 Main St Apt 4B",
  • "addressLine2": "Anytown, CA 90210",
  • "addressLine3": "USA",
  • "postalCode": "90210",
  • "city": "Anytown",
  • "subdivision": "subdivision",
  • "countryCode": "US"
}

Response samples

Content type
application/json
{
  • "site": {
    }
}

Get a specific site of a customer

Retrieves detailed information about the site identified by code belonging to the customer identified by partyCode. Access is limited to customers related to the user's party, and appropriate permissions must be verified.

Authorizations:
(OAuth2ApiKeyAuth)
path Parameters
partyCode
required
integer <int64> (PartyCodeQueryParam)
Example: 1000001

Targeted party code

siteCode
required
integer <int64> (siteCode)
Example: 1000032

Targeted site code

Responses

Response samples

Content type
application/json

Retrieves detailed information about the site identified by code belonging to the customer identified by partyCode.

{
  • "site": {
    }
}

Parties

Parties operation with all operation types

Get parties data

Get parties data filtered by parameters

Authorizations:
(OAuth2ApiKeyAuth)
query Parameters
pageNumber
integer <int32> (PageNumberQueryParam) [ 1 .. 1000 ]
Default: 1
Example: pageNumber=2

The page number

pageSize
integer <int32> (PageSizeQueryParam) [ 1 .. 1000 ]
Default: 1000
Example: pageSize=2

The page size

lastModifiedDateFrom
string <date-time> (LastModifiedDateFromQueryParam)
Example: lastModifiedDateFrom=2024-05-02T10:00:00

Date from for last update date of data

lastModifiedDateTo
string <date-time> (LastModifiedDateToQueryParam)
Example: lastModifiedDateTo=2024-05-02T10:00:00

Date to for last update date of data

externalRef
string (externalRef) <= 255 characters
Example: externalRef=12345678

external ref of the party

source
string (source) <= 255 characters
Example: source=GENES

source of the party

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "parties": [
    ]
}

Get a party with extended information

Get a party with extended information by party code

Authorizations:
(OAuth2ApiKeyAuth)
path Parameters
partyCode
required
integer <int64> (PartyCodeQueryParam)
Example: 1000001

Targeted party code

Responses

Response samples

Content type
application/json
{
  • "code": 100001,
  • "name": "EUROMASTER SERVICE ET MANAGEMENT",
  • "functionalRef": "B60406111",
  • "type": "B2B",
  • "active": true,
  • "membership": "Association Charade",
  • "legalIdentifier": {
    },
  • "contacts": [
    ],
  • "sites": [
    ],
  • "references": [
    ],
  • "lastModifiedDate": "2025-07-10T14:30:00",
  • "lastModifiedBy": "user1"
}

Create party data

Create party external

Authorizations:
(OAuth2ApiKeyAuth)
Request Body schema: application/json
externalRef
required
string (externalRef) <= 255 characters

External reference identifier

functionalRef
string (functionalRef) <= 255 characters

Functional reference identifier

type
required
string (TypeEnum)
Enum: "B2B" "B2C"

The type of the party

name
string (name) <= 255 characters

The name

active
boolean (active)

Active flag

object (PartyLegalIdentifierDTO)

Legal identifier information

Responses

Request samples

Content type
application/json

Create a party with the given informations

{
  • "externalRef": "YEIZR",
  • "functionalRef": "B1234",
  • "type": "B2B",
  • "name": "TRANSPORT NICOLAS",
  • "active": true,
  • "legalIdentifier": {
    }
}

Response samples

Content type
application/json
{
  • "code": 10001111
}

Quick search parties data

Quick search parties data (name and code) filtered by parameters

Authorizations:
(OAuth2ApiKeyAuth)
query Parameters
value
required
string (ValueQueryParam) [ 1 .. 255 ] characters
Example: value=Transp

The value contained in the party's name

limit
integer <int32> (LimitQueryParam) [ 1 .. 1000 ]
Default: 100
Example: limit=2

The limit size

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Create a party.

This endpoint allows to create a party.

Authorizations:
(OAuth2ApiKeyAuth)
Request Body schema: application/json
functionalRef
string (functionalRef) <= 255 characters

Functional reference identifier

type
required
string (TypeEnum)
Enum: "B2B" "B2C"

The type of the party

name
string (name) <= 255 characters

The name

Responses

Request samples

Content type
application/json
{
  • "functionalRef": "B1234",
  • "type": "B2B",
  • "name": "TRANSPORT NICOLAS"
}

Response samples

Content type
application/json
{
  • "code": 100001,
  • "functionalRef": "B1234",
  • "type": "B2B",
  • "active": true,
  • "name": "TRANSPORT NICOLAS",
  • "lastModifiedDate": "2024-12-27T12:23:23"
}

Get parties data

Get parties data filtered by parameters

Authorizations:
(OAuth2ApiKeyAuth)
query Parameters
pageNumber
integer <int32> (PageNumberQueryParam) [ 1 .. 1000 ]
Default: 1
Example: pageNumber=2

The page number

pageSize
integer <int32> (PageSizeQueryParam) [ 1 .. 1000 ]
Default: 1000
Example: pageSize=2

The page size

lastModifiedDateFrom
string <date-time> (LastModifiedDateFromQueryParam)
Example: lastModifiedDateFrom=2024-05-02T10:00:00

Date from for last update date of data

lastModifiedDateTo
string <date-time> (LastModifiedDateToQueryParam)
Example: lastModifiedDateTo=2024-05-02T10:00:00

Date to for last update date of data

functionalRef
string (functionalRef) <= 255 characters
Example: functionalRef=B1234

Functional reference

type
string (TypeEnum)
Enum: "B2B" "B2C"
Example: type=B2B

Type of parties

withInactive
boolean (WithInactiveQueryParam)
Default: false
Example: withInactive=true

If filled then return active and inactive parties (default false)

withExternalRef
boolean (WithExternalRefQueryParam)
Default: false
Example: withExternalRef=true

If filled then return external references for each party (default false)

codes
Array of integers <int64> (PartyCodeListQueryParameter) [ 1 .. 100 ] items [ items <int64 > ]
Example: codes=123,234

List of party code

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "parties": [
    ]
}

Get a party

Retrieve a party by his code

Authorizations:
(OAuth2ApiKeyAuth)
path Parameters
partyCode
required
integer <int64> (PartyCodeQueryParam)
Example: 1000001

Targeted party code

Responses

Response samples

Content type
application/json
{
  • "code": 1020202,
  • "name": "SARL BTP PRADELS",
  • "functionalRef": "B1234",
  • "type": "B2B",
  • "active": true,
  • "membership": "Association Charade",
  • "legalIdentifier": {
    },
  • "lastModifiedDate": "2024-12-27T12:23:23",
  • "lastModifiedBy": "user1"
}

Update a party

Update a party by his code

Authorizations:
(OAuth2ApiKeyAuth)
path Parameters
partyCode
required
integer <int64> (PartyCodeQueryParam)
Example: 1000001

Targeted party code

Request Body schema: application/json
functionalRef
string (functionalRef) <= 255 characters

Functional reference identifier

type
required
string (TypeEnum)
Enum: "B2B" "B2C"

The type of the party

name
string (name) <= 255 characters

The name

Responses

Request samples

Content type
application/json
{
  • "functionalRef": "B1234",
  • "type": "B2B",
  • "name": "TRANSPORT NICOLAS"
}

Response samples

Content type
application/json
{
  • "code": 100001,
  • "functionalRef": "B1234",
  • "type": "B2B",
  • "active": true,
  • "name": "TRANSPORT NICOLAS",
  • "lastModifiedDate": "2024-12-27T12:23:23"
}

Delete a party

Update a party to set his active attribute to false

Authorizations:
(OAuth2ApiKeyAuth)
path Parameters
partyCode
required
integer <int64> (PartyCodeQueryParam)
Example: 1000001

Targeted party code

Responses

Response samples

Content type
application/json
Example
{
  • "errors": [
    ]
}

Get sites for a party

Retrieve sites by party code

Authorizations:
(OAuth2ApiKeyAuth)
path Parameters
partyCode
required
integer <int64> (PartyCodeQueryParam)
Example: 1000001

Targeted party code

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Add bank account

Add bank account by party code

Authorizations:
(OAuth2ApiKeyAuth)
path Parameters
partyCode
required
integer <int64> (PartyCodeQueryParam)
Example: 1000001

Targeted party code

Request Body schema: application/json
owner
string (owner) <= 255 characters

Owner of the bank account

bankName
string (bankName) <= 255 characters

Name of the bank

bankKey
string (bankKey) <= 255 characters

Key of the bank

countryCode
string (countryCode) <= 255 characters

The country code of the address

number
string (bankAccountNumber) <= 255 characters

Number of the bank account

iban
string (iban) <= 255 characters

International Bank Account Number

controlKey
string (controlKey) <= 255 characters

Key to validate or identify the account

bic
string (bic) <= 255 characters

Code to identify the bank

Responses

Request samples

Content type
application/json

Create a bank account with the given informations

{
  • "owner": "John Doe",
  • "bankName": "Bank",
  • "bankKey": "1234",
  • "countryCode": "FR",
  • "number": "123456789",
  • "iban": "FR123456789",
  • "controlKey": "1234",
  • "bic": "BANK000FR"
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Get bank account

Get bank account by party code

Authorizations:
(OAuth2ApiKeyAuth)
path Parameters
partyCode
required
integer <int64> (PartyCodeQueryParam)
Example: 1000001

Targeted party code

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Delete a bank account

Delete a bank account based on the IBAN

Authorizations:
(OAuth2ApiKeyAuth)
path Parameters
partyCode
required
integer <int64> (PartyCodeQueryParam)
Example: 1000001

Targeted party code

iban
required
string (iban) <= 255 characters
Example: FR123456789

IBAN of the bank account to delete

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Create a commercial relationship between the party and the party assigned to the authenticated user

Create a commercial relationship between the party and the party assigned to the authenticated user

Authorizations:
(OAuth2ApiKeyAuth)
path Parameters
partyCode
required
integer <int64> (PartyCodeQueryParam)
Example: 1000001

Targeted party code

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Get a party

Retrieve a party by its okta token

Authorizations:
(OAuth2ApiKeyAuth)

Responses

Response samples

Content type
application/json
{
  • "code": 1020202,
  • "name": "SARL BTP PRADELS",
  • "functionalRef": "B1234",
  • "type": "B2B",
  • "active": true,
  • "membership": "Association Charade",
  • "legalIdentifier": {
    },
  • "lastModifiedDate": "2024-12-27T12:23:23",
  • "lastModifiedBy": "user1"
}

Get sites for the current user

Retrieve sites by party of the current user

Authorizations:
(OAuth2ApiKeyAuth)
query Parameters
pageNumber
integer <int32> (PageNumberQueryParam) [ 1 .. 1000 ]
Default: 1
Example: pageNumber=2

The page number

pageSize
integer <int32> (PageSizeQueryParam) [ 1 .. 1000 ]
Default: 1000
Example: pageSize=2

The page size

name
string (name) <= 255 characters
Example: name=Euromaster Kepler

Name of the site, search string using a like

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "sites": [
    ]
}

Get a site by external reference for the current user

Retrieve a site by external reference for the party of the current user

Authorizations:
(OAuth2ApiKeyAuth)
path Parameters
externalRef
required
string (externalRef) <= 255 characters
Example: 12345678

External reference of the site

Responses

Response samples

Content type
application/json
{
  • "code": 100023,
  • "partyCode": 1000032,
  • "functionalRef": "B1234",
  • "active": true,
  • "name": "Euromaster Kepler",
  • "addressLine1": "Industrichone",
  • "addressLine2": "address 2",
  • "addressLine3": "address 3",
  • "postalCode": "42697",
  • "city": "Solingen",
  • "subdivision": "subdivision",
  • "countryCode": "DE",
  • "lastModifiedDate": "2024-12-27T12:23:23",
  • "references": [
    ]
}

Returns a list of users associated with the current authenticated user's party

This endpoint allows filtering, sorting, and pagination depending on implementation. It is typically used to retrieve all users belonging to my party for administrative or integration purposes. Proper authorization is required to access my party’s user list.

Authorizations:
(OAuth2ApiKeyAuth)
query Parameters
pageNumber
integer <int32> (PageNumberQueryParam) [ 1 .. 1000 ]
Default: 1
Example: pageNumber=2

The page number

pageSize
integer <int32> (PageSizeQueryParam) [ 1 .. 1000 ]
Default: 1000
Example: pageSize=2

The page size

withInactive
boolean (WithInactiveQueryParam)
Default: false
Example: withInactive=true

Include inactive users

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "users": [
    ]
}

Get contacts for the current user

Retrieve contacts by party of the current user

Authorizations:
(OAuth2ApiKeyAuth)
query Parameters
pageNumber
integer <int32> (PageNumberQueryParam) [ 1 .. 1000 ]
Default: 1
Example: pageNumber=2

The page number

pageSize
integer <int32> (PageSizeQueryParam) [ 1 .. 1000 ]
Default: 1000
Example: pageSize=2

The page size

lastModifiedDateFrom
string <date-time> (LastModifiedDateFromQueryParam)
Example: lastModifiedDateFrom=2024-05-02T10:00:00

Date from for last update date of data

lastModifiedDateTo
string <date-time> (LastModifiedDateToQueryParam)
Example: lastModifiedDateTo=2024-05-02T10:00:00

Date to for last update date of data

withExternalRef
boolean (WithExternalRefQueryParam)
Default: false
Example: withExternalRef=true

Set to true to include external reference.

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "contacts": [
    ]
}

Create a contact belonging to my party

Create, update or delete a contact belonging to my party from an external application

Authorizations:
(OAuth2ApiKeyAuth)
Request Body schema: application/json
title
string (title) <= 255 characters

The title of the contact (e.g., Mr., Mrs., Ms.)

firstName
string (firstName) <= 255 characters

The first name of the contact

lastName
string (lastName) <= 255 characters

The last name of the contact

secondLastName
string (secondLastName) <= 255 characters

The second last name of the contact

nationalIdentificationNumber
string (nationalIdentificationNumber) <= 255 characters

The national identification number of the contact

email
string (email) <= 255 characters

The email address of the contact

phoneNumber
string (phoneNumber) <= 255 characters

The phone number of the contact

mobilePhoneNumber
string (mobilePhoneNumber) <= 255 characters

Mobile phone number of the contact

birthDate
string <date> (birthDate)

The birth date of the contact

object (GlobalCommunicationChannelDTO)

The contact's communication preferences

object (gdpr)

GDPR consent details.

externalRef
required
string (externalRef) <= 255 characters

External reference identifier

active
boolean (active)

Active flag

Array of objects (siteAssignment) <= 1000 items

Responses

Request samples

Content type
application/json

Create a contact with the given informations

{
  • "externalRef": "CTC123",
  • "title": "Mr",
  • "firstName": "Firstname",
  • "lastName": "Lastname",
  • "secondLastName": "SecondLastName",
  • "nationalIdentificationNumber": "12345678E",
  • "email": "firstname.lastname@company.com",
  • "phoneNumber": "+33473345678",
  • "mobilePhoneNumber": "+33612345678",
  • "birthDate": "1970-01-01",
  • "active": true,
  • "communicationChannel": {
    },
  • "gdpr": {
    }
}

Response samples

Content type
application/json
{
  • "code": 10001111
}

Create or update a POS for my party.

Create or update a POS for my party.

Authorizations:
(OAuth2ApiKeyAuth)
Request Body schema: application/json
externalRef
required
string (externalRef) <= 255 characters

External reference identifier

name
required
string (name) <= 255 characters

The name

alias
string (alias) <= 255 characters

POS alias name used for communication

object (SiteLegalIdentifierDTO)

Legal identifier information

functionalRef
string (functionalRef) <= 255 characters

Functional reference identifier

active
boolean (active)

Active flag

addressLine1
string (addressLine1) <= 255 characters

The first line of the address

addressLine2
string (addressLine2) <= 255 characters

The second line of the address

addressLine3
string (addressLine3) <= 255 characters

The third line of the address

postalCode
string (postalCode) <= 255 characters

The postal code of the address

city
string (city) <= 255 characters

The city of the address

subdivision
string (subdivision) <= 255 characters

The subdivision (e.g., state, province) of the address

countryCode
string (countryCode) <= 255 characters

The country code of the address

object (GeolocationDTO)

Geographic coordinates of the Point of Sale, used for mapping and proximity searches.

phoneNumber
string (phoneNumber) <= 255 characters

The phone number of the contact

email
string (email) <= 255 characters

The email address of the contact

url
string (url) <= 255 characters

URL of the site's web page

Responses

Request samples

Content type
application/json

Create a point of sale with the given information

{
  • "externalRef": "CTC123",
  • "name": "Euromaster Kepler",
  • "alias": "Kepler Tyres",
  • "legalIdentifier": {
    },
  • "functionalRef": "B",
  • "active": true,
  • "addressLine1": "123 Main St Apt 4B",
  • "addressLine2": "Anytown, CA 90210",
  • "addressLine3": "USA",
  • "postalCode": "90210",
  • "city": "Anytown",
  • "subdivision": "subdivision",
  • "countryCode": "FR",
  • "geolocation": {
    },
  • "phoneNumber": "+33123456789",
  • "email": "contact@euromaster-kepler.fr",
  • "url": "https://www.mysite.com/kepler"
}

Response samples

Content type
application/json
{
  • "code": 10001111
}

List all the offers from the offer catalog defined for the party of the authenticated user.

List all the offers from the offer catalog defined for the party of the authenticated user.

Authorizations:
(OAuth2ApiKeyAuth)
query Parameters
category
string (CategoryQueryParam) <= 255 characters
Example: category=CUSTOMER

Category of the offer

partyType
string (PartyTypeQueryParam) <= 255 characters
Example: partyType=B2B

The party type

type
string (OfferTypeQueryParam) <= 255 characters
Example: type=PROSPECTING

The offer type.

vehicleCategory
string (VehicleCategoryQueryParam) <= 255 characters
Example: vehicleCategory=TRUCK

The vehicle category of the offer.

withInactive
boolean (WithInactiveQueryParam)
Default: false
Example: withInactive=true

Set to true to include inactive or expired in the results. If false (default), only active will be returned.

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Create contact data

Create a contact associated to a party from an external application

Authorizations:
(OAuth2ApiKeyAuth)
path Parameters
partyCode
required
integer <int64> (PartyCodeQueryParam)
Example: 1000001

Targeted party code

Request Body schema: application/json
title
string (title) <= 255 characters

The title of the contact (e.g., Mr., Mrs., Ms.)

firstName
string (firstName) <= 255 characters

The first name of the contact

lastName
string (lastName) <= 255 characters

The last name of the contact

secondLastName
string (secondLastName) <= 255 characters

The second last name of the contact

nationalIdentificationNumber
string (nationalIdentificationNumber) <= 255 characters

The national identification number of the contact

email
string (email) <= 255 characters

The email address of the contact

phoneNumber
string (phoneNumber) <= 255 characters

The phone number of the contact

mobilePhoneNumber
string (mobilePhoneNumber) <= 255 characters

Mobile phone number of the contact

birthDate
string <date> (birthDate)

The birth date of the contact

object (GlobalCommunicationChannelDTO)

The contact's communication preferences

object (gdpr)

GDPR consent details.

externalRef
required
string (externalRef) <= 255 characters

External reference identifier

active
boolean (active)

Active flag

Array of objects (siteAssignment) <= 1000 items

Responses

Request samples

Content type
application/json

Create a contact with the given informations

{
  • "externalRef": "CTC",
  • "title": "M",
  • "firstName": "John",
  • "lastName": "Doe",
  • "secondLastName": "Doe2",
  • "nationalIdentificationNumber": "12345678E",
  • "email": "john.doe@mail.com",
  • "phoneNumber": "00 001 1111111",
  • "mobilePhoneNumber": "+33612345678",
  • "birthDate": "1970-01-01",
  • "active": true,
  • "communicationChannel": {
    },
  • "gdpr": {
    }
}

Response samples

Content type
application/json
{
  • "code": 10001111
}

Partially updates the details of a user identified by code, who belongs to the current authenticated user's party.

Partially updates the details of a user identified by code, who belongs to the current authenticated user's party. Only the fields provided in the request body will be updated. This endpoint is typically used to modify user attributes such as role, status, or language information. Authorization is required, and the user must exist and be linked to the current authenticated user's party.

Authorizations:
(OAuth2ApiKeyAuth)
path Parameters
userCode
required
integer <int64> (userCode)
Example: 1000032

Targeted user code

Request Body schema: application/json
language
required
string (language) <= 255 characters

Language of the translation (e.g. 'nl-NL', 'fr-FR')

required
Array of objects

List of role

preferredSites
Array of integers <int64> (siteCode) [ items <int64 > ]

List of preferred sites

Responses

Request samples

Content type
application/json
{
  • "language": "fr-FR",
  • "roles": [
    ],
  • "preferredSites": [
    ]
}

Response samples

Content type
application/json
{
  • "code": 100001,
  • "userName": "firstname.lastname@company.com",
  • "firstName": "Firstname",
  • "lastName": "Lastname",
  • "active": true,
  • "language": "fr-FR",
  • "partyCode": 100001,
  • "roles": [
    ],
  • "preferredSites": [
    ],
  • "lastModifiedDate": "2025-07-10T14:30:00",
  • "lastModifiedBy": "user1"
}

Retrieves detailed information about a specific user identified by code, who belongs to the current authenticated user's party.

Retrieves detailed information about a specific user identified by code, who belongs to the current authenticated user's party. This endpoint ensures that the user exists and is associated with my party. It is typically used to view user details for administrative or integration purposes. Authorization is required to access this resource.

Authorizations:
(OAuth2ApiKeyAuth)
path Parameters
userCode
required
integer <int64> (userCode)
Example: 1000032

Targeted user code

Responses

Response samples

Content type
application/json
{
  • "code": 100001,
  • "userName": "pierre.martin@email.com",
  • "firstName": "Pierre",
  • "lastName": "Martin",
  • "active": true,
  • "language": "fr-FR",
  • "roles": [
    ],
  • "preferredSites": [
    ],
  • "partyCode": 1000726,
  • "sourceCode": "EMR-FR",
  • "sourceCountryCode": "FR",
  • "lastModifiedDate": "2024-12-27T12:23:23"
}

Sites

Sites operation with all operation types

Get sites data

Get sites data filtered by parameters

Authorizations:
(OAuth2ApiKeyAuth)
query Parameters
pageNumber
integer <int32> (PageNumberQueryParam) [ 1 .. 1000 ]
Default: 1
Example: pageNumber=2

The page number

pageSize
integer <int32> (PageSizeQueryParam) [ 1 .. 1000 ]
Default: 1000
Example: pageSize=2

The page size

lastModifiedDateFrom
string <date-time> (LastModifiedDateFromQueryParam)
Example: lastModifiedDateFrom=2024-05-02T10:00:00

Date from for last update date of data

lastModifiedDateTo
string <date-time> (LastModifiedDateToQueryParam)
Example: lastModifiedDateTo=2024-05-02T10:00:00

Date to for last update date of data

name
string (name) <= 255 characters
Example: name=Euromaster Kepler

The value contained in the site's name

functionalRef
string (functionalRef) <= 255 characters
Example: functionalRef=B1234

functional ref of the site

externalRef
string (externalRef) <= 255 characters
Example: externalRef=12345678

external ref of the site

source
string (source) <= 255 characters
Example: source=GENES

source of the site

withInactive
boolean (WithInactiveQueryParam)
Default: false
Example: withInactive=true

Retrieve inactive site or not

withExternalRef
boolean (WithExternalRefQueryParam)
Default: false
Example: withExternalRef=true

Retrieve external ref data or not

codes
Array of integers <int64> (SiteCodeListQueryParameter) [ 1 .. 100 ] items [ items <int64 > ]
Example: codes=123,234

List of site code

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "sites": [
    ]
}

Create a site.

This endpoint allows to create a site.

Authorizations:
(OAuth2ApiKeyAuth)
Request Body schema: application/json
partyCode
required
integer <int64> (partyCode)

Party code of the source

functionalRef
string (functionalRef) <= 255 characters

Functional reference identifier

name
required
string (name) <= 255 characters

The name

addressLine1
string (addressLine1) <= 255 characters

The first line of the address

addressLine2
string (addressLine2) <= 255 characters

The second line of the address

addressLine3
string (addressLine3) <= 255 characters

The third line of the address

postalCode
string (postalCode) <= 255 characters

The postal code of the address

city
string (city) <= 255 characters

The city of the address

subdivision
string (subdivision) <= 255 characters

The subdivision (e.g., state, province) of the address

countryCode
required
string (countryCode) <= 255 characters

The country code of the address

Responses

Request samples

Content type
application/json
{
  • "partyCode": 1000032,
  • "functionalRef": "B1234",
  • "name": "Euromaster Kepler",
  • "addressLine1": "Industrichone",
  • "addressLine2": "address 2",
  • "addressLine3": "address 3",
  • "postalCode": "42697",
  • "city": "Solingen",
  • "subdivision": "subdivision",
  • "countryCode": "DE"
}

Response samples

Content type
application/json
{
  • "code": 100023,
  • "partyCode": 1000032,
  • "functionalRef": "B1234",
  • "active": true,
  • "name": "Euromaster Kepler",
  • "legalIdentifier": {
    },
  • "addressLine1": "Industrichone",
  • "addressLine2": "address 2",
  • "addressLine3": "address 3",
  • "postalCode": "42697",
  • "city": "Solingen",
  • "subdivision": "subdivision",
  • "countryCode": "DE",
  • "lastModifiedDate": "2024-12-27T12:23:23",
  • "lastModifiedBy": "user1"
}

Create site data

Create site external

Authorizations:
(OAuth2ApiKeyAuth)
Request Body schema: application/json
partyCode
required
integer <int64> (partyCode)

Party code of the source

functionalRef
string (functionalRef) <= 255 characters

Functional reference identifier

name
string (name) <= 255 characters

The name

addressLine1
string (addressLine1) <= 255 characters

The first line of the address

addressLine2
string (addressLine2) <= 255 characters

The second line of the address

addressLine3
string (addressLine3) <= 255 characters

The third line of the address

postalCode
string (postalCode) <= 255 characters

The postal code of the address

city
string (city) <= 255 characters

The city of the address

subdivision
string (subdivision) <= 255 characters

The subdivision (e.g., state, province) of the address

countryCode
required
string (countryCode) <= 255 characters

The country code of the address

externalRef
required
string (externalRef) <= 255 characters

External reference identifier

object (SiteLegalIdentifierDTO)

Legal identifier information

Responses

Request samples

Content type
application/json

Create a site with the given informations

{
  • "externalRef": "UIOZE",
  • "partyCode": 1000032,
  • "functionalRef": "B1234",
  • "name": "Euromaster Kepler",
  • "legalIdentifier": {
    },
  • "addressLine1": "Industrichone",
  • "addressLine2": "address 2",
  • "addressLine3": "address 3",
  • "postalCode": "42697",
  • "city": "Solingen",
  • "subdivision": "subdivision",
  • "countryCode": "DE"
}

Response samples

Content type
application/json
{
  • "code": 10001111
}

Get a site

Retrieve a site by his code

Authorizations:
(OAuth2ApiKeyAuth)
path Parameters
siteCode
required
integer <int64> (siteCode)
Example: 1000032

Targeted site code

Responses

Response samples

Content type
application/json
{
  • "code": 100023,
  • "partyCode": 1000032,
  • "functionalRef": "B1234",
  • "active": true,
  • "name": "Euromaster Kepler",
  • "addressLine1": "Industrichone",
  • "addressLine2": "address 2",
  • "addressLine3": "address 3",
  • "postalCode": "42697",
  • "city": "Solingen",
  • "subdivision": "subdivision",
  • "countryCode": "DE",
  • "lastModifiedDate": "2024-12-27T12:23:23"
}

Update a site

Update a site by his code

Authorizations:
(OAuth2ApiKeyAuth)
path Parameters
siteCode
required
integer <int64> (siteCode)
Example: 1000032

Targeted site code

Request Body schema: application/json
partyCode
required
integer <int64> (partyCode)

Party code of the source

functionalRef
string (functionalRef) <= 255 characters

Functional reference identifier

name
required
string (name) <= 255 characters

The name

addressLine1
string (addressLine1) <= 255 characters

The first line of the address

addressLine2
string (addressLine2) <= 255 characters

The second line of the address

addressLine3
string (addressLine3) <= 255 characters

The third line of the address

postalCode
string (postalCode) <= 255 characters

The postal code of the address

city
string (city) <= 255 characters

The city of the address

subdivision
string (subdivision) <= 255 characters

The subdivision (e.g., state, province) of the address

countryCode
required
string (countryCode) <= 255 characters

The country code of the address

Responses

Request samples

Content type
application/json
{
  • "partyCode": 1000032,
  • "functionalRef": "B1234",
  • "name": "Euromaster Kepler",
  • "addressLine1": "Industrichone",
  • "addressLine2": "address 2",
  • "addressLine3": "address 3",
  • "postalCode": "42697",
  • "city": "Solingen",
  • "subdivision": "subdivision",
  • "countryCode": "DE"
}

Response samples

Content type
application/json
{
  • "code": 100023,
  • "partyCode": 1000032,
  • "functionalRef": "B1234",
  • "active": true,
  • "name": "Euromaster Kepler",
  • "addressLine1": "Industrichone",
  • "addressLine2": "address 2",
  • "addressLine3": "address 3",
  • "postalCode": "42697",
  • "city": "Solingen",
  • "subdivision": "subdivision",
  • "countryCode": "DE",
  • "lastModifiedDate": "2024-12-27T12:23:23"
}

Delete a site

Update a site to set his active attribute to false

Authorizations:
(OAuth2ApiKeyAuth)
path Parameters
siteCode
required
integer <int64> (siteCode)
Example: 1000032

Targeted site code

Responses

Response samples

Content type
application/json
Example
{
  • "errors": [
    ]
}

Partially update a credit profile information

Partially update a credit profile information for a site as an authenticated user

Authorizations:
(OAuth2ApiKeyAuth)
path Parameters
siteCode
required
integer <int64> (siteCode)
Example: 1000032

Targeted site code

Request Body schema: application/json
totalRiskAmount
integer <int32> (totalRiskAmount)

Risk amount estimated for the bilTo site

riskClass
string (riskClass) <= 255 characters

Indicates the overall credit risk level associated with the billTo code, combined with the company's size (e.g., SME, large account). It also indicates if the customer is financially blocked

dunningGroup
string (dunningGroup) <= 255 characters

Indicates the specific set of escalation rules and communication types used when a customer fails to pay on time

sessionCode
string (sessionCode) <= 255 characters

Refers to the legal process initiated when the customer is unable to pay and the debt is transferred to a third party

creditManagerContactCode
integer <int64> (contactCode)

Contact code of the source

billToContactCode
integer <int64> (contactCode)

Contact code of the source

Responses

Request samples

Content type
application/json
{
  • "totalRiskAmount": 10000,
  • "riskClass": "Grand Compte / Risque Faible",
  • "dunningGroup": "Relance à 4 niveaux, tous les 15 jours",
  • "sessionCode": "Mandataire Judiciaire",
  • "creditManagerContactCode": 105293,
  • "billToContactCode": 101982
}

Response samples

Content type
application/json
{
  • "siteCode": 100005,
  • "totalRiskAmount": 10000,
  • "riskClass": "Grand Compte / Risque Faible",
  • "dunningGroup": "Relance à 4 niveaux, tous les 15 jours",
  • "sessionCode": "Mandataire Judiciaire",
  • "creditManagerContactCode": 105293,
  • "billToContactCode": 101982,
  • "lastModifiedDate": "2025-07-10T14:30:00",
  • "lastModifiedBy": "user1"
}

Get Point of sales

Allows the listing of Points of Sale (POS) that the user's party is authorized to consult.

Authorizations:
(OAuth2ApiKeyAuth)
query Parameters
offerCode
integer <int64> (offerCode)
Example: offerCode=100000

Filter by offerCode. Default Behavior: If this parameter is not provided (or is null), the API will return only My point of sales. An offerCode is filled The API will return the POS of parties who have subscribed as customers to this offer proposed by my party.

pageNumber
integer <int32> (PageNumberQueryParam) [ 1 .. 1000 ]
Default: 1
Example: pageNumber=2

The page number

pageSize
integer <int32> (PageSizeQueryParam) [ 1 .. 1000 ]
Default: 1000
Example: pageSize=2

The page size

withInactive
boolean (WithInactiveQueryParam)
Default: false
Example: withInactive=true

Retrieve inactive site or not

withExternalRef
boolean (WithExternalRefQueryParam)
Default: false
Example: withExternalRef=true

Retrieve external ref data or not

externalRef
string (externalRef) <= 255 characters
Example: externalRef=12345678

The external ref of the point of sale

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "sites": [
    ]
}

Get a point of sale

Retrieve a point of sale by its code

Authorizations:
(OAuth2ApiKeyAuth)
path Parameters
posCode
required
integer <int64> (siteCode)
Example: 1000032

Targeted point of sale's code

query Parameters
withExternalRef
boolean (WithExternalRefQueryParam)
Default: false
Example: withExternalRef=true

Retrieve external ref data or not

Responses

Response samples

Content type
application/json
{
  • "code": 100023,
  • "partyCode": 1000032,
  • "functionalRef": "B1234",
  • "active": true,
  • "name": "Euromaster Kepler",
  • "addressLine1": "Industrichone",
  • "addressLine2": "address 2",
  • "addressLine3": "address 3",
  • "postalCode": "42697",
  • "city": "Solingen",
  • "subdivision": "subdivision",
  • "countryCode": "DE",
  • "lastModifiedDate": "2024-12-27T12:23:23",
  • "alias": "Kepler Tyres",
  • "legalIdentifier": {
    },
  • "geolocation": {
    },
  • "phoneNumber": "+33123456789",
  • "email": "contact@euromaster-kepler.fr",
  • "url": "https://www.mysite.com/kepler",
  • "lastModifiedBy": "John Doe",
  • "references": [
    ]
}

Offers

Offers operation with all operation types

Get offers data

Get offers data filtered by parameters

Authorizations:
(OAuth2ApiKeyAuth)
query Parameters
category
string (CategoryQueryParam) <= 255 characters
Example: category=CUSTOMER

The category of the offer

partyType
string (PartyTypeQueryParam) <= 255 characters
Example: partyType=B2B

The type of the party

type
string (OfferTypeQueryParam) <= 255 characters
Example: type=PROSPECTING

The type of the offer

vehicleCategory
string (VehicleCategoryQueryParam) <= 255 characters
Example: vehicleCategory=TRUCK

The category of the vehicle

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Get an offer

Retrieve an offer by its code

Authorizations:
(OAuth2ApiKeyAuth)
path Parameters
code
required
integer <int64> (offerCode)
Example: 100000

Targeted offer code

Responses

Response samples

Content type
application/json
{
  • "code": 100001,
  • "active": true,
  • "name": "Master Premium",
  • "category": "CUSTOMER",
  • "partyType": "B2B",
  • "type": "TRANSACTIONAL",
  • "vehicleCategory": "TRUCK",
  • "lastModifiedDate": "2024-12-27T12:23:23",
  • "lastModifiedBy": "user2"
}

Subscriptions

Subscriptions operation with all operation types

Create a subscription.

This endpoint allows to create a subscription.

Authorizations:
(OAuth2ApiKeyAuth)
Request Body schema: application/json
name
string (subscriptionName) <= 255 characters

Name of the subscription

startDate
string <date> (startDateSubscription)

Start date of the subscription in YYYY-MM-DD format

endDate
string <date> (endDateSubscription)

End date of the subscription in YYYY-MM-DD format

inspectionFrequency
integer <int32> (inspectionFrequency)

Frequency of inspections in days

pressure
boolean (pressure)

Indicates if the pressure is taken

mileageUOM
string (MileageUOMEnum)
Enum: "km" "mi"

Vehicle mileage unit of measure

pressureUOM
string (PressureUOMEnum)
Enum: "bar" "psi"

Unit of measure for pressure

resale
boolean (resale)

Indicates if the party is for resale

nonResale
boolean (nonResale)

Indicates if the party is for non resale

requiredPO
boolean (requiredPO)

Indicates if a Purchase Order (PO) is required for this party

vatType
string (vatType) <= 255 characters

VAT Type associated with the subscription for accounting purposes, if applicable

glAccount
integer <int64> (glAccount)

GL account linked to the supplier

commercialAgreement
string (commercialAgreement) <= 255 characters

A document that provides the detailed pricing and a comprehensive description of the offer

paymentType
string (PaymentTypeEnum)
Enum: "CASH" "CREDIT"

Payment type, if applicable

customerCode
required
integer <int64> (partyCode)

Party code of the source

offerCode
required
integer <int64> (offerCode)

Offer code

disputeContactCode
integer <int64> (disputeContactCode)

Code of the partner contact associated with the dispute role for this subscription

accountingContactCode
integer <int64> (accountingContactCode)

Code of the partner contact associated with the accounting role for this subscription

purchasingContactCode
integer <int64> (purchasingContactCode)

Code of the partner contact associated with the purchasing role for this subscription

businessOwnerContactCode
integer <int64> (businessOwnerContactCode)

Code of the Euromaster contact associated with the business owner role for this subscription

contractorCode
required
integer <int64> (partyCode)

Party code of the source

active
boolean (activeWithDefault)

Active flag

Array of objects (SubscriptionLineBaseDTO)

List of subscription lines

Responses

Request samples

Content type
application/json
{
  • "name": "Subscription Name",
  • "active": true,
  • "contractorCode": 900000,
  • "customerCode": 900001,
  • "offerCode": 100000,
  • "startDate": "2024-03-01",
  • "endDate": "2026-03-01",
  • "inspectionFrequency": 90,
  • "pressure": true,
  • "resale": false,
  • "nonResale": false,
  • "requiredPO": false,
  • "glAccount": 607,
  • "vatType": "FRD - DEBIT FR",
  • "commercialAgreement": "offreSmall_MCP1",
  • "paymentType": "CASH",
  • "disputeContactCode": 102762,
  • "accountingContactCode": 105162,
  • "purchasingContactCode": 109201,
  • "businessOwnerContactCode": 107202,
  • "lines": [
    ]
}

Response samples

Content type
application/json
{
  • "code": 100023,
  • "name": "Subscription Name",
  • "active": true,
  • "contractorCode": 900000,
  • "customerCode": 900001,
  • "offerCode": 100000,
  • "startDate": "2024-03-01",
  • "endDate": "2026-03-01",
  • "inspectionFrequency": 90,
  • "pressure": true,
  • "resale": false,
  • "nonResale": false,
  • "requiredPO": false,
  • "glAccount": 607,
  • "vatType": "FRD - DEBIT FR",
  • "commercialAgreement": "offreSmall_MCP1",
  • "paymentType": "CASH",
  • "disputeContactCode": 102762,
  • "accountingContactCode": 105162,
  • "purchasingContactCode": 109201,
  • "businessOwnerContactCode": 107202,
  • "lines": [
    ],
  • "inspectionSchedulingMethod": "PERIOD",
  • "inspectionPeriods": [
    ],
  • "lastModifiedDate": "2024-12-27T12:23:23",
  • "lastModifiedBy": "user1"
}

Get all subscriptions

Get all subscriptions filtered by parameters

Authorizations:
(OAuth2ApiKeyAuth)
query Parameters
pageNumber
integer <int32> (PageNumberQueryParam) [ 1 .. 1000 ]
Default: 1
Example: pageNumber=2

The page number

pageSize
integer <int32> (PageSizeQueryParam) [ 1 .. 1000 ]
Default: 1000
Example: pageSize=2

The page size

lastModifiedDateFrom
string <date-time> (LastModifiedDateFromQueryParam)
Example: lastModifiedDateFrom=2024-05-02T10:00:00

Date from for last update date of data

lastModifiedDateTo
string <date-time> (LastModifiedDateToQueryParam)
Example: lastModifiedDateTo=2024-05-02T10:00:00

Date to for last update date of data

contractorCode
integer <int64> (PartyCodeQueryParam)
Example: contractorCode=1000001

Contractor party code

customerCode
integer <int64> (PartyCodeQueryParam)
Example: customerCode=1000001

Customer party code

offerCode
Array of integers <int64> (OfferCodeListQueryParameter) [ 1 .. 100 ] items [ items <int64 > ]
Example: offerCode=123,234

List of offer codes

startDate
string <date> (startDateSubscription)
Example: startDate=2024-01-01

Start date of the subscription

endDate
string <date> (endDateSubscription)
Example: endDate=2025-01-01

End date of the subscription

withInactive
boolean (WithInactiveQueryParam)
Default: false
Example: withInactive=true

If filled then return active and inactive subscriptions

customerSiteCode
Array of integers <int64> (SiteCodeListQueryParameter) [ 1 .. 100 ] items [ items <int64 > ]
Example: customerSiteCode=123,234

List of customer site codes

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "subscriptions": [
    ]
}

Get a subscription

Retrieve a subscription by its code

Authorizations:
(OAuth2ApiKeyAuth)
path Parameters
subscriptionCode
required
integer <int64> (SubscriptionCodeParam)
Example: 100000

Targeted subscription code

Responses

Response samples

Content type
application/json
{
  • "code": 100023,
  • "contractorCode": 900000,
  • "customerCode": 900001,
  • "offerCode": 100000,
  • "startDate": "2024-03-01",
  • "endDate": "2026-03-01",
  • "active": true,
  • "inspectionFrequency": 90,
  • "pressure": true,
  • "lastModifiedDate": "2024-12-27T12:23:23"
}

Update partially a subscription

Update partially a subscription by its code

Authorizations:
(OAuth2ApiKeyAuth)
path Parameters
subscriptionCode
required
integer <int64> (SubscriptionCodeParam)
Example: 100000

Targeted subscription code

Request Body schema: application/json
name
string (subscriptionName) <= 255 characters

Name of the subscription

startDate
string <date> (startDateSubscription)

Start date of the subscription in YYYY-MM-DD format

endDate
string <date> (endDateSubscription)

End date of the subscription in YYYY-MM-DD format

inspectionFrequency
integer <int32> (inspectionFrequency)

Frequency of inspections in days

pressure
boolean (pressure)

Indicates if the pressure is taken

mileageUOM
string (MileageUOMEnum)
Enum: "km" "mi"

Vehicle mileage unit of measure

pressureUOM
string (PressureUOMEnum)
Enum: "bar" "psi"

Unit of measure for pressure

disputeContactCode
integer <int64> (disputeContactCode)

Code of the partner contact associated with the dispute role for this subscription

accountingContactCode
integer <int64> (accountingContactCode)

Code of the partner contact associated with the accounting role for this subscription

purchasingContactCode
integer <int64> (purchasingContactCode)

Code of the partner contact associated with the purchasing role for this subscription

businessOwnerContactCode
integer <int64> (businessOwnerContactCode)

Code of the Euromaster contact associated with the business owner role for this subscription

resale
boolean (resale)

Indicates if the party is for resale

nonResale
boolean (nonResale)

Indicates if the party is for non resale

requiredPO
boolean (requiredPO)

Indicates if a Purchase Order (PO) is required for this party

vatType
string (vatType) <= 255 characters

VAT Type associated with the subscription for accounting purposes, if applicable

glAccount
integer <int64> (glAccount)

GL account linked to the supplier

commercialAgreement
string (commercialAgreement) <= 255 characters

A document that provides the detailed pricing and a comprehensive description of the offer

paymentType
string (PaymentTypeEnum)
Enum: "CASH" "CREDIT"

Payment type, if applicable

active
boolean (active)

Active flag

Responses

Request samples

Content type
application/json
{
  • "name": "Subscription Name",
  • "active": true,
  • "startDate": "2024-03-01",
  • "endDate": "2026-03-01",
  • "inspectionFrequency": 90,
  • "pressure": true,
  • "resale": false,
  • "nonResale": false,
  • "requiredPO": false,
  • "glAccount": 607,
  • "vatType": "FRD - DEBIT FR",
  • "commercialAgreement": "offreSmall_MCP1",
  • "paymentType": "CASH",
  • "disputeContactCode": 102762,
  • "accountingContactCode": 105162,
  • "purchasingContactCode": 109201,
  • "businessOwnerContactCode": 107202
}

Response samples

Content type
application/json
{
  • "code": 1000000,
  • "name": "Subscription Name",
  • "active": true,
  • "contractorCode": 1000000,
  • "customerCode": 1000001,
  • "offerCode": 1000002,
  • "startDate": "2024-03-01",
  • "endDate": "2026-03-01",
  • "inspectionFrequency": 90,
  • "pressure": true,
  • "resale": false,
  • "nonResale": false,
  • "requiredPO": false,
  • "glAccount": 607,
  • "vatType": "FRD - DEBIT FR",
  • "commercialAgreement": "offreSmall_MCP1",
  • "paymentType": "CASH",
  • "disputeContactCode": 102762,
  • "accountingContactCode": 105162,
  • "purchasingContactCode": 109201,
  • "businessOwnerContactCode": 107202,
  • "lastModifiedDate": "2024-12-27T12:23:23",
  • "lastModifiedBy": "user1"
}

Add a line to a subscription

This endpoint allows to add a line to a subscription.

Authorizations:
(OAuth2ApiKeyAuth)
path Parameters
subscriptionCode
required
integer <int64> (SubscriptionCodeParam)
Example: 100000

Targeted subscription code

customerSiteCode
required
integer <int64> (siteCode)
Example: 1000032

Targeted customer site code

Request Body schema: application/json
inspectionServiceProviderCode
required
integer <int64> (partyCode)

Party code of the source

Responses

Request samples

Content type
application/json
{
  • "inspectionServiceProviderCode": 1000032
}

Response samples

Content type
application/json
{
  • "customerSiteCode": 10001111,
  • "inspectionServiceProviderCode": 10002222
}

Update a subscription line

This endpoint allows to update a subscription line.

Authorizations:
(OAuth2ApiKeyAuth)
path Parameters
subscriptionCode
required
integer <int64> (SubscriptionCodeParam)
Example: 100000

Targeted subscription code

customerSiteCode
required
integer <int64> (siteCode)
Example: 1000032

Targeted customer site code

Request Body schema: application/json
inspectionServiceProviderCode
required
integer <int64> (partyCode)

Party code of the source

Responses

Request samples

Content type
application/json
{
  • "inspectionServiceProviderCode": 1000032
}

Response samples

Content type
application/json
{
  • "customerSiteCode": 10001111,
  • "inspectionServiceProviderCode": 10002222
}

Get all my subscriptions as a customer

Get all my subscriptions as a customer and as an authenticated user associated to a Party

Authorizations:
(OAuth2ApiKeyAuth)
query Parameters
pageNumber
integer <int32> (PageNumberQueryParam) [ 1 .. 1000 ]
Default: 1
Example: pageNumber=2

The page number

pageSize
integer <int32> (PageSizeQueryParam) [ 1 .. 1000 ]
Default: 1000
Example: pageSize=2

The page size

lastModifiedDateFrom
string <date-time> (LastModifiedDateFromQueryParam)
Example: lastModifiedDateFrom=2024-05-02T10:00:00

Date from for last update date of data

lastModifiedDateTo
string <date-time> (LastModifiedDateToQueryParam)
Example: lastModifiedDateTo=2024-05-02T10:00:00

Date to for last update date of data

contractorCode
integer <int64> (PartyCodeQueryParam)
Example: contractorCode=1000001

Contractor party code

offerCode
integer <int64> (offerCode)
Example: offerCode=100000

Offer code

withInactive
boolean (WithInactiveQueryParam)
Default: false
Example: withInactive=true

If filled then return active and inactive subscriptions

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "subscriptions": [
    ]
}

Get detailed lines for a specific subscription

Get detailed lines for a specific subscription for which I am a customer and an authenticated user associated with a party

Authorizations:
(OAuth2ApiKeyAuth)
path Parameters
subscriptionCode
required
integer <int64> (SubscriptionCodeParam)
Example: 100000

Targeted subscription code

query Parameters
pageNumber
integer <int32> (PageNumberQueryParam) [ 1 .. 1000 ]
Default: 1
Example: pageNumber=2

The page number

pageSize
integer <int32> (PageSizeQueryParam) [ 1 .. 1000 ]
Default: 1000
Example: pageSize=2

The page size

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "lines": [
    ]
}

Get commercial agreement for a specific subscription

Get commercial agreement for a specific subscription for which I am a customer and an authenticated user associated with a party

Authorizations:
(OAuth2ApiKeyAuth)
path Parameters
subscriptionCode
required
integer <int64> (SubscriptionCodeParam)
Example: 100000

Targeted subscription code

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Get a subscription as job service provider

Get a subscription as job service provider.

Authorizations:
(OAuth2ApiKeyAuth)
path Parameters
subscriptionCode
required
integer <int64> (SubscriptionCodeParam)
Example: 100000

Targeted subscription code

Responses

Response samples

Content type
application/json
{
  • "code": 100001,
  • "name": "Subscription Name",
  • "active": true,
  • "contractorCode": 100000,
  • "customerCode": 100001,
  • "offerCode": 100001,
  • "startDate": "1970-01-01",
  • "endDate": "1970-01-01",
  • "inspectionFrequency": 90,
  • "pressure": true,
  • "resale": true,
  • "nonResale": true,
  • "requiredPO": true,
  • "glAccount": 603,
  • "vatType": "FRD - DEBIT FR",
  • "commercialAgreement": "offreSmall_MCP1",
  • "paymentType": "CASH",
  • "soldToSiteCode": 100005,
  • "billToSiteCode": 100005,
  • "payerSiteCode": 100005,
  • "contractorContacts": {
    },
  • "lastModifiedDate": "2025-07-10T14:30:00",
  • "lastModifiedBy": "user1"
}

Get all my subscriptions as a contractor

Get all my subscriptions as a contractor and as an authenticated user associated to a Party

Authorizations:
(OAuth2ApiKeyAuth)
query Parameters
pageNumber
integer <int32> (PageNumberQueryParam) [ 1 .. 1000 ]
Default: 1
Example: pageNumber=2

The page number

pageSize
integer <int32> (PageSizeQueryParam) [ 1 .. 1000 ]
Default: 1000
Example: pageSize=2

The page size

customerCode
integer <int64> (PartyCodeQueryParam)
Example: customerCode=1000001

Customer party code

offerCode
integer <int64> (offerCode)
Example: offerCode=100000

Offer code

lastModifiedDateFrom
string <date-time> (LastModifiedDateFromQueryParam)
Example: lastModifiedDateFrom=2024-05-02T10:00:00

Date from for last update date of data

lastModifiedDateTo
string <date-time> (LastModifiedDateToQueryParam)
Example: lastModifiedDateTo=2024-05-02T10:00:00

Date to for last update date of data

withInactive
boolean (WithInactiveQueryParam)
Default: false
Example: withInactive=true

If filled then return active and inactive subscriptions

customerExternalRef
string (CustomerExternalRefQueryParam) <= 255 characters
Example: customerExternalRef=A75A0624

Identifier of the customer in the external source application

customerSiteCode
integer <int64> (siteCode)
Example: customerSiteCode=1000032

Filters subscriptions associated with a specific customer site unique code (on susbsription line level)

subscriptionLinesBillToSiteCode
integer <int64> (siteCode)
Example: subscriptionLinesBillToSiteCode=1000032

Filters subscriptions associated with a specific billTo site unique code (on susbsription line level)

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "subscriptions": [
    ]
}

Create a subscription as a contractor

This endpoint allows to create a subscription as a contractor.

Authorizations:
(OAuth2ApiKeyAuth)
Request Body schema: application/json
name
string (subscriptionName) <= 255 characters

Name of the subscription

startDate
string <date> (startDateSubscription)

Start date of the subscription in YYYY-MM-DD format

endDate
string <date> (endDateSubscription)

End date of the subscription in YYYY-MM-DD format

inspectionFrequency
integer <int32> (inspectionFrequency)

Frequency of inspections in days

pressure
boolean (pressure)

Indicates if the pressure is taken

mileageUOM
string (MileageUOMEnum)
Enum: "km" "mi"

Vehicle mileage unit of measure

pressureUOM
string (PressureUOMEnum)
Enum: "bar" "psi"

Unit of measure for pressure

inspectionSchedulingMethod
string (InspectionSchedulingMethodEnum)
Enum: "FREQUENCY" "PERIOD"

The scheduling method of the inspections: FREQUENCY (uses 'inspectionFrequency') or PERIOD (uses 'inspectionPeriods').

Array of objects (InspectionPeriodDTO) <= 12 items

A unique set of up to 12 inspection periods. Rules: Max 365 days total, no overlaps, strictly chronological.

billToSiteCode
integer <int64> (siteCode)

Site code of the source

payerSiteCode
integer <int64> (siteCode)

Site code of the source

resale
boolean (resale)

Indicates if the party is for resale

nonResale
boolean (nonResale)

Indicates if the party is for non resale

requiredPO
boolean (requiredPO)

Indicates if a Purchase Order (PO) is required for this party

vatType
string (vatType) <= 255 characters

VAT Type associated with the subscription for accounting purposes, if applicable

glAccount
integer <int64> (glAccount)

GL account linked to the supplier

commercialAgreement
string (commercialAgreement) <= 255 characters

A document that provides the detailed pricing and a comprehensive description of the offer

paymentType
string (PaymentTypeEnum)
Enum: "CASH" "CREDIT"

Payment type, if applicable

soldToSiteCode
integer <int64> (siteCode)

Site code of the source

object (ContractorContactsDTO)

Contractor Contacts information

customerSizeTypology
string (CustomerSizeTypologyEnum)
Enum: "NATIONAL" "REGIONAL" "LOCAL" "FRANCHISE"

Typology indicating the size or structural scope of the customer associated with the subscription

customerMarketTypology
string (CustomerMarketTypologyEnum)
Enum: "BUYING_GROUP" "AGRIBUSINESS" "CHORUS"

Typology indicating the specific market segment or business network of the customer

customerCode
required
integer <int64> (partyCode)

Party code of the source

offerCode
required
integer <int64> (offerCode)

Offer code

Responses

Request samples

Content type
application/json
{
  • "name": "Subscription Name",
  • "customerCode": 100001,
  • "offerCode": 100001,
  • "startDate": "1970-01-01",
  • "endDate": "1970-01-01",
  • "inspectionFrequency": 90,
  • "pressure": true,
  • "resale": true,
  • "nonResale": true,
  • "requiredPO": true,
  • "glAccount": 603,
  • "vatType": "FRD - DEBIT FR",
  • "commercialAgreement": "offreSmall_MCP1",
  • "paymentType": "CASH",
  • "soldToSiteCode": 100005,
  • "billToSiteCode": 100005,
  • "payerSiteCode": 100005,
  • "customerSizeTypology": "NATIONAL",
  • "customerMarketTypology": "BUYING_GROUP",
  • "inspectionSchedulingMethod": "PERIOD",
  • "inspectionPeriods": [
    ],
  • "contractorContacts": {
    }
}

Response samples

Content type
application/json
{
  • "code": 100001,
  • "name": "Subscription Name",
  • "active": true,
  • "contractorCode": 100000,
  • "customerCode": 100001,
  • "offerCode": 100001,
  • "startDate": "1970-01-01",
  • "endDate": "1970-01-01",
  • "inspectionFrequency": 90,
  • "pressure": true,
  • "resale": true,
  • "nonResale": true,
  • "requiredPO": true,
  • "glAccount": 603,
  • "vatType": "FRD - DEBIT FR",
  • "commercialAgreement": "offreSmall_MCP1",
  • "paymentType": "CASH",
  • "soldToSiteCode": 100005,
  • "billToSiteCode": 100005,
  • "payerSiteCode": 100005,
  • "customerSizeTypology": "NATIONAL",
  • "customerMarketTypology": "BUYING_GROUP",
  • "contractorContacts": {
    },
  • "inspectionSchedulingMethod": "PERIOD",
  • "inspectionPeriods": [
    ],
  • "lastModifiedDate": "2025-07-10T14:30:00",
  • "lastModifiedBy": "user1"
}

Partially update a subscription as a contractor

This endpoint allows to partially update a subscription as a contractor.

Authorizations:
(OAuth2ApiKeyAuth)
path Parameters
subscriptionCode
required
integer <int64> (SubscriptionCodeParam)
Example: 100000

Targeted subscription code

Request Body schema: application/json
name
string (subscriptionName) <= 255 characters

Name of the subscription

startDate
string <date> (startDateSubscription)

Start date of the subscription in YYYY-MM-DD format

endDate
string <date> (endDateSubscription)

End date of the subscription in YYYY-MM-DD format

inspectionFrequency
integer <int32> (inspectionFrequency)

Frequency of inspections in days

pressure
boolean (pressure)

Indicates if the pressure is taken

mileageUOM
string (MileageUOMEnum)
Enum: "km" "mi"

Vehicle mileage unit of measure

pressureUOM
string (PressureUOMEnum)
Enum: "bar" "psi"

Unit of measure for pressure

inspectionSchedulingMethod
string (InspectionSchedulingMethodEnum)
Enum: "FREQUENCY" "PERIOD"

The scheduling method of the inspections: FREQUENCY (uses 'inspectionFrequency') or PERIOD (uses 'inspectionPeriods').

Array of objects (InspectionPeriodDTO) <= 12 items

A unique set of up to 12 inspection periods. Rules: Max 365 days total, no overlaps, strictly chronological.

billToSiteCode
integer <int64> (siteCode)

Site code of the source

payerSiteCode
integer <int64> (siteCode)

Site code of the source

resale
boolean (resale)

Indicates if the party is for resale

nonResale
boolean (nonResale)

Indicates if the party is for non resale

requiredPO
boolean (requiredPO)

Indicates if a Purchase Order (PO) is required for this party

vatType
string (vatType) <= 255 characters

VAT Type associated with the subscription for accounting purposes, if applicable

glAccount
integer <int64> (glAccount)

GL account linked to the supplier

commercialAgreement
string (commercialAgreement) <= 255 characters

A document that provides the detailed pricing and a comprehensive description of the offer

paymentType
string (PaymentTypeEnum)
Enum: "CASH" "CREDIT"

Payment type, if applicable

soldToSiteCode
integer <int64> (siteCode)

Site code of the source

object (ContractorContactsDTO)

Contractor Contacts information

customerSizeTypology
string (CustomerSizeTypologyEnum)
Enum: "NATIONAL" "REGIONAL" "LOCAL" "FRANCHISE"

Typology indicating the size or structural scope of the customer associated with the subscription

customerMarketTypology
string (CustomerMarketTypologyEnum)
Enum: "BUYING_GROUP" "AGRIBUSINESS" "CHORUS"

Typology indicating the specific market segment or business network of the customer

Responses

Request samples

Content type
application/json
{
  • "name": "Subscription Name",
  • "startDate": "1970-01-01",
  • "endDate": "1970-01-01",
  • "inspectionFrequency": 90,
  • "pressure": true,
  • "resale": true,
  • "nonResale": true,
  • "requiredPO": true,
  • "glAccount": 603,
  • "vatType": "FRD - DEBIT FR",
  • "commercialAgreement": "offreSmall_MCP1",
  • "paymentType": "CASH",
  • "soldToSiteCode": 100005,
  • "billToSiteCode": 100005,
  • "payerSiteCode": 100005,
  • "customerSizeTypology": "NATIONAL",
  • "customerMarketTypology": "BUYING_GROUP",
  • "contractorContacts": {
    }
}

Response samples

Content type
application/json
{
  • "code": 100001,
  • "name": "Subscription Name",
  • "active": true,
  • "contractorCode": 100000,
  • "customerCode": 100001,
  • "offerCode": 100001,
  • "startDate": "1970-01-01",
  • "endDate": "1970-01-01",
  • "inspectionFrequency": 90,
  • "pressure": true,
  • "resale": true,
  • "nonResale": true,
  • "requiredPO": true,
  • "glAccount": 603,
  • "vatType": "FRD - DEBIT FR",
  • "commercialAgreement": "offreSmall_MCP1",
  • "paymentType": "CASH",
  • "soldToSiteCode": 100005,
  • "billToSiteCode": 100005,
  • "payerSiteCode": 100005,
  • "customerSizeTypology": "NATIONAL",
  • "customerMarketTypology": "BUYING_GROUP",
  • "contractorContacts": {
    },
  • "lastModifiedDate": "2025-07-10T14:30:00",
  • "lastModifiedBy": "user1"
}

Delete a subscription as contractor by code

Set the subscription active status to false and the endDate with the current date.

Authorizations:
(OAuth2ApiKeyAuth)
path Parameters
subscriptionCode
required
integer <int64> (SubscriptionCodeParam)
Example: 100000

Targeted subscription code

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Get a subscription as a contractor and as an authenticated user associated to a Party (only if there is a commercial relationship for which my party is contractor)

This endpoint allows to get a subscription as a contractor.

Authorizations:
(OAuth2ApiKeyAuth)
path Parameters
subscriptionCode
required
integer <int64> (SubscriptionCodeParam)
Example: 100000

Targeted subscription code

Responses

Response samples

Content type
application/json
{
  • "code": 100001,
  • "name": "Subscription Name",
  • "active": true,
  • "contractorCode": 100000,
  • "customerCode": 100001,
  • "offerCode": 100001,
  • "startDate": "1970-01-01",
  • "endDate": "1970-01-01",
  • "inspectionFrequency": 90,
  • "pressure": true,
  • "resale": true,
  • "nonResale": true,
  • "requiredPO": true,
  • "glAccount": 603,
  • "vatType": "FRD - DEBIT FR",
  • "commercialAgreement": "offreSmall_MCP1",
  • "paymentType": "CASH",
  • "soldToSiteCode": 100005,
  • "billToSiteCode": 100005,
  • "payerSiteCode": 100005,
  • "contractorContacts": {
    },
  • "lastModifiedDate": "2025-07-10T14:30:00",
  • "lastModifiedBy": "user1"
}

Get lines for a contractor's subscription

Get detailed lines for a specific subscription for which I am a contractor and an authenticated user associated with a party

Authorizations:
(OAuth2ApiKeyAuth)
path Parameters
subscriptionCode
required
integer <int64> (SubscriptionCodeParam)
Example: 100000

The subscription code

query Parameters
pageNumber
integer <int32> (PageNumberQueryParam) [ 1 .. 1000 ]
Default: 1
Example: pageNumber=2

The page number

pageSize
integer <int32> (PageSizeQueryParam) [ 1 .. 1000 ]
Default: 1000
Example: pageSize=2

The page size

customerSiteExternalRef
string (CustomerSiteExternalRefQueryParam) <= 255 characters
Example: customerSiteExternalRef=E0919590

The customer site external reference

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "lines": [
    ]
}

Delete a line for a specific subscription

Delete a line for a specific subscription for which I am a contractor and an authenticated user associated with a party

Authorizations:
(OAuth2ApiKeyAuth)
path Parameters
subscriptionCode
required
integer <int64> (SubscriptionCodeParam)
Example: 100000

Targeted subscription code

customerSiteCode
required
integer <int64> (siteCode)
Example: 1000032

Targeted customer site code

Responses

Response samples

Content type
application/json
Example
{
  • "errors": [
    ]
}

Create or update lines for a specific subscription as contractor

This endpoint allows to create or update lines for a specific subscription as contractor.

Authorizations:
(OAuth2ApiKeyAuth)
path Parameters
subscriptionCode
required
integer <int64> (SubscriptionCodeParam)
Example: 100000

Targeted subscription code

customerSiteCode
required
integer <int64> (siteCode)
Example: 1000032

Targeted customer site code

Request Body schema: application/json
inspectionServiceProviderCode
integer <int64> (partyCode)

Party code of the source

jobServiceProviderSiteCode
integer <int64> (siteCode)

Site code of the source

object (ContractorContactsCommercialDTO)

Contractor Contacts commercial information

billToSiteCode
integer <int64> (siteCode)

Site code of the source

payerSiteCode
integer <int64> (siteCode)

Site code of the source

Responses

Request samples

Content type
application/json
{
  • "inspectionServiceProviderCode": 100003,
  • "jobServiceProviderSiteCode": 100006,
  • "billToSiteCode": 100005,
  • "payerSiteCode": 100005,
  • "contractorContacts": {
    }
}

Response samples

Content type
application/json
{
  • "customerSiteCode": 100001,
  • "inspectionServiceProviderCode": 100003,
  • "jobServiceProviderSiteCode": 100006,
  • "billToSiteCode": 100005,
  • "payerSiteCode": 100005,
  • "contractorContacts": {
    },
  • "lastModifiedDate": "2025-07-10T14:30:00",
  • "lastModifiedBy": "user1"
}

Get all my subscriptions as an inspector

Get all active subscriptions for which my Party is inspection service provider

Authorizations:
(OAuth2ApiKeyAuth)
query Parameters
pageNumber
integer <int32> (PageNumberQueryParam) [ 1 .. 1000 ]
Default: 1
Example: pageNumber=2

The page number

pageSize
integer <int32> (PageSizeQueryParam) [ 1 .. 1000 ]
Default: 1000
Example: pageSize=2

The page size

customerCode
integer <int64> (PartyCodeQueryParam)
Example: customerCode=1000001

Customer party code

customerSiteCode
integer <int64> (siteCode)
Example: customerSiteCode=1000032

Customer site code

lastModifiedDateFrom
string <date-time> (LastModifiedDateFromQueryParam)
Example: lastModifiedDateFrom=2024-05-02T10:00:00

Date from for last update date of data

lastModifiedDateTo
string <date-time> (LastModifiedDateToQueryParam)
Example: lastModifiedDateTo=2024-05-02T10:00:00

Date to for last update date of data

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "subscriptions": [
    ]
}

Get a subscription as an inspector

Get a subscription as a service provider and as an authenticated user associated to a Party (only if there is a subscription line for which my party is inspection service provider)

Authorizations:
(OAuth2ApiKeyAuth)
path Parameters
subscriptionCode
required
integer <int64> (subscriptionCode)
Example: 1000032

The subscription code

Responses

Response samples

Content type
application/json
{
  • "code": 100001,
  • "name": "Subscription Name",
  • "active": true,
  • "contractorCode": 100000,
  • "customerCode": 100001,
  • "offerCode": 100001,
  • "startDate": "1970-01-01",
  • "endDate": "1970-01-01",
  • "inspectionFrequency": 90,
  • "inspectionSchedulingMethod": "PERIOD",
  • "inspectionPeriods": [
    ],
  • "pressure": true,
  • "lastModifiedDate": "2025-07-10T14:30:00",
  • "lastModifiedBy": "user1"
}

Get all subscription lines

Get all subscription lines. Only for batch usage

Authorizations:
(OAuth2ApiKeyAuth)
query Parameters
pageNumber
integer <int32> (PageNumberQueryParam) [ 1 .. 1000 ]
Default: 1
Example: pageNumber=2

The page number

pageSize
integer <int32> (PageSizeQueryParam) [ 1 .. 1000 ]
Default: 1000
Example: pageSize=2

The page size

lastModifiedDateFrom
string <date-time> (LastModifiedDateFromQueryParam)
Example: lastModifiedDateFrom=2024-05-02T10:00:00

Date from for last update date of data

lastModifiedDateTo
string <date-time> (LastModifiedDateToQueryParam)
Example: lastModifiedDateTo=2024-05-02T10:00:00

Date to for last update date of data

subscriptionCode
integer <int64> (SubscriptionCodeParam)
Example: subscriptionCode=100000

The subscription code

customerSiteCode
integer <int64> (siteCode)
Example: customerSiteCode=1000032

Code of the customer's site included in the subscription Refers to a site of a party (code of a party's site into the Party repository)

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "subscriptionLines": [
    ]
}

Subscriptions : Vehicles

Subscriptions operation with a focus on vehicles related endpoints

List vehicles linked to subscriptions.

Retrieves the list of vehicles associated with subscriptions.

Authorizations:
(OAuth2ApiKeyAuth)
query Parameters
customerSiteCode
integer <int64> (siteCode)
Example: customerSiteCode=1000032

Filters vehicles associated with a specific customer site unique code.

pageNumber
integer <int32> (PageNumberQueryParam) [ 1 .. 1000 ]
Default: 1
Example: pageNumber=2

The page number

pageSize
integer <int32> (PageSizeQueryParam) [ 1 .. 1000 ]
Default: 1000
Example: pageSize=2

The page size

withInactive
boolean (WithInactiveQueryParam)
Default: false
Example: withInactive=true

Set to true to include inactive or expired vehicles in the results. If false (default), only active vehicles will be returned.

vehicleCode
integer <int64> (vehicleCode)
Example: vehicleCode=1000032

The vehicle code

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "vehicles": [
    ]
}

Create or update vehicles for a specific subscription as contractor.

Create or update vehicles for a specific subscription as contractor (The party of the authenticated user is the contractor of the subscription).

Authorizations:
(OAuth2ApiKeyAuth)
path Parameters
subscriptionCode
required
integer <int64> (subscriptionCode)
Example: 1000032

The subscription code

vehicleCode
required
integer <int64> (vehicleCode)
Example: 1000032

The vehicle code

Request Body schema: application/json
nextInspectionDate
string <date-time> (nextInspectionDate)

Timestamp of the next inspection in ISO 8601 format (UTC)

nextInspectionType
string (InspectionTypeEnum)
Enum: "COMPLETE" "VISUAL"

Type of inspection

serviceGroupCode
integer <int64> (serviceGroupCode)

The code of the service group this vehicle belongs to. Refers to a service group (code of the serviceGroup into the ServiceGroup repository).

pending
boolean (pending)

Indicates if the vehicle is awaiting a confirmation to make part of the subscription.

Responses

Request samples

Content type
application/json
{
  • "pending": true,
  • "nextInspectionDate": "2026-03-12T14:19:36",
  • "nextInspectionType": "COMPLETE",
  • "serviceGroupCode": 12
}

Response samples

Content type
application/json
{
  • "code": 1066769,
  • "subscriptionCode": 1000851,
  • "nextInspectionDate": "2026-03-12T14:19:36",
  • "nextInspectionType": "COMPLETE",
  • "pending": true,
  • "active": true,
  • "serviceGroupCode": 12,
  • "lastModifiedDate": "2026-03-16T10:14:52",
  • "lastModifiedBy": "user@mail.com"
}

Delete a vehicle from a specific subscription as contractor.

Delete a vehicle for a specific subscription as contractor (The party of the authenticated user is the contractor of the subscription). If pending = TRUE, the subscription vehicle record is completely deleted from the database. If pending = FALSE, the subscription vehicle is updated to have active = FALSE.

Authorizations:
(OAuth2ApiKeyAuth)
path Parameters
subscriptionCode
required
integer <int64> (subscriptionCode)
Example: 1000032

The subscription code

vehicleCode
required
integer <int64> (vehicleCode)
Example: 1000032

The vehicle code

query Parameters
exitDate
string <date> (exitDate)
Example: exitDate=1990-10-10

The date of the exit from the contract. If empty take today's date.

Responses

Response samples

Content type
application/json
Example
{
  • "errors": [
    ]
}

Request the attachment of a vehicle to a given subscription as an inspector.

Request the attachment of a vehicle to a given subscription as an inspector." The authenticated users as to belong to the party parameterized as inspection service provider for the provided subscription."The vehicle is created in the subscription with pending = TRUE."A validation by the back office will be then required to validate the attachment of the vehicle.

Authorizations:
(OAuth2ApiKeyAuth)
path Parameters
subscriptionCode
required
integer <int64> (subscriptionCode)
Example: 1000032

The subscription code

vehicleCode
required
integer <int64> (vehicleCode)
Example: 1000032

The vehicle code

Request Body schema: application/json
nextInspectionDate
string <date-time> (nextInspectionDate)

Timestamp of the next inspection in ISO 8601 format (UTC)

nextInspectionType
string (InspectionTypeEnum)
Enum: "COMPLETE" "VISUAL"

Type of inspection

serviceGroupCode
integer <int64> (serviceGroupCode)

The code of the service group this vehicle belongs to. Refers to a service group (code of the serviceGroup into the ServiceGroup repository).

Responses

Request samples

Content type
application/json
{
  • "nextInspectionDate": "2026-03-12T14:19:36",
  • "nextInspectionType": "COMPLETE",
  • "serviceGroupCode": 12
}

Response samples

Content type
application/json
{
  • "code": 1066769,
  • "subscriptionCode": 1000851,
  • "nextInspectionDate": "2026-03-12T14:19:36",
  • "nextInspectionType": "COMPLETE",
  • "pending": true,
  • "active": true,
  • "serviceGroupCode": 12,
  • "lastModifiedDate": "2026-03-16T10:14:52",
  • "lastModifiedBy": "user@mail.com"
}

Get vehicles on contractor's subscriptions

Get vehicles on all the subscriptions for which the party of the authenticated user is the contractor.

Authorizations:
(OAuth2ApiKeyAuth)
query Parameters
code
integer <int64> (VehicleCodeQueryParam)
Example: code=1000001

Filters vehicles with unique code

customerCode
integer <int64> (PartyCodeQueryParam)
Example: customerCode=1000001

Filters vehicles associated with a specific customer's unique code

customerSiteCode
integer <int64> (siteCode)
Example: customerSiteCode=1000032

Filters vehicles associated with a specific customer site unique code.

lastModifiedDateFrom
string <date-time> (LastModifiedDateFromQueryParam)
Example: lastModifiedDateFrom=2024-05-02T10:00:00

Date from for last update date of data

lastModifiedDateTo
string <date-time> (LastModifiedDateToQueryParam)
Example: lastModifiedDateTo=2024-05-02T10:00:00

Date to for last update date of data

offerCode
integer <int64> (offerCode)
Example: offerCode=100000

Filters vehicles by a specific offer's unique code

pageNumber
integer <int32> (PageNumberQueryParam) [ 1 .. 1000 ]
Default: 1
Example: pageNumber=2

The page number

pageSize
integer <int32> (PageSizeQueryParam) [ 1 .. 1000 ]
Default: 1000
Example: pageSize=2

The page size

withExtension
boolean (WithExtensionQueryParam)
Default: false
Example: withExtension=true

Whether to include the extension data

withInactive
boolean (WithInactiveQueryParam)
Default: false
Example: withInactive=true

Set to true to include inactive or expired vehicles in the results. If false (default), only active vehicles will be returned.

pending
boolean (PendingQueryParam)
Example: pending=true

Filters on vehicule status in the subscription. If not provided, the filter is not applied.

registrationNumber
string (RegistrationNumberQueryParam) <= 100 characters
Example: registrationNumber=FM-873-JN

Search by license plate (using a like)

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "vehicles": [
    ]
}

Get subscription's vehicles as contractor

Get detailed vehicles for a specific subscription as contractor (The party of the authenticated user is the contractor of the subscription).

Authorizations:
(OAuth2ApiKeyAuth)
path Parameters
subscriptionCode
required
integer <int64> (subscriptionCode)
Example: 1000032

The subscription code

query Parameters
customerCode
integer <int64> (PartyCodeQueryParam)
Example: customerCode=1000001

Filters vehicles associated with a specific customer's unique code

customerSiteCode
integer <int64> (siteCode)
Example: customerSiteCode=1000032

Filters vehicles associated with a specific customer site unique code.

lastModifiedDateFrom
string <date-time> (LastModifiedDateFromQueryParam)
Example: lastModifiedDateFrom=2024-05-02T10:00:00

Date from for last update date of data

lastModifiedDateTo
string <date-time> (LastModifiedDateToQueryParam)
Example: lastModifiedDateTo=2024-05-02T10:00:00

Date to for last update date of data

offerCode
integer <int64> (offerCode)
Example: offerCode=100000

Filters vehicles by a specific offer's unique code

pageNumber
integer <int32> (PageNumberQueryParam) [ 1 .. 1000 ]
Default: 1
Example: pageNumber=2

The page number

pageSize
integer <int32> (PageSizeQueryParam) [ 1 .. 1000 ]
Default: 1000
Example: pageSize=2

The page size

withExtension
boolean (WithExtensionQueryParam)
Default: false
Example: withExtension=true

Whether to include the extension data

withInactive
boolean (WithInactiveQueryParam)
Default: false
Example: withInactive=true

Set to true to include inactive or expired vehicles in the results. If false (default), only active vehicles will be returned.

pending
boolean (PendingQueryParam)
Example: pending=true

Filters on vehicule status in the subscription. If not provided, the filter is not applied.

registrationNumber
string (RegistrationNumberQueryParam) <= 100 characters
Example: registrationNumber=FM-873-JN

Search by license plate (using a like)

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "vehicles": [
    ]
}

Get vehicles on inspector's subscriptions

Get vehicles on all the subscriptions for which the party of the authenticated user is the inspector

Authorizations:
(OAuth2ApiKeyAuth)
query Parameters
customerCode
integer <int64> (PartyCodeQueryParam)
Example: customerCode=1000001

Filters vehicles associated with a specific customer's unique code

customerSiteCode
integer <int64> (siteCode)
Example: customerSiteCode=1000032

Filters vehicles associated with a specific customer site unique code

lastModifiedDateFrom
string <date-time> (LastModifiedDateFromQueryParam)
Example: lastModifiedDateFrom=2024-05-02T10:00:00

Filters vehicles last modified on or after this date. Supports 'YYYY-MM-DDThh:mm:ss' format

lastModifiedDateTo
string <date-time> (LastModifiedDateToQueryParam)
Example: lastModifiedDateTo=2024-05-02T10:00:00

Filters vehicles last modified on or before this date. Supports 'YYYY-MM-DDThh:mm:ss' format

offerCode
integer <int64> (offerCode)
Example: offerCode=100000

Filters vehicles by a specific offer's unique code

pageNumber
integer <int32> (PageNumberQueryParam) [ 1 .. 1000 ]
Default: 1
Example: pageNumber=2

The page number

pageSize
integer <int32> (PageSizeQueryParam) [ 1 .. 1000 ]
Default: 1000
Example: pageSize=2

The page size

withExtension
boolean (WithExtensionQueryParam)
Default: false
Example: withExtension=true

Whether to include the extension data

withInactive
boolean (WithInactiveQueryParam)
Default: false
Example: withInactive=true

Set to true to include inactive or expired vehicles in the results. If false (default), only active vehicles will be returned

pending
boolean (PendingQueryParam)
Example: pending=true

Filters on vehicule status in the subscription. If not provided, the filter is not applied

registrationNumber
string (RegistrationNumberQueryParam) <= 100 characters
Example: registrationNumber=FM-873-JN

Search by license plate (using a like)

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "vehicles": [
    ]
}

Get subscription's vehicles as customer

Get vehicles under contract for a specific subscription as a customer

Authorizations:
(OAuth2ApiKeyAuth)
path Parameters
subscriptionCode
required
integer <int64> (subscriptionCode)
Example: 1000032

The subscription code

query Parameters
customerSiteCode
integer <int64> (siteCode)
Example: customerSiteCode=1000032

Filters vehicles associated with a specific customer site unique code.

lastModifiedDateFrom
string <date-time> (LastModifiedDateFromQueryParam)
Example: lastModifiedDateFrom=2024-05-02T10:00:00

Date from for last update date of data

lastModifiedDateTo
string <date-time> (LastModifiedDateToQueryParam)
Example: lastModifiedDateTo=2024-05-02T10:00:00

Date to for last update date of data

pageNumber
integer <int32> (PageNumberQueryParam) [ 1 .. 1000 ]
Default: 1
Example: pageNumber=2

The page number

pageSize
integer <int32> (PageSizeQueryParam) [ 1 .. 1000 ]
Default: 1000
Example: pageSize=2

The page size

withExtension
boolean (WithExtensionQueryParam)
Default: false
Example: withExtension=true

Whether to include the extension data

withInactive
boolean (WithInactiveQueryParam)
Default: false
Example: withInactive=true

Set to true to include inactive or expired vehicles in the results. If false (default), only active vehicles will be returned.

pending
boolean (PendingQueryParam)
Example: pending=true

Filters on vehicule status in the subscription. If not provided, the filter is not applied.

registrationNumber
string (RegistrationNumberQueryParam) <= 100 characters
Example: registrationNumber=FM-873-JN

Search by license plate (using a like)

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "vehicles": [
    ]
}

Users

Users operation with all operation types

Get users data

Get users data filtered by parameters

Authorizations:
(OAuth2ApiKeyAuth)
query Parameters
pageNumber
integer <int32> (PageNumberQueryParam) [ 1 .. 1000 ]
Default: 1
Example: pageNumber=2

The page number

pageSize
integer <int32> (PageSizeQueryParam) [ 1 .. 1000 ]
Default: 1000
Example: pageSize=2

The page size

hasCompany
boolean (HasCompanyQueryParam)
Default: true
Example: hasCompany=true

Filter users by company association

lastModifiedDateFrom
string <date-time> (LastModifiedDateFromQueryParam)
Example: lastModifiedDateFrom=2024-05-02T10:00:00

Filters users last modified on or after this date.

lastModifiedDateTo
string <date-time> (LastModifiedDateToQueryParam)
Example: lastModifiedDateTo=2024-05-02T10:00:00

Filters users last modified on or before this date.

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "users": [
    ]
}

Get a user

Retrieve a user by its okta token

Authorizations:
(OAuth2ApiKeyAuth)

Responses

Response samples

Content type
application/json
{
  • "code": 100001,
  • "userName": "pierre.martin@email.com",
  • "firstName": "Pierre",
  • "lastName": "Martin",
  • "active": true,
  • "language": "fr-FR",
  • "roles": [
    ],
  • "preferredSites": [
    ],
  • "partyCode": 1000726,
  • "sourceCode": "EMR-FR",
  • "sourceCountryCode": "FR",
  • "lastModifiedDate": "2024-12-27T12:23:23"
}

Update my own User

Partially updates a user's details. Currently, the only supported update is changing the user's language.

Authorizations:
(OAuth2ApiKeyAuth)
Request Body schema: application/json
language
string (languageQueryParam) <= 255 characters

Language of the translation (e.g. 'nl-NL', 'fr-FR')

Responses

Request samples

Content type
application/json
{
  • "language": "en-GB"
}

Response samples

Content type
application/json
{
  • "code": 100001,
  • "userName": "pierre.martin@email.com",
  • "firstName": "Pierre",
  • "lastName": "Martin",
  • "active": true,
  • "language": "fr-FR",
  • "roles": [
    ],
  • "preferredSites": [
    ],
  • "partyCode": 1000726,
  • "sourceCode": "EMR-FR",
  • "sourceCountryCode": "FR",
  • "lastModifiedDate": "2024-12-27T12:23:23"
}

Update my own party

Switches the authenticated user's active party to one of the parties he is authorized to access. The target party must belong to the user's list of authorized parties; any other value is rejected.

Authorizations:
(OAuth2ApiKeyAuth)
Request Body schema: application/json
code
required
integer <int64> (partyCode)

Party code of the source

Responses

Request samples

Content type
application/json
{
  • "code": "12345"
}

Response samples

Content type
application/json
{
  • "code": 100001,
  • "userName": "pierre.martin@email.com",
  • "firstName": "Pierre",
  • "lastName": "Martin",
  • "active": true,
  • "language": "fr-FR",
  • "roles": [
    ],
  • "preferredSites": [
    ],
  • "partyCode": 1000726,
  • "sourceCode": "EMR-FR",
  • "sourceCountryCode": "FR",
  • "lastModifiedDate": "2024-12-27T12:23:23"
}

Get authorised parties

Retrieve the code and name of my authorised parties.

Authorizations:
(OAuth2ApiKeyAuth)

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Update a user

Update a user by his code

Authorizations:
(OAuth2ApiKeyAuth)
path Parameters
userCode
required
integer <int64> (userCode)
Example: 1000032

Targeted user code

Request Body schema: application/json
language
string (language) <= 255 characters

Language of the translation (e.g. 'nl-NL', 'fr-FR')

Array of objects

List of role

Responses

Request samples

Content type
application/json
{
  • "language": "fr-FR",
  • "roles": [
    ]
}

Response samples

Content type
application/json
{
  • "code": 1000000
}

InspectorCustomers

Inspector customers operation with all operation types

Quick search customers data for which my company is assigned as Inspector service provider.

List of customers for which my company is assigned as Inspector service provider. Maximum number of results limited to 100.

Authorizations:
(OAuth2ApiKeyAuth)
query Parameters
name
required
string (CustomerNameQueryParam) [ 1 .. 100 ] characters
Example: name=Euromaster

The value contained in the customer's name

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Get a customer for which my company is assign as Inspector service provider.

Get a customer for which my company is assign as Inspector service provider.

Authorizations:
(OAuth2ApiKeyAuth)
path Parameters
partyCode
required
integer <int64> (PartyCodeQueryParam)
Example: 1000001

Refers to an end-customer

Responses

Response samples

Content type
application/json
{
  • "code": 1020202,
  • "name": "SARL BTP PRADELS",
  • "functionalRef": "B1234",
  • "type": "B2B",
  • "active": true,
  • "membership": "Association Charade",
  • "legalIdentifier": {
    },
  • "lastModifiedDate": "2024-12-27T12:23:23",
  • "lastModifiedBy": "user1"
}

Get my end-customers sites as Inspector service provider.

Get my end-customers sites as Inspector service provider.

Authorizations:
(OAuth2ApiKeyAuth)
path Parameters
partyCode
required
integer <int64> (PartyCodeQueryParam)
Example: 1000001

Targeted party code

query Parameters
pageNumber
integer <int32> (PageNumberQueryParam) [ 1 .. 1000 ]
Default: 1
Example: pageNumber=2

The page number

pageSize
integer <int32> (PageSizeQueryParam) [ 1 .. 1000 ]
Default: 1000
Example: pageSize=2

The page size

name
string (CustomerNameQueryParam) [ 1 .. 100 ] characters
Example: name=Euromaster

The value contained in the customer's name

withInactive
boolean (WithInactiveQueryParam)
Default: false
Example: withInactive=true

If filled then return active and inactive parties (default false)

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "sites": [
    ]
}

Get a end-customer's site as Inspection service provider.

Get a end-customer's site for which I'm the inspector.

Authorizations:
(OAuth2ApiKeyAuth)
path Parameters
partyCode
required
integer <int64> (PartyCodeQueryParam)
Example: 1000001

Refers to a end-customer

siteCode
required
integer <int64> (siteCode)
Example: 1000032

Refers to a end-customer's site

Responses

Response samples

Content type
application/json
{
  • "code": 100023,
  • "partyCode": 1000032,
  • "functionalRef": "B1234",
  • "active": true,
  • "name": "Euromaster Kepler",
  • "addressLine1": "Industrichone",
  • "addressLine2": "address 2",
  • "addressLine3": "address 3",
  • "postalCode": "42697",
  • "city": "Solingen",
  • "subdivision": "subdivision",
  • "countryCode": "DE",
  • "legalIdentifier": {
    },
  • "lastModifiedDate": "2024-12-27T12:23:23",
  • "lastModifiedBy": "user@email.com"
}

Suppliers

Suppliers operation with all operation types

List of active suppliers for which my company is customer

List of active suppliers for which my company is customer

Authorizations:
(OAuth2ApiKeyAuth)
query Parameters
limit
integer <int32> (Limit100QueryParam) [ 1 .. 100 ]
Default: 100
Example: limit=2

The limit size

offerType
string (OfferTypeQueryParam) <= 255 characters
Example: offerType=PROSPECTING

The offer type to search for

name
required
string (SupplierNameQueryParam) [ 1 .. 100 ] characters
Example: name=Euromaster

The name to search for

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Retrieves the list of sites associated with the supplier identified by partyCode.

Access is limited to suppliers related to the user's party, and appropriate permissions must be verified.

Authorizations:
(OAuth2ApiKeyAuth)
path Parameters
partyCode
required
integer <int64> (PartyCodeQueryParam)
Example: 1000001

Targeted party code

query Parameters
pageNumber
integer <int32> (PageNumberQueryParam) [ 1 .. 1000 ]
Default: 1
Example: pageNumber=2

The page number

pageSize
integer <int32> (PageSizeQueryParam) [ 1 .. 1000 ]
Default: 1000
Example: pageSize=2

The page size

name
string (SupplierNameQueryParam) [ 1 .. 100 ] characters
Example: name=Euromaster

The value contained in the supplier's name

withInactive
boolean (WithInactiveQueryParam)
Default: false
Example: withInactive=true

If filled then return active and inactive parties (default false)

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "sites": [
    ]
}

OfferScenarios

offerScenarios operation with all operation types

List all offerScenarios.

List all offerScenarios. Only scenarios linked to subscriptions for which the party of the user is the contractor are returned.

Authorizations:
(OAuth2ApiKeyAuth)
query Parameters
pageNumber
integer <int32> (PageNumberQueryParam) [ 1 .. 1000 ]
Default: 1
Example: pageNumber=2

The page number

pageSize
integer <int32> (PageSizeQueryParam) [ 1 .. 1000 ]
Default: 1000
Example: pageSize=2

The page size

lastModifiedDateFrom
string <date-time> (LastModifiedDateFromQueryParam)
Example: lastModifiedDateFrom=2024-05-02T10:00:00

Date from for last update date of data

lastModifiedDateTo
string <date-time> (LastModifiedDateToQueryParam)
Example: lastModifiedDateTo=2024-05-02T10:00:00

Date to for last update date of data

CreatedOrUpdatedBy
string (CreatedOrUpdatedByParam) [ 1 .. 255 ] characters
Example: CreatedOrUpdatedBy=user.valuecheck@euromaster.com

User name used to filter on the lastModifiedBy or createdBy fields.

customerCode
integer <int64> (customerCodeQueryParam)
Example: customerCode=100786

Filters by the customer code (corresponds to the party code in the Party repository).

subscriptionCode
integer <int64> (subscriptionCodeQueryParam)
Example: subscriptionCode=100786

Filters by the subscription code (corresponds to the subscription code in the Subscription repository).

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "offerScenarios": [
    ]
}

Create a new offer scenario

Create a new offer scenario

Authorizations:
(OAuth2ApiKeyAuth)
Request Body schema: application/json
name
required
string (offerScenarioName) <= 255 characters

Name given by the user to this specific scenario (Concatenation of the customer name, the last update date and the name of the scenario).

subscriptionCode
required
integer <int64> (subscriptionCode)

Unique code of the subscription

customerCode
required
integer <int64> (partyCode)

Refers to a customer party (code of the party into the Party repository).

siteCodes
Array of integers <int64> (siteCode) [ items <int64 > ]
inspectionsDateFrom
string <date> (startDateInspection)

Filters inspections for analytics on or after this date. Supports 'YYYY-MM-DD' format.

inspectionsDateTo
string <date> (endDateInspection)

Filters inspections for analytics on or before this date. Supports 'YYYY-MM-DD' format

geographicalScope
string (geographicScope) <= 255 characters

Geographical scope of the prospecting.

active
boolean (activeWithDefault)

Active flag

currency
string (CurrencyEnum)
Enum: "EUR" "CHF" "GBP" "RON" "CZK" "PLN" "SEK"

Offer scenario's Currency

object (FleetDataDTO)
object (OfferDataDTO)

Responses

Request samples

Content type
application/json

Create an offerScenario with the given information

{
  • "name": "offerScenario for my client",
  • "subscriptionCode": 110002,
  • "customerCode": 900001,
  • "siteCodes": [
    ],
  • "geographicalScope": "REGIONAL",
  • "inspectionsDateFrom": "2024-01-01",
  • "inspectionsDateTo": "2024-12-31",
  • "active": true,
  • "currency": "EUR",
  • "fleetData": {
    },
  • "offerData": {
    }
}

Response samples

Content type
application/json
{
  • "code": 2000002,
  • "name": "LondonUrbanDistribution",
  • "subscriptionCode": 110002,
  • "customerCode": 900001,
  • "siteCodes": [
    ],
  • "geographicalScope": "REGIONAL",
  • "inspectionsDateFrom": "2024-01-01",
  • "inspectionsDateTo": "2024-12-31",
  • "active": true,
  • "currency": "EUR",
  • "fleetData": {
    },
  • "offerData": {
    },
  • "lastModifiedDate": "2024-10-30T18:11:45",
  • "createdBy": "digital-clientid",
  • "lastModifiedBy": "digital-clientid-same-party"
}

Update an existing offerScenario

Update an existing offerScenario. This PUT functions like a PATCH (partial update is possible).

Authorizations:
(OAuth2ApiKeyAuth)
path Parameters
code
required
integer <int64> (offerScenarioCode)
Example: 100000

Refers to an offerScenario (code of the offerScenario into the offerScenario repository)

Request Body schema: application/json
name
required
string (offerScenarioName) <= 255 characters

Name given by the user to this specific scenario (Concatenation of the customer name, the last update date and the name of the scenario).

subscriptionCode
required
integer <int64> (subscriptionCode)

Unique code of the subscription

customerCode
required
integer <int64> (partyCode)

Refers to a customer party (code of the party into the Party repository).

siteCodes
Array of integers <int64> (siteCode) [ items <int64 > ]
inspectionsDateFrom
string <date> (startDateInspection)

Filters inspections for analytics on or after this date. Supports 'YYYY-MM-DD' format.

inspectionsDateTo
string <date> (endDateInspection)

Filters inspections for analytics on or before this date. Supports 'YYYY-MM-DD' format

geographicalScope
string (geographicScope) <= 255 characters

Geographical scope of the prospecting.

active
boolean (active)

Active flag

currency
string (CurrencyEnum)
Enum: "EUR" "CHF" "GBP" "RON" "CZK" "PLN" "SEK"

Offer scenario's Currency

object (FleetDataDTO)
object (OfferDataDTO)

Responses

Request samples

Content type
application/json

Update an existing offerScenario with the given information

{
  • "name": "offerScenario for my client",
  • "subscriptionCode": 110002,
  • "customerCode": 900001,
  • "siteCodes": [
    ],
  • "geographicalScope": "REGIONAL",
  • "inspectionsDateFrom": "2024-01-01",
  • "inspectionsDateTo": "2024-12-31",
  • "active": true,
  • "currency": "EUR",
  • "fleetData": {
    },
  • "offerData": {
    }
}

Response samples

Content type
application/json
{
  • "code": 2000002,
  • "name": "LondonUrbanDistribution",
  • "subscriptionCode": 110002,
  • "customerCode": 900001,
  • "siteCodes": [
    ],
  • "geographicalScope": "REGIONAL",
  • "inspectionsDateFrom": "2024-01-01",
  • "inspectionsDateTo": "2024-12-31",
  • "active": true,
  • "currency": "EUR",
  • "fleetData": {
    },
  • "offerData": {
    },
  • "lastModifiedDate": "2024-10-30T18:11:45",
  • "createdBy": "digital-clientid",
  • "lastModifiedBy": "digital-clientid-same-party"
}

get an offerScenario

get an offerScenario.

Authorizations:
(OAuth2ApiKeyAuth)
path Parameters
code
required
integer <int64> (offerScenarioCode)
Example: 100000

Refers to an offerScenario (code of the offerScenario into the offerScenario repository)

Responses

Response samples

Content type
application/json
{
  • "code": 2000002,
  • "name": "LondonUrbanDistribution",
  • "subscriptionCode": 110002,
  • "customerCode": 900001,
  • "siteCodes": [
    ],
  • "geographicalScope": "REGIONAL",
  • "inspectionsDateFrom": "2024-01-01",
  • "inspectionsDateTo": "2024-12-31",
  • "active": true,
  • "currency": "EUR",
  • "fleetData": {
    },
  • "offerData": {
    },
  • "lastModifiedDate": "2024-10-30T18:11:45",
  • "createdBy": "digital-clientid",
  • "lastModifiedBy": "digital-clientid-same-party"
}

TechnicianCustomers

Technician customers operation with all operation types

List of end-customers as Technician.

List of end-customers as Technician (only if there is a subscription line with these customers for which one of my preferred sites is job service provider). Maximum number of results limited to 100.

Authorizations:
(OAuth2ApiKeyAuth)
query Parameters
name
required
string (CustomerNameQueryParam) [ 1 .. 100 ] characters
Example: name=Euromaster

The value contained in the customer's name

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Get an end-customer as technician

Get an end-customer as technician (only if there is a subscription line with these customers for which one of my preferred sites is job service provider)

Authorizations:
(OAuth2ApiKeyAuth)
path Parameters
partyCode
required
integer <int64> (PartyCodeQueryParam)
Example: 1000001

Targeted party code

Responses

Response samples

Content type
application/json
{
  • "code": 1020202,
  • "name": "SARL BTP PRADELS",
  • "functionalRef": "B1234",
  • "type": "B2B",
  • "active": true,
  • "membership": "Association Charade",
  • "legalIdentifier": {
    },
  • "lastModifiedDate": "2024-12-27T12:23:23",
  • "lastModifiedBy": "user1"
}

Get my end-customers sites as Technician.

Get my end-customers sites as Technician (only if there is a subscription line with this customer for which one of my preferred sites is job service provider).

Authorizations:
(OAuth2ApiKeyAuth)
path Parameters
partyCode
required
integer <int64> (PartyCodeQueryParam)
Example: 1000001

Targeted party code

query Parameters
pageNumber
integer <int32> (PageNumberQueryParam) [ 1 .. 1000 ]
Default: 1
Example: pageNumber=2

The page number

pageSize
integer <int32> (PageSizeQueryParam) [ 1 .. 1000 ]
Default: 1000
Example: pageSize=2

The page size

name
string (CustomerNameQueryParam) [ 1 .. 100 ] characters
Example: name=Euromaster

The value contained in the customer's name

withInactive
boolean (WithInactiveQueryParam)
Default: false
Example: withInactive=true

Set to true to include inactive or expired sites in the results. If false (default), only active sites will be returned.

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "sites": [
    ]
}

PowerBIReport

Power BI Report operation with all operation types

Get information used to display a power BI report directly in a web interface.

Get information used to display a power BI report directly in a web interface. This endpoint manage the Azure authorization and the report's URL generation. The requester's role is important in validating access to the report.

Authorizations:
(OAuth2ApiKeyAuth)
path Parameters
id
required
string <uuid> (powerbiReportId)
Example: a1b2c3d4-e5f6-7890-abcd-ef1234567890

The identifier of the Power BI report in the CDL.

query Parameters
language
required
string (languageQueryParam) <= 255 characters
Example: language=fr-FR

Preferred language for displaying the report.

Responses

Response samples

Content type
application/json
{}

ValueCheck

ValueCheck operation with all operation types

Get the valueCheck report for an offerScenario

Get a valueCheck report from an existing offer scenario.

Authorizations:
(OAuth2ApiKeyAuth)
path Parameters
offerScenarioCode
required
integer <int64> (offerScenarioCode)
Example: 100000

The unique identifier of the offerScenario

query Parameters
language
string (languageQueryParam) <= 255 characters
Example: language=fr-FR

Language using ISO 639 and ISO 3166

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

AddressingCodes

AddressingCodes operation with all operation types

Get all entries from the addressing directory

Get a list of all entries from the addressing directory. Only users with ROUTING_MANAGER role can use this endpoint

Authorizations:
(OAuth2ApiKeyAuth)
query Parameters
pageNumber
integer <int32> (PageNumberQueryParam) [ 1 .. 1000 ]
Default: 1
Example: pageNumber=2

The number of page requested, minimum 1

pageSize
integer <int32> (PageSizeQueryParam) [ 1 .. 1000 ]
Default: 1000
Example: pageSize=2

The size of the page

lastModifiedDateFrom
string <date-time> (LastModifiedDateFromQueryParam)
Example: lastModifiedDateFrom=2024-05-02T10:00:00

last modified date from, must have the format yyyy-MM-ddTHH:mm:ss

lastModifiedDateTo
string <date-time> (LastModifiedDateToQueryParam)
Example: lastModifiedDateTo=2024-05-02T10:00:00

last modified date to, must have the format yyyy-MM-ddTHH:mm:ss

hasAssignedPlatform
boolean (HasAssignedPlatformQueryParam)
Example: hasAssignedPlatform=true

Filter entries managed by an appoved platform. Will be overridden to True if withExtendedResult is filled

isApplicable
boolean (IsApplicableQueryParam)
Example: isApplicable=true

Filter entries that are in the Euromaster scope. Will be overridden if withExtendedResult is filled, in accordance to its value

isRelevantForBackOffice
boolean (IsRelevantForBackOfficeQueryParam)
Example: isRelevantForBackOffice=true

Filter entries flagged as relevant for back office operations

isRelevantForEndOfYearRebate
boolean (IsRelevantForEndOfYearRebateQueryParam)
Example: isRelevantForEndOfYearRebate=true

Filter entries flagged as relevant for end of year rebates

isRelevantForFleets
boolean (IsRelevantForFleetsQueryParam)
Example: isRelevantForFleets=true

Filter entries flagged as relevant for fleet applications

isRelevantForOperations
boolean (IsRelevantForOperationsQueryParam)
Example: isRelevantForOperations=true

Filter entries flagged as relevant for operations applications

isRelevantForSelfBilling
boolean (IsRelevantForSelfBillingQueryParam)
Example: isRelevantForSelfBilling=true

Filter entries flagged as relevant for self billing

withExtendedResult
boolean (WithExtendedResultQueryParam)
Example: withExtendedResult=true

If false, returns only entries for restricted search. Else, returns full search. This parameter overrides withInactive to False, hasAssignedPlatform to True and isApplicable according to its value

withInactive
boolean (WithInactiveQueryParam)
Default: false
Example: withInactive=true

If false, returns only entries where the current date is between effectiveStartDate and effectiveEndDate. Will be overridden to False if withExtendedResult is filled

addressingReference
string (addressingReference) <= 255 characters
Example: addressingReference=123456789_12345678912345

Reference of the directory addressing code

code
integer <int64> (addressingCode)
Example: code=100001

Unique identifier of the addressing code

deliveredCustomerSiteExternalRef
string (DeliveredCustomerSiteExternalRefQueryParam) <= 255 characters
Example: deliveredCustomerSiteExternalRef=E0919590

Reference of the delivered customer's site in the external application

offerExternalName
string (offerName) <= 255 characters
Example: offerExternalName=Mastercare Plus

Name of the contract offer in source system. By default, no filter will be applied

siren
string (siren) <= 255 characters ^\d{9}$
Example: siren=824393151

SIREN of the company

siret
string (siret) <= 255 characters
Example: siret=36252187900034

SIRET

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "addressingCatalog": [
    ]
}

Create an addressing entry

This endpoint allows to intelligently creates or updates an addressing entry based on the business key (addressingReference + effectiveStartDate).

Authorizations:
(OAuth2ApiKeyAuth)
Request Body schema: application/json
addressingReference
required
string (addressingReference) <= 255 characters

Reference of the directory addressing code

siren
required
string (siren) <= 255 characters ^\d{9}$

SIREN (short for "Système d’Identification du Répertoire des ENtreprises") is a unique 9-digit identification number assigned by the French government (via INSEE) to every legal entity operating in France, such as companies, associations, or public institutions.

siret
string (siret) <= 255 characters

SIRET

routingCode
string (routingCode) <= 50 characters

Specific internal routing code (e.g., 'ACHATS', 'COMPTA')

suffix
string (suffix) <= 255 characters

Routing suffix

hasAssignedPlatform
boolean (hasAssignedPlatform)

Flag that indicates if the addressing code is managed by an appoved platform

offerCode
integer <int64> (offerCode)

Offer code

internalComment
string (internalComment) <= 255 characters

Euromaster designation for this addressing code

isApplicable
boolean (isApplicable)

Flag that indicates if the addressing code is in the Euromaster scope or not.If the value is null, that means the data management did not handle this record yet.

effectiveStartDate
string <date> (effectiveStartDate)

Effective start date of the addressing reference

effectiveEndDate
string <date> (effectiveEndDate)

Effective end date of the addressing reference

isRelevantForOperations
boolean (isRelevantForOperations)

Flag indicating whether the entry is useful for operations applications

isRelevantForFleets
boolean (isRelevantForFleets)

Flag indicating whether the entry is useful for fleet applications

isRelevantForBackOffice
boolean (isRelevantForBackOffice)

Flag indicating whether the entry is useful for back office operations

isRelevantForSelfBilling
boolean (isRelevantForSelfBilling)

Flag indicating whether the entry is useful for self billing

isRelevantForEndOfYearRebate
boolean (isRelevantForEndOfYearRebate)

Flag indicating whether the entry is useful for end of year rebates

Responses

Request samples

Content type
application/json
{
  • "addressingReference": "123456789_12345678912345",
  • "siren": "352870017",
  • "siret": "35287001700012",
  • "routingCode": "ACHATS",
  • "suffix": "B2B",
  • "hasAssignedPlatform": true,
  • "offerCode": 100001,
  • "internalComment": "Internal comment for Euromaster",
  • "isApplicable": true,
  • "effectiveStartDate": "2024-01-01",
  • "effectiveEndDate": "2026-01-01",
  • "isRelevantForOperations": false,
  • "isRelevantForFleets": false,
  • "isRelevantForBackOffice": false,
  • "isRelevantForSelfBilling": false,
  • "isRelevantForEndOfYearRebate": false
}

Response samples

Content type
application/json
{
  • "code": 100001,
  • "addressingReference": "123456789_12345678912345",
  • "siren": "352870017",
  • "siret": "35287001700012",
  • "routingCode": "ACHATS",
  • "suffix": "B2B",
  • "hasAssignedPlatform": true,
  • "offerCode": 100001,
  • "internalComment": "Internal comment for Euromaster",
  • "isApplicable": true,
  • "effectiveStartDate": "2024-01-01",
  • "effectiveEndDate": "2026-01-01",
  • "isRelevantForOperations": false,
  • "isRelevantForFleets": false,
  • "isRelevantForBackOffice": false,
  • "isRelevantForSelfBilling": false,
  • "isRelevantForEndOfYearRebate": false,
  • "lastModifiedDate": "2025-07-10T14:30:00",
  • "lastModifiedBy": "user1"
}

Partially updates an existing addressing entry

This endpoint allows to partially updates an existing addressing entry. This endpoint is strictly restricted to updating the internal comment and the relevance flags. Any other fields provided in the payload will be ignored or rejected.

Authorizations:
(OAuth2ApiKeyAuth)
path Parameters
addressingCode
required
integer <int64> (addressingCode)
Example: 100001

Unique internal identifier of the addressing entry to update

Request Body schema: application/json
offerCode
integer <int64> (offerCode)

Offer code

internalComment
string (internalComment) <= 255 characters

Euromaster designation for this addressing code

isApplicable
boolean (isApplicable)

Flag that indicates if the addressing code is in the Euromaster scope or not.If the value is null, that means the data management did not handle this record yet.

isRelevantForOperations
boolean (isRelevantForOperations)

Flag indicating whether the entry is useful for operations applications

isRelevantForFleets
boolean (isRelevantForFleets)

Flag indicating whether the entry is useful for fleet applications

isRelevantForBackOffice
boolean (isRelevantForBackOffice)

Flag indicating whether the entry is useful for back office operations

isRelevantForSelfBilling
boolean (isRelevantForSelfBilling)

Flag indicating whether the entry is useful for self billing

isRelevantForEndOfYearRebate
boolean (isRelevantForEndOfYearRebate)

Flag indicating whether the entry is useful for end of year rebates

Responses

Request samples

Content type
application/json
{
  • "offerCode": 100001,
  • "internalComment": "PARC TECHNO",
  • "isApplicable": true,
  • "isRelevantForOperations": false,
  • "isRelevantForFleets": false,
  • "isRelevantForBackOffice": false,
  • "isRelevantForSelfBilling": false,
  • "isRelevantForEndOfYearRebate": false
}

Response samples

Content type
application/json
[
  • {
    }
]

Countries

Get countries referential

Get countries referential

Authorizations:
(OAuth2ApiKeyAuth)
query Parameters
language
string (languageQueryParam) <= 255 characters
Example: language=fr-FR

Language for translation (e.g. 'nl-NL', 'fr-FR')

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Languages

Get languages referential endpoint

Get languages referential

Authorizations:
(OAuth2ApiKeyAuth)
query Parameters
language
string (languageQueryParam) <= 255 characters
Example: language=fr-FR

Language for translation

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Contacts

Get contacts data by fuzzy search

Retrieve contacts using fuzzy search on parameters like name, email, or phone number.

Authorizations:
(OAuth2ApiKeyAuth)
query Parameters
pageNumber
integer <int32> (PageNumberQueryParam) [ 1 .. 1000 ]
Default: 1
Example: pageNumber=2

The page number

pageSize
integer <int32> (PageSizeQueryParam) [ 1 .. 1000 ]
Default: 1000
Example: pageSize=2

The page size

search
string (SearchQueryParam) [ 3 .. 255 ] characters
Example: search=doe

Search using fuzzy search. The value is searched for simultaneously in: firstname, lastname, email, phoneNumber, mobilePhoneNumber

type
string (PartyTypeQueryParam) <= 255 characters
Example: type=B2B

The type of the party

partyCode
integer <int64> (PartyCodeQueryParam)
Example: partyCode=1000001

The code of the party

Responses

Response samples

Content type
application/json
Example
{
  • "pagination": {
    },
  • "contacts": [
    ]
}

OcodCockpit

Post OCOD cockpit data for a specific site

Add/update data used to measure the sales performance of a client site from OCOD.

Authorizations:
(OAuth2ApiKeyAuth)
path Parameters
siteExternalRef
required
string

The external reference identifier of the site.

Request Body schema: application/json

Request body

europeanSegmentation
string <= 255 characters

High-level grouping based on European regional business criteria.

firstEuropeanClassification
string <= 255 characters

Primary classification tier according to the European market structure.

secondEuropeanClassification
string <= 255 characters

Secondary, more granular classification tier for detailed targeting.

customerSize
string <= 255 characters

Categorization based on business volume (e.g., Small, Medium, Large, Key Account).

customerType
string <= 255 characters

Nature of the customer entity (e.g., Fleet, Dealer, End-User).

accountStatus
string <= 255 characters

Current operational status of the account (e.g., Active, Inactive, Prospect).

acquisitionDate
string <date>

The date when the customer was first onboarded or acquired.

kpiExtractDate
string <date>

The specific date when these performance indicators were extracted from the database.

currency
string (CurrencyEnum)
Enum: "EUR" "CHF" "GBP" "RON" "CZK" "PLN" "SEK"

Offer scenario's Currency

mainBrand12Months
string <= 255 characters

The primary brand purchased or used by the customer over the last 12 months.

mainMarket12Months
string <= 255 characters

The primary market segment the customer operated in during the last 12 months.

monthOfLastSales
string <date>

The most recent month and year in which a sale was recorded.

numberOfActivePlates12Months
integer

Total number of unique vehicle license plates active within the last 12 months.

numberOfActivePos12Months
integer

Number of active Points of Sale or delivery locations for the customer in the last 12 months.

previousAnnualSpend
number

Total amount spent by the customer during the previous full fiscal year.

productUniverse12Months
string <= 255 characters

The range or scope of product categories purchased by the customer in the last 12 months.

salesObjective
number

The internal revenue target or quota set for this customer.

salesPotential
number

Estimated total spending capacity of the customer for the given period.

smrHvPotentialTruckOnly
number

Estimated Service, Maintenance, and Repair (SMR) potential for Heavy Vehicles (Trucks only).

smrLvPotential
number

Estimated Service, Maintenance, and Repair (SMR) potential for Light Vehicles.

ytdSpend
number

Total Year-To-Date (YTD) spending by the customer for the current year.

ytdSpendYMinus1
number

Total Year-To-Date (YTD) spending by the customer for the same period last year.

countAgri
integer

Number of agricultural vehicles, such as tractors and self-propelled machinery.

countAgriTrailers
integer

Number of trailers specifically designed for agricultural use.

countBusesCoaches
integer

Number of passenger transport vehicles, including city buses and long-distance coaches.

countCars
integer

Number of standard passenger cars in the fleet.

countConstructionTrucks
integer

Number of trucks specialized for construction site work (e.g., tippers, concrete mixers).

countEarthmover
integer

Number of heavy machinery units used for earthmoving and excavation.

countHarvesters
integer

Number of harvesting machines (e.g., combine harvesters, forage harvesters).

countIndustrial
integer

Number of vehicles dedicated to industrial applications and site-specific tasks.

countLeasedConstructionTrucks
integer

Number of construction-specific trucks currently held under a leasing agreement.

countSmallTractors
integer

Number of utility or compact tractors, typically used for landscaping or small-scale farming.

countTrucks
integer

Number of standard freight trucks and heavy goods vehicles (HGV).

countVans
integer

Number of light commercial vehicles (LCV) used for deliveries or service tasks.

totalEarthmovers
integer

Total number of earthmoving and civil engineering machinery (e.g., excavators, bulldozers).

totalForklifts
integer

Total number of forklifts and material handling equipment.

totalHarbour
integer

Total number of specialized vehicles and equipment used in port or harbour environments.

totalIndustrialVehicles
integer

Total number of vehicles dedicated to industrial use (excluding standard forklifts).

totalOtherAgriVehicles
integer

Total number of miscellaneous agricultural vehicles not classified elsewhere.

totalTrailers
integer

Total number of trailers and semi-trailers associated with the fleet.

totalTrucks
integer

Total number of trucks (including rigid and tractor units) within the fleet.

Responses

Request samples

Content type
application/json

Add/update data used to measure the sales performance of a client site from OCOD.

{
  • "europeanSegmentation": "Segmentation",
  • "firstEuropeanClassification": "Segmentation",
  • "secondEuropeanClassification": "Segmentation",
  • "customerSize": "Large",
  • "customerType": "Fleet",
  • "accountStatus": "Active",
  • "acquisitionDate": "2018-03-15",
  • "kpiExtractDate": "2026-04-01",
  • "currency": "EUR",
  • "mainBrand12Months": "Michelin",
  • "mainMarket12Months": "Trucks",
  • "monthOfLastSales": "2026-03-01",
  • "numberOfActivePlates12Months": 45,
  • "numberOfActivePos12Months": 3,
  • "previousAnnualSpend": 125000,
  • "productUniverse12Months": "Tyres",
  • "salesObjective": 140000,
  • "salesPotential": 160000,
  • "smrHvPotentialTruckOnly": 50000,
  • "smrLvPotential": 20000,
  • "ytdSpend": 42000,
  • "ytdSpendYMinus1": 38000,
  • "countTrucks": 30,
  • "countVans": 15,
  • "countCars": 5,
  • "totalTrucks": 30,
  • "totalTrailers": 10
}

Response samples

Content type
application/json

Returns the saved OCOD Cockpit data for the customer site.

{
  • "siteCode": 100786,
  • "europeanSegmentation": "Fleet",
  • "firstEuropeanClassification": "Key Account",
  • "secondEuropeanClassification": "National Fleet",
  • "customerSize": "Large",
  • "customerType": "Fleet",
  • "accountStatus": "Active",
  • "acquisitionDate": "2018-03-15",
  • "kpiExtractDate": "2026-04-01",
  • "currency": "EUR",
  • "mainBrand12Months": "Michelin",
  • "mainMarket12Months": "Trucks",
  • "monthOfLastSales": "2026-03-01",
  • "numberOfActivePlates12Months": 45,
  • "numberOfActivePos12Months": 3,
  • "previousAnnualSpend": 125000,
  • "productUniverse12Months": "Tyres + SMR",
  • "salesObjective": 140000,
  • "salesPotential": 160000,
  • "smrHvPotentialTruckOnly": 50000,
  • "smrLvPotential": 20000,
  • "ytdSpend": 42000,
  • "ytdSpendYMinus1": 38000,
  • "countTrucks": 30,
  • "countVans": 15,
  • "countCars": 5,
  • "totalTrucks": 30,
  • "totalTrailers": 10,
  • "createdDate": "2026-04-10T08:00:00Z",
  • "createdBy": "system",
  • "lastModifiedDate": "2026-04-16T10:30:00",
  • "lastModifiedBy": "user1"
}

Get OCOD cockpit data for all sites

Retrieve data used to measure the sales performance of client sites from OCOD.

Authorizations:
(OAuth2ApiKeyAuth)
query Parameters
pageNumber
integer <int32> (PageNumberQueryParam) [ 1 .. 1000 ]
Default: 1
Example: pageNumber=2

The page number

pageSize
integer <int32> (PageSizeQueryParam) [ 1 .. 1000 ]
Default: 1000
Example: pageSize=2

The page size

lastModifiedDateFrom
string <date-time> (LastModifiedDateFromQueryParam)
Example: lastModifiedDateFrom=2024-05-02T10:00:00

Filters sites last modified on or after this date. Supports 'YYYY-MM-DDThh:mm:hh' format.

lastModifiedDateTo
string <date-time> (LastModifiedDateToQueryParam)
Example: lastModifiedDateTo=2024-05-02T10:00:00

Filters sites last modified on or before this date. Supports 'YYYY-MM-DDThh:mm:hh' format.

Responses

Response samples

Content type
application/json

Returns the OCOD Cockpit data for the customer sites.

{
  • "pagination": {
    },
  • "profile": [
    ]
}