New to the Accounting Entries API?
API Overview
What an Accounting Entry is and how the API is structured.
API Scopes
Required scope:
accounting-entries:read.Generate API Keys
How to generate standalone API keys for authenticating your integration.
Standalone API Key Guide
End-to-end guide for authenticating with standalone API keys.
Standalone API Keys with Postman
How to make API calls using standalone API keys in Postman.
Getting Started
You’ll need API credentials with at least theaccounting-entries:read scope. Once authenticated, the two main endpoints you’ll use are:
Key Differences
- Field names and structure have changed. See Field Mapping below.
- The Accounting Entries API uses cursor-based pagination.
Field Mapping
The table below maps fields from theExpense model to their equivalents in the AccountingEntry model.
—: field is not available in the AccountingEntry model*: data is the same but represented differently. See the Accounting Entries API reference for details.
Expense field | AccountingEntry equivalent |
|---|---|
| id | id |
| employeeId | employeeId |
| employeeCode | — |
| departmentId | teamId |
| performedAt | performedAt |
| amountOriginal | transactionValue |
| amountSettled | totalBillValue * |
| note | note |
| type | family * |
| accountId | accountId |
| taxCodeId | taxCodeId |
| createdAt | createdAt |
| updatedAt | updatedAt |
| deletedAt | deletedAt |
| tagIds[].id | tags[].tagId |
| tagIds[].tagGroupId | tags[].tagGroupId |
| receiptIds[] | receiptIds[] |
| settledExpenseIds[] | — |
| status | status * |
| supplier.CIF | supplier.cif |
| supplier.documentNumber | supplier.documentNumber |
| cardTransaction.state | — |
| cardTransaction.authorizedAt | — |
| cardTransaction.settledAt | settledAt |
| cardTransaction.reversedAt | — |
| cardTransaction.merchant.id | — |
| cardTransaction.merchant.name | — |
| lines[].amountSettled | splitItems[].totalBillValue * |
| lines[].accountId | splitItems[].accountId |
| lines[].taxCodeId | splitItems[].taxCodeId |
| lines[].tagIds[] | splitItems[].tags[].tagId |
| lines[].accountCode | splitItems[].accountCode |
New Fields in AccountingEntryV1
The following fields are available inAccountingEntryV1 with no equivalent in the Expense API.
| Field | Description |
|---|---|
| companyId | Company the entry belongs to |
| accountCode | Account code for the entry |
| bookkeepingDate | Date used for accounting records |
| subFamily | Finer-grained classification within family |
| exportStatus | Export state of the entry (separate from status) |
| reviewStatus | Review state of the entry |
| attendees | People associated with the entry (e.g. attendees of a business meal) |
| foreignExtensionId | Auto-generated ID used when this API interacts with other Pleo APIs |