The Accounting Entries API endpoints enable you to perform the following: - Apply filters and search for accounting entries and accounting receipts. - Retrieve list of accounting entries and accounting receipts. - Retrieve details of a specific accounting entry.
openapi: 3.0.1
info:
title: App Marketplace accounting-entries API
description: API for Pleo App Marketplace
termsOfService: https://pleo.io/terms/
contact:
email: partner-ecosystem-team@pleo.io
license:
name: Apache 2.0
url: http://www.apache.org/licenses/LICENSE-2.0.html
version: 39.4.0
servers:
- url: https://external.pleo.io
description: Production server
- url: https://external.staging.pleo.io
description: Staging server
security:
- bearerAuth: []
- basicAuth: []
tags:
- name: accounting-entries
description: "The Accounting Entries API endpoints enable you to perform the following:\n - Apply filters and search for accounting entries and accounting receipts.\n - Retrieve list of accounting entries and accounting receipts.\n - Retrieve details of a specific accounting entry."
paths:
/v1/accounting-entries/core:search:
post:
tags:
- accounting-entries
summary: 'Fetch core accounting entries based on filters. '
operationId: externalSearchCoreAccountingEntriesV1
parameters:
- name: company_id
in: query
description: Only return accounting entries that have the specific company ID. Required if partner_id or organization_id is not provided.
required: false
style: form
explode: true
schema:
type: string
format: uuid
- name: organization_id
in: query
description: Only return accounting entries that belong to the companies associated. to the given Organization Id. Required if company_id or partner_id is not provided.
required: false
style: form
explode: true
schema:
type: string
format: uuid
- name: before
in: query
description: Lower bound of the page of data to return (cannot be used together with [after])
required: false
style: form
explode: true
schema:
type: string
- name: after
in: query
description: Upper bound of the page of data to return (cannot be used together with [before])
required: false
style: form
explode: true
schema:
type: string
- name: limit
in: query
required: false
style: form
explode: true
schema:
maximum: 100
minimum: 1
type: integer
description: The maximum amount of items to return. Never returns more than 100 items
format: int32
default: 20
- name: sorting_order
in: query
description: The order to sort the results by. Must be the same length as [sortingKeys]; one order per key.
required: false
style: form
explode: true
schema:
type: array
items:
$ref: '#/components/schemas/PageOrder'
- name: sorting_keys
in: query
description: The keys to sort the results by
required: false
style: form
explode: true
schema:
type: array
items:
$ref: '#/components/schemas/AccountingEntriesSortingKeys'
requestBody:
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/AccountingEntryBaseSearchRequest'
responses:
default:
description: default response
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/CursorPaginatedResponseAccountingEntryCoreV6'
deprecated: true
/v1/accounting-entries:search:
post:
tags:
- accounting-entries
summary: 'Fetch accounting entries based on filters. '
operationId: externalSearchAccountingEntriesV1
parameters:
- name: company_id
in: query
description: Only return accounting entries that have the specific company ID. Required if partner_id or organization_id is not provided.
required: false
style: form
explode: true
schema:
type: string
format: uuid
- name: organization_id
in: query
description: Only return accounting entries that belong to the companies associated. to the given Organization Id. Required if company_id or partner_id is not provided.
required: false
style: form
explode: true
schema:
type: string
format: uuid
- name: before
in: query
description: Lower bound of the page of data to return (cannot be used together with [after])
required: false
style: form
explode: true
schema:
type: string
- name: after
in: query
description: Upper bound of the page of data to return (cannot be used together with [before])
required: false
style: form
explode: true
schema:
type: string
- name: limit
in: query
required: false
style: form
explode: true
schema:
maximum: 100
minimum: 1
type: integer
description: The maximum amount of items to return. Never returns more than 100 items
format: int32
default: 20
- name: sorting_order
in: query
description: The order to sort the results by. Must be the same length as [sortingKeys]; one order per key.
required: false
style: form
explode: true
schema:
type: array
items:
$ref: '#/components/schemas/PageOrder'
- name: sorting_keys
in: query
description: The keys to sort the results by
required: false
style: form
explode: true
schema:
type: array
items:
$ref: '#/components/schemas/AccountingEntriesSortingKeys'
requestBody:
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/AccountingEntryBaseSearchRequest'
responses:
'200':
description: A paginated list of accounting entries matching the search criteria.
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/CursorPaginatedResponseAccountingEntryV1'
'403':
description: 'Forbidden: client lacks the necessary permissions.'
'503':
description: Service temporarily unavailable. The request can be retried.
/v1/accounting-entries/{accountingEntryId}:
get:
tags:
- accounting-entries
summary: 'Fetch a single accounting entry by id. '
operationId: externalGetAccountingEntryV1
parameters:
- name: accountingEntryId
in: path
required: true
style: simple
explode: false
schema:
type: string
description: The specific accounting entry ID that you are looking for.
format: uuid
- name: include_deleted
in: query
required: false
style: form
explode: true
schema:
type: boolean
description: Set this to true if you want to include deleted accounting entries.
responses:
'200':
description: The accounting entry for the specified ID.
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/DataResponseAccountingEntryV1'
'403':
description: 'Forbidden: client lacks the necessary permissions.'
'404':
description: Accounting entry not found.
'503':
description: Service temporarily unavailable. The request can be retried.
/v1/accounting-entries/receipts:search:
post:
tags:
- accounting-entries
summary: Apply filters to search for specific accounting entry receipts.
operationId: searchReceiptsByPostV6
parameters:
- name: company_id
in: query
description: Return only receipts of the given Company Id. Required if `partner_id` or `organization_id` is not provided.
required: false
style: form
explode: true
schema:
type: string
format: uuid
- name: partner_id
in: query
description: Return only receipts of the specific companies associated with the given Partner ID. Required if `company_id` or `organization_id` is not provided.
required: false
style: form
explode: true
schema:
type: string
format: uuid
- name: organization_id
in: query
description: Return only receipts of the specific companies associated with the given Organization ID. Required if `company_id` or `partner_id` is not provided.
required: false
style: form
explode: true
schema:
type: string
format: uuid
- name: before
in: query
description: Lower bound of the page of data to return (cannot be used together with [after])
required: false
style: form
explode: true
schema:
type: string
- name: after
in: query
description: Upper bound of the page of data to return (cannot be used together with [before])
required: false
style: form
explode: true
schema:
type: string
- name: limit
in: query
required: false
style: form
explode: true
schema:
maximum: 100
minimum: 1
type: integer
description: The maximum amount of items to return. Never returns more than 100 items
format: int32
default: 10
- name: sorting_order
in: query
description: The order to sort the results by. Must be the same length as [sortingKeys]; one order per key.
required: false
style: form
explode: true
schema:
type: array
items:
$ref: '#/components/schemas/PageOrder'
- name: sorting_keys
in: query
description: The keys to sort the results by
required: false
style: form
explode: true
schema:
type: array
items:
$ref: '#/components/schemas/ReceiptsSortingKeys'
requestBody:
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/ReceiptSearchRequest'
responses:
default:
description: default response
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/CursorPaginatedResponseReceiptModel'
/v1/accounting-entries/{accountingEntryId}/core:
get:
tags:
- accounting-entries
summary: Get details of an accounting entry.
operationId: getCoreAccountingEntryV6ById
parameters:
- name: accountingEntryId
in: path
required: true
style: simple
explode: false
schema:
type: string
description: The specific accounting entry ID that you are looking for.
format: uuid
- name: include_deleted
in: query
required: false
style: form
explode: true
schema:
type: boolean
description: Set this to true if you want to include deleted accounting entries.
- name: include_hidden
in: query
required: false
style: form
explode: true
schema:
type: boolean
description: Set this to true if you want to include hidden accounting entries. ONLY USE THIS IF YOU KNOW WHAT YOU'RE DOING.
deprecated: true
responses:
default:
description: default response
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/DataResponseAccountingEntryCoreV6'
/v1/accounting-entries/{accountingEntryId}/receipts:
get:
tags:
- accounting-entries
summary: Get all receipts of an accounting entry.
operationId: getAllReceiptsV6
parameters:
- name: accountingEntryId
in: path
required: true
style: simple
explode: false
schema:
type: string
format: uuid
- name: source
in: query
description: Only return Receipts with the given source. Useful for fetching a list of receipts uploaded via particular sources.
required: false
style: form
explode: true
schema:
type: array
items:
$ref: '#/components/schemas/ReceiptSource'
- name: file_type
in: query
description: Return all receipts with the presigned URL generated for the given file type. Used for fetching receipts with a presigned URL other than the default (ORIGINAL).
required: false
style: form
explode: true
schema:
$ref: '#/components/schemas/ReceiptFileType'
- name: before
in: query
description: Lower bound of the page of data to return (cannot be used together with [after])
required: false
style: form
explode: true
schema:
type: string
- name: after
in: query
description: Upper bound of the page of data to return (cannot be used together with [before])
required: false
style: form
explode: true
schema:
type: string
- name: limit
in: query
required: false
style: form
explode: true
schema:
maximum: 100
minimum: 1
type: integer
description: The maximum amount of items to return. Never returns more than 100 items
format: int32
default: 10
- name: sorting_order
in: query
description: The order to sort the results by. Must be the same length as [sortingKeys]; one order per key.
required: false
style: form
explode: true
schema:
type: array
items:
$ref: '#/components/schemas/PageOrder'
- name: sorting_keys
in: query
description: The keys to sort the results by
required: false
style: form
explode: true
schema:
type: array
items:
$ref: '#/components/schemas/ReceiptsSortingKeys'
responses:
default:
description: default response
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/CursorPaginatedResponseReceiptModel'
/v1/accounting-entries/{accountingEntryId}/receipts/{receiptId}:
get:
tags:
- accounting-entries
summary: Returns a receipt with time-bound access to the receipt file.
operationId: getReceiptFileV6
parameters:
- name: accountingEntryId
in: path
required: true
style: simple
explode: false
schema:
type: string
description: The specific accounting entry ID that you are looking for.
format: uuid
- name: receiptId
in: path
required: true
style: simple
explode: false
schema:
type: string
description: The specific receipt ID that you are looking for.
format: uuid
- name: file_type
in: query
required: false
style: form
explode: true
schema:
$ref: '#/components/schemas/ReceiptFileType'
responses:
default:
description: default response
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/DataResponseReceiptModel'
components:
schemas:
ExportStatus:
type: string
description: '`CREATED`: The accounting entry has been created.
`EXPORTED`: The accounting entry has been exported.
`EXPORTING`: The accounting entry is in the process of being exported.
`QUEUED`: The accounting entry is in the queue to be exported.
'
enum:
- CREATED
- EXPORTED
- EXPORTING
- NOT_CREATED
- NOT_EXPORTED
- QUEUED
AccountingEntryCoreV6:
required:
- companyId
- createdAt
- exportStatus
- family
- fees
- id
- performedAt
- receiptIds
- reviewStatus
- status
- transactionValue
- updatedAt
type: object
properties:
accountCode:
type: string
description: The account code allocated to the specific accounting entry. For example, an expense incurred for meals and drinks account would have a specific account code.
accountId:
type: string
description: 'Unique identification number of the account (Category) allocated to the transaction. If `I don''t know` is selected, then in the API endpoint response, `"00000000-0000-0000-0000-000000000000"` is returned, implying no category is yet selected for the specific accounting entry. '
format: uuid
bookkeepingDate:
type: string
description: The date when the transaction was settled, except for out of pocket expenses; for out of pocket expense, the bookkeeping date is when the purchase was done.
format: date-time
companyId:
type: string
description: The unique identifier of the company that to which the accounting entry belongs.
format: uuid
createdAt:
type: string
description: The date and time when the specific accounting entry is created.
format: date-time
deletedAt:
type: string
description: If the accounting entry is deleted, this field specifies the date and time of deletion.
format: date-time
employeeId:
type: string
description: The unique identifier of the employee who incurred the expense.
format: uuid
exportStatus:
type: string
description: 'This can be one of `ExportStatus` values.
`CREATED`: The accounting entry has been created.
`EXPORTED`: The accounting entry has been exported.
`EXPORTING`: The accounting entry is in the process of being exported.
`QUEUED`: The accounting entry is in the queue to be exported.
'
example: CREATED
externalAccountId:
type: string
description: The external id of the account specified for this accounting entry.
format: uuid
family:
type: string
description: 'This can be one of `AccountingEntryFamily` values.
`BALANCE_AMENDMENT`: Represents manual wallet balance adjustments, often through human intervention.
`BILL_INVOICE`: Represents an invoice issued to the company. If payment of the invoice is made via Pleo, the payment is recorded separately, using the `BILL_INVOICE_PAYMENT` family.
`CARD_PURCHASE`: Represents a purchase made using a physical or virtual Pleo card.
`CASHBACK`: An amount of money that is returned to the company through Pleo cashback.
`CREDIT_NOTE`: Represents a credit note issued to the company, stored only in the accounting entry metadata table.
`MILEAGE`: Represents a Mileage expense incurred by an employee. The amount is owed to the employee.
`OUT_OF_POCKET`: Represents an amount that is spent by an employee out of their own pocket. The amount is owed to the employee.
`OVERDRAFT`: Represents either the monthly subscription fee for using Pleo Overdraft, or a the interest incurred on an existing overdraft.
`PER_DIEM`: Represents a daily allowance given to an employee during travel - the amount is owed to the employee.
`PLEO_INVOICE`: Represents the SaaS invoice from Pleo to the company.
`REIMBURSEMENT`: Represents a reimbursement from the company to the employee or vice-versa.
`WALLET`: Represents a top up or withdrawal on the Pleo wallet
`BILL_INVOICE_PAYMENT`: Represents a payment of an invoice from the company wallet.
'
example: BALANCE_AMENDMENT
fees:
type: object
additionalProperties:
description: A mapping of fee type to fee amount, for example foreign transaction fees.
allOf:
- $ref: '#/components/schemas/Money'
description: A mapping of fee type to fee amount, for example foreign transaction fees.
foreignExtensionId:
type: string
description: This is an auto-generated ID that populates when the Accounting Entries API endpoints interact with other Pleo APIs.
grossBillValue:
description: '**DEPRECATED** Please use the Tax Calculation API instead. Bill value **before** taxes. Currency is the same as `transactionWalletValue`'
allOf:
- $ref: '#/components/schemas/Money'
id:
type: string
description: The unique identifier of the specific accounting entry.
format: uuid
netBillValue:
description: '**DEPRECATED** Please use the Tax Calculation API instead. Bill value **after** taxes. Currency is the same as `transactionWalletValue`'
allOf:
- $ref: '#/components/schemas/Money'
note:
type: string
description: An optional note that can be added to the accounting entry.
performedAt:
type: string
description: The date and time when the transaction was performed.
format: date-time
receiptIds:
uniqueItems: true
type: array
description: IDs of any receipts associated with the specific accounting entry.
items:
type: string
description: IDs of any receipts associated with the specific accounting entry.
format: uuid
reconciliationId:
type: string
description: The id of the specific reconciliation that was used to export and book this accounting entry.
example: '4113617'
reviewStatus:
type: string
description: 'This can be one of `ReviewStatus` values.
`NOT_OK`: The accounting entry has been reviewed as `Not OK`.
`NOT_REQUIRED`: The accounting entry does not require review.
`NOT_SET`: The accounting entry has not been reviewed yet.
`OK`: The accounting entry has been reviewed as `OK`.
`WAITING_FOR_EXPENSE_OWNER`: The accounting entry is waiting for more details from the Expense Owner.
`WAITING_FOR_REVIEWER`: The accounting entry is waiting for review by a reviewer.
`WAITING_FOR_COMPANY_REVIEWER`: The accounting entry is waiting for review by a company reviewer.
`WAITING_FOR_TEAM_REVIEWER`: The accounting entry is waiting for review by a team reviewer.
`WAITING_FOR_TAG_REVIEWER`: The accounting entry is waiting for review by a tag reviewer.
'
example: NOT_OK
settledAt:
type: string
description: The date and time when the transaction was settled. For example in the case of a card purchase, the date when the transaction was finalized.
format: date-time
spendTransactionIds:
uniqueItems: true
type: array
description: A list of IDs of spend transactions associated with the specific accounting entry.
items:
type: string
description: A list of IDs of spend transactions associated with the specific accounting entry.
format: uuid
status:
type: string
description: "This can be one of `AccountingEntryStatus` values.\n\n`DRAFT`: The accounting entry is still in a work-in-progress stage; the details might change.\n`PENDING`: Payment is in progress. The transaction amount in the specific currency is final, yet the funds have not\n yet been settled.> ⚠️ **Note**: The customer can no longer cancel this expense.\n> amount/currency is fixed, funds have been reserved but not yet settled,\n> and expense can no longer be canceled by user\n`COMPLETED`: The transaction is complete, implying the funds have been settled for the final bill amount.\n`COMPLETED_EXTERNALLY`: Payment has completed *outside of Pleo*. Hence, it does not impact the Pleo wallet\n`CANCELLED`: Canceled by user, Pleo, or an external party\n`REJECTED`: Rejected by user, Pleo or an external party\n`ERROR`: An error prevented the accounting entry from being settled\n"
example: DRAFT
subFamily:
type: string
description: 'This can be one of `AccountingEntrySubFamily` values.
`ATM`: A `CARD_PURCHASE` that was performed at an ATM.
`IN_STORE`: A `CARD_PURCHASE` that was performed at a physical store.
`ONLINE`: A `CARD_PURCHASE` that was performed online.
`PLEO_INVOICE`: A `PLEO_INVOICE` that was paid.
`PLEO_INVOICE_REFUND`: A `PLEO_INVOICE` that was refunded.
`REIMBURSEMENT_TO_COMPANY`: A `REIMBURSEMENT` was made to the company.
`REIMBURSEMENT_TO_EMPLOYEE`: A `REIMBURSEMENT` was made to the employee.
`REIMBURSEMENT_TO_EMPLOYEE_REFUND`: A `REIMBURSEMENT` to the employee was refunded.
`LOAD`: Either a `WALLET` or a BALANCE_AMENDMENT` load.
`UNLOAD`: Either a `WALLET` or a BALANCE_AMENDMENT` unload - Money leaves the Pleo wallet.
`WITHDRAWAL`: A `WALLET` withdrawal.
`FEE`: A monthly fee paid for using overdraft.
`INTEREST`: Interest paid for the amount over drafted.
`BILL_INVOICE_PAYMENT_RETURNED`: A `BILL_INVOICE_PAYMENT` that was returned.
`BILL_INVOICE_PAYMENT_RECEIVED`: A `BILL_INVOICE_PAYMENT` that was received.
'
example: ATM
supplier:
$ref: '#/components/schemas/AccountingEntrySupplier'
taxBillValue:
description: '**DEPRECATED** Please use the Tax Calculation API instead. Specifies the tax amount. Currency is the same as `transactionWalletValue`'
allOf:
- $ref: '#/components/schemas/Money'
taxCodeId:
type: string
description: A unique identifier that references the specific `TaxCode` applied to the specific accounting entry.
format: uuid
teamId:
type: string
description: A unique identifier of the team to which the accounting entry belongs. For example, an accounting entry is associated with the Design team of a company. So, the entry specifies the Design Team ID
format: uuid
totalBillValue:
description: 'The total amount that is either debited or credited from the Pleo wallet of the company.
- Could be more than the `transactionWalletValue` as in a card purchase, payment processing fees are included.
- `BILL_INVOICE` includes scheduled payments. They are included in the `totalBillValue`, yet they do not impact the actual Pleo wallet balance.'
allOf:
- $ref: '#/components/schemas/Money'
transactionValue:
description: ' The transaction amount in the specific currency the payment was performed. For example, an expense is incurred in France. So the value returned is in Euro ( EUR ).'
allOf:
- $ref: '#/components/schemas/Money'
transactionWalletValue:
description: 'The transaction amount in the functional currency of the company. For example, a company is based in the United Kingdom. An employee incurs an expense in France. The `transactionWalletValue` is the amount in Great Britain Pound ( GBP ) equivalent to the Euro ( EUR ) spent for the purchase. '
allOf:
- $ref: '#/components/schemas/Money'
updatedAt:
type: string
description: Specifies the date and time when details of the specific accounting entry is modified.
format: date-time
CursorPaginatedResponseAccountingEntryV1:
required:
- data
- pagination
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/AccountingEntryV1'
pagination:
$ref: '#/components/schemas/CursorPageInfo'
ReceiptMimeType:
type: string
description: '`unknown`: The MIME type of the file is unknown.
`application/pdf`: The receipt file is a PDF file.
`application/postscript`: The receipt file is a PostScript file.
`application/xml`: The receipt file is a xml e-invoice.
`image/jpeg`: The receipt file is a JPEG image.
`image/png`: The receipt file is a PNG image.
`image/heic`: The receipt file is a HEIC image.
`image/heif`: The receipt file is a HEIF image.
`image/gif`: The receipt file is a GIF image.
`text/xml`: The receipt file is a xml e-invoice.
'
enum:
- unknown
- application/pdf
- application/postscript
- application/xml
- image/jpeg
- image/png
- image/heic
- image/heif
- image/gif
- text/xml
AccountingEntryV1:
required:
- attendees
- companyId
- createdAt
- exportStatus
- family
- id
- performedAt
- receiptIds
- reviewStatus
- splitItems
- status
- tags
- transactionValue
- updatedAt
type: object
properties:
accountCode:
type: string
description: The account code allocated to the specific accounting entry. For example, an expense incurred for meals and drinks account would have a specific account code.
accountId:
type: string
description: 'Unique identification number of the account (Category) allocated to the transaction. If `I don''t know` is selected, then in the API endpoint response, `"00000000-0000-0000-0000-000000000000"` is returned, implying no category is yet selected for the specific accounting entry. '
format: uuid
attendees:
type: array
description: A list of attendee objects associated with the accounting entry. For example, in the case of a business meal expense, attendees would be the people who attended the meal. Each attendee is represented as an `AttendeeV1` object containing identifying information for either an employee or a contact.
items:
description: A list of attendee objects associated with the accounting entry. For example, in the case of a business meal expense, attendees would be the people who attended the meal. Each attendee is represented as an `AttendeeV1` object containing identifying information for either an employee or a contact.
allOf:
- $ref: '#/components/schemas/AttendeeV1'
bookkeepingDate:
type: string
description: The date when the transaction was settled, except for out of pocket expenses; for out of pocket expense, the bookkeeping date is when the purchase was done.
format: date-time
companyId:
type: string
description: The unique identifier of the company that to which the accounting entry belongs.
format: uuid
createdAt:
type: string
description: The date and time when the specific accounting entry is created.
format: date-time
deletedAt:
type: string
description: If the accounting entry is deleted, this field specifies the date and time of deletion.
format: date-time
employeeId:
type: string
description: The unique identifier of the employee who incurred the expense.
format: uuid
exportStatus:
type: string
description: 'This can be one of `ExportStatus` values.
`CREATED`: The accounting entry has been created.
`EXPORTED`: The accounting entry has been exported.
`EXPORTING`: The accounting entry is in the process of being exported.
# --- truncated at 32 KB (65 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/pleo/refs/heads/main/openapi/pleo-accounting-entries-api-openapi.yml