canonical: https://jentic.com/apis/gerermesaffaires.com/gerermesaffaires

# GererMesAffaires {REST:API}

Jentic publishes the only available OpenAPI specification for GererMesAffaires {REST:API}, keeping it validated and agent-ready. GererMesAffaires is a French secure document and business administration platform used by accountants, advisors, and SMEs to exchange invoices, payslips, contracts, and other regulated documents with their clients. The API exposes document workflows, business groups, spaces, hubs, customer folders, signatures, payslips, and notifications across roughly 280 endpoints. It is most often used to integrate accounting software with the GererMesAffaires hub so client documents flow automatically into the right space.

## For AI agents

Push and pull regulated documents, payslips, and customer folders into French SME workspaces and exchange them with accountants. Manage business groups, spaces, hubs, and document signatures programmatically.

## Scope

Does not handle accounting ledgers, tax filing, or payroll calculation - use for secure document and payslip exchange between French accountants and clients only.

## Capabilities

- Push payslips and accounting documents into a client's secure space inside a business group
- Create and manage business groups, spaces, and hub structures for accountant-client document exchange
- Send and track e-signature requests on contracts and engagement letters
- Synchronise customer folders between an external accounting system and the GererMesAffaires hub
- Manage user profiles, registrations, and session activity for the platform's tenants
- Distribute notifications and menu structures across hubs and spaces

## Use cases

### Accountant-to-Client Payslip Distribution

French accounting firms produce payslips for their SME clients each month and need a secure, audit-trailed way to deliver them. The GererMesAffaires API accepts payslip uploads into the client's space inside the firm's hub, so the firm's payroll software can push files automatically and the client retrieves them via the GererMesAffaires portal. This replaces email-based delivery with an audited workflow.

Example prompt: Upload a payslip PDF for a named employee to space {spaceId} on hub {hub} via `POST `/hub/spaces/{spaceId}/payslips`` and confirm the file ID in the response.

### Business Group and Space Provisioning

When an accounting firm onboards a new client, it must create a business group, provision a dedicated space, and grant access to specific users. The API exposes business-group and space CRUD plus guest access endpoints, so onboarding can be automated end-to-end from the firm's CRM rather than configured manually in the GererMesAffaires UI.

Example prompt: Create a business group via `POST /business-groups`, then add a space and grant a guest user access using `POST `/business-groups/{id}/spaces/{spaceId}/legal-entities/{personId}/customers/{folderId}/guest-in-space``.

### Document Synchronisation with External Accounting Software

Accounting tools that hold ledgers, invoices, and tax filings need a secure way to mirror documents into the client portal so clients can view, download, and acknowledge them. The API's document and hub endpoints provide a one-way push from the system of record into the GererMesAffaires hub, keeping the portal consistent with the firm's tooling.

Example prompt: For each new invoice exported from the accounting system, call `POST `/hub/documents`` to push the file into the correct hub and capture the resulting document ID.

### Agent-Driven Client Document Workflow

An AI agent embedded in an accounting firm's tooling can answer queries like 'send last month's payslip to client X' by discovering the right GererMesAffaires operation through Jentic and executing it. The agent does not need a hand-coded integration: Jentic resolves the natural-language intent to the payslip-push endpoint and calls it with the correct parameters.

Example prompt: Given a client name and month, look up the matching space, then call `POST `/hub/spaces/{spaceId}/payslips`` via Jentic to push the payslip and return the document ID to the user.

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/business-groups` | Create a business group for an accounting firm |
| GET | `/business-groups/{id}/spaces` | List spaces inside a business group |
| POST | `/hub/documents` | Push a document into a hub |
| POST | `/hub/payslips` | Push a payslip into a hub |
| POST | `/hub/spaces/{spaceId}/payslips` | Push a payslip into a specific client space |
| POST | `/registration` | Register a new user profile |
| GET | `/profile` | Retrieve the current user profile |

## Key resources

- **Business Groups** — Top-level tenant entities representing accounting firms or SME owners.
- **Spaces** — Per-client workspaces inside a business group where documents are exchanged.
- **Hub** — Hub-scoped document and payslip endpoints for client-facing exchange.
- **Documents** — Files pushed into spaces or hubs, with metadata and audit trails.
- **Profile** — User account profile, contact details, and identity files.
- **Registration** — Registration and session lifecycle endpoints for new users.

## Why Jentic

- **Setup:** Wiring the GererMesAffaires API by hand means running the OAuth 2.0 flow, refreshing tokens, and navigating a large operation surface for document and payslip exchange yourself. Through Jentic you install once, import GererMesAffaires from the API Directory, complete the OAuth grant once, and your agent calls it.
- **Permission scoping:** GererMesAffaires puts the space id in the URL path (`/hub/spaces/{spaceId}/payslips`), so a rule can pin your agent to one space: it can push payslips to that space and nothing else. You choose the operations it may call, so broader ones like creating business groups or registration are not included unless you add them.
- **Credential handling:** Your GererMesAffaires OAuth tokens are stored once, encrypted, by your own Jentic One instance and refreshed at execution time. The raw access and refresh tokens never enter the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'push a payslip to a client space', and Jentic returns the matching GererMesAffaires operation with its input schema so the agent calls the right endpoint without browsing the large operation surface.

## Related APIs

- **PandaDoc** — Document automation and e-signature platform for proposals, contracts, and quotes.
- **Contentful** — Headless content platform that can hold marketing content while GererMesAffaires holds regulated client documents.
- **Sanity** — Structured content backend often paired with regulated document portals to host firm-facing content.

## FAQ

### Why is there no official OpenAPI spec for GererMesAffaires {REST:API}?

GererMesAffaires does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call GererMesAffaires {REST:API} via structured tooling. It is validated against the live API and kept up to date. Get started with Jentic One, the self-hosted execution layer.

### What authentication does the GererMesAffaires API use?

The API uses OAuth 2.0 (`gma_auth`). Through Jentic, OAuth tokens are stored in the encrypted vault and refreshed automatically - agents receive a scoped execution token rather than the underlying access or refresh tokens.

### Can I push payslips to a specific client space with the GererMesAffaires API?

Yes. Call `POST `/hub/spaces/{spaceId}/payslips`` to push a payslip into a named space, or `POST `/hub/payslips`` for the hub-default space. Both endpoints accept the file and metadata fields.

### How do I provision a new business group through Jentic?

Search Jentic for `create a business group in GererMesAffaires`, load the schema for `POST /business-groups`, and execute with the group name and owner. Jentic handles the OAuth flow so the agent does not see raw tokens.

### Does the GererMesAffaires API handle accounting ledgers or tax filing?

No. The API moves documents and manages workspace structure; it does not record ledger entries or file taxes. Combine it with a dedicated accounting system for those workflows.

### Can the GererMesAffaires API send a document for e-signature?

Yes - document endpoints include signature workflow fields. Use the document creation endpoints under `/hub/documents` and `/hub/spaces/{spaceId}/documents` and supply the relevant signature parameters.

### Can I limit what my agent is allowed to do with the GererMesAffaires API?

Yes. Because you run Jentic One yourself, your own rules decide which GererMesAffaires operations and credentials the agent may use. Since the space id sits in the URL path, such as POST `/hub/spaces/{spaceId}/payslips`, a rule can pin the agent to a single client space so it only pushes payslips there and nothing else. You also choose the operation set, so broader calls like POST /business-groups or POST /registration are excluded unless you explicitly grant them.
