Skip to main content
API docs by Redocly

Party API - Apigee (1.2.0)

Download OpenAPI specification:Download

License: Internal usage only

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

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": null,
  • "nationalIdentificationNumber": "12345678E",
  • "email": "mail@email.com",
  • "phoneNumber": "00 001 1111111",
  • "mobilePhoneNumber": null,
  • "birthDate": "1990-10-10",
  • "addressLine1": "Neumarkter Str.",
  • "addressLine2": null,
  • "addressLine3": null,
  • "postalCode": "44666",
  • "city": "City",
  • "subdivision": null,
  • "countryCode": "DE",
  • "communicationChannel": {
    },
  • "gdpr": {
    }
}

Response samples

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

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
[
  • {
    },
  • {
    }
]

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 <int32> (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": [
    ]
}

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 parties data

Get parties data by party code

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

Targeted party code

Responses

Response samples

Content type
application/json
{
  • "code": "100011",
  • "type": "B2C",
  • "active": true,
  • "membership": "Michelin",
  • "legalIdentifier": {
    },
  • "sites": [
    ],
  • "references": [
    ]
}

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-27:12: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 <int32> (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 <int32> (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-27:12:23:23"
}

Delete a party

Update a party to set his active attribute to false

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

Targeted party code

Responses

Response samples

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

Get sites for a party

Retrieve sites by party code

Authorizations:
(OAuth2ApiKeyAuth)
path Parameters
partyCode
required
integer <int32> (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 <int32> (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 <int32> (PartyCodeQueryParam)
Example: 1000001

Targeted party code

Responses

Response samples

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

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

Responses

Response samples

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

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

Responses

Response samples

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

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": null,
  • "addressLine3": null,
  • "postalCode": "42697",
  • "city": "Solingen",
  • "subdivision": null,
  • "countryCode": "DE"
}

Response samples

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

Create site data

Create site external

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

Party code of the source

externalRef
required
string (externalRef) <= 255 characters

External reference identifier

functionalRef
string (functionalRef) <= 255 characters

Functional reference identifier

name
string (name) <= 255 characters

The name

object (SiteLegalIdentifierDTO)

Legal identifier information

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

Create a site with the given informations

{
  • "externalRef": "UIOZE",
  • "partyCode": 1000032,
  • "functionalRef": "B1234",
  • "name": "Euromaster Kepler",
  • "legalIdentifier": {
    },
  • "addressLine1": "Industrichone",
  • "addressLine2": null,
  • "addressLine3": null,
  • "postalCode": "42697",
  • "city": "Solingen",
  • "subdivision": null,
  • "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> (SiteCodeQueryParam)
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": null,
  • "addressLine3": null,
  • "postalCode": "42697",
  • "city": "Solingen",
  • "subdivision": null,
  • "countryCode": "DE",
  • "lastModifiedDate": "2024-12-27:12:23:23"
}

Update a site

Update a site by his code

Authorizations:
(OAuth2ApiKeyAuth)
path Parameters
siteCode
required
integer <int64> (SiteCodeQueryParam)
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": null,
  • "addressLine3": null,
  • "postalCode": "42697",
  • "city": "Solingen",
  • "subdivision": null,
  • "countryCode": "DE"
}

Response samples

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

Delete a site

Update a site to set his active attribute to false

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

Targeted site code

Responses

Response samples

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

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
contractorCode
required
integer <int64> (partyCode)

Party code of the source

customerCode
required
integer <int64> (partyCode)

Party code of the source

offerCode
required
integer <int64> (offerCode)

Offer code

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

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

glAccount
integer <int64> (glAccount)

GL account linked to the supplier

Array of objects

List of subscription lines

Responses

Request samples

Content type
application/json
{
  • "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,
  • "lines": [
    ]
}

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,
  • "resale": false,
  • "nonResale": false,
  • "requiredPO": false,
  • "lastModifiedDate": "2024-12-27T12:23:23",
  • "glAccount": 607,
  • "lines": [
    ]
}

Get subscriptions data

Get subscriptions 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

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

Contractor party code

customerCode
integer <int32> (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 a subscription

Update a subscription by its code

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

Targeted subscription code

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

Offer code

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

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

glAccount
integer <int64> (glAccount)

GL account linked to the supplier

Responses

Request samples

Content type
application/json
{
  • "offerCode": 1000002,
  • "startDate": "2024-03-01",
  • "endDate": "2026-03-01",
  • "inspectionFrequency": 90,
  • "pressure": true,
  • "resale": false,
  • "nonResale": false,
  • "requiredPO": false,
  • "glAccount": 607
}

Response samples

Content type
application/json
{
  • "code": 1000000,
  • "contractorCode": 1000000,
  • "customerCode": 1000001,
  • "offerCode": 1000002,
  • "startDate": "2024-03-01",
  • "endDate": "2026-03-01",
  • "active": true,
  • "inspectionFrequency": 90,
  • "pressure": true,
  • "resale": false,
  • "nonResale": false,
  • "requiredPO": false,
  • "glAccount": 607,
  • "lastModifiedDate": "2024-12-27T12:23:23"
}

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> (CustomerSiteCodeParam)
Example: 100000

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> (CustomerSiteCodeParam)
Example: 100000

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 <int32> (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 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 <int32> (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

Responses

Response samples

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

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

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> (CustomerSiteCodeParam)
Example: 100000

Targeted customer site code

Responses

Response samples

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

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

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": [
    ],
  • "partyCode": 1000726,
  • "lastModifiedDate": "2024-12-27T12:23:23"
}

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 Inpector service provider

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

Authorizations:
(OAuth2ApiKeyAuth)
path Parameters
partyCode
required
integer <int32> (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 <int32> (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 inspector

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

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

Refers to a end-customer

siteCode
required
integer <int64> (SiteCodeQueryParam)
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": null,
  • "addressLine3": null,
  • "postalCode": "42697",
  • "city": "Solingen",
  • "subdivision": null,
  • "countryCode": "DE",
  • "legalIdentifier": {
    },
  • "lastModifiedDate": "2024-12-27:12:23:23",
  • "lastModifiedBy": "user@email.com"
}

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

Create contact data

Create contact external

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

External reference identifier

siteCode
integer <int64> (siteCode)

Site code of the source

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

email
string (email) <= 255 characters

The email address of the contact

phoneNumber
string (phoneNumber) <= 255 characters

The phone number of the contact

Responses

Request samples

Content type
application/json

Create a contact with the given informations

{
  • "externalRef": "CTC",
  • "siteCode": 100023,
  • "title": "M",
  • "firstName": "John",
  • "lastName": "Doe",
  • "secondLastName": "Doe2",
  • "email": "john.doe@mail.com",
  • "phoneNumber": "00 001 1111111"
}

Response samples

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