Partners (customers, suppliers, employees)

​

Definition

A partner is an external entity involved in your accounting processes: a customer (client), a supplier, or an employee. Partners are required to post receivable, payable, and payroll-related entries and to drive reconciliation flows.

​

Purpose

• Serve as the reference entity for transactions in the accounting system.
• Link each transaction to the correct third-party account.
• Store contact, tax and bank information about the entity.

​

Structure

Clients and suppliers share the same structure. Each one has:

• An identifier (id) in the accounting software
• A name (name). For an individual (is_company is false), also a first name (first_name) and a last name (last_name)
• An external reference (external_reference): your own identifier for the partner, to link it to your system
• Tax and legal identifiers: the VAT number (vat) and the company number (company_number)
• A ledger account (account_number): the account used on journal entry lines to debit or credit this partner
• A third-party account (third_party_account): the code of the partner in the accounting software
• Contact information: email, phone, mobile, website and the addresses (addresses)
• Bank accounts (bank_accounts) and a currency (currency)
• An active flag (active)
• The date of the last update (last_updated_on). Use it with updated_after for incremental synchronization

Employees have a smaller structure: identifier, name, contact information, reference and ledger account.

​

Relationships

• Partners are defined at the level of a folder.
• Invoices reference their client or supplier with partner_id.
• Journal entry lines and outstanding items reference a client, supplier or employee with partner_id. Use partner_id to filter journal entries.
• A partner’s account_number is a ledger account. See Accounts in invoices and Accounts in journal entries.
• A client or supplier can have several contact persons, returned by Get contacts of a partner.

​

API endpoints

• Get clients: list all clients.
• Get one client: retrieve a specific client.
• Get suppliers: list all suppliers.
• Get one supplier: retrieve a specific supplier.
• Get employees: list all employees.
• Get contacts of a partner: list the contact persons of a client or supplier.
• Create client: create a client.
• Update client: update an existing client.
• Create supplier: create a supplier.
• Update supplier: update an existing supplier.

Support for each endpoint differs per accounting software. Check the coverage matrix.