APIHub
Back to Explore

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.

Uncategorized
OAuth
HTTPS
CORS: Unknown
Description enriched
Visit official documentation

Latency

2303ms p95

Uptime

100.0% 30d

Playground

Verified

live

Endpoints

REST · JSON
PATCH

/spaces/{id}/legal

Modify legal information of a Space (except private)

  • id (path, required) — Id of the space
GET

/spaces/{id}/logo

Returns a space with the logo

  • id (path, required) — Id of the space
GET

/spaces/{id}/status

Returns all status of the space

  • id (path, required) — Id of the space
POST

/spaces/{id}/status

Replace or Add a status

  • id (path, required) — Id of the space
GET

/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 group
POST

/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 space
GET

/hub/spaces/{spaceId}/menus

Returns predefined folders and workbooks of the Hub for the space

  • spaceId (path, required) — Id of the space
POST

/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 space
GET

/menus

Returns predefined entries

POST

/menus/{menuId}/documents

add a document to the target menuId

  • menuId (path, required) — Id of the space
GET

/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 group
PATCH

/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 group
GET

/business-groups/{id}

Returns a group

  • id (path, required) — Id of the group
GET

/business-groups/{id}/spaces

Returns spaces of the business group with id

  • id (path, required) — Id of the group
  • Name (query) — Name of the space
  • Type (query) — Type of the space
  • RegistrationNumber (query) — registration number of the space
DELETE

/business-groups/{id}/spaces/{spaceId}

Remove a customer space from partner

  • id (path, required) — Id of the group of the customer space
  • spaceId (path, required) — Id of the space
POST

/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 group
  • spaceId (path, required) — Id of the company space which contains the customer folder
  • personId (path, required) — Id of the person customer
  • folderId (path, required) — Id of the folder customer
POST

/business-groups/{id}/spaces/{spaceId}/legal-entities/{personId}/customers/{folderId}/spaces

Add a Space in a group

  • id (path, required) — Id of the group
  • spaceId (path, required) — Id of the company space which contains the customer folder
  • personId (path, required) — Id of the person customer
  • folderId (path, required) — Id of the folder customer
GET

/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 invitation
POST

/registration

complete the invitation

GET

/session

Returns member id of user logged

GET

/spaces

Returns spaces of my group

  • Name (query) — Name of the space
  • Type (query) — Type of the space
  • RegistrationNumber (query) — registration number of the space
POST

/spaces

Add a Space in my group

GET

/spaces/all

Returns all spaces

  • Name (query) — Name of the space
  • Type (query) — Type of the space
DELETE

/spaces/{id}

Delete a Space (only space not delivered to customer)

  • id (path, required) — Id of the space
GET

/spaces/{id}

Returns a space

  • id (path, required) — Id of the space
PATCH

/spaces/{id}

Modify a Space (except private)

  • id (path, required) — Id of the space
GET

/spaces/{id}/accounting-year

Returns list of accounting years for the space {id}

  • id (path, required) — Id of the space
  • End (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 space
GET

/spaces/{id}/collective-decision

Returns list of collective decisions for the space {id}

  • id (path, required) — Id of the space
  • Date (query) — Date of the collective decision YYYMMDD
  • Event (query) — Event of the collective decision (see post for the list of events)
  • Range (query) — index range of the results
  • HasCompanyRegistrationCertificate (query) — If true returns only invoices with a CompanyRegistrationCertificate
  • HasStatus (query) — If true returns only invoices with a Status
  • HasSireneRegister (query) — If true returns only invoices with a SireneRegister
  • HasMinutes (query) — If true returns only invoices with Minutes
POST

/spaces/{id}/collective-decision

Create a colletive decision for the space id

  • id (path, required) — Id of the space
GET

/spaces/{id}/company-entities

Returns list of company entities

  • id (path, required) — Id of the space
  • Name (query) — Name of the company entity
  • LegalName (query) — Legal name of the company entity
  • RegistrationNumber (query) — registration number of the company entity
POST

/spaces/{id}/company-entities

Add a Company Entity in a Space

  • id (path, required) — Id of the space
GET

/spaces/{id}/company-entities/all

Returns list of company entities even company entities archived

  • id (path, required) — Id of the space
  • Name (query) — Name of the company entity
  • RegistrationNumber (query) — registration number of the company entity
GET

/spaces/{id}/company-entities/{companyId}

Returns a compay entity

  • id (path, required) — Id of the space
  • companyId (path, required) — Id of the company entity
PATCH

/spaces/{id}/company-entities/{companyId}

Modify a company entity

  • id (path, required) — Id of the space
  • companyId (path, required) — Id of the company entity to modify
GET

/spaces/{id}/company-entities/{personId}/details

Returns all details of a company entity

  • id (path, required) — Id of the space
  • personId (path, required) — Id of the company entity to get
POST

/spaces/{id}/company-entities/{personId}/details

Replace or Add a contact detail for a person

  • id (path, required) — Id of the space
  • personId (path, required) — Id of the person or memberId
DELETE

/spaces/{id}/company-entities/{personId}/details/{designation}

delete a contact detail for a company entity

  • id (path, required) — Id of the space
  • personId (path, required) — Id of the person or memberId
  • designation (path, required) — designation
POST

/spaces/{id}/documents/download

create an archive with documents

  • id (path, required) — Id of the space
GET

/spaces/{id}/folders/{folderId}/persons/{memberId}

return the access of a person in a customer contract

  • id (path, required) — Id of the space
  • memberId (path, required) — memberId of the person
  • folderId (path, required) — id of the customer folder
PATCH

/spaces/{id}/folders/{folderId}/persons/{memberId}

Add/Modify/Delete a person in a customer contract (except manager)

  • id (path, required) — Id of the space
  • memberId (path, required) — memberId of the person
  • folderId (path, required) — id of the customer folder
PATCH

/spaces/{id}/folders/{folderId}/persons/{memberId}/activeaccess

open an access

  • id (path, required) — Id of the space
  • memberId (path, required) — memberId of the person
  • folderId (path, required) — id of the customer folder
PATCH

/spaces/{id}/folders/{folderId}/persons/{memberId}/unactiveaccess

close an access

  • id (path, required) — Id of the space
  • memberId (path, required) — memberId of the person
  • folderId (path, required) — id of the customer folder
POST

/spaces/{id}/folders/{folderId}/persons/{personId}/guest-in-space

invite a owner in a space

  • folderId (path, required) — Id of the folder customer
  • personId (path, required) — Id of the person to invite to his space
  • id (path, required) — Id of the space
GET

/spaces/{id}/groups

Returns list of groups

  • id (path, required) — Id of the space
  • Name (query) — Name of the groups
POST

/spaces/{id}/groups

Add a group in a Space

  • id (path, required) — Id of the space
GET

/spaces/{id}/groups/all

Returns list of groups even archived of the space

  • id (path, required) — Id of the space
  • Name (query) — Name of the group
GET

/spaces/{id}/groups/{groupId}

Returns a group

  • id (path, required) — Id of the space
  • groupId (path, required) — Id of the group
PATCH

/spaces/{id}/groups/{groupId}

Modify a group

  • id (path, required) — Id of the space
  • groupId (path, required) — Id of the group to modify
DELETE

/spaces/{id}/groups/{groupId}/folders/{folderId}

delete access to a folder for a group

  • id (path, required) — Id of the space
  • groupId (path, required) — Id of the group to modify
  • folderId (path, required) — Id of the folder
PATCH

/spaces/{id}/groups/{groupId}/folders/{folderId}

Add access to a folder for a group

  • id (path, required) — Id of the space
  • groupId (path, required) — Id of the group to modify
  • folderId (path, required) — Id of the folder
DELETE

/spaces/{id}/groups/{groupId}/persons/{memberId}

Delete a person of a group

  • id (path, required) — Id of the space
  • groupId (path, required) — Id of the group to modify
  • memberId (path, required) — MemberId of the person
PATCH

/spaces/{id}/groups/{groupId}/persons/{memberId}

Add a person to a group

  • id (path, required) — Id of the space
  • groupId (path, required) — Id of the group to modify
  • memberId (path, required) — MemberId of the person
GET

/spaces/{id}/legal

Returns legal information of a space (except private)

  • id (path, required) — Id of the space
GET

/spaces/{id}/persons

Returns list of persons

  • id (path, required) — Id of the space
  • Function (query) — Function of the person
  • Range (query) — index range of the results
  • Name (query) — Name of the person
  • Validated (query) — Status of the person
  • Email (query) — Email of the person
POST

/spaces/{id}/persons

Add a Person in a Space

  • id (path, required) — Id of the space
GET

/spaces/{id}/persons/all

Returns list of persons even persons archived

  • id (path, required) — Id of the space
  • Name (query) — Name of the person
  • Function (query) — Function of the person
  • Range (query) — index range of the results
  • Validated (query) — Status of the person
  • Email (query) — Email of the person
PATCH

/spaces/{id}/persons/{memberId}/player

Modify the role of a person

  • id (path, required) — Id of the space
  • memberId (path, required) — memberId of the person
DELETE

/spaces/{id}/persons/{personId}

delete a person

  • id (path, required) — Id of the space
  • personId (path, required) — Id of the person to modify or memberId
GET

/spaces/{id}/persons/{personId}

Returns a person

  • id (path, required) — Id of the space
  • personId (path, required) — Id of the person to get or memberId
PATCH

/spaces/{id}/persons/{personId}

Modify a person

  • id (path, required) — Id of the space
  • personId (path, required) — Id of the person to modify or memberId
GET

/spaces/{id}/persons/{personId}/details

Returns all details of a person

  • id (path, required) — Id of the space
  • personId (path, required) — Id of the person to get or memberId
POST

/spaces/{id}/persons/{personId}/details

Replace or Add a contact detail for a person

  • id (path, required) — Id of the space
  • personId (path, required) — Id of the person or memberId
DELETE

/spaces/{id}/persons/{personId}/details/{designation}

delete a contact detail for a person

  • id (path, required) — Id of the space
  • personId (path, required) — Id of the person or memberId
  • designation (path, required) — designation
GET

/spaces/{id}/persons/{personId}/folders

Returns list of folders with exceptionnal access of the person personId

  • id (path, required) — Id of the space
  • personId (path, required) — Id of the person to get folders
  • Range (query) — index range of the results
GET

/spaces/{id}/persons/{personId}/groups

Returns list of groups of the person personId

  • id (path, required) — Id of the space
  • personId (path, required) — Id of the person to get groups
GET

/spaces/{id}/persons/{personId}/portfolios

Returns list of portfolios of the person personId

  • id (path, required) — Id of the space
  • personId (path, required) — Id of the person to get portfolios
POST

/spaces/{id}/persons/{personId}/portfolios

Create a portfolio for the person personId

  • id (path, required) — Id of the space
  • personId (path, required) — Id of the person who will be the owner of the portfolio
PATCH

/spaces/{id}/portfolios/{portfolioId}/persons/{memberId}

Add/Modify/Delete a person in a portfolio (except manager)

  • id (path, required) — Id of the space
  • memberId (path, required) — memberId of the person
  • portfolioId (path, required) — id of the portfolio
GET

/spaces/{id}/professional-vehicles

Returns list of professionalvehicles for the space {id}

  • id (path, required) — Id of the space
  • Designation (query) — designation of the vehicle
POST

/spaces/{id}/professional-vehicles

Create a professional vehicle for the space

  • id (path, required) — Id of the space
GET

/spaces/{id}/settings/nf203/logs

Returns state of activation of logs

  • id (path, required) — Id of the space
POST

/spaces/{id}/settings/nf203/logs

Enable/Disable logs

  • id (path, required) — Id of the space
DELETE

/spaces/{id}/status/{code}

delete a status of the space

  • id (path, required) — Id of the space
  • code (path, required) — code of the status
GET

/spaces/{id}/tax-contracts

Returns list of tax contracts for the space {id}

  • id (path, required) — Id of the space
POST

/spaces/{id}/tax-contracts

Create a tax contract for the space

  • id (path, required) — Id of the space
GET

/spaces/{id}/triggers

Returns list of triggers for the space {id}

  • id (path, required) — Id of the space
DELETE

/spaces/{id}/triggers/{name}

Deletes a trigger for the space id

  • id (path, required) — Id of the space
  • name (path, required) — trigger name
POST

/spaces/{id}/triggers/{name}

Creates a trigger for the space id

  • id (path, required) — Id of the space
  • name (path, required) — trigger name
DELETE

/spaces/{spaceId}/common-folders/{id}

Delete a common folder

  • id (path, required) — Id of the folder
  • spaceId (path, required) — Id of the space
PATCH

/spaces/{spaceId}/common-folders/{id}

Modify a common folder

  • id (path, required) — Id of the folder
  • spaceId (path, required) — Id of the space
GET

/spaces/{spaceId}/company-entities/{id}/follow-ups

Returns folder of the company entity

  • id (path, required) — Id of the company entity
  • spaceId (path, required) — Id of the space
GET

/spaces/{spaceId}/customers

Returns folder with Id and customer data

  • spaceId (path, required) — Id of the space
  • CustomerNumber (query) — CustomerNumber of the customer
  • WithContractingPartner (query) — if present returns infos of the ContractingPartner too
GET

/spaces/{spaceId}/customers/all

Returns folder with Id and customer data (even archived)

  • spaceId (path, required) — Id of the space
  • CustomerNumber (query) — CustomerNumber of the employee
  • WithContractingPartner (query) — if present returns infos of the ContractingPartner too
GET

/spaces/{spaceId}/documents

Returns documents of the folder

  • spaceId (path, required) — Id of the space
  • FullText (query) — Text to find
  • Range (query) — index range of the results
  • Class (query) — class of the document to find
PATCH

/spaces/{spaceId}/documents/{documentId}

modify a doc

  • spaceId (path, required) — Id of the space
  • documentId (path, required) — Id of the document
GET

/spaces/{spaceId}/documents/{documentId}/extend

read the data of a document

  • documentId (path, required) — Id of the document
  • spaceId (path, required) — Id of the space
POST

/spaces/{spaceId}/documents/{documentId}/extend

Add a data to a document

  • documentId (path, required) — Id of the document
  • spaceId (path, required) — Id of the space
GET

/spaces/{spaceId}/documents/{documentId}/folders

Returns versions of the document

  • documentId (path, required) — Id of the document
  • spaceId (path, required) — Id of the space
POST

/spaces/{spaceId}/documents/{documentId}/mailing

send by mail a document

  • documentId (path, required) — Id of the document
  • spaceId (path, required) — Id of the space
GET

/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 document
  • spaceId (path, required) — Id of the space
GET

/spaces/{spaceId}/documents/{documentId}/versions

Returns versions of the document

  • documentId (path, required) — Id of the document
  • spaceId (path, required) — Id of the space
POST

/spaces/{spaceId}/documents/{documentId}/versions

Add a version to a document and set it as current

  • documentId (path, required) — Id of the document
  • spaceId (path, required) — Id of the space
GET

/spaces/{spaceId}/documents/{documentId}/versions/current

Returns current version of the document

  • documentId (path, required) — Id of the document
  • spaceId (path, required) — Id of the space
GET

/spaces/{spaceId}/documents/{id}/access

Returns accesses of one document

  • id (path, required) — Id of the document
  • spaceId (path, required) — Id of the space
GET

/spaces/{spaceId}/documents/{id}/accounting

Returns the document with the accounting property

  • id (path, required) — Id of the document
  • spaceId (path, required) — Id of the space
GET

/spaces/{spaceId}/documents/{id}/download

Returns content of one document

  • id (path, required) — Id of the document
  • spaceId (path, required) — Id of the space
GET

/spaces/{spaceId}/employees

Returns folders with Id and employee data

  • spaceId (path, required) — Id of the space
  • SSNumber (query) — SSNumber of the employee
  • EmployeeNumber (query) — EmployeeNumber of the employee
  • WithContractingPartner (query) — if present returns infos of the ContractingPartner too
GET

/spaces/{spaceId}/employees/all

Returns folders with Id and employee data (even archived)

  • spaceId (path, required) — Id of the space
  • SSNumber (query) — SSNumber of the employee
  • EmployeeNumber (query) — EmployeeNumber of the employee
  • WithContractingPartner (query) — if present returns infos of the ContractingPartner too
GET

/spaces/{spaceId}/employers

Returns folders with Id and employer data

  • spaceId (path, required) — Id of the space
  • EmployeeNumber (query) — EmployeeNumber of the employer contract
  • WithContractingPartner (query) — if present returns infos of the ContractingPartner too
GET

/spaces/{spaceId}/employers/all

Returns folders with Id and employer data (even archived)

  • spaceId (path, required) — Id of the space
  • EmployeeNumber (query) — EmployeeNumber of the employer contract
  • WithContractingPartner (query) — if present returns infos of the ContractingPartner too
GET

/spaces/{spaceId}/extend

read the data of a space

  • spaceId (path, required) — Id of the space
POST

/spaces/{spaceId}/extend

Add a data to a space

  • spaceId (path, required) — Id of the space
GET

/spaces/{spaceId}/folders

Returns folders of the space

  • Name (query) — Name of the folder
  • Keywords (query) — keywords attached to the folder
  • RootFolders (query) — only root folders
  • Range (query) — index range of the results
  • Class (query) — class of the folder
  • spaceId (path, required) — Id of the space
GET

/spaces/{spaceId}/folders/all

Returns folders of the space (even archived)

  • Name (query) — Name of the folder
  • Range (query) — index range of the results
  • Keywords (query) — keywords attached to the folder
  • Class (query) — class of the folder
  • spaceId (path, required) — Id of the space
DELETE

/spaces/{spaceId}/folders/{folderId}/bank-statements/{documentId}

delete a bank statement

  • spaceId (path, required) — Id of the space
  • folderId (path, required) — Id of the folder
  • documentId (path, required) — Id of the document
PATCH

/spaces/{spaceId}/folders/{folderId}/bank-statements/{documentId}

modify a bank statement

  • spaceId (path, required) — Id of the space
  • folderId (path, required) — Id of the folder
  • documentId (path, required) — Id of the document
DELETE

/spaces/{spaceId}/folders/{folderId}/contractual-documents/{documentId}

delete a contractual document

  • spaceId (path, required) — Id of the space
  • folderId (path, required) — Id of the folder
  • documentId (path, required) — Id of the document
PATCH

/spaces/{spaceId}/folders/{folderId}/contractual-documents/{documentId}

modify a contractual document

  • spaceId (path, required) — Id of the space
  • folderId (path, required) — Id of the folder
  • documentId (path, required) — Id of the document
DELETE

/spaces/{spaceId}/folders/{folderId}/corporate-tax-declarations/{documentId}

delete a corporate tax declaration

  • spaceId (path, required) — Id of the space
  • folderId (path, required) — Id of the folder
  • documentId (path, required) — Id of the document
PATCH

/spaces/{spaceId}/folders/{folderId}/corporate-tax-declarations/{documentId}

modify a coporate tax declaration

  • spaceId (path, required) — Id of the space
  • folderId (path, required) — Id of the folder
  • documentId (path, required) — Id of the document
DELETE

/spaces/{spaceId}/folders/{folderId}/expense-proofs/{documentId}

delete an expense proof

  • spaceId (path, required) — Id of the space
  • folderId (path, required) — Id of the folder
  • documentId (path, required) — Id of the document
PATCH

/spaces/{spaceId}/folders/{folderId}/expense-proofs/{documentId}

modify an expense report

  • spaceId (path, required) — Id of the space
  • folderId (path, required) — Id of the folder
  • documentId (path, required) — Id of the document
DELETE

/spaces/{spaceId}/folders/{folderId}/expense-reports/{documentId}

delete an expense report

  • spaceId (path, required) — Id of the space
  • folderId (path, required) — Id of the folder
  • documentId (path, required) — Id of the document
PATCH

/spaces/{spaceId}/folders/{folderId}/expense-reports/{documentId}

modify an expense report

  • spaceId (path, required) — Id of the space
  • folderId (path, required) — Id of the folder
  • documentId (path, required) — Id of the document
DELETE

/spaces/{spaceId}/folders/{folderId}/invoices/{documentId}

delete an invoice document

  • spaceId (path, required) — Id of the space
  • folderId (path, required) — Id of the folder
  • documentId (path, required) — Id of the document
PATCH

/spaces/{spaceId}/folders/{folderId}/invoices/{documentId}

modify a invoice

  • spaceId (path, required) — Id of the space
  • folderId (path, required) — Id of the folder
  • documentId (path, required) — Id of the document
GET

/spaces/{spaceId}/folders/{folderId}/nominative-social-declarations/{documentId}

get a nominative social declaration

  • spaceId (path, required) — Id of the space
  • folderId (path, required) — Id of the folder
  • documentId (path, required) — Id of the document
DELETE

/spaces/{spaceId}/folders/{folderId}/other-taxes/{documentId}

delete a tax declaration

  • spaceId (path, required) — Id of the space
  • folderId (path, required) — Id of the folder
  • documentId (path, required) — Id of the document
PATCH

/spaces/{spaceId}/folders/{folderId}/other-taxes/{documentId}

modify an other tax declaration

  • spaceId (path, required) — Id of the space
  • folderId (path, required) — Id of the folder
  • documentId (path, required) — Id of the document
DELETE

/spaces/{spaceId}/folders/{folderId}/payrolls/{documentId}

delete a payroll

  • spaceId (path, required) — Id of the space
  • folderId (path, required) — Id of the folder
  • documentId (path, required) — Id of the document
PATCH

/spaces/{spaceId}/folders/{folderId}/payrolls/{documentId}

modify a payroll

  • spaceId (path, required) — Id of the space
  • folderId (path, required) — Id of the folder
  • documentId (path, required) — Id of the document
POST

/spaces/{spaceId}/folders/{folderId}/payrolls/{documentId}/refresh

recalculate a payroll

  • spaceId (path, required) — Id of the space
  • folderId (path, required) — Id of the folder
  • documentId (path, required) — Id of the document
DELETE

/spaces/{spaceId}/folders/{folderId}/payslips/{documentId}

delete a payslip

  • spaceId (path, required) — Id of the space
  • folderId (path, required) — Id of the folder
  • documentId (path, required) — Id of the document
PATCH

/spaces/{spaceId}/folders/{folderId}/payslips/{documentId}

modify a payslip

  • spaceId (path, required) — Id of the space
  • folderId (path, required) — Id of the folder
  • documentId (path, required) — Id of the document
DELETE

/spaces/{spaceId}/folders/{folderId}/social-contracts/{documentId}

delete a social contract

  • spaceId (path, required) — Id of the space
  • folderId (path, required) — Id of the folder
  • documentId (path, required) — Id of the document
PATCH

/spaces/{spaceId}/folders/{folderId}/social-contracts/{documentId}

modify a social contract

  • spaceId (path, required) — Id of the space
  • folderId (path, required) — Id of the folder
  • documentId (path, required) — Id of the document
DELETE

/spaces/{spaceId}/folders/{folderId}/social-declarations/{documentId}

delete a social declaration

  • spaceId (path, required) — Id of the space
  • folderId (path, required) — Id of the folder
  • documentId (path, required) — Id of the document
PATCH

/spaces/{spaceId}/folders/{folderId}/social-declarations/{documentId}

modify a social declaration

  • spaceId (path, required) — Id of the space
  • folderId (path, required) — Id of the folder
  • documentId (path, required) — Id of the document
DELETE

/spaces/{spaceId}/folders/{folderId}/vat-declarations/{documentId}

delete a VAT declaration

  • spaceId (path, required) — Id of the space
  • folderId (path, required) — Id of the folder
  • documentId (path, required) — Id of the document
PATCH

/spaces/{spaceId}/folders/{folderId}/vat-declarations/{documentId}

modify a vat declaration

  • spaceId (path, required) — Id of the space
  • folderId (path, required) — Id of the folder
  • documentId (path, required) — Id of the document
GET

/spaces/{spaceId}/folders/{id}

Returns folder with Id

  • id (path, required) — Id of the folder
  • spaceId (path, required) — Id of the space
PATCH

/spaces/{spaceId}/folders/{id}

Modify a Folder (except Name, Class, ModificationDate and ArchivalDate)

  • id (path, required) — Id of the folder
  • spaceId (path, required) — Id of the space
DELETE

/spaces/{spaceId}/folders/{id}/accounting-year

delete an AccountingYear

  • id (path, required) — Id of the folder
  • spaceId (path, required) — Id of the space
PATCH

/spaces/{spaceId}/folders/{id}/accounting-year

Modify a Folder (except Name, Class, ModificationDate and ArchivalDate) and AccountingYear data

  • id (path, required) — Id of the folder
  • spaceId (path, required) — Id of the space
GET

/spaces/{spaceId}/folders/{id}/accountings

Returns accountings documents of the folder (results and taxation or accountingyear)

  • id (path, required) — Id of the folder
  • spaceId (path, required) — Id of the space
  • Date (query) — date range of the documents
  • FolderDate (query) — date range of attachment
  • Title (query) — Title of the accounting document
  • Workbook (query) — workbook of the accounting
  • Class (query) — class of the accounting
  • AccountedOn (query) — accountedon of the accounting (boolean available)
  • WithFolders (query) — if present, the folders containing the documents are returned
  • Range (query) — index range of the results
GET

/spaces/{spaceId}/folders/{id}/accountings-journal

journal of accountings document delivered to a customer

  • id (path, required) — Id of the customer folder
  • spaceId (path, required) — Id of the space
  • DeliveryDate (query) — delivery dates of the document
  • AccountingDate (query) — accounting dates of the document
  • Number (query) — numbers of the document
  • Workbook (query) — workbook of the document
  • YearMonth (query) — yearmonth of the document
  • Class (query) — class of the document
  • Code (query) — code of the document
  • TargetFolderName (query) — Name of the target folder of the document
DELETE

/spaces/{spaceId}/folders/{id}/bank

Delete a Folder (except Name, Class, ModificationDate and ArchivalDate) and Bank data

  • id (path, required) — Id of the folder
  • spaceId (path, required) — Id of the space
GET

/spaces/{spaceId}/folders/{id}/bank

Returns folder with Id and bank data

  • id (path, required) — Id of the folder
  • spaceId (path, required) — Id of the space
PATCH

/spaces/{spaceId}/folders/{id}/bank

Modify a Folder (except Name, Class, ModificationDate and ArchivalDate) and Bank data

  • id (path, required) — Id of the folder
  • spaceId (path, required) — Id of the space
GET

/spaces/{spaceId}/folders/{id}/bank-statements

Returns bank statements of the folder bank

  • id (path, required) — Id of the folder bank
  • spaceId (path, required) — Id of the space
  • Date (query) — range date of the documents
  • Number (query) — Number of the bank statement
  • Range (query) — index range of the results
POST

/spaces/{spaceId}/folders/{id}/bank-statements

Add a bank statement in a folder bank

  • id (path, required) — Id of the folder bank
  • spaceId (path, required) — Id of the space
PATCH

/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 folder
  • spaceId (path, required) — Id of the space
GET

/spaces/{spaceId}/folders/{id}/common-folders

Returns common folders of a folder

  • id (path, required) — Id of the folder
  • spaceId (path, required) — Id of the space
  • Name (query) — Name of the folder
  • Keywords (query) — keywords attached to the folder
POST

/spaces/{spaceId}/folders/{id}/common-folders

Add a common folder in another folder

  • id (path, required) — Id of the folder
  • spaceId (path, required) — Id of the space
GET

/spaces/{spaceId}/folders/{id}/common-folders/all

Returns common folders (even archived) of a folder

  • id (path, required) — Id of the folder
  • spaceId (path, required) — Id of the space
  • Name (query) — Name of the folder
  • Keywords (query) — keywords attached to the folder
GET

/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 space
GET

/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 space
GET

/spaces/{spaceId}/folders/{id}/contractual-documents

Returns documents of the folder

  • id (path, required) — Id of the folder
  • spaceId (path, required) — Id of the space
  • Date (query) — date range of the documents
  • FolderDate (query) — date range of attachment
  • Type (query) — Type of the document
  • Range (query) — index range of the results
POST

/spaces/{spaceId}/folders/{id}/contractual-documents

Add a document in a folder

  • id (path, required) — Id of the folder
  • spaceId (path, required) — Id of the space
GET

/spaces/{spaceId}/folders/{id}/contractual-relationship

Returns folder with Id and contractual-relationship data

  • id (path, required) — Id of the folder
  • spaceId (path, required) — Id of the space
GET

/spaces/{spaceId}/folders/{id}/coporate-tax-declarations

Returns corporate tax declarations

  • id (path, required) — Id of the folder result and taxation
  • spaceId (path, required) — Id of the space
  • Date (query) — range date of the documents
  • Range (query) — index range of the results
POST

/spaces/{spaceId}/folders/{id}/coporate-tax-declarations

Add a corporate tax declaration

  • id (path, required) — Id of the folder result and taxation
  • spaceId (path, required) — Id of the space
DELETE

/spaces/{spaceId}/folders/{id}/customer

delete a customer

  • id (path, required) — Id of the folder
  • spaceId (path, required) — Id of the space
GET

/spaces/{spaceId}/folders/{id}/customer

Returns folder with Id and customer data

  • id (path, required) — Id of the folder
  • spaceId (path, required) — Id of the space
POST

/spaces/{spaceId}/folders/{id}/other-taxes

Add a tax declaration

  • id (path, required) — Id of the folder tax contract
  • spaceId (path, required) — Id of the space
PATCH

/spaces/{spaceId}/folders/{id}/customer

Modify a Folder (except Name, Class, ModificationDate and ArchivalDate) and Customer data

  • id (path, required) — Id of the folder
  • spaceId (path, required) — Id of the space
GET

/spaces/{spaceId}/folders/{id}/deliveries-journal

journal of documents delivered to a customer

  • id (path, required) — Id of the customer folder
  • spaceId (path, required) — Id of the space
  • DeliveryDate (query) — delivery dates of the document
  • AccountingDate (query) — accounting dates of the document
  • Number (query) — numbers of the document
  • Class (query) — class of the document
  • TargetFolderName (query) — Name of the target folder of the document
GET

/spaces/{spaceId}/folders/{id}/documents

Returns documents of the folder

  • id (path, required) — Id of the folder
  • spaceId (path, required) — Id of the space
  • Date (query) — date range of the documents
  • Title (query) — Title of the document
  • FolderDate (query) — date range of attachment
  • Class (query) — Class of document
  • Range (query) — index range of the results
POST

/spaces/{spaceId}/folders/{id}/documents

Add a document in a folder

  • id (path, required) — Id of the folder
  • spaceId (path, required) — Id of the space
PATCH

/spaces/{spaceId}/folders/{id}/documents/{documentId}/detach

Detach a doc of a folder

  • id (path, required) — Id of the folder
  • spaceId (path, required) — Id of the space
  • documentId (path, required) — Id of the document
DELETE

/spaces/{spaceId}/folders/{id}/employee

Delete a Folder (except Name, Class, ModificationDate and ArchivalDate) and Employee data

  • id (path, required) — Id of the folder
  • spaceId (path, required) — Id of the space
GET

/spaces/{spaceId}/folders/{id}/employee

Returns folder with Id and employee data

  • id (path, required) — Id of the folder
  • spaceId (path, required) — Id of the space
PATCH

/spaces/{spaceId}/folders/{id}/employee

Modify a Folder (except Name, Class, ModificationDate and ArchivalDate) and Employee data

  • id (path, required) — Id of the folder
  • spaceId (path, required) — Id of the space
GET

/spaces/{spaceId}/folders/{id}/expense-proofs

Returns expense proofs of the folder (social, followup or exchange)

  • id (path, required) — Id of the folder
  • spaceId (path, required) — Id of the space
  • Date (query) — date range of the documents
  • FolderDate (query) — date range of attachment
  • Status (query) — Status of the expense proof
  • NoExpenseReport (query) — To return expense proofs not attached to an expense report
  • Range (query) — index range of the results
POST

/spaces/{spaceId}/folders/{id}/expense-proofs

Add a expense proof in a folder followup or exchange

  • id (path, required) — Id of the folder
  • spaceId (path, required) — Id of the space
GET

/spaces/{spaceId}/folders/{id}/expense-reports

Returns expense reports of the folder (social or followup)

  • id (path, required) — Id of the folder
  • spaceId (path, required) — Id of the space
  • Date (query) — date range of the documents
  • FolderDate (query) — date range of attachment
  • WithExtend (query) — If present returns also the data extend
  • Range (query) — index range of the results
  • ProcessingDate (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 sort
POST

/spaces/{spaceId}/folders/{id}/expense-reports

Add a expense report in a folder followup

  • id (path, required) — Id of the folder
  • spaceId (path, required) — Id of the space
GET

/spaces/{spaceId}/folders/{id}/other-taxes

Returns other taxes declarations

  • id (path, required) — Id of the folder taxcontract
  • spaceId (path, required) — Id of the space
  • Date (query) — range date of the documents
  • Range (query) — index range of the results
GET

/spaces/{spaceId}/folders/{id}/expense-reports/{expenseReportId}/expense-proofs

Returns expense proofs linked to the expenseReportId

  • id (path, required) — Id of the folder
  • spaceId (path, required) — Id of the space
  • expenseReportId (path, required) — Id of the expense report
  • Date (query) — Date of the documents (YYYY or YYYYMM or YYYYMMDD)
  • Status (query) — Status of the expense proof
  • FolderDate (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 folder
  • spaceId (path, required) — Id of the space
GET

/spaces/{spaceId}/folders/{id}/insurance

Returns folder with Id and insurance data

  • id (path, required) — Id of the folder
  • spaceId (path, required) — Id of the space
PATCH

/spaces/{spaceId}/folders/{id}/insurance

Modify a Folder (except Name, Class, ModificationDate and ArchivalDate) and Insurance data

  • id (path, required) — Id of the folder
  • spaceId (path, required) — Id of the space
GET

/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 folder
  • spaceId (path, required) — Id of the space
  • Title (query) — Title of the documents
  • Date (query) — date range of the documents
  • Number (query) — Number of the invoice
  • InclVAT (query) — amount incl. VAT
  • BeforeVAT (query) — amount before VAT
  • DueDate (query) — date due payment
  • PaymentDate (query) — date of payment (boolean and valid available)
  • InvoiceDate (query) — range date of invoice
  • FolderDate (query) — date range of attachment
  • AccountedOn (query) — value of AccountedOn (boolean available but not range)
  • WithExtend (query) — If present returns also the data extend
  • Extend (query) — json object to filter extend data
  • Range (query) — index range of the results
  • SortOrder (query) — order of sort (if absent default is asc)
  • SortName (query) — name of value for sort
POST

/spaces/{spaceId}/folders/{id}/invoices

Add a invoice in a folder of a customer or a provider

  • id (path, required) — Id of the folder
  • spaceId (path, required) — Id of the space
GET

/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 space
DELETE

/spaces/{spaceId}/folders/{id}/loan

Delete a Folder (except Name, Class, ModificationDate and ArchivalDate) and Loan data

  • id (path, required) — Id of the folder
  • spaceId (path, required) — Id of the space
GET

/spaces/{spaceId}/folders/{id}/loan

Returns folder with Id and loan data

  • id (path, required) — Id of the folder
  • spaceId (path, required) — Id of the space
PATCH

/spaces/{spaceId}/folders/{id}/loan

Modify a Folder (except Name, Class, ModificationDate and ArchivalDate) and Loan data

  • id (path, required) — Id of the folder
  • spaceId (path, required) — Id of the space
GET

/spaces/{spaceId}/folders/{id}/messages

Returns messages of the folder

  • Text (query) — Name of the message
  • Range (query) — index range of the results
  • MessageDate (query) — date of the message
  • spaceId (path, required) — Id of the space
  • id (path, required) — Id of the folder
POST

/spaces/{spaceId}/folders/{id}/messages

Write a message in the journal of a folder

  • id (path, required) — Id of the folder
  • spaceId (path, required) — Id of the space
GET

/spaces/{spaceId}/folders/{id}/messages/{messageId}

Returns message with Id

  • id (path, required) — Id of the folder
  • spaceId (path, required) — Id of the space
  • messageId (path, required) — Id of the mesage
PATCH

/spaces/{spaceId}/folders/{id}/messages/{messageId}

Modify a Message

  • id (path, required) — Id of the folder
  • spaceId (path, required) — Id of the space
  • messageId (path, required) — Id of the message
GET

/spaces/{spaceId}/folders/{id}/nominative-social-declarations

Returns nominative social declarations of the folder social

  • id (path, required) — Id of the folder social
  • spaceId (path, required) — Id of the space
  • Date (query) — range date of the documents
  • Range (query) — index range of the results
GET

/spaces/{spaceId}/folders/{id}/passwords

Returns identifiers/passwords of the folder

  • spaceId (path, required) — Id of the space
  • id (path, required) — Id of the folder
POST

/spaces/{spaceId}/folders/{id}/passwords

Write a identifier/password in aa folder

  • id (path, required) — Id of the folder
  • spaceId (path, required) — Id of the space
DELETE

/spaces/{spaceId}/folders/{id}/passwords/{passwordId}

delete a password

  • id (path, required) — Id of the folder
  • spaceId (path, required) — Id of the space
  • passwordId (path, required) — Id of the password
GET

/spaces/{spaceId}/folders/{id}/passwords/{passwordId}

Returns password with Id

  • id (path, required) — Id of the folder
  • spaceId (path, required) — Id of the space
  • passwordId (path, required) — Id of the password
PATCH

/spaces/{spaceId}/folders/{id}/passwords/{passwordId}

Modify a Password

  • id (path, required) — Id of the folder
  • spaceId (path, required) — Id of the space
  • passwordId (path, required) — Id of the password
GET

/spaces/{spaceId}/folders/{id}/payrolls

Returns payrolls of the folder social

  • id (path, required) — Id of the folder social
  • spaceId (path, required) — Id of the space
  • Date (query) — range date of the documents
  • Begin (query) — begin date of the payrolls
  • End (query) — end date of the payrolls
  • Range (query) — index range of the results
POST

/spaces/{spaceId}/folders/{id}/payrolls

Add a payroll in a folder social

  • id (path, required) — Id of the folder social
  • spaceId (path, required) — Id of the space
DELETE

/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 social
  • spaceId (path, required) — Id of the space
  • payrollId (path, required) — Id of the payroll
POST

/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 social
  • spaceId (path, required) — Id of the space
  • payrollId (path, required) — Id of the payroll
GET

/spaces/{spaceId}/folders/{id}/payslips

Returns payslips of the folder employee

  • id (path, required) — Id of the folder employee
  • spaceId (path, required) — Id of the space
  • Date (query) — range date of the documents
  • Range (query) — index range of the results
POST

/spaces/{spaceId}/folders/{id}/payslips

Add a payslip in a folder employee

  • id (path, required) — Id of the folder employee
  • spaceId (path, required) — Id of the space
DELETE

/spaces/{spaceId}/folders/{id}/portfolio/{portfolioId}

delete a secondary portfolio of a customer contract

  • id (path, required) — Id of the folder
  • spaceId (path, required) — Id of the space
  • portfolioId (path, required) — Id of the portfolio
DELETE

/spaces/{spaceId}/folders/{id}/professional-vehicle

delete a Professional Vehicle

  • id (path, required) — Id of the folder
  • spaceId (path, required) — Id of the space
PATCH

/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 folder
  • spaceId (path, required) — Id of the space
DELETE

/spaces/{spaceId}/folders/{id}/provider

delete a provider

  • id (path, required) — Id of the folder
  • spaceId (path, required) — Id of the space
GET

/spaces/{spaceId}/folders/{id}/provider

Returns folder with Id and provider data

  • id (path, required) — Id of the folder
  • spaceId (path, required) — Id of the space
PATCH

/spaces/{spaceId}/folders/{id}/provider

Modify a Folder (except Name, Class, ModificationDate and ArchivalDate) and Provider data

  • id (path, required) — Id of the folder
  • spaceId (path, required) — Id of the space
GET

/spaces/{spaceId}/folders/{id}/required-documents

list of the required documents for a person

  • id (path, required) — Id of the folder either exchange either followup
  • spaceId (path, required) — Id of the space
PATCH

/spaces/{spaceId}/folders/{id}/required-documents/{requireddocumentid}

Modify the status of a requireddocument

  • id (path, required) — Id of the folder exchange or followup
  • spaceId (path, required) — Id of the space
  • requireddocumentid (path, required) — Id of the requireddocument
POST

/spaces/{spaceId}/folders/{id}/required-documents/{requireddocumentid}

Add a required document to a line

  • id (path, required) — Id of the folder exchange or followup
  • spaceId (path, required) — Id of the space
  • requireddocumentid (path, required) — Id of the requireddocument
DELETE

/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 followup
  • spaceId (path, required) — Id of the space
  • requireddocumentid (path, required) — Id of the requireddocument
  • documentId (path, required) — Id of the document to delete
GET

/spaces/{spaceId}/folders/{id}/sections

Returns sections of the folder

  • id (path, required) — Id of the folder
  • spaceId (path, required) — Id of the space
GET

/spaces/{spaceId}/folders/{id}/social-contracts

Returns social contracts of the folder employee

  • id (path, required) — Id of the folder employee
  • spaceId (path, required) — Id of the space
  • Date (query) — range date of the documents
  • Range (query) — index range of the results
POST

/spaces/{spaceId}/folders/{id}/social-contracts

Add a social contract in a folder employee

  • id (path, required) — Id of the folder employee
  • spaceId (path, required) — Id of the space
GET

/spaces/{spaceId}/folders/{id}/social-declarations

Returns social declarations

  • id (path, required) — Id of the folder socialregime
  • spaceId (path, required) — Id of the space
  • Date (query) — range date of the documents
  • Range (query) — index range of the results
POST

/spaces/{spaceId}/folders/{id}/social-declarations

Add a social declaration

  • id (path, required) — Id of the folder social regime
  • spaceId (path, required) — Id of the space
DELETE

/spaces/{spaceId}/folders/{id}/social-regimes

delete a social regime

  • id (path, required) — Id of the folder
  • spaceId (path, required) — Id of the space
GET

/spaces/{spaceId}/folders/{id}/social-regimes

Returns folder with Id and social regime data

  • id (path, required) — Id of the folder
  • spaceId (path, required) — Id of the space
PATCH

/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 folder
  • spaceId (path, required) — Id of the space
GET

/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 folder
  • spaceId (path, required) — Id of the space
  • Number (query) — Number of the invoice
  • InclVat (query) — amount incl. VAT
  • BeforeVAT (query) — amount before VAT
  • DueDate (query) — range date due payment
  • PaymentDate (query) — range date of payment
  • InvoiceDate (query) — range date of invoice
DELETE

/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 folder
  • spaceId (path, required) — Id of the space
PATCH

/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 folder
  • spaceId (path, required) — Id of the space
PATCH

/spaces/{spaceId}/persons/{id}/invitation

modify an invitation

  • id (path, required) — Id of the person
  • spaceId (path, required) — Id of the space
GET

/spaces/{spaceId}/folders/{id}/vat-declarations

Returns vat declarations

  • id (path, required) — Id of the folder result and taxation
  • spaceId (path, required) — Id of the space
  • Date (query) — range date of the documents
  • Range (query) — index range of the results
POST

/spaces/{spaceId}/folders/{id}/vat-declarations

Add a vat declaration

  • id (path, required) — Id of the folder result and taxation
  • spaceId (path, required) — Id of the space
DELETE

/spaces/{spaceId}/folders/{id}/{documentClass}

delete a class document

  • spaceId (path, required) — Id of the space
  • id (path, required) — Id of the folder
  • documentClass (path, required) — class of the document
GET

/spaces/{spaceId}/folders/{id}/{documentClass}

Returns document of documentClass (without specific data) of the folder

  • id (path, required) — Id of the folder
  • spaceId (path, required) — Id of the space
  • documentClass (path, required) — class of the document
POST

/spaces/{spaceId}/folders/{id}/{documentClass}

Add a document in a folder

  • id (path, required) — Id of the folder
  • spaceId (path, required) — Id of the space
  • documentClass (path, required) — class of the document
GET

/spaces/{spaceId}/legal-entities/{id}/banks

Returns list of bank folders for a legal-entity

  • id (path, required) — Id of the legal-entity
  • spaceId (path, required) — Id of the space
POST

/spaces/{spaceId}/legal-entities/{id}/banks

Add a folder for a bank

  • id (path, required) — Id of the bank or memberId
  • spaceId (path, required) — Id of the space
GET

/spaces/{spaceId}/legal-entities/{id}/banks/all

Returns folder of the banks even archived

  • id (path, required) — Id of the bank
  • spaceId (path, required) — Id of the space
GET

/spaces/{spaceId}/legal-entities/{id}/contracts

Returns all contract folders of the legal entity

  • id (path, required) — Id of the legal entity or memberId
  • spaceId (path, required) — Id of the space
GET

/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 memberId
  • spaceId (path, required) — Id of the space
GET

/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 memberId
  • spaceId (path, required) — Id of the space
GET

/spaces/{spaceId}/legal-entities/{id}/customers

Returns folder of the customer

  • id (path, required) — Id of the customer or memberId
  • spaceId (path, required) — Id of the space
POST

/spaces/{spaceId}/legal-entities/{id}/customers

Add a folder for a customer

  • id (path, required) — Id of the customer or memberId
  • spaceId (path, required) — Id of the space
GET

/spaces/{spaceId}/legal-entities/{id}/customers/all

Returns folder of the customers (even archived)

  • id (path, required) — Id of the customer or memberId
  • spaceId (path, required) — Id of the space
GET

/spaces/{spaceId}/legal-entities/{id}/insurances

Returns list of insurance folders for a legal-entity

  • id (path, required) — Id of the insurance
  • spaceId (path, required) — Id of the space
POST

/spaces/{spaceId}/legal-entities/{id}/insurances

Add a folder for a insurance

  • id (path, required) — Id of the insurance or memberId
  • spaceId (path, required) — Id of the space
GET

/spaces/{spaceId}/legal-entities/{id}/insurances/all

Returns folder of the insurances even archived

  • id (path, required) — Id of the insurance
  • spaceId (path, required) — Id of the space
GET

/spaces/{spaceId}/legal-entities/{id}/loans

Returns folder of the loan

  • id (path, required) — Id of the loan
  • spaceId (path, required) — Id of the space
POST

/spaces/{spaceId}/legal-entities/{id}/loans

Add a folder for a loan

  • id (path, required) — Id of the loan or memberId
  • spaceId (path, required) — Id of the space
GET

/spaces/{spaceId}/legal-entities/{id}/loans/all

Returns folder of the loans even archived

  • id (path, required) — Id of the loan
  • spaceId (path, required) — Id of the space
GET

/spaces/{spaceId}/legal-entities/{id}/providers

Returns list of providers folders for a legal-entity

  • id (path, required) — Id of the provider or memberId
  • spaceId (path, required) — Id of the space
POST

/spaces/{spaceId}/legal-entities/{id}/providers

Add a folder for a provider

  • id (path, required) — Id of the provider or memberId
  • spaceId (path, required) — Id of the space
GET

/spaces/{spaceId}/legal-entities/{id}/providers/all

Returns folder of the providers even archived

  • id (path, required) — Id of the provider or memberId
  • spaceId (path, required) — Id of the space
GET

/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 memberId
  • spaceId (path, required) — Id of the space
POST

/spaces/{spaceId}/legal-entities/{id}/social-regimes

Add a folder for a social regime

  • id (path, required) — Id of the legal entity or memberId
  • spaceId (path, required) — Id of the space
GET

/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 memberId
  • spaceId (path, required) — Id of the space
GET

/spaces/{spaceId}/loans

Returns list of all loan folders of the space

  • spaceId (path, required) — Id of the space
GET

/spaces/{spaceId}/loans/all

Returns list of all loan folders even archived of the space

  • spaceId (path, required) — Id of the space
PATCH

/spaces/{spaceId}/persons/{id}/call-for-document

modify the invitation of a person to collect documents

  • id (path, required) — Id of the person
  • spaceId (path, required) — Id of the space
POST

/spaces/{spaceId}/persons/{id}/call-for-document

invite a person to collect documents

  • id (path, required) — Id of the person or memberId
  • spaceId (path, required) — Id of the space
GET

/spaces/{spaceId}/persons/{id}/employees

Returns folder of the employee

  • id (path, required) — Id of the person or memberId
  • spaceId (path, required) — Id of the space
POST

/spaces/{spaceId}/persons/{id}/employees

Add a folder for a employee

  • id (path, required) — Id of the employee
  • spaceId (path, required) — Id of the space
GET

/spaces/{spaceId}/persons/{id}/employees/all

Returns folder of all employees (even archived)

  • id (path, required) — Id of the person or memberId
  • spaceId (path, required) — Id of the space
GET

/spaces/{spaceId}/persons/{id}/exchange

Returns folder exchange of the person

  • id (path, required) — Id of the person or memberId
  • spaceId (path, required) — Id of the space
GET

/spaces/{spaceId}/persons/{id}/follow-ups

Returns folder of the person

  • id (path, required) — Id of the person or memberId
  • spaceId (path, required) — Id of the space
DELETE

/spaces/{spaceId}/persons/{id}/guest-in-space

delete the invitation of a person in a space

  • id (path, required) — Id of the person
  • spaceId (path, required) — Id of the space
PATCH

/spaces/{spaceId}/persons/{id}/guest-in-space

invite a person in a space

  • id (path, required) — Id of the person
  • spaceId (path, required) — Id of the space
POST

/spaces/{spaceId}/persons/{id}/guest-in-space

invite a person in a space

  • id (path, required) — Id of the person
  • spaceId (path, required) — Id of the space
DELETE

/spaces/{spaceId}/persons/{id}/invitation

delete the invitation of a person in a space

  • id (path, required) — Id of the person
  • spaceId (path, required) — Id of the space
GET

/spaces/{spaceId}/persons/{id}/invitation

Returns invitation of a person

  • id (path, required) — Id of the person
  • spaceId (path, required) — Id of the space
POST

/spaces/{spaceId}/persons/{id}/invitation

create an invitation in a space for a person

  • id (path, required) — Id of the person
  • spaceId (path, required) — Id of the space
POST

/spaces/{spaceId}/persons/{id}/invitation/{invitationId}/send

send the invitation of a person in a space

  • id (path, required) — Id of the person
  • invitationId (path, required) — Id of the invitation
  • spaceId (path, required) — Id of the space
GET

/spaces/{spaceId}/persons/{memberId}/folders/{id}

Returns folderId with the access of the person

  • id (path, required) — Id of the folder
  • spaceId (path, required) — Id of the space
  • memberId (path, required) — memberId of the person
PATCH

/spaces/{spaceId}/persons/{memberId}/folders/{id}

Modify an access

  • id (path, required) — Id of the folder
  • spaceId (path, required) — Id of the space
  • memberId (path, required) — memberId of the person
GET

/spaces/{spaceId}/providers

Returns folder with Id and provider data

  • spaceId (path, required) — Id of the space
  • WithContractingPartner (query) — if present returns infos of the ContractingPartner too
GET

/spaces/{spaceId}/providers/all

Returns folder with Id and provider data (even archived)

  • spaceId (path, required) — Id of the space
  • WithContractingPartner (query) — if present returns infos of the ContractingPartner too
GET

/spaces/{spaceId}/search

Research text inside documents, folders or messages

  • spaceId (path, required) — Id of the space
  • Query (query) — Text to find
  • Range (query) — index range of the results
  • QueryContext (query) — context of research
GET

/spaces/{spaceId}/social-regimes

Returns folder with Id and social regime data

  • spaceId (path, required) — Id of the space
  • WithContractingPartner (query) — if present returns infos of the ContractingPartner too
GET

/spaces/{spaceId}/social-regimes/all

Returns folder with Id and social regime data (even archived)

  • spaceId (path, required) — Id of the space
  • WithContractingPartner (query) — if present returns infos of the ContractingPartner too
GET

/spaces/{spaceId}/spaces-invoicings

Returns CSV Invoicings of the spaces for the account of the spaceId

  • spaceId (path, required) — Id of the space
  • Date (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