How-to guides
These guides walk through specific integration tasks end to end: prerequisites, API sequence, headers, and troubleshooting. They mirror the Fluide Business help center but are written for developers calling Fluide APIs.Quickstarts verify connectivity and your first call. Guides go deeper on a single feature or cross-product workflow.
Guide structure
| Section | Purpose |
|---|---|
| Overview | What you will accomplish |
| Prerequisites | Credentials, permissions, existing data |
| Steps | Numbered API sequence with curl examples |
| Tips | Conventions and optimizations |
| Troubleshooting | Common errors and fixes |
| Related | API reference and adjacent guides |
Partner integrations: include
X-Workspace-Id and X-Acting-Company-Id on product API calls. See Multi-tenancy.Service partner
Onboard a client company
Create a workspace and client company for a partner integration, then store IDs for acting-client API calls.
Issue a self-onboarding link
Generate a one-time URL so a merchant completes their own company profile.
Submit client KYB
Upload KYB documents and submit partner-mediated compliance review for a client company.
Act as a client via API
Scope product API requests to a specific merchant using acting-client headers.
Manage workspaces
Create, list, and organize partner workspaces that group client companies.
Complete partner firm KYB
Submit Know Your Business verification for your SERVICE_PARTNER organization.
Manage partner team members
Invite and assign roles to staff in your SERVICE_PARTNER organization.
List partner transactions
View payment and wallet transactions across client companies in your partner portfolio.
HR & People
Add an employee
Create a single employee record via the HR API — canonical source for payroll.
Bulk import employees
Download the HR import template and upload a spreadsheet of employees.
Configure employee payout rails
Set up bank or mobile-money payout rails for employees via HR API.
Update an employee profile
Patch employee personal, employment, and contact details via API.
Download employee CV
Export an employee CV document via HR or Utils document APIs.
HR Operations
Manage employment contracts
Create and update employment contracts that drive payroll eligibility.
Request leave
Submit and track employee leave requests via the HR API.
Clock attendance
Record clock-in and clock-out events for attendance tracking.
Configure leave policy
Set up leave types, accrual rules, and approval workflows.
Run a performance cycle
Create and manage performance review cycles via API.
Offboard an employee
Deactivate an employee and close out contracts and access.
Payroll
Run payroll
Create, calculate, approve, and complete a payroll run via API.
Configure payroll settings
Set pay frequency, tax rules, and payroll configuration for a company.
Payroll chart of accounts
Map payroll components to GL accounts before Books integration.
Pay
Create wallet types
Provision operating and other wallet types for a client company.
First payroll disbursement
Disburse net pay from a completed payroll run to employee payout rails.
Create a payment link
Generate a checkout session or payment link for collecting customer payments.
Collect invoice payment
Record payment against a Books invoice via Pay integration.
Disburse a bill payment
Pay an approved vendor bill from your operating wallet.
Export bank payment files
Generate bank upload files for bulk payroll or vendor disbursements.
Books
Books overview for integrators
Understand accounting modules, subsidiaries, and API layout for Fluide Books.
Create an invoice
Create and send a customer invoice via the Books API.
Record a bill
Create a vendor bill for accounts payable.
Post a journal entry
Create and post double-entry journal entries to the general ledger.
Chart of accounts
List and create GL accounts in the account hierarchy.
Manage business partners
Create customers and vendors used on invoices and bills.
Bill approval workflow
Submit bills for approval and track approval status via API.
Recurring journal entries
Set up automated recurring GL entries.
Record invoice payment
Apply a payment to an open invoice in Books.
Bank reconciliation
Match bank transactions to ledger entries.
Financial statements
Generate P&L, balance sheet, and cash flow reports via API.
Configure tax settings
Set tax codes and rates for invoices and bills.
Access & Auth
Machine tokens and scopes
Exchange API keys for JWTs and understand permission scoping for integrations.
Create a custom org role
Define a custom role with specific permission strings.
Assign org roles
Assign roles to organization members.
Check permissions
Validate session and inspect effective permissions for debugging.
Utils
Generate payslip PDF
Generate a payslip PDF and retrieve a public URL via Utils.
Send a notification
Send email, SMS, or push notifications via Utils.
Upload and retrieve files
Store and fetch files via the Utils file API.
Playbooks
HR → Payroll employee sync
How HR mirrors employees into Payroll after API create.
Payroll → Books GL posting
GL mappings and journal posting after payroll completes.
Partner onboard to first employee
End-to-end: workspace → company → acting headers → HR employee.
Partner onboard to first payroll
Full ISV path from merchant onboarding through first payroll run.
Hire to payslip
HR create → payroll run → payslip PDF delivery.
Invoice to cash collection
Books invoice → Pay payment link → record payment.
Multi-tenancy
Organization vs partner tenancy models.
API reference
Full endpoint schemas and playground.