Journal Parameter
GET/journal
Returns a journal list
Link to technical documentation
EndPoint:
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.
Parameter
The C R UD – Retrieve resources.
"url": https://api.cegid.com/loop-api-publiques/journal?codeDossier=CEGID003
| Name | Description | example | mandatory | |
|---|---|---|---|---|
| codeDossier | Code Dossier | CEGID003 | Yes | |
| filter string (query) | Permet de filtrer le résultat | code=="ACH" | NO | |
| Sort | Permet de trier le résultat | ?filter="field==={filter}" | NO | |
| skip | Lets pass X éléments | ?skip="{number}" | NO | |
| take | Permet de récupérer X éléments | ?take="{number}" | NO |
Class Reponse
To retrieve a single resource the request should supply the UID.
| Action | Description | ||
|---|---|---|---|
| code string | The code of journal | ||
| libelle string | Description of journal | ||
| type Enum | 1-7 | ||
| compteContrepartie object | |||
| typeContrepartie boolean | example 1 | ||
| repriseDateOp boolean | false or true | ||
| beaurdereau boolean | false or true | ||
| ferme boolean | false or true | ||
| accesclient boolean | close | ||
| saisielibelle string | |||
Example response
[
{
"objectId": "976aa4f3-f6e8-4164-a960-0990bd558682",
"revisionId": "0x0000000000004678",
"description": [
"ACH"
],
"code": "ACH",
"libelle": "Journal achat",
"type": 1,
"compteContrepartie": {
"objectId": null,
"description": [
""
]
},
"typeContrepartie": 1,
"repriseDateOp": false,
"bordereau": true,
"ferme": false,
"accesClient": false,
"saisieLibelle": 2
}
]
POST/journal
adding a journal
Link to technical documentation
EndPoint:
POST https://api.cegid.com/loop-api-publiques/journal?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.
Parameter
The C R UD – Retrieve resources.
"url": https://api.cegid.com/loop-api-publiques/journal?codeDossier=CEGID003
| Name | Description | example | mandatory | |
|---|---|---|---|---|
| codeDossier | Code Dossier | CEGID003 | Yes |
On body
[
{
"code": "string",
"libelle": "string",
"type": "1",
"compteContrepartie": {
"objectId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
},
"typeContrepartie": "1",
"repriseDateOp": true,
"bordereau": true,
"ferme": true,
"accesClient": true,
"saisieLibelle": "1"
}
]
Class Reponse
To retrieve a single resource the request should supply the UID.
| Action | Description | ||
|---|---|---|---|
| code string | The code of journal | ||
| libelle string | Description of journal | ||
| type Enum | 1-7 | ||
| compteContrepartie object | |||
| typeContrepartie boolean | example 1 | ||
| repriseDateOp boolean | false or true | ||
| bordereau boolean | false or true | ||
| ferme boolean | false or true | ||
| accesclient boolean | close | ||
| saisielibelle string | |||
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": "AC1",
"libelle": "ACHAT",
"type": 1,
"compteContrepartie": {
"objectId": null,
"description": [
""
]
},
"typeContrepartie": 1,
"repriseDateOp": true,
"bordereau": true,
"ferme": true,
"accesClient": true,
"saisieLibelle": 1
}
]
Attention, before adding it is necessary to do the get journal in order to have objectId of the journal
Example response
[
{
"revisionId": "0x0000000000071C54",
"objectId": "c0e2f011-4f0d-4fb2-bdcb-0fdf79feb630",
"code": "AC2",
"libelle": "ACHAT",
"type": 1,
"compteContrepartie": {
"objectId": null
},
"typeContrepartie": 1,
"repriseDateOp": true,
"bordereau": true,
"ferme": true,
"accesClient": true,
"saisieLibelle": 1,
"created": "2022-06-02T12:47:51Z",
"updated": "2022-06-02T12:47:51Z"
}
]
PUT/journal
Modification of journal
Link to technical documentation
EndPoint:
PUT https://api.cegid.com/loop-api-publiques/journal?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.
Parameter
The C R UD – Retrieve resources.
"url": https://api.cegid.com/loop-api-publiques/journal?codeDossier=CEGID003
| Name | Description | example | mandatory |
|---|---|---|---|
| code string | The code of journal | ||
| libelle string | Description of journal | ||
| type Enum | 1-7 | ||
| compteContrepartie object | |||
| typeContrepartie boolean | example 1 | ||
| repriseDateOp boolean | false or true | ||
| beaurdereau boolean | false or true | ||
| ferme boolean | false or true | ||
| accesclient boolean | close | ||
| saisielibelle string | |||
Example body
Information:
Attention, before modifying it is necessary to do the get journal in order to have objectId of the journal
[
{
"revisionId": "0x0000000000071C55",
"objectId": "c0e2f011-4f0d-4fb2-bdcb-0fdf79feb630",
"code": "AC2",
"libelle": "ACHAT MARCHANDISE",
"type": 1,
"compteContrepartie": {
"objectId": null
},
"typeContrepartie": 1,
"repriseDateOp": true,
"bordereau": true,
"ferme": true,
"accesClient": true,
"saisieLibelle": 1,
"updated": "2022-06-02T13:13:56Z"
}
]
Example response
Response body
Download
[
{
"revisionId": "0x0000000000071C55",
"objectId": "c0e2f011-4f0d-4fb2-bdcb-0fdf79feb630",
"code": "AC2",
"libelle": "ACHAT MARCHANDISE",
"type": 1,
"compteContrepartie": {
"objectId": null
},
"typeContrepartie": 1,
"repriseDateOp": true,
"bordereau": true,
"ferme": true,
"accesClient": true,
"saisieLibelle": 1
}
]
DEL/journal
Delete of journal
Link to technical documentation
EndPoint:
DEL https://api.cegid.com/loop-api-publiques/journal?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.
Parameter
The C R UD – Retrieve resources.
"url": https://api.cegid.com/loop-api-publiques/journal?codeDossier=CEGID003
| Name | Description | example | mandatory |
|---|---|---|---|
| code string | The code of journal | ||
| libelle string | Description of journal | ||
| type Enum | 1-7 | ||
| compteContrepartie object | |||
| typeContrepartie boolean | example 1 | ||
| repriseDateOp boolean | false or true | ||
| beaurdereau boolean | false or true | ||
| ferme boolean | false or true | ||
| accesclient boolean | close | ||
| saisielibelle string | |||
Example body
Information:
Attention, before modifying it is necessary to do the get journal in order to have objectId of the journal
[
{
"revisionId": "0x0000000000071C55",
"objectId": "c0e2f011-4f0d-4fb2-bdcb-0fdf79feb630",
"code": "AC2",
"libelle": "ACHAT MARCHANDISE",
"type": 1,
"compteContrepartie": {
"objectId": null
},
"typeContrepartie": 1,
"repriseDateOp": true,
"bordereau": true,
"ferme": true,
"accesClient": true,
"saisieLibelle": 1,
"updated": "2022-06-02T13:13:56Z"
}
]
Example response
Response body
Download
[
{
"revisionId": "0x0000000000071C55",
"objectId": "c0e2f011-4f0d-4fb2-bdcb-0fdf79feb630",
"code": "AC2",
"libelle": "ACHAT MARCHANDISE",
"type": 1,
"compteContrepartie": {
"objectId": null
},
"typeContrepartie": 1,
"repriseDateOp": true,
"bordereau": true,
"ferme": true,
"accesClient": true,
"saisieLibelle": 1
}
]