Data types
Partners (Customers, Suppliers, Employees)
Definition
A partner represents a counterparty involved in your accounting processes. Partners are the third parties used in accounting: customers, suppliers, and employees. They are required to post receivable/payable/payroll-related entries and to drive reconciliation flows.Purpose
- Serve as the reference entity for transactions in the accounting system.
- Maintain accurate accounting records by linking transactions to the correct accounts.
- Provide additional metadata such as contact information, payment terms, and tax information.
Relationships
- Always referenced by invoices. Possibly also in financial entries, and journal entries.
- Can have default ledger accounts for automatic posting in journal entries.
Endpoints
Clients
| Method | Endpoint | Description |
|---|---|---|
| POST | Create Client | Create a client (customer) |
| GET | Get One Client | Retrieve a specific client |
| GET | Get Clients | List all clients |
| PATCH | Update Client | Update an existing client |
Suppliers
| Method | Endpoint | Description |
|---|---|---|
| POST | Create Supplier | Create a supplier |
| GET | Get One Supplier | Retrieve a specific supplier |
| GET | Get Suppliers | List all suppliers |
| PATCH | Update Supplier | Update an existing supplier |
Employees
| Method | Endpoint | Description |
|---|---|---|
| GET | Get Employees | List all employees |