Third-party customer
GET/tiersClient
Returns a Third-Party list
API Request/Response
example Code Description Links 200 class response
Media type
application/json Controls Accept header.
Therefore, all responses from the API are in the JSON format and all payloads to the API must be in the JSON format.
The request headers must contain Content-Type: application-json
.
Base URL
The base URL has the same structure for all public API requests. It consists of:
Domain | Mode | Role | |
---|---|---|---|
Example | https://loop.loopsoftware.fr | /YPN | /cabinet |
on cegid Developers : https://developers.cegid.com/api-details#api=loop-api-publiques&operation=gettiersclient
For the purpose of this document, Base URL will be referred to as <baseUrl>
.
Request Types
The base url is followed by one of Request Types:
query
for CRUD operations on modelstransaction
for transactional requestsserverless
for requests to server functionsservice
for requests to services
Parameter
The C R UD – Retrieve resources.
"url": hhttps://loop.loopsoftware.fr/collaborateur/service/publicapi/query/comptabilite/tiersClient?codeDossier=CEGID003
Name | Description | example | mandatory | |
---|---|---|---|---|
codeDossier | Code Dossier | CEGID003 | Yes | |
filter string (query) | Allows you to filter the result | code=="CLI0002" | NO | |
Sort | Allows you to sort the result | ?filter="field==={filter}" | NO | |
skip | Allows to pass X elements | ?skip="{number}" | NO | |
take | Allows to recover X elements | ?take="{number}" | NO |
Class Reponse
To retrieve a single resource the request should supply the UID.
Field | Description |
---|---|
code string | code of Third-party |
type string | Enum:Array [ 5 ] |
nature string | Enum:Array [ 2 ] |
prenom string | first name |
nom string | name |
raisonSociale string | |
nomUsuel string | |
lettrable boolean | |
compteContrepartie | {...} |
SIRET string | |
telephone string | |
fax string | |
email string | |
siteWeb string | |
adr | {...} |
rib | [...] |
actif boolean | |
validation | sEnum:Array [ 2 ] |
soumisTva boolean | |
numeroTva string | |
tva | {...} |
modePaiement | Enum:Array[ 11 ] |
fact | {...} |
Example response
[
{
"objectId": "8b9bc406-637a-4623-ba38-036b975ce3be",
"revisionId": "0x0000000000033A66",
"description": [
"CLI0002"
],
"code": "CLI0002",
"type": 0,
"nature": 2,
"prenom": "",
"nom": "",
"raisonSociale": "ESSAI client",
"nomUsuel": "ESSAI client",
"lettrable": true,
"compteContrepartie": {
"objectId": null,
"description": [
""
]
},
"SIRET": "",
"telephone": "",
"fax": "",
"email": "",
"siteWeb": "",
"adr": {
"adresse1": "",
"adresse2": "",
"adresse3": "",
"ville": "",
"codePostal": "",
"pays": {
"objectId": null,
"description": [
""
]
},
"geolocalisation": ""
}
]
POST/tiersClient
adding a Third-Party
POST https://developers.cegid.com/api-details#api=loop-api-publiques&operation=addtiersclient
API Request/Response
example Code Description Links 200 class response
Media type
application/json Controls Accept header.
Therefore, all responses from the API are in the JSON format and all payloads to the API must be in the JSON format.
The request headers must contain Content-Type: application-json
.
Base URL
The base URL has the same structure for all public API requests. It consists of:
Domain | Mode | Role | |
---|---|---|---|
Example | https://loop.loopsoftware.fr | /YPN | /cabinet |
on cegid Developers : https://developers.cegid.com/api-details#api=loop-api-publiques&operation=addtiersclient
For the purpose of this document, Base URL will be referred to as <baseUrl>
.
Request Types
The base url is followed by one of Request Types:
query
for CRUD operations on modelstransaction
for transactional requestsserverless
for requests to server functionsservice
for requests to services
Parameter
The C R UD – Retrieve resources.
Name | Description | example | mandatory | |
---|---|---|---|---|
codeDossier | Code Dossier | CEGID003 | Yes |
Description of body
To retrieve a single resource the request should supply the UID.
| Fields | nature | Description |
| :--------------- |:---------------:| -----:|
| code | string | The code of the third-party customer |
| type |Enum | {third-party customer:0,third-party provider:1,third-party employee:2,Prospect:3,third-party various:4} |
| nature |integer | Physical person:1,Corporation:2 |
| prenom |string | first name |
| nom |string | name |
| nomUsuel |string | Usual name |
| lettrable |boolean | false or true
| compteContrepartie |object | accountCounterparty |
| SIRET |string |
| telephone |string | Phone number |
| fax |string | Fax |
| email |string | Email |
| siteWeb |string | Web site |
| adr |object | Adresse |
| rib |object | Adresse |
| actif |Boolean | true or false |
| validation |integer | {Create:1, Valid:4} |
| tva |object | Vat |
| modePaiement |Enum | "1":None", "2":"Cash","3":"Bank check","4":"Bank card"/>,"5":"Payment","6":"debit","7":"TIP","8" :"LCR BOR","9":"LCR magnetic","10":"Traite","11" :"Telepayment"|
| tva |object | Mode Payment |
Example body
Information:
You cannot change the properties of a 'child' element You can add, edit or delete 'child' elements by including their 'objectId', all other properties will be ignored This also applies to 'child' elements in an array Adapt the example below if necessary.
{
"code": "Client003",
"type": 0,
"nature": 1,
"prenom": "Client 003",
"nom": " client",
"raisonSociale": "",
"nomUsuel": " client",
"lettrable": true,
"compteContrepartie" : {
"objectId" : null,
"description" : [
""
]
},
"SIRET": "",
"telephone": "0478338877",
"fax": "",
"email": "monclient@gmail.com",
"siteWeb": "www.cegid.com",
"adr": {
"adresse1": " av des alouette",
"adresse2": "",
"adresse3": "",
"ville": "",
"codePostal": "",
"pays": {
"objectId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
},
"geolocalisation": ""
},
"rib" : [ ],
"actif": true,
"validation": 1,
"soumisTva": true,
"numeroTva": "string",
"tva": {
"objectId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
},
"modePaiement": 1,
"fact": {}
}
]
Attention, before adding it is necessary to do the get Third-Party in order to have objectId of the Third-Party
Example response
[
{
"revisionId" : "0x000000000001BD59",
"objectId" : "06492d78-46a2-44e2-b110-9005a7785db2",
"code" : "Client003",
"type" : 2,
"nature" : 1,
"prenom" : "Client 003",
"nom" : " client",
"raisonSociale" : "",
"nomUsuel" : " client",
"lettrable" : true,
"compteContrepartie" : {
"objectId" : null
},
"SIRET" : "",
"telephone" : "0478338877",
"fax" : "",
"email" : "monclient@gmail.com",
"siteWeb" : "www.cegid.com",
"rib" : [ ],
"actif" : true,
"validation" : 1,
"soumisTva" : true,
"numeroTva" : "string",
"tva" : {
"objectId" : "3fa85f64-5717-4562-b3fc-2c963f66afa6"
},
"modePaiement" : 1,
"created" : "2022-06-28T12:41:30Z",
"updated" : "2022-06-28T12:41:30Z"
}
]
PUT/tiersClient
Modification of Third-Party
PUT https://api.cegid.com/loop-api-publiques/tiersClient?codeDossier={codeDossier}
API Request/Response
example Code Description Links 200 class response
Media type
application/json Controls Accept header.
Therefore, all responses from the API are in the JSON format and all payloads to the API must be in the JSON format.
The request headers must contain Content-Type: application-json
.
Base URL
The base URL has the same structure for all public API requests. It consists of:
Domain | Mode | Role | |
---|---|---|---|
Example | https://loop.loopsoftware.fr | /YPN | /cabinet |
on cegid Developers : https://developers.cegid.com/api-details#api=loop-api-publiques&operation=updatetiersclient
For the purpose of this document, Base URL will be referred to as <baseUrl>
.
Request Types
The base url is followed by one of Request Types:
query
for CRUD operations on modelstransaction
for transactional requestsserverless
for requests to server functionsservice
for requests to services
Parameter
The C R UD – Retrieve resources.
Name | Description | example | mandatory |
---|---|---|---|
codeDossier | Code Dossier | CEGID003 | Yes |
Class Reponse
To retrieve a single resource the request should supply the UID.
Field | Nature | ||
---|---|---|---|
code | string | ||
type | integer : 0 | ||
nature | integer : 1 | ||
prenom | string | ||
nom | string | ||
raisonSociale | string | ||
nomUsuel | string | ||
lettrable | Beelean :true | ||
compteContrepartie | : {objectId: "3fa85f64-5717-4562-b3fc-2c963f66afa6"} | ||
SIRET | string | ||
telephone | string | ||
fax | string | ||
string | |||
siteWeb | : | string | , |
adr | "adresse1": "string","adresse2": "string","adresse3": "string""ville": "string","codePostal": "string","pays": "objectId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" | ||
geolocalisation | string | ||
rib | objectId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" | ||
actif | true | ||
validation | 1 | ||
soumisTva | true | ||
numeroTva | string | ||
tva | {"objectId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"} | ||
modePaiement | 1 |
No links DELETE /tiersClient
Example body
Information:
You cannot change the properties of a 'child' element You can add, edit or delete 'child' elements by including their 'objectId', all other properties will be ignored This also applies to 'child' elements in an array Adapt the example below if necessary.
[
{
"objectId" : "815e7856-3182-4b28-8bb1-25eca3f2ebfd",
"revisionId" : "0x000000000001BD60",
"code" : "Client003",
"type" : 2,
"nature" : 1,
"prenom" : "Client 003",
"nom" : "Update client",
"raisonSociale" : "",
"nomUsuel" : " client",
"lettrable" : true,
"compteContrepartie" : {
"objectId" : null
},
"SIRET" : "",
"telephone" : "0478338877",
"fax" : "",
"email" : "monclient@gmail.com",
"siteWeb" : "www.cegid.com",
"rib" : [ ],
"actif" : true,
"validation" : 1,
"soumisTva" : true,
"numeroTva" : "string",
"tva" : {
"objectId" : null
},
"modePaiement" : 1,
"updated" : "2022-06-28T13:35:21Z"
}
]
Attention, before modifying it is necessary to do the get Third-Party in order to have objectId of the Third-Party
Example response
[[
{
"objectId" : "815e7856-3182-4b28-8bb1-25eca3f2ebfd",
"revisionId" : "0x000000000001BD60",
"code" : "Client003",
"type" : 2,
"nature" : 1,
"prenom" : "Client 003",
"nom" : "Update client",
"raisonSociale" : "",
"nomUsuel" : " client",
"lettrable" : true,
"compteContrepartie" : {
"objectId" : null
},
"SIRET" : "",
"telephone" : "0478338877",
"fax" : "",
"email" : "monclient@gmail.com",
"siteWeb" : "www.cegid.com",
"rib" : [ ],
"actif" : true,
"validation" : 1,
"soumisTva" : true,
"numeroTva" : "string",
"tva" : {
"objectId" : null
},
"modePaiement" : 1,
"updated" : "2022-06-28T13:35:21Z"
}
]
DEL/tiersClient
Delete of Third-Party
DEL https://api.cegid.com/loop-api-publiques/tiersClient?codeDossier={codeDossier}
API Request/Response
example Code Description Links 200 class response
Media type
application/json Controls Accept header.
Therefore, all responses from the API are in the JSON format and all payloads to the API must be in the JSON format.
The request headers must contain Content-Type: application-json
.
Base URL
The base URL has the same structure for all public API requests. It consists of:
Domain | Mode | Role | |
---|---|---|---|
Example | https://loop.loopsoftware.fr | /YPN | /cabinet |
on cegid Developers : https://developers.cegid.com/api-details#api=loop-api-publiques&operation=deletetiersclient
For the purpose of this document, Base URL will be referred to as <baseUrl>
.
Request Types
The base url is followed by one of Request Types:
query
for CRUD operations on modelstransaction
for transactional requestsserverless
for requests to server functionsservice
for requests to services
Parameter
The C R UD – Retrieve resources.
Name | Description | example | mandatory |
---|---|---|---|
codeDossier | Code Dossier | CEGID003 | Yes |
Class Reponse
To retrieve a single resource the request should supply the UID.
You can get objectId, revisionId by API Get before | Action | Description | | | |--------------------------------------------------------------------------------|---------------------------|----------------------|-------------------| numero string| The code of the Third-Party number| | | | objectId string | Description of id | | | | revisionId string | id | | |
Example body
Information:
Attention, before modifying it is necessary to do the get Third-Party in order to have objectId of the Third-Party
[
{
"revisionId": "0x000000000006DE0F",
"objectId": "95e17efe-bb83-4d19-9424-7d5d2383982a"
}
]
Example response
Response body
Download
[
{
"revisionId": "0x000000000006DE0F",
"objectId": "95e17efe-bb83-4d19-9424-7d5d2383982a"
}
]