GererMesAffaires {REST:API}
Sécurisez vos données en interfaçant votre logiciel métier avec le service en ligne GererMesAffaires
COMMUNITYBEARER0 INSTALLS
OpenAPI Specificationv3.0
{
"openapi": "3.0.0",
"servers": [
{
"description": "Sandbox server for integrators",
"url": "https://sandbox.gerermesaffaires.com/api/v1/"
}
],
"info": {
"contact": {
"email": "api@gerermesaffaires.com"
},
"description": "Sécurisez vos données en interfaçant votre logiciel métier avec le service en ligne GererMesAffaires",
"title": "GererMesAffaires {REST:API}",
"version": "1.0.6",
"x-logo": {
"url": "https://api.apis.guru/v2/cache/logo/https_www.gerermesaffaires.com_wp-content_uploads_2019_09_cropped-logo-2019-180x180.png"
},
"x-origin": [
{
"format": "openapi",
"url": "https://api.gerermesaffaires.com/wp-content/uploads/2022/09/GmaAPI-GererMesAffairesAPI-1.0.6-swagger.json",
"version": "3.0"
}
],
"x-providerName": "gerermesaffaires.com"
},
"externalDocs": {
"description": "Documentation fonctionnelle des API GererMesAffaires",
"url": "https://api.gerermesaffaires.com/"
},
"security": [
{
"gma_auth": [
"collaborator",
"owner",
"robot"
]
}
],
"paths": {
"/box/menus": {
"get": {
"description": "Returns predefined folders and workbooks of the Box for all the spaces",
"responses": {
"200": {
"$ref": "#/components/responses/SpaceMenus"
}
},
"security": [
{
"gma_auth": [
"owner"
]
}
]
}
},
"/business-groups": {
"get": {
"description": "Returns a list of groups custom ordered by name",
"parameters": [
{
"description": "Name of the group",
"in": "query",
"name": "Name",
"required": false,
"schema": {
"example": "Dupond",
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/BusinessGroup"
}
},
"security": [
{
"gma_auth": [
"collaborator"
]
}
]
},
"patch": {
"description": "Modifies an object",
"requestBody": {
"$ref": "#/components/requestBodies/ModifyBusinessGroup"
},
"responses": {
"204": {
"description": "OK"
}
},
"security": [
{
"gma_auth": [
"collaborator"
]
}
]
},
"post": {
"description": "Adds a group (only for managers and ADN collaborators)",
"requestBody": {
"$ref": "#/components/requestBodies/BusinessGroup"
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"properties": {
"Id": {
"example": "P1234",
"type": "string"
}
},
"type": "object"
}
}
},
"description": "Id of group created",
"headers": {
"Location": {
"schema": {
"description": "path of the group created",
"example": "/business-groups/P64684",
"type": "string"
}
}
}
}
},
"security": [
{
"gma_auth": [
"collaborator"
]
}
]
}
},
"/business-groups/all": {
"get": {
"description": "Returns list of groups custom for managers",
"parameters": [
{
"description": "Name of the group",
"in": "query",
"name": "Name",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/BusinessGroup"
}
},
"security": [
{
"gma_auth": [
"collaborator"
]
}
]
}
},
"/business-groups/{id}": {
"get": {
"description": "Returns a group",
"parameters": [
{
"description": "Id of the group",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "P18784",
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/OneBusinessGroup"
}
},
"security": [
{
"gma_auth": [
"collaborator"
]
}
]
}
},
"/business-groups/{id}/spaces": {
"get": {
"description": "Returns spaces of the business group with id",
"parameters": [
{
"description": "Id of the group",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "P18784",
"type": "string"
}
},
{
"description": "Name of the space",
"in": "query",
"name": "Name",
"required": false,
"schema": {
"example": "Mon Entreprise",
"type": "string"
}
},
{
"description": "Type of the space",
"in": "query",
"name": "Type",
"required": false,
"schema": {
"enum": [
"private",
"enterprise",
"company",
"association"
],
"example": "private",
"type": "string"
}
},
{
"description": "registration number of the space",
"in": "query",
"name": "RegistrationNumber",
"required": false,
"schema": {
"example": "12345",
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Space"
}
},
"security": [
{
"gma_auth": [
"collaborator"
]
}
]
}
},
"/business-groups/{id}/spaces/{spaceId}": {
"delete": {
"description": "Remove a customer space from partner",
"parameters": [
{
"description": "Id of the group of the customer space",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "P18784",
"type": "string"
}
},
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P18784",
"type": "string"
}
}
],
"responses": {
"204": {
"description": "OK"
}
},
"security": [
{
"gma_auth": [
"collaborator"
]
}
]
}
},
"/business-groups/{id}/spaces/{spaceId}/legal-entities/{personId}/customers/{folderId}/guest-in-space": {
"post": {
"description": "send an invitation to manager the private space of personId",
"parameters": [
{
"description": "Id of the group",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "P18784",
"type": "string"
}
},
{
"description": "Id of the company space which contains the customer folder",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P18784",
"type": "string"
}
},
{
"description": "Id of the person customer",
"in": "path",
"name": "personId",
"required": true,
"schema": {
"example": "P18784",
"type": "string"
}
},
{
"description": "Id of the folder customer",
"in": "path",
"name": "folderId",
"required": true,
"schema": {
"example": "P18784",
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/PSpace"
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"properties": {
"Id": {
"example": "P1234",
"type": "string"
}
},
"type": "object"
}
}
},
"description": "Id of space created",
"headers": {
"Location": {
"schema": {
"description": "path of the space created",
"example": "/business-groups/P468486/spaces/P64684",
"type": "string"
}
}
}
}
},
"security": [
{
"gma_auth": [
"collaborator"
]
}
]
}
},
"/business-groups/{id}/spaces/{spaceId}/legal-entities/{personId}/customers/{folderId}/spaces": {
"post": {
"description": "Add a Space in a group",
"parameters": [
{
"description": "Id of the group",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "P18784",
"type": "string"
}
},
{
"description": "Id of the company space which contains the customer folder",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P18784",
"type": "string"
}
},
{
"description": "Id of the person customer",
"in": "path",
"name": "personId",
"required": true,
"schema": {
"example": "P18784",
"type": "string"
}
},
{
"description": "Id of the folder customer",
"in": "path",
"name": "folderId",
"required": true,
"schema": {
"example": "P18784",
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/BSpace"
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"properties": {
"Id": {
"example": "P1234",
"type": "string"
}
},
"type": "object"
}
}
},
"description": "Id of space created",
"headers": {
"Location": {
"schema": {
"description": "path of the space created",
"example": "/business-groups/P468486/spaces/P64684",
"type": "string"
}
}
}
}
},
"security": [
{
"gma_auth": [
"collaborator"
]
}
]
}
},
"/hub/business-groups/{Id}/menus": {
"get": {
"description": "Returns predefined folders and workbooks of the Hub for all the spaces of the business group",
"parameters": [
{
"description": "Id of the business group",
"in": "path",
"name": "Id",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/SpaceMenus"
}
},
"security": [
{
"gma_auth": [
"collaborator"
]
}
]
}
},
"/hub/documents": {
"post": {
"description": "Add a document (this document is analyzed to be saved in the correct folder and correct space)",
"requestBody": {
"$ref": "#/components/requestBodies/HubDocuments"
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"properties": {
"Id": {
"example": "T1234",
"type": "string"
}
},
"type": "object"
}
}
},
"description": "Id of documents created",
"headers": {
"Location": {
"schema": {
"description": "path of the documents created",
"example": "/hub/spaces/PFJOJAF14546/documents/P48548FDAF",
"type": "string"
}
}
}
}
},
"security": [
{
"gma_auth": [
"collaborator",
"owner",
"robot"
]
}
]
}
},
"/hub/menus": {
"get": {
"description": "Returns predefined folders and workbooks of the Hub for all the spaces",
"responses": {
"200": {
"$ref": "#/components/responses/SpaceMenus"
}
},
"security": [
{
"gma_auth": [
"collaborator"
]
}
]
}
},
"/hub/menus/all": {
"get": {
"description": "Returns predefined folders and workbooks of the Hub for all the spaces and customer spaces",
"responses": {
"200": {
"$ref": "#/components/responses/SpaceMenusAll"
}
},
"security": [
{
"gma_auth": [
"collaborator"
]
}
]
}
},
"/hub/payslips": {
"post": {
"description": "Add a payslip (this document is analyzed to be saved in the correct folder and correct space)",
"requestBody": {
"$ref": "#/components/requestBodies/HubDocuments"
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"properties": {
"Id": {
"example": "T1234",
"type": "string"
}
},
"type": "object"
}
}
},
"description": "Id of documents created",
"headers": {
"Location": {
"schema": {
"description": "path of the documents created",
"example": "/hub/spaces/PFJOJAF14546/documents/P48548FDAF",
"type": "string"
}
}
}
}
},
"security": [
{
"gma_auth": [
"collaborator",
"owner",
"robot"
]
}
]
}
},
"/hub/spaces/{spaceId}/documents": {
"post": {
"description": "Add a document in a space (this document is analyzed to be saved in the correct folder)",
"parameters": [
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Documents"
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"properties": {
"Id": {
"example": "T1234",
"type": "string"
}
},
"type": "object"
}
}
},
"description": "Id of documents created",
"headers": {
"Location": {
"schema": {
"description": "path of the documents created",
"example": "/hub/spaces/PFJOJAF14546/documents/P48548FDAF",
"type": "string"
}
}
}
}
},
"security": [
{
"gma_auth": [
"collaborator",
"owner",
"robot"
]
}
]
}
},
"/hub/spaces/{spaceId}/menus": {
"get": {
"description": "Returns predefined folders and workbooks of the Hub for the space",
"parameters": [
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Menus"
}
}
}
},
"/hub/spaces/{spaceId}/payslips": {
"post": {
"description": "Add a payslip in a space (this document is analyzed to be saved in the correct folder)",
"parameters": [
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Documents"
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"properties": {
"Id": {
"example": "T1234",
"type": "string"
}
},
"type": "object"
}
}
},
"description": "Id of documents created",
"headers": {
"Location": {
"schema": {
"description": "path of the documents created",
"example": "/hub/spaces/PFJOJAF14546/documents/P48548FDAF",
"type": "string"
}
}
}
}
},
"security": [
{
"gma_auth": [
"collaborator",
"owner",
"robot"
]
}
]
}
},
"/menus": {
"get": {
"description": "Returns predefined entries",
"responses": {
"200": {
"$ref": "#/components/responses/SpaceOneMenus"
}
}
}
},
"/menus/{menuId}/documents": {
"post": {
"description": "add a document to the target menuId",
"parameters": [
{
"description": "Id of the space",
"in": "path",
"name": "menuId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/MenuDocuments"
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"properties": {
"Report": {
"example": "T1234",
"type": "object"
}
},
"type": "object"
}
}
},
"description": "Report of upload"
}
},
"security": [
{
"gma_auth": [
"collaborator",
"owner",
"robot",
"box",
"hub"
]
}
]
}
},
"/profile": {
"get": {
"description": "Returns status of member",
"parameters": [
{
"description": "to get a contract (if not signed error 404 + html contract)",
"in": "query",
"name": "Contract",
"required": false,
"schema": {
"example": "member",
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/PartialProfile"
}
},
"security": [
{
"gma_auth": [
"owner"
]
}
]
},
"patch": {
"description": "modify infos of profile",
"requestBody": {
"$ref": "#/components/requestBodies/ModifyProfile"
},
"responses": {
"204": {
"description": "OK"
}
},
"security": [
{
"gma_auth": [
"owner"
]
}
]
},
"post": {
"description": "create infos of profile",
"requestBody": {
"$ref": "#/components/requestBodies/Profile"
},
"responses": {
"204": {
"description": "OK"
}
},
"security": [
{
"gma_auth": [
"owner"
]
}
]
}
},
"/profile/email": {
"patch": {
"description": "modify email of profile",
"requestBody": {
"$ref": "#/components/requestBodies/ModifyEmailProfile"
},
"responses": {
"204": {
"description": "OK"
}
},
"security": [
{
"gma_auth": [
"owner"
]
}
]
}
},
"/profile/id-file": {
"get": {
"description": "Returns status of member",
"parameters": [
{
"description": "to get a contract (if not signed error 404 + html contract)",
"in": "query",
"name": "Contract",
"required": false,
"schema": {
"example": "member",
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Profile"
}
}
}
},
"/profile/mobile": {
"patch": {
"description": "modify mobile of profile",
"requestBody": {
"$ref": "#/components/requestBodies/ModifyMobileProfile"
},
"responses": {
"204": {
"description": "OK"
}
},
"security": [
{
"gma_auth": [
"owner"
]
}
]
}
},
"/registration": {
"get": {
"description": "Returns the method to get the validation code or the link to register after invitation",
"parameters": [
{
"description": "Code of the invitation",
"in": "query",
"name": "Code",
"required": true,
"schema": {
"example": "HFIHA",
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Registration"
}
},
"security": [
{
"gma_auth": [
"owner"
]
}
]
},
"post": {
"description": "complete the invitation",
"requestBody": {
"$ref": "#/components/requestBodies/Registration"
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"properties": {
"Private": {
"properties": {
"FolderId": {
"example": "POJFA987EA",
"type": "string"
},
"SpaceId": {
"example": "P1234",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
}
},
"description": "Id of the private space and the contract folder"
}
},
"security": [
{
"gma_auth": [
"owner"
]
}
]
}
},
"/session": {
"get": {
"description": "Returns member id of user logged",
"responses": {
"200": {
"$ref": "#/components/responses/Session"
}
},
"security": [
{
"gma_auth": [
"collaborator",
"owner",
"robot"
]
}
]
}
},
"/spaces": {
"get": {
"description": "Returns spaces of my group",
"parameters": [
{
"description": "Name of the space",
"in": "query",
"name": "Name",
"required": false,
"schema": {
"example": "Mon Entreprise",
"type": "string"
}
},
{
"description": "Type of the space",
"in": "query",
"name": "Type",
"required": false,
"schema": {
"enum": [
"private",
"enterprise",
"company",
"association"
],
"example": "private",
"type": "string"
}
},
{
"description": "registration number of the space",
"in": "query",
"name": "RegistrationNumber",
"required": false,
"schema": {
"example": "12345",
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Space"
}
}
},
"post": {
"description": "Add a Space in my group",
"requestBody": {
"$ref": "#/components/requestBodies/Space"
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"properties": {
"Id": {
"example": "P1234",
"type": "string"
}
},
"type": "object"
}
}
},
"description": "Id of space created",
"headers": {
"Location": {
"schema": {
"description": "path of the space created",
"example": "/spaces/P64684",
"type": "string"
}
}
}
}
},
"security": [
{
"gma_auth": [
"collaborator",
"owner",
"robot"
]
}
]
}
},
"/spaces/all": {
"get": {
"description": "Returns all spaces",
"parameters": [
{
"description": "Name of the space",
"in": "query",
"name": "Name",
"required": false,
"schema": {
"example": "Mon Entreprise",
"type": "string"
}
},
{
"description": "Type of the space",
"in": "query",
"name": "Type",
"required": false,
"schema": {
"enum": [
"private",
"enterprise",
"company",
"association"
],
"example": "private",
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Space"
}
}
}
},
"/spaces/{id}": {
"delete": {
"description": "Delete a Space (only space not delivered to customer)",
"parameters": [
{
"description": "Id of the space",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "P18784",
"type": "string"
}
}
],
"responses": {
"204": {
"description": "OK"
}
}
},
"get": {
"description": "Returns a space",
"parameters": [
{
"description": "Id of the space",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "P18784",
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/OneSpace"
}
}
},
"patch": {
"description": "Modify a Space (except private)",
"parameters": [
{
"description": "Id of the space",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "P18784",
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/ModifySpace"
},
"responses": {
"204": {
"description": "OK"
}
}
}
},
"/spaces/{id}/accounting-year": {
"get": {
"description": "Returns list of accounting years for the space {id}",
"parameters": [
{
"description": "Id of the space",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "P15646476",
"type": "string"
}
},
{
"description": "End date of the accounting year (YYYYMM or YYYYMMDD) (range not available)",
"in": "query",
"name": "End",
"required": false,
"schema": {
"example": "201603",
"type": "string"
}
},
{
"description": "Effective date inside the accounting year (range not available)",
"in": "query",
"name": "EffectiveDate",
"required": false,
"schema": {
"example": "20160301",
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/AccountingYear"
}
}
},
"post": {
"description": "Create a accounting year for the space id",
"parameters": [
{
"description": "Id of the space",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "P198746",
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/AccountingYear"
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"properties": {
"Id": {
"example": "T1234",
"type": "string"
}
},
"type": "object"
}
}
},
"description": "Id of the accounting year created",
"headers": {
"Location": {
"schema": {
"description": "path of the accounting year created",
"example": "/spaces/P468486/accounting-year/T6JFH4FGFGGz84/",
"type": "string"
}
}
}
}
},
"security": [
{
"gma_auth": [
"collaborator",
"owner",
"robot"
]
}
]
}
},
"/spaces/{id}/collective-decision": {
"get": {
"description": "Returns list of collective decisions for the space {id}",
"parameters": [
{
"description": "Id of the space",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "P15646476",
"type": "string"
}
},
{
"description": "Date of the collective decision YYYMMDD",
"in": "query",
"name": "Date",
"required": false,
"schema": {
"example": "20160302,null",
"type": "string"
}
},
{
"description": "Event of the collective decision (see post for the list of events)",
"in": "query",
"name": "Event",
"required": false,
"schema": {
"example": "OGM",
"type": "string"
}
},
{
"description": "index range of the results",
"in": "query",
"name": "Range",
"required": false,
"schema": {
"example": "10-19",
"type": "string"
}
},
{
"description": "If true returns only invoices with a CompanyRegistrationCertificate",
"in": "query",
"name": "HasCompanyRegistrationCertificate",
"required": false,
"schema": {
"enum": [
"true",
"false"
],
"example": "true",
"type": "string"
}
},
{
"description": "If true returns only invoices with a Status",
"in": "query",
"name": "HasStatus",
"required": false,
"schema": {
"enum": [
"true",
"false"
],
"example": "true",
"type": "string"
}
},
{
"description": "If true returns only invoices with a SireneRegister",
"in": "query",
"name": "HasSireneRegister",
"required": false,
"schema": {
"enum": [
"true",
"false"
],
"example": "true",
"type": "string"
}
},
{
"description": "If true returns only invoices with Minutes",
"in": "query",
"name": "HasMinutes",
"required": false,
"schema": {
"enum": [
"true",
"false"
],
"example": "true",
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/CollectiveDecision"
}
}
},
"post": {
"description": "Create a colletive decision for the space id",
"parameters": [
{
"description": "Id of the space",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "P198746",
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/CollectiveDecision"
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"properties": {
"Id": {
"example": "T1234",
"type": "string"
}
},
"type": "object"
}
}
},
"description": "Id of the collective decision created",
"headers": {
"Location": {
"schema": {
"description": "path of the collective decision created",
"example": "/spaces/P468486/collective-decision/T6JFH4FGFGGz84/",
"type": "string"
}
}
}
}
},
"security": [
{
"gma_auth": [
"collaborator",
"owner",
"robot"
]
}
]
}
},
"/spaces/{id}/company-entities": {
"get": {
"description": "Returns list of company entities",
"parameters": [
{
"description": "Id of the space",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "P15646476",
"type": "string"
}
},
{
"description": "Name of the company entity",
"in": "query",
"name": "Name",
"required": false,
"schema": {
"example": "Source de France",
"type": "string"
}
},
{
"description": "Legal name of the company entity",
"in": "query",
"name": "LegalName",
"required": false,
"schema": {
"example": "Source de France SAS",
"type": "string"
}
},
{
"description": "registration number of the company entity",
"in": "query",
"name": "RegistrationNumber",
"required": false,
"schema": {
"example": "12356213854",
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/CompanyEntity"
}
}
},
"post": {
"description": "Add a Company Entity in a Space",
"parameters": [
{
"description": "Id of the space",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "T198746",
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/CompanyEntity"
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"properties": {
"Id": {
"example": "T1234",
"type": "string"
}
},
"type": "object"
}
}
},
"description": "Id of company entity created",
"headers": {
"Location": {
"schema": {
"description": "path of the company entity created",
"example": "/spaces/P468486/company-entities/P6JFH4FGFGGz84",
"type": "string"
}
}
}
}
},
"security": [
{
"gma_auth": [
"collaborator",
"owner",
"robot"
]
}
]
}
},
"/spaces/{id}/company-entities/all": {
"get": {
"description": "Returns list of company entities even company entities archived",
"parameters": [
{
"description": "Id of the space",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "P15646476",
"type": "string"
}
},
{
"description": "Name of the company entity",
"in": "query",
"name": "Name",
"required": false,
"schema": {
"example": "Source de France",
"type": "string"
}
},
{
"description": "registration number of the company entity",
"in": "query",
"name": "RegistrationNumber",
"required": false,
"schema": {
"example": "12356213854",
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/CompanyEntity"
}
}
}
},
"/spaces/{id}/company-entities/{companyId}": {
"get": {
"description": "Returns a compay entity",
"parameters": [
{
"description": "Id of the space",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "P15646476",
"type": "string"
}
},
{
"description": "Id of the company entity",
"in": "path",
"name": "companyId",
"required": true,
"schema": {
"example": "P15646476",
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/OneCompanyEntity"
}
}
},
"patch": {
"description": "Modify a company entity",
"parameters": [
{
"description": "Id of the space",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "P187867864",
"type": "string"
}
},
{
"description": "Id of the company entity to modify",
"in": "path",
"name": "companyId",
"required": true,
"schema": {
"example": "P1863763784",
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/ModifyCompanyEntity"
},
"responses": {
"204": {
"description": "OK"
}
}
}
},
"/spaces/{id}/company-entities/{personId}/details": {
"get": {
"description": "Returns all details of a company entity",
"parameters": [
{
"description": "Id of the space",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "P15646476",
"type": "string"
}
},
{
"description": "Id of the company entity to get",
"in": "path",
"name": "personId",
"required": true,
"schema": {
"example": "T18784",
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Details"
}
}
},
"post": {
"description": "Replace or Add a contact detail for a person",
"parameters": [
{
"description": "Id of the space",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "P18784",
"type": "string"
}
},
{
"description": "Id of the person or memberId",
"in": "path",
"name": "personId",
"required": true,
"schema": {
"example": "P18784",
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Details"
},
"responses": {
"204": {
"description": "OK"
}
}
}
},
"/spaces/{id}/company-entities/{personId}/details/{designation}": {
"delete": {
"description": "delete a contact detail for a company entity",
"parameters": [
{
"description": "Id of the space",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "P18784",
"type": "string"
}
},
{
"description": "Id of the person or memberId",
"in": "path",
"name": "personId",
"required": true,
"schema": {
"example": "P18784",
"type": "string"
}
},
{
"description": "designation",
"in": "path",
"name": "designation",
"required": true,
"schema": {
"example": "P18784",
"type": "string"
}
}
],
"responses": {
"204": {
"description": "OK"
}
}
}
},
"/spaces/{id}/documents/download": {
"post": {
"description": "create an archive with documents",
"parameters": [
{
"description": "Id of the space",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "P198746",
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Zip"
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"properties": {
"ZipFile": {
"example": "KPFKPKAAFKFJ",
"type": "string"
}
},
"type": "object"
}
},
"multipart/form-data": {
"schema": {
"properties": {
"ZipFile": {
"format": "binary",
"type": "string"
}
},
"type": "object"
}
}
},
"description": "Zip file base64 encoded",
"headers": {
"Location": {
"schema": {
"description": "path of the person created",
"example": "/spaces/P468486/zip/P6JFH4684",
"type": "string"
}
}
}
}
},
"security": [
{
"gma_auth": [
"collaborator",
"owner",
"robot"
]
}
]
}
},
"/spaces/{id}/folders/{folderId}/persons/{memberId}": {
"get": {
"description": "return the access of a person in a customer contract",
"parameters": [
{
"description": "Id of the space",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "P18784",
"type": "string"
}
},
{
"description": "memberId of the person",
"in": "path",
"name": "memberId",
"required": true,
"schema": {
"example": "P18784",
"type": "string"
}
},
{
"description": "id of the customer folder",
"in": "path",
"name": "folderId",
"required": true,
"schema": {
"example": "T18784",
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/PersonAccess"
}
}
},
"patch": {
"description": "Add/Modify/Delete a person in a customer contract (except manager)",
"parameters": [
{
"description": "Id of the space",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "P18784",
"type": "string"
}
},
{
"description": "memberId of the person",
"in": "path",
"name": "memberId",
"required": true,
"schema": {
"example": "P18784",
"type": "string"
}
},
{
"description": "id of the customer folder",
"in": "path",
"name": "folderId",
"required": true,
"schema": {
"example": "T18784",
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/ModifyCustomerCont"
},
"responses": {
"204": {
"description": "OK"
}
}
}
},
"/spaces/{id}/folders/{folderId}/persons/{memberId}/activeaccess": {
"patch": {
"description": "open an access",
"parameters": [
{
"description": "Id of the space",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "P18784",
"type": "string"
}
},
{
"description": "memberId of the person",
"in": "path",
"name": "memberId",
"required": true,
"schema": {
"example": "P18784",
"type": "string"
}
},
{
"description": "id of the customer folder",
"in": "path",
"name": "folderId",
"required": true,
"schema": {
"example": "T18784",
"type": "string"
}
}
],
"responses": {
"204": {
"description": "OK"
}
}
}
},
"/spaces/{id}/folders/{folderId}/persons/{memberId}/unactiveaccess": {
"patch": {
"description": "close an access",
"parameters": [
{
"description": "Id of the space",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "P18784",
"type": "string"
}
},
{
"description": "memberId of the person",
"in": "path",
"name": "memberId",
"required": true,
"schema": {
"example": "P18784",
"type": "string"
}
},
{
"description": "id of the customer folder",
"in": "path",
"name": "folderId",
"required": true,
"schema": {
"example": "T18784",
"type": "string"
}
}
],
"responses": {
"204": {
"description": "OK"
}
}
}
},
"/spaces/{id}/folders/{folderId}/persons/{personId}/guest-in-space": {
"post": {
"description": "invite a owner in a space",
"parameters": [
{
"description": "Id of the folder customer",
"in": "path",
"name": "folderId",
"required": true,
"schema": {
"example": "T198NFNIAJFAA46",
"type": "string"
}
},
{
"description": "Id of the person to invite to his space",
"in": "path",
"name": "personId",
"required": true,
"schema": {
"example": "P198NFNIAJFAA46",
"type": "string"
}
},
{
"description": "Id of the space",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvitationPerson"
}
}
},
"description": "PersonId (if exist)of the person in the customer space",
"required": true
},
"responses": {
"204": {
"description": "OK"
}
},
"security": [
{
"gma_auth": [
"collaborator",
"owner",
"robot"
]
}
]
}
},
"/spaces/{id}/groups": {
"get": {
"description": "Returns list of groups",
"parameters": [
{
"description": "Id of the space",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "P15646476",
"type": "string"
}
},
{
"description": "Name of the groups",
"in": "query",
"name": "Name",
"required": false,
"schema": {
"example": "RH",
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Group"
}
}
},
"post": {
"description": "Add a group in a Space",
"parameters": [
{
"description": "Id of the space",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "T198746",
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Group"
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"properties": {
"Id": {
"example": "T1234",
"type": "string"
}
},
"type": "object"
}
}
},
"description": "Id of company entity created",
"headers": {
"Location": {
"schema": {
"description": "path of the group created",
"example": "/spaces/P468486/groups/P6JFH4FGFGGz84",
"type": "string"
}
}
}
}
},
"security": [
{
"gma_auth": [
"collaborator",
"owner",
"robot"
]
}
]
}
},
"/spaces/{id}/groups/all": {
"get": {
"description": "Returns list of groups even archived of the space",
"parameters": [
{
"description": "Id of the space",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "P15646476",
"type": "string"
}
},
{
"description": "Name of the group",
"in": "query",
"name": "Name",
"required": false,
"schema": {
"example": "RH",
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Group"
}
}
}
},
"/spaces/{id}/groups/{groupId}": {
"get": {
"description": "Returns a group",
"parameters": [
{
"description": "Id of the space",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "P15646476",
"type": "string"
}
},
{
"description": "Id of the group",
"in": "path",
"name": "groupId",
"required": true,
"schema": {
"example": "P15646476",
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/OneGroup"
}
}
},
"patch": {
"description": "Modify a group",
"parameters": [
{
"description": "Id of the space",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "P187867864",
"type": "string"
}
},
{
"description": "Id of the group to modify",
"in": "path",
"name": "groupId",
"required": true,
"schema": {
"example": "P1863763784",
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/ModifyGroup"
},
"responses": {
"204": {
"description": "OK"
}
}
}
},
"/spaces/{id}/groups/{groupId}/folders/{folderId}": {
"delete": {
"description": "delete access to a folder for a group",
"parameters": [
{
"description": "Id of the space",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "P187867864",
"type": "string"
}
},
{
"description": "Id of the group to modify",
"in": "path",
"name": "groupId",
"required": true,
"schema": {
"example": "P1863763784",
"type": "string"
}
},
{
"description": "Id of the folder",
"in": "path",
"name": "folderId",
"required": true,
"schema": {
"example": "P1863763784",
"type": "string"
}
}
],
"responses": {
"204": {
"description": "OK"
}
}
},
"patch": {
"description": "Add access to a folder for a group",
"parameters": [
{
"description": "Id of the space",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "P187867864",
"type": "string"
}
},
{
"description": "Id of the group to modify",
"in": "path",
"name": "groupId",
"required": true,
"schema": {
"example": "P1863763784",
"type": "string"
}
},
{
"description": "Id of the folder",
"in": "path",
"name": "folderId",
"required": true,
"schema": {
"example": "P1863763784",
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/ModifyFolderGroup"
},
"responses": {
"204": {
"description": "OK"
}
}
}
},
"/spaces/{id}/groups/{groupId}/persons/{memberId}": {
"delete": {
"description": "Delete a person of a group",
"parameters": [
{
"description": "Id of the space",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "P187867864",
"type": "string"
}
},
{
"description": "Id of the group to modify",
"in": "path",
"name": "groupId",
"required": true,
"schema": {
"example": "P1863763784",
"type": "string"
}
},
{
"description": "MemberId of the person",
"in": "path",
"name": "memberId",
"required": true,
"schema": {
"example": "P1863763784",
"type": "string"
}
}
],
"responses": {
"204": {
"description": "OK"
}
}
},
"patch": {
"description": "Add a person to a group",
"parameters": [
{
"description": "Id of the space",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "P187867864",
"type": "string"
}
},
{
"description": "Id of the group to modify",
"in": "path",
"name": "groupId",
"required": true,
"schema": {
"example": "P1863763784",
"type": "string"
}
},
{
"description": "MemberId of the person",
"in": "path",
"name": "memberId",
"required": true,
"schema": {
"example": "P1863763784",
"type": "string"
}
}
],
"responses": {
"204": {
"description": "OK"
}
}
}
},
"/spaces/{id}/legal": {
"get": {
"description": "Returns legal information of a space (except private)",
"parameters": [
{
"description": "Id of the space",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "P18784",
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/OneLegal"
}
}
},
"patch": {
"description": "Modify legal information of a Space (except private)",
"parameters": [
{
"description": "Id of the space",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "P18784",
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/ModifyLegal"
},
"responses": {
"204": {
"description": "OK"
}
}
}
},
"/spaces/{id}/logo": {
"get": {
"description": "Returns a space with the logo",
"parameters": [
{
"description": "Id of the space",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "P18784",
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/OneSpaceWithLogo"
}
}
}
},
"/spaces/{id}/persons": {
"get": {
"description": "Returns list of persons",
"parameters": [
{
"description": "Id of the space",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "P15646476",
"type": "string"
}
},
{
"description": "Function of the person",
"in": "query",
"name": "Function",
"required": false,
"schema": {
"example": "employee",
"type": "string"
}
},
{
"description": "index range of the results",
"in": "query",
"name": "Range",
"required": false,
"schema": {
"example": "10-19",
"type": "string"
}
},
{
"description": "Name of the person",
"in": "query",
"name": "Name",
"required": false,
"schema": {
"example": "Germain",
"type": "string"
}
},
{
"description": "Status of the person",
"in": "query",
"name": "Validated",
"required": false,
"schema": {
"enum": [
"true",
"false"
],
"example": "true",
"type": "string"
}
},
{
"description": "Email of the person",
"in": "query",
"name": "Email",
"required": false,
"schema": {
"example": "maxgermain@maxgermain.com",
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Person"
}
}
},
"post": {
"description": "Add a Person in a Space",
"parameters": [
{
"description": "Id of the space",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "P198746",
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Person"
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"properties": {
"Id": {
"example": "T1234",
"type": "string"
}
},
"type": "object"
}
}
},
"description": "Id of person created",
"headers": {
"Location": {
"schema": {
"description": "path of the person created",
"example": "/spaces/P468486/persons/P6JFH4684",
"type": "string"
}
}
}
}
},
"security": [
{
"gma_auth": [
"collaborator",
"owner",
"robot"
]
}
]
}
},
"/spaces/{id}/persons/all": {
"get": {
"description": "Returns list of persons even persons archived",
"parameters": [
{
"description": "Id of the space",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "P15646476",
"type": "string"
}
},
{
"description": "Name of the person",
"in": "query",
"name": "Name",
"required": false,
"schema": {
"example": "Germain",
"type": "string"
}
},
{
"description": "Function of the person",
"in": "query",
"name": "Function",
"required": false,
"schema": {
"example": "employee",
"type": "string"
}
},
{
"description": "index range of the results",
"in": "query",
"name": "Range",
"required": false,
"schema": {
"example": "10-19",
"type": "string"
}
},
{
"description": "Status of the person",
"in": "query",
"name": "Validated",
"required": false,
"schema": {
"enum": [
"true",
"false"
],
"example": "true",
"type": "string"
}
},
{
"description": "Email of the person",
"in": "query",
"name": "Email",
"required": false,
"schema": {
"example": "maxgermain@maxgermain.com",
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Person"
}
}
}
},
"/spaces/{id}/persons/{memberId}/player": {
"patch": {
"description": "Modify the role of a person",
"parameters": [
{
"description": "Id of the space",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "P18784",
"type": "string"
}
},
{
"description": "memberId of the person",
"in": "path",
"name": "memberId",
"required": true,
"schema": {
"example": "P18784",
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/ModifyPlayer"
},
"responses": {
"204": {
"description": "OK"
}
}
}
},
"/spaces/{id}/persons/{personId}": {
"delete": {
"description": "delete a person",
"parameters": [
{
"description": "Id of the space",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "P18784",
"type": "string"
}
},
{
"description": "Id of the person to modify or memberId",
"in": "path",
"name": "personId",
"required": true,
"schema": {
"example": "P18784",
"type": "string"
}
}
],
"responses": {
"204": {
"description": "OK"
}
}
},
"get": {
"description": "Returns a person",
"parameters": [
{
"description": "Id of the space",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "P15646476",
"type": "string"
}
},
{
"description": "Id of the person to get or memberId",
"in": "path",
"name": "personId",
"required": true,
"schema": {
"example": "T18784",
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/OnePerson"
}
}
},
"patch": {
"description": "Modify a person",
"parameters": [
{
"description": "Id of the space",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "P18784",
"type": "string"
}
},
{
"description": "Id of the person to modify or memberId",
"in": "path",
"name": "personId",
"required": true,
"schema": {
"example": "P18784",
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/ModifyPerson"
},
"responses": {
"204": {
"description": "OK"
}
}
}
},
"/spaces/{id}/persons/{personId}/details": {
"get": {
"description": "Returns all details of a person",
"parameters": [
{
"description": "Id of the space",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "P15646476",
"type": "string"
}
},
{
"description": "Id of the person to get or memberId",
"in": "path",
"name": "personId",
"required": true,
"schema": {
"example": "T18784",
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Details"
}
}
},
"post": {
"description": "Replace or Add a contact detail for a person",
"parameters": [
{
"description": "Id of the space",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "P18784",
"type": "string"
}
},
{
"description": "Id of the person or memberId",
"in": "path",
"name": "personId",
"required": true,
"schema": {
"example": "P18784",
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Details"
},
"responses": {
"204": {
"description": "OK"
}
}
}
},
"/spaces/{id}/persons/{personId}/details/{designation}": {
"delete": {
"description": "delete a contact detail for a person",
"parameters": [
{
"description": "Id of the space",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "P18784",
"type": "string"
}
},
{
"description": "Id of the person or memberId",
"in": "path",
"name": "personId",
"required": true,
"schema": {
"example": "P18784",
"type": "string"
}
},
{
"description": "designation",
"in": "path",
"name": "designation",
"required": true,
"schema": {
"example": "P18784",
"type": "string"
}
}
],
"responses": {
"204": {
"description": "OK"
}
}
}
},
"/spaces/{id}/persons/{personId}/folders": {
"get": {
"description": "Returns list of folders with exceptionnal access of the person personId",
"parameters": [
{
"description": "Id of the space",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "P15646476",
"type": "string"
}
},
{
"description": "Id of the person to get folders",
"in": "path",
"name": "personId",
"required": true,
"schema": {
"example": "T18784",
"type": "string"
}
},
{
"description": "index range of the results",
"in": "query",
"name": "Range",
"required": false,
"schema": {
"example": "10-19",
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Folder"
}
}
}
},
"/spaces/{id}/persons/{personId}/groups": {
"get": {
"description": "Returns list of groups of the person personId",
"parameters": [
{
"description": "Id of the space",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "P15646476",
"type": "string"
}
},
{
"description": "Id of the person to get groups",
"in": "path",
"name": "personId",
"required": true,
"schema": {
"example": "T18784",
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Group"
}
}
}
},
"/spaces/{id}/persons/{personId}/portfolios": {
"get": {
"description": "Returns list of portfolios of the person personId",
"parameters": [
{
"description": "Id of the space",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "P15646476",
"type": "string"
}
},
{
"description": "Id of the person to get portfolios",
"in": "path",
"name": "personId",
"required": true,
"schema": {
"example": "T18784",
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Portfolios"
}
}
},
"post": {
"description": "Create a portfolio for the person personId",
"parameters": [
{
"description": "Id of the space",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "P198746",
"type": "string"
}
},
{
"description": "Id of the person who will be the owner of the portfolio",
"in": "path",
"name": "personId",
"required": true,
"schema": {
"example": "T18784",
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Portfolio"
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"properties": {
"Id": {
"example": "P1234",
"type": "string"
}
},
"type": "object"
}
}
},
"description": "Id of the portfolio created",
"headers": {
"Location": {
"schema": {
"description": "path of the portfolio created",
"example": "/spaces/P468486/persons/P6JFH4FGFGGz84/portfolios/PM6965TUGA",
"type": "string"
}
}
}
}
},
"security": [
{
"gma_auth": [
"collaborator",
"owner",
"robot"
]
}
]
}
},
"/spaces/{id}/portfolios/{portfolioId}/persons/{memberId}": {
"patch": {
"description": "Add/Modify/Delete a person in a portfolio (except manager)",
"parameters": [
{
"description": "Id of the space",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "P18784",
"type": "string"
}
},
{
"description": "memberId of the person",
"in": "path",
"name": "memberId",
"required": true,
"schema": {
"example": "P18784",
"type": "string"
}
},
{
"description": "id of the portfolio",
"in": "path",
"name": "portfolioId",
"required": true,
"schema": {
"example": "T18784",
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/ModifyPortfolio"
},
"responses": {
"204": {
"description": "OK"
}
}
}
},
"/spaces/{id}/professional-vehicles": {
"get": {
"description": "Returns list of professionalvehicles for the space {id}",
"parameters": [
{
"description": "Id of the space",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "P15646476",
"type": "string"
}
},
{
"description": "designation of the vehicle",
"in": "query",
"name": "Designation",
"required": false,
"schema": {
"example": "peugeot",
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/ProfessionalVehicle"
}
}
},
"post": {
"description": "Create a professional vehicle for the space",
"parameters": [
{
"description": "Id of the space",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "P198746",
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/ProfessionalVehicle"
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"properties": {
"Id": {
"example": "T1234",
"type": "string"
}
},
"type": "object"
}
}
},
"description": "Id of the professional vehicle created",
"headers": {
"Location": {
"schema": {
"description": "path of the professional vehicle created",
"example": "/spaces/P468486/professionalvehicles/T6JFH4FGFGGz84/",
"type": "string"
}
}
}
}
},
"security": [
{
"gma_auth": [
"collaborator",
"owner",
"robot"
]
}
]
}
},
"/spaces/{id}/settings/nf203/logs": {
"get": {
"description": "Returns state of activation of logs",
"parameters": [
{
"description": "Id of the space",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "P15646476",
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Logs"
}
},
"security": [
{
"gma_auth": [
"collaborator",
"owner",
"robot"
]
}
]
},
"post": {
"description": "Enable/Disable logs",
"parameters": [
{
"description": "Id of the space",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "P198746",
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Logs"
},
"responses": {
"204": {
"description": "Nothing"
}
},
"security": [
{
"gma_auth": [
"collaborator",
"owner",
"robot"
]
}
]
}
},
"/spaces/{id}/status": {
"get": {
"description": "Returns all status of the space",
"parameters": [
{
"description": "Id of the space",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "P15646476",
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Status"
}
}
},
"post": {
"description": "Replace or Add a status",
"parameters": [
{
"description": "Id of the space",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "P18784",
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Status"
},
"responses": {
"204": {
"description": "OK"
}
}
}
},
"/spaces/{id}/status/{code}": {
"delete": {
"description": "delete a status of the space",
"parameters": [
{
"description": "Id of the space",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "P18784",
"type": "string"
}
},
{
"description": "code of the status",
"in": "path",
"name": "code",
"required": true,
"schema": {
"example": "P18784",
"type": "string"
}
}
],
"responses": {
"204": {
"description": "OK"
}
}
}
},
"/spaces/{id}/tax-contracts": {
"get": {
"description": "Returns list of tax contracts for the space {id}",
"parameters": [
{
"description": "Id of the space",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "P15646476",
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/TaxContract"
}
}
},
"post": {
"description": "Create a tax contract for the space",
"parameters": [
{
"description": "Id of the space",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "P198746",
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/TaxContract"
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"properties": {
"Id": {
"example": "T1234",
"type": "string"
}
},
"type": "object"
}
}
},
"description": "Id of the tax contract created",
"headers": {
"Location": {
"schema": {
"description": "path of the tax contract created",
"example": "/spaces/P468486/taxcontract/T6JFH4FGFGGz84/",
"type": "string"
}
}
}
}
},
"security": [
{
"gma_auth": [
"collaborator",
"owner",
"robot"
]
}
]
}
},
"/spaces/{id}/triggers": {
"get": {
"description": "Returns list of triggers for the space {id}",
"parameters": [
{
"description": "Id of the space",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "P15646476",
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Triggers"
}
},
"security": [
{
"gma_auth": [
"collaborator",
"owner",
"robot"
]
}
]
}
},
"/spaces/{id}/triggers/{name}": {
"delete": {
"description": "Deletes a trigger for the space id",
"parameters": [
{
"description": "Id of the space",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "P198746",
"type": "string"
}
},
{
"description": "trigger name",
"in": "path",
"name": "name",
"required": true,
"schema": {
"example": "collect",
"type": "string"
}
}
],
"responses": {
"204": {
"description": "nothing"
}
},
"security": [
{
"gma_auth": [
"collaborator",
"owner",
"robot"
]
}
]
},
"post": {
"description": "Creates a trigger for the space id",
"parameters": [
{
"description": "Id of the space",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "P198746",
"type": "string"
}
},
{
"description": "trigger name",
"in": "path",
"name": "name",
"required": true,
"schema": {
"example": "collect",
"type": "string"
}
}
],
"responses": {
"201": {
"description": "nothing"
}
},
"security": [
{
"gma_auth": [
"collaborator",
"owner",
"robot"
]
}
]
}
},
"/spaces/{spaceId}/common-folders/{id}": {
"delete": {
"description": "Delete a common folder",
"parameters": [
{
"description": "Id of the folder",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "T18784",
"type": "string"
}
},
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
}
],
"responses": {
"204": {
"description": "OK"
}
}
},
"patch": {
"description": "Modify a common folder",
"parameters": [
{
"description": "Id of the folder",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "T18784",
"type": "string"
}
},
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/ModifyCFolder"
},
"responses": {
"204": {
"description": "OK"
}
}
}
},
"/spaces/{spaceId}/company-entities/{id}/follow-ups": {
"get": {
"description": "Returns folder of the company entity",
"parameters": [
{
"description": "Id of the company entity",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "T15646IFHA476",
"type": "string"
}
},
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Folder"
}
}
}
},
"/spaces/{spaceId}/customers": {
"get": {
"description": "Returns folder with Id and customer data",
"parameters": [
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
},
{
"description": "CustomerNumber of the customer",
"in": "query",
"name": "CustomerNumber",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "if present returns infos of the ContractingPartner too",
"in": "query",
"name": "WithContractingPartner",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Customer"
}
}
}
},
"/spaces/{spaceId}/customers/all": {
"get": {
"description": "Returns folder with Id and customer data (even archived)",
"parameters": [
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
},
{
"description": "CustomerNumber of the employee",
"in": "query",
"name": "CustomerNumber",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "if present returns infos of the ContractingPartner too",
"in": "query",
"name": "WithContractingPartner",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Customer"
}
}
}
},
"/spaces/{spaceId}/documents": {
"get": {
"description": "Returns documents of the folder",
"parameters": [
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
},
{
"description": "Text to find",
"in": "query",
"name": "FullText",
"required": false,
"schema": {
"example": "durand",
"type": "string"
}
},
{
"description": "index range of the results",
"in": "query",
"name": "Range",
"required": false,
"schema": {
"example": "10-19",
"type": "string"
}
},
{
"description": "class of the document to find",
"in": "query",
"name": "Class",
"required": false,
"schema": {
"example": "payslip",
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/DocumentSearch"
}
}
}
},
"/spaces/{spaceId}/documents/{documentId}": {
"patch": {
"description": "modify a doc",
"parameters": [
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
},
{
"description": "Id of the document",
"in": "path",
"name": "documentId",
"required": true,
"schema": {
"example": "PJOFJAFA8Y",
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/ModifyDocument"
},
"responses": {
"204": {
"description": "OK"
}
}
}
},
"/spaces/{spaceId}/documents/{documentId}/extend": {
"get": {
"description": "read the data of a document",
"parameters": [
{
"description": "Id of the document",
"in": "path",
"name": "documentId",
"required": true,
"schema": {
"example": "P15646IFHA476",
"type": "string"
}
},
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/DocumentData"
}
}
},
"post": {
"description": "Add a data to a document",
"parameters": [
{
"description": "Id of the document",
"in": "path",
"name": "documentId",
"required": true,
"schema": {
"example": "P1987HGFKJFAA46",
"type": "string"
}
},
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
},
"required": true
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"properties": {
"Id": {
"example": "P1234",
"type": "string"
}
},
"type": "object"
}
}
},
"description": "Id of document created",
"headers": {
"Location": {
"schema": {
"description": "path of the document created",
"example": "/folders/PFJOJAF14546/documents/P48548FDAF",
"type": "string"
}
}
}
}
},
"security": [
{
"gma_auth": [
"collaborator",
"owner",
"robot"
]
}
]
}
},
"/spaces/{spaceId}/documents/{documentId}/folders": {
"get": {
"description": "Returns versions of the document",
"parameters": [
{
"description": "Id of the document",
"in": "path",
"name": "documentId",
"required": true,
"schema": {
"example": "P15646IFHA476",
"type": "string"
}
},
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/OneDocumentFolders"
}
}
}
},
"/spaces/{spaceId}/documents/{documentId}/mailing": {
"post": {
"description": "send by mail a document",
"parameters": [
{
"description": "Id of the document",
"in": "path",
"name": "documentId",
"required": true,
"schema": {
"example": "P1987HGFKJFAA46",
"type": "string"
}
},
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/MailingDocument"
},
"responses": {
"200": {
"$ref": "#/components/responses/Mailing"
}
},
"security": [
{
"gma_auth": [
"collaborator",
"owner",
"robot"
]
}
]
}
},
"/spaces/{spaceId}/documents/{documentId}/mailingprice": {
"get": {
"description": "returns the number of pages and the price of the pdf to send by mail",
"parameters": [
{
"description": "Id of the document",
"in": "path",
"name": "documentId",
"required": true,
"schema": {
"example": "P1987HGFKJFAA46",
"type": "string"
}
},
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Mailing"
}
},
"security": [
{
"gma_auth": [
"collaborator",
"owner",
"robot"
]
}
]
}
},
"/spaces/{spaceId}/documents/{documentId}/versions": {
"get": {
"description": "Returns versions of the document",
"parameters": [
{
"description": "Id of the document",
"in": "path",
"name": "documentId",
"required": true,
"schema": {
"example": "P15646IFHA476",
"type": "string"
}
},
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Document"
}
}
},
"post": {
"description": "Add a version to a document and set it as current",
"parameters": [
{
"description": "Id of the document",
"in": "path",
"name": "documentId",
"required": true,
"schema": {
"example": "P1987HGFKJFAA46",
"type": "string"
}
},
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Version"
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"properties": {
"Id": {
"example": "P1234",
"type": "string"
}
},
"type": "object"
}
}
},
"description": "Id of document created",
"headers": {
"Location": {
"schema": {
"description": "path of the document created",
"example": "/folders/PFJOJAF14546/documents/P48548FDAF",
"type": "string"
}
}
}
}
},
"security": [
{
"gma_auth": [
"collaborator",
"owner",
"robot"
]
}
]
}
},
"/spaces/{spaceId}/documents/{documentId}/versions/current": {
"get": {
"description": "Returns current version of the document",
"parameters": [
{
"description": "Id of the document",
"in": "path",
"name": "documentId",
"required": true,
"schema": {
"example": "P15646IFHA476",
"type": "string"
}
},
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/CurrentDocument"
}
}
}
},
"/spaces/{spaceId}/documents/{id}/access": {
"get": {
"description": "Returns accesses of one document",
"parameters": [
{
"description": "Id of the document",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "P15646IFHA476",
"type": "string"
}
},
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/OneAccessDocument"
}
}
}
},
"/spaces/{spaceId}/documents/{id}/accounting": {
"get": {
"description": "Returns the document with the accounting property",
"parameters": [
{
"description": "Id of the document",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "P15646IFHA476",
"type": "string"
}
},
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/OneAccounting"
}
}
}
},
"/spaces/{spaceId}/documents/{id}/download": {
"get": {
"description": "Returns content of one document",
"parameters": [
{
"description": "Id of the document",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "P15646IFHA476",
"type": "string"
}
},
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/OneDocument",
"headers": {
"Content-Disposition": {
"schema": {
"description": "file namle",
"example": "attachment; filename=\"filename.extension\"",
"type": "string"
}
}
}
}
}
}
},
"/spaces/{spaceId}/employees": {
"get": {
"description": "Returns folders with Id and employee data",
"parameters": [
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
},
{
"description": "SSNumber of the employee",
"in": "query",
"name": "SSNumber",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "EmployeeNumber of the employee",
"in": "query",
"name": "EmployeeNumber",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "if present returns infos of the ContractingPartner too",
"in": "query",
"name": "WithContractingPartner",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Employee"
}
}
}
},
"/spaces/{spaceId}/employees/all": {
"get": {
"description": "Returns folders with Id and employee data (even archived)",
"parameters": [
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
},
{
"description": "SSNumber of the employee",
"in": "query",
"name": "SSNumber",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "EmployeeNumber of the employee",
"in": "query",
"name": "EmployeeNumber",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "if present returns infos of the ContractingPartner too",
"in": "query",
"name": "WithContractingPartner",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Employee"
}
}
}
},
"/spaces/{spaceId}/employers": {
"get": {
"description": "Returns folders with Id and employer data",
"parameters": [
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
},
{
"description": "EmployeeNumber of the employer contract",
"in": "query",
"name": "EmployeeNumber",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "if present returns infos of the ContractingPartner too",
"in": "query",
"name": "WithContractingPartner",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Employee"
}
}
}
},
"/spaces/{spaceId}/employers/all": {
"get": {
"description": "Returns folders with Id and employer data (even archived)",
"parameters": [
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
},
{
"description": "EmployeeNumber of the employer contract",
"in": "query",
"name": "EmployeeNumber",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "if present returns infos of the ContractingPartner too",
"in": "query",
"name": "WithContractingPartner",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Employee"
}
}
}
},
"/spaces/{spaceId}/extend": {
"get": {
"description": "read the data of a space",
"parameters": [
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/OneSpaceWithExtend"
}
}
},
"post": {
"description": "Add a data to a space",
"parameters": [
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
},
"required": true
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"properties": {
"Id": {
"example": "P1234",
"type": "string"
}
},
"type": "object"
}
}
},
"description": "Id of document created",
"headers": {
"Location": {
"schema": {
"description": "path of the document created",
"example": "/folders/PFJOJAF14546/documents/P48548FDAF",
"type": "string"
}
}
}
}
},
"security": [
{
"gma_auth": [
"collaborator",
"owner",
"robot"
]
}
]
}
},
"/spaces/{spaceId}/folders": {
"get": {
"description": "Returns folders of the space",
"parameters": [
{
"description": "Name of the folder",
"in": "query",
"name": "Name",
"required": false,
"schema": {
"example": "Secrétariat juridique",
"type": "string"
}
},
{
"description": "keywords attached to the folder",
"in": "query",
"name": "Keywords",
"required": false,
"schema": {
"example": "juridique",
"type": "string"
}
},
{
"description": "only root folders",
"in": "query",
"name": "RootFolders",
"required": false,
"schema": {
"enum": [
"all"
],
"example": "all",
"type": "string"
}
},
{
"description": "index range of the results",
"in": "query",
"name": "Range",
"required": false,
"schema": {
"example": "10-19",
"type": "string"
}
},
{
"description": "class of the folder",
"in": "query",
"name": "Class",
"required": false,
"schema": {
"example": "social",
"type": "string"
}
},
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Folder"
}
}
}
},
"/spaces/{spaceId}/folders/all": {
"get": {
"description": "Returns folders of the space (even archived)",
"parameters": [
{
"description": "Name of the folder",
"in": "query",
"name": "Name",
"required": false,
"schema": {
"example": "Secrétariat juridique",
"type": "string"
}
},
{
"description": "index range of the results",
"in": "query",
"name": "Range",
"required": false,
"schema": {
"example": "10-19",
"type": "string"
}
},
{
"description": "keywords attached to the folder",
"in": "query",
"name": "Keywords",
"required": false,
"schema": {
"example": "juridique",
"type": "string"
}
},
{
"description": "class of the folder",
"in": "query",
"name": "Class",
"required": false,
"schema": {
"example": "social",
"type": "string"
}
},
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Folder"
}
}
}
},
"/spaces/{spaceId}/folders/{folderId}/bank-statements/{documentId}": {
"delete": {
"description": "delete a bank statement",
"parameters": [
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
},
{
"description": "Id of the folder",
"in": "path",
"name": "folderId",
"required": true,
"schema": {
"example": "PJOFJAFA8Y",
"type": "string"
}
},
{
"description": "Id of the document",
"in": "path",
"name": "documentId",
"required": true,
"schema": {
"example": "PJOFJAFA8Y",
"type": "string"
}
}
],
"responses": {
"204": {
"description": "OK"
}
}
},
"patch": {
"description": "modify a bank statement",
"parameters": [
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
},
{
"description": "Id of the folder",
"in": "path",
"name": "folderId",
"required": true,
"schema": {
"example": "PJOFJAFA8Y",
"type": "string"
}
},
{
"description": "Id of the document",
"in": "path",
"name": "documentId",
"required": true,
"schema": {
"example": "PJOFJAFA8Y",
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/ModifyBankStatement"
},
"responses": {
"204": {
"description": "OK"
}
}
}
},
"/spaces/{spaceId}/folders/{folderId}/contractual-documents/{documentId}": {
"delete": {
"description": "delete a contractual document",
"parameters": [
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
},
{
"description": "Id of the folder",
"in": "path",
"name": "folderId",
"required": true,
"schema": {
"example": "PJOFJAFA8Y",
"type": "string"
}
},
{
"description": "Id of the document",
"in": "path",
"name": "documentId",
"required": true,
"schema": {
"example": "PJOFJAFA8Y",
"type": "string"
}
}
],
"responses": {
"204": {
"description": "OK"
}
}
},
"patch": {
"description": "modify a contractual document",
"parameters": [
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
},
{
"description": "Id of the folder",
"in": "path",
"name": "folderId",
"required": true,
"schema": {
"example": "PJOFJAFA8Y",
"type": "string"
}
},
{
"description": "Id of the document",
"in": "path",
"name": "documentId",
"required": true,
"schema": {
"example": "PJOFJAFA8Y",
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/ModifyContractualDocument"
},
"responses": {
"204": {
"description": "OK"
}
}
}
},
"/spaces/{spaceId}/folders/{folderId}/corporate-tax-declarations/{documentId}": {
"delete": {
"description": "delete a corporate tax declaration",
"parameters": [
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
},
{
"description": "Id of the folder",
"in": "path",
"name": "folderId",
"required": true,
"schema": {
"example": "PJOFJAFA8Y",
"type": "string"
}
},
{
"description": "Id of the document",
"in": "path",
"name": "documentId",
"required": true,
"schema": {
"example": "PJOFJAFA8Y",
"type": "string"
}
}
],
"responses": {
"204": {
"description": "OK"
}
}
},
"patch": {
"description": "modify a coporate tax declaration",
"parameters": [
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
},
{
"description": "Id of the folder",
"in": "path",
"name": "folderId",
"required": true,
"schema": {
"example": "PJOFJAFA8Y",
"type": "string"
}
},
{
"description": "Id of the document",
"in": "path",
"name": "documentId",
"required": true,
"schema": {
"example": "PJOFJAFA8Y",
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/ModifyCorporateTaxDeclaration"
},
"responses": {
"204": {
"description": "OK"
}
}
}
},
"/spaces/{spaceId}/folders/{folderId}/expense-proofs/{documentId}": {
"delete": {
"description": "delete an expense proof",
"parameters": [
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
},
{
"description": "Id of the folder",
"in": "path",
"name": "folderId",
"required": true,
"schema": {
"example": "PJOFJAFA8Y",
"type": "string"
}
},
{
"description": "Id of the document",
"in": "path",
"name": "documentId",
"required": true,
"schema": {
"example": "PJOFJAFA8Y",
"type": "string"
}
}
],
"responses": {
"204": {
"description": "OK"
}
}
},
"patch": {
"description": "modify an expense report",
"parameters": [
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
},
{
"description": "Id of the folder",
"in": "path",
"name": "folderId",
"required": true,
"schema": {
"example": "PJOFJAFA8Y",
"type": "string"
}
},
{
"description": "Id of the document",
"in": "path",
"name": "documentId",
"required": true,
"schema": {
"example": "PJOFJAFA8Y",
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/ModifyExpenseProof"
},
"responses": {
"204": {
"description": "OK"
}
}
}
},
"/spaces/{spaceId}/folders/{folderId}/expense-reports/{documentId}": {
"delete": {
"description": "delete an expense report",
"parameters": [
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
},
{
"description": "Id of the folder",
"in": "path",
"name": "folderId",
"required": true,
"schema": {
"example": "PJOFJAFA8Y",
"type": "string"
}
},
{
"description": "Id of the document",
"in": "path",
"name": "documentId",
"required": true,
"schema": {
"example": "PJOFJAFA8Y",
"type": "string"
}
}
],
"responses": {
"204": {
"description": "OK"
}
}
},
"patch": {
"description": "modify an expense report",
"parameters": [
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
},
{
"description": "Id of the folder",
"in": "path",
"name": "folderId",
"required": true,
"schema": {
"example": "PJOFJAFA8Y",
"type": "string"
}
},
{
"description": "Id of the document",
"in": "path",
"name": "documentId",
"required": true,
"schema": {
"example": "PJOFJAFA8Y",
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/ModifyExpenseReport"
},
"responses": {
"204": {
"description": "OK"
}
}
}
},
"/spaces/{spaceId}/folders/{folderId}/invoices/{documentId}": {
"delete": {
"description": "delete an invoice document",
"parameters": [
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
},
{
"description": "Id of the folder",
"in": "path",
"name": "folderId",
"required": true,
"schema": {
"example": "PJOFJAFA8Y",
"type": "string"
}
},
{
"description": "Id of the document",
"in": "path",
"name": "documentId",
"required": true,
"schema": {
"example": "PJOFJAFA8Y",
"type": "string"
}
}
],
"responses": {
"204": {
"description": "OK"
}
}
},
"patch": {
"description": "modify a invoice",
"parameters": [
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
},
{
"description": "Id of the folder",
"in": "path",
"name": "folderId",
"required": true,
"schema": {
"example": "PJOFJAFA8Y",
"type": "string"
}
},
{
"description": "Id of the document",
"in": "path",
"name": "documentId",
"required": true,
"schema": {
"example": "PJOFJAFA8Y",
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/ModifyInvoice"
},
"responses": {
"204": {
"description": "OK"
}
}
}
},
"/spaces/{spaceId}/folders/{folderId}/nominative-social-declarations/{documentId}": {
"get": {
"description": "get a nominative social declaration",
"parameters": [
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
},
{
"description": "Id of the folder",
"in": "path",
"name": "folderId",
"required": true,
"schema": {
"example": "PJOFJAFA8Y",
"type": "string"
}
},
{
"description": "Id of the document",
"in": "path",
"name": "documentId",
"required": true,
"schema": {
"example": "PJOFJAFA8Y",
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/OneNSD"
}
}
}
},
"/spaces/{spaceId}/folders/{folderId}/other-taxes/{documentId}": {
"delete": {
"description": "delete a tax declaration",
"parameters": [
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
},
{
"description": "Id of the folder",
"in": "path",
"name": "folderId",
"required": true,
"schema": {
"example": "PJOFJAFA8Y",
"type": "string"
}
},
{
"description": "Id of the document",
"in": "path",
"name": "documentId",
"required": true,
"schema": {
"example": "PJOFJAFA8Y",
"type": "string"
}
}
],
"responses": {
"204": {
"description": "OK"
}
}
},
"patch": {
"description": "modify an other tax declaration",
"parameters": [
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
},
{
"description": "Id of the folder",
"in": "path",
"name": "folderId",
"required": true,
"schema": {
"example": "PJOFJAFA8Y",
"type": "string"
}
},
{
"description": "Id of the document",
"in": "path",
"name": "documentId",
"required": true,
"schema": {
"example": "PJOFJAFA8Y",
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/ModifyOtherTax"
},
"responses": {
"204": {
"description": "OK"
}
}
}
},
"/spaces/{spaceId}/folders/{folderId}/payrolls/{documentId}": {
"delete": {
"description": "delete a payroll",
"parameters": [
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
},
{
"description": "Id of the folder",
"in": "path",
"name": "folderId",
"required": true,
"schema": {
"example": "PJOFJAFA8Y",
"type": "string"
}
},
{
"description": "Id of the document",
"in": "path",
"name": "documentId",
"required": true,
"schema": {
"example": "PJOFJAFA8Y",
"type": "string"
}
}
],
"responses": {
"204": {
"description": "OK"
}
}
},
"patch": {
"description": "modify a payroll",
"parameters": [
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
},
{
"description": "Id of the folder",
"in": "path",
"name": "folderId",
"required": true,
"schema": {
"example": "PJOFJAFA8Y",
"type": "string"
}
},
{
"description": "Id of the document",
"in": "path",
"name": "documentId",
"required": true,
"schema": {
"example": "PJOFJAFA8Y",
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/ModifyPayroll"
},
"responses": {
"204": {
"description": "OK"
}
}
}
},
"/spaces/{spaceId}/folders/{folderId}/payrolls/{documentId}/refresh": {
"post": {
"description": "recalculate a payroll",
"parameters": [
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
},
{
"description": "Id of the folder",
"in": "path",
"name": "folderId",
"required": true,
"schema": {
"example": "PJOFJAFA8Y",
"type": "string"
}
},
{
"description": "Id of the document",
"in": "path",
"name": "documentId",
"required": true,
"schema": {
"example": "PJOFJAFA8Y",
"type": "string"
}
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"properties": {
"Id": {
"example": "T1234",
"type": "string"
}
},
"type": "object"
}
}
},
"description": "Id of the payroll generated"
},
"204": {
"description": "OK"
}
}
}
},
"/spaces/{spaceId}/folders/{folderId}/payslips/{documentId}": {
"delete": {
"description": "delete a payslip",
"parameters": [
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
},
{
"description": "Id of the folder",
"in": "path",
"name": "folderId",
"required": true,
"schema": {
"example": "PJOFJAFA8Y",
"type": "string"
}
},
{
"description": "Id of the document",
"in": "path",
"name": "documentId",
"required": true,
"schema": {
"example": "PJOFJAFA8Y",
"type": "string"
}
}
],
"responses": {
"204": {
"description": "OK"
}
}
},
"patch": {
"description": "modify a payslip",
"parameters": [
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
},
{
"description": "Id of the folder",
"in": "path",
"name": "folderId",
"required": true,
"schema": {
"example": "PJOFJAFA8Y",
"type": "string"
}
},
{
"description": "Id of the document",
"in": "path",
"name": "documentId",
"required": true,
"schema": {
"example": "PJOFJAFA8Y",
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/ModifyPayslip"
},
"responses": {
"204": {
"description": "OK"
}
}
}
},
"/spaces/{spaceId}/folders/{folderId}/social-contracts/{documentId}": {
"delete": {
"description": "delete a social contract",
"parameters": [
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
},
{
"description": "Id of the folder",
"in": "path",
"name": "folderId",
"required": true,
"schema": {
"example": "PJOFJAFA8Y",
"type": "string"
}
},
{
"description": "Id of the document",
"in": "path",
"name": "documentId",
"required": true,
"schema": {
"example": "PJOFJAFA8Y",
"type": "string"
}
}
],
"responses": {
"204": {
"description": "OK"
}
}
},
"patch": {
"description": "modify a social contract",
"parameters": [
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
},
{
"description": "Id of the folder",
"in": "path",
"name": "folderId",
"required": true,
"schema": {
"example": "PJOFJAFA8Y",
"type": "string"
}
},
{
"description": "Id of the document",
"in": "path",
"name": "documentId",
"required": true,
"schema": {
"example": "PJOFJAFA8Y",
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/ModifySocialContract"
},
"responses": {
"204": {
"description": "OK"
}
}
}
},
"/spaces/{spaceId}/folders/{folderId}/social-declarations/{documentId}": {
"delete": {
"description": "delete a social declaration",
"parameters": [
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
},
{
"description": "Id of the folder",
"in": "path",
"name": "folderId",
"required": true,
"schema": {
"example": "PJOFJAFA8Y",
"type": "string"
}
},
{
"description": "Id of the document",
"in": "path",
"name": "documentId",
"required": true,
"schema": {
"example": "PJOFJAFA8Y",
"type": "string"
}
}
],
"responses": {
"204": {
"description": "OK"
}
}
},
"patch": {
"description": "modify a social declaration",
"parameters": [
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
},
{
"description": "Id of the folder",
"in": "path",
"name": "folderId",
"required": true,
"schema": {
"example": "PJOFJAFA8Y",
"type": "string"
}
},
{
"description": "Id of the document",
"in": "path",
"name": "documentId",
"required": true,
"schema": {
"example": "PJOFJAFA8Y",
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/ModifySocialDeclaration"
},
"responses": {
"204": {
"description": "OK"
}
}
}
},
"/spaces/{spaceId}/folders/{folderId}/vat-declarations/{documentId}": {
"delete": {
"description": "delete a VAT declaration",
"parameters": [
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
},
{
"description": "Id of the folder",
"in": "path",
"name": "folderId",
"required": true,
"schema": {
"example": "PJOFJAFA8Y",
"type": "string"
}
},
{
"description": "Id of the document",
"in": "path",
"name": "documentId",
"required": true,
"schema": {
"example": "PJOFJAFA8Y",
"type": "string"
}
}
],
"responses": {
"204": {
"description": "OK"
}
}
},
"patch": {
"description": "modify a vat declaration",
"parameters": [
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
},
{
"description": "Id of the folder",
"in": "path",
"name": "folderId",
"required": true,
"schema": {
"example": "PJOFJAFA8Y",
"type": "string"
}
},
{
"description": "Id of the document",
"in": "path",
"name": "documentId",
"required": true,
"schema": {
"example": "PJOFJAFA8Y",
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/ModifyVATDeclaration"
},
"responses": {
"204": {
"description": "OK"
}
}
}
},
"/spaces/{spaceId}/folders/{id}": {
"get": {
"description": "Returns folder with Id",
"parameters": [
{
"description": "Id of the folder",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "T15646476",
"type": "string"
}
},
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/OneFolder"
}
}
},
"patch": {
"description": "Modify a Folder (except Name, Class, ModificationDate and ArchivalDate)",
"parameters": [
{
"description": "Id of the folder",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "T18784",
"type": "string"
}
},
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/ModifyFolder"
},
"responses": {
"204": {
"description": "OK"
}
}
}
},
"/spaces/{spaceId}/folders/{id}/accounting-year": {
"delete": {
"description": "delete an AccountingYear",
"parameters": [
{
"description": "Id of the folder",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "T18784",
"type": "string"
}
},
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
}
],
"responses": {
"204": {
"description": "OK"
}
}
},
"patch": {
"description": "Modify a Folder (except Name, Class, ModificationDate and ArchivalDate) and AccountingYear data",
"parameters": [
{
"description": "Id of the folder",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "T18784",
"type": "string"
}
},
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/ModifyAccountingYear"
},
"responses": {
"204": {
"description": "OK"
}
}
}
},
"/spaces/{spaceId}/folders/{id}/accountings": {
"get": {
"description": "Returns accountings documents of the folder (results and taxation or accountingyear)",
"parameters": [
{
"description": "Id of the folder",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "T15646IFHA476",
"type": "string"
}
},
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
},
{
"description": "date range of the documents",
"in": "query",
"name": "Date",
"required": false,
"schema": {
"example": "20160321,null",
"type": "string"
}
},
{
"description": "date range of attachment",
"in": "query",
"name": "FolderDate",
"required": false,
"schema": {
"example": "20180306,null",
"type": "string"
}
},
{
"description": "Title of the accounting document",
"in": "query",
"name": "Title",
"required": false,
"schema": {
"example": "Accounting",
"type": "string"
}
},
{
"description": "workbook of the accounting",
"in": "query",
"name": "Workbook",
"required": false,
"schema": {
"example": "Accounting",
"type": "string"
}
},
{
"description": "class of the accounting",
"in": "query",
"name": "Class",
"required": false,
"schema": {
"example": "Invoice",
"type": "string"
}
},
{
"description": "accountedon of the accounting (boolean available)",
"in": "query",
"name": "AccountedOn",
"required": false,
"schema": {
"example": "20180201,null",
"type": "string"
}
},
{
"description": "if present, the folders containing the documents are returned",
"in": "query",
"name": "WithFolders",
"required": false,
"schema": {
"example": "yes",
"type": "string"
}
},
{
"description": "index range of the results",
"in": "query",
"name": "Range",
"required": false,
"schema": {
"example": "10-19",
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Accounting"
}
}
}
},
"/spaces/{spaceId}/folders/{id}/accountings-journal": {
"get": {
"description": "journal of accountings document delivered to a customer",
"parameters": [
{
"description": "Id of the customer folder",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "T15646IFHA476",
"type": "string"
}
},
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
},
{
"description": "delivery dates of the document",
"in": "query",
"name": "DeliveryDate",
"required": false,
"schema": {
"example": "20191123082536,null",
"type": "string"
}
},
{
"description": "accounting dates of the document",
"in": "query",
"name": "AccountingDate",
"required": false,
"schema": {
"example": "20170215,null",
"type": "string"
}
},
{
"description": "numbers of the document",
"in": "query",
"name": "Number",
"required": false,
"schema": {
"example": "12,17",
"type": "integer"
}
},
{
"description": "workbook of the document",
"in": "query",
"name": "Workbook",
"required": false,
"schema": {
"example": "cashwoucher",
"type": "string"
}
},
{
"description": "yearmonth of the document",
"in": "query",
"name": "YearMonth",
"required": false,
"schema": {
"example": "201802",
"type": "string"
}
},
{
"description": "class of the document",
"in": "query",
"name": "Class",
"required": false,
"schema": {
"example": "invoice",
"type": "string"
}
},
{
"description": "code of the document",
"in": "query",
"name": "Code",
"required": false,
"schema": {
"example": "delivered",
"type": "string"
}
},
{
"description": "Name of the target folder of the document",
"in": "query",
"name": "TargetFolderName",
"required": false,
"schema": {
"example": "Exercice*",
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/AccountingsJournal"
}
}
}
},
"/spaces/{spaceId}/folders/{id}/bank": {
"delete": {
"description": "Delete a Folder (except Name, Class, ModificationDate and ArchivalDate) and Bank data",
"parameters": [
{
"description": "Id of the folder",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "T18784",
"type": "string"
}
},
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
}
],
"responses": {
"204": {
"description": "OK"
}
}
},
"get": {
"description": "Returns folder with Id and bank data",
"parameters": [
{
"description": "Id of the folder",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "T15646476",
"type": "string"
}
},
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/OneBank"
}
}
},
"patch": {
"description": "Modify a Folder (except Name, Class, ModificationDate and ArchivalDate) and Bank data",
"parameters": [
{
"description": "Id of the folder",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "T18784",
"type": "string"
}
},
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/ModifyBank"
},
"responses": {
"204": {
"description": "OK"
}
}
}
},
"/spaces/{spaceId}/folders/{id}/bank-statements": {
"get": {
"description": "Returns bank statements of the folder bank",
"parameters": [
{
"description": "Id of the folder bank",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "T15646IFHA476",
"type": "string"
}
},
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
},
{
"description": "range date of the documents",
"in": "query",
"name": "Date",
"required": false,
"schema": {
"example": "20160321, null",
"type": "string"
}
},
{
"description": "Number of the bank statement",
"in": "query",
"name": "Number",
"required": false,
"schema": {
"example": "201603",
"type": "string"
}
},
{
"description": "index range of the results",
"in": "query",
"name": "Range",
"required": false,
"schema": {
"example": "10-19",
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/BankStatement"
}
}
},
"post": {
"description": "Add a bank statement in a folder bank",
"parameters": [
{
"description": "Id of the folder bank",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "P1987HGFKJFAA46",
"type": "string"
}
},
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/BankStatement"
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"properties": {
"Id": {
"example": "T1234",
"type": "string"
}
},
"type": "object"
}
}
},
"description": "Id of document created",
"headers": {
"Location": {
"schema": {
"description": "path of the document created",
"example": "/folders/PFJOJAF14546/bankstatements/P48548FDAF",
"type": "string"
}
}
}
}
},
"security": [
{
"gma_auth": [
"collaborator",
"owner",
"robot"
]
}
]
}
},
"/spaces/{spaceId}/folders/{id}/collective-decision": {
"patch": {
"description": "Modify a Folder (except Name, Class, ModificationDate and ArchivalDate) and Collective Decision data",
"parameters": [
{
"description": "Id of the folder",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "T18784",
"type": "string"
}
},
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/ModifyCollectiveDecision"
},
"responses": {
"204": {
"description": "OK"
}
}
}
},
"/spaces/{spaceId}/folders/{id}/common-folders": {
"get": {
"description": "Returns common folders of a folder",
"parameters": [
{
"description": "Id of the folder",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "P15646IFHA476",
"type": "string"
}
},
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
},
{
"description": "Name of the folder",
"in": "query",
"name": "Name",
"required": false,
"schema": {
"example": "Folder one",
"type": "string"
}
},
{
"description": "keywords attached to the folder",
"in": "query",
"name": "Keywords",
"required": false,
"schema": {
"example": "juridique",
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Folder"
}
}
},
"post": {
"description": "Add a common folder in another folder",
"parameters": [
{
"description": "Id of the folder",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "P1987HGFKJFAA46",
"type": "string"
}
},
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/CommonFolder"
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"properties": {
"Id": {
"example": "T1234",
"type": "string"
}
},
"type": "object"
}
}
},
"description": "Id of folder created",
"headers": {
"Location": {
"schema": {
"description": "path of the folder created",
"example": "spaces/P464864/folders/PFJOJAF14546/common-folders/P48548FDAF",
"type": "string"
}
}
}
}
},
"security": [
{
"gma_auth": [
"collaborator",
"owner",
"robot"
]
}
]
}
},
"/spaces/{spaceId}/folders/{id}/common-folders/all": {
"get": {
"description": "Returns common folders (even archived) of a folder",
"parameters": [
{
"description": "Id of the folder",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "P15646IFHA476",
"type": "string"
}
},
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
},
{
"description": "Name of the folder",
"in": "query",
"name": "Name",
"required": false,
"schema": {
"example": "Folder one",
"type": "string"
}
},
{
"description": "keywords attached to the folder",
"in": "query",
"name": "Keywords",
"required": false,
"schema": {
"example": "juridique",
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Folder"
}
}
}
},
"/spaces/{spaceId}/folders/{id}/contracting-partner": {
"get": {
"description": "Returns all contracting partners of a contract",
"parameters": [
{
"description": "Id of the folder (contract)",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "T15646IFHA476",
"type": "string"
}
},
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/ContractingPartner"
}
}
}
},
"/spaces/{spaceId}/folders/{id}/contracting-partner/space": {
"get": {
"description": "Returns collector space of a contract",
"parameters": [
{
"description": "Id of the folder (contract)",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "T15646IFHA476",
"type": "string"
}
},
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/ContractingPartner"
}
}
}
},
"/spaces/{spaceId}/folders/{id}/contractual-documents": {
"get": {
"description": "Returns documents of the folder",
"parameters": [
{
"description": "Id of the folder",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "T15646IFHA476",
"type": "string"
}
},
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
},
{
"description": "date range of the documents",
"in": "query",
"name": "Date",
"required": false,
"schema": {
"example": "20160321,null",
"type": "string"
}
},
{
"description": "date range of attachment",
"in": "query",
"name": "FolderDate",
"required": false,
"schema": {
"example": "20180306,null",
"type": "string"
}
},
{
"description": "Type of the document",
"in": "query",
"name": "Type",
"required": false,
"schema": {
"enum": [
"contract",
"engagement-letter",
"amendment",
"purchase-order",
"delivery-order",
"quotation",
"other"
],
"example": "amendment",
"type": "string"
}
},
{
"description": "index range of the results",
"in": "query",
"name": "Range",
"required": false,
"schema": {
"example": "10-19",
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/ContractualDocument"
}
}
},
"post": {
"description": "Add a document in a folder",
"parameters": [
{
"description": "Id of the folder",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "P1987HGFKJFAA46",
"type": "string"
}
},
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/ContractualDocument"
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"properties": {
"Id": {
"example": "T1234",
"type": "string"
}
},
"type": "object"
}
}
},
"description": "Id of document created",
"headers": {
"Location": {
"schema": {
"description": "path of the document created",
"example": "/folders/PFJOJAF14546/contractual-documents/P48548FDAF",
"type": "string"
}
}
}
}
},
"security": [
{
"gma_auth": [
"collaborator",
"owner",
"robot"
]
}
]
}
},
"/spaces/{spaceId}/folders/{id}/contractual-relationship": {
"get": {
"description": "Returns folder with Id and contractual-relationship data",
"parameters": [
{
"description": "Id of the folder",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "T15646476",
"type": "string"
}
},
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/OneContractual-Relationship"
}
}
}
},
"/spaces/{spaceId}/folders/{id}/coporate-tax-declarations": {
"get": {
"description": "Returns corporate tax declarations",
"parameters": [
{
"description": "Id of the folder result and taxation",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "T15646IFHA476",
"type": "string"
}
},
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
},
{
"description": "range date of the documents",
"in": "query",
"name": "Date",
"required": false,
"schema": {
"example": "20160321, null",
"type": "string"
}
},
{
"description": "index range of the results",
"in": "query",
"name": "Range",
"required": false,
"schema": {
"example": "10-19",
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/CorporateTaxDeclaration"
}
}
},
"post": {
"description": "Add a corporate tax declaration",
"parameters": [
{
"description": "Id of the folder result and taxation",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "P1987HGFKJFAA46",
"type": "string"
}
},
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/CorporateTaxDeclaration"
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"properties": {
"Id": {
"example": "T1234",
"type": "string"
}
},
"type": "object"
}
}
},
"description": "Id of document created",
"headers": {
"Location": {
"schema": {
"description": "path of the document created",
"example": "/folders/PFJOJAF14546/coporatetaxdeclarations/P48548FDAF",
"type": "string"
}
}
}
}
},
"security": [
{
"gma_auth": [
"collaborator",
"owner",
"robot"
]
}
]
}
},
"/spaces/{spaceId}/folders/{id}/customer": {
"delete": {
"description": "delete a customer",
"parameters": [
{
"description": "Id of the folder",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "T18784",
"type": "string"
}
},
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
}
],
"responses": {
"204": {
"description": "OK"
}
}
},
"get": {
"description": "Returns folder with Id and customer data",
"parameters": [
{
"description": "Id of the folder",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "T15646476",
"type": "string"
}
},
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/OneCustomer"
}
}
},
"patch": {
"description": "Modify a Folder (except Name, Class, ModificationDate and ArchivalDate) and Customer data",
"parameters": [
{
"description": "Id of the folder",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "T18784",
"type": "string"
}
},
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/ModifyCustomer"
},
"responses": {
"204": {
"description": "OK"
}
}
}
},
"/spaces/{spaceId}/folders/{id}/deliveries-journal": {
"get": {
"description": "journal of documents delivered to a customer",
"parameters": [
{
"description": "Id of the customer folder",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "T15646IFHA476",
"type": "string"
}
},
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
},
{
"description": "delivery dates of the document",
"in": "query",
"name": "DeliveryDate",
"required": false,
"schema": {
"example": "20191123082536,null",
"type": "string"
}
},
{
"description": "accounting dates of the document",
"in": "query",
"name": "AccountingDate",
"required": false,
"schema": {
"example": "20170215,null",
"type": "string"
}
},
{
"description": "numbers of the document",
"in": "query",
"name": "Number",
"required": false,
"schema": {
"example": "12,17",
"type": "integer"
}
},
{
"description": "class of the document",
"in": "query",
"name": "Class",
"required": false,
"schema": {
"example": "invoice",
"type": "string"
}
},
{
"description": "Name of the target folder of the document",
"in": "query",
"name": "TargetFolderName",
"required": false,
"schema": {
"example": "Exercice*",
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/DeliveriesJournal"
}
}
}
},
"/spaces/{spaceId}/folders/{id}/documents": {
"get": {
"description": "Returns documents of the folder",
"parameters": [
{
"description": "Id of the folder",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "T15646IFHA476",
"type": "string"
}
},
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
},
{
"description": "date range of the documents",
"in": "query",
"name": "Date",
"required": false,
"schema": {
"example": "20160321,null",
"type": "string"
}
},
{
"description": "Title of the document",
"in": "query",
"name": "Title",
"required": false,
"schema": {
"example": "Facture EDF",
"type": "string"
}
},
{
"description": "date range of attachment",
"in": "query",
"name": "FolderDate",
"required": false,
"schema": {
"example": "20180306,null",
"type": "string"
}
},
{
"description": "Class of document",
"in": "query",
"name": "Class",
"required": false,
"schema": {
"example": "Contract",
"type": "string"
}
},
{
"description": "index range of the results",
"in": "query",
"name": "Range",
"required": false,
"schema": {
"example": "10-19",
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Document"
}
}
},
"post": {
"description": "Add a document in a folder",
"parameters": [
{
"description": "Id of the folder",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "P1987HGFKJFAA46",
"type": "string"
}
},
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Document"
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"properties": {
"Id": {
"example": "P1234",
"type": "string"
}
},
"type": "object"
}
}
},
"description": "Id of document created",
"headers": {
"Location": {
"schema": {
"description": "path of the document created",
"example": "/folders/PFJOJAF14546/documents/P48548FDAF",
"type": "string"
}
}
}
}
},
"security": [
{
"gma_auth": [
"collaborator",
"owner",
"robot"
]
}
]
}
},
"/spaces/{spaceId}/folders/{id}/documents/{documentId}/detach": {
"patch": {
"description": "Detach a doc of a folder",
"parameters": [
{
"description": "Id of the folder",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "P18784",
"type": "string"
}
},
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
},
{
"description": "Id of the document",
"in": "path",
"name": "documentId",
"required": true,
"schema": {
"example": "PJOFJAFA8Y",
"type": "string"
}
}
],
"responses": {
"204": {
"description": "OK"
}
}
}
},
"/spaces/{spaceId}/folders/{id}/employee": {
"delete": {
"description": "Delete a Folder (except Name, Class, ModificationDate and ArchivalDate) and Employee data",
"parameters": [
{
"description": "Id of the folder",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "T18784",
"type": "string"
}
},
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
}
],
"responses": {
"204": {
"description": "OK"
}
}
},
"get": {
"description": "Returns folder with Id and employee data",
"parameters": [
{
"description": "Id of the folder",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "T15646476",
"type": "string"
}
},
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/OneEmployee"
}
}
},
"patch": {
"description": "Modify a Folder (except Name, Class, ModificationDate and ArchivalDate) and Employee data",
"parameters": [
{
"description": "Id of the folder",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "T18784",
"type": "string"
}
},
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/ModifyEmployee"
},
"responses": {
"204": {
"description": "OK"
}
}
}
},
"/spaces/{spaceId}/folders/{id}/expense-proofs": {
"get": {
"description": "Returns expense proofs of the folder (social, followup or exchange)",
"parameters": [
{
"description": "Id of the folder",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "T15646IFHA476",
"type": "string"
}
},
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
},
{
"description": "date range of the documents",
"in": "query",
"name": "Date",
"required": false,
"schema": {
"example": "20160321,null",
"type": "string"
}
},
{
"description": "date range of attachment",
"in": "query",
"name": "FolderDate",
"required": false,
"schema": {
"example": "20180306,null",
"type": "string"
}
},
{
"description": "Status of the expense proof",
"in": "query",
"name": "Status",
"required": false,
"schema": {
"enum": [
"R",
"W",
"V"
],
"example": "R",
"type": "string"
}
},
{
"description": "To return expense proofs not attached to an expense report",
"in": "query",
"name": "NoExpenseReport",
"required": false,
"schema": {
"example": "1",
"type": "boolean"
}
},
{
"description": "index range of the results",
"in": "query",
"name": "Range",
"required": false,
"schema": {
"example": "10-19",
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/ExpenseProof"
}
}
},
"post": {
"description": "Add a expense proof in a folder followup or exchange",
"parameters": [
{
"description": "Id of the folder",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "P1987HGFKJFAA46",
"type": "string"
}
},
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/ExpenseProof"
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"properties": {
"Id": {
"example": "T1234",
"type": "string"
}
},
"type": "object"
}
}
},
"description": "Id of expense proof created",
"headers": {
"Location": {
"schema": {
"description": "path of the expense proof created",
"example": "/folders/PFJOJAF14546/expenseproofs/P48548FDAF",
"type": "string"
}
}
}
}
},
"security": [
{
"gma_auth": [
"collaborator",
"owner",
"robot"
]
}
]
}
},
"/spaces/{spaceId}/folders/{id}/expense-reports": {
"get": {
"description": "Returns expense reports of the folder (social or followup)",
"parameters": [
{
"description": "Id of the folder",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "T15646IFHA476",
"type": "string"
}
},
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
},
{
"description": "date range of the documents",
"in": "query",
"name": "Date",
"required": false,
"schema": {
"example": "20160321,null",
"type": "string"
}
},
{
"description": "date range of attachment",
"in": "query",
"name": "FolderDate",
"required": false,
"schema": {
"example": "20180306,null",
"type": "string"
}
},
{
"description": "If present returns also the data extend",
"in": "query",
"name": "WithExtend",
"required": false,
"schema": {
"enum": [
"true",
"false"
],
"example": "true",
"type": "string"
}
},
{
"description": "index range of the results",
"in": "query",
"name": "Range",
"required": false,
"schema": {
"example": "10-19",
"type": "string"
}
},
{
"description": "range of processing date (boolean available)",
"in": "query",
"name": "ProcessingDate",
"required": false,
"schema": {
"example": "20180526,null",
"type": "string"
}
},
{
"description": "range of ExpenseDate (valid available)",
"in": "query",
"name": "ExpenseDate",
"required": false,
"schema": {
"example": "20180526,null"
}
},
{
"description": "order of sort (if absent default is asc)",
"in": "query",
"name": "SortOrder",
"required": false,
"schema": {
"enum": [
"asc",
"desc"
],
"example": "asc",
"type": "string"
}
},
{
"description": "name of value for sort",
"in": "query",
"name": "SortName",
"required": false,
"schema": {
"enum": [
"ExpenseDate",
"InclVAT",
"Title"
],
"example": "ExpenseDate",
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/ExpenseReport"
}
}
},
"post": {
"description": "Add a expense report in a folder followup",
"parameters": [
{
"description": "Id of the folder",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "P1987HGFKJFAA46",
"type": "string"
}
},
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/ExpenseReport"
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"properties": {
"Id": {
"example": "T1234",
"type": "string"
}
},
"type": "object"
}
}
},
"description": "Id of expense report created",
"headers": {
"Location": {
"schema": {
"description": "path of the expense report created",
"example": "/folders/PFJOJAF14546/expensereports/P48548FDAF",
"type": "string"
}
}
}
}
},
"security": [
{
"gma_auth": [
"collaborator",
"owner",
"robot"
]
}
]
}
},
"/spaces/{spaceId}/folders/{id}/expense-reports/{expenseReportId}/expense-proofs": {
"get": {
"description": "Returns expense proofs linked to the expenseReportId",
"parameters": [
{
"description": "Id of the folder",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "T15646IFHA476",
"type": "string"
}
},
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
},
{
"description": "Id of the expense report",
"in": "path",
"name": "expenseReportId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
},
{
"description": "Date of the documents (YYYY or YYYYMM or YYYYMMDD)",
"in": "query",
"name": "Date",
"required": false,
"schema": {
"example": "20160321",
"type": "string"
}
},
{
"description": "Status of the expense proof",
"in": "query",
"name": "Status",
"required": false,
"schema": {
"enum": [
"R",
"W",
"V"
],
"example": "R",
"type": "string"
}
},
{
"description": "Date of upload of the document (YYYY or YYYYMM or YYYYMMDD)",
"in": "query",
"name": "FolderDate",
"required": false,
"schema": {
"example": 20180202000000,
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/ExpenseProof"
}
}
}
},
"/spaces/{spaceId}/folders/{id}/insurance": {
"delete": {
"description": "Delete a Folder (except Name, Class, ModificationDate and ArchivalDate) and Insurance data",
"parameters": [
{
"description": "Id of the folder",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "T18784",
"type": "string"
}
},
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
}
],
"responses": {
"204": {
"description": "OK"
}
}
},
"get": {
"description": "Returns folder with Id and insurance data",
"parameters": [
{
"description": "Id of the folder",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "T15646476",
"type": "string"
}
},
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/OneInsurance"
}
}
},
"patch": {
"description": "Modify a Folder (except Name, Class, ModificationDate and ArchivalDate) and Insurance data",
"parameters": [
{
"description": "Id of the folder",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "T18784",
"type": "string"
}
},
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/ModifyInsurance"
},
"responses": {
"204": {
"description": "OK"
}
}
}
},
"/spaces/{spaceId}/folders/{id}/invoices": {
"get": {
"description": "Returns invoices of the folder (customer, provider, accountingyear or root folders customers or providers)",
"parameters": [
{
"description": "Id of the folder",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "T15646IFHA476",
"type": "string"
}
},
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
},
{
"description": "Title of the documents",
"in": "query",
"name": "Title",
"required": false,
"schema": {
"example": "factrure",
"type": "string"
}
},
{
"description": "date range of the documents",
"in": "query",
"name": "Date",
"required": false,
"schema": {
"example": "20160321,null",
"type": "string"
}
},
{
"description": "Number of the invoice",
"in": "query",
"name": "Number",
"required": false,
"schema": {
"example": 23585,
"type": "string"
}
},
{
"description": "amount incl. VAT",
"in": "query",
"name": "InclVAT",
"required": false,
"schema": {
"example": "100.50,123.69",
"type": "number"
}
},
{
"description": "amount before VAT",
"in": "query",
"name": "BeforeVAT",
"required": false,
"schema": {
"example": "102.50,123.69",
"type": "number"
}
},
{
"description": "date due payment",
"in": "query",
"name": "DueDate",
"required": false,
"schema": {
"example": "20201231,20211231",
"type": "string"
}
},
{
"description": "date of payment (boolean and valid available)",
"in": "query",
"name": "PaymentDate",
"required": false,
"schema": {
"example": "20201201,20211201",
"type": "string"
}
},
{
"description": "range date of invoice",
"in": "query",
"name": "InvoiceDate",
"required": false,
"schema": {
"example": "20201201",
"type": "string"
}
},
{
"description": "date range of attachment",
"in": "query",
"name": "FolderDate",
"required": false,
"schema": {
"example": "20180306,null",
"type": "string"
}
},
{
"description": "value of AccountedOn (boolean available but not range)",
"in": "query",
"name": "AccountedOn",
"required": false,
"schema": {
"example": "20220101",
"type": "string"
}
},
{
"description": "If present returns also the data extend",
"in": "query",
"name": "WithExtend",
"required": false,
"schema": {
"example": "202102,null",
"type": "string"
}
},
{
"description": "json object to filter extend data",
"in": "query",
"name": "Extend",
"required": false,
"schema": {
"example": "[{\"Name\":\"field1\",\"Equals\":\"test\"},{\"Name\":\"field2\",\"Start\":\"20180101\"},{\"Name\":\"field3\",\"End\":\"20190101\"}]",
"type": "string"
}
},
{
"description": "index range of the results",
"in": "query",
"name": "Range",
"required": false,
"schema": {
"example": "10-19",
"type": "string"
}
},
{
"description": "order of sort (if absent default is asc)",
"in": "query",
"name": "SortOrder",
"required": false,
"schema": {
"enum": [
"asc",
"desc"
],
"example": "asc",
"type": "string"
}
},
{
"description": "name of value for sort",
"in": "query",
"name": "SortName",
"required": false,
"schema": {
"enum": [
"DueDate",
"PaymentDate",
"InvoiceDate",
"InclVAT",
"Contracting",
"Title"
],
"example": "PaymentDate",
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Invoice"
}
}
},
"post": {
"description": "Add a invoice in a folder of a customer or a provider",
"parameters": [
{
"description": "Id of the folder",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "P1987HGFKJFAA46",
"type": "string"
}
},
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Invoice"
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"properties": {
"Id": {
"example": "T1234",
"type": "string"
}
},
"type": "object"
}
}
},
"description": "Id of invoice created",
"headers": {
"Location": {
"schema": {
"description": "path of the invoice created",
"example": "/folders/PFJOJAF14546/invoices/P48548FDAF",
"type": "string"
}
}
}
}
},
"security": [
{
"gma_auth": [
"collaborator",
"owner",
"robot"
]
}
]
}
},
"/spaces/{spaceId}/folders/{id}/legal-entity": {
"get": {
"description": "Returns legal entity of a follow up folder",
"parameters": [
{
"description": "Id of the folder (followup)",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "T15646IFHA476",
"type": "string"
}
},
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/LegalEntityFollow"
}
}
}
},
"/spaces/{spaceId}/folders/{id}/loan": {
"delete": {
"description": "Delete a Folder (except Name, Class, ModificationDate and ArchivalDate) and Loan data",
"parameters": [
{
"description": "Id of the folder",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "T18784",
"type": "string"
}
},
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
}
],
"responses": {
"204": {
"description": "OK"
}
}
},
"get": {
"description": "Returns folder with Id and loan data",
"parameters": [
{
"description": "Id of the folder",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "T15646476",
"type": "string"
}
},
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/OneLoan"
}
}
},
"patch": {
"description": "Modify a Folder (except Name, Class, ModificationDate and ArchivalDate) and Loan data",
"parameters": [
{
"description": "Id of the folder",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "T18784",
"type": "string"
}
},
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/ModifyLoan"
},
"responses": {
"204": {
"description": "OK"
}
}
}
},
"/spaces/{spaceId}/folders/{id}/messages": {
"get": {
"description": "Returns messages of the folder",
"parameters": [
{
"description": "Name of the message",
"in": "query",
"name": "Text",
"required": false,
"schema": {
"example": "*welcom*",
"type": "string"
}
},
{
"description": "index range of the results",
"in": "query",
"name": "Range",
"required": false,
"schema": {
"example": "10-19",
"type": "string"
}
},
{
"description": "date of the message",
"in": "query",
"name": "MessageDate",
"required": false,
"schema": {
"example": "20190202",
"type": "string"
}
},
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
},
{
"description": "Id of the folder",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "P18784",
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Message"
}
}
},
"post": {
"description": "Write a message in the journal of a folder",
"parameters": [
{
"description": "Id of the folder",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "P18784",
"type": "string"
}
},
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Message"
},
"responses": {
"200": {
"description": "OK"
}
},
"security": [
{
"gma_auth": [
"collaborator",
"owner",
"robot"
]
}
]
}
},
"/spaces/{spaceId}/folders/{id}/messages/{messageId}": {
"get": {
"description": "Returns message with Id",
"parameters": [
{
"description": "Id of the folder",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "T15646476",
"type": "string"
}
},
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
},
{
"description": "Id of the mesage",
"in": "path",
"name": "messageId",
"required": true,
"schema": {
"example": "TJOFJAFA8Y",
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/OneMessage"
}
}
},
"patch": {
"description": "Modify a Message",
"parameters": [
{
"description": "Id of the folder",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "P18784",
"type": "string"
}
},
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
},
{
"description": "Id of the message",
"in": "path",
"name": "messageId",
"required": true,
"schema": {
"example": "TJOFJAFA8Y",
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/ModifyMessage"
},
"responses": {
"204": {
"description": "OK"
}
}
}
},
"/spaces/{spaceId}/folders/{id}/nominative-social-declarations": {
"get": {
"description": "Returns nominative social declarations of the folder social",
"parameters": [
{
"description": "Id of the folder social",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "T15646IFHA476",
"type": "string"
}
},
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
},
{
"description": "range date of the documents",
"in": "query",
"name": "Date",
"required": false,
"schema": {
"example": "20160321, null",
"type": "string"
}
},
{
"description": "index range of the results",
"in": "query",
"name": "Range",
"required": false,
"schema": {
"example": "10-19",
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/NSD"
}
}
}
},
"/spaces/{spaceId}/folders/{id}/other-taxes": {
"get": {
"description": "Returns other taxes declarations",
"parameters": [
{
"description": "Id of the folder taxcontract",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "T15646IFHA476",
"type": "string"
}
},
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
},
{
"description": "range date of the documents",
"in": "query",
"name": "Date",
"required": false,
"schema": {
"example": "20160321, null",
"type": "string"
}
},
{
"description": "index range of the results",
"in": "query",
"name": "Range",
"required": false,
"schema": {
"example": "10-19",
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/OtherTax"
}
}
},
"post": {
"description": "Add a tax declaration",
"parameters": [
{
"description": "Id of the folder tax contract",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "P1987HGFKJFAA46",
"type": "string"
}
},
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/OtherTax"
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"properties": {
"Id": {
"example": "T1234",
"type": "string"
}
},
"type": "object"
}
}
},
"description": "Id of document created",
"headers": {
"Location": {
"schema": {
"description": "path of the document created",
"example": "/folders/PFJOJAF14546/othertaxes/P48548FDAF",
"type": "string"
}
}
}
}
},
"security": [
{
"gma_auth": [
"collaborator",
"owner",
"robot"
]
}
]
}
},
"/spaces/{spaceId}/folders/{id}/passwords": {
"get": {
"description": "Returns identifiers/passwords of the folder",
"parameters": [
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
},
{
"description": "Id of the folder",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "P18784",
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Password"
}
}
},
"post": {
"description": "Write a identifier/password in aa folder",
"parameters": [
{
"description": "Id of the folder",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "P18784",
"type": "string"
}
},
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Password"
},
"responses": {
"200": {
"description": "OK"
}
},
"security": [
{
"gma_auth": [
"collaborator",
"owner",
"robot"
]
}
]
}
},
"/spaces/{spaceId}/folders/{id}/passwords/{passwordId}": {
"delete": {
"description": "delete a password",
"parameters": [
{
"description": "Id of the folder",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "P18784",
"type": "string"
}
},
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
},
{
"description": "Id of the password",
"in": "path",
"name": "passwordId",
"required": true,
"schema": {
"example": "TJOFJAFA8Y",
"type": "string"
}
}
],
"responses": {
"204": {
"description": "OK"
}
}
},
"get": {
"description": "Returns password with Id",
"parameters": [
{
"description": "Id of the folder",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "T15646476",
"type": "string"
}
},
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
},
{
"description": "Id of the password",
"in": "path",
"name": "passwordId",
"required": true,
"schema": {
"example": "TJOFJAFA8Y",
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/OnePassword"
}
}
},
"patch": {
"description": "Modify a Password",
"parameters": [
{
"description": "Id of the folder",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "P18784",
"type": "string"
}
},
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
},
{
"description": "Id of the password",
"in": "path",
"name": "passwordId",
"required": true,
"schema": {
"example": "TJOFJAFA8Y",
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/ModifyPassword"
},
"responses": {
"204": {
"description": "OK"
}
}
}
},
"/spaces/{spaceId}/folders/{id}/payrolls": {
"get": {
"description": "Returns payrolls of the folder social",
"parameters": [
{
"description": "Id of the folder social",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "T15646IFHA476",
"type": "string"
}
},
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
},
{
"description": "range date of the documents",
"in": "query",
"name": "Date",
"required": false,
"schema": {
"example": "20160321, null",
"type": "string"
}
},
{
"description": "begin date of the payrolls",
"in": "query",
"name": "Begin",
"required": false,
"schema": {
"example": "20160321,null",
"type": "string"
}
},
{
"description": "end date of the payrolls",
"in": "query",
"name": "End",
"required": false,
"schema": {
"example": "20160321,null",
"type": "string"
}
},
{
"description": "index range of the results",
"in": "query",
"name": "Range",
"required": false,
"schema": {
"example": "10-19",
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Payroll"
}
}
},
"post": {
"description": "Add a payroll in a folder social",
"parameters": [
{
"description": "Id of the folder social",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "P1987HGFKJFAA46",
"type": "string"
}
},
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Payroll"
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"properties": {
"Id": {
"example": "T1234",
"type": "string"
}
},
"type": "object"
}
}
},
"description": "Id of document created",
"headers": {
"Location": {
"schema": {
"description": "path of the document created",
"example": "/folders/PFJOJAF14546/payrolls/P48548FDAF",
"type": "string"
}
}
}
}
},
"security": [
{
"gma_auth": [
"collaborator",
"owner",
"robot"
]
}
]
}
},
"/spaces/{spaceId}/folders/{id}/payrolls/{payrollId}/nominative-social-declaration": {
"delete": {
"description": "delete a nominative social declaration in a folder social",
"parameters": [
{
"description": "Id of the folder social",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "P1987HGFKJFAA46",
"type": "string"
}
},
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
},
{
"description": "Id of the payroll",
"in": "path",
"name": "payrollId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
}
],
"responses": {
"204": {
"description": "OK"
}
},
"security": [
{
"gma_auth": [
"collaborator",
"owner",
"robot"
]
}
]
},
"post": {
"description": "Add a nominative social declaration in a folder social",
"parameters": [
{
"description": "Id of the folder social",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "P1987HGFKJFAA46",
"type": "string"
}
},
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
},
{
"description": "Id of the payroll",
"in": "path",
"name": "payrollId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Document"
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"properties": {
"Id": {
"example": "T1234",
"type": "string"
}
},
"type": "object"
}
}
},
"description": "Id of document created",
"headers": {
"Location": {
"schema": {
"description": "path of the document created",
"example": "/folders/PFJOJAF14546/payrolls/P48548FDAF/nominativesocialdeclaration/PFJAIFJ",
"type": "string"
}
}
}
}
},
"security": [
{
"gma_auth": [
"collaborator",
"owner",
"robot"
]
}
]
}
},
"/spaces/{spaceId}/folders/{id}/payslips": {
"get": {
"description": "Returns payslips of the folder employee",
"parameters": [
{
"description": "Id of the folder employee",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "T15646IFHA476",
"type": "string"
}
},
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
},
{
"description": "range date of the documents",
"in": "query",
"name": "Date",
"required": false,
"schema": {
"example": "20160321, null",
"type": "string"
}
},
{
"description": "index range of the results",
"in": "query",
"name": "Range",
"required": false,
"schema": {
"example": "10-19",
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/PaySlip"
}
}
},
"post": {
"description": "Add a payslip in a folder employee",
"parameters": [
{
"description": "Id of the folder employee",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "P1987HGFKJFAA46",
"type": "string"
}
},
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/PaySlip"
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"properties": {
"Id": {
"example": "T1234",
"type": "string"
}
},
"type": "object"
}
}
},
"description": "Id of document created",
"headers": {
"Location": {
"schema": {
"description": "path of the document created",
"example": "/folders/PFJOJAF14546/payslips/P48548FDAF",
"type": "string"
}
}
}
}
},
"security": [
{
"gma_auth": [
"collaborator",
"owner",
"robot"
]
}
]
}
},
"/spaces/{spaceId}/folders/{id}/portfolio/{portfolioId}": {
"delete": {
"description": "delete a secondary portfolio of a customer contract",
"parameters": [
{
"description": "Id of the folder",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "T18784",
"type": "string"
}
},
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
},
{
"description": "Id of the portfolio",
"in": "path",
"name": "portfolioId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
}
],
"responses": {
"204": {
"description": "OK"
}
}
}
},
"/spaces/{spaceId}/folders/{id}/professional-vehicle": {
"delete": {
"description": "delete a Professional Vehicle",
"parameters": [
{
"description": "Id of the folder",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "T18784",
"type": "string"
}
},
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
}
],
"responses": {
"204": {
"description": "OK"
}
}
},
"patch": {
"description": "Modify a Folder (except Name, Class, ModificationDate and ArchivalDate) and Professional Vehicle data",
"parameters": [
{
"description": "Id of the folder",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "T18784",
"type": "string"
}
},
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/ModifyProfessionalVehicle"
},
"responses": {
"204": {
"description": "OK"
}
}
}
},
"/spaces/{spaceId}/folders/{id}/provider": {
"delete": {
"description": "delete a provider",
"parameters": [
{
"description": "Id of the folder",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "T18784",
"type": "string"
}
},
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
}
],
"responses": {
"204": {
"description": "OK"
}
}
},
"get": {
"description": "Returns folder with Id and provider data",
"parameters": [
{
"description": "Id of the folder",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "T15646476",
"type": "string"
}
},
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/OneProvider"
}
}
},
"patch": {
"description": "Modify a Folder (except Name, Class, ModificationDate and ArchivalDate) and Provider data",
"parameters": [
{
"description": "Id of the folder",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "T18784",
"type": "string"
}
},
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/ModifyProvider"
},
"responses": {
"204": {
"description": "OK"
}
}
}
},
"/spaces/{spaceId}/folders/{id}/required-documents": {
"get": {
"description": "list of the required documents for a person",
"parameters": [
{
"description": "Id of the folder either exchange either followup",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "T15646IFHA476",
"type": "string"
}
},
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/RequiredDocument"
}
}
}
},
"/spaces/{spaceId}/folders/{id}/required-documents/{requireddocumentid}": {
"patch": {
"description": "Modify the status of a requireddocument",
"parameters": [
{
"description": "Id of the folder exchange or followup",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "P18784",
"type": "string"
}
},
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
},
{
"description": "Id of the requireddocument",
"in": "path",
"name": "requireddocumentid",
"required": true,
"schema": {
"example": "T156HUFHA476",
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/ModifyReqStatus"
},
"responses": {
"204": {
"description": "OK"
}
}
},
"post": {
"description": "Add a required document to a line",
"parameters": [
{
"description": "Id of the folder exchange or followup",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "P1987HGFKJFAA46",
"type": "string"
}
},
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
},
{
"description": "Id of the requireddocument",
"in": "path",
"name": "requireddocumentid",
"required": true,
"schema": {
"example": "T156HUFHA476",
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/RequiredDocument"
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"properties": {
"Id": {
"example": "P1234",
"type": "string"
}
},
"type": "object"
}
}
},
"description": "Id of document created",
"headers": {
"Location": {
"schema": {
"description": "path of the document created",
"example": "/folders/PFJOJAF14546/documents/P48548FDAF",
"type": "string"
}
}
}
}
},
"security": [
{
"gma_auth": [
"collaborator",
"owner",
"robot"
]
}
]
}
},
"/spaces/{spaceId}/folders/{id}/required-documents/{requireddocumentid}/documents/{documentId}": {
"delete": {
"description": "delete a document from a required document",
"parameters": [
{
"description": "Id of the folder exchange or followup",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "P1987HGFKJFAA46",
"type": "string"
}
},
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
},
{
"description": "Id of the requireddocument",
"in": "path",
"name": "requireddocumentid",
"required": true,
"schema": {
"example": "T156HUFHA476",
"type": "string"
}
},
{
"description": "Id of the document to delete",
"in": "path",
"name": "documentId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
}
],
"responses": {
"204": {
"description": "OK"
}
},
"security": [
{
"gma_auth": [
"collaborator",
"owner",
"robot"
]
}
]
}
},
"/spaces/{spaceId}/folders/{id}/sections": {
"get": {
"description": "Returns sections of the folder",
"parameters": [
{
"description": "Id of the folder",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "T15646IFHA476",
"type": "string"
}
},
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Section"
}
}
}
},
"/spaces/{spaceId}/folders/{id}/social-contracts": {
"get": {
"description": "Returns social contracts of the folder employee",
"parameters": [
{
"description": "Id of the folder employee",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "T15646IFHA476",
"type": "string"
}
},
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
},
{
"description": "range date of the documents",
"in": "query",
"name": "Date",
"required": false,
"schema": {
"example": "20160321, null",
"type": "string"
}
},
{
"description": "index range of the results",
"in": "query",
"name": "Range",
"required": false,
"schema": {
"example": "10-19",
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/SocialContract"
}
}
},
"post": {
"description": "Add a social contract in a folder employee",
"parameters": [
{
"description": "Id of the folder employee",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "P1987HGFKJFAA46",
"type": "string"
}
},
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/SocialContract"
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"properties": {
"Id": {
"example": "T1234",
"type": "string"
}
},
"type": "object"
}
}
},
"description": "Id of document created",
"headers": {
"Location": {
"schema": {
"description": "path of the document created",
"example": "/folders/PFJOJAF14546/socialcontracts/P48548FDAF",
"type": "string"
}
}
}
}
},
"security": [
{
"gma_auth": [
"collaborator",
"owner",
"robot"
]
}
]
}
},
"/spaces/{spaceId}/folders/{id}/social-declarations": {
"get": {
"description": "Returns social declarations",
"parameters": [
{
"description": "Id of the folder socialregime",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "T15646IFHA476",
"type": "string"
}
},
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
},
{
"description": "range date of the documents",
"in": "query",
"name": "Date",
"required": false,
"schema": {
"example": "20160321, null",
"type": "string"
}
},
{
"description": "index range of the results",
"in": "query",
"name": "Range",
"required": false,
"schema": {
"example": "10-19",
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/SocialDeclaration"
}
}
},
"post": {
"description": "Add a social declaration",
"parameters": [
{
"description": "Id of the folder social regime",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "P1987HGFKJFAA46",
"type": "string"
}
},
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/SocialDeclaration"
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"properties": {
"Id": {
"example": "T1234",
"type": "string"
}
},
"type": "object"
}
}
},
"description": "Id of document created",
"headers": {
"Location": {
"schema": {
"description": "path of the document created",
"example": "/folders/PFJOJAF14546/socialdeclarations/P48548FDAF",
"type": "string"
}
}
}
}
},
"security": [
{
"gma_auth": [
"collaborator",
"owner",
"robot"
]
}
]
}
},
"/spaces/{spaceId}/folders/{id}/social-regimes": {
"delete": {
"description": "delete a social regime",
"parameters": [
{
"description": "Id of the folder",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "T18784",
"type": "string"
}
},
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
}
],
"responses": {
"204": {
"description": "OK"
}
}
},
"get": {
"description": "Returns folder with Id and social regime data",
"parameters": [
{
"description": "Id of the folder",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "T15646476",
"type": "string"
}
},
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/OneSocialRegime"
}
}
},
"patch": {
"description": "Modify a Folder (except Name, Class, ModificationDate and ArchivalDate) and Social Regime data",
"parameters": [
{
"description": "Id of the folder",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "T18784",
"type": "string"
}
},
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/ModifySocialRegime"
},
"responses": {
"204": {
"description": "OK"
}
}
}
},
"/spaces/{spaceId}/folders/{id}/sum-invoices": {
"get": {
"description": "Returns sum of invoices of the folder (customer, provider, accountingyear or root folders customers or providers)",
"parameters": [
{
"description": "Id of the folder",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "T15646IFHA476",
"type": "string"
}
},
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
},
{
"description": "Number of the invoice",
"in": "query",
"name": "Number",
"required": false,
"schema": {
"example": 23585,
"type": "string"
}
},
{
"description": "amount incl. VAT",
"in": "query",
"name": "InclVat",
"required": false,
"schema": {
"example": "100.50,101.50",
"type": "number"
}
},
{
"description": "amount before VAT",
"in": "query",
"name": "BeforeVAT",
"required": false,
"schema": {
"example": "102.50,101.50",
"type": "number"
}
},
{
"description": "range date due payment",
"in": "query",
"name": "DueDate",
"required": false,
"schema": {
"example": "20201231",
"type": "string"
}
},
{
"description": "range date of payment",
"in": "query",
"name": "PaymentDate",
"required": false,
"schema": {
"example": "20201201,null",
"type": "string"
}
},
{
"description": "range date of invoice",
"in": "query",
"name": "InvoiceDate",
"required": false,
"schema": {
"example": "20201201,null",
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/SumInvoice"
}
}
}
},
"/spaces/{spaceId}/folders/{id}/tax-contract": {
"delete": {
"description": "Delete a Folder (except Name, Class, ModificationDate and ArchivalDate) and tax contract data",
"parameters": [
{
"description": "Id of the folder",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "T18784",
"type": "string"
}
},
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
}
],
"responses": {
"204": {
"description": "OK"
}
}
},
"patch": {
"description": "Modify a Folder (except Name, Class, ModificationDate and ArchivalDate) and Tax Contract data",
"parameters": [
{
"description": "Id of the folder",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "T18784",
"type": "string"
}
},
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/ModifyTaxContract"
},
"responses": {
"204": {
"description": "OK"
}
}
}
},
"/spaces/{spaceId}/folders/{id}/vat-declarations": {
"get": {
"description": "Returns vat declarations",
"parameters": [
{
"description": "Id of the folder result and taxation",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "T15646IFHA476",
"type": "string"
}
},
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
},
{
"description": "range date of the documents",
"in": "query",
"name": "Date",
"required": false,
"schema": {
"example": "20160321, null",
"type": "string"
}
},
{
"description": "index range of the results",
"in": "query",
"name": "Range",
"required": false,
"schema": {
"example": "10-19",
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/VATDeclaration"
}
}
},
"post": {
"description": "Add a vat declaration",
"parameters": [
{
"description": "Id of the folder result and taxation",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "P1987HGFKJFAA46",
"type": "string"
}
},
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/VATDeclaration"
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"properties": {
"Id": {
"example": "T1234",
"type": "string"
}
},
"type": "object"
}
}
},
"description": "Id of document created",
"headers": {
"Location": {
"schema": {
"description": "path of the document created",
"example": "/folders/PFJOJAF14546/vatdeclarations/P48548FDAF",
"type": "string"
}
}
}
}
},
"security": [
{
"gma_auth": [
"collaborator",
"owner",
"robot"
]
}
]
}
},
"/spaces/{spaceId}/folders/{id}/{documentClass}": {
"delete": {
"description": "delete a class document",
"parameters": [
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
},
{
"description": "Id of the folder",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "PJOFJAFA8Y",
"type": "string"
}
},
{
"description": "class of the document",
"in": "path",
"name": "documentClass",
"required": true,
"schema": {
"example": "birthCertificate",
"type": "string"
}
}
],
"responses": {
"204": {
"description": "OK"
}
}
},
"get": {
"description": "Returns document of documentClass (without specific data) of the folder",
"parameters": [
{
"description": "Id of the folder",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "T15646IFHA476",
"type": "string"
}
},
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
},
{
"description": "class of the document",
"in": "path",
"name": "documentClass",
"required": true,
"schema": {
"example": "birthCertificate",
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Document"
}
}
},
"post": {
"description": "Add a document in a folder",
"parameters": [
{
"description": "Id of the folder",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "P1987HGFKJFAA46",
"type": "string"
}
},
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
},
{
"description": "class of the document",
"in": "path",
"name": "documentClass",
"required": true,
"schema": {
"example": "birthCertificate",
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Document"
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"properties": {
"Id": {
"example": "P123",
"type": "string"
}
},
"type": "object"
}
}
},
"description": "Id of document created",
"headers": {
"Location": {
"schema": {
"description": "path of the document created",
"example": "/folders/PFJOJAF14546/documents/P48548FDAF",
"type": "string"
}
}
}
}
},
"security": [
{
"gma_auth": [
"collaborator",
"owner",
"robot"
]
}
]
}
},
"/spaces/{spaceId}/legal-entities/{id}/banks": {
"get": {
"description": "Returns list of bank folders for a legal-entity",
"parameters": [
{
"description": "Id of the legal-entity",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "T15646476",
"type": "string"
}
},
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Bank"
}
}
},
"post": {
"description": "Add a folder for a bank",
"parameters": [
{
"description": "Id of the bank or memberId",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "T1987HGFA46",
"type": "string"
}
},
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Bank"
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"properties": {
"Id": {
"example": "T1234",
"type": "string"
}
},
"type": "object"
}
}
},
"description": "Id of folder created",
"headers": {
"Location": {
"schema": {
"description": "path of the folder created",
"example": "/folders/KJF64988",
"type": "string"
}
}
}
}
},
"security": [
{
"gma_auth": [
"collaborator",
"owner",
"robot"
]
}
]
}
},
"/spaces/{spaceId}/legal-entities/{id}/banks/all": {
"get": {
"description": "Returns folder of the banks even archived",
"parameters": [
{
"description": "Id of the bank",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "T15646476",
"type": "string"
}
},
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Bank"
}
}
}
},
"/spaces/{spaceId}/legal-entities/{id}/contracts": {
"get": {
"description": "Returns all contract folders of the legal entity",
"parameters": [
{
"description": "Id of the legal entity or memberId",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "T15646476",
"type": "string"
}
},
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Contract"
}
}
}
},
"/spaces/{spaceId}/legal-entities/{id}/contractual-relationships": {
"get": {
"description": "Returns folder of the others contract with legal entity",
"parameters": [
{
"description": "Id of the legal-entity or memberId",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "T15646476",
"type": "string"
}
},
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Contractual-Relationship"
}
}
}
},
"/spaces/{spaceId}/legal-entities/{id}/contractual-relationships/all": {
"get": {
"description": "Returns folder of the others contract with legal entity (even archived)",
"parameters": [
{
"description": "Id of the legal-entity or memberId",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "T15646476",
"type": "string"
}
},
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Contractual-Relationship"
}
}
}
},
"/spaces/{spaceId}/legal-entities/{id}/customers": {
"get": {
"description": "Returns folder of the customer",
"parameters": [
{
"description": "Id of the customer or memberId",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "T15646476",
"type": "string"
}
},
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Customer"
}
}
},
"post": {
"description": "Add a folder for a customer",
"parameters": [
{
"description": "Id of the customer or memberId",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "T1987HGFA46",
"type": "string"
}
},
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Customer"
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"properties": {
"Id": {
"example": "T1234",
"type": "string"
}
},
"type": "object"
}
}
},
"description": "Id of folder created",
"headers": {
"Location": {
"schema": {
"description": "path of the folder created",
"example": "/folders/KJF64988",
"type": "string"
}
}
}
}
},
"security": [
{
"gma_auth": [
"collaborator",
"owner",
"robot"
]
}
]
}
},
"/spaces/{spaceId}/legal-entities/{id}/customers/all": {
"get": {
"description": "Returns folder of the customers (even archived)",
"parameters": [
{
"description": "Id of the customer or memberId",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "T15646476",
"type": "string"
}
},
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Customer"
}
}
}
},
"/spaces/{spaceId}/legal-entities/{id}/insurances": {
"get": {
"description": "Returns list of insurance folders for a legal-entity",
"parameters": [
{
"description": "Id of the insurance",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "T15646476",
"type": "string"
}
},
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Insurance"
}
}
},
"post": {
"description": "Add a folder for a insurance",
"parameters": [
{
"description": "Id of the insurance or memberId",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "T1987HGFA46",
"type": "string"
}
},
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Insurance"
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"properties": {
"Id": {
"example": "T1234",
"type": "string"
}
},
"type": "object"
}
}
},
"description": "Id of folder created",
"headers": {
"Location": {
"schema": {
"description": "path of the folder created",
"example": "/folders/KJF64988",
"type": "string"
}
}
}
}
},
"security": [
{
"gma_auth": [
"collaborator",
"owner",
"robot"
]
}
]
}
},
"/spaces/{spaceId}/legal-entities/{id}/insurances/all": {
"get": {
"description": "Returns folder of the insurances even archived",
"parameters": [
{
"description": "Id of the insurance",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "T15646476",
"type": "string"
}
},
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Insurance"
}
}
}
},
"/spaces/{spaceId}/legal-entities/{id}/loans": {
"get": {
"description": "Returns folder of the loan",
"parameters": [
{
"description": "Id of the loan",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "T15646476",
"type": "string"
}
},
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Loan"
}
}
},
"post": {
"description": "Add a folder for a loan",
"parameters": [
{
"description": "Id of the loan or memberId",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "T1987HGFA46",
"type": "string"
}
},
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Loan"
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"properties": {
"Id": {
"example": "T1234",
"type": "string"
}
},
"type": "object"
}
}
},
"description": "Id of folder created",
"headers": {
"Location": {
"schema": {
"description": "path of the folder created",
"example": "/folders/KJF64988",
"type": "string"
}
}
}
}
},
"security": [
{
"gma_auth": [
"collaborator",
"owner",
"robot"
]
}
]
}
},
"/spaces/{spaceId}/legal-entities/{id}/loans/all": {
"get": {
"description": "Returns folder of the loans even archived",
"parameters": [
{
"description": "Id of the loan",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "T15646476",
"type": "string"
}
},
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Loan"
}
}
}
},
"/spaces/{spaceId}/legal-entities/{id}/providers": {
"get": {
"description": "Returns list of providers folders for a legal-entity",
"parameters": [
{
"description": "Id of the provider or memberId",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "P15646476",
"type": "string"
}
},
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Provider"
}
}
},
"post": {
"description": "Add a folder for a provider",
"parameters": [
{
"description": "Id of the provider or memberId",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "P1987HGFA46",
"type": "string"
}
},
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Provider"
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"properties": {
"Id": {
"example": "T1234",
"type": "string"
}
},
"type": "object"
}
}
},
"description": "Id of folder created",
"headers": {
"Location": {
"schema": {
"description": "path of the folder created",
"example": "/folders/KJF64988",
"type": "string"
}
}
}
}
},
"security": [
{
"gma_auth": [
"collaborator",
"owner",
"robot"
]
}
]
}
},
"/spaces/{spaceId}/legal-entities/{id}/providers/all": {
"get": {
"description": "Returns folder of the providers even archived",
"parameters": [
{
"description": "Id of the provider or memberId",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "P15646476",
"type": "string"
}
},
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Provider"
}
}
}
},
"/spaces/{spaceId}/legal-entities/{id}/social-regimes": {
"get": {
"description": "Returns list of social regimes folders for a legal-entity",
"parameters": [
{
"description": "Id of the legal entity or memberId",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "P15646476",
"type": "string"
}
},
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/SocialRegime"
}
}
},
"post": {
"description": "Add a folder for a social regime",
"parameters": [
{
"description": "Id of the legal entity or memberId",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "P1987HGFA46",
"type": "string"
}
},
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/SocialRegime"
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"properties": {
"Id": {
"example": "T1234",
"type": "string"
}
},
"type": "object"
}
}
},
"description": "Id of folder created",
"headers": {
"Location": {
"schema": {
"description": "path of the folder created",
"example": "/folders/KJF64988",
"type": "string"
}
}
}
}
},
"security": [
{
"gma_auth": [
"collaborator",
"owner",
"robot"
]
}
]
}
},
"/spaces/{spaceId}/legal-entities/{id}/social-regimes/all": {
"get": {
"description": "Returns folder of the social regimes even archived",
"parameters": [
{
"description": "Id of the legal entity or memberId",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "P15646476",
"type": "string"
}
},
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/SocialRegime"
}
}
}
},
"/spaces/{spaceId}/loans": {
"get": {
"description": "Returns list of all loan folders of the space",
"parameters": [
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Loan"
}
}
}
},
"/spaces/{spaceId}/loans/all": {
"get": {
"description": "Returns list of all loan folders even archived of the space",
"parameters": [
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Loan"
}
}
}
},
"/spaces/{spaceId}/persons/{id}/call-for-document": {
"patch": {
"description": "modify the invitation of a person to collect documents",
"parameters": [
{
"description": "Id of the person",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "P198NFNIAJFAA46",
"type": "string"
}
},
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ModifyCollect"
}
}
},
"description": "Infos to invite",
"required": true
},
"responses": {
"204": {
"description": "OK"
}
},
"security": [
{
"gma_auth": [
"collaborator",
"owner",
"robot"
]
}
]
},
"post": {
"description": "invite a person to collect documents",
"parameters": [
{
"description": "Id of the person or memberId",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "P198NFNIAJFAA46",
"type": "string"
}
},
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CallForDocument"
}
}
},
"description": "Infos to invite",
"required": true
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"properties": {
"Id": {
"example": "T12FJOAHJ34",
"type": "string"
}
},
"type": "object"
}
}
},
"description": "Id of the folder of the person invited",
"headers": {
"Location": {
"schema": {
"description": "path of the folder of the person",
"example": "/persons/PFJOFJOAJHZ4546",
"type": "string"
}
}
}
}
},
"security": [
{
"gma_auth": [
"collaborator",
"owner",
"robot"
]
}
]
}
},
"/spaces/{spaceId}/persons/{id}/employees": {
"get": {
"description": "Returns folder of the employee",
"parameters": [
{
"description": "Id of the person or memberId",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "P15HBGUFA76",
"type": "string"
}
},
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Employee"
}
}
},
"post": {
"description": "Add a folder for a employee",
"parameters": [
{
"description": "Id of the employee",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "P198JFUAFA46",
"type": "string"
}
},
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Employee"
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"properties": {
"Id": {
"example": "T1234",
"type": "string"
}
},
"type": "object"
}
}
},
"description": "Id of folder created",
"headers": {
"Location": {
"schema": {
"description": "path of the folder created",
"example": "/folders/KJF64988",
"type": "string"
}
}
}
}
},
"security": [
{
"gma_auth": [
"collaborator",
"owner",
"robot"
]
}
]
}
},
"/spaces/{spaceId}/persons/{id}/employees/all": {
"get": {
"description": "Returns folder of all employees (even archived)",
"parameters": [
{
"description": "Id of the person or memberId",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "P15HBGUFA76",
"type": "string"
}
},
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Employee"
}
}
}
},
"/spaces/{spaceId}/persons/{id}/exchange": {
"get": {
"description": "Returns folder exchange of the person",
"parameters": [
{
"description": "Id of the person or memberId",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "T15646IFHA476",
"type": "string"
}
},
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/OneFolder"
}
}
}
},
"/spaces/{spaceId}/persons/{id}/follow-ups": {
"get": {
"description": "Returns folder of the person",
"parameters": [
{
"description": "Id of the person or memberId",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "T15646IFHA476",
"type": "string"
}
},
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/FollowUp"
}
}
}
},
"/spaces/{spaceId}/persons/{id}/guest-in-space": {
"delete": {
"description": "delete the invitation of a person in a space",
"parameters": [
{
"description": "Id of the person",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "P198NFNIAJFAA46",
"type": "string"
}
},
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
}
],
"responses": {
"204": {
"description": "OK"
}
},
"security": [
{
"gma_auth": [
"collaborator",
"owner",
"robot"
]
}
]
},
"patch": {
"description": "invite a person in a space",
"parameters": [
{
"description": "Id of the person",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "P198NFNIAJFAA46",
"type": "string"
}
},
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ModifyInvitation"
}
}
},
"description": "Infos to invite",
"required": true
},
"responses": {
"204": {
"description": "OK"
}
},
"security": [
{
"gma_auth": [
"collaborator",
"owner",
"robot"
]
}
]
},
"post": {
"description": "invite a person in a space",
"parameters": [
{
"description": "Id of the person",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "P198NFNIAJFAA46",
"type": "string"
}
},
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GuestInSpace"
}
}
},
"description": "Infos to invite",
"required": true
},
"responses": {
"204": {
"description": "OK"
}
},
"security": [
{
"gma_auth": [
"collaborator",
"owner",
"robot"
]
}
]
}
},
"/spaces/{spaceId}/persons/{id}/invitation": {
"delete": {
"description": "delete the invitation of a person in a space",
"parameters": [
{
"description": "Id of the person",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "P198NFNIAJFAA46",
"type": "string"
}
},
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
}
],
"responses": {
"204": {
"description": "OK"
}
},
"security": [
{
"gma_auth": [
"collaborator",
"owner",
"robot"
]
}
]
},
"get": {
"description": "Returns invitation of a person",
"parameters": [
{
"description": "Id of the person",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "P198NFNIAJFAA46",
"type": "string"
}
},
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/Invitation"
}
}
},
"description": "Automatically created"
}
}
},
"patch": {
"description": "modify an invitation",
"parameters": [
{
"description": "Id of the person",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "P198NFNIAJFAA46",
"type": "string"
}
},
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/CreateInvitation"
},
"responses": {
"204": {
"description": "OK"
}
},
"security": [
{
"gma_auth": [
"collaborator",
"owner",
"robot"
]
}
]
},
"post": {
"description": "create an invitation in a space for a person",
"parameters": [
{
"description": "Id of the person",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "P198NFNIAJFAA46",
"type": "string"
}
},
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/CreateInvitation"
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"properties": {
"Id": {
"example": "T1234",
"type": "string"
}
},
"type": "object"
}
}
},
"description": "Id of invitation created"
}
},
"security": [
{
"gma_auth": [
"collaborator",
"owner",
"robot"
]
}
]
}
},
"/spaces/{spaceId}/persons/{id}/invitation/{invitationId}/send": {
"post": {
"description": "send the invitation of a person in a space",
"parameters": [
{
"description": "Id of the person",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "P198NFNIAJFAA46",
"type": "string"
}
},
{
"description": "Id of the invitation",
"in": "path",
"name": "invitationId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
},
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/SendInvitation"
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"properties": {
"Id": {
"example": "T1234",
"type": "string"
}
},
"type": "object"
}
}
},
"description": "Id of document created"
}
},
"security": [
{
"gma_auth": [
"collaborator",
"owner",
"robot"
]
}
]
}
},
"/spaces/{spaceId}/persons/{memberId}/folders/{id}": {
"get": {
"description": "Returns folderId with the access of the person",
"parameters": [
{
"description": "Id of the folder",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "T15646476",
"type": "string"
}
},
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
},
{
"description": "memberId of the person",
"in": "path",
"name": "memberId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/OneAccess"
}
}
},
"patch": {
"description": "Modify an access",
"parameters": [
{
"description": "Id of the folder",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "T18784",
"type": "string"
}
},
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
},
{
"description": "memberId of the person",
"in": "path",
"name": "memberId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/ModifyAccess"
},
"responses": {
"204": {
"description": "OK"
}
}
}
},
"/spaces/{spaceId}/providers": {
"get": {
"description": "Returns folder with Id and provider data",
"parameters": [
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
},
{
"description": "if present returns infos of the ContractingPartner too",
"in": "query",
"name": "WithContractingPartner",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Provider"
}
}
}
},
"/spaces/{spaceId}/providers/all": {
"get": {
"description": "Returns folder with Id and provider data (even archived)",
"parameters": [
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
},
{
"description": "if present returns infos of the ContractingPartner too",
"in": "query",
"name": "WithContractingPartner",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Provider"
}
}
}
},
"/spaces/{spaceId}/search": {
"get": {
"description": "Research text inside documents, folders or messages",
"parameters": [
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
},
{
"description": "Text to find",
"in": "query",
"name": "Query",
"required": false,
"schema": {
"example": "durand",
"type": "string"
}
},
{
"description": "index range of the results",
"in": "query",
"name": "Range",
"required": false,
"schema": {
"example": "10-19",
"type": "string"
}
},
{
"description": "context of research",
"in": "query",
"name": "QueryContext",
"required": false,
"schema": {
"properties": {
"Class": {
"enum": [
"Folder",
"Document",
"Message"
],
"example": "Folder",
"type": "string"
},
"Filters": {
"properties": {
"DocumentClass": {
"example": "payslip",
"type": "string"
},
"ExcludedFolders": {
"items": {
"type": "string"
},
"type": "array"
},
"IncludedFolders": {
"items": {
"example": [
"POJFA9492"
],
"type": "string"
},
"type": "array"
}
},
"type": "object"
}
},
"type": "object"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Search"
}
}
}
},
"/spaces/{spaceId}/social-regimes": {
"get": {
"description": "Returns folder with Id and social regime data",
"parameters": [
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
},
{
"description": "if present returns infos of the ContractingPartner too",
"in": "query",
"name": "WithContractingPartner",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/SocialRegime"
}
}
}
},
"/spaces/{spaceId}/social-regimes/all": {
"get": {
"description": "Returns folder with Id and social regime data (even archived)",
"parameters": [
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
},
{
"description": "if present returns infos of the ContractingPartner too",
"in": "query",
"name": "WithContractingPartner",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/SocialRegime"
}
}
}
},
"/spaces/{spaceId}/spaces-invoicings": {
"get": {
"description": "Returns CSV Invoicings of the spaces for the account of the spaceId",
"parameters": [
{
"description": "Id of the space",
"in": "path",
"name": "spaceId",
"required": true,
"schema": {
"example": "P156HUFHA476",
"type": "string"
}
},
{
"description": "date range of the documents",
"in": "query",
"name": "Date",
"required": false,
"schema": {
"example": "20160321,null",
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/SpacesInvoicing"
}
}
}
}
},
"components": {
"requestBodies": {
"AccountingYear": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"properties": {
"About": {
"example": "<b> Mon premier dossier </b>",
"type": "string"
},
"Comment": {
"example": "ogm of the company",
"type": "string"
},
"End": {
"example": "20181231",
"type": "string"
},
"Home": {
"example": "yes",
"type": "boolean"
},
"Keywords": {
"example": [
"paris",
"comptabilité"
],
"items": {
"type": "string"
},
"type": "array"
},
"Level": {
"enum": [
"confidential",
"regular",
"public"
],
"example": "confidential",
"type": "string"
},
"NetIncome": {
"example": 52634.36,
"type": "number"
},
"NetPosition": {
"example": 14580.36,
"type": "number"
},
"Start": {
"example": "20180101",
"type": "string"
},
"Tax": {
"example": 45698.36,
"type": "number"
},
"TaxableIncome": {
"example": 869523.36,
"type": "number"
},
"Turnover": {
"example": 1025.36,
"type": "number"
}
},
"type": "object"
}
],
"required": [
"End"
]
}
}
},
"description": "AccountingYear to add",
"required": true
},
"BSpace": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"properties": {
"Logo": {
"properties": {
"Content64Encoded": {
"example": "NIFHAZFA07GA=",
"type": "string"
},
"Name": {
"example": "toto.png",
"type": "string"
}
},
"type": "object"
},
"Name": {
"example": "Mon Entreprise",
"type": "string"
},
"TemplateSpaceId": {
"example": "PKOJOFOFKAOKF",
"type": "string"
},
"Type": {
"enum": [
"enterprise",
"company",
"association"
],
"example": "company",
"type": "string"
}
},
"type": "object"
}
],
"required": [
"Type"
]
}
}
},
"description": "Space to add (except private)",
"required": true
},
"Bank": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"properties": {
"About": {
"example": "<b> Mon premier dossier </b>",
"type": "string"
},
"Comment": {
"example": "pieces company",
"type": "string"
},
"ContractReference": {
"example": "13587449420F",
"type": "string"
},
"Designation": {
"example": "client pièces détachées",
"type": "string"
},
"End": {
"example": "20190101",
"type": "string"
},
"Home": {
"example": "yes",
"type": "boolean"
},
"Keywords": {
"example": [
"paris",
"comptabilité"
],
"items": {
"type": "string"
},
"type": "array"
},
"Level": {
"enum": [
"confidential",
"regular",
"public"
],
"example": "confidential",
"type": "string"
},
"Start": {
"example": "20180630",
"type": "string"
}
},
"type": "object"
}
]
}
}
},
"description": "Bank to add (except name, class and archivaldate)",
"required": true
},
"BankStatement": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"properties": {
"Balance": {
"example": 1352.63,
"format": "number",
"type": "number"
},
"DocumentId": {
"example": "PBUFBAUBF1531",
"type": "string"
},
"Number": {
"example": "10015848",
"format": "string",
"type": "number"
},
"StatementDate": {
"example": "20160801",
"type": "string"
}
},
"type": "object"
},
{
"properties": {
"Accounting": {
"properties": {
"AccountedOn": {
"example": "20181202",
"type": "string"
},
"Workbook": {
"enum": [
"customer",
"provider",
"bank",
"cashWoucher",
"fiscal",
"insurance",
"social",
"other",
"permanent"
],
"example": "fiscal",
"type": "string"
},
"YearMonth": {
"example": 201902,
"type": "string"
}
},
"type": "object"
},
"Author": {
"example": "Antoine Dupond",
"type": "string"
},
"Balance": {
"example": 1352.63,
"format": "number",
"type": "number"
},
"Code": {
"example": "COD",
"type": "string"
},
"Comment": {
"example": "my document",
"type": "string"
},
"Date": {
"example": "20161203",
"type": "string"
},
"File": {
"properties": {
"Content64Encoded": {
"example": "gjgjJ9FJA829H9HA18B",
"type": "string"
},
"Name": {
"example": "MonDocument.pdf",
"type": "string"
}
},
"type": "object"
},
"Number": {
"example": "10015848",
"format": "string",
"type": "number"
},
"StatementDate": {
"example": "20160801",
"type": "string"
},
"Title": {
"example": "Facture décembre",
"type": "string"
}
},
"type": "object"
}
],
"required": [
"Title",
"File",
"Name",
"Content64Encoded",
"DocumentId",
"StatementDate"
]
}
},
"multipart/form-data": {
"schema": {
"allOf": [
{
"properties": {
"Accounting": {
"properties": {
"AccountedOn": {
"example": "20181202",
"type": "string"
},
"Workbook": {
"enum": [
"customer",
"provider",
"bank",
"cashWoucher",
"fiscal",
"insurance",
"social",
"other",
"permanent"
],
"example": "fiscal",
"type": "string"
},
"YearMonth": {
"example": 201902,
"type": "string"
}
},
"type": "object"
},
"Author": {
"example": "Antoine Dupond",
"type": "string"
},
"Balance": {
"example": 1352.63,
"format": "number",
"type": "number"
},
"Code": {
"example": "COD",
"type": "string"
},
"Comment": {
"example": "my document",
"type": "string"
},
"Date": {
"example": "20161203",
"type": "string"
},
"File": {
"format": "binary",
"type": "string"
},
"Number": {
"example": "10015848",
"format": "string",
"type": "number"
},
"StatementDate": {
"example": "20160801",
"type": "string"
},
"Title": {
"example": "Facture décembre",
"type": "string"
}
},
"type": "object"
}
],
"required": [
"Title",
"File",
"Name",
"StatementDate"
]
}
}
},
"description": "Bank statement to add (either DocumentId,StatementDate either (File,Name,Content64Encoded,Title,StatementDate) is mandatory)",
"required": true
},
"BusinessGroup": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"properties": {
"Name": {
"example": "Client Durand",
"type": "string"
}
},
"type": "object"
}
],
"required": [
"Name"
]
}
}
},
"description": "BusinessGroup to add",
"required": true
},
"CollectiveDecision": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"properties": {
"About": {
"example": "<b> Mon premier dossier </b>",
"type": "string"
},
"Comment": {
"example": "ogm of the company",
"type": "string"
},
"Date": {
"example": "20180202",
"type": "string"
},
"DividendDistributions": {
"example": 1025.36,
"type": "number"
},
"DividendDistributionsDate": {
"example": "20180203",
"type": "string"
},
"Event": {
"description": "for space type 'company' enums allowed are 'EGM','CGM','OGM','ConstituentAssembly','SolePartner','OtherEvent','Office','ExecutiveCommittee','Consulting','Board','PartnersMeeting' and for space type 'association' enums allowed are 'EGM','CGM','OGM','Other','Office','ExecutiveCommittee'",
"enum": [
"EGM",
"CGM",
"OGM",
"ConstituentAssembly",
"SolePartner",
"OtherEvent",
"Other",
"Office",
"ExecutiveCommittee",
"Consulting",
"Board",
"PartnersMeeting"
],
"example": "EGM",
"type": "string"
},
"Home": {
"example": "yes",
"type": "boolean"
},
"Keywords": {
"example": [
"paris",
"comptabilité"
],
"items": {
"type": "string"
},
"type": "array"
},
"Level": {
"enum": [
"confidential",
"regular",
"public"
],
"example": "confidential",
"type": "string"
}
},
"type": "object"
}
],
"required": [
"Event",
"Date"
]
}
}
},
"description": "CollectiveDecision to add",
"required": true
},
"CommonFolder": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"properties": {
"About": {
"example": "<b> Mon premier dossier </b>",
"type": "string"
},
"ArchivalDate": {
"example": "20160203",
"type": "string"
},
"Home": {
"example": "yes",
"type": "boolean"
},
"Keywords": {
"example": [
"paris",
"comptabilité"
],
"items": {
"type": "string"
},
"type": "array"
},
"Level": {
"enum": [
"confidential",
"regular",
"public"
],
"example": "confidential",
"type": "string"
},
"Name": {
"example": "Dupond",
"type": "string"
},
"Rights": {
"example": true,
"type": "boolean"
}
},
"type": "object"
}
],
"required": [
"Name"
]
}
}
},
"description": "Common Folder to add",
"required": true
},
"CompanyEntity": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"properties": {
"ApeCode": {
"example": "420F",
"type": "string"
},
"ArchivalDate": {
"example": "20160203",
"type": "string"
},
"Comment": {
"example": "my brother",
"type": "string"
},
"LegalName": {
"example": "Mon entreprise Dupond",
"type": "string"
},
"LegalStatut": {
"example": "SAS",
"type": "string"
},
"Name": {
"example": "Dupond",
"type": "string"
},
"RegistrationNumber": {
"example": "236542158",
"type": "string"
},
"Type": {
"example": "EPT",
"type": "string"
},
"VatNumber": {
"example": "46546847864",
"type": "string"
}
},
"type": "object"
}
],
"required": [
"Name",
"LegalName"
]
}
}
},
"description": "Company to add Name or LegalName are mandatory",
"required": true
},
"ContractualDocument": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"properties": {
"Amount": {
"example": "1001.36",
"type": "string"
},
"Designation": {
"example": "contrat client",
"type": "string"
},
"DocumentId": {
"example": "PBUFBAUBF1531",
"type": "string"
},
"Reference": {
"example": "151465AFHIA",
"type": "string"
},
"StartDate": {
"example": "20181128",
"type": "string"
},
"Type": {
"enum": [
"contract",
"engagement-letter",
"amendment",
"purchase-order",
"delivery-order",
"quotation",
"other"
],
"example": "quotation",
"type": "string"
}
},
"type": "object"
},
{
"properties": {
"Accounting": {
"properties": {
"AccountedOn": {
"example": "20181202",
"type": "string"
},
"Workbook": {
"enum": [
"customer",
"provider",
"bank",
"cashWoucher",
"fiscal",
"insurance",
"social",
"other",
"permanent"
],
"example": "fiscal",
"type": "string"
},
"YearMonth": {
"example": 201902,
"type": "string"
}
},
"type": "object"
},
"Amount": {
"example": "1001.36",
"type": "string"
},
"Author": {
"example": "Antoine Dupond",
"type": "string"
},
"Code": {
"example": "COD",
"type": "string"
},
"Comment": {
"example": "my document",
"type": "string"
},
"Date": {
"example": "20161203",
"type": "string"
},
"Designation": {
"example": "contrat client",
"type": "string"
},
"File": {
"properties": {
"Content64Encoded": {
"example": "gjgjJ9FJA829H9HA18B",
"type": "string"
},
"Name": {
"example": "MonDocument.pdf",
"type": "string"
}
}
},
"Reference": {
"example": "151465AFHIA",
"type": "string"
},
"StartDate": {
"example": "20181128",
"type": "string"
},
"Title": {
"example": "Facture décembre",
"type": "string"
},
"Type": {
"enum": [
"contract",
"engagement-letter",
"amendment",
"purchase-order",
"delivery-order",
"quotation",
"other"
],
"example": "quotation",
"type": "string"
}
},
"type": "object"
}
],
"required": [
"Title",
"File",
"Name",
"Content64Encoded",
"DocumentId"
]
}
},
"multipart/form-data": {
"schema": {
"allOf": [
{
"properties": {
"Accounting": {
"properties": {
"AccountedOn": {
"example": "20181202",
"type": "string"
},
"Workbook": {
"enum": [
"customer",
"provider",
"bank",
"cashWoucher",
"fiscal",
"insurance",
"social",
"other",
"permanent"
],
"example": "fiscal",
"type": "string"
},
"YearMonth": {
"example": 201902,
"type": "string"
}
},
"type": "object"
},
"Amount": {
"example": "1001.36",
"type": "string"
},
"Author": {
"example": "Antoine Dupond",
"type": "string"
},
"Code": {
"example": "COD",
"type": "string"
},
"Comment": {
"example": "my document",
"type": "string"
},
"Date": {
"example": "20161203",
"type": "string"
},
"Designation": {
"example": "contrat client",
"type": "string"
},
"File": {
"format": "binary",
"type": "string"
},
"Reference": {
"example": "151465AFHIA",
"type": "string"
},
"StartDate": {
"example": "20181128",
"type": "string"
},
"Title": {
"example": "Facture décembre",
"type": "string"
},
"Type": {
"enum": [
"contract",
"engagement-letter",
"amendment",
"purchase-order",
"delivery-order",
"quotation",
"other"
],
"example": "quotation",
"type": "string"
}
},
"type": "object"
}
],
"required": [
"Title",
"File",
"Name"
]
}
}
},
"description": "Document to add (either DocumentId either (File,Name,Content64Encoded,Title) is mandatory)",
"required": true
},
"CorporateTaxDeclaration": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"properties": {
"Amount": {
"example": 132.63,
"format": "float",
"type": "number"
},
"DeclarationDate": {
"example": "20160801",
"type": "string"
},
"DocumentId": {
"example": "PBUFBAUBF1531",
"type": "string"
},
"Order": {
"enum": [
"1st advance",
"2nd advance",
"3rd advance",
"4th advance",
"regularization"
],
"example": "1st advance",
"type": "string"
},
"Rate": {
"example": 10.63,
"format": "float",
"type": "number"
},
"TaxBase": {
"example": 123.36,
"format": "float",
"type": "number"
}
},
"type": "object"
},
{
"properties": {
"Accounting": {
"properties": {
"AccountedOn": {
"example": "20181202",
"type": "string"
},
"Workbook": {
"enum": [
"customer",
"provider",
"bank",
"cashWoucher",
"fiscal",
"insurance",
"social",
"other",
"permanent"
],
"example": "fiscal",
"type": "string"
},
"YearMonth": {
"example": 201902,
"type": "string"
}
},
"type": "object"
},
"Amount": {
"example": 132.63,
"format": "float",
"type": "number"
},
"Author": {
"example": "Antoine Dupond",
"type": "string"
},
"Code": {
"example": "COD",
"type": "string"
},
"Comment": {
"example": "my document",
"type": "string"
},
"Date": {
"example": "20161203",
"type": "string"
},
"DeclarationDate": {
"example": "20160801",
"type": "string"
},
"File": {
"properties": {
"Content64Encoded": {
"example": "gjgjJ9FJA829H9HA18B",
"type": "string"
},
"Name": {
"example": "MonDocument.pdf",
"type": "string"
}
},
"type": "object"
},
"Order": {
"enum": [
"1st advance",
"2nd advance",
"3rd advance",
"4th advance",
"regularization"
],
"example": "1st advance",
"type": "string"
},
"Rate": {
"example": 10.63,
"format": "float",
"type": "number"
},
"TaxBase": {
"example": 123.36,
"format": "float",
"type": "number"
},
"Title": {
"example": "Facture décembre",
"type": "string"
}
},
"type": "object"
}
],
"required": [
"Title",
"File",
"Name",
"Content64Encoded",
"DocumentId"
]
}
},
"multipart/form-data": {
"schema": {
"allOf": [
{
"properties": {
"Accounting": {
"properties": {
"AccountedOn": {
"example": "20181202",
"type": "string"
},
"Workbook": {
"enum": [
"customer",
"provider",
"bank",
"cashWoucher",
"fiscal",
"insurance",
"social",
"other",
"permanent"
],
"example": "fiscal",
"type": "string"
},
"YearMonth": {
"example": 201902,
"type": "string"
}
},
"type": "object"
},
"Amount": {
"example": 132.63,
"format": "float",
"type": "number"
},
"Author": {
"example": "Antoine Dupond",
"type": "string"
},
"Code": {
"example": "COD",
"type": "string"
},
"Comment": {
"example": "my document",
"type": "string"
},
"Date": {
"example": "20161203",
"type": "string"
},
"DeclarationDate": {
"example": "20160801",
"type": "string"
},
"File": {
"format": "binary",
"type": "string"
},
"Order": {
"enum": [
"1st advance",
"2nd advance",
"3rd advance",
"4th advance",
"regularization"
],
"example": "1st advance",
"type": "string"
},
"Rate": {
"example": 10.63,
"format": "float",
"type": "number"
},
"TaxBase": {
"example": 123.36,
"format": "float",
"type": "number"
},
"Title": {
"example": "Facture décembre",
"type": "string"
}
},
"type": "object"
}
],
"required": [
"Title",
"File",
"Name"
]
}
}
},
"description": "Corporate tax declaration to add (either (DeclarationDate,DocumentId) either (File,Name,Content64Encoded,Title,DeclarationDate) is mandatory)",
"required": true
},
"CreateInvitation": {
"content": {
"application/json": {
"schema": {
"properties": {
"ClientManagement": {
"enum": [
"no",
"manager",
"adn"
],
"type": "string"
},
"EmployeeAccess": {
"example": true,
"type": "boolean"
},
"Folders": {
"items": {
"properties": {
"Id": {
"example": "PK8481482",
"type": "string"
},
"Right": {
"enum": [
"read",
"write"
],
"example": "read",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"GroupIds": {
"items": {
"example": [
"PJFIA84",
"PHAJHFJHA"
],
"type": "string"
},
"type": "array"
},
"IsAdmin": {
"example": true,
"type": "boolean"
},
"Player": {
"enum": [
"guest",
"owner",
"manager",
"assistant",
"collaborator"
],
"example": "guest",
"type": "string"
},
"PlayerEnd": {
"example": "20190601",
"type": "string"
}
},
"type": "object"
}
}
},
"description": "Invitation to create",
"required": true
},
"Customer": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"properties": {
"About": {
"example": "<b> Mon premier dossier </b>",
"type": "string"
},
"Comment": {
"example": "pieces company",
"type": "string"
},
"CustomerNumber": {
"example": "13587449420F",
"type": "string"
},
"Designation": {
"example": "client pièces détachées",
"type": "string"
},
"End": {
"example": "20190101",
"type": "string"
},
"Home": {
"example": "yes",
"type": "boolean"
},
"Keywords": {
"example": [
"paris",
"comptabilité"
],
"items": {
"type": "string"
},
"type": "array"
},
"Level": {
"enum": [
"confidential",
"regular",
"public"
],
"example": "confidential",
"type": "string"
},
"PortfolioId": {
"example": "T1OJFOAZ7449420F",
"type": "string"
},
"Start": {
"example": "20180630",
"type": "string"
}
},
"type": "object"
}
]
}
}
},
"description": "Customer to add (except name, class and archivaldate)",
"required": true
},
"Details": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"properties": {
"Address": {
"properties": {
"City": {
"example": "Paris",
"type": "string"
},
"Complement": {
"example": "batiment A",
"type": "string"
},
"Country": {
"example": "France",
"type": "string"
},
"Street": {
"example": "2, rue du chateau",
"type": "string"
},
"ZipCode": {
"example": "75001",
"type": "string"
}
},
"type": "object"
},
"Designation": {
"example": "Office",
"type": "string"
},
"Email": {
"items": {
"example": [
"bertrand@monmail.com"
],
"type": "string"
},
"type": "array"
},
"Phone": {
"items": {
"example": [
"+33606060606"
],
"type": "string"
},
"type": "array"
}
},
"type": "object"
}
],
"required": [
"Designation"
]
}
}
},
"description": "Contact details to add or replace (Designation and Phone or Mail are mandatory)",
"required": true
},
"Document": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"properties": {
"DocumentId": {
"example": "PBUFBAUBF1531",
"type": "string"
}
},
"type": "object"
},
{
"properties": {
"Accounting": {
"properties": {
"AccountedOn": {
"example": "20181202",
"type": "string"
},
"Workbook": {
"enum": [
"customer",
"provider",
"bank",
"cashWoucher",
"fiscal",
"insurance",
"social",
"other",
"permanent"
],
"example": "fiscal",
"type": "string"
},
"YearMonth": {
"example": 201902,
"type": "string"
}
},
"type": "object"
},
"Author": {
"example": "Antoine Dupond",
"type": "string"
},
"Code": {
"example": "COD",
"type": "string"
},
"Comment": {
"example": "my document",
"type": "string"
},
"Date": {
"example": "20161203",
"type": "string"
},
"File": {
"properties": {
"Content64Encoded": {
"example": "gjgjJ9FJA829H9HA18B",
"type": "string"
},
"Name": {
"example": "MonDocument.pdf",
"type": "string"
}
},
"type": "object"
},
"Title": {
"example": "Facture décembre",
"type": "string"
}
},
"type": "object"
}
],
"required": [
"Title",
"File",
"Name",
"Content64Encoded"
]
}
},
"multipart/form-data": {
"schema": {
"allOf": [
{
"properties": {
"Accounting": {
"properties": {
"AccountedOn": {
"example": "20181202",
"type": "string"
},
"Workbook": {
"enum": [
"customer",
"provider",
"bank",
"cashWoucher",
"fiscal",
"insurance",
"social",
"other",
"permanent"
],
"example": "fiscal",
"type": "string"
},
"YearMonth": {
"example": 201902,
"type": "string"
}
},
"type": "object"
},
"Author": {
"example": "Antoine Dupond",
"type": "string"
},
"Code": {
"example": "COD",
"type": "string"
},
"Comment": {
"example": "my document",
"type": "string"
},
"Date": {
"example": "20161203",
"type": "string"
},
"File": {
"format": "binary",
"type": "string"
},
"Title": {
"example": "Facture décembre",
"type": "string"
}
},
"type": "object"
}
],
"required": [
"Title",
"File",
"Name"
]
}
}
},
"description": "Document to add (either DocumentId either (File,Name,Content64Encoded,Title) is mandatory)",
"required": true
},
"Documents": {
"content": {
"application/json": {
"schema": {
"properties": {
"Accounting": {
"properties": {
"AccountedOn": {
"example": "20181202",
"type": "string"
},
"Workbook": {
"enum": [
"customer",
"provider",
"bank",
"cashWoucher",
"fiscal",
"insurance",
"social",
"other",
"permanent"
],
"example": "fiscal",
"type": "string"
},
"YearMonth": {
"example": 201902,
"type": "string"
}
},
"type": "object"
},
"Author": {
"example": "Antoine Dupond",
"type": "string"
},
"Code": {
"example": "COD",
"type": "string"
},
"Comment": {
"example": "my document",
"type": "string"
},
"Date": {
"example": "20161203",
"type": "string"
},
"File": {
"properties": {
"Content64Encoded": {
"example": "gjgjJ9FJA829H9HA18B",
"type": "string"
},
"Name": {
"example": "Mon Document",
"type": "string"
}
},
"type": "object"
},
"Title": {
"example": "Facture décembre",
"type": "string"
}
},
"required": [
"Title",
"File"
],
"type": "object"
}
},
"multipart/form-data": {
"schema": {
"properties": {
"Accounting": {
"properties": {
"AccountedOn": {
"example": "20181202",
"type": "string"
},
"Workbook": {
"enum": [
"customer",
"provider",
"bank",
"cashWoucher",
"fiscal",
"insurance",
"social",
"other",
"permanent"
],
"example": "fiscal",
"type": "string"
},
"YearMonth": {
"example": 201902,
"type": "string"
}
},
"type": "object"
},
"Author": {
"example": "Antoine Dupond",
"type": "string"
},
"Code": {
"example": "COD",
"type": "string"
},
"Comment": {
"example": "my document",
"type": "string"
},
"Date": {
"example": "20161203",
"type": "string"
},
"File": {
"format": "binary",
"type": "string"
},
"Title": {
"example": "Facture décembre",
"type": "string"
}
},
"required": [
"Title",
"File"
],
"type": "object"
}
}
},
"description": "Document to add",
"required": true
},
"Employee": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"properties": {
"About": {
"example": "<b> Mon premier dossier </b>",
"type": "string"
},
"Comment": {
"example": "pieces company",
"type": "string"
},
"ContractType": {
"example": "01",
"type": "string"
},
"EmployeeNumber": {
"example": "13587FAZCD420F",
"type": "string"
},
"End": {
"example": "20190101",
"type": "string"
},
"Function": {
"example": "commercial",
"type": "string"
},
"Home": {
"example": "yes",
"type": "boolean"
},
"Keywords": {
"example": [
"paris",
"comptabilité"
],
"items": {
"type": "string"
},
"type": "array"
},
"Level": {
"enum": [
"confidential",
"regular",
"public"
],
"example": "confidential",
"type": "string"
},
"PostalMail": {
"example": true,
"type": "boolean"
},
"SSNumber": {
"example": "1542012365985215",
"type": "string"
},
"Start": {
"example": "20180630",
"type": "string"
}
},
"type": "object"
}
]
}
}
},
"description": "Employee to add (except name, class and archivaldate)",
"required": true
},
"ExpenseProof": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"properties": {
"Account": {
"enum": [
"CAB",
"IKM",
"PRK",
"TXI",
"VOY",
"PTT",
"FHR",
"DIV",
"RES"
],
"example": "CAB",
"type": "string"
},
"ArchivalDate": {
"example": 20211231,
"type": "string"
},
"BeforeVAT": {
"example": 1000,
"type": "number"
},
"DocumentId": {
"example": "PBUFBAUBF1531",
"type": "string"
},
"ExpenseDate": {
"example": "20200202",
"type": "string"
},
"ExpenseReportId": {
"example": "PFOIAHF874984",
"type": "string"
},
"Provider": {
"example": "G7",
"type": "string"
},
"Reason": {
"example": "taxi",
"type": "string"
},
"Status": {
"enum": [
"R",
"V",
"W"
],
"example": "R",
"type": "string"
},
"VAT": {
"example": 19.5,
"type": "number"
}
},
"type": "object"
},
{
"properties": {
"Account": {
"enum": [
"CAB",
"IKM",
"PRK",
"TXI",
"VOY",
"PTT",
"FHR",
"DIV",
"RES"
],
"example": "CAB",
"type": "string"
},
"Accounting": {
"properties": {
"AccountedOn": {
"example": "20181202",
"type": "string"
},
"Workbook": {
"enum": [
"customer",
"provider",
"bank",
"cashWoucher",
"fiscal",
"insurance",
"social",
"other",
"permanent"
],
"example": "fiscal",
"type": "string"
},
"YearMonth": {
"example": 201902,
"type": "string"
}
},
"type": "object"
},
"ArchivalDate": {
"example": 20211231,
"type": "string"
},
"Author": {
"example": "Antoine Dupond",
"type": "string"
},
"BeforeVAT": {
"example": 1000,
"type": "number"
},
"Code": {
"example": "COD",
"type": "string"
},
"Comment": {
"example": "my document",
"type": "string"
},
"Date": {
"example": "20161203",
"type": "string"
},
"ExpenseDate": {
"example": "20200202",
"type": "string"
},
"ExpenseReportId": {
"example": "PFOIAHF874984",
"type": "string"
},
"File": {
"properties": {
"Content64Encoded": {
"example": "gjgjJ9FJA829H9HA18B",
"type": "string"
},
"Name": {
"example": "MonDocument.pdf",
"type": "string"
}
},
"type": "object"
},
"Provider": {
"example": "G7",
"type": "string"
},
"Reason": {
"example": "taxi",
"type": "string"
},
"Status": {
"enum": [
"R",
"V",
"W"
],
"example": "R",
"type": "string"
},
"Title": {
"example": "Facture décembre",
"type": "string"
},
"VAT": {
"example": 19.5,
"type": "number"
}
},
"type": "object"
}
],
"required": [
"Title",
"File",
"Name",
"Content64Encoded",
"DocumentId"
]
}
},
"multipart/form-data": {
"schema": {
"allOf": [
{
"properties": {
"Account": {
"enum": [
"CAB",
"IKM",
"PRK",
"TXI",
"VOY",
"PTT",
"FHR",
"DIV",
"RES"
],
"example": "CAB",
"type": "string"
},
"Accounting": {
"properties": {
"AccountedOn": {
"example": "20181202",
"type": "string"
},
"Workbook": {
"enum": [
"customer",
"provider",
"bank",
"cashWoucher",
"fiscal",
"insurance",
"social",
"other",
"permanent"
],
"example": "fiscal",
"type": "string"
},
"YearMonth": {
"example": 201902,
"type": "string"
}
},
"type": "object"
},
"ArchivalDate": {
"example": 20211231,
"type": "string"
},
"Author": {
"example": "Antoine Dupond",
"type": "string"
},
"BeforeVAT": {
"example": 1000,
"type": "number"
},
"Code": {
"example": "COD",
"type": "string"
},
"Comment": {
"example": "my document",
"type": "string"
},
"Date": {
"example": "20161203",
"type": "string"
},
"ExpenseDate": {
"example": "20200202",
"type": "string"
},
"ExpenseReportId": {
"example": "PFOIAHF874984",
"type": "string"
},
"File": {
"format": "binary",
"type": "string"
},
"Provider": {
"example": "G7",
"type": "string"
},
"Reason": {
"example": "taxi",
"type": "string"
},
"Status": {
"enum": [
"R",
"V",
"W"
],
"example": "R",
"type": "string"
},
"Title": {
"example": "Facture décembre",
"type": "string"
},
"VAT": {
"example": 19.5,
"type": "number"
}
},
"type": "object"
}
],
"required": [
"Title",
"File",
"Name"
]
}
}
},
"description": "Expense proof to add (either DocumentId, ExpenseDate either (File,Name,Content64Encoded,Title,ExpenseDate) is mandatory)",
"required": true
},
"ExpenseReport": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"properties": {
"BeforeVAT": {
"example": 1000,
"type": "number"
},
"Date": {
"example": "20161203",
"type": "string"
},
"DocumentId": {
"example": "PBUFBAUBF1531",
"type": "string"
},
"ExpenseDate": {
"example": "20200202",
"type": "string"
},
"InclVAT": {
"example": 1200,
"type": "number"
},
"ProcessingDate": {
"example": "20200203",
"type": "string"
},
"VAT": {
"example": 19.5,
"type": "number"
}
},
"type": "object"
},
{
"properties": {
"Accounting": {
"properties": {
"AccountedOn": {
"example": "20181202",
"type": "string"
},
"Workbook": {
"enum": [
"customer",
"provider",
"bank",
"cashWoucher",
"fiscal",
"insurance",
"social",
"other",
"permanent"
],
"example": "fiscal",
"type": "string"
},
"YearMonth": {
"example": 201902,
"type": "string"
}
},
"type": "object"
},
"Author": {
"example": "Antoine Dupond",
"type": "string"
},
"BeforeVAT": {
"example": 1000,
"type": "number"
},
"Code": {
"example": "COD",
"type": "string"
},
"Comment": {
"example": "my document",
"type": "string"
},
"Date": {
"example": "20161203",
"type": "string"
},
"ExpenseDate": {
"example": "20200202",
"type": "string"
},
"File": {
"properties": {
"Content64Encoded": {
"example": "gjgjJ9FJA829H9HA18B",
"type": "string"
},
"Name": {
"example": "MonDocument.pdf",
"type": "string"
}
},
"type": "object"
},
"InclVAT": {
"example": 1200,
"type": "number"
},
"ProcessingDate": {
"example": "20200203",
"type": "string"
},
"Title": {
"example": "Facture décembre",
"type": "string"
},
"VAT": {
"example": 19.5,
"type": "number"
}
},
"type": "object"
}
],
"required": [
"Title",
"File",
"Name",
"Content64Encoded",
"DocumentId"
]
}
},
"multipart/form-data": {
"schema": {
"allOf": [
{
"properties": {
"Accounting": {
"properties": {
"AccountedOn": {
"example": "20181202",
"type": "string"
},
"Workbook": {
"enum": [
"customer",
"provider",
"bank",
"cashWoucher",
"fiscal",
"insurance",
"social",
"other",
"permanent"
],
"example": "fiscal",
"type": "string"
},
"YearMonth": {
"example": 201902,
"type": "string"
}
},
"type": "object"
},
"Author": {
"example": "Antoine Dupond",
"type": "string"
},
"BeforeVAT": {
"example": 1000,
"type": "number"
},
"Code": {
"example": "COD",
"type": "string"
},
"Comment": {
"example": "my document",
"type": "string"
},
"Date": {
"example": "20161203",
"type": "string"
},
"ExpenseDate": {
"example": "20200202",
"type": "string"
},
"File": {
"format": "binary",
"type": "string"
},
"InclVAT": {
"example": 1200,
"type": "number"
},
"ProcessingDate": {
"example": "20200203",
"type": "string"
},
"Title": {
"example": "Facture décembre",
"type": "string"
},
"VAT": {
"example": 19.5,
"type": "number"
}
},
"type": "object"
}
],
"required": [
"Title",
"File",
"Name"
]
}
}
},
"description": "expense proof to add (either DocumentId, ExpenseDate either (File,Name,Content64Encoded,Title,ExpenseDate) is mandatory)",
"required": true
},
"Folder": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"properties": {
"About": {
"example": "<b> Mon premier dossier </b>",
"type": "string"
},
"ArchivalDate": {
"example": "20160203",
"type": "string"
},
"Home": {
"example": "yes",
"type": "boolean"
},
"Keywords": {
"example": [
"paris",
"comptabilité"
],
"items": {
"type": "string"
},
"type": "array"
},
"Level": {
"enum": [
"confidential",
"regular",
"public"
],
"example": "confidential",
"type": "string"
},
"Name": {
"example": "Dupond",
"type": "string"
}
},
"type": "object"
}
],
"required": [
"Name"
]
}
}
},
"description": "Folder to add",
"required": true
},
"Group": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"properties": {
"EndDate": {
"example": "20160203",
"type": "string"
},
"Name": {
"example": "RH",
"type": "string"
}
},
"type": "object"
}
],
"required": [
"Name",
"LegalName"
]
}
}
},
"description": "Group",
"required": true
},
"HubDocuments": {
"content": {
"application/json": {
"schema": {
"properties": {
"Accounting": {
"properties": {
"AccountedOn": {
"example": "20181202",
"type": "string"
},
"Workbook": {
"enum": [
"customer",
"provider",
"bank",
"cashWoucher",
"fiscal",
"insurance",
"social",
"other",
"permanent"
],
"example": "fiscal",
"type": "string"
},
"YearMonth": {
"example": 201902,
"type": "string"
}
},
"type": "object"
},
"AddContractAllowed": {
"example": true,
"type": "boolean"
},
"Author": {
"example": "Antoine Dupond",
"type": "string"
},
"Comment": {
"example": "my document",
"type": "string"
},
"Date": {
"example": "20161203",
"type": "string"
},
"File": {
"properties": {
"Content64Encoded": {
"example": "gjgjJ9FJA829H9HA18B",
"type": "string"
},
"Name": {
"example": "Mon Document",
"type": "string"
}
},
"type": "object"
},
"Title": {
"example": "Facture décembre",
"type": "string"
}
},
"required": [
"Title",
"File"
],
"type": "object"
}
},
"multipart/form-data": {
"schema": {
"properties": {
"Accounting": {
"properties": {
"AccountedOn": {
"example": "20181202",
"type": "string"
},
"Workbook": {
"enum": [
"customer",
"provider",
"bank",
"cashWoucher",
"fiscal",
"insurance",
"social",
"other",
"permanent"
],
"example": "fiscal",
"type": "string"
},
"YearMonth": {
"example": 201902,
"type": "string"
}
},
"type": "object"
},
"Author": {
"example": "Antoine Dupond",
"type": "string"
},
"Comment": {
"example": "my document",
"type": "string"
},
"Date": {
"example": "20161203",
"type": "string"
},
"File": {
"format": "binary",
"type": "string"
},
"Title": {
"example": "Facture décembre",
"type": "string"
}
},
"required": [
"Title",
"File"
],
"type": "object"
}
}
},
"description": "Document to add",
"required": true
},
"Insurance": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"properties": {
"About": {
"example": "<b> Mon premier dossier </b>",
"type": "string"
},
"Comment": {
"example": "pieces company",
"type": "string"
},
"CustomerNumber": {
"example": "13587449420F",
"type": "string"
},
"Designation": {
"example": "client pièces détachées",
"type": "string"
},
"End": {
"example": "20190101",
"type": "string"
},
"Home": {
"example": "yes",
"type": "boolean"
},
"Keywords": {
"example": [
"paris",
"comptabilité"
],
"items": {
"type": "string"
},
"type": "array"
},
"Level": {
"enum": [
"confidential",
"regular",
"public"
],
"example": "confidential",
"type": "string"
},
"PolicyNumber": {
"example": "1358",
"type": "string"
},
"Start": {
"example": "20180630",
"type": "string"
}
},
"type": "object"
}
]
}
}
},
"description": "Insurance to add (except name, class and archivaldate)",
"required": true
},
"Invoice": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"properties": {
"BeforeVAT": {
"example": 1000,
"type": "number"
},
"Date": {
"example": "20161203",
"type": "string"
},
"DocumentId": {
"example": "PBUFBAUBF1531",
"type": "string"
},
"DueDate": {
"example": 20190130,
"type": "string"
},
"InclVAT": {
"example": 1200,
"type": "number"
},
"InvoiceDate": {
"example": "20200202",
"type": "string"
},
"Number": {
"example": "036459879874",
"type": "string"
},
"PaymentDate": {
"example": 20190131,
"type": "string"
},
"Type": {
"enum": [
"commercial-invoice",
"credit-note",
"amending-invoice",
"self-billing",
"credit-self-billing",
"down-payment-invoice",
"informations-invoice"
],
"example": "commercial-invoice",
"type": "string"
},
"VAT": {
"example": 19.5,
"type": "number"
}
},
"type": "object"
},
{
"properties": {
"Accounting": {
"properties": {
"AccountedOn": {
"example": "20181202",
"type": "string"
},
"Workbook": {
"enum": [
"customer",
"provider",
"bank",
"cashWoucher",
"fiscal",
"insurance",
"social",
"other",
"permanent"
],
"example": "fiscal",
"type": "string"
},
"YearMonth": {
"example": 201902,
"type": "string"
}
},
"type": "object"
},
"Author": {
"example": "Antoine Dupond",
"type": "string"
},
"BeforeVAT": {
"example": 1000,
"type": "number"
},
"Code": {
"example": "COD",
"type": "string"
},
"Comment": {
"example": "my document",
"type": "string"
},
"Date": {
"example": "20161203",
"type": "string"
},
"DueDate": {
"example": 20190130,
"type": "string"
},
"File": {
"properties": {
"Content64Encoded": {
"example": "gjgjJ9FJA829H9HA18B",
"type": "string"
},
"Name": {
"example": "MonDocument.pdf",
"type": "string"
}
},
"type": "object"
},
"InclVAT": {
"example": 1200,
"type": "number"
},
"InvoiceDate": {
"example": "20200202",
"type": "string"
},
"Number": {
"example": "036459879874",
"type": "string"
},
"PaymentDate": {
"example": 20190131,
"type": "string"
},
"Title": {
"example": "Facture décembre",
"type": "string"
},
"Type": {
"enum": [
"commercial-invoice",
"credit-note",
"amending-invoice",
"self-billing",
"credit-self-billing",
"down-payment-invoice",
"informations-invoice"
],
"example": "commercial-invoice",
"type": "string"
},
"VAT": {
"example": 19.5,
"type": "number"
}
},
"type": "object"
}
],
"required": [
"Title",
"File",
"Name",
"Content64Encoded",
"DocumentId"
]
}
},
"multipart/form-data": {
"schema": {
"allOf": [
{
"properties": {
"Accounting": {
"properties": {
"AccountedOn": {
"example": "20181202",
"type": "string"
},
"Workbook": {
"enum": [
"customer",
"provider",
"bank",
"cashWoucher",
"fiscal",
"insurance",
"social",
"other",
"permanent"
],
"example": "fiscal",
"type": "string"
},
"YearMonth": {
"example": 201902,
"type": "string"
}
},
"type": "object"
},
"Author": {
"example": "Antoine Dupond",
"type": "string"
},
"BeforeVAT": {
"example": 1000,
"type": "number"
},
"Code": {
"example": "COD",
"type": "string"
},
"Comment": {
"example": "my document",
"type": "string"
},
"Date": {
"example": "20161203",
"type": "string"
},
"DueDate": {
"example": 20190130,
"type": "string"
},
"File": {
"format": "binary",
"type": "string"
},
"InclVAT": {
"example": 1200,
"type": "number"
},
"InvoiceDate": {
"example": "20200202",
"type": "string"
},
"Number": {
"example": "036459879874",
"type": "string"
},
"PaymentDate": {
"example": 20190131,
"type": "string"
},
"Title": {
"example": "Facture décembre",
"type": "string"
},
"Type": {
"enum": [
"commercial-invoice",
"credit-note",
"amending-invoice",
"self-billing",
"credit-self-billing",
"down-payment-invoice",
"informations-invoice"
],
"example": "commercial-invoice",
"type": "string"
},
"VAT": {
"example": 19.5,
"type": "number"
}
},
"type": "object"
}
],
"required": [
"Title",
"File",
"Name"
]
}
}
},
"description": "Invoice to add (either DocumentId, InvoiceDate either (File,Name,Content64Encoded,Title,InvoiceDate) is mandatory)",
"required": true
},
"Loan": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"properties": {
"About": {
"example": "<b> Mon premier dossier </b>",
"type": "string"
},
"Amount": {
"example": 1000,
"format": "float",
"type": "number"
},
"Category": {
"enum": [
"debt spreading",
"bank loan",
"current account",
"overdraft agreement",
"leasing",
"obligation"
],
"example": "debt spreading",
"type": "string"
},
"Comment": {
"example": "pieces company",
"type": "string"
},
"Designation": {
"example": "emprunt entreprise",
"type": "string"
},
"DueAmount": {
"example": 1000.6,
"format": "float",
"type": "number"
},
"End": {
"example": "20190101",
"type": "string"
},
"Home": {
"example": "yes",
"type": "boolean"
},
"Keywords": {
"example": [
"paris",
"comptabilité"
],
"items": {
"type": "string"
},
"type": "array"
},
"Level": {
"enum": [
"confidential",
"regular",
"public"
],
"example": "confidential",
"type": "string"
},
"MonthsNumber": {
"example": 12,
"type": "number"
},
"Rate": {
"example": 2.5,
"format": "float",
"type": "number"
},
"Start": {
"example": "20180630",
"type": "string"
},
"TotalCost": {
"example": 10200,
"format": "float",
"type": "number"
}
},
"type": "object"
}
]
}
}
},
"description": "Loan to add (except name, class and archivaldate)",
"required": true
},
"Logs": {
"content": {
"application/json": {
"schema": {
"properties": {
"Enabled": {
"example": true,
"type": "boolean"
}
},
"type": "object"
}
}
},
"description": "State of activation of the logs"
},
"MailingDocument": {
"content": {
"application/json": {
"schema": {
"properties": {
"Address": {
"properties": {
"City": {
"example": "Paris",
"type": "string"
},
"Complement": {
"example": "batiment A",
"type": "string"
},
"Country": {
"example": "France",
"type": "string"
},
"Street": {
"example": "2, rue du chateau",
"type": "string"
},
"ZipCode": {
"example": "75001",
"type": "string"
}
},
"type": "object"
},
"Name": {
"example": "Société Dupond",
"type": "string"
}
},
"type": "object"
}
}
},
"description": "document to send by mail",
"required": true
},
"MenuDocuments": {
"content": {
"application/json": {
"schema": {
"properties": {
"Author": {
"example": "Antoine Dupond",
"type": "string"
},
"Comment": {
"example": "my document",
"type": "string"
},
"Date": {
"example": "20161203",
"type": "string"
},
"File": {
"properties": {
"Content64Encoded": {
"example": "gjgjJ9FJA829H9HA18B",
"type": "string"
},
"Name": {
"example": "Mon Document",
"type": "string"
}
},
"type": "object"
},
"Title": {
"example": "Facture décembre",
"type": "string"
}
},
"required": [
"Title",
"File"
],
"type": "object"
}
},
"multipart/form-data": {
"schema": {
"properties": {
"Author": {
"example": "Antoine Dupond",
"type": "string"
},
"Comment": {
"example": "my document",
"type": "string"
},
"Date": {
"example": "20161203",
"type": "string"
},
"File": {
"format": "binary",
"type": "string"
},
"Title": {
"example": "Facture décembre",
"type": "string"
}
},
"required": [
"Title",
"File"
],
"type": "object"
}
}
},
"description": "Document to add",
"required": true
},
"Message": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"properties": {
"Level": {
"enum": [
"confidential",
"regular"
],
"example": "confidential",
"type": "string"
},
"MessageDate": {
"example": "20160203",
"type": "string"
},
"Notify": {
"properties": {
"How": {
"enum": [
"std",
"mail",
"sms"
],
"example": "sms",
"type": "string"
},
"MemberIds": {
"items": {
"example": [
"PJOFJAFJAOJ",
"PJFJAPJF"
],
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"Text": {
"example": "<p> hello world </p>",
"type": "string"
}
},
"type": "object"
}
],
"required": [
"Text"
]
}
}
},
"description": "Message to write (except Author and ModificationAuthor). Text must be Html, tags 'audio','button','input','script','select','textarea','video' are deleted",
"required": true
},
"ModifyAccess": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"properties": {
"Right": {
"enum": [
"write",
"read",
"none"
],
"example": "write",
"type": "string"
}
},
"type": "object"
},
{
"properties": {
"About": {
"example": "<b> Mon premier dossier </b>",
"type": "string"
},
"Home": {
"example": "yes",
"type": "boolean"
},
"Keywords": {
"example": [
"paris",
"comptabilité"
],
"items": {
"type": "string"
},
"type": "array"
},
"Level": {
"enum": [
"confidential",
"regular",
"public"
],
"example": "confidential",
"type": "string"
}
},
"type": "object"
}
]
}
}
},
"description": "Access to modify",
"required": true
},
"ModifyAccountingYear": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"properties": {
"About": {
"example": "<b> Mon premier dossier </b>",
"type": "string"
},
"Comment": {
"example": "ogm of the company",
"type": "string"
},
"End": {
"example": "20181231",
"type": "string"
},
"Home": {
"example": "yes",
"type": "boolean"
},
"Keywords": {
"example": [
"paris",
"comptabilité"
],
"items": {
"type": "string"
},
"type": "array"
},
"Level": {
"enum": [
"confidential",
"regular",
"public"
],
"example": "confidential",
"type": "string"
},
"NetIncome": {
"example": 52634.36,
"type": "number"
},
"NetPosition": {
"example": 14580.36,
"type": "number"
},
"Start": {
"example": "20180101",
"type": "string"
},
"Tax": {
"example": 45698.36,
"type": "number"
},
"TaxableIncome": {
"example": 869523.36,
"type": "number"
},
"Turnover": {
"example": 1025.36,
"type": "number"
}
},
"type": "object"
}
]
}
}
},
"description": "Accounting year to modify (except name, class and archivaldate)",
"required": true
},
"ModifyBank": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"properties": {
"About": {
"example": "<b> Mon premier dossier </b>",
"type": "string"
},
"Comment": {
"example": "pieces company",
"type": "string"
},
"ContractReference": {
"example": "13587449420F",
"type": "string"
},
"Designation": {
"example": "client pièces détachées",
"type": "string"
},
"End": {
"example": "20190101",
"type": "string"
},
"Home": {
"example": "yes",
"type": "boolean"
},
"Keywords": {
"example": [
"paris",
"comptabilité"
],
"items": {
"type": "string"
},
"type": "array"
},
"Level": {
"enum": [
"confidential",
"regular",
"public"
],
"example": "confidential",
"type": "string"
},
"Start": {
"example": "20180630",
"type": "string"
}
},
"type": "object"
}
]
}
}
},
"description": "Bank to modify (except name, class and archivaldate)",
"required": true
},
"ModifyBankStatement": {
"content": {
"application/json": {
"schema": {
"properties": {
"Balance": {
"example": 1352.63,
"format": "number",
"type": "number"
},
"Number": {
"example": "10015848",
"format": "string",
"type": "number"
},
"StatementDate": {
"example": "20160801",
"type": "string"
}
},
"type": "object"
}
}
},
"description": "A bank statement to modify"
},
"ModifyBusinessGroup": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"properties": {
"Name": {
"example": "Client Durand",
"type": "string"
}
},
"type": "object"
}
]
}
}
},
"description": "BusinessGroup to modify",
"required": true
},
"ModifyCFolder": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"properties": {
"About": {
"example": "<b> Mon premier dossier </b>",
"type": "string"
},
"ArchivalDate": {
"example": "20160203",
"type": "string"
},
"Home": {
"example": "yes",
"type": "boolean"
},
"Keywords": {
"example": [
"paris",
"comptabilité"
],
"items": {
"type": "string"
},
"type": "array"
},
"Level": {
"enum": [
"confidential",
"regular",
"public"
],
"example": "confidential",
"type": "string"
},
"Name": {
"example": "Dupond",
"type": "string"
}
},
"type": "object"
}
]
}
}
},
"description": "Folder to modify",
"required": true
},
"ModifyCollectiveDecision": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"properties": {
"About": {
"example": "<b> Mon premier dossier </b>",
"type": "string"
},
"Comment": {
"example": "ogm of the company",
"type": "string"
},
"Date": {
"example": "20180202",
"type": "string"
},
"DividendDistributions": {
"example": 1025.36,
"type": "number"
},
"DividendDistributionsDate": {
"example": "20180203",
"type": "string"
},
"Event": {
"description": "for space type 'company' enums allowed are 'EGM','CGM','OGM','ConstituentAssembly','SolePartner','OtherEvent','Office','ExecutiveCommittee','Consulting','Board','PartnersMeeting' and for space type 'association' enums allowed are 'EGM','CGM','OGM','Other','Office','ExecutiveCommittee'",
"enum": [
"EGM",
"CGM",
"OGM",
"ConstituentAssembly",
"SolePartner",
"OtherEvent",
"Other",
"Office",
"ExecutiveCommittee",
"Consulting",
"Board",
"PartnersMeeting"
],
"example": "EGM",
"type": "string"
},
"Home": {
"example": "yes",
"type": "boolean"
},
"Keywords": {
"example": [
"paris",
"comptabilité"
],
"items": {
"type": "string"
},
"type": "array"
},
"Level": {
"enum": [
"confidential",
"regular",
"public"
],
"example": "confidential",
"type": "string"
}
},
"type": "object"
}
]
}
}
},
"description": "Collective decision to modify (except name, class and archivaldate)",
"required": true
},
"ModifyCompanyEntity": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"properties": {
"ApeCode": {
"example": "420F",
"type": "string"
},
"ArchivalDate": {
"example": "20160203",
"type": "string"
},
"Comment": {
"example": "my brother",
"type": "string"
},
"LegalName": {
"example": "Mon entreprise Dupond",
"type": "string"
},
"LegalStatut": {
"example": "SAS",
"type": "string"
},
"Name": {
"example": "Dupond",
"type": "string"
},
"RegistrationNumber": {
"example": "236542158",
"type": "string"
},
"Type": {
"example": "EPT",
"type": "string"
},
"VatNumber": {
"example": "46546847864",
"type": "string"
}
},
"type": "object"
}
]
}
}
},
"description": "Company entity to modify",
"required": true
},
"ModifyContractualDocument": {
"content": {
"application/json": {
"schema": {
"properties": {
"Amount": {
"example": "1001.36",
"type": "string"
},
"Designation": {
"example": "contrat client",
"type": "string"
},
"Reference": {
"example": "151465AFHIA",
"type": "string"
},
"StartDate": {
"example": "20181128",
"type": "string"
},
"Type": {
"enum": [
"contract",
"engagement-letter",
"amendment",
"purchase-order",
"delivery-order",
"quotation",
"other"
],
"example": "quotation",
"type": "string"
}
},
"type": "object"
}
}
},
"description": "A contractual document to modify"
},
"ModifyCorporateTaxDeclaration": {
"content": {
"application/json": {
"schema": {
"properties": {
"Amount": {
"example": 132.63,
"format": "float",
"type": "number"
},
"DeclarationDate": {
"example": "20160801",
"type": "string"
},
"Order": {
"enum": [
"1st advance",
"2nd advance",
"3rd advance",
"4th advance",
"regularization"
],
"example": "1st advance",
"type": "string"
},
"Rate": {
"example": 10.63,
"format": "float",
"type": "number"
},
"TaxBase": {
"example": 123.36,
"format": "float",
"type": "number"
}
},
"type": "object"
}
}
},
"description": "A Corporate Tax Declaration to modify"
},
"ModifyCustomer": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"properties": {
"About": {
"example": "<b> Mon premier dossier </b>",
"type": "string"
},
"Comment": {
"example": "pieces company",
"type": "string"
},
"CustomerNumber": {
"example": "13587449420F",
"type": "string"
},
"Designation": {
"example": "client pièces détachées",
"type": "string"
},
"End": {
"example": "20190101",
"type": "string"
},
"Home": {
"example": "yes",
"type": "boolean"
},
"KeepOld": {
"example": true,
"type": "boolean"
},
"Keywords": {
"example": [
"paris",
"comptabilité"
],
"items": {
"type": "string"
},
"type": "array"
},
"Level": {
"enum": [
"confidential",
"regular",
"public"
],
"example": "confidential",
"type": "string"
},
"PortfolioId": {
"example": "T1OJFOAZ7449420F",
"type": "string"
},
"SecondaryPortfolioId": {
"example": "T1OJFOAZ7449420F",
"type": "string"
},
"Start": {
"example": "20180630",
"type": "string"
}
},
"type": "object"
}
]
}
}
},
"description": "Customer to modify (except name, class and archivaldate)",
"required": true
},
"ModifyCustomerCont": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"properties": {
"Groups": {
"enum": [
"tax",
"wealth management",
"social",
"social manager",
"purchases",
"sales",
"legal",
"accounting"
],
"example": [
"social",
"legal"
],
"items": {
"type": "string"
},
"type": "array"
},
"IsAdmin": {
"example": false,
"type": "boolean"
},
"Role": {
"enum": [
"collaborator",
"assistant",
"empty"
],
"example": "collaborator",
"type": "string"
}
},
"type": "object"
}
]
}
}
},
"description": "Customer contract to modify",
"required": true
},
"ModifyDocument": {
"content": {
"application/json": {
"schema": {
"properties": {
"Accounting": {
"properties": {
"AccountedOn": {
"example": "20181202",
"type": "string"
},
"Workbook": {
"enum": [
"customer",
"provider",
"bank",
"cashWoucher",
"fiscal",
"insurance",
"social",
"other",
"permanent"
],
"example": "fiscal",
"type": "string"
},
"YearMonth": {
"example": 201802,
"type": "string"
}
},
"type": "object"
},
"Author": {
"example": "Antoine Dupond",
"type": "string"
},
"Code": {
"example": "COD",
"type": "string"
},
"Comment": {
"example": "my document",
"type": "string"
},
"Date": {
"example": "20161203",
"type": "string"
},
"Title": {
"example": "Facture décembre",
"type": "string"
}
},
"type": "object"
}
}
},
"description": "document to modify (except name, class and archivaldate)",
"required": true
},
"ModifyEmailProfile": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"properties": {
"Email": {
"example": "paule@durand.fr",
"type": "string"
}
},
"type": "object"
},
{
"properties": {
"Email": {
"example": "paule@durand.fr",
"type": "string"
},
"EmailCode": {
"example": "1256",
"type": "string"
},
"SMSCode": {
"example": "FAHF",
"type": "string"
}
},
"type": "object"
}
]
}
}
},
"description": "Email to modify",
"required": true
},
"ModifyEmployee": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"properties": {
"About": {
"example": "<b> Mon premier dossier </b>",
"type": "string"
},
"Comment": {
"example": "pieces company",
"type": "string"
},
"ContractType": {
"example": "01",
"type": "string"
},
"EmployeeNumber": {
"example": "13587FAZCD420F",
"type": "string"
},
"End": {
"example": "20190101",
"type": "string"
},
"Function": {
"example": "commercial",
"type": "string"
},
"Home": {
"example": "yes",
"type": "boolean"
},
"Keywords": {
"example": [
"paris",
"comptabilité"
],
"items": {
"type": "string"
},
"type": "array"
},
"Level": {
"enum": [
"confidential",
"regular",
"public"
],
"example": "confidential",
"type": "string"
},
"PostalMail": {
"example": true,
"type": "boolean"
},
"SSNumber": {
"example": "1542012365985215",
"type": "string"
},
"Start": {
"example": "20180630",
"type": "string"
}
},
"type": "object"
}
]
}
}
},
"description": "Employee to modify (except name, class and archivaldate)",
"required": true
},
"ModifyExpenseProof": {
"content": {
"application/json": {
"schema": {
"properties": {
"Account": {
"enum": [
"CAB",
"IKM",
"PRK",
"TXI",
"VOY",
"PTT",
"FHR",
"DIV",
"RES"
],
"example": "CAB",
"type": "string"
},
"ArchivalDate": {
"example": 20211231,
"type": "string"
},
"BeforeVAT": {
"example": 1000,
"type": "number"
},
"ExpenseDate": {
"example": "20200202",
"type": "string"
},
"ExpenseReportId": {
"example": "PFOIAHF874984",
"type": "string"
},
"Provider": {
"example": "G7",
"type": "string"
},
"Reason": {
"example": "taxi",
"type": "string"
},
"Status": {
"enum": [
"R",
"V",
"W"
],
"example": "R",
"type": "string"
},
"VAT": {
"example": 19.5,
"type": "number"
}
},
"type": "object"
}
}
},
"description": "An expense proof to modify"
},
"ModifyExpenseReport": {
"content": {
"application/json": {
"schema": {
"properties": {
"BeforeVAT": {
"example": 1000,
"type": "number"
},
"ExpenseDate": {
"example": "20200202",
"type": "string"
},
"InclVAT": {
"example": 1200,
"type": "number"
},
"ProcessingDate": {
"example": "20200203",
"type": "string"
},
"VAT": {
"example": 19.5,
"type": "number"
}
},
"type": "object"
}
}
},
"description": "An expense report to modify"
},
"ModifyFolder": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"properties": {
"About": {
"example": "<b> Mon premier dossier </b>",
"type": "string"
},
"Home": {
"example": "yes",
"type": "boolean"
},
"Keywords": {
"example": [
"paris",
"comptabilité"
],
"items": {
"type": "string"
},
"type": "array"
},
"Level": {
"enum": [
"confidential",
"regular",
"public"
],
"example": "confidential",
"type": "string"
}
},
"type": "object"
}
]
}
}
},
"description": "Folder to modify (except Name, Class,ModificationDate and ArchivalDate)",
"required": true
},
"ModifyFolderGroup": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"properties": {
"Right": {
"enum": [
"read",
"write"
],
"example": "read",
"type": "string"
}
},
"type": "object"
}
],
"required": [
"Right"
]
}
}
},
"description": "Group to modify to add folder access",
"required": true
},
"ModifyGroup": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"properties": {
"EndDate": {
"example": "20160203",
"type": "string"
},
"Name": {
"example": "RH",
"type": "string"
}
},
"type": "object"
}
]
}
}
},
"description": "Group to modify",
"required": true
},
"ModifyInsurance": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"properties": {
"About": {
"example": "<b> Mon premier dossier </b>",
"type": "string"
},
"Comment": {
"example": "pieces company",
"type": "string"
},
"CustomerNumber": {
"example": "13587449420F",
"type": "string"
},
"Designation": {
"example": "client pièces détachées",
"type": "string"
},
"End": {
"example": "20190101",
"type": "string"
},
"Home": {
"example": "yes",
"type": "boolean"
},
"Keywords": {
"example": [
"paris",
"comptabilité"
],
"items": {
"type": "string"
},
"type": "array"
},
"Level": {
"enum": [
"confidential",
"regular",
"public"
],
"example": "confidential",
"type": "string"
},
"PolicyNumber": {
"example": "1358",
"type": "string"
},
"Start": {
"example": "20180630",
"type": "string"
}
},
"type": "object"
}
]
}
}
},
"description": "Insurance to modify (except name, class and archivaldate)",
"required": true
},
"ModifyInvoice": {
"content": {
"application/json": {
"schema": {
"properties": {
"BeforeVAT": {
"example": 1000,
"type": "number"
},
"DueDate": {
"example": 20190130,
"type": "string"
},
"InclVAT": {
"example": 1200,
"type": "number"
},
"InvoiceDate": {
"example": "20200202",
"type": "string"
},
"Number": {
"example": "036459879874",
"type": "string"
},
"PaymentDate": {
"example": 20190131,
"type": "string"
},
"Type": {
"enum": [
"commercial-invoice",
"credit-note",
"amending-invoice",
"self-billing",
"credit-self-billing",
"down-payment-invoice",
"informations-invoice"
],
"example": "commercial-invoice",
"type": "string"
},
"VAT": {
"example": 19.5,
"type": "number"
}
},
"type": "object"
}
}
},
"description": "A invoice to modify"
},
"ModifyLegal": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Legal"
}
]
}
}
},
"description": "Legal information to modify",
"required": true
},
"ModifyLoan": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"properties": {
"About": {
"example": "<b> Mon premier dossier </b>",
"type": "string"
},
"Amount": {
"example": 1000,
"format": "float",
"type": "number"
},
"Category": {
"enum": [
"debt spreading",
"bank loan",
"current account",
"overdraft agreement",
"leasing",
"obligation"
],
"example": "debt spreading",
"type": "string"
},
"Comment": {
"example": "pieces company",
"type": "string"
},
"Designation": {
"example": "emprunt entreprise",
"type": "string"
},
"DueAmount": {
"example": 1000.6,
"format": "float",
"type": "number"
},
"End": {
"example": "20190101",
"type": "string"
},
"Home": {
"example": "yes",
"type": "boolean"
},
"Keywords": {
"example": [
"paris",
"comptabilité"
],
"items": {
"type": "string"
},
"type": "array"
},
"Level": {
"enum": [
"confidential",
"regular",
"public"
],
"example": "confidential",
"type": "string"
},
"MonthsNumber": {
"example": 12,
"type": "number"
},
"Rate": {
"example": 2.5,
"format": "float",
"type": "number"
},
"Start": {
"example": "20180630",
"type": "string"
},
"TotalCost": {
"example": 10200,
"format": "float",
"type": "number"
}
},
"type": "object"
}
]
}
}
},
"description": "Loan to modify (except name, class and archivaldate)",
"required": true
},
"ModifyMessage": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"properties": {
"Level": {
"enum": [
"confidential",
"regular"
],
"example": "confidential",
"type": "string"
},
"MessageDate": {
"example": "20160203",
"type": "string"
},
"Notify": {
"properties": {
"How": {
"enum": [
"std",
"mail",
"sms"
],
"example": "sms",
"type": "string"
},
"MemberIds": {
"items": {
"example": [
"PJOFJAFJAOJ",
"PJFJAPJF"
],
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"Text": {
"example": "<p> hello world </p>",
"type": "string"
}
},
"type": "object"
}
]
}
}
},
"description": "Message to modify (except Author and ModificationAuthor)",
"required": true
},
"ModifyMobileProfile": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"properties": {
"Mobile": {
"example": 33606060606,
"type": "string"
}
},
"type": "object"
},
{
"properties": {
"Mobile": {
"example": 33606060606,
"type": "string"
},
"Password": {
"example": "azerty",
"type": "string"
},
"SMSCode": {
"example": "FAHF",
"type": "string"
}
},
"type": "object"
}
]
}
}
},
"description": "Mobile to modify",
"required": true
},
"ModifyOtherTax": {
"content": {
"application/json": {
"schema": {
"properties": {
"Amount": {
"example": 132.63,
"format": "float",
"type": "number"
},
"DeclarationDate": {
"example": "20160801",
"type": "string"
},
"Reference": {
"example": "décla CFE",
"type": "string"
}
},
"type": "object"
}
}
},
"description": "A Tax Declaration to modify"
},
"ModifyPassword": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"properties": {
"Comment": {
"example": "mon compte google",
"type": "string"
},
"Designation": {
"example": "compte google",
"type": "string"
},
"Ident": {
"example": "test",
"type": "string"
},
"Link": {
"example": "www.google.fr",
"type": "string"
},
"Password": {
"example": "azerty",
"type": "string"
}
},
"type": "object"
}
]
}
}
},
"description": "Password to modify",
"required": true
},
"ModifyPayroll": {
"content": {
"application/json": {
"schema": {
"properties": {
"Begin": {
"example": "20160801",
"type": "string"
},
"EmployeeContributions": {
"example": 1352.63,
"format": "float",
"type": "number"
},
"EmployerContributions": {
"example": 132.63,
"format": "float",
"type": "number"
},
"End": {
"example": "20160831",
"type": "string"
},
"NetAmount": {
"example": 1005.63,
"format": "float",
"type": "number"
},
"TotalGrossAmount": {
"example": 1548.63,
"format": "float",
"type": "number"
}
},
"type": "object"
}
}
},
"description": "A payroll to modify"
},
"ModifyPayslip": {
"content": {
"application/json": {
"schema": {
"properties": {
"Begin": {
"example": "20160801",
"type": "string"
},
"EmployeeContributions": {
"example": 2000.5,
"format": "float",
"type": "number"
},
"EmployerContributions": {
"example": 400.5,
"format": "float",
"type": "number"
},
"End": {
"example": "20160831",
"type": "string"
},
"FixedGrossAmount": {
"example": 1352.63,
"format": "float",
"type": "number"
},
"NetAmount": {
"example": 1005.63,
"format": "float",
"type": "number"
},
"TotalGrossAmount": {
"example": 1548.63,
"format": "float",
"type": "number"
},
"Vacation": {
"example": 20.5,
"format": "float",
"type": "number"
},
"VariableGrossAmount": {
"example": 132.63,
"format": "float",
"type": "number"
}
},
"type": "object"
}
}
},
"description": "A payslip to modify"
},
"ModifyPerson": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"properties": {
"Address": {
"properties": {
"City": {
"example": "Paris",
"type": "string"
},
"Complement": {
"example": "batiment A",
"type": "string"
},
"Country": {
"example": "France",
"type": "string"
},
"Street": {
"example": "2, rue du chateau",
"type": "string"
},
"ZipCode": {
"example": "75001",
"type": "string"
}
},
"type": "object"
},
"ArchivalDate": {
"example": "20160203",
"type": "string"
},
"Birth": {
"properties": {
"Date": {
"example": 19671231,
"type": "integer"
},
"Place": {
"example": "Lille",
"type": "string"
}
},
"type": "object"
},
"Comment": {
"example": "my brother",
"type": "string"
},
"Email": {
"example": "bertrand@monmail.com",
"type": "string"
},
"FirstName": {
"example": "Bertrand",
"type": "string"
},
"Mobile": {
"example": "+33606060606",
"type": "string"
},
"Name": {
"example": "Dupond",
"type": "string"
},
"Sex": {
"enum": [
"male",
"female"
],
"example": "male",
"type": "string"
}
},
"type": "object"
}
]
}
}
},
"description": "Person to modify",
"required": true
},
"ModifyPlayer": {
"content": {
"application/json": {
"schema": {
"properties": {
"ClientManagement": {
"enum": [
"no",
"manager",
"adn"
],
"type": "string"
},
"IsAdmin": {
"example": true,
"type": "boolean"
},
"Player": {
"enum": [
"guest",
"owner",
"manager",
"assistant",
"collaborator"
],
"example": "guest",
"type": "string"
},
"PlayerEnd": {
"example": "20210203",
"type": "string"
}
},
"required": [
"Player"
],
"type": "object"
}
}
},
"description": "Person to modify",
"required": true
},
"ModifyPortfolio": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"properties": {
"Apply": {
"example": true,
"type": "boolean"
},
"Groups": {
"enum": [
"tax",
"wealth management",
"social",
"social manager",
"purchases",
"sales",
"legal",
"accounting"
],
"example": [
"social",
"legal"
],
"items": {
"type": "string"
},
"type": "array"
},
"IsAdmin": {
"example": false,
"type": "boolean"
},
"Role": {
"enum": [
"collaborator",
"assistant",
"empty"
],
"example": "collaborator",
"type": "string"
}
},
"type": "object"
}
]
}
}
},
"description": "Portfolio to modify",
"required": true
},
"ModifyProfessionalVehicle": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"properties": {
"About": {
"example": "<b> Mon premier dossier </b>",
"type": "string"
},
"Brand": {
"example": "Renault",
"type": "string"
},
"Comment": {
"example": "Peugeot Lyon",
"type": "string"
},
"CompanyTax": {
"example": true,
"type": "boolean"
},
"DateIn": {
"example": "20201802",
"type": "string"
},
"DateOut": {
"example": "20201802",
"type": "string"
},
"Designation": {
"example": "peugeot siège",
"type": "string"
},
"Home": {
"example": "yes",
"type": "boolean"
},
"Keywords": {
"example": [
"paris",
"clio"
],
"items": {
"type": "string"
},
"type": "array"
},
"Level": {
"enum": [
"confidential",
"regular",
"public"
],
"example": "confidential",
"type": "string"
},
"Model": {
"example": "Clio",
"type": "string"
},
"RegistrationDate": {
"example": "20181231",
"type": "string"
},
"RegistrationNumber": {
"example": "AA001AA",
"type": "string"
},
"Type": {
"example": "car",
"type": "string"
},
"Value": {
"example": 1500.23,
"type": "number"
}
},
"type": "object"
}
]
}
}
},
"description": "Professional vehicle to modify (except name, class and archivaldate)",
"required": true
},
"ModifyProfile": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"properties": {
"Birth": {
"properties": {
"City": {
"example": "Créteil",
"type": "string"
},
"Country": {
"example": "FR",
"type": "string"
},
"Date": {
"example": "19800101",
"type": "string"
},
"ZipCode": {
"example": "94000",
"type": "string"
}
},
"type": "object"
},
"BirthName": {
"example": "Dupond",
"type": "string"
},
"Email": {
"example": "paule@durand.fr",
"type": "string"
},
"FirstName": {
"example": "Paule",
"type": "string"
},
"IDFile": {
"properties": {
"Content64Encoded": {
"example": "PIHFPAH20FBIA=",
"type": "string"
},
"Name": {
"example": "id.png",
"type": "string"
}
},
"type": "object"
},
"Name": {
"example": "Durand",
"type": "string"
},
"Sex": {
"enum": [
"male",
"female"
],
"type": "string"
}
},
"type": "object"
}
]
}
},
"multipart/form-data": {
"schema": {
"allOf": [
{
"properties": {
"Birth": {
"properties": {
"City": {
"example": "Créteil",
"type": "string"
},
"Country": {
"example": "France",
"type": "string"
},
"Date": {
"example": "19800101",
"type": "string"
},
"ZipCode": {
"example": "94000",
"type": "string"
}
},
"type": "object"
},
"BirthName": {
"example": "Dupond",
"type": "string"
},
"Email": {
"example": "paule@durand.fr",
"type": "string"
},
"FirstName": {
"example": "Paule",
"type": "string"
},
"IDFile": {
"format": "binary",
"type": "string"
},
"Name": {
"example": "Durand",
"type": "string"
},
"Sex": {
"enum": [
"male",
"female"
],
"type": "string"
}
},
"type": "object"
}
]
}
}
},
"description": "Profile to add",
"required": true
},
"ModifyProvider": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"properties": {
"About": {
"example": "<b> Mon premier dossier </b>",
"type": "string"
},
"Comment": {
"example": "pieces company",
"type": "string"
},
"Designation": {
"example": "client pièces détachées",
"type": "string"
},
"End": {
"example": "20190101",
"type": "string"
},
"Home": {
"example": "yes",
"type": "boolean"
},
"Keywords": {
"example": [
"paris",
"comptabilité"
],
"items": {
"type": "string"
},
"type": "array"
},
"Level": {
"enum": [
"confidential",
"regular",
"public"
],
"example": "confidential",
"type": "string"
},
"ProviderNumber": {
"example": "13587449420F",
"type": "string"
},
"Start": {
"example": "20180630",
"type": "string"
}
},
"type": "object"
}
]
}
}
},
"description": "Provider to modify (except name, class and archivaldate)",
"required": true
},
"ModifyReqStatus": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"properties": {
"Status": {
"enum": [
"waiting",
"ended",
"validated"
],
"example": "waiting",
"type": "string"
}
},
"type": "object"
}
]
}
}
},
"description": "Status to modify",
"required": true
},
"ModifySocialContract": {
"content": {
"application/json": {
"schema": {
"properties": {
"ContractDate": {
"example": "20190202",
"type": "string"
},
"ContractDuration": {
"example": "6 mois",
"type": "string"
},
"ContractualChange": {
"example": "augmentation",
"type": "string"
},
"Position": {
"example": "cadre",
"type": "string"
},
"WageDevelopments": {
"example": 1548.63,
"format": "float",
"type": "number"
}
},
"type": "object"
}
}
},
"description": "A social contract to modify"
},
"ModifySocialDeclaration": {
"content": {
"application/json": {
"schema": {
"properties": {
"Amount": {
"example": 132.63,
"format": "float",
"type": "number"
},
"DeclarationDate": {
"example": "20160801",
"type": "string"
}
},
"type": "object"
}
}
},
"description": "A Social Declaration to modify"
},
"ModifySocialRegime": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"properties": {
"About": {
"example": "<b> Mon premier dossier </b>",
"type": "string"
},
"Comment": {
"example": "pieces company",
"type": "string"
},
"Designation": {
"example": "client pièces détachées",
"type": "string"
},
"End": {
"example": "20190101",
"type": "string"
},
"Home": {
"example": "yes",
"type": "boolean"
},
"Keywords": {
"example": [
"paris",
"comptabilité"
],
"items": {
"type": "string"
},
"type": "array"
},
"Level": {
"enum": [
"confidential",
"regular",
"public"
],
"example": "confidential",
"type": "string"
},
"Periodicity": {
"enum": [
"monthly",
"quarterly",
"half-yearly",
"annual",
"null"
],
"example": "monthly",
"type": "string"
},
"Start": {
"example": "20180630",
"type": "string"
},
"Type": {
"enum": [
"mandatory",
"optional",
"null"
],
"example": "mandatory",
"type": "string"
}
},
"type": "object"
}
]
}
}
},
"description": "Social Regime to modify (except name, class and archivaldate)",
"required": true
},
"ModifySpace": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"properties": {
"Logo": {
"properties": {
"Content64Encoded": {
"example": "NIFHAZFA07GA=",
"type": "string"
},
"Name": {
"example": "toto.png",
"type": "string"
}
},
"type": "object"
},
"Name": {
"example": "Mon Entreprise",
"type": "string"
},
"TemplateSpaceId": {
"example": "PHAOH8486",
"type": "string"
}
},
"type": "object"
}
]
}
}
},
"description": "Space to modify (except private)",
"required": true
},
"ModifyTaxContract": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"properties": {
"About": {
"example": "<b> Mon premier dossier </b>",
"type": "string"
},
"ArchivalDate": {
"example": "20160203",
"type": "string"
},
"Comment": {
"example": "pieces company",
"type": "string"
},
"Designation": {
"example": "taxes foncières",
"type": "string"
},
"End": {
"example": "20190101",
"type": "string"
},
"Home": {
"example": "yes",
"type": "boolean"
},
"Keywords": {
"example": [
"paris",
"comptabilité"
],
"items": {
"type": "string"
},
"type": "array"
},
"Level": {
"enum": [
"confidential",
"regular",
"public"
],
"example": "confidential",
"type": "string"
},
"Start": {
"example": "20180630",
"type": "string"
}
},
"type": "object"
}
]
}
}
},
"description": "Tax contract to modify (except name, class and archivaldate)",
"required": true
},
"ModifyVATDeclaration": {
"content": {
"application/json": {
"schema": {
"properties": {
"Begin": {
"example": "20160801",
"type": "string"
},
"CollectedVAT": {
"example": 1548.63,
"format": "float",
"type": "number"
},
"CreditVAT": {
"example": 400.5,
"format": "float",
"type": "number"
},
"DeductibleVAT": {
"example": 20.5,
"format": "float",
"type": "number"
},
"End": {
"example": "20160831",
"type": "string"
},
"ExemptTurnover": {
"example": 132.63,
"format": "float",
"type": "number"
},
"Number": {
"example": "153126",
"type": "string"
},
"PayableVAT": {
"example": 2000.5,
"format": "float",
"type": "number"
},
"TaxableTurnover": {
"example": 1352.63,
"format": "float",
"type": "number"
}
},
"type": "object"
}
}
},
"description": "A VAT Declaration to modify"
},
"OtherTax": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"properties": {
"Amount": {
"example": 132.63,
"format": "float",
"type": "number"
},
"DeclarationDate": {
"example": "20160801",
"type": "string"
},
"DocumentId": {
"example": "PBUFBAUBF1531",
"type": "string"
},
"Reference": {
"example": "décla CFE",
"type": "string"
}
},
"type": "object"
},
{
"properties": {
"Accounting": {
"properties": {
"AccountedOn": {
"example": "20181202",
"type": "string"
},
"Workbook": {
"enum": [
"customer",
"provider",
"bank",
"cashWoucher",
"fiscal",
"insurance",
"social",
"other",
"permanent"
],
"example": "fiscal",
"type": "string"
},
"YearMonth": {
"example": 201902,
"type": "string"
}
},
"type": "object"
},
"Amount": {
"example": 132.63,
"format": "float",
"type": "number"
},
"Author": {
"example": "Antoine Dupond",
"type": "string"
},
"Code": {
"example": "COD",
"type": "string"
},
"Comment": {
"example": "my document",
"type": "string"
},
"Date": {
"example": "20161203",
"type": "string"
},
"DeclarationDate": {
"example": "20160801",
"type": "string"
},
"File": {
"properties": {
"Content64Encoded": {
"example": "gjgjJ9FJA829H9HA18B",
"type": "string"
},
"Name": {
"example": "MonDocument.pdf",
"type": "string"
}
},
"type": "object"
},
"Reference": {
"example": "décla CFE",
"type": "string"
},
"Title": {
"example": "Facture décembre",
"type": "string"
}
},
"type": "object"
}
],
"required": [
"Title",
"File",
"Name",
"Content64Encoded",
"DocumentId"
]
}
},
"multipart/form-data": {
"schema": {
"allOf": [
{
"properties": {
"Accounting": {
"properties": {
"AccountedOn": {
"example": "20181202",
"type": "string"
},
"Workbook": {
"enum": [
"customer",
"provider",
"bank",
"cashWoucher",
"fiscal",
"insurance",
"social",
"other",
"permanent"
],
"example": "fiscal",
"type": "string"
},
"YearMonth": {
"example": 201902,
"type": "string"
}
},
"type": "object"
},
"Amount": {
"example": 132.63,
"format": "float",
"type": "number"
},
"Author": {
"example": "Antoine Dupond",
"type": "string"
},
"Code": {
"example": "COD",
"type": "string"
},
"Comment": {
"example": "my document",
"type": "string"
},
"Date": {
"example": "20161203",
"type": "string"
},
"DeclarationDate": {
"example": "20160801",
"type": "string"
},
"File": {
"format": "binary",
"type": "string"
},
"Reference": {
"example": "décla CFE",
"type": "string"
},
"Title": {
"example": "Facture décembre",
"type": "string"
}
},
"type": "object"
}
],
"required": [
"Title",
"File",
"Name"
]
}
}
},
"description": "Other tax declaration to add (either (Reference,DocumentId) either (File,Name,Content64Encoded,Title,Reference) is mandatory)",
"required": true
},
"PSpace": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"properties": {
"Groups": {
"enum": [
"tax",
"wealth management",
"legal"
],
"example": [
"tax",
"legal"
],
"items": {
"type": "string"
},
"type": "array"
},
"Role": {
"enum": [
"collaborator",
"manager"
],
"example": "collaborator",
"type": "string"
}
},
"type": "object"
}
],
"required": [
"Role"
]
}
}
},
"description": "role and groups to apply to the managed private space",
"required": true
},
"Password": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"properties": {
"Comment": {
"example": "mon compte google",
"type": "string"
},
"Designation": {
"example": "compte google",
"type": "string"
},
"Ident": {
"example": "test",
"type": "string"
},
"Link": {
"example": "www.google.fr",
"type": "string"
},
"Password": {
"example": "azerty",
"type": "string"
}
},
"type": "object"
}
],
"required": [
"Designation"
]
}
}
},
"description": "Password to write",
"required": true
},
"PaySlip": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"properties": {
"Begin": {
"example": "20160801",
"type": "string"
},
"DocumentId": {
"example": "PBUFBAUBF1531",
"type": "string"
},
"EmployeeContributions": {
"example": 2000.5,
"format": "float",
"type": "number"
},
"EmployerContributions": {
"example": 400.5,
"format": "float",
"type": "number"
},
"End": {
"example": "20160831",
"type": "string"
},
"FixedGrossAmount": {
"example": 1352.63,
"format": "float",
"type": "number"
},
"NetAmount": {
"example": 1005.63,
"format": "float",
"type": "number"
},
"TotalGrossAmount": {
"example": 1548.63,
"format": "float",
"type": "number"
},
"Vacation": {
"example": 20.5,
"format": "float",
"type": "number"
},
"VariableGrossAmount": {
"example": 132.63,
"format": "float",
"type": "number"
}
},
"type": "object"
},
{
"properties": {
"Accounting": {
"properties": {
"AccountedOn": {
"example": "20181202",
"type": "string"
},
"Workbook": {
"enum": [
"customer",
"provider",
"bank",
"cashWoucher",
"fiscal",
"insurance",
"social",
"other",
"permanent"
],
"example": "fiscal",
"type": "string"
},
"YearMonth": {
"example": 201902,
"type": "string"
}
},
"type": "object"
},
"Author": {
"example": "Antoine Dupond",
"type": "string"
},
"Begin": {
"example": "20160801",
"type": "string"
},
"Code": {
"example": "COD",
"type": "string"
},
"Comment": {
"example": "my document",
"type": "string"
},
"Date": {
"example": "20161203",
"type": "string"
},
"EmployeeContributions": {
"example": 2000.5,
"format": "float",
"type": "number"
},
"EmployerContributions": {
"example": 400.5,
"format": "float",
"type": "number"
},
"End": {
"example": "20160831",
"type": "string"
},
"File": {
"properties": {
"Content64Encoded": {
"example": "gjgjJ9FJA829H9HA18B",
"type": "string"
},
"Name": {
"example": "MonDocument.pdf",
"type": "string"
}
},
"type": "object"
},
"FixedGrossAmount": {
"example": 1352.63,
"format": "float",
"type": "number"
},
"NetAmount": {
"example": 1005.63,
"format": "float",
"type": "number"
},
"Title": {
"example": "Facture décembre",
"type": "string"
},
"TotalGrossAmount": {
"example": 1548.63,
"format": "float",
"type": "number"
},
"Vacation": {
"example": 20.5,
"format": "float",
"type": "number"
},
"VariableGrossAmount": {
"example": 132.63,
"format": "float",
"type": "number"
}
},
"type": "object"
}
],
"required": [
"Title",
"File",
"Name",
"Content64Encoded",
"DocumentId"
]
}
},
"multipart/form-data": {
"schema": {
"allOf": [
{
"properties": {
"Accounting": {
"properties": {
"AccountedOn": {
"example": "20181202",
"type": "string"
},
"Workbook": {
"enum": [
"customer",
"provider",
"bank",
"cashWoucher",
"fiscal",
"insurance",
"social",
"other",
"permanent"
],
"example": "fiscal",
"type": "string"
},
"YearMonth": {
"example": 201902,
"type": "string"
}
},
"type": "object"
},
"Author": {
"example": "Antoine Dupond",
"type": "string"
},
"Begin": {
"example": "20160801",
"type": "string"
},
"Code": {
"example": "COD",
"type": "string"
},
"Comment": {
"example": "my document",
"type": "string"
},
"Date": {
"example": "20161203",
"type": "string"
},
"EmployeeContributions": {
"example": 2000.5,
"format": "float",
"type": "number"
},
"EmployerContributions": {
"example": 400.5,
"format": "float",
"type": "number"
},
"End": {
"example": "20160831",
"type": "string"
},
"File": {
"format": "binary",
"type": "string"
},
"FixedGrossAmount": {
"example": 1352.63,
"format": "float",
"type": "number"
},
"NetAmount": {
"example": 1005.63,
"format": "float",
"type": "number"
},
"Title": {
"example": "Facture décembre",
"type": "string"
},
"TotalGrossAmount": {
"example": 1548.63,
"format": "float",
"type": "number"
},
"Vacation": {
"example": 20.5,
"format": "float",
"type": "number"
},
"VariableGrossAmount": {
"example": 132.63,
"format": "float",
"type": "number"
}
},
"type": "object"
}
],
"required": [
"Title",
"File",
"Name"
]
}
}
},
"description": "Payslip to add (either DocumentId either (File,Name,Content64Encoded,Title) is mandatory)",
"required": true
},
"PaySlips": {
"content": {
"application/json": {
"schema": {
"items": {
"allOf": [
{
"$ref": "#/components/schemas/PaySlip"
},
{
"properties": {
"File": {
"properties": {
"Content64Encoded": {
"example": "gjgjJ9FJA829H9HA18B",
"type": "string"
},
"Name": {
"example": "Ma fiche de salaire",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
]
},
"required": [
"Title",
"File"
],
"type": "array"
}
},
"multipart/form-data": {
"schema": {
"items": {
"allOf": [
{
"$ref": "#/components/schemas/PaySlip"
},
{
"properties": {
"File": {
"format": "binary",
"type": "string"
}
},
"type": "object"
}
]
},
"required": [
"Title",
"File"
],
"type": "array"
}
}
},
"description": "Payslips to add",
"required": true
},
"Payroll": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"properties": {
"Begin": {
"example": "20160801",
"type": "string"
},
"DocumentId": {
"example": "PBUFBAUBF1531",
"type": "string"
},
"EmployeeContributions": {
"example": 1352.63,
"format": "float",
"type": "number"
},
"EmployerContributions": {
"example": 132.63,
"format": "float",
"type": "number"
},
"End": {
"example": "20160831",
"type": "string"
},
"NetAmount": {
"example": 1005.63,
"format": "float",
"type": "number"
},
"TotalGrossAmount": {
"example": 1548.63,
"format": "float",
"type": "number"
}
},
"type": "object"
},
{
"properties": {
"Accounting": {
"properties": {
"AccountedOn": {
"example": "20181202",
"type": "string"
},
"Workbook": {
"enum": [
"customer",
"provider",
"bank",
"cashWoucher",
"fiscal",
"insurance",
"social",
"other",
"permanent"
],
"example": "fiscal",
"type": "string"
},
"YearMonth": {
"example": 201902,
"type": "string"
}
},
"type": "object"
},
"Author": {
"example": "Antoine Dupond",
"type": "string"
},
"Begin": {
"example": "20160801",
"type": "string"
},
"Code": {
"example": "COD",
"type": "string"
},
"Comment": {
"example": "my document",
"type": "string"
},
"Date": {
"example": "20161203",
"type": "string"
},
"EmployeeContributions": {
"example": 1352.63,
"format": "float",
"type": "number"
},
"EmployerContributions": {
"example": 132.63,
"format": "float",
"type": "number"
},
"End": {
"example": "20160831",
"type": "string"
},
"File": {
"properties": {
"Content64Encoded": {
"example": "gjgjJ9FJA829H9HA18B",
"type": "string"
},
"Name": {
"example": "MonDocument.pdf",
"type": "string"
}
},
"type": "object"
},
"NetAmount": {
"example": 1005.63,
"format": "float",
"type": "number"
},
"Title": {
"example": "Facture décembre",
"type": "string"
},
"TotalGrossAmount": {
"example": 1548.63,
"format": "float",
"type": "number"
}
},
"type": "object"
}
],
"required": [
"Title",
"File",
"Name",
"Content64Encoded",
"DocumentId"
]
}
},
"multipart/form-data": {
"schema": {
"allOf": [
{
"properties": {
"Accounting": {
"properties": {
"AccountedOn": {
"example": "20181202",
"type": "string"
},
"Workbook": {
"enum": [
"customer",
"provider",
"bank",
"cashWoucher",
"fiscal",
"insurance",
"social",
"other",
"permanent"
],
"example": "fiscal",
"type": "string"
},
"YearMonth": {
"example": 201902,
"type": "string"
}
},
"type": "object"
},
"Author": {
"example": "Antoine Dupond",
"type": "string"
},
"Begin": {
"example": "20160801",
"type": "string"
},
"Code": {
"example": "COD",
"type": "string"
},
"Comment": {
"example": "my document",
"type": "string"
},
"Date": {
"example": "20161203",
"type": "string"
},
"EmployeeContributions": {
"example": 1352.63,
"format": "float",
"type": "number"
},
"EmployerContributions": {
"example": 132.63,
"format": "float",
"type": "number"
},
"End": {
"example": "20160831",
"type": "string"
},
"File": {
"format": "binary",
"type": "string"
},
"NetAmount": {
"example": 1005.63,
"format": "float",
"type": "number"
},
"Title": {
"example": "Facture décembre",
"type": "string"
},
"TotalGrossAmount": {
"example": 1548.63,
"format": "float",
"type": "number"
}
},
"type": "object"
}
],
"required": [
"Title",
"File",
"Name"
]
}
}
},
"description": "Payroll to add or to generate",
"required": true
},
"Person": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"properties": {
"Address": {
"properties": {
"City": {
"example": "Paris",
"type": "string"
},
"Complement": {
"example": "batiment A",
"type": "string"
},
"Country": {
"example": "France",
"type": "string"
},
"Street": {
"example": "2, rue du chateau",
"type": "string"
},
"ZipCode": {
"example": "75001",
"type": "string"
}
},
"type": "object"
},
"ArchivalDate": {
"example": "20160203",
"type": "string"
},
"Birth": {
"properties": {
"Date": {
"example": 19671231,
"type": "integer"
},
"Place": {
"example": "Lille",
"type": "string"
}
},
"type": "object"
},
"Comment": {
"example": "my brother",
"type": "string"
},
"Email": {
"example": "bertrand@monmail.com",
"type": "string"
},
"FirstName": {
"example": "Bertrand",
"type": "string"
},
"Mobile": {
"example": "+33606060606",
"type": "string"
},
"Name": {
"example": "Dupond",
"type": "string"
},
"Sex": {
"enum": [
"male",
"female"
],
"example": "male",
"type": "string"
}
},
"type": "object"
}
],
"required": [
"Name",
"FirstName",
"Sex"
]
}
}
},
"description": "Person to add",
"required": true
},
"Portfolio": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"properties": {
"About": {
"example": "<b> Mon premier dossier </b>",
"type": "string"
},
"ArchivalDate": {
"example": "20160203",
"type": "string"
},
"Designation": {
"example": "My Portfolio",
"type": "string"
},
"Home": {
"example": "yes",
"type": "boolean"
},
"Keywords": {
"example": [
"paris",
"comptabilité"
],
"items": {
"type": "string"
},
"type": "array"
},
"Level": {
"enum": [
"confidential",
"regular",
"public"
],
"example": "confidential",
"type": "string"
},
"Name": {
"example": "Dupond",
"type": "string"
}
},
"type": "object"
}
]
}
}
},
"description": "Portfolio to add (except Class and Name)",
"required": false
},
"ProfessionalVehicle": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"properties": {
"About": {
"example": "<b> Mon premier dossier </b>",
"type": "string"
},
"Brand": {
"example": "Renault",
"type": "string"
},
"Comment": {
"example": "Peugeot Lyon",
"type": "string"
},
"CompanyTax": {
"example": true,
"type": "boolean"
},
"DateIn": {
"example": "20201802",
"type": "string"
},
"DateOut": {
"example": "20201802",
"type": "string"
},
"Designation": {
"example": "peugeot siège",
"type": "string"
},
"Home": {
"example": "yes",
"type": "boolean"
},
"Keywords": {
"example": [
"paris",
"clio"
],
"items": {
"type": "string"
},
"type": "array"
},
"Level": {
"enum": [
"confidential",
"regular",
"public"
],
"example": "confidential",
"type": "string"
},
"Model": {
"example": "Clio",
"type": "string"
},
"RegistrationDate": {
"example": "20181231",
"type": "string"
},
"RegistrationNumber": {
"example": "AA001AA",
"type": "string"
},
"Type": {
"example": "car",
"type": "string"
},
"Value": {
"example": 1500.23,
"type": "number"
}
},
"type": "object"
}
],
"required": [
"Designation"
]
}
}
},
"description": "Professional vehicle to add",
"required": true
},
"Profile": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"properties": {
"Birth": {
"properties": {
"City": {
"example": "Créteil",
"type": "string"
},
"Country": {
"example": "FR",
"type": "string"
},
"Date": {
"example": "19800101",
"type": "string"
},
"ZipCode": {
"example": "94000",
"type": "string"
}
},
"type": "object"
},
"BirthName": {
"example": "Dupond",
"type": "string"
},
"Email": {
"example": "paule@durand.fr",
"type": "string"
},
"FirstName": {
"example": "Paule",
"type": "string"
},
"IDFile": {
"properties": {
"Content64Encoded": {
"example": "PIHFPAH20FBIA=",
"type": "string"
},
"Name": {
"example": "id.png",
"type": "string"
}
},
"type": "object"
},
"Name": {
"example": "Durand",
"type": "string"
},
"Sex": {
"enum": [
"male",
"female"
],
"type": "string"
}
},
"type": "object"
}
],
"required": [
"Name",
"FirstName",
"Email",
"Sex",
"File",
"BirthName",
"Birth"
]
}
},
"multipart/form-data": {
"schema": {
"allOf": [
{
"properties": {
"Birth": {
"properties": {
"City": {
"example": "Créteil",
"type": "string"
},
"Country": {
"example": "France",
"type": "string"
},
"Date": {
"example": "19800101",
"type": "string"
},
"ZipCode": {
"example": "94000",
"type": "string"
}
},
"type": "object"
},
"BirthName": {
"example": "Dupond",
"type": "string"
},
"Email": {
"example": "paule@durand.fr",
"type": "string"
},
"FirstName": {
"example": "Paule",
"type": "string"
},
"IDFile": {
"format": "binary",
"type": "string"
},
"Name": {
"example": "Durand",
"type": "string"
},
"Sex": {
"enum": [
"male",
"female"
],
"type": "string"
}
},
"type": "object"
}
],
"required": [
"Name",
"FirstName",
"Email",
"Sex",
"File",
"BirthName",
"Birth"
]
}
}
},
"description": "Profile to add",
"required": true
},
"Provider": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"properties": {
"About": {
"example": "<b> Mon premier dossier </b>",
"type": "string"
},
"Comment": {
"example": "pieces company",
"type": "string"
},
"Designation": {
"example": "client pièces détachées",
"type": "string"
},
"End": {
"example": "20190101",
"type": "string"
},
"Home": {
"example": "yes",
"type": "boolean"
},
"Keywords": {
"example": [
"paris",
"comptabilité"
],
"items": {
"type": "string"
},
"type": "array"
},
"Level": {
"enum": [
"confidential",
"regular",
"public"
],
"example": "confidential",
"type": "string"
},
"ProviderNumber": {
"example": "13587449420F",
"type": "string"
},
"Start": {
"example": "20180630",
"type": "string"
}
},
"type": "object"
}
]
}
}
},
"description": "Provider to add (except name, class and archivaldate)",
"required": true
},
"Registration": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"properties": {
"Code": {
"example": "OJFOA",
"type": "string"
},
"Secret": {
"example": 123456,
"type": "string"
}
},
"type": "object"
}
]
}
}
},
"description": "code and secret to accept the invitation",
"required": true
},
"RequiredDocument": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"properties": {
"File": {
"properties": {
"Content64Encoded": {
"example": "gjgjJ9FJA829H9HA18B",
"type": "string"
},
"Name": {
"example": "MonDocument.pdf",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
],
"required": [
"File",
"Name",
"Content64Encoded"
]
}
},
"multipart/form-data": {
"schema": {
"allOf": [
{
"properties": {
"File": {
"format": "binary",
"type": "string"
},
"Name": {
"example": "Facture décembre",
"type": "string"
}
},
"type": "object"
}
],
"required": [
"Name",
"File"
]
}
}
},
"description": "Required Document to add",
"required": true
},
"SendInvitation": {
"content": {
"application/json": {
"schema": {
"properties": {
"Contact": {
"example": "Dupond",
"type": "string"
},
"Message": {
"example": "<p> Bienvenue dans l'espace de l'envtreprise SOCIETE </p>",
"type": "string"
},
"Signature": {
"example": "cordialement",
"type": "string"
},
"Subject": {
"example": "invitation sur le coffre",
"type": "string"
}
},
"type": "object"
}
}
},
"description": "content of invitation message to send",
"required": true
},
"SocialContract": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"properties": {
"ContractDate": {
"example": "20190202",
"type": "string"
},
"ContractDuration": {
"example": "6 mois",
"type": "string"
},
"ContractualChange": {
"example": "augmentation",
"type": "string"
},
"DocumentId": {
"example": "PBUFBAUBF1531",
"type": "string"
},
"Position": {
"example": "cadre",
"type": "string"
},
"WageDevelopments": {
"example": 1548.63,
"format": "float",
"type": "number"
}
},
"type": "object"
},
{
"properties": {
"Accounting": {
"properties": {
"AccountedOn": {
"example": "20181202",
"type": "string"
},
"Workbook": {
"enum": [
"customer",
"provider",
"bank",
"cashWoucher",
"fiscal",
"insurance",
"social",
"other",
"permanent"
],
"example": "fiscal",
"type": "string"
},
"YearMonth": {
"example": 201902,
"type": "string"
}
},
"type": "object"
},
"Author": {
"example": "Antoine Dupond",
"type": "string"
},
"Code": {
"example": "COD",
"type": "string"
},
"Comment": {
"example": "my document",
"type": "string"
},
"ContractDate": {
"example": "20190202",
"type": "string"
},
"ContractDuration": {
"example": "6 mois",
"type": "string"
},
"ContractualChange": {
"example": "augmentation",
"type": "string"
},
"Date": {
"example": "20161203",
"type": "string"
},
"File": {
"properties": {
"Content64Encoded": {
"example": "gjgjJ9FJA829H9HA18B",
"type": "string"
},
"Name": {
"example": "MonDocument.pdf",
"type": "string"
}
},
"type": "object"
},
"Position": {
"example": "cadre",
"type": "string"
},
"Title": {
"example": "Facture décembre",
"type": "string"
},
"WageDevelopments": {
"example": 1548.63,
"format": "float",
"type": "number"
}
},
"type": "object"
}
],
"required": [
"Title",
"File",
"Name",
"Content64Encoded",
"DocumentId"
]
}
},
"multipart/form-data": {
"schema": {
"allOf": [
{
"properties": {
"Accounting": {
"properties": {
"AccountedOn": {
"example": "20181202",
"type": "string"
},
"Workbook": {
"enum": [
"customer",
"provider",
"bank",
"cashWoucher",
"fiscal",
"insurance",
"social",
"other",
"permanent"
],
"example": "fiscal",
"type": "string"
},
"YearMonth": {
"example": 201902,
"type": "string"
}
},
"type": "object"
},
"Author": {
"example": "Antoine Dupond",
"type": "string"
},
"Code": {
"example": "COD",
"type": "string"
},
"Comment": {
"example": "my document",
"type": "string"
},
"ContractDate": {
"example": "20190202",
"type": "string"
},
"ContractDuration": {
"example": "6 mois",
"type": "string"
},
"ContractualChange": {
"example": "augmentation",
"type": "string"
},
"Date": {
"example": "20161203",
"type": "string"
},
"File": {
"format": "binary",
"type": "string"
},
"Position": {
"example": "cadre",
"type": "string"
},
"Title": {
"example": "Facture décembre",
"type": "string"
},
"WageDevelopments": {
"example": 1548.63,
"format": "float",
"type": "number"
}
},
"type": "object"
}
],
"required": [
"Title",
"File",
"Name"
]
}
}
},
"description": "Social contract to add (either DocumentId either (File,Name,Content64Encoded,Title) is mandatory)",
"required": true
},
"SocialDeclaration": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"properties": {
"Amount": {
"example": 132.63,
"format": "float",
"type": "number"
},
"DeclarationDate": {
"example": "20160801",
"type": "string"
},
"DocumentId": {
"example": "PBUFBAUBF1531",
"type": "string"
}
},
"type": "object"
},
{
"properties": {
"Accounting": {
"properties": {
"AccountedOn": {
"example": "20181202",
"type": "string"
},
"Workbook": {
"enum": [
"customer",
"provider",
"bank",
"cashWoucher",
"fiscal",
"insurance",
"social",
"other",
"permanent"
],
"example": "fiscal",
"type": "string"
},
"YearMonth": {
"example": 201902,
"type": "string"
}
},
"type": "object"
},
"Amount": {
"example": 132.63,
"format": "float",
"type": "number"
},
"Author": {
"example": "Antoine Dupond",
"type": "string"
},
"Code": {
"example": "COD",
"type": "string"
},
"Comment": {
"example": "my document",
"type": "string"
},
"Date": {
"example": "20161203",
"type": "string"
},
"DeclarationDate": {
"example": "20160801",
"type": "string"
},
"File": {
"properties": {
"Content64Encoded": {
"example": "gjgjJ9FJA829H9HA18B",
"type": "string"
},
"Name": {
"example": "MonDocument.pdf",
"type": "string"
}
},
"type": "object"
},
"Title": {
"example": "Facture décembre",
"type": "string"
}
},
"type": "object"
}
],
"required": [
"Title",
"File",
"Name",
"Content64Encoded",
"DocumentId"
]
}
},
"multipart/form-data": {
"schema": {
"allOf": [
{
"properties": {
"Accounting": {
"properties": {
"AccountedOn": {
"example": "20181202",
"type": "string"
},
"Workbook": {
"enum": [
"customer",
"provider",
"bank",
"cashWoucher",
"fiscal",
"insurance",
"social",
"other",
"permanent"
],
"example": "fiscal",
"type": "string"
},
"YearMonth": {
"example": 201902,
"type": "string"
}
},
"type": "object"
},
"Amount": {
"example": 132.63,
"format": "float",
"type": "number"
},
"Author": {
"example": "Antoine Dupond",
"type": "string"
},
"Code": {
"example": "COD",
"type": "string"
},
"Comment": {
"example": "my document",
"type": "string"
},
"Date": {
"example": "20161203",
"type": "string"
},
"DeclarationDate": {
"example": "20160801",
"type": "string"
},
"File": {
"format": "binary",
"type": "string"
},
"Title": {
"example": "Facture décembre",
"type": "string"
}
},
"type": "object"
}
],
"required": [
"Title",
"File",
"Name"
]
}
}
},
"description": "Social declaration to add (either (Reference,DocumentId) either (File,Name,Content64Encoded,Title,Reference) is mandatory)",
"required": true
},
"SocialRegime": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"properties": {
"About": {
"example": "<b> Mon premier dossier </b>",
"type": "string"
},
"Comment": {
"example": "pieces company",
"type": "string"
},
"Designation": {
"example": "client pièces détachées",
"type": "string"
},
"End": {
"example": "20190101",
"type": "string"
},
"Home": {
"example": "yes",
"type": "boolean"
},
"Keywords": {
"example": [
"paris",
"comptabilité"
],
"items": {
"type": "string"
},
"type": "array"
},
"Level": {
"enum": [
"confidential",
"regular",
"public"
],
"example": "confidential",
"type": "string"
},
"Periodicity": {
"enum": [
"monthly",
"quarterly",
"half-yearly",
"annual",
"null"
],
"example": "monthly",
"type": "string"
},
"Start": {
"example": "20180630",
"type": "string"
},
"Type": {
"enum": [
"mandatory",
"optional",
"null"
],
"example": "mandatory",
"type": "string"
}
},
"type": "object"
}
],
"required": [
"Name"
]
}
}
},
"description": "SocialRegime to add (except name, class and archivaldate)",
"required": true
},
"Space": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"properties": {
"LegalStatut": {
"example": "SA",
"type": "string"
},
"Logo": {
"properties": {
"Content64Encoded": {
"example": "NIFHAZFA07GA=",
"type": "string"
},
"Name": {
"example": "toto.png",
"type": "string"
}
},
"type": "object"
},
"Name": {
"example": "Mon Entreprise",
"type": "string"
},
"RegistrationNumber": {
"example": 5146486846,
"type": "string"
},
"TemplateSpaceId": {
"example": "PKOJOFOFKAOKF",
"type": "string"
},
"Type": {
"enum": [
"enterprise",
"company",
"association"
],
"example": "company",
"type": "string"
}
},
"type": "object"
}
],
"required": [
"Name",
"Type"
]
}
}
},
"description": "Space to add (except private)",
"required": true
},
"Status": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"properties": {
"Code": {
"example": "COD",
"type": "string"
},
"Comment": {
"example": "my first code",
"type": "string"
},
"Label": {
"example": "code 1",
"type": "string"
}
},
"type": "object"
}
],
"required": [
"Code",
"Label"
]
}
}
},
"description": "Status to add or replace",
"required": true
},
"TaxContract": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"properties": {
"About": {
"example": "<b> Mon premier dossier </b>",
"type": "string"
},
"Comment": {
"example": "ogm of the company",
"type": "string"
},
"Designation": {
"example": "année 2019",
"type": "string"
},
"End": {
"example": "20181231",
"type": "string"
},
"Home": {
"example": "yes",
"type": "boolean"
},
"Keywords": {
"example": [
"paris",
"comptabilité"
],
"items": {
"type": "string"
},
"type": "array"
},
"Level": {
"enum": [
"confidential",
"regular",
"public"
],
"example": "confidential",
"type": "string"
},
"Start": {
"example": "20180101",
"type": "string"
}
},
"type": "object"
}
],
"required": [
"Designation"
]
}
}
},
"description": "Tax contract to add",
"required": true
},
"VATDeclaration": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"properties": {
"Begin": {
"example": "20160801",
"type": "string"
},
"CollectedVAT": {
"example": 1548.63,
"format": "float",
"type": "number"
},
"CreditVAT": {
"example": 400.5,
"format": "float",
"type": "number"
},
"DeductibleVAT": {
"example": 20.5,
"format": "float",
"type": "number"
},
"DocumentId": {
"example": "PBUFBAUBF1531",
"type": "string"
},
"End": {
"example": "20160831",
"type": "string"
},
"ExemptTurnover": {
"example": 132.63,
"format": "float",
"type": "number"
},
"Number": {
"example": "153126",
"type": "string"
},
"PayableVAT": {
"example": 2000.5,
"format": "float",
"type": "number"
},
"TaxableTurnover": {
"example": 1352.63,
"format": "float",
"type": "number"
}
},
"type": "object"
},
{
"properties": {
"Accounting": {
"properties": {
"AccountedOn": {
"example": "20181202",
"type": "string"
},
"Workbook": {
"enum": [
"customer",
"provider",
"bank",
"cashWoucher",
"fiscal",
"insurance",
"social",
"other",
"permanent"
],
"example": "fiscal",
"type": "string"
},
"YearMonth": {
"example": 201902,
"type": "string"
}
},
"type": "object"
},
"Author": {
"example": "Antoine Dupond",
"type": "string"
},
"Begin": {
"example": "20160801",
"type": "string"
},
"Code": {
"example": "COD",
"type": "string"
},
"CollectedVAT": {
"example": 1548.63,
"format": "float",
"type": "number"
},
"Comment": {
"example": "my document",
"type": "string"
},
"CreditVAT": {
"example": 400.5,
"format": "float",
"type": "number"
},
"Date": {
"example": "20161203",
"type": "string"
},
"DeductibleVAT": {
"example": 20.5,
"format": "float",
"type": "number"
},
"End": {
"example": "20160831",
"type": "string"
},
"ExemptTurnover": {
"example": 132.63,
"format": "float",
"type": "number"
},
"File": {
"properties": {
"Content64Encoded": {
"example": "gjgjJ9FJA829H9HA18B",
"type": "string"
},
"Name": {
"example": "MonDocument.pdf",
"type": "string"
}
},
"type": "object"
},
"Number": {
"example": "153126",
"type": "string"
},
"PayableVAT": {
"example": 2000.5,
"format": "float",
"type": "number"
},
"TaxableTurnover": {
"example": 1352.63,
"format": "float",
"type": "number"
},
"Title": {
"example": "Facture décembre",
"type": "string"
}
},
"type": "object"
}
],
"required": [
"Title",
"File",
"Name",
"Content64Encoded",
"DocumentId",
"End"
]
}
},
"multipart/form-data": {
"schema": {
"allOf": [
{
"properties": {
"Accounting": {
"properties": {
"AccountedOn": {
"example": "20181202",
"type": "string"
},
"Workbook": {
"enum": [
"customer",
"provider",
"bank",
"cashWoucher",
"fiscal",
"insurance",
"social",
"other",
"permanent"
],
"example": "fiscal",
"type": "string"
},
"YearMonth": {
"example": 201902,
"type": "string"
}
},
"type": "object"
},
"Author": {
"example": "Antoine Dupond",
"type": "string"
},
"Begin": {
"example": "20160801",
"type": "string"
},
"Code": {
"example": "COD",
"type": "string"
},
"CollectedVAT": {
"example": 1548.63,
"format": "float",
"type": "number"
},
"Comment": {
"example": "my document",
"type": "string"
},
"CreditVAT": {
"example": 400.5,
"format": "float",
"type": "number"
},
"Date": {
"example": "20161203",
"type": "string"
},
"DeductibleVAT": {
"example": 20.5,
"format": "float",
"type": "number"
},
"End": {
"example": "20160831",
"type": "string"
},
"ExemptTurnover": {
"example": 132.63,
"format": "float",
"type": "number"
},
"File": {
"format": "binary",
"type": "string"
},
"Number": {
"example": "153126",
"type": "string"
},
"PayableVAT": {
"example": 2000.5,
"format": "float",
"type": "number"
},
"TaxableTurnover": {
"example": 1352.63,
"format": "float",
"type": "number"
},
"Title": {
"example": "Facture décembre",
"type": "string"
}
},
"type": "object"
}
],
"required": [
"Title",
"File",
"Name",
"End"
]
}
}
},
"description": "VATDeclaration to add (either (DocumentId,End) either (File,Name,Content64Encoded,Title,End) is mandatory)",
"required": true
},
"Version": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"properties": {
"Author": {
"example": "Antoine Dupond",
"type": "string"
},
"Code": {
"example": "COD",
"type": "string"
},
"Comment": {
"example": "my document",
"type": "string"
},
"Date": {
"example": "20161203",
"type": "string"
},
"File": {
"properties": {
"Content64Encoded": {
"example": "gjgjJ9FJA829H9HA18B",
"type": "string"
},
"Name": {
"example": "MonDocument.pdf",
"type": "string"
}
},
"type": "object"
},
"Title": {
"example": "Facture décembre",
"type": "string"
}
},
"type": "object"
}
],
"required": [
"Title",
"File",
"Name",
"Content64Encoded"
]
}
},
"multipart/form-data": {
"schema": {
"allOf": [
{
"properties": {
"Author": {
"example": "Antoine Dupond",
"type": "string"
},
"Code": {
"example": "COD",
"type": "string"
},
"Comment": {
"example": "my document",
"type": "string"
},
"Date": {
"example": "20161203",
"type": "string"
},
"File": {
"format": "binary",
"type": "string"
},
"Title": {
"example": "Facture décembre",
"type": "string"
}
},
"type": "object"
}
],
"required": [
"Title",
"File",
"Name"
]
}
}
},
"description": "Version to add",
"required": true
},
"Zip": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"properties": {
"DocumentId": {
"items": {
"example": "POFA872498",
"type": "string"
},
"type": "array"
}
},
"type": "object"
}
],
"required": [
"DocumentId"
]
}
}
},
"description": "Documents to archive",
"required": true
}
},
"responses": {
"Accounting": {
"content": {
"application/json": {
"schema": {
"items": {
"allOf": [
{
"$ref": "#/components/schemas/Accounting"
}
]
},
"type": "array"
}
}
},
"description": "A list of accountings document of the folder"
},
"AccountingYear": {
"content": {
"application/json": {
"schema": {
"items": {
"allOf": [
{
"$ref": "#/components/schemas/AccountingYear"
},
{
"properties": {
"Id": {
"example": "P45IHFA",
"type": "string"
}
},
"type": "object"
}
]
},
"type": "array"
}
}
},
"description": "A list of accounting years"
},
"AccountingsJournal": {
"content": {
"application/json": {
"schema": {
"items": {
"properties": {
"AccountingDate": {
"example": "20181123",
"type": "string"
},
"AccountingDocumentId": {
"example": "P0I4UIBH91",
"type": "string"
},
"Class": {
"example": "invoice",
"type": "string"
},
"Code": {
"example": "delivered",
"type": "string"
},
"DeliveryDate": {
"example": "20181123082356",
"type": "string"
},
"Id": {
"example": "PJDAKAZ9299",
"type": "string"
},
"Number": {
"example": 12,
"type": "integer"
},
"TargetFolder": {
"properties": {
"Id": {
"example": "P90742HB",
"type": "string"
},
"Name": {
"example": "Exercice clos le",
"type": "string"
}
},
"type": "object"
},
"Workbook": {
"enum": [
"customer",
"provider",
"bank",
"cashWoucher",
"fiscal",
"insurance",
"social",
"other",
"permanent"
],
"example": "fiscal",
"type": "string"
},
"YearMonth": {
"example": "201811",
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
}
},
"description": "A list of accountings document (journal)"
},
"Bank": {
"content": {
"application/json": {
"schema": {
"items": {
"allOf": [
{
"$ref": "#/components/schemas/Bank"
}
]
},
"type": "array"
}
}
},
"description": "A list of bank folders"
},
"BankStatement": {
"content": {
"application/json": {
"schema": {
"items": {
"allOf": [
{
"$ref": "#/components/schemas/BankStatement"
}
]
},
"type": "array"
}
}
},
"description": "A list of bank statements of the folder bank"
},
"BusinessGroup": {
"content": {
"application/json": {
"schema": {
"items": {
"allOf": [
{
"$ref": "#/components/schemas/BusinessGroup"
}
]
},
"type": "array"
}
}
},
"description": "A list of groups"
},
"CollectiveDecision": {
"content": {
"application/json": {
"schema": {
"items": {
"allOf": [
{
"$ref": "#/components/schemas/CollectiveDecision"
},
{
"properties": {
"Id": {
"example": "P45IHFA",
"type": "string"
}
},
"type": "object"
}
]
},
"type": "array"
}
}
},
"description": "A list of collective decisions"
},
"CompanyEntity": {
"content": {
"application/json": {
"schema": {
"items": {
"allOf": [
{
"$ref": "#/components/schemas/CompanyEntity"
}
]
},
"type": "array"
}
}
},
"description": "A list of company entities"
},
"Contract": {
"content": {
"application/json": {
"schema": {
"items": {
"allOf": [
{
"$ref": "#/components/schemas/Contract"
}
]
},
"type": "array"
}
}
},
"description": "A list of contracts folders"
},
"ContractingCustomer": {
"content": {
"application/json": {
"schema": {
"items": {
"allOf": [
{
"$ref": "#/components/schemas/Customer"
},
{
"properties": {
"Contracting": {
"properties": {
"Id": {
"example": "P12345",
"type": "string"
},
"Type": {
"example": "Person",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
]
},
"type": "array"
}
}
},
"description": "A list of customer folders"
},
"ContractingPartner": {
"content": {
"application/json": {
"schema": {
"items": {
"properties": {
"Class": {
"enum": [
"CompanyEntity",
"Person"
],
"example": "Person",
"type": "string"
},
"Id": {
"example": "P12345",
"type": "string"
},
"Role": {
"example": "employee",
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
}
},
"description": "A list of contracting partners"
},
"ContractingSpace": {
"content": {
"application/json": {
"schema": {
"properties": {
"SpaceId": {
"example": "P12345",
"type": "string"
}
},
"type": "object"
}
}
},
"description": "Id of contracting space"
},
"Contractual-Relationship": {
"content": {
"application/json": {
"schema": {
"items": {
"allOf": [
{
"$ref": "#/components/schemas/Contractual-Relationship"
}
]
},
"type": "array"
}
}
},
"description": "A list of other contract folders"
},
"ContractualDocument": {
"content": {
"application/json": {
"schema": {
"items": {
"allOf": [
{
"$ref": "#/components/schemas/ContractualDocument"
}
]
},
"type": "array"
}
}
},
"description": "A list of documents of the folder"
},
"CorporateTaxDeclaration": {
"content": {
"application/json": {
"schema": {
"items": {
"allOf": [
{
"$ref": "#/components/schemas/CorporateTaxDeclaration"
}
]
},
"type": "array"
}
}
},
"description": "A list of Corporate Tax declarations"
},
"CurrentDocument": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"properties": {
"Author": {
"example": "Antoine Dupond",
"type": "string"
},
"Class": {
"items": {
"example": [
"Contract",
"Invoice"
],
"type": "string"
},
"type": "array"
},
"Code": {
"example": "COD",
"type": "string"
},
"Comment": {
"example": "my document",
"type": "string"
},
"Date": {
"example": "20161203",
"type": "string"
},
"Extension": {
"example": "png",
"type": "string"
},
"Id": {
"example": "P45IHFA",
"type": "string"
},
"Title": {
"example": "Facture décembre",
"type": "string"
}
},
"type": "object"
}
]
}
}
},
"description": "current version of the document"
},
"Customer": {
"content": {
"application/json": {
"schema": {
"items": {
"allOf": [
{
"$ref": "#/components/schemas/Customer"
}
]
},
"type": "array"
}
}
},
"description": "A list of customer folders"
},
"DeliveriesJournal": {
"content": {
"application/json": {
"schema": {
"items": {
"properties": {
"Author": {
"example": "Dupond",
"type": "string"
},
"Class": {
"example": "invoice",
"type": "string"
},
"DeleteDate": {
"example": "20220223",
"type": "string"
},
"DeliveryDate": {
"example": "20181123082356",
"type": "string"
},
"Id": {
"example": "PJDAKAZ9299",
"type": "string"
},
"Number": {
"example": 12,
"type": "integer"
},
"TargetFolder": {
"properties": {
"Id": {
"example": "P90742HB",
"type": "string"
},
"Name": {
"example": "Exercice clos le",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"type": "array"
}
}
},
"description": "A list of document (journal)"
},
"Details": {
"content": {
"application/json": {
"schema": {
"items": {
"allOf": [
{
"properties": {
"Address": {
"properties": {
"City": {
"example": "Paris",
"type": "string"
},
"Complement": {
"example": "batiment A",
"type": "string"
},
"Country": {
"example": "France",
"type": "string"
},
"Street": {
"example": "2, rue du chateau",
"type": "string"
},
"ZipCode": {
"example": "75001",
"type": "string"
}
},
"type": "object"
},
"Designation": {
"example": "Office",
"type": "string"
},
"Email": {
"items": {
"example": [
"bertrand@monmail.com"
],
"type": "string"
},
"type": "array"
},
"Phone": {
"items": {
"example": [
"+33606060606"
],
"type": "string"
},
"type": "array"
}
},
"type": "object"
}
]
},
"type": "array"
}
}
},
"description": "A list of contact details of a person"
},
"Document": {
"content": {
"application/json": {
"schema": {
"items": {
"allOf": [
{
"$ref": "#/components/schemas/Document"
}
]
},
"type": "array"
}
}
},
"description": "A list of documents of the folder"
},
"DocumentData": {
"content": {
"application/json": {
"schema": {
"items": {
"allOf": [
{
"$ref": "#/components/schemas/Document"
},
{
"properties": {
"Extend": {
"type": "object"
}
},
"type": "object"
}
]
},
"type": "array"
}
}
},
"description": "A list of documents of the folder"
},
"DocumentSearch": {
"content": {
"application/json": {
"schema": {
"items": {
"properties": {
"Author": {
"example": "Antoine Dupond",
"type": "string"
},
"Code": {
"example": "COD",
"type": "string"
},
"Comment": {
"example": "my document",
"type": "string"
},
"Date": {
"example": "20161203",
"type": "string"
},
"Extension": {
"example": "pdf",
"type": "string"
},
"Folders": {
"items": {
"properties": {
"Id": {
"example": "PHFIHA393",
"type": "string"
},
"Name": {
"example": "My Folder",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"Id": {
"example": "P45IHFA",
"type": "string"
},
"Title": {
"example": "Facture décembre",
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
}
},
"description": "A list of documents returned by the search"
},
"Employee": {
"content": {
"application/json": {
"schema": {
"items": {
"allOf": [
{
"$ref": "#/components/schemas/Employee"
}
]
},
"type": "array"
}
}
},
"description": "A list of employees folders"
},
"Employer": {
"content": {
"application/json": {
"schema": {
"items": {
"allOf": [
{
"$ref": "#/components/schemas/Employer"
}
]
},
"type": "array"
}
}
},
"description": "A list of employers folders"
},
"ExpenseProof": {
"content": {
"application/json": {
"schema": {
"items": {
"allOf": [
{
"$ref": "#/components/schemas/ExpenseProof"
}
]
},
"type": "array"
}
}
},
"description": "A list of expense proof of the folder (if the folder is social the PersonId is also returned)"
},
"ExpenseReport": {
"content": {
"application/json": {
"schema": {
"items": {
"allOf": [
{
"$ref": "#/components/schemas/ExpenseReport"
}
]
},
"type": "array"
}
}
},
"description": "A list of expense reports of the folder (if the folder is social the PersonId is also returned)"
},
"Folder": {
"content": {
"application/json": {
"schema": {
"items": {
"allOf": [
{
"$ref": "#/components/schemas/Folder"
}
]
},
"type": "array"
}
}
},
"description": "A list of folders"
},
"FollowUp": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/FollowUp"
}
]
}
}
},
"description": "the folder of a person"
},
"Group": {
"content": {
"application/json": {
"schema": {
"items": {
"allOf": [
{
"$ref": "#/components/schemas/Group"
}
]
},
"type": "array"
}
}
},
"description": "A list of groups"
},
"Insurance": {
"content": {
"application/json": {
"schema": {
"items": {
"allOf": [
{
"$ref": "#/components/schemas/Insurance"
}
]
},
"type": "array"
}
}
},
"description": "A list of insurance folders"
},
"Invoice": {
"content": {
"application/json": {
"schema": {
"items": {
"allOf": [
{
"$ref": "#/components/schemas/Invoice"
}
]
},
"type": "array"
}
}
},
"description": "A list of invoices of the folder (if the folder is the root folder (Customers of Providers) the FolderId, the Designation and the Contracting of the contract are also returned)"
},
"LegalEntityFollow": {
"content": {
"application/json": {
"schema": {
"properties": {
"Class": {
"enum": [
"CompanyEntity",
"Person"
],
"example": "Person",
"type": "string"
},
"Id": {
"example": "P12345",
"type": "string"
}
},
"type": "object"
}
}
},
"description": "legal entity of the folder"
},
"Loan": {
"content": {
"application/json": {
"schema": {
"items": {
"allOf": [
{
"$ref": "#/components/schemas/Loan"
}
]
},
"type": "array"
}
}
},
"description": "A list of loan folders"
},
"Logs": {
"content": {
"application/json": {
"schema": {
"properties": {
"Enabled": {
"example": true,
"type": "boolean"
}
},
"type": "object"
}
}
},
"description": "State of activation of the logs"
},
"Mailing": {
"content": {
"application/json": {
"schema": {
"properties": {
"PageNb": {
"example": 2,
"type": "number"
},
"Price": {
"example": "1.37",
"type": "string"
}
},
"type": "object"
}
}
},
"description": "A list of documents of the folder"
},
"Menus": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"properties": {
"Folders": {
"items": {
"properties": {
"Id": {
"example": "PIHDOIAH81",
"type": "string"
},
"Name": {
"example": "My Folder",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"Workbooks": {
"items": {
"example": "customer",
"type": "string"
},
"type": "array"
}
},
"type": "object"
}
]
}
}
},
"description": "menus of the hub"
},
"Message": {
"content": {
"application/json": {
"schema": {
"items": {
"allOf": [
{
"$ref": "#/components/schemas/Message"
}
]
},
"type": "array"
}
}
},
"description": "A list of messages"
},
"NSD": {
"content": {
"application/json": {
"schema": {
"items": {
"allOf": [
{
"$ref": "#/components/schemas/Payroll"
},
{
"properties": {
"PayrollId": {
"example": "PJOFAP2089",
"type": "string"
}
},
"type": "object"
}
]
},
"type": "array"
}
}
},
"description": "A list of nominative social declarations of the folder social"
},
"OneAccess": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Access"
},
{
"$ref": "#/components/schemas/Folder"
}
]
}
}
},
"description": "An access to a folder"
},
"OneAccessDocument": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"properties": {
"Access": {
"items": {
"properties": {
"DownloadedOn": {
"example": "20210205",
"type": "string"
},
"FirstName": {
"example": "Martin",
"type": "string"
},
"Name": {
"example": "Dupond",
"type": "string"
},
"SeenOn": {
"example": "20180201",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"Author": {
"example": "Antoine Dupond",
"type": "string"
},
"Class": {
"items": {
"example": [
"Contract",
"Invoice"
],
"type": "string"
},
"type": "array"
},
"Code": {
"example": "COD",
"type": "string"
},
"Comment": {
"example": "my document",
"type": "string"
},
"Date": {
"example": "20161203",
"type": "string"
},
"Extension": {
"example": "png",
"type": "string"
},
"Id": {
"example": "P45IHFA",
"type": "string"
},
"Title": {
"example": "Facture décembre",
"type": "string"
}
},
"type": "object"
}
]
}
}
},
"description": "accesses of one document (without folder date)"
},
"OneAccounting": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"properties": {
"Accounting": {
"properties": {
"AccountedOn": {
"example": "20181202",
"type": "string"
},
"Workbook": {
"enum": [
"customer",
"provider",
"bank",
"cashWoucher",
"fiscal",
"insurance",
"social",
"other",
"permanent"
],
"example": "fiscal",
"type": "string"
},
"YearMonth": {
"example": 201802,
"type": "string"
}
},
"type": "object"
},
"Author": {
"example": "Antoine Dupond",
"type": "string"
},
"Class": {
"items": {
"example": [
"Contract",
"Invoice"
],
"type": "string"
},
"type": "array"
},
"Code": {
"example": "COD",
"type": "string"
},
"Comment": {
"example": "my document",
"type": "string"
},
"Date": {
"example": "20161203",
"type": "string"
},
"Extension": {
"example": "png",
"type": "string"
},
"Id": {
"example": "P45IHFA",
"type": "string"
},
"Title": {
"example": "Facture décembre",
"type": "string"
}
},
"type": "object"
}
]
}
}
},
"description": "document with accounting property"
},
"OneBank": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Bank"
}
]
}
}
},
"description": "A bank folder"
},
"OneBusinessGroup": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/BusinessGroup"
},
{
"properties": {
"Id": {
"example": "P45IHFA",
"type": "string"
}
},
"type": "object"
},
{
"properties": {
"ModificationDate": {
"example": "20190325125042",
"type": "string"
}
},
"type": "object"
}
]
}
}
},
"description": "A group"
},
"OneCompanyEntity": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/CompanyEntity"
}
]
}
}
},
"description": "A company entity"
},
"OneContractual-Relationship": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Contractual-Relationship"
}
]
}
}
},
"description": "A contractual relationship folder"
},
"OneCustomer": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Customer"
},
{
"properties": {
"Actors": {
"items": {
"properties": {
"Active": {
"example": "no",
"type": "string"
},
"IsAdmin": {
"example": "yes",
"type": "string"
},
"MemberId": {
"example": "P12345",
"type": "string"
},
"Name": {
"example": "Antoine Dupond",
"type": "string"
},
"Role": {
"example": "collaborator",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"ClientSpaceId": {
"example": "PDHIADHIA",
"type": "string"
},
"PortfolioId": {
"example": "PJFAIOJFR",
"type": "string"
},
"SecondaryPortfolioIds": {
"items": {
"example": "PJFAIOJFR",
"type": "string"
},
"type": "array"
}
},
"type": "object"
}
]
}
}
},
"description": "A customer folder"
},
"OneDocument": {
"content": {
"*/*": {
"schema": {
"allOf": [
{
"properties": {
"File": {
"format": "binary",
"type": "string"
}
},
"type": "object"
}
]
}
},
"application/json": {
"schema": {
"allOf": [
{
"properties": {
"Author": {
"example": "Antoine Dupond",
"type": "string"
},
"Class": {
"example": [
"Contract",
"Invoice"
],
"items": {
"type": "string"
},
"type": "array"
},
"Code": {
"example": "COD",
"type": "string"
},
"Comment": {
"example": "my document",
"type": "string"
},
"Date": {
"example": "20161203",
"type": "string"
},
"Extension": {
"example": "png",
"type": "string"
},
"File": {
"properties": {
"Content64Encoded": {
"example": "JFOJAOJF=",
"type": "string"
}
},
"type": "object"
},
"Id": {
"example": "P45IHFA",
"type": "string"
},
"Title": {
"example": "Facture décembre",
"type": "string"
}
},
"type": "object"
}
]
}
},
"multipart/form-data": {
"schema": {
"allOf": [
{
"properties": {
"DTO": {
"properties": {
"Author": {
"example": "Antoine Dupond",
"type": "string"
},
"Class": {
"items": {
"example": [
"Contract",
"Invoice"
],
"type": "string"
},
"type": "array"
},
"Code": {
"example": "COD",
"type": "string"
},
"Comment": {
"example": "my document",
"type": "string"
},
"Date": {
"example": "20161203",
"type": "string"
},
"Extension": {
"example": "png",
"type": "string"
},
"Id": {
"example": "P45IHFA",
"type": "string"
},
"Title": {
"example": "Facture décembre",
"type": "string"
}
},
"type": "object"
},
"File": {
"format": "binary",
"type": "string"
}
},
"type": "object"
}
]
}
}
},
"description": "content of one document (without folder date)"
},
"OneDocumentFolders": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"properties": {
"Author": {
"example": "Antoine Dupond",
"type": "string"
},
"Class": {
"items": {
"example": [
"Contract",
"Invoice"
],
"type": "string"
},
"type": "array"
},
"Code": {
"example": "COD",
"type": "string"
},
"Comment": {
"example": "my document",
"type": "string"
},
"Date": {
"example": "20161203",
"type": "string"
},
"Extension": {
"example": "png",
"type": "string"
},
"FolderDate": {
"example": "20161203",
"type": "string"
},
"Folders": {
"items": {
"properties": {
"Id": {
"example": "PHFIHA393",
"type": "string"
},
"Name": {
"example": "My Folder",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"Id": {
"example": "P45IHFA",
"type": "string"
},
"Title": {
"example": "Facture décembre",
"type": "string"
}
},
"type": "object"
}
]
}
}
},
"description": "document with folders"
},
"OneEmployee": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Employee"
}
]
}
}
},
"description": "An employee folder"
},
"OneFolder": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Folder"
},
{
"properties": {
"Id": {
"example": "T45IHFA",
"type": "string"
}
},
"type": "object"
},
{
"properties": {
"ModificationDate": {
"example": "20190325125042",
"type": "string"
}
},
"type": "object"
}
]
}
}
},
"description": "A folder"
},
"OneGroup": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Group"
},
{
"properties": {
"Accesses": {
"properties": {
"Id": {
"example": "PAHIA1564165",
"type": "string"
},
"Name": {
"example": "Social",
"type": "string"
},
"Right": {
"enum": [
"read",
"write"
],
"example": "read",
"type": "string"
}
},
"type": "object"
},
"Persons": {
"properties": {
"MemberId": {
"example": "PAHIA1564165",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
]
}
}
},
"description": "A company entity"
},
"OneInsurance": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Insurance"
}
]
}
}
},
"description": "An insurance folder"
},
"OneLegal": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Legal"
}
]
}
}
},
"description": "Legal informations of a space"
},
"OneLoan": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Loan"
}
]
}
}
},
"description": "A loan folder"
},
"OneMessage": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Message"
},
{
"properties": {
"Id": {
"example": "T45IHFA",
"type": "string"
}
},
"type": "object"
},
{
"properties": {
"ModificationDate": {
"example": "20190325125042",
"type": "string"
}
},
"type": "object"
}
]
}
}
},
"description": "A message"
},
"OneNSD": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Payroll"
},
{
"properties": {
"PayrollId": {
"example": "PJOFAP2089",
"type": "string"
}
},
"type": "object"
}
]
}
}
},
"description": "A nominative social declaration of the folder social"
},
"OnePassword": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Password"
},
{
"properties": {
"Id": {
"example": "T45IHFA",
"type": "string"
}
},
"type": "object"
}
]
}
}
},
"description": "A password"
},
"OnePerson": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Person"
},
{
"properties": {
"Id": {
"example": "T45IHFA",
"type": "string"
}
},
"type": "object"
},
{
"properties": {
"ModificationDate": {
"example": "20190325125042",
"type": "string"
}
},
"type": "object"
},
{
"properties": {
"MemberId": {
"example": "P1A6FD090A",
"type": "string"
}
},
"type": "object"
}
]
}
}
},
"description": "A person"
},
"OneProvider": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Provider"
}
]
}
}
},
"description": "A provider folder"
},
"OneSocialRegime": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SocialRegime"
}
]
}
}
},
"description": "A social regime folder"
},
"OneSpace": {
"content": {
"application/json": {
"schema": {
"properties": {
"Id": {
"example": "P12345",
"type": "string"
},
"ModificationDate": {
"example": "20190325125042",
"type": "string"
},
"Name": {
"example": "Mon Entreprise",
"type": "string"
},
"Type": {
"enum": [
"private",
"enterprise",
"company",
"association"
],
"example": "company",
"type": "string"
}
},
"type": "object"
}
}
},
"description": "A space"
},
"OneSpaceWithExtend": {
"content": {
"application/json": {
"schema": {
"properties": {
"Extend": {
"example": {
"test": "test"
},
"type": "object"
},
"Id": {
"example": "P12345",
"type": "string"
},
"ModificationDate": {
"example": "20190325125042",
"type": "string"
},
"Name": {
"example": "Mon Entreprise",
"type": "string"
},
"Type": {
"enum": [
"private",
"enterprise",
"company",
"association"
],
"example": "company",
"type": "string"
}
},
"type": "object"
}
}
},
"description": "A space"
},
"OneSpaceWithLogo": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Space"
}
]
}
},
"multipart/form-data": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Space"
}
]
}
}
},
"description": "A space"
},
"OtherTax": {
"content": {
"application/json": {
"schema": {
"items": {
"allOf": [
{
"$ref": "#/components/schemas/OtherTax"
}
]
},
"type": "array"
}
}
},
"description": "A list of other taxes declarations"
},
"PartialProfile": {
"content": {
"application/json": {
"schema": {
"properties": {
"Birth": {
"properties": {
"City": {
"example": "Créteil",
"type": "string"
},
"Country": {
"example": "FR",
"type": "string"
},
"Date": {
"example": "19800101",
"type": "string"
},
"ZipCode": {
"example": "94000",
"type": "string"
}
},
"type": "object"
},
"BirthName": {
"example": "Dupond",
"type": "string"
},
"FirstName": {
"example": "Paule",
"type": "string"
},
"Name": {
"example": "Durand",
"type": "string"
},
"PrivateSpaceId": {
"example": "PFJAOJHFA",
"type": "string"
},
"Sex": {
"enum": [
"male",
"female"
],
"type": "string"
},
"Status": {
"enum": [
"validated",
"not validated"
],
"example": "Person",
"type": "string"
}
},
"type": "object"
}
}
},
"description": "the status of the member"
},
"Password": {
"content": {
"application/json": {
"schema": {
"items": {
"allOf": [
{
"$ref": "#/components/schemas/Password"
},
{
"properties": {
"Id": {
"example": "TJVPJAJJAFA",
"type": "string"
}
},
"type": "object"
}
]
},
"type": "array"
}
}
},
"description": "A list of passwords"
},
"PaySlip": {
"content": {
"application/json": {
"schema": {
"items": {
"allOf": [
{
"$ref": "#/components/schemas/PaySlip"
}
]
},
"type": "array"
}
}
},
"description": "A list of payslips of the folder employee"
},
"Payroll": {
"content": {
"application/json": {
"schema": {
"items": {
"allOf": [
{
"$ref": "#/components/schemas/Payroll"
}
]
},
"type": "array"
}
}
},
"description": "A list of payrolls of the folder social"
},
"Person": {
"content": {
"application/json": {
"schema": {
"items": {
"allOf": [
{
"$ref": "#/components/schemas/Person"
}
]
},
"type": "array"
}
}
},
"description": "A list of persons"
},
"PersonAccess": {
"content": {
"application/json": {
"schema": {
"items": {
"properties": {
"Active": {
"example": "no",
"type": "string"
},
"IsAdmin": {
"example": "yes",
"type": "string"
},
"MemberId": {
"example": "P12345",
"type": "string"
},
"Name": {
"example": "Antoine Dupond",
"type": "string"
},
"Role": {
"example": "collaborator",
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
}
},
"description": "the access of a person to a customer contract folder"
},
"Portfolios": {
"content": {
"application/json": {
"schema": {
"items": {
"allOf": [
{
"$ref": "#/components/schemas/Portfolio"
},
{
"properties": {
"Id": {
"example": "P45IHFA",
"type": "string"
}
},
"type": "object"
}
]
},
"type": "array"
}
}
},
"description": "A list of portfolios"
},
"ProfessionalVehicle": {
"content": {
"application/json": {
"schema": {
"items": {
"allOf": [
{
"$ref": "#/components/schemas/ProfessionalVehicle"
},
{
"properties": {
"Id": {
"example": "P45IHFA",
"type": "string"
}
},
"type": "object"
}
]
},
"type": "array"
}
}
},
"description": "A list of professional Vehicles"
},
"Profile": {
"content": {
"application/json": {
"schema": {
"properties": {
"Birth": {
"properties": {
"City": {
"example": "Créteil",
"type": "string"
},
"Country": {
"example": "FR",
"type": "string"
},
"Date": {
"example": "19800101",
"type": "string"
},
"ZipCode": {
"example": "94000",
"type": "string"
}
},
"type": "object"
},
"BirthName": {
"example": "Dupond",
"type": "string"
},
"FirstName": {
"example": "Paule",
"type": "string"
},
"IDFile": {
"properties": {
"Content64Encoded": {
"example": "PKDJFAJAFA",
"type": "string"
}
},
"type": "object"
},
"Name": {
"example": "Durand",
"type": "string"
},
"PrivateSpaceId": {
"example": "PFJAOJHFA",
"type": "string"
},
"Sex": {
"enum": [
"male",
"female"
],
"type": "string"
},
"Status": {
"enum": [
"validated",
"not validated"
],
"example": "Person",
"type": "string"
}
},
"type": "object"
}
},
"multipart/form-data": {
"schema": {
"properties": {
"Birth": {
"properties": {
"City": {
"example": "Créteil",
"type": "string"
},
"Country": {
"example": "France",
"type": "string"
},
"Date": {
"example": "19800101",
"type": "string"
},
"ZipCode": {
"example": "94000",
"type": "string"
}
},
"type": "object"
},
"BirthName": {
"example": "Dupond",
"type": "string"
},
"FirstName": {
"example": "Paule",
"type": "string"
},
"IDFile": {
"format": "binary",
"type": "string"
},
"Name": {
"example": "Durand",
"type": "string"
},
"PrivateSpaceId": {
"example": "PFJAOJHFA",
"type": "string"
},
"Sex": {
"enum": [
"male",
"female"
],
"type": "string"
},
"Status": {
"enum": [
"validated",
"not validated"
],
"example": "Person",
"type": "string"
}
},
"type": "object"
}
}
},
"description": "the status of the member"
},
"Provider": {
"content": {
"application/json": {
"schema": {
"items": {
"allOf": [
{
"$ref": "#/components/schemas/Provider"
}
]
},
"type": "array"
}
}
},
"description": "A list of provider folders"
},
"Registration": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"properties": {
"Message": {
"example": "Contacter Antoine Dupond",
"type": "string"
}
},
"type": "object"
},
{
"properties": {
"url": {
"example": "https://www.google.com",
"type": "string"
}
},
"type": "object"
}
]
}
}
},
"description": "the method to get the validation code or the registration link"
},
"RequiredDocument": {
"content": {
"application/json": {
"schema": {
"items": {
"properties": {
"Comment": {
"example": "recto verso",
"type": "string"
},
"Date": {
"example": "20161203",
"type": "string"
},
"DocIds": {
"items": {
"example": [
"PIHFAHAF",
"PPJFAJHFHR94982"
],
"type": "string"
},
"type": "array"
},
"Id": {
"example": "TPKAZ9299",
"type": "string"
},
"Name": {
"example": "passeport",
"type": "string"
},
"Status": {
"enum": [
"waiting",
"validated",
"ended"
],
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
}
},
"description": "A list of required documents"
},
"Search": {
"content": {
"application/json": {
"schema": {
"properties": {
"Count": {
"items": {
"properties": {
"Class": {
"enum": [
"Document",
"Message",
"Folder"
],
"example": "Folder",
"type": "string"
},
"Count": {
"example": 3,
"type": "integer"
}
},
"type": "object"
},
"type": "array"
},
"Results": {
"items": {
"properties": {
"Class": {
"enum": [
"Document",
"Message",
"Folder"
],
"example": "Folder",
"type": "string"
},
"Extract": {
"properties": {
"Text": {
"example": "le dossier social",
"type": "string"
},
"Where": {
"example": "Content",
"type": "string"
}
},
"type": "object"
},
"Id": {
"example": "P94901",
"type": "string"
},
"Label": {
"example": "Document 1",
"type": "string"
},
"Location": {
"items": {
"example": "Document 1",
"type": "string"
},
"type": "array"
},
"Score": {
"example": 15.5656,
"type": "number"
},
"Specific": {
"properties": {
"Extension": {
"example": "pdf",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"type": "array"
},
"TotalCount": {
"example": 3,
"type": "integer"
}
},
"type": "object"
}
}
},
"description": "result object of search"
},
"Section": {
"content": {
"application/json": {
"schema": {
"items": {
"allOf": [
{
"$ref": "#/components/schemas/Section"
},
{
"properties": {
"Type": {
"example": "About",
"type": "string"
}
},
"type": "object"
}
]
},
"type": "array"
}
}
},
"description": "A list of sections of the folder"
},
"Session": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Session"
}
]
}
}
},
"description": "A session"
},
"SocialContract": {
"content": {
"application/json": {
"schema": {
"items": {
"allOf": [
{
"$ref": "#/components/schemas/SocialContract"
}
]
},
"type": "array"
}
}
},
"description": "A list of social contracts of the folder employee"
},
"SocialDeclaration": {
"content": {
"application/json": {
"schema": {
"items": {
"allOf": [
{
"$ref": "#/components/schemas/SocialDeclaration"
}
]
},
"type": "array"
}
}
},
"description": "A list of social declarations"
},
"SocialRegime": {
"content": {
"application/json": {
"schema": {
"items": {
"allOf": [
{
"$ref": "#/components/schemas/SocialRegime"
}
]
},
"type": "array"
}
}
},
"description": "A list of social regime folders"
},
"Space": {
"content": {
"application/json": {
"schema": {
"items": {
"properties": {
"Id": {
"example": "P12345",
"type": "string"
},
"ModificationDate": {
"example": "20190325125042",
"type": "string"
},
"Name": {
"example": "Mon Entreprise",
"type": "string"
},
"RegistrationNumber": {
"example": "123456",
"type": "string"
},
"Type": {
"enum": [
"private",
"enterprise",
"company",
"association"
],
"example": "company",
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
}
},
"description": "A list of Spaces"
},
"SpaceMenus": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"properties": {
"Menus": {
"items": {
"properties": {
"Class": {
"example": "Customer",
"type": "string"
},
"Id": {
"example": "/F/Piozhgzihgiahgoi",
"type": "string"
},
"Name": {
"example": "My Folder",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"SpaceId": {
"example": "PFHIAH4684",
"type": "string"
},
"SpaceName": {
"example": "Mon entreprise",
"type": "string"
}
},
"type": "object"
}
]
}
}
},
"description": "menus tree of the hub/box"
},
"SpaceMenusAll": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"properties": {
"BusinessGroup": {
"properties": {
"Id": {
"example": "Piozhgzihgiahgoi",
"type": "string"
},
"Name": {
"example": "My BusinessGroup",
"type": "string"
}
},
"type": "object"
},
"Menus": {
"items": {
"properties": {
"Class": {
"example": "Customer",
"type": "string"
},
"Id": {
"example": "/F/Piozhgzihgiahgoi",
"type": "string"
},
"Name": {
"example": "My Folder",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"SpaceId": {
"example": "PFHIAH4684",
"type": "string"
},
"SpaceName": {
"example": "Mon entreprise",
"type": "string"
}
},
"type": "object"
}
]
}
}
},
"description": "menus tree of the hub"
},
"SpaceOneMenus": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"properties": {
"Label": {
"example": "Dossier banque",
"type": "string"
},
"MenuId": {
"example": "PFHIAH4684",
"type": "string"
},
"Pictogram": {
"example": "KPFJAPFJKA",
"type": "string"
},
"SubMenus": {
"items": {
"properties": {
"Label": {
"example": "Dossier banque",
"type": "string"
},
"MenuId": {
"example": "/F/Piozhgzihgiahgoi",
"type": "string"
},
"Pictogram": {
"example": "KPFJAPFJKA",
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
]
}
}
},
"description": "menu tree of the hub/box"
},
"SpacesInvoicing": {
"content": {
"application/json": {
"schema": {
"items": {
"allOf": [
{
"$ref": "#/components/schemas/SpacesInvoicing"
}
]
},
"type": "array"
}
}
},
"description": "A list of csv invoicings"
},
"Status": {
"content": {
"application/json": {
"schema": {
"items": {
"allOf": [
{
"properties": {
"Code": {
"example": "COD",
"type": "string"
},
"Comment": {
"example": "my first code",
"type": "string"
},
"Label": {
"example": "code 1",
"type": "string"
}
},
"type": "object"
}
]
},
"type": "array"
}
}
},
"description": "A list of status of"
},
"SumInvoice": {
"content": {
"application/json": {
"schema": {
"properties": {
"BeforeVAT": {
"example": 1229.5,
"type": "number"
},
"InclVAT": {
"example": 1329.5,
"type": "number"
},
"VAT": {
"example": 29.5,
"type": "number"
}
},
"type": "object"
}
}
},
"description": "Sum of the invoices of the folder"
},
"TaxContract": {
"content": {
"application/json": {
"schema": {
"items": {
"allOf": [
{
"$ref": "#/components/schemas/TaxContract"
},
{
"properties": {
"Id": {
"example": "P45IHFA",
"type": "string"
}
},
"type": "object"
}
]
},
"type": "array"
}
}
},
"description": "A list of tax contracts"
},
"Triggers": {
"content": {
"application/json": {
"schema": {
"items": {
"allOf": [
{
"$ref": "#/components/schemas/Trigger"
}
]
},
"type": "array"
}
}
},
"description": "A list of triggers"
},
"VATDeclaration": {
"content": {
"application/json": {
"schema": {
"items": {
"allOf": [
{
"$ref": "#/components/schemas/VATDeclaration"
}
]
},
"type": "array"
}
}
},
"description": "A list of VAT declarations"
}
},
"schemas": {
"Access": {
"properties": {
"Id": {
"example": "T45IHFA",
"type": "string"
},
"Right": {
"enum": [
"write",
"read",
"none"
],
"example": "write",
"type": "string"
}
},
"type": "object"
},
"Accounting": {
"allOf": [
{
"$ref": "#/components/schemas/Document"
},
{
"properties": {
"Accounting": {
"properties": {
"AccountedOn": {
"example": "20181202",
"type": "string"
},
"Workbook": {
"enum": [
"customer",
"provider",
"bank",
"cashWoucher",
"fiscal",
"insurance",
"social",
"other",
"permanent"
],
"example": "fiscal",
"type": "string"
},
"YearMonth": {
"example": 201802,
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
]
},
"AccountingYear": {
"allOf": [
{
"$ref": "#/components/schemas/Folder"
},
{
"properties": {
"Comment": {
"example": "ogm of the company",
"type": "string"
},
"End": {
"example": "20181231",
"type": "string"
},
"NetIncome": {
"example": 52634.36,
"type": "number"
},
"NetPosition": {
"example": 14580.36,
"type": "number"
},
"Start": {
"example": "20171231",
"type": "string"
},
"Tax": {
"example": 45698.36,
"type": "number"
},
"TaxableIncome": {
"example": 869523.36,
"type": "number"
},
"Turnover": {
"example": 1025.36,
"type": "number"
}
},
"type": "object"
}
]
},
"Bank": {
"allOf": [
{
"$ref": "#/components/schemas/Contract"
},
{
"properties": {
"ContractReference": {
"example": "13587449420F",
"type": "string"
},
"Designation": {
"example": "banque prêt entreprise",
"type": "string"
}
},
"type": "object"
}
]
},
"BankStatement": {
"allOf": [
{
"$ref": "#/components/schemas/Document"
},
{
"properties": {
"AccountedOn": {
"example": 20201231,
"type": "string"
},
"Balance": {
"example": 1352.63,
"format": "number",
"type": "number"
},
"Number": {
"example": "10015848",
"format": "string",
"type": "number"
},
"StatementDate": {
"example": "20160801",
"type": "string"
}
},
"type": "object"
}
]
},
"BusinessGroup": {
"properties": {
"Id": {
"example": "P45IHFA",
"type": "string"
},
"ModificationDate": {
"example": "20190325125042",
"type": "string"
},
"Name": {
"example": "Client Durand",
"type": "string"
}
},
"type": "object"
},
"CallForDocument": {
"properties": {
"Categories": {
"example": [
"ID",
"Invoices"
],
"items": {
"type": "string"
},
"type": "array"
},
"ClientManagement": {
"enum": [
"no",
"manager",
"adn"
],
"type": "string"
},
"Comment": {
"example": "first invitation",
"type": "string"
},
"Contact": {
"example": "Dupond",
"type": "string"
},
"IsAdmin": {
"example": true,
"type": "boolean"
},
"Message": {
"example": "<p> Bienvenue dans l'espace de l'entreprise SOCIETE </p>",
"type": "string"
},
"Player": {
"enum": [
"guest",
"owner",
"manager",
"assistant",
"collaborator"
],
"example": "guest",
"type": "string"
},
"PlayerEnd": {
"example": "20190601",
"type": "string"
},
"Signature": {
"example": "cordialement",
"type": "string"
},
"Subject": {
"example": "invitation sur le coffre",
"type": "string"
}
},
"type": "object"
},
"CollectiveDecision": {
"allOf": [
{
"$ref": "#/components/schemas/Folder"
},
{
"properties": {
"Comment": {
"example": "ogm of the company",
"type": "string"
},
"Date": {
"example": "20180202",
"type": "string"
},
"DividendDistributions": {
"example": 1025.36,
"type": "number"
},
"DividendDistributionsDate": {
"example": "20180203",
"type": "string"
},
"Event": {
"enum": [
"EGM",
"CGM",
"OGM",
"ConstituentAssembly",
"SolePartner",
"OtherEvent",
"Other",
"Office",
"ExecutiveCommittee",
"Consulting",
"Board",
"PartnersMeeting"
],
"example": "EGM",
"type": "string"
}
},
"type": "object"
}
]
},
"CompanyEntity": {
"allOf": [
{
"$ref": "#/components/schemas/LegalEntity"
},
{
"properties": {
"ApeCode": {
"example": "420F",
"type": "string"
},
"LegalName": {
"example": "Mon entreprise Dupond",
"type": "string"
},
"LegalStatut": {
"example": "SAS",
"type": "string"
},
"RegistrationNumber": {
"example": "236542158",
"type": "string"
},
"Type": {
"example": "EPT",
"type": "string"
},
"VatNumber": {
"example": "46546847864",
"type": "string"
}
},
"type": "object"
}
]
},
"Contract": {
"allOf": [
{
"$ref": "#/components/schemas/Folder"
},
{
"properties": {
"Comment": {
"example": "pieces company",
"type": "string"
},
"End": {
"example": "20190101",
"type": "string"
},
"Start": {
"example": "20180630",
"type": "string"
}
},
"type": "object"
}
]
},
"Contractual-Relationship": {
"allOf": [
{
"$ref": "#/components/schemas/Contract"
},
{
"properties": {
"ContractReference": {
"example": "13587449420F",
"type": "string"
},
"Designation": {
"example": "autre contrat",
"type": "string"
}
},
"type": "object"
}
]
},
"ContractualDocument": {
"allOf": [
{
"$ref": "#/components/schemas/Document"
},
{
"properties": {
"Amount": {
"example": "1001.36",
"type": "string"
},
"Designation": {
"example": "contrat client",
"type": "string"
},
"Reference": {
"example": "151465AFHIA",
"type": "string"
},
"StartDate": {
"example": "20181128",
"type": "string"
},
"Type": {
"enum": [
"contract",
"engagement-letter",
"amendment",
"purchase-order",
"delivery-order",
"quotation",
"other"
],
"example": "quotation",
"type": "string"
}
},
"type": "object"
}
]
},
"CorporateTaxDeclaration": {
"allOf": [
{
"$ref": "#/components/schemas/Document"
},
{
"properties": {
"Amount": {
"example": 132.63,
"format": "float",
"type": "number"
},
"DeclarationDate": {
"example": "20160801",
"type": "string"
},
"Order": {
"enum": [
"1st advance",
"2nd advance",
"3rd advance",
"4th advance",
"regularization"
],
"example": "1st advance",
"type": "string"
},
"Rate": {
"example": 10.63,
"format": "float",
"type": "number"
},
"TaxBase": {
"example": 123.36,
"format": "float",
"type": "number"
}
},
"type": "object"
}
]
},
"Customer": {
"allOf": [
{
"$ref": "#/components/schemas/Contract"
},
{
"properties": {
"CustomerNumber": {
"example": "13587449420F",
"type": "string"
},
"Designation": {
"example": "client pièces détachées",
"type": "string"
}
},
"type": "object"
}
]
},
"Document": {
"properties": {
"Author": {
"example": "Antoine Dupond",
"type": "string"
},
"Class": {
"items": {
"example": [
"Contract",
"Invoice"
],
"type": "string"
},
"type": "array"
},
"Code": {
"example": "COD",
"type": "string"
},
"Comment": {
"example": "my document",
"type": "string"
},
"Date": {
"example": "20161203",
"type": "string"
},
"Extension": {
"example": "pdf",
"type": "string"
},
"FolderDate": {
"example": "20161203020506",
"type": "string"
},
"Id": {
"example": "P45IHFA",
"type": "string"
},
"Title": {
"example": "Facture décembre",
"type": "string"
}
},
"type": "object"
},
"Employee": {
"allOf": [
{
"$ref": "#/components/schemas/Contract"
},
{
"properties": {
"ContractType": {
"example": "01",
"type": "string"
},
"EmployeeNumber": {
"example": "13587FAZCD420F",
"type": "string"
},
"Function": {
"example": "commercial",
"type": "string"
},
"PostalMail": {
"example": true,
"type": "boolean"
},
"SSNumber": {
"example": "1542012365985215",
"type": "string"
}
},
"type": "object"
}
]
},
"Employer": {
"allOf": [
{
"$ref": "#/components/schemas/Contract"
},
{
"properties": {
"EmployeeNumber": {
"example": "13587FAZCD420F",
"type": "string"
},
"Function": {
"example": "commercial",
"type": "string"
},
"SSNumber": {
"example": "1542012365985215",
"type": "string"
}
},
"type": "object"
}
]
},
"Exchange": {
"allOf": [
{
"$ref": "#/components/schemas/Folder"
}
]
},
"ExpenseProof": {
"allOf": [
{
"$ref": "#/components/schemas/Document"
},
{
"properties": {
"Account": {
"enum": [
"CAB",
"IKM",
"PRK",
"TXI",
"VOY",
"PTT",
"FHR",
"DIV",
"RES"
],
"example": "CAB",
"type": "string"
},
"ArchivalDate": {
"example": 20211231,
"type": "string"
},
"ExpenseDate": {
"example": "20200202",
"type": "string"
},
"InclVAT": {
"example": 1000,
"type": "number"
},
"Provider": {
"example": "G7",
"type": "string"
},
"Reason": {
"example": "taxi",
"type": "string"
},
"Status": {
"enum": [
"R",
"V",
"W"
],
"example": "R",
"type": "string"
},
"VAT": {
"example": 19.5,
"type": "number"
}
},
"type": "object"
}
]
},
"ExpenseReport": {
"allOf": [
{
"$ref": "#/components/schemas/Document"
},
{
"properties": {
"BeforeVAT": {
"example": 1000,
"type": "number"
},
"ExpenseDate": {
"example": "20200202",
"type": "string"
},
"InclVAT": {
"example": 1200,
"type": "number"
},
"ProcessingDate": {
"example": "20200203",
"type": "string"
},
"VAT": {
"example": 19.5,
"type": "number"
}
},
"type": "object"
}
]
},
"Folder": {
"properties": {
"About": {
"example": "<b> Mon premier dossier </b>",
"type": "string"
},
"ArchivalDate": {
"example": "20160203",
"type": "string"
},
"Class": {
"example": "social",
"type": "string"
},
"Home": {
"example": "yes",
"type": "boolean"
},
"Id": {
"example": "T45IHFA",
"type": "string"
},
"Keywords": {
"example": [
"paris",
"comptabilité"
],
"items": {
"type": "string"
},
"type": "array"
},
"Level": {
"enum": [
"confidential",
"regular",
"public"
],
"example": "confidential",
"type": "string"
},
"ModificationDate": {
"example": "20190325125042",
"type": "string"
},
"Name": {
"example": "Dupond",
"type": "string"
},
"Parent": {
"example": "TIOPHNA",
"type": "string"
}
},
"type": "object"
},
"FollowUp": {
"allOf": [
{
"$ref": "#/components/schemas/Folder"
},
{
"properties": {
"ClientManagement": {
"enum": [
"manager",
"adn",
"null"
],
"type": "string"
},
"Invitation": {
"properties": {
"Comment": {
"example": "salarié invité",
"type": "string"
},
"PlayerEnd": {
"example": "20190203",
"type": "string"
},
"Status": {
"enum": [
null,
"on",
"refused",
"accepted",
"finished",
"expired",
"waiting for validation"
],
"example": "accepted",
"type": "string"
}
},
"type": "object"
},
"Player": {
"enum": [
"guest",
"manager",
"collaborator",
"owner",
"assistant"
],
"example": "manager",
"type": "string"
}
},
"type": "object"
}
]
},
"Group": {
"properties": {
"EndDate": {
"example": "20160203",
"type": "string"
},
"Id": {
"example": "T45IHFA",
"type": "string"
},
"Name": {
"example": "RH",
"type": "string"
}
}
},
"GuestInSpace": {
"properties": {
"ClientManagement": {
"enum": [
"no",
"manager",
"adn"
],
"type": "string"
},
"Comment": {
"example": "first invitation",
"type": "string"
},
"Contact": {
"example": "Dupond",
"type": "string"
},
"Folders": {
"items": {
"properties": {
"Id": {
"example": "PK8481482",
"type": "string"
},
"Right": {
"enum": [
"read",
"write"
],
"example": "read",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"GroupIds": {
"items": {
"example": [
"PJFIA84",
"PHAJHFJHA"
],
"type": "string"
},
"type": "array"
},
"IsAdmin": {
"example": true,
"type": "boolean"
},
"MemberId": {
"example": "PAIHIHFA79TFA",
"type": "string"
},
"Message": {
"example": "<p> Bienvenue dans l'espace de l'entreprise SOCIETE </p>",
"type": "string"
},
"Player": {
"enum": [
"guest",
"owner",
"manager",
"assistant",
"collaborator"
],
"example": "guest",
"type": "string"
},
"PlayerEnd": {
"example": "20190601",
"type": "string"
},
"Signature": {
"example": "cordialement",
"type": "string"
},
"Subject": {
"example": "invitation sur le coffre",
"type": "string"
}
},
"type": "object"
},
"Insurance": {
"allOf": [
{
"$ref": "#/components/schemas/Contract"
},
{
"properties": {
"CustomerNumber": {
"example": "13587449420F",
"type": "string"
},
"Designation": {
"example": "assurance civile",
"type": "string"
},
"PolicyNumber": {
"example": "13587449420F",
"type": "string"
}
},
"type": "object"
}
]
},
"Invitation": {
"properties": {
"ClientManagement": {
"enum": [
"no",
"manager",
"adn"
],
"type": "string"
},
"CodeMethod": {
"oneOf": [
{
"properties": {
"Code": {
"example": "1234",
"type": "string"
},
"Type": {
"enum": [
"manual"
],
"type": "string"
}
},
"type": "object"
},
{
"properties": {
"Month": {
"type": "string"
},
"Type": {
"enum": [
"payslip"
],
"type": "string"
}
},
"type": "object"
},
{
"properties": {
"Type": {
"enum": [
"SMS"
],
"type": "string"
}
},
"type": "object"
}
]
},
"EmployeeAccess": {
"example": true,
"type": "boolean"
},
"Folders": {
"items": {
"properties": {
"Id": {
"example": "PK8481482",
"type": "string"
},
"Name": {
"example": "Social",
"type": "string"
},
"Right": {
"enum": [
"read",
"write"
],
"example": "read",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"GroupIds": {
"items": {
"example": [
"PJFIA84",
"PHAJHFJHA"
],
"type": "string"
},
"type": "array"
},
"Groups": {
"items": {
"properties": {
"EndDate": {
"example": "20230202",
"type": "string"
},
"Id": {
"example": "PK8481482",
"type": "string"
},
"Name": {
"example": "Mon Groupe",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"IsAdmin": {
"example": true,
"type": "boolean"
},
"LinkMethod": {
"properties": {
"Type": {
"enum": [
"Postal",
"Email"
],
"example": "Postal",
"type": "string"
}
},
"type": "object"
},
"Player": {
"enum": [
"guest",
"owner",
"manager",
"assistant",
"collaborator"
],
"example": "guest",
"type": "string"
},
"PlayerEnd": {
"example": "20190601",
"type": "string"
},
"Status": {
"enum": [
"sent",
"accepted",
"refused",
"expired",
"finished",
"waiting for validation",
"waiting for password and userid",
"waiting for login",
"not sent",
"waiting for invitation"
],
"example": "accepted",
"type": "string"
}
},
"type": "object"
},
"InvitationPerson": {
"properties": {
"PersonId": {
"example": "PAIHIHFA79TFA",
"type": "string"
}
},
"type": "object"
},
"Invoice": {
"allOf": [
{
"$ref": "#/components/schemas/Document"
},
{
"properties": {
"AccountedOn": {
"example": 20201231,
"type": "string"
},
"BeforeVAT": {
"example": 1000,
"type": "number"
},
"DueDate": {
"example": 20190130,
"type": "string"
},
"InclVAT": {
"example": 1200,
"type": "number"
},
"InvoiceDate": {
"example": "20200202",
"type": "string"
},
"Number": {
"example": "036459879874",
"type": "string"
},
"PaymentDate": {
"example": 20190131,
"type": "string"
},
"Type": {
"enum": [
"commercial-invoice",
"credit-note",
"amending-invoice",
"self-billing",
"credit-self-billing",
"down-payment-invoice",
"informations-invoice"
],
"example": "commercial-invoice",
"type": "string"
},
"VAT": {
"example": 19.5,
"type": "number"
}
},
"type": "object"
}
]
},
"Legal": {
"properties": {
"IdentificationNumber": {
"example": "548",
"type": "string"
},
"RegistrationDate": {
"example": "20190325",
"type": "string"
},
"RegistrationNumber": {
"example": "123456",
"type": "string"
},
"VATNumber": {
"example": "123",
"type": "string"
}
},
"type": "object"
},
"LegalEntity": {
"properties": {
"ArchivalDate": {
"example": "20160203",
"type": "string"
},
"Comment": {
"example": "my brother",
"type": "string"
},
"Id": {
"example": "T45IHFA",
"type": "string"
},
"ModificationDate": {
"example": "20190325125042",
"type": "string"
},
"Name": {
"example": "Dupond",
"type": "string"
}
},
"type": "object"
},
"Loan": {
"allOf": [
{
"$ref": "#/components/schemas/Contract"
},
{
"properties": {
"Amount": {
"example": 1000,
"format": "float",
"type": "number"
},
"Category": {
"enum": [
"debt spreading",
"bank loan",
"current account",
"overdraft agreement",
"leasing",
"obligation"
],
"example": "debt spreading",
"type": "string"
},
"Designation": {
"example": "emprunt entreprise",
"type": "string"
},
"DueAmount": {
"example": 1000.6,
"format": "float",
"type": "number"
},
"MonthsNumber": {
"example": 12,
"type": "number"
},
"Rate": {
"example": 2.5,
"format": "float",
"type": "number"
},
"TotalCost": {
"example": 10200,
"format": "float",
"type": "number"
}
},
"type": "object"
}
]
},
"Message": {
"properties": {
"Author": {
"example": "PKPOFJA7655TFA",
"type": "string"
},
"Id": {
"example": "T45IHFA",
"type": "string"
},
"Level": {
"enum": [
"confidential",
"regular"
],
"example": "confidential",
"type": "string"
},
"MessageDate": {
"example": "20160203",
"type": "string"
},
"ModificationAuthor": {
"example": "P8Y80FAVUV24",
"type": "string"
},
"ModificationDate": {
"example": "20190325125042",
"type": "string"
},
"Text": {
"example": "<p> hello world </p>",
"type": "string"
}
},
"type": "object"
},
"ModifyCollect": {
"properties": {
"Categories": {
"items": {
"example": [
"ID",
"Invoices"
],
"type": "string"
},
"type": "array"
},
"ClientManagement": {
"enum": [
"no",
"manager",
"adn"
],
"type": "string"
},
"IsAdmin": {
"example": true,
"type": "boolean"
},
"Player": {
"enum": [
"guest",
"owner",
"manager",
"assistant",
"collaborator"
],
"example": "guest",
"type": "string"
},
"PlayerEnd": {
"example": "20190601",
"type": "string"
}
},
"type": "object"
},
"ModifyInvitation": {
"properties": {
"ClientManagement": {
"enum": [
"no",
"manager",
"adn"
],
"type": "string"
},
"Folders": {
"items": {
"properties": {
"Id": {
"example": "PK8481482",
"type": "string"
},
"Right": {
"enum": [
"read",
"write"
],
"example": "read",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"GroupIds": {
"items": {
"example": [
"PJFIA84",
"PHAJHFJHA"
],
"type": "string"
},
"type": "array"
},
"IsAdmin": {
"example": true,
"type": "boolean"
},
"Player": {
"enum": [
"guest",
"owner",
"manager",
"assistant",
"collaborator"
],
"example": "guest",
"type": "string"
},
"PlayerEnd": {
"example": "20190601",
"type": "string"
}
},
"type": "object"
},
"OtherTax": {
"allOf": [
{
"$ref": "#/components/schemas/Document"
},
{
"properties": {
"Amount": {
"example": 132.63,
"format": "float",
"type": "number"
},
"DeclarationDate": {
"example": "20160801",
"type": "string"
},
"Reference": {
"example": "décla CFE",
"type": "string"
}
},
"type": "object"
}
]
},
"Password": {
"properties": {
"Comment": {
"example": "mon compte google",
"type": "string"
},
"Designation": {
"example": "compte google",
"type": "string"
},
"Ident": {
"example": "test",
"type": "string"
},
"Link": {
"example": "https://www.google.fr",
"type": "string"
},
"Password": {
"example": "azerty",
"type": "string"
}
},
"type": "object"
},
"PaySlip": {
"allOf": [
{
"$ref": "#/components/schemas/Document"
},
{
"properties": {
"Begin": {
"example": "20160801",
"type": "string"
},
"EmployeeContributions": {
"example": 2000.5,
"format": "float",
"type": "number"
},
"EmployerContributions": {
"example": 400.5,
"format": "float",
"type": "number"
},
"End": {
"example": "20160831",
"type": "string"
},
"FixedGrossAmount": {
"example": 1352.63,
"format": "float",
"type": "number"
},
"NetAmount": {
"example": 1005.63,
"format": "float",
"type": "number"
},
"TotalGrossAmount": {
"example": 1548.63,
"format": "float",
"type": "number"
},
"Vacation": {
"example": 20.5,
"format": "float",
"type": "number"
},
"VariableGrossAmount": {
"example": 132.63,
"format": "float",
"type": "number"
}
},
"type": "object"
}
]
},
"Payroll": {
"allOf": [
{
"$ref": "#/components/schemas/Document"
},
{
"properties": {
"Begin": {
"example": "20160801",
"type": "string"
},
"EmployeeContributions": {
"example": 1352.63,
"format": "float",
"type": "number"
},
"EmployerContributions": {
"example": 132.63,
"format": "float",
"type": "number"
},
"End": {
"example": "20160831",
"type": "string"
},
"NetAmount": {
"example": 1005.63,
"format": "float",
"type": "number"
},
"TotalGrossAmount": {
"example": 1548.63,
"format": "float",
"type": "number"
}
},
"type": "object"
}
]
},
"Person": {
"allOf": [
{
"$ref": "#/components/schemas/LegalEntity"
},
{
"properties": {
"Address": {
"properties": {
"City": {
"example": "Paris",
"type": "string"
},
"Complement": {
"example": "batiment A",
"type": "string"
},
"Country": {
"example": "France",
"type": "string"
},
"Street": {
"example": "2, rue du chateau",
"type": "string"
},
"ZipCode": {
"example": "75001",
"type": "string"
}
},
"type": "object"
},
"Birth": {
"properties": {
"Date": {
"example": 19671231,
"type": "integer"
},
"Place": {
"example": "Lille",
"type": "string"
}
},
"type": "object"
},
"Email": {
"example": "bertrand@monmail.com",
"type": "string"
},
"FirstName": {
"example": "Bertrand",
"type": "string"
},
"Function": {
"example": [
"employee",
"provider"
],
"items": {
"type": "string"
},
"type": "array"
},
"MemberId": {
"example": "P1A6FD090A",
"type": "string"
},
"Mobile": {
"example": "+33606060606",
"type": "string"
},
"Sex": {
"enum": [
"male",
"female"
],
"example": "male",
"type": "string"
},
"Validated": {
"enum": [
"true",
"false"
],
"example": "true",
"type": "string"
}
},
"type": "object"
}
]
},
"Portfolio": {
"allOf": [
{
"$ref": "#/components/schemas/Folder"
},
{
"properties": {
"Designation": {
"example": "My Portfolio",
"type": "string"
}
},
"type": "object"
}
]
},
"ProfessionalProperties": {
"allOf": [
{
"$ref": "#/components/schemas/Folder"
},
{
"properties": {
"Comment": {
"example": "Peugeot Lyon",
"type": "string"
},
"DateIn": {
"example": "20201802",
"type": "string"
},
"DateOut": {
"example": "20201802",
"type": "string"
},
"Designation": {
"example": "peugeot siège",
"type": "string"
},
"Value": {
"example": 1500.23,
"type": "number"
}
},
"type": "object"
}
]
},
"ProfessionalVehicle": {
"allOf": [
{
"$ref": "#/components/schemas/ProfessionalProperties"
},
{
"properties": {
"Brand": {
"example": "Renault",
"type": "string"
},
"CompanyTax": {
"example": true,
"type": "boolean"
},
"Model": {
"example": "Clio",
"type": "string"
},
"RegistrationDate": {
"example": "20181231",
"type": "string"
},
"RegistrationNumber": {
"example": "AA001AA",
"type": "string"
},
"Type": {
"example": "car",
"type": "string"
}
},
"type": "object"
}
]
},
"Provider": {
"allOf": [
{
"$ref": "#/components/schemas/Contract"
},
{
"properties": {
"About": {
"example": "<b> Mon premier fournisseur </b>",
"type": "string"
},
"Designation": {
"example": "fournisseur pièces détachées",
"type": "string"
},
"ProviderNumber": {
"example": "13587449420F",
"type": "string"
}
},
"type": "object"
}
]
},
"Section": {
"properties": {
"Keywords": {
"items": {
"example": [
"paris",
"comptabilité"
],
"type": "string"
},
"type": "array"
},
"Name": {
"example": "Journal",
"type": "string"
},
"State": {
"enum": [
"folded",
"unfolded",
"hidden"
],
"example": "folded",
"type": "string"
},
"Type": {
"enum": [
"about",
"notes",
"documents",
"tasks",
"codes",
"subfolders",
"contacts",
"any other specific type"
],
"example": "notes",
"type": "string"
}
},
"type": "object"
},
"Session": {
"properties": {
"MemberId": {
"example": "PIFIAJHNFA972BUBF",
"type": "string"
},
"Scope": {
"example": "collaborator",
"type": "string"
}
},
"type": "object"
},
"SocialContract": {
"allOf": [
{
"$ref": "#/components/schemas/Document"
},
{
"properties": {
"ContractDate": {
"example": "20190202",
"type": "string"
},
"ContractDuration": {
"example": "6 mois",
"type": "string"
},
"ContractualChange": {
"example": "augmentation",
"type": "string"
},
"Position": {
"example": "cadre",
"type": "string"
},
"WageDevelopments": {
"example": 1548.63,
"format": "float",
"type": "number"
}
},
"type": "object"
}
]
},
"SocialDeclaration": {
"allOf": [
{
"$ref": "#/components/schemas/Document"
},
{
"properties": {
"Amount": {
"example": 132.63,
"format": "float",
"type": "number"
},
"DeclarationDate": {
"example": "20160801",
"type": "string"
}
},
"type": "object"
}
]
},
"SocialRegime": {
"allOf": [
{
"$ref": "#/components/schemas/Contract"
},
{
"properties": {
"About": {
"example": "<b> Mon premier fournisseur </b>",
"type": "string"
},
"Designation": {
"example": "fournisseur pièces détachées",
"type": "string"
},
"Periodicity": {
"enum": [
"monthly",
"quarterly",
"half-yearly",
"annual",
"null"
],
"example": "monthly",
"type": "string"
},
"Type": {
"enum": [
"mandatory",
"optional",
"null"
],
"example": "mandatory",
"type": "string"
}
},
"type": "object"
}
]
},
"Space": {
"properties": {
"Id": {
"example": "P12345",
"type": "string"
},
"Logo": {
"properties": {
"Content64Encoded": {
"example": "PHNUOAFAFOPFAF",
"type": "string"
},
"Extension": {
"example": "png",
"type": "string"
}
},
"type": "object"
},
"ModificationDate": {
"example": "20190325125042",
"type": "string"
},
"Name": {
"example": "Mon Entreprise",
"type": "string"
},
"Type": {
"enum": [
"private",
"enterprise",
"company",
"association"
],
"example": "company",
"type": "string"
}
},
"type": "object"
},
"SpacesInvoicing": {
"allOf": [
{
"$ref": "#/components/schemas/Document"
},
{
"properties": {
"InvoiceNumber": {
"example": "A123",
"type": "string"
}
},
"type": "object"
}
]
},
"TaxContract": {
"allOf": [
{
"$ref": "#/components/schemas/Folder"
},
{
"properties": {
"Comment": {
"example": "ogm of the company",
"type": "string"
},
"Designation": {
"example": "année 2019",
"type": "string"
},
"End": {
"example": "20181231",
"type": "string"
},
"Start": {
"example": "20171231",
"type": "string"
}
},
"type": "object"
}
]
},
"Trigger": {
"properties": {
"Date": {
"type": "string"
},
"Event": {
"enum": [
"person",
"collect",
"document"
],
"type": "string"
}
},
"type": "object"
},
"VATDeclaration": {
"allOf": [
{
"$ref": "#/components/schemas/Document"
},
{
"properties": {
"Begin": {
"example": "20160801",
"type": "string"
},
"CollectedVAT": {
"example": 1548.63,
"format": "float",
"type": "number"
},
"CreditVAT": {
"example": 400.5,
"format": "float",
"type": "number"
},
"DeductibleVAT": {
"example": 20.5,
"format": "float",
"type": "number"
},
"End": {
"example": "20160831",
"type": "string"
},
"ExemptTurnover": {
"example": 132.63,
"format": "float",
"type": "number"
},
"Number": {
"example": "153126",
"type": "string"
},
"PayableVAT": {
"example": 2000.5,
"format": "float",
"type": "number"
},
"TaxableTurnover": {
"example": 1352.63,
"format": "float",
"type": "number"
}
},
"type": "object"
}
]
}
},
"securitySchemes": {
"gma_auth": {
"flows": {
"authorizationCode": {
"authorizationUrl": "https://sandbox.gerermesaffaires.com/openid/v1/authorize",
"refreshUrl": "https://sandbox.gerermesaffaires.com/openid/v1/token",
"scopes": {
"box": "*Originally missing*",
"collaborator": "blue access",
"hub": "*Originally missing*",
"owner": "green access"
},
"tokenUrl": "https://sandbox.gerermesaffaires.com/openid/v1/token"
},
"clientCredentials": {
"refreshUrl": "https://sandbox.gerermesaffaires.com/openid/v1/token",
"scopes": {
"box": "*Originally missing*",
"hub": "*Originally missing*",
"robot": "server access"
},
"tokenUrl": "https://sandbox.gerermesaffaires.com/openid/v1/token"
}
},
"type": "oauth2"
}
}
}
}