GererMesAffaires {REST:API}
The GererMesAffaires REST API provides a comprehensive set of endpoints for managing business groups and their spaces, including legal data, company entities, persons, groups, documents, payslips, menus and configuration settings, allowing creation, retrieval, updating, and deletion of these resources.
Admin: update documentationPATCH
/spaces/{id}/legal
Modify legal information of a Space (except private)
id ( path , required ) — Id of the spaceGET
/spaces/{id}/logo
Returns a space with the logo
id ( path , required ) — Id of the spaceGET
/spaces/{id}/status
Returns all status of the space
id ( path , required ) — Id of the spacePOST
/spaces/{id}/status
Replace or Add a status
id ( path , required ) — Id of the spaceGET
/hub/business-groups/{Id}/menus
Returns predefined folders and workbooks of the Hub for all the spaces of the business group
Id ( path , required ) — Id of the business groupPOST
/hub/documents
Add a document (this document is analyzed to be saved in the correct folder and correct space)
GET
/hub/menus
Returns predefined folders and workbooks of the Hub for all the spaces
GET
/hub/menus/all
Returns predefined folders and workbooks of the Hub for all the spaces and customer spaces
POST
/hub/payslips
Add a payslip (this document is analyzed to be saved in the correct folder and correct space)
POST
/hub/spaces/{spaceId}/documents
Add a document in a space (this document is analyzed to be saved in the correct folder)
spaceId ( path , required ) — Id of the spaceGET
/hub/spaces/{spaceId}/menus
Returns predefined folders and workbooks of the Hub for the space
spaceId ( path , required ) — Id of the spacePOST
/hub/spaces/{spaceId}/payslips
Add a payslip in a space (this document is analyzed to be saved in the correct folder)
spaceId ( path , required ) — Id of the spaceGET
/menus
Returns predefined entries
POST
/menus/{menuId}/documents
add a document to the target menuId
menuId ( path , required ) — Id of the spaceGET
/box/menus
Returns predefined folders and workbooks of the Box for all the spaces
GET
/business-groups
Returns a list of groups custom ordered by name
Name ( query ) — Name of the groupPATCH
/business-groups
Modifies an object
POST
/business-groups
Adds a group (only for managers and ADN collaborators)
GET
/business-groups/all
Returns list of groups custom for managers
Name ( query ) — Name of the groupGET
/business-groups/{id}
Returns a group
id ( path , required ) — Id of the groupGET
/business-groups/{id}/spaces
Returns spaces of the business group with id
id ( path , required ) — Id of the groupName ( query ) — Name of the spaceType ( query ) — Type of the spaceRegistrationNumber ( query ) — registration number of the spaceDELETE
/business-groups/{id}/spaces/{spaceId}
Remove a customer space from partner
id ( path , required ) — Id of the group of the customer spacespaceId ( path , required ) — Id of the spacePOST
/business-groups/{id}/spaces/{spaceId}/legal-entities/{personId}/customers/{folderId}/guest-in-space
send an invitation to manager the private space of personId
id ( path , required ) — Id of the groupspaceId ( path , required ) — Id of the company space which contains the customer folderpersonId ( path , required ) — Id of the person customerfolderId ( path , required ) — Id of the folder customerPOST
/business-groups/{id}/spaces/{spaceId}/legal-entities/{personId}/customers/{folderId}/spaces
Add a Space in a group
id ( path , required ) — Id of the groupspaceId ( path , required ) — Id of the company space which contains the customer folderpersonId ( path , required ) — Id of the person customerfolderId ( path , required ) — Id of the folder customerGET
/profile
Returns status of member
Contract ( query ) — to get a contract (if not signed error 404 + html contract)PATCH
/profile
modify infos of profile
POST
/profile
create infos of profile
PATCH
/profile/email
modify email of profile
GET
/profile/id-file
Returns status of member
Contract ( query ) — to get a contract (if not signed error 404 + html contract)PATCH
/profile/mobile
modify mobile of profile
GET
/registration
Returns the method to get the validation code or the link to register after invitation
Code ( query , required ) — Code of the invitationPOST
/registration
complete the invitation
GET
/session
Returns member id of user logged
GET
/spaces
Returns spaces of my group
Name ( query ) — Name of the spaceType ( query ) — Type of the spaceRegistrationNumber ( query ) — registration number of the spacePOST
/spaces
Add a Space in my group
GET
/spaces/all
Returns all spaces
Name ( query ) — Name of the spaceType ( query ) — Type of the spaceDELETE
/spaces/{id}
Delete a Space (only space not delivered to customer)
id ( path , required ) — Id of the spaceGET
/spaces/{id}
Returns a space
id ( path , required ) — Id of the spacePATCH
/spaces/{id}
Modify a Space (except private)
id ( path , required ) — Id of the spaceGET
/spaces/{id}/accounting-year
Returns list of accounting years for the space {id}
id ( path , required ) — Id of the spaceEnd ( query ) — End date of the accounting year (YYYYMM or YYYYMMDD) (range not available)EffectiveDate ( query ) — Effective date inside the accounting year (range not available)POST
/spaces/{id}/accounting-year
Create a accounting year for the space id
id ( path , required ) — Id of the spaceGET
/spaces/{id}/collective-decision
Returns list of collective decisions for the space {id}
id ( path , required ) — Id of the spaceDate ( query ) — Date of the collective decision YYYMMDDEvent ( query ) — Event of the collective decision (see post for the list of events)Range ( query ) — index range of the resultsHasCompanyRegistrationCertificate ( query ) — If true returns only invoices with a CompanyRegistrationCertificateHasStatus ( query ) — If true returns only invoices with a StatusHasSireneRegister ( query ) — If true returns only invoices with a SireneRegisterHasMinutes ( query ) — If true returns only invoices with MinutesPOST
/spaces/{id}/collective-decision
Create a colletive decision for the space id
id ( path , required ) — Id of the spaceGET
/spaces/{id}/company-entities
Returns list of company entities
id ( path , required ) — Id of the spaceName ( query ) — Name of the company entityLegalName ( query ) — Legal name of the company entityRegistrationNumber ( query ) — registration number of the company entityPOST
/spaces/{id}/company-entities
Add a Company Entity in a Space
id ( path , required ) — Id of the spaceGET
/spaces/{id}/company-entities/all
Returns list of company entities even company entities archived
id ( path , required ) — Id of the spaceName ( query ) — Name of the company entityRegistrationNumber ( query ) — registration number of the company entityGET
/spaces/{id}/company-entities/{companyId}
Returns a compay entity
id ( path , required ) — Id of the spacecompanyId ( path , required ) — Id of the company entityPATCH
/spaces/{id}/company-entities/{companyId}
Modify a company entity
id ( path , required ) — Id of the spacecompanyId ( path , required ) — Id of the company entity to modifyGET
/spaces/{id}/company-entities/{personId}/details
Returns all details of a company entity
id ( path , required ) — Id of the spacepersonId ( path , required ) — Id of the company entity to getPOST
/spaces/{id}/company-entities/{personId}/details
Replace or Add a contact detail for a person
id ( path , required ) — Id of the spacepersonId ( path , required ) — Id of the person or memberIdDELETE
/spaces/{id}/company-entities/{personId}/details/{designation}
delete a contact detail for a company entity
id ( path , required ) — Id of the spacepersonId ( path , required ) — Id of the person or memberIddesignation ( path , required ) — designationPOST
/spaces/{id}/documents/download
create an archive with documents
id ( path , required ) — Id of the spaceGET
/spaces/{id}/folders/{folderId}/persons/{memberId}
return the access of a person in a customer contract
id ( path , required ) — Id of the spacememberId ( path , required ) — memberId of the personfolderId ( path , required ) — id of the customer folderPATCH
/spaces/{id}/folders/{folderId}/persons/{memberId}
Add/Modify/Delete a person in a customer contract (except manager)
id ( path , required ) — Id of the spacememberId ( path , required ) — memberId of the personfolderId ( path , required ) — id of the customer folderPATCH
/spaces/{id}/folders/{folderId}/persons/{memberId}/activeaccess
open an access
id ( path , required ) — Id of the spacememberId ( path , required ) — memberId of the personfolderId ( path , required ) — id of the customer folderPATCH
/spaces/{id}/folders/{folderId}/persons/{memberId}/unactiveaccess
close an access
id ( path , required ) — Id of the spacememberId ( path , required ) — memberId of the personfolderId ( path , required ) — id of the customer folderPOST
/spaces/{id}/folders/{folderId}/persons/{personId}/guest-in-space
invite a owner in a space
folderId ( path , required ) — Id of the folder customerpersonId ( path , required ) — Id of the person to invite to his spaceid ( path , required ) — Id of the spaceGET
/spaces/{id}/groups
Returns list of groups
id ( path , required ) — Id of the spaceName ( query ) — Name of the groupsPOST
/spaces/{id}/groups
Add a group in a Space
id ( path , required ) — Id of the spaceGET
/spaces/{id}/groups/all
Returns list of groups even archived of the space
id ( path , required ) — Id of the spaceName ( query ) — Name of the groupGET
/spaces/{id}/groups/{groupId}
Returns a group
id ( path , required ) — Id of the spacegroupId ( path , required ) — Id of the groupPATCH
/spaces/{id}/groups/{groupId}
Modify a group
id ( path , required ) — Id of the spacegroupId ( path , required ) — Id of the group to modifyDELETE
/spaces/{id}/groups/{groupId}/folders/{folderId}
delete access to a folder for a group
id ( path , required ) — Id of the spacegroupId ( path , required ) — Id of the group to modifyfolderId ( path , required ) — Id of the folderPATCH
/spaces/{id}/groups/{groupId}/folders/{folderId}
Add access to a folder for a group
id ( path , required ) — Id of the spacegroupId ( path , required ) — Id of the group to modifyfolderId ( path , required ) — Id of the folderDELETE
/spaces/{id}/groups/{groupId}/persons/{memberId}
Delete a person of a group
id ( path , required ) — Id of the spacegroupId ( path , required ) — Id of the group to modifymemberId ( path , required ) — MemberId of the personPATCH
/spaces/{id}/groups/{groupId}/persons/{memberId}
Add a person to a group
id ( path , required ) — Id of the spacegroupId ( path , required ) — Id of the group to modifymemberId ( path , required ) — MemberId of the personGET
/spaces/{id}/legal
Returns legal information of a space (except private)
id ( path , required ) — Id of the spaceGET
/spaces/{id}/persons
Returns list of persons
id ( path , required ) — Id of the spaceFunction ( query ) — Function of the personRange ( query ) — index range of the resultsName ( query ) — Name of the personValidated ( query ) — Status of the personEmail ( query ) — Email of the personPOST
/spaces/{id}/persons
Add a Person in a Space
id ( path , required ) — Id of the spaceGET
/spaces/{id}/persons/all
Returns list of persons even persons archived
id ( path , required ) — Id of the spaceName ( query ) — Name of the personFunction ( query ) — Function of the personRange ( query ) — index range of the resultsValidated ( query ) — Status of the personEmail ( query ) — Email of the personPATCH
/spaces/{id}/persons/{memberId}/player
Modify the role of a person
id ( path , required ) — Id of the spacememberId ( path , required ) — memberId of the personDELETE
/spaces/{id}/persons/{personId}
delete a person
id ( path , required ) — Id of the spacepersonId ( path , required ) — Id of the person to modify or memberIdGET
/spaces/{id}/persons/{personId}
Returns a person
id ( path , required ) — Id of the spacepersonId ( path , required ) — Id of the person to get or memberIdPATCH
/spaces/{id}/persons/{personId}
Modify a person
id ( path , required ) — Id of the spacepersonId ( path , required ) — Id of the person to modify or memberIdGET
/spaces/{id}/persons/{personId}/details
Returns all details of a person
id ( path , required ) — Id of the spacepersonId ( path , required ) — Id of the person to get or memberIdPOST
/spaces/{id}/persons/{personId}/details
Replace or Add a contact detail for a person
id ( path , required ) — Id of the spacepersonId ( path , required ) — Id of the person or memberIdDELETE
/spaces/{id}/persons/{personId}/details/{designation}
delete a contact detail for a person
id ( path , required ) — Id of the spacepersonId ( path , required ) — Id of the person or memberIddesignation ( path , required ) — designationGET
/spaces/{id}/persons/{personId}/folders
Returns list of folders with exceptionnal access of the person personId
id ( path , required ) — Id of the spacepersonId ( path , required ) — Id of the person to get foldersRange ( query ) — index range of the resultsGET
/spaces/{id}/persons/{personId}/groups
Returns list of groups of the person personId
id ( path , required ) — Id of the spacepersonId ( path , required ) — Id of the person to get groupsGET
/spaces/{id}/persons/{personId}/portfolios
Returns list of portfolios of the person personId
id ( path , required ) — Id of the spacepersonId ( path , required ) — Id of the person to get portfoliosPOST
/spaces/{id}/persons/{personId}/portfolios
Create a portfolio for the person personId
id ( path , required ) — Id of the spacepersonId ( path , required ) — Id of the person who will be the owner of the portfolioPATCH
/spaces/{id}/portfolios/{portfolioId}/persons/{memberId}
Add/Modify/Delete a person in a portfolio (except manager)
id ( path , required ) — Id of the spacememberId ( path , required ) — memberId of the personportfolioId ( path , required ) — id of the portfolioGET
/spaces/{id}/professional-vehicles
Returns list of professionalvehicles for the space {id}
id ( path , required ) — Id of the spaceDesignation ( query ) — designation of the vehiclePOST
/spaces/{id}/professional-vehicles
Create a professional vehicle for the space
id ( path , required ) — Id of the spaceGET
/spaces/{id}/settings/nf203/logs
Returns state of activation of logs
id ( path , required ) — Id of the spacePOST
/spaces/{id}/settings/nf203/logs
Enable/Disable logs
id ( path , required ) — Id of the spaceDELETE
/spaces/{id}/status/{code}
delete a status of the space
id ( path , required ) — Id of the spacecode ( path , required ) — code of the statusGET
/spaces/{id}/tax-contracts
Returns list of tax contracts for the space {id}
id ( path , required ) — Id of the spacePOST
/spaces/{id}/tax-contracts
Create a tax contract for the space
id ( path , required ) — Id of the spaceGET
/spaces/{id}/triggers
Returns list of triggers for the space {id}
id ( path , required ) — Id of the spaceDELETE
/spaces/{id}/triggers/{name}
Deletes a trigger for the space id
id ( path , required ) — Id of the spacename ( path , required ) — trigger namePOST
/spaces/{id}/triggers/{name}
Creates a trigger for the space id
id ( path , required ) — Id of the spacename ( path , required ) — trigger nameDELETE
/spaces/{spaceId}/common-folders/{id}
Delete a common folder
id ( path , required ) — Id of the folderspaceId ( path , required ) — Id of the spacePATCH
/spaces/{spaceId}/common-folders/{id}
Modify a common folder
id ( path , required ) — Id of the folderspaceId ( path , required ) — Id of the spaceGET
/spaces/{spaceId}/company-entities/{id}/follow-ups
Returns folder of the company entity
id ( path , required ) — Id of the company entityspaceId ( path , required ) — Id of the spaceGET
/spaces/{spaceId}/customers
Returns folder with Id and customer data
spaceId ( path , required ) — Id of the spaceCustomerNumber ( query ) — CustomerNumber of the customerWithContractingPartner ( query ) — if present returns infos of the ContractingPartner tooGET
/spaces/{spaceId}/customers/all
Returns folder with Id and customer data (even archived)
spaceId ( path , required ) — Id of the spaceCustomerNumber ( query ) — CustomerNumber of the employeeWithContractingPartner ( query ) — if present returns infos of the ContractingPartner tooGET
/spaces/{spaceId}/documents
Returns documents of the folder
spaceId ( path , required ) — Id of the spaceFullText ( query ) — Text to findRange ( query ) — index range of the resultsClass ( query ) — class of the document to findPATCH
/spaces/{spaceId}/documents/{documentId}
modify a doc
spaceId ( path , required ) — Id of the spacedocumentId ( path , required ) — Id of the documentGET
/spaces/{spaceId}/documents/{documentId}/extend
read the data of a document
documentId ( path , required ) — Id of the documentspaceId ( path , required ) — Id of the spacePOST
/spaces/{spaceId}/documents/{documentId}/extend
Add a data to a document
documentId ( path , required ) — Id of the documentspaceId ( path , required ) — Id of the spaceGET
/spaces/{spaceId}/documents/{documentId}/folders
Returns versions of the document
documentId ( path , required ) — Id of the documentspaceId ( path , required ) — Id of the spacePOST
/spaces/{spaceId}/documents/{documentId}/mailing
send by mail a document
documentId ( path , required ) — Id of the documentspaceId ( path , required ) — Id of the spaceGET
/spaces/{spaceId}/documents/{documentId}/mailingprice
returns the number of pages and the price of the pdf to send by mail
documentId ( path , required ) — Id of the documentspaceId ( path , required ) — Id of the spaceGET
/spaces/{spaceId}/documents/{documentId}/versions
Returns versions of the document
documentId ( path , required ) — Id of the documentspaceId ( path , required ) — Id of the spacePOST
/spaces/{spaceId}/documents/{documentId}/versions
Add a version to a document and set it as current
documentId ( path , required ) — Id of the documentspaceId ( path , required ) — Id of the spaceGET
/spaces/{spaceId}/documents/{documentId}/versions/current
Returns current version of the document
documentId ( path , required ) — Id of the documentspaceId ( path , required ) — Id of the spaceGET
/spaces/{spaceId}/documents/{id}/access
Returns accesses of one document
id ( path , required ) — Id of the documentspaceId ( path , required ) — Id of the spaceGET
/spaces/{spaceId}/documents/{id}/accounting
Returns the document with the accounting property
id ( path , required ) — Id of the documentspaceId ( path , required ) — Id of the spaceGET
/spaces/{spaceId}/documents/{id}/download
Returns content of one document
id ( path , required ) — Id of the documentspaceId ( path , required ) — Id of the spaceGET
/spaces/{spaceId}/employees
Returns folders with Id and employee data
spaceId ( path , required ) — Id of the spaceSSNumber ( query ) — SSNumber of the employeeEmployeeNumber ( query ) — EmployeeNumber of the employeeWithContractingPartner ( query ) — if present returns infos of the ContractingPartner tooGET
/spaces/{spaceId}/employees/all
Returns folders with Id and employee data (even archived)
spaceId ( path , required ) — Id of the spaceSSNumber ( query ) — SSNumber of the employeeEmployeeNumber ( query ) — EmployeeNumber of the employeeWithContractingPartner ( query ) — if present returns infos of the ContractingPartner tooGET
/spaces/{spaceId}/employers
Returns folders with Id and employer data
spaceId ( path , required ) — Id of the spaceEmployeeNumber ( query ) — EmployeeNumber of the employer contractWithContractingPartner ( query ) — if present returns infos of the ContractingPartner tooGET
/spaces/{spaceId}/employers/all
Returns folders with Id and employer data (even archived)
spaceId ( path , required ) — Id of the spaceEmployeeNumber ( query ) — EmployeeNumber of the employer contractWithContractingPartner ( query ) — if present returns infos of the ContractingPartner tooGET
/spaces/{spaceId}/extend
read the data of a space
spaceId ( path , required ) — Id of the spacePOST
/spaces/{spaceId}/extend
Add a data to a space
spaceId ( path , required ) — Id of the spaceGET
/spaces/{spaceId}/folders
Returns folders of the space
Name ( query ) — Name of the folderKeywords ( query ) — keywords attached to the folderRootFolders ( query ) — only root foldersRange ( query ) — index range of the resultsClass ( query ) — class of the folderspaceId ( path , required ) — Id of the spaceGET
/spaces/{spaceId}/folders/all
Returns folders of the space (even archived)
Name ( query ) — Name of the folderRange ( query ) — index range of the resultsKeywords ( query ) — keywords attached to the folderClass ( query ) — class of the folderspaceId ( path , required ) — Id of the spaceDELETE
/spaces/{spaceId}/folders/{folderId}/bank-statements/{documentId}
delete a bank statement
spaceId ( path , required ) — Id of the spacefolderId ( path , required ) — Id of the folderdocumentId ( path , required ) — Id of the documentPATCH
/spaces/{spaceId}/folders/{folderId}/bank-statements/{documentId}
modify a bank statement
spaceId ( path , required ) — Id of the spacefolderId ( path , required ) — Id of the folderdocumentId ( path , required ) — Id of the documentDELETE
/spaces/{spaceId}/folders/{folderId}/contractual-documents/{documentId}
delete a contractual document
spaceId ( path , required ) — Id of the spacefolderId ( path , required ) — Id of the folderdocumentId ( path , required ) — Id of the documentPATCH
/spaces/{spaceId}/folders/{folderId}/contractual-documents/{documentId}
modify a contractual document
spaceId ( path , required ) — Id of the spacefolderId ( path , required ) — Id of the folderdocumentId ( path , required ) — Id of the documentDELETE
/spaces/{spaceId}/folders/{folderId}/corporate-tax-declarations/{documentId}
delete a corporate tax declaration
spaceId ( path , required ) — Id of the spacefolderId ( path , required ) — Id of the folderdocumentId ( path , required ) — Id of the documentPATCH
/spaces/{spaceId}/folders/{folderId}/corporate-tax-declarations/{documentId}
modify a coporate tax declaration
spaceId ( path , required ) — Id of the spacefolderId ( path , required ) — Id of the folderdocumentId ( path , required ) — Id of the documentDELETE
/spaces/{spaceId}/folders/{folderId}/expense-proofs/{documentId}
delete an expense proof
spaceId ( path , required ) — Id of the spacefolderId ( path , required ) — Id of the folderdocumentId ( path , required ) — Id of the documentPATCH
/spaces/{spaceId}/folders/{folderId}/expense-proofs/{documentId}
modify an expense report
spaceId ( path , required ) — Id of the spacefolderId ( path , required ) — Id of the folderdocumentId ( path , required ) — Id of the documentDELETE
/spaces/{spaceId}/folders/{folderId}/expense-reports/{documentId}
delete an expense report
spaceId ( path , required ) — Id of the spacefolderId ( path , required ) — Id of the folderdocumentId ( path , required ) — Id of the documentPATCH
/spaces/{spaceId}/folders/{folderId}/expense-reports/{documentId}
modify an expense report
spaceId ( path , required ) — Id of the spacefolderId ( path , required ) — Id of the folderdocumentId ( path , required ) — Id of the documentDELETE
/spaces/{spaceId}/folders/{folderId}/invoices/{documentId}
delete an invoice document
spaceId ( path , required ) — Id of the spacefolderId ( path , required ) — Id of the folderdocumentId ( path , required ) — Id of the documentPATCH
/spaces/{spaceId}/folders/{folderId}/invoices/{documentId}
modify a invoice
spaceId ( path , required ) — Id of the spacefolderId ( path , required ) — Id of the folderdocumentId ( path , required ) — Id of the documentGET
/spaces/{spaceId}/folders/{folderId}/nominative-social-declarations/{documentId}
get a nominative social declaration
spaceId ( path , required ) — Id of the spacefolderId ( path , required ) — Id of the folderdocumentId ( path , required ) — Id of the documentDELETE
/spaces/{spaceId}/folders/{folderId}/other-taxes/{documentId}
delete a tax declaration
spaceId ( path , required ) — Id of the spacefolderId ( path , required ) — Id of the folderdocumentId ( path , required ) — Id of the documentPATCH
/spaces/{spaceId}/folders/{folderId}/other-taxes/{documentId}
modify an other tax declaration
spaceId ( path , required ) — Id of the spacefolderId ( path , required ) — Id of the folderdocumentId ( path , required ) — Id of the documentDELETE
/spaces/{spaceId}/folders/{folderId}/payrolls/{documentId}
delete a payroll
spaceId ( path , required ) — Id of the spacefolderId ( path , required ) — Id of the folderdocumentId ( path , required ) — Id of the documentPATCH
/spaces/{spaceId}/folders/{folderId}/payrolls/{documentId}
modify a payroll
spaceId ( path , required ) — Id of the spacefolderId ( path , required ) — Id of the folderdocumentId ( path , required ) — Id of the documentPOST
/spaces/{spaceId}/folders/{folderId}/payrolls/{documentId}/refresh
recalculate a payroll
spaceId ( path , required ) — Id of the spacefolderId ( path , required ) — Id of the folderdocumentId ( path , required ) — Id of the documentDELETE
/spaces/{spaceId}/folders/{folderId}/payslips/{documentId}
delete a payslip
spaceId ( path , required ) — Id of the spacefolderId ( path , required ) — Id of the folderdocumentId ( path , required ) — Id of the documentPATCH
/spaces/{spaceId}/folders/{folderId}/payslips/{documentId}
modify a payslip
spaceId ( path , required ) — Id of the spacefolderId ( path , required ) — Id of the folderdocumentId ( path , required ) — Id of the documentDELETE
/spaces/{spaceId}/folders/{folderId}/social-contracts/{documentId}
delete a social contract
spaceId ( path , required ) — Id of the spacefolderId ( path , required ) — Id of the folderdocumentId ( path , required ) — Id of the documentPATCH
/spaces/{spaceId}/folders/{folderId}/social-contracts/{documentId}
modify a social contract
spaceId ( path , required ) — Id of the spacefolderId ( path , required ) — Id of the folderdocumentId ( path , required ) — Id of the documentDELETE
/spaces/{spaceId}/folders/{folderId}/social-declarations/{documentId}
delete a social declaration
spaceId ( path , required ) — Id of the spacefolderId ( path , required ) — Id of the folderdocumentId ( path , required ) — Id of the documentPATCH
/spaces/{spaceId}/folders/{folderId}/social-declarations/{documentId}
modify a social declaration
spaceId ( path , required ) — Id of the spacefolderId ( path , required ) — Id of the folderdocumentId ( path , required ) — Id of the documentDELETE
/spaces/{spaceId}/folders/{folderId}/vat-declarations/{documentId}
delete a VAT declaration
spaceId ( path , required ) — Id of the spacefolderId ( path , required ) — Id of the folderdocumentId ( path , required ) — Id of the documentPATCH
/spaces/{spaceId}/folders/{folderId}/vat-declarations/{documentId}
modify a vat declaration
spaceId ( path , required ) — Id of the spacefolderId ( path , required ) — Id of the folderdocumentId ( path , required ) — Id of the documentGET
/spaces/{spaceId}/folders/{id}
Returns folder with Id
id ( path , required ) — Id of the folderspaceId ( path , required ) — Id of the spacePATCH
/spaces/{spaceId}/folders/{id}
Modify a Folder (except Name, Class, ModificationDate and ArchivalDate)
id ( path , required ) — Id of the folderspaceId ( path , required ) — Id of the spaceDELETE
/spaces/{spaceId}/folders/{id}/accounting-year
delete an AccountingYear
id ( path , required ) — Id of the folderspaceId ( path , required ) — Id of the spacePATCH
/spaces/{spaceId}/folders/{id}/accounting-year
Modify a Folder (except Name, Class, ModificationDate and ArchivalDate) and AccountingYear data
id ( path , required ) — Id of the folderspaceId ( path , required ) — Id of the spaceGET
/spaces/{spaceId}/folders/{id}/accountings
Returns accountings documents of the folder (results and taxation or accountingyear)
id ( path , required ) — Id of the folderspaceId ( path , required ) — Id of the spaceDate ( query ) — date range of the documentsFolderDate ( query ) — date range of attachmentTitle ( query ) — Title of the accounting documentWorkbook ( query ) — workbook of the accountingClass ( query ) — class of the accountingAccountedOn ( query ) — accountedon of the accounting (boolean available)WithFolders ( query ) — if present, the folders containing the documents are returnedRange ( query ) — index range of the resultsGET
/spaces/{spaceId}/folders/{id}/accountings-journal
journal of accountings document delivered to a customer
id ( path , required ) — Id of the customer folderspaceId ( path , required ) — Id of the spaceDeliveryDate ( query ) — delivery dates of the documentAccountingDate ( query ) — accounting dates of the documentNumber ( query ) — numbers of the documentWorkbook ( query ) — workbook of the documentYearMonth ( query ) — yearmonth of the documentClass ( query ) — class of the documentCode ( query ) — code of the documentTargetFolderName ( query ) — Name of the target folder of the documentDELETE
/spaces/{spaceId}/folders/{id}/bank
Delete a Folder (except Name, Class, ModificationDate and ArchivalDate) and Bank data
id ( path , required ) — Id of the folderspaceId ( path , required ) — Id of the spaceGET
/spaces/{spaceId}/folders/{id}/bank
Returns folder with Id and bank data
id ( path , required ) — Id of the folderspaceId ( path , required ) — Id of the spacePATCH
/spaces/{spaceId}/folders/{id}/bank
Modify a Folder (except Name, Class, ModificationDate and ArchivalDate) and Bank data
id ( path , required ) — Id of the folderspaceId ( path , required ) — Id of the spaceGET
/spaces/{spaceId}/folders/{id}/bank-statements
Returns bank statements of the folder bank
id ( path , required ) — Id of the folder bankspaceId ( path , required ) — Id of the spaceDate ( query ) — range date of the documentsNumber ( query ) — Number of the bank statementRange ( query ) — index range of the resultsPOST
/spaces/{spaceId}/folders/{id}/bank-statements
Add a bank statement in a folder bank
id ( path , required ) — Id of the folder bankspaceId ( path , required ) — Id of the spacePATCH
/spaces/{spaceId}/folders/{id}/collective-decision
Modify a Folder (except Name, Class, ModificationDate and ArchivalDate) and Collective Decision data
id ( path , required ) — Id of the folderspaceId ( path , required ) — Id of the spaceGET
/spaces/{spaceId}/folders/{id}/common-folders
Returns common folders of a folder
id ( path , required ) — Id of the folderspaceId ( path , required ) — Id of the spaceName ( query ) — Name of the folderKeywords ( query ) — keywords attached to the folderPOST
/spaces/{spaceId}/folders/{id}/common-folders
Add a common folder in another folder
id ( path , required ) — Id of the folderspaceId ( path , required ) — Id of the spaceGET
/spaces/{spaceId}/folders/{id}/common-folders/all
Returns common folders (even archived) of a folder
id ( path , required ) — Id of the folderspaceId ( path , required ) — Id of the spaceName ( query ) — Name of the folderKeywords ( query ) — keywords attached to the folderGET
/spaces/{spaceId}/folders/{id}/contracting-partner
Returns all contracting partners of a contract
id ( path , required ) — Id of the folder (contract)spaceId ( path , required ) — Id of the spaceGET
/spaces/{spaceId}/folders/{id}/contracting-partner/space
Returns collector space of a contract
id ( path , required ) — Id of the folder (contract)spaceId ( path , required ) — Id of the spaceGET
/spaces/{spaceId}/folders/{id}/contractual-documents
Returns documents of the folder
id ( path , required ) — Id of the folderspaceId ( path , required ) — Id of the spaceDate ( query ) — date range of the documentsFolderDate ( query ) — date range of attachmentType ( query ) — Type of the documentRange ( query ) — index range of the resultsPOST
/spaces/{spaceId}/folders/{id}/contractual-documents
Add a document in a folder
id ( path , required ) — Id of the folderspaceId ( path , required ) — Id of the spaceGET
/spaces/{spaceId}/folders/{id}/contractual-relationship
Returns folder with Id and contractual-relationship data
id ( path , required ) — Id of the folderspaceId ( path , required ) — Id of the spaceGET
/spaces/{spaceId}/folders/{id}/coporate-tax-declarations
Returns corporate tax declarations
id ( path , required ) — Id of the folder result and taxationspaceId ( path , required ) — Id of the spaceDate ( query ) — range date of the documentsRange ( query ) — index range of the resultsPOST
/spaces/{spaceId}/folders/{id}/coporate-tax-declarations
Add a corporate tax declaration
id ( path , required ) — Id of the folder result and taxationspaceId ( path , required ) — Id of the spaceDELETE
/spaces/{spaceId}/folders/{id}/customer
delete a customer
id ( path , required ) — Id of the folderspaceId ( path , required ) — Id of the spaceGET
/spaces/{spaceId}/folders/{id}/customer
Returns folder with Id and customer data
id ( path , required ) — Id of the folderspaceId ( path , required ) — Id of the spacePOST
/spaces/{spaceId}/folders/{id}/other-taxes
Add a tax declaration
id ( path , required ) — Id of the folder tax contractspaceId ( path , required ) — Id of the spacePATCH
/spaces/{spaceId}/folders/{id}/customer
Modify a Folder (except Name, Class, ModificationDate and ArchivalDate) and Customer data
id ( path , required ) — Id of the folderspaceId ( path , required ) — Id of the spaceGET
/spaces/{spaceId}/folders/{id}/deliveries-journal
journal of documents delivered to a customer
id ( path , required ) — Id of the customer folderspaceId ( path , required ) — Id of the spaceDeliveryDate ( query ) — delivery dates of the documentAccountingDate ( query ) — accounting dates of the documentNumber ( query ) — numbers of the documentClass ( query ) — class of the documentTargetFolderName ( query ) — Name of the target folder of the documentGET
/spaces/{spaceId}/folders/{id}/documents
Returns documents of the folder
id ( path , required ) — Id of the folderspaceId ( path , required ) — Id of the spaceDate ( query ) — date range of the documentsTitle ( query ) — Title of the documentFolderDate ( query ) — date range of attachmentClass ( query ) — Class of documentRange ( query ) — index range of the resultsPOST
/spaces/{spaceId}/folders/{id}/documents
Add a document in a folder
id ( path , required ) — Id of the folderspaceId ( path , required ) — Id of the spacePATCH
/spaces/{spaceId}/folders/{id}/documents/{documentId}/detach
Detach a doc of a folder
id ( path , required ) — Id of the folderspaceId ( path , required ) — Id of the spacedocumentId ( path , required ) — Id of the documentDELETE
/spaces/{spaceId}/folders/{id}/employee
Delete a Folder (except Name, Class, ModificationDate and ArchivalDate) and Employee data
id ( path , required ) — Id of the folderspaceId ( path , required ) — Id of the spaceGET
/spaces/{spaceId}/folders/{id}/employee
Returns folder with Id and employee data
id ( path , required ) — Id of the folderspaceId ( path , required ) — Id of the spacePATCH
/spaces/{spaceId}/folders/{id}/employee
Modify a Folder (except Name, Class, ModificationDate and ArchivalDate) and Employee data
id ( path , required ) — Id of the folderspaceId ( path , required ) — Id of the spaceGET
/spaces/{spaceId}/folders/{id}/expense-proofs
Returns expense proofs of the folder (social, followup or exchange)
id ( path , required ) — Id of the folderspaceId ( path , required ) — Id of the spaceDate ( query ) — date range of the documentsFolderDate ( query ) — date range of attachmentStatus ( query ) — Status of the expense proofNoExpenseReport ( query ) — To return expense proofs not attached to an expense reportRange ( query ) — index range of the resultsPOST
/spaces/{spaceId}/folders/{id}/expense-proofs
Add a expense proof in a folder followup or exchange
id ( path , required ) — Id of the folderspaceId ( path , required ) — Id of the spaceGET
/spaces/{spaceId}/folders/{id}/expense-reports
Returns expense reports of the folder (social or followup)
id ( path , required ) — Id of the folderspaceId ( path , required ) — Id of the spaceDate ( query ) — date range of the documentsFolderDate ( query ) — date range of attachmentWithExtend ( query ) — If present returns also the data extendRange ( query ) — index range of the resultsProcessingDate ( query ) — range of processing date (boolean available)ExpenseDate ( query ) — range of ExpenseDate (valid available)SortOrder ( query ) — order of sort (if absent default is asc)SortName ( query ) — name of value for sortPOST
/spaces/{spaceId}/folders/{id}/expense-reports
Add a expense report in a folder followup
id ( path , required ) — Id of the folderspaceId ( path , required ) — Id of the spaceGET
/spaces/{spaceId}/folders/{id}/other-taxes
Returns other taxes declarations
id ( path , required ) — Id of the folder taxcontractspaceId ( path , required ) — Id of the spaceDate ( query ) — range date of the documentsRange ( query ) — index range of the resultsGET
/spaces/{spaceId}/folders/{id}/expense-reports/{expenseReportId}/expense-proofs
Returns expense proofs linked to the expenseReportId
id ( path , required ) — Id of the folderspaceId ( path , required ) — Id of the spaceexpenseReportId ( path , required ) — Id of the expense reportDate ( query ) — Date of the documents (YYYY or YYYYMM or YYYYMMDD)Status ( query ) — Status of the expense proofFolderDate ( query ) — Date of upload of the document (YYYY or YYYYMM or YYYYMMDD)DELETE
/spaces/{spaceId}/folders/{id}/insurance
Delete a Folder (except Name, Class, ModificationDate and ArchivalDate) and Insurance data
id ( path , required ) — Id of the folderspaceId ( path , required ) — Id of the spaceGET
/spaces/{spaceId}/folders/{id}/insurance
Returns folder with Id and insurance data
id ( path , required ) — Id of the folderspaceId ( path , required ) — Id of the spacePATCH
/spaces/{spaceId}/folders/{id}/insurance
Modify a Folder (except Name, Class, ModificationDate and ArchivalDate) and Insurance data
id ( path , required ) — Id of the folderspaceId ( path , required ) — Id of the spaceGET
/spaces/{spaceId}/folders/{id}/invoices
Returns invoices of the folder (customer, provider, accountingyear or root folders customers or providers)
id ( path , required ) — Id of the folderspaceId ( path , required ) — Id of the spaceTitle ( query ) — Title of the documentsDate ( query ) — date range of the documentsNumber ( query ) — Number of the invoiceInclVAT ( query ) — amount incl. VATBeforeVAT ( query ) — amount before VATDueDate ( query ) — date due paymentPaymentDate ( query ) — date of payment (boolean and valid available)InvoiceDate ( query ) — range date of invoiceFolderDate ( query ) — date range of attachmentAccountedOn ( query ) — value of AccountedOn (boolean available but not range)WithExtend ( query ) — If present returns also the data extendExtend ( query ) — json object to filter extend dataRange ( query ) — index range of the resultsSortOrder ( query ) — order of sort (if absent default is asc)SortName ( query ) — name of value for sortPOST
/spaces/{spaceId}/folders/{id}/invoices
Add a invoice in a folder of a customer or a provider
id ( path , required ) — Id of the folderspaceId ( path , required ) — Id of the spaceGET
/spaces/{spaceId}/folders/{id}/legal-entity
Returns legal entity of a follow up folder
id ( path , required ) — Id of the folder (followup)spaceId ( path , required ) — Id of the spaceDELETE
/spaces/{spaceId}/folders/{id}/loan
Delete a Folder (except Name, Class, ModificationDate and ArchivalDate) and Loan data
id ( path , required ) — Id of the folderspaceId ( path , required ) — Id of the spaceGET
/spaces/{spaceId}/folders/{id}/loan
Returns folder with Id and loan data
id ( path , required ) — Id of the folderspaceId ( path , required ) — Id of the spacePATCH
/spaces/{spaceId}/folders/{id}/loan
Modify a Folder (except Name, Class, ModificationDate and ArchivalDate) and Loan data
id ( path , required ) — Id of the folderspaceId ( path , required ) — Id of the spaceGET
/spaces/{spaceId}/folders/{id}/messages
Returns messages of the folder
Text ( query ) — Name of the messageRange ( query ) — index range of the resultsMessageDate ( query ) — date of the messagespaceId ( path , required ) — Id of the spaceid ( path , required ) — Id of the folderPOST
/spaces/{spaceId}/folders/{id}/messages
Write a message in the journal of a folder
id ( path , required ) — Id of the folderspaceId ( path , required ) — Id of the spaceGET
/spaces/{spaceId}/folders/{id}/messages/{messageId}
Returns message with Id
id ( path , required ) — Id of the folderspaceId ( path , required ) — Id of the spacemessageId ( path , required ) — Id of the mesagePATCH
/spaces/{spaceId}/folders/{id}/messages/{messageId}
Modify a Message
id ( path , required ) — Id of the folderspaceId ( path , required ) — Id of the spacemessageId ( path , required ) — Id of the messageGET
/spaces/{spaceId}/folders/{id}/nominative-social-declarations
Returns nominative social declarations of the folder social
id ( path , required ) — Id of the folder socialspaceId ( path , required ) — Id of the spaceDate ( query ) — range date of the documentsRange ( query ) — index range of the resultsGET
/spaces/{spaceId}/folders/{id}/passwords
Returns identifiers/passwords of the folder
spaceId ( path , required ) — Id of the spaceid ( path , required ) — Id of the folderPOST
/spaces/{spaceId}/folders/{id}/passwords
Write a identifier/password in aa folder
id ( path , required ) — Id of the folderspaceId ( path , required ) — Id of the spaceDELETE
/spaces/{spaceId}/folders/{id}/passwords/{passwordId}
delete a password
id ( path , required ) — Id of the folderspaceId ( path , required ) — Id of the spacepasswordId ( path , required ) — Id of the passwordGET
/spaces/{spaceId}/folders/{id}/passwords/{passwordId}
Returns password with Id
id ( path , required ) — Id of the folderspaceId ( path , required ) — Id of the spacepasswordId ( path , required ) — Id of the passwordPATCH
/spaces/{spaceId}/folders/{id}/passwords/{passwordId}
Modify a Password
id ( path , required ) — Id of the folderspaceId ( path , required ) — Id of the spacepasswordId ( path , required ) — Id of the passwordGET
/spaces/{spaceId}/folders/{id}/payrolls
Returns payrolls of the folder social
id ( path , required ) — Id of the folder socialspaceId ( path , required ) — Id of the spaceDate ( query ) — range date of the documentsBegin ( query ) — begin date of the payrollsEnd ( query ) — end date of the payrollsRange ( query ) — index range of the resultsPOST
/spaces/{spaceId}/folders/{id}/payrolls
Add a payroll in a folder social
id ( path , required ) — Id of the folder socialspaceId ( path , required ) — Id of the spaceDELETE
/spaces/{spaceId}/folders/{id}/payrolls/{payrollId}/nominative-social-declaration
delete a nominative social declaration in a folder social
id ( path , required ) — Id of the folder socialspaceId ( path , required ) — Id of the spacepayrollId ( path , required ) — Id of the payrollPOST
/spaces/{spaceId}/folders/{id}/payrolls/{payrollId}/nominative-social-declaration
Add a nominative social declaration in a folder social
id ( path , required ) — Id of the folder socialspaceId ( path , required ) — Id of the spacepayrollId ( path , required ) — Id of the payrollGET
/spaces/{spaceId}/folders/{id}/payslips
Returns payslips of the folder employee
id ( path , required ) — Id of the folder employeespaceId ( path , required ) — Id of the spaceDate ( query ) — range date of the documentsRange ( query ) — index range of the resultsPOST
/spaces/{spaceId}/folders/{id}/payslips
Add a payslip in a folder employee
id ( path , required ) — Id of the folder employeespaceId ( path , required ) — Id of the spaceDELETE
/spaces/{spaceId}/folders/{id}/portfolio/{portfolioId}
delete a secondary portfolio of a customer contract
id ( path , required ) — Id of the folderspaceId ( path , required ) — Id of the spaceportfolioId ( path , required ) — Id of the portfolioDELETE
/spaces/{spaceId}/folders/{id}/professional-vehicle
delete a Professional Vehicle
id ( path , required ) — Id of the folderspaceId ( path , required ) — Id of the spacePATCH
/spaces/{spaceId}/folders/{id}/professional-vehicle
Modify a Folder (except Name, Class, ModificationDate and ArchivalDate) and Professional Vehicle data
id ( path , required ) — Id of the folderspaceId ( path , required ) — Id of the spaceDELETE
/spaces/{spaceId}/folders/{id}/provider
delete a provider
id ( path , required ) — Id of the folderspaceId ( path , required ) — Id of the spaceGET
/spaces/{spaceId}/folders/{id}/provider
Returns folder with Id and provider data
id ( path , required ) — Id of the folderspaceId ( path , required ) — Id of the spacePATCH
/spaces/{spaceId}/folders/{id}/provider
Modify a Folder (except Name, Class, ModificationDate and ArchivalDate) and Provider data
id ( path , required ) — Id of the folderspaceId ( path , required ) — Id of the spaceGET
/spaces/{spaceId}/folders/{id}/required-documents
list of the required documents for a person
id ( path , required ) — Id of the folder either exchange either followupspaceId ( path , required ) — Id of the spacePATCH
/spaces/{spaceId}/folders/{id}/required-documents/{requireddocumentid}
Modify the status of a requireddocument
id ( path , required ) — Id of the folder exchange or followupspaceId ( path , required ) — Id of the spacerequireddocumentid ( path , required ) — Id of the requireddocumentPOST
/spaces/{spaceId}/folders/{id}/required-documents/{requireddocumentid}
Add a required document to a line
id ( path , required ) — Id of the folder exchange or followupspaceId ( path , required ) — Id of the spacerequireddocumentid ( path , required ) — Id of the requireddocumentDELETE
/spaces/{spaceId}/folders/{id}/required-documents/{requireddocumentid}/documents/{documentId}
delete a document from a required document
id ( path , required ) — Id of the folder exchange or followupspaceId ( path , required ) — Id of the spacerequireddocumentid ( path , required ) — Id of the requireddocumentdocumentId ( path , required ) — Id of the document to deleteGET
/spaces/{spaceId}/folders/{id}/sections
Returns sections of the folder
id ( path , required ) — Id of the folderspaceId ( path , required ) — Id of the spaceGET
/spaces/{spaceId}/folders/{id}/social-contracts
Returns social contracts of the folder employee
id ( path , required ) — Id of the folder employeespaceId ( path , required ) — Id of the spaceDate ( query ) — range date of the documentsRange ( query ) — index range of the resultsPOST
/spaces/{spaceId}/folders/{id}/social-contracts
Add a social contract in a folder employee
id ( path , required ) — Id of the folder employeespaceId ( path , required ) — Id of the spaceGET
/spaces/{spaceId}/folders/{id}/social-declarations
Returns social declarations
id ( path , required ) — Id of the folder socialregimespaceId ( path , required ) — Id of the spaceDate ( query ) — range date of the documentsRange ( query ) — index range of the resultsPOST
/spaces/{spaceId}/folders/{id}/social-declarations
Add a social declaration
id ( path , required ) — Id of the folder social regimespaceId ( path , required ) — Id of the spaceDELETE
/spaces/{spaceId}/folders/{id}/social-regimes
delete a social regime
id ( path , required ) — Id of the folderspaceId ( path , required ) — Id of the spaceGET
/spaces/{spaceId}/folders/{id}/social-regimes
Returns folder with Id and social regime data
id ( path , required ) — Id of the folderspaceId ( path , required ) — Id of the spacePATCH
/spaces/{spaceId}/folders/{id}/social-regimes
Modify a Folder (except Name, Class, ModificationDate and ArchivalDate) and Social Regime data
id ( path , required ) — Id of the folderspaceId ( path , required ) — Id of the spaceGET
/spaces/{spaceId}/folders/{id}/sum-invoices
Returns sum of invoices of the folder (customer, provider, accountingyear or root folders customers or providers)
id ( path , required ) — Id of the folderspaceId ( path , required ) — Id of the spaceNumber ( query ) — Number of the invoiceInclVat ( query ) — amount incl. VATBeforeVAT ( query ) — amount before VATDueDate ( query ) — range date due paymentPaymentDate ( query ) — range date of paymentInvoiceDate ( query ) — range date of invoiceDELETE
/spaces/{spaceId}/folders/{id}/tax-contract
Delete a Folder (except Name, Class, ModificationDate and ArchivalDate) and tax contract data
id ( path , required ) — Id of the folderspaceId ( path , required ) — Id of the spacePATCH
/spaces/{spaceId}/folders/{id}/tax-contract
Modify a Folder (except Name, Class, ModificationDate and ArchivalDate) and Tax Contract data
id ( path , required ) — Id of the folderspaceId ( path , required ) — Id of the spacePATCH
/spaces/{spaceId}/persons/{id}/invitation
modify an invitation
id ( path , required ) — Id of the personspaceId ( path , required ) — Id of the spaceGET
/spaces/{spaceId}/folders/{id}/vat-declarations
Returns vat declarations
id ( path , required ) — Id of the folder result and taxationspaceId ( path , required ) — Id of the spaceDate ( query ) — range date of the documentsRange ( query ) — index range of the resultsPOST
/spaces/{spaceId}/folders/{id}/vat-declarations
Add a vat declaration
id ( path , required ) — Id of the folder result and taxationspaceId ( path , required ) — Id of the spaceDELETE
/spaces/{spaceId}/folders/{id}/{documentClass}
delete a class document
spaceId ( path , required ) — Id of the spaceid ( path , required ) — Id of the folderdocumentClass ( path , required ) — class of the documentGET
/spaces/{spaceId}/folders/{id}/{documentClass}
Returns document of documentClass (without specific data) of the folder
id ( path , required ) — Id of the folderspaceId ( path , required ) — Id of the spacedocumentClass ( path , required ) — class of the documentPOST
/spaces/{spaceId}/folders/{id}/{documentClass}
Add a document in a folder
id ( path , required ) — Id of the folderspaceId ( path , required ) — Id of the spacedocumentClass ( path , required ) — class of the documentGET
/spaces/{spaceId}/legal-entities/{id}/banks
Returns list of bank folders for a legal-entity
id ( path , required ) — Id of the legal-entityspaceId ( path , required ) — Id of the spacePOST
/spaces/{spaceId}/legal-entities/{id}/banks
Add a folder for a bank
id ( path , required ) — Id of the bank or memberIdspaceId ( path , required ) — Id of the spaceGET
/spaces/{spaceId}/legal-entities/{id}/banks/all
Returns folder of the banks even archived
id ( path , required ) — Id of the bankspaceId ( path , required ) — Id of the spaceGET
/spaces/{spaceId}/legal-entities/{id}/contracts
Returns all contract folders of the legal entity
id ( path , required ) — Id of the legal entity or memberIdspaceId ( path , required ) — Id of the spaceGET
/spaces/{spaceId}/legal-entities/{id}/contractual-relationships
Returns folder of the others contract with legal entity
id ( path , required ) — Id of the legal-entity or memberIdspaceId ( path , required ) — Id of the spaceGET
/spaces/{spaceId}/legal-entities/{id}/contractual-relationships/all
Returns folder of the others contract with legal entity (even archived)
id ( path , required ) — Id of the legal-entity or memberIdspaceId ( path , required ) — Id of the spaceGET
/spaces/{spaceId}/legal-entities/{id}/customers
Returns folder of the customer
id ( path , required ) — Id of the customer or memberIdspaceId ( path , required ) — Id of the spacePOST
/spaces/{spaceId}/legal-entities/{id}/customers
Add a folder for a customer
id ( path , required ) — Id of the customer or memberIdspaceId ( path , required ) — Id of the spaceGET
/spaces/{spaceId}/legal-entities/{id}/customers/all
Returns folder of the customers (even archived)
id ( path , required ) — Id of the customer or memberIdspaceId ( path , required ) — Id of the spaceGET
/spaces/{spaceId}/legal-entities/{id}/insurances
Returns list of insurance folders for a legal-entity
id ( path , required ) — Id of the insurancespaceId ( path , required ) — Id of the spacePOST
/spaces/{spaceId}/legal-entities/{id}/insurances
Add a folder for a insurance
id ( path , required ) — Id of the insurance or memberIdspaceId ( path , required ) — Id of the spaceGET
/spaces/{spaceId}/legal-entities/{id}/insurances/all
Returns folder of the insurances even archived
id ( path , required ) — Id of the insurancespaceId ( path , required ) — Id of the spaceGET
/spaces/{spaceId}/legal-entities/{id}/loans
Returns folder of the loan
id ( path , required ) — Id of the loanspaceId ( path , required ) — Id of the spacePOST
/spaces/{spaceId}/legal-entities/{id}/loans
Add a folder for a loan
id ( path , required ) — Id of the loan or memberIdspaceId ( path , required ) — Id of the spaceGET
/spaces/{spaceId}/legal-entities/{id}/loans/all
Returns folder of the loans even archived
id ( path , required ) — Id of the loanspaceId ( path , required ) — Id of the spaceGET
/spaces/{spaceId}/legal-entities/{id}/providers
Returns list of providers folders for a legal-entity
id ( path , required ) — Id of the provider or memberIdspaceId ( path , required ) — Id of the spacePOST
/spaces/{spaceId}/legal-entities/{id}/providers
Add a folder for a provider
id ( path , required ) — Id of the provider or memberIdspaceId ( path , required ) — Id of the spaceGET
/spaces/{spaceId}/legal-entities/{id}/providers/all
Returns folder of the providers even archived
id ( path , required ) — Id of the provider or memberIdspaceId ( path , required ) — Id of the spaceGET
/spaces/{spaceId}/legal-entities/{id}/social-regimes
Returns list of social regimes folders for a legal-entity
id ( path , required ) — Id of the legal entity or memberIdspaceId ( path , required ) — Id of the spacePOST
/spaces/{spaceId}/legal-entities/{id}/social-regimes
Add a folder for a social regime
id ( path , required ) — Id of the legal entity or memberIdspaceId ( path , required ) — Id of the spaceGET
/spaces/{spaceId}/legal-entities/{id}/social-regimes/all
Returns folder of the social regimes even archived
id ( path , required ) — Id of the legal entity or memberIdspaceId ( path , required ) — Id of the spaceGET
/spaces/{spaceId}/loans
Returns list of all loan folders of the space
spaceId ( path , required ) — Id of the spaceGET
/spaces/{spaceId}/loans/all
Returns list of all loan folders even archived of the space
spaceId ( path , required ) — Id of the spacePATCH
/spaces/{spaceId}/persons/{id}/call-for-document
modify the invitation of a person to collect documents
id ( path , required ) — Id of the personspaceId ( path , required ) — Id of the spacePOST
/spaces/{spaceId}/persons/{id}/call-for-document
invite a person to collect documents
id ( path , required ) — Id of the person or memberIdspaceId ( path , required ) — Id of the spaceGET
/spaces/{spaceId}/persons/{id}/employees
Returns folder of the employee
id ( path , required ) — Id of the person or memberIdspaceId ( path , required ) — Id of the spacePOST
/spaces/{spaceId}/persons/{id}/employees
Add a folder for a employee
id ( path , required ) — Id of the employeespaceId ( path , required ) — Id of the spaceGET
/spaces/{spaceId}/persons/{id}/employees/all
Returns folder of all employees (even archived)
id ( path , required ) — Id of the person or memberIdspaceId ( path , required ) — Id of the spaceGET
/spaces/{spaceId}/persons/{id}/exchange
Returns folder exchange of the person
id ( path , required ) — Id of the person or memberIdspaceId ( path , required ) — Id of the spaceGET
/spaces/{spaceId}/persons/{id}/follow-ups
Returns folder of the person
id ( path , required ) — Id of the person or memberIdspaceId ( path , required ) — Id of the spaceDELETE
/spaces/{spaceId}/persons/{id}/guest-in-space
delete the invitation of a person in a space
id ( path , required ) — Id of the personspaceId ( path , required ) — Id of the spacePATCH
/spaces/{spaceId}/persons/{id}/guest-in-space
invite a person in a space
id ( path , required ) — Id of the personspaceId ( path , required ) — Id of the spacePOST
/spaces/{spaceId}/persons/{id}/guest-in-space
invite a person in a space
id ( path , required ) — Id of the personspaceId ( path , required ) — Id of the spaceDELETE
/spaces/{spaceId}/persons/{id}/invitation
delete the invitation of a person in a space
id ( path , required ) — Id of the personspaceId ( path , required ) — Id of the spaceGET
/spaces/{spaceId}/persons/{id}/invitation
Returns invitation of a person
id ( path , required ) — Id of the personspaceId ( path , required ) — Id of the spacePOST
/spaces/{spaceId}/persons/{id}/invitation
create an invitation in a space for a person
id ( path , required ) — Id of the personspaceId ( path , required ) — Id of the spacePOST
/spaces/{spaceId}/persons/{id}/invitation/{invitationId}/send
send the invitation of a person in a space
id ( path , required ) — Id of the personinvitationId ( path , required ) — Id of the invitationspaceId ( path , required ) — Id of the spaceGET
/spaces/{spaceId}/persons/{memberId}/folders/{id}
Returns folderId with the access of the person
id ( path , required ) — Id of the folderspaceId ( path , required ) — Id of the spacememberId ( path , required ) — memberId of the personPATCH
/spaces/{spaceId}/persons/{memberId}/folders/{id}
Modify an access
id ( path , required ) — Id of the folderspaceId ( path , required ) — Id of the spacememberId ( path , required ) — memberId of the personGET
/spaces/{spaceId}/providers
Returns folder with Id and provider data
spaceId ( path , required ) — Id of the spaceWithContractingPartner ( query ) — if present returns infos of the ContractingPartner tooGET
/spaces/{spaceId}/providers/all
Returns folder with Id and provider data (even archived)
spaceId ( path , required ) — Id of the spaceWithContractingPartner ( query ) — if present returns infos of the ContractingPartner tooGET
/spaces/{spaceId}/search
Research text inside documents, folders or messages
spaceId ( path , required ) — Id of the spaceQuery ( query ) — Text to findRange ( query ) — index range of the resultsQueryContext ( query ) — context of researchGET
/spaces/{spaceId}/social-regimes
Returns folder with Id and social regime data
spaceId ( path , required ) — Id of the spaceWithContractingPartner ( query ) — if present returns infos of the ContractingPartner tooGET
/spaces/{spaceId}/social-regimes/all
Returns folder with Id and social regime data (even archived)
spaceId ( path , required ) — Id of the spaceWithContractingPartner ( query ) — if present returns infos of the ContractingPartner tooGET
/spaces/{spaceId}/spaces-invoicings
Returns CSV Invoicings of the spaces for the account of the spaceId
spaceId ( path , required ) — Id of the spaceDate ( query ) — date range of the documents
280 endpoints auto-detected
Authentication
This API requires authentication: OAuth.
curl -X PATCH \
"https://sandbox.gerermesaffaires.com/api/v1/spaces/{id}/legal" sandbox.gerermesaffaires.com · HTTPS only