Stockage
Fichiers, pièces justificatives et organisation en dossiers
Fichiers
Les fichiers sont les pièces justificatives rattachées à un exercice comptable. Le stockage utilise des URLs signées compatibles S3.
POST
/organizations/:idOrganization/years/:idYear/filesContent-Type: application/jsonAuthorization: Bearer <clé>
| Nom | Type | Requis |
|---|---|---|
| idFolder | string | non |
| reference | string | non |
| name | string | oui |
| hash | string | non |
GET
/organizations/:idOrganization/years/:idYear/filesContent-Type: application/jsonAuthorization: Bearer <clé>
Aucun champ requis
GET
/organizations/:idOrganization/years/:idYear/files/:idFileContent-Type: application/jsonAuthorization: Bearer <clé>
| Nom | Type | Requis |
|---|---|---|
| idFile | string | oui |
PATCH
/organizations/:idOrganization/years/:idYear/files/:idFileContent-Type: application/jsonAuthorization: Bearer <clé>
| Nom | Type | Requis |
|---|---|---|
| idFile | string | oui |
| reference | string | non |
| name | string | non |
| date | string | non |
| idFolder | string | non |
DELETE
/organizations/:idOrganization/years/:idYear/files/:idFileContent-Type: application/jsonAuthorization: Bearer <clé>
| Nom | Type | Requis |
|---|---|---|
| idFile | string | oui |
POST
/organizations/:idOrganization/years/:idYear/files/:idFile/upload-urlContent-Type: application/jsonAuthorization: Bearer <clé>
Générer une URL signée pour uploader un fichier. Taille maximale : 50 Mo.
| Nom | Type | Requis |
|---|---|---|
| idFile | string | oui |
| type | string | oui |
| size | number | oui |
POST
/organizations/:idOrganization/years/:idYear/files/:idFile/download-urlContent-Type: application/jsonAuthorization: Bearer <clé>
Générer une URL signée pour télécharger un fichier.
| Nom | Type | Requis |
|---|---|---|
| idFile | string | oui |
POST
/organizations/:idOrganization/years/:idYear/files/:idFile/delete-urlContent-Type: application/jsonAuthorization: Bearer <clé>
Générer une URL signée pour supprimer un fichier.
| Nom | Type | Requis |
|---|---|---|
| idFile | string | oui |
POST
/organizations/:idOrganization/years/:idYear/files/:idFile/finalizeContent-Type: application/jsonAuthorization: Bearer <clé>
Finaliser l'upload d'un fichier après avoir utilisé l'URL signée PUT.
| Nom | Type | Requis |
|---|---|---|
| idFile | string | oui |
POST
/organizations/:idOrganization/years/:idYear/files/:idFile/ocrContent-Type: application/jsonAuthorization: Bearer <clé>
Lancer la reconnaissance optique de caractères (OCR) sur un fichier. Nécessite des pages OCR disponibles.
| Nom | Type | Requis |
|---|---|---|
| idFile | string | oui |
Attention
La taille maximale par fichier est de 50 Mo. Au-delà, l'API retourne une erreur
400.Dossiers
Les dossiers permettent d'organiser les fichiers au sein d'un exercice. Ils supportent une hiérarchie imbriquée via le champ idFolderParent.
POST
/organizations/:idOrganization/years/:idYear/foldersContent-Type: application/jsonAuthorization: Bearer <clé>
| Nom | Type | Requis |
|---|---|---|
| idFolderParent | string | non |
| name | string | oui |
GET
/organizations/:idOrganization/years/:idYear/foldersContent-Type: application/jsonAuthorization: Bearer <clé>
Aucun champ requis
GET
/organizations/:idOrganization/years/:idYear/folders/:idFolderContent-Type: application/jsonAuthorization: Bearer <clé>
| Nom | Type | Requis |
|---|---|---|
| idFolder | string | oui |
PATCH
/organizations/:idOrganization/years/:idYear/folders/:idFolderContent-Type: application/jsonAuthorization: Bearer <clé>
| Nom | Type | Requis |
|---|---|---|
| idFolder | string | oui |
| name | string | non |
| idFolderParent | string | non |
DELETE
/organizations/:idOrganization/years/:idYear/folders/:idFolderContent-Type: application/jsonAuthorization: Bearer <clé>
| Nom | Type | Requis |
|---|---|---|
| idFolder | string | oui |