Pleo accounting-entries-external API
The accounting-entries-external API from Pleo — 3 operation(s) for accounting-entries-external.
The accounting-entries-external API from Pleo — 3 operation(s) for accounting-entries-external.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/pleo-accounting-entries-external-api"
curl "https://apis.io/api/v1/apis?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: App Marketplace accounting-entries Accounting Entries External 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-external
paths:
/v1/accounting-entries/core:search:
post:
tags:
- accounting-entries-external
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-external
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-external
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.
components:
schemas:
DataResponseAccountingEntryV1:
required:
- data
type: object
properties:
data:
$ref: '#/components/schemas/AccountingEntryV1'
CursorPaginatedResponseAccountingEntryV1:
required:
- data
- pagination
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/AccountingEntryV1'
pagination:
$ref: '#/components/schemas/CursorPageInfo'
ReviewStatus:
type: string
description: '`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.
'
enum:
- NOT_OK
- NOT_REQUIRED
- NOT_SET
- OK
- WAITING_FOR_EXPENSE_OWNER
- WAITING_FOR_REVIEWER
- WAITING_FOR_COMPANY_REVIEWER
- WAITING_FOR_TEAM_REVIEWER
- WAITING_FOR_TAG_REVIEWER
CursorPageCurrentRequestInfo:
required:
- parameters
type: object
properties:
after:
type: string
before:
type: string
limit:
type: integer
format: int32
offset:
type: integer
format: int64
parameters:
type: object
additionalProperties:
type: array
items:
type: string
sortingKeys:
type: array
items:
type: string
sortingOrder:
type: array
items:
$ref: '#/components/schemas/PageOrder'
AccountingEntrySupplier:
type: object
properties:
cif:
type: string
documentNumber:
type: string
documentType:
type: string
description: This can be one of `SupplierDocumentType` values.
example: FACTURA
externalAccountNumber:
type: string
externalSupplierId:
type: string
AccountingEntryFamily:
type: string
description: '`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.
'
enum:
- BALANCE_AMENDMENT
- BILL_INVOICE
- CARD_PURCHASE
- CASHBACK
- CREDIT_NOTE
- MILEAGE
- OUT_OF_POCKET
- OVERDRAFT
- PER_DIEM
- PLEO_INVOICE
- REIMBURSEMENT
- WALLET
- BILL_INVOICE_PAYMENT
Money:
required:
- currency
- minors
type: object
properties:
currency:
type: string
description: The currency codes followed in Pleo conforms with ISO 4217.
example: EUR
minors:
type: integer
description: "The transaction amount is represented in smallest denomination in a specific currency.\n For example:\n- A transaction amount is £65.80 in Great Britain Pounds (GBP); this represented as `6580`.\n- A transaction amount is 1500 ISK in Icelandic Króna (ISK); this is represented as `1500`."
format: int64
example: 10
AccountingEntrySubFamily:
type: string
description: '`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.
'
enum:
- ATM
- IN_STORE
- ONLINE
- PLEO_INVOICE
- PLEO_INVOICE_REFUND
- REIMBURSEMENT_TO_COMPANY
- REIMBURSEMENT_TO_EMPLOYEE
- REIMBURSEMENT_TO_EMPLOYEE_REFUND
- LOAD
- UNLOAD
- WITHDRAWAL
- FEE
- INTEREST
- BILL_INVOICE_PAYMENT_RETURNED
- BILL_INVOICE_PAYMENT_RECEIVED
CursorPaginatedResponseAccountingEntryCoreV6:
required:
- data
- pagination
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/AccountingEntryCoreV6'
pagination:
$ref: '#/components/schemas/CursorPageInfo'
SplitItemV1:
required:
- createdAt
- id
- tags
- updatedAt
type: object
properties:
accountCode:
type: string
description: 'The account code picked for the specific split item. If this is not null, it should be used instead of the account code from the `accountId` field. '
accountId:
type: string
description: 'The id 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. '
format: uuid
createdAt:
type: string
description: The time when the split item was created. This is in ISO 8601 format. For example, `2024-01-01T12:00:00Z`.
format: date-time
id:
type: string
description: Unique identifier of the split item
format: uuid
tags:
type: array
description: A list of `AccountingEntryTagV1` objects representing the tags associated with the split item.
items:
description: A list of `AccountingEntryTagV1` objects representing the tags associated with the split item.
allOf:
- $ref: '#/components/schemas/AccountingEntryTagV1'
taxCodeId:
type: string
description: A unique identifier that references the specific `TaxCode` applied to the specific split item.
format: uuid
totalBillValue:
description: The portion of the transaction amount assigned to this split item, represented as a `Money` object in the company's default currency.
allOf:
- $ref: '#/components/schemas/Money'
transactionValue:
description: The transaction amount in the currency in which the payment was made, represented as a `Money` object. For example, if an expense is incurred in France, the value is returned in EUR.
allOf:
- $ref: '#/components/schemas/Money'
updatedAt:
type: string
description: The time when the split item was last updated. This is in ISO 8601 format. For example, `2024-01-01T12:00:00Z`.
format: date-time
description: A list of `SplitItemV1` objects associated with the accounting entry. The list is empty when the entry has not been split. When the entry is split, the list contains the resulting split items.
AttendeeV1:
required:
- attendableId
- attendableType
- id
type: object
properties:
attendableId:
type: string
attendableType:
type: string
description: This can be one of `AccountingEntryAttendeeType` values.
example: CONTACT
id:
type: string
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.
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.
`QUEUED`: The accounting entry is in the queue to be exported.
'
example: CREATED
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
foreignExtensionId:
type: string
description: This is an auto-generated ID that populates when the Accounting Entries API endpoints interact with other Pleo APIs.
id:
type: string
description: The unique identifier of the specific accounting entry.
format: uuid
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
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
splitItems:
type: array
description: A list of `SplitItemV1` objects associated with the accounting entry. The list is empty when the entry has not been split. When the entry is split, the list contains the resulting split items.
items:
description: A list of `SplitItemV1` objects associated with the accounting entry. The list is empty when the entry has not been split. When the entry is split, the list contains the resulting split items.
allOf:
- $ref: '#/components/schemas/SplitItemV1'
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'
tags:
type: array
description: A list of `AccountingEntryTagV1` objects representing the tags associated with the accounting entry.
items:
description: A list of `AccountingEntryTagV1` objects representing the tags associated with the accounting entry.
allOf:
- $ref: '#/components/schemas/AccountingEntryTagV1'
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 billed value of the transaction used for accounting purposes, represented as a `Money` object in the company’s default currency.
allOf:
- $ref: '#/components/schemas/Money'
transactionValue:
description: The transaction amount in the currency in which the payment was made, represented as a `Money` object. For example, if an expense is incurred in France, the value is returned in EUR.
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
AccountingEntryStatus:
type: string
description: "`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"
enum:
- DRAFT
- PENDING
- COMPLETED
- COMPLETED_EXTERNALLY
- CANCELLED
- REJECTED
- ERROR
AccountingEntryBaseSearchRequest:
required:
- includeDeleted
type: object
properties:
accountIds:
maxItems: 100
minItems: 0
type: array
description: Only return accounting entries that match with the given account IDs.
items:
type: string
format: uuid
bookkeepingDateEnd:
type: string
description: Return accounting entries that have been recorded prior to the specific bookkeeping date. This value cannot be used with other date search criteria.
format: date-time
bookkeepingDateStart:
type: string
description: Return accounting entries that have been recorded after the specific bookkeeping date. This value cannot be used with any other date search criteria.
format: date-time
employeeIds:
maxItems: 100
minItems: 0
type: array
description: Only return accounting entries that match with the specific Employee ID.
items:
type: string
format: uuid
exportStatus:
type: array
description: 'Only return accounting entries that match with the specific export status. '
items:
$ref: '#/components/schemas/ExportStatus'
families:
type: array
description: Only return accounting entries that belong to the specific accounting entry families
items:
$ref: '#/components/schemas/AccountingEntryFamily'
foreignExtensionIds:
maxItems: 100
minItems: 0
type: array
description: Only return accounting entries with the given `foreignExtensionId`. This is an auto-generated ID that populates when the Accounting Entries API endpoints interact with other Pleo APIs.'
items:
type: string
hasAccount:
type: boolean
description: Only return accounting entries with an Account ID assigned
hasBookkeepingDate:
type: boolean
description: Only return Accounting Entries that have bookkeeping date set
hasNote:
type: boolean
description: Return accounting entries that have a note
includeDeleted:
type: boolean
description: Include deleted accounting entries
default: false
performedAtEnd:
type: string
description: Only return accounting entries performed before this date. Cannot be used with any other date filters
format: date-time
performedAtStart:
type:
# --- truncated at 32 KB (48 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/pleo/refs/heads/main/openapi/pleo-accounting-entries-external-api-openapi.yml