Pleo Export Items (v1) API
The Export Items (v1) API from Pleo — 1 operation(s) for export items (v1).
OpenAPI Specification
openapi: 3.0.1
info:
title: App Marketplace accounting-entries Export Items (v1) 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: Export Items (v1)
paths:
/v1/export-items:
get:
tags:
- Export Items (v1)
summary: Get Export Items
description: Fetch a list of export items that have been marked for export for a given job. The data for these accounting entries are transformed accordingly for export purposes.
operationId: getExportItemsV1
parameters:
- name: job_id
in: query
description: The Export Job ID in which the accounting entries have been included for export.
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] or [offset]).
required: false
style: form
explode: true
schema:
pattern: ^[A-Z2-7=~]+$
type: string
- name: after
in: query
description: Upper bound of the page of data to return (cannot be used together with [before] or [offset]).
required: false
style: form
explode: true
schema:
pattern: ^[A-Z2-7=~]+$
type: string
- name: offset
in: query
description: Offset of the page of data to return (cannot be used together with [before] or [after]).
required: false
style: form
explode: true
schema:
minimum: 0
type: integer
format: int64
- name: limit
in: query
description: The maximum amount of items to return.
required: false
style: form
explode: true
schema:
minimum: 0
type: integer
format: int32
- name: sorting_keys
in: query
description: The keys to sort the results by.
required: false
style: form
explode: true
schema:
type: array
items:
type: string
- 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'
responses:
default:
description: default response
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/CursorPaginatedResponseExportItemV1'
deprecated: true
components:
schemas:
ExportItemV1:
required:
- _links
- accountingEntryId
- accountingEntryLines
- additionalInformation
- amount
- companyId
- date
- type
- user
type: object
properties:
_links:
$ref: '#/components/schemas/LinksResponse'
accountingEntryId:
type: string
description: This is the Pleo internal identifier of the export item.
format: uuid
example: 00000000-0000-0000-0000-000000000000
accountingEntryLines:
type: array
description: Accounting entry broken down in entry lines. There will always be an accounting entry line. If the accounting entry has been split into separate lines, then each line would represent the details of that accounting entry line, else there would only be one line present, representing the whole entry.
items:
$ref: '#/components/schemas/ExportItemLineV1'
additionalInformation:
$ref: '#/components/schemas/ExportItemAdditionalInformationV1'
amount:
$ref: '#/components/schemas/ExportItemAmount'
companyId:
type: string
description: Pleo company identifier this export item belongs to.
format: uuid
example: 00000000-0000-0000-0000-000000000000
date:
pattern: YYYY-MM-DDTHH:mi:ssZ
type: string
description: Date the accounting entry should be bookkept.
format: date-time
files:
type: array
description: Files that have been attached to this accounting entry.
nullable: true
items:
$ref: '#/components/schemas/ExportItemFile'
note:
type: string
description: Additional comments potentially describing the accounting entry.
nullable: true
supplier:
$ref: '#/components/schemas/SupplierV1'
team:
$ref: '#/components/schemas/TeamV1'
teamCode:
type: string
description: Team code is an identifier assigned to an expense to categorize it or associate it with a specific team.
nullable: true
type:
type: string
description: This is the Pleo internal identifier of the accounting entry this export item is associated with.
enum:
- card_purchase
- card_invoice
- out_of_pocket
- mileage
- per_diem
- external_reimbursement
- direct_reimbursement
- invoice
- invoice_payment
- chargeback
- refund
- cashback
- atm_withdrawal
- wallet_topup
- wallet_unload
- personal_spend
- fee
user:
$ref: '#/components/schemas/ExportItemUserV1'
TaxV1:
required:
- amount
- id
- rate
- type
type: object
properties:
amount:
$ref: '#/components/schemas/ExportItemAmount'
code:
type: string
description: Tax code
nullable: true
id:
type: string
description: This is the Pleo internal identifier of the tax code.
format: uuid
example: 00000000-0000-0000-0000-000000000000
rate:
type: number
description: Tax rate. This is represented in decimals and not the percentage. e.g. 20% tax rate would be 0.20.
example: 0.2
type:
type: string
description: Tax type
enum:
- inclusive
- exclusive
- reverse
description: Tax details applicable to this accounting entry line. The tax details would usually either have the code or the identifier or both.
nullable: true
SupplierBankAccount:
required:
- bankName
- country
type: object
properties:
accountNumber:
type: string
description: Bank account number.
nullable: true
bankCode:
type: string
description: Bank code.
nullable: true
bankName:
type: string
description: Name of the bank.
bic:
type: string
description: Branch information.
nullable: true
country:
maxLength: 2
minLength: 2
type: string
description: Country the bank is located in. This is an ISO 3166-1 alpha-2 country code.
example: DK
enum:
- UNDEFINED
- AC
- AD
- AE
- AF
- AG
- AI
- AL
- AM
- AN
- AO
- AQ
- AR
- AS
- AT
- AU
- AW
- AX
- AZ
- BA
- BB
- BD
- BE
- BF
- BG
- BH
- BI
- BJ
- BL
- BM
- BN
- BO
- BQ
- BR
- BS
- BT
- BU
- BV
- BW
- BY
- BZ
- CA
- CC
- CD
- CF
- CG
- CH
- CI
- CK
- CL
- CM
- CN
- CO
- CP
- CR
- CS
- CU
- CV
- CW
- CX
- CY
- CZ
- DE
- DG
- DJ
- DK
- DM
- DO
- DZ
- EA
- EC
- EE
- EG
- EH
- ER
- ES
- ET
- EU
- EZ
- FI
- FJ
- FK
- FM
- FO
- FR
- FX
- GA
- GB
- GD
- GE
- GF
- GG
- GH
- GI
- GL
- GM
- GN
- GP
- GQ
- GR
- GS
- GT
- GU
- GW
- GY
- HK
- HM
- HN
- HR
- HT
- HU
- IC
- ID
- IE
- IL
- IM
- IN
- IO
- IQ
- IR
- IS
- IT
- JE
- JM
- JO
- JP
- KE
- KG
- KH
- KI
- KM
- KN
- KP
- KR
- KW
- KY
- KZ
- LA
- LB
- LC
- LI
- LK
- LR
- LS
- LT
- LU
- LV
- LY
- MA
- MC
- MD
- ME
- MF
- MG
- MH
- MK
- ML
- MM
- MN
- MO
- MP
- MQ
- MR
- MS
- MT
- MU
- MV
- MW
- MX
- MY
- MZ
- NA
- NC
- NE
- NF
- NG
- NI
- NL
- 'NO'
- NP
- NR
- NT
- NU
- NZ
- OM
- PA
- PE
- PF
- PG
- PH
- PK
- PL
- PM
- PN
- PR
- PS
- PT
- PW
- PY
- QA
- RE
- RO
- RS
- RU
- RW
- SA
- SB
- SC
- SD
- SE
- SF
- SG
- SH
- SI
- SJ
- SK
- SL
- SM
- SN
- SO
- SR
- SS
- ST
- SU
- SV
- SX
- SY
- SZ
- TA
- TC
- TD
- TF
- TG
- TH
- TJ
- TK
- TL
- TM
- TN
- TO
- TP
- TR
- TT
- TV
- TW
- TZ
- UA
- UG
- UK
- UM
- US
- UY
- UZ
- VA
- VC
- VE
- VG
- VI
- VN
- VU
- WF
- WS
- XI
- XU
- XK
- YE
- YT
- YU
- ZA
- ZM
- ZR
- ZW
iban:
type: string
description: Unique international bank account number.
nullable: true
description: Bank account information of the supplier.
nullable: true
TagV1:
required:
- code
- groupCode
- id
type: object
properties:
code:
type: string
description: This is the identifier to the specific cost allocation item. e.g. the specific project, department, etc.
groupCode:
type: string
description: Allocation grouping, e.g. project, cost center, department or if the if dimensions are being used, this would be the dimension group identifier.
id:
type: string
description: This is the Pleo internal identifier of the tag.
format: uuid
example: 00000000-0000-0000-0000-000000000000
description: Tags are used to appropriate funds to specific projects, cost centers, departments, etc. This is what is known as "tags" in Pleo.
nullable: true
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'
LinksResponse:
type: object
properties:
api:
type: object
additionalProperties:
type: string
mobile:
type: object
additionalProperties:
type: string
web:
type: object
additionalProperties:
type: string
description: Contains links relevant to the export item.
example:
web:
exportItem: https://example.com
mobile:
exportItem: https://example.com
api:
exportItem: https://example.com
ExportItemLineV1:
required:
- accountingEntryLineId
- lineAmount
- netAmount
type: object
properties:
account:
$ref: '#/components/schemas/AccountV1'
accountingEntryLineId:
type: string
description: This is the Pleo internal identifier of this accounting entry line.
format: uuid
example: 00000000-0000-0000-0000-000000000000
lineAmount:
$ref: '#/components/schemas/ExportItemAmount'
netAmount:
$ref: '#/components/schemas/ExportItemAmount'
tags:
type: array
description: Tags are used to appropriate funds to specific projects, cost centers, departments, etc. This is what is known as "tags" in Pleo.
nullable: true
items:
$ref: '#/components/schemas/TagV1'
tax:
$ref: '#/components/schemas/TaxV1'
description: Accounting entry broken down in entry lines. There will always be an accounting entry line. If the accounting entry has been split into separate lines, then each line would represent the details of that accounting entry line, else there would only be one line present, representing the whole entry.
ExportItemFile:
required:
- size
- type
- url
type: object
properties:
size:
type: integer
description: Size of the file in bytes.
format: int32
example: 2084
type:
type: string
description: Type of file, usually represented similar to mime type.
example: application/pdf
url:
type: string
description: URL to retrieve the file attachment from. This URL is active for a limited time (24 Hours) from the time the export item is fetched.
example: https://file.url
description: Files that have been attached to this accounting entry.
nullable: true
CursorPageInfo:
required:
- currentRequestPagination
- hasNextPage
- hasPreviousPage
type: object
properties:
currentRequestPagination:
$ref: '#/components/schemas/CursorPageCurrentRequestInfo'
endCursor:
type: string
hasNextPage:
type: boolean
hasPreviousPage:
type: boolean
startCursor:
type: string
total:
type: integer
format: int64
TeamV1:
required:
- id
- name
type: object
properties:
code:
type: string
description: Team code, usually the unique identifier of the team in the accounting system.
nullable: true
id:
type: string
description: This is the Pleo internal identifier of the team.
format: uuid
example: 00000000-0000-0000-0000-000000000000
name:
type: string
description: This is the name of the team.
example: Marketing
description: Teams are assigned to an expense to categorize it or associate it with a specific team within the company.
nullable: true
ExportItemUserV1:
required:
- id
- name
type: object
properties:
code:
type: string
description: This would usually represent the employee code.
nullable: true
id:
type: string
description: This is the Pleo internal identifier of the user.
format: uuid
nullable: true
example: 00000000-0000-0000-0000-000000000000
name:
type: string
description: Full name of the user.
example: John Doe
description: This applies to the person that initiated the spend. This would in most cases be the employee.
ExportItemAmount:
required:
- inSupplierCurrency
- inWalletCurrency
type: object
properties:
inSupplierCurrency:
$ref: '#/components/schemas/MoneyModel'
inWalletCurrency:
$ref: '#/components/schemas/MoneyModel'
description: Export item amount.
SupplierV1:
type: object
properties:
account:
type: string
description: Supplier account code in the accounting system.
nullable: true
categoryCode:
type: string
description: This is the category code that describes the merchant/supplier's activity.
nullable: true
example: '5999'
code:
type: string
description: Identifier of the supplier in the accounting system.
nullable: true
country:
maxLength: 2
minLength: 2
type: string
description: The 2-letter country code the merchant or supplier operates in.
nullable: true
example: DK
enum:
- UNDEFINED
- AC
- AD
- AE
- AF
- AG
- AI
- AL
- AM
- AN
- AO
- AQ
- AR
- AS
- AT
- AU
- AW
- AX
- AZ
- BA
- BB
- BD
- BE
- BF
- BG
- BH
- BI
- BJ
- BL
- BM
- BN
- BO
- BQ
- BR
- BS
- BT
- BU
- BV
- BW
- BY
- BZ
- CA
- CC
- CD
- CF
- CG
- CH
- CI
- CK
- CL
- CM
- CN
- CO
- CP
- CR
- CS
- CU
- CV
- CW
- CX
- CY
- CZ
- DE
- DG
- DJ
- DK
- DM
- DO
- DZ
- EA
- EC
- EE
- EG
- EH
- ER
- ES
- ET
- EU
- EZ
- FI
- FJ
- FK
- FM
- FO
- FR
- FX
- GA
- GB
- GD
- GE
- GF
- GG
- GH
- GI
- GL
- GM
- GN
- GP
- GQ
- GR
- GS
- GT
- GU
- GW
- GY
- HK
- HM
- HN
- HR
- HT
- HU
- IC
- ID
- IE
- IL
- IM
- IN
- IO
- IQ
- IR
- IS
- IT
- JE
- JM
- JO
- JP
- KE
- KG
- KH
- KI
- KM
- KN
- KP
- KR
- KW
- KY
- KZ
- LA
- LB
- LC
- LI
- LK
- LR
- LS
- LT
- LU
- LV
- LY
- MA
- MC
- MD
- ME
- MF
- MG
- MH
- MK
- ML
- MM
- MN
- MO
- MP
- MQ
- MR
- MS
- MT
- MU
- MV
- MW
- MX
- MY
- MZ
- NA
- NC
- NE
- NF
- NG
- NI
- NL
- 'NO'
- NP
- NR
- NT
- NU
- NZ
- OM
- PA
- PE
- PF
- PG
- PH
- PK
- PL
- PM
- PN
- PR
- PS
- PT
- PW
- PY
- QA
- RE
- RO
- RS
- RU
- RW
- SA
- SB
- SC
- SD
- SE
- SF
- SG
- SH
- SI
- SJ
- SK
- SL
- SM
- SN
- SO
- SR
- SS
- ST
- SU
- SV
- SX
- SY
- SZ
- TA
- TC
- TD
- TF
- TG
- TH
- TJ
- TK
- TL
- TM
- TN
- TO
- TP
- TR
- TT
- TV
- TW
- TZ
- UA
- UG
- UK
- UM
- US
- UY
- UZ
- VA
- VC
- VE
- VG
- VI
- VN
- VU
- WF
- WS
- XI
- XU
- XK
- YE
- YT
- YU
- ZA
- ZM
- ZR
- ZW
name:
type: string
description: Name of the supplier or merchant.
nullable: true
example: GOOGLE*ADS8693645259
taxIdentifier:
type: string
description: This is the tax identification of the supplier in their country of operation.
nullable: true
description: The supplier or merchant involved.
nullable: true
InvoiceInformationV1:
required:
- invoiceDate
- invoiceNumber
- status
type: object
properties:
dueDate:
pattern: YYYY-MM-DD
type: string
description: Date the payment is due.
format: date-time
nullable: true
invoiceDate:
pattern: YYYY-MM-DD
type: string
description: Date the invoice was issued.
format: date-time
invoiceNumber:
type: string
description: The invoice number.
paymentDate:
pattern: YYYY-MM-DD
type: string
description: Date the invoice was paid if the status is paid.
format: date-time
nullable: true
status:
type: string
description: The invoice status.
enum:
- pending_approval
- parsed
- preparing
- prepared
- ready
- rejected_by_approver
- marked_as_paid
- scheduled
- payment_in_progress
- paid
- voided_by_user
- rejected_by_user
- failed_payment
supplierBankAccount:
$ref: '#/components/schemas/SupplierBankAccount'
description: In the case of an invoice, additional information pertaining to the invoice would be represented here.
nullable: true
CursorPaginatedResponseExportItemV1:
required:
- data
- pagination
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/ExportItemV1'
pagination:
$ref: '#/components/schemas/CursorPageInfo'
ExportItemAdditionalInformationV1:
required:
- reconciliationId
type: object
properties:
attendees:
type: array
description: Used to represent attendance involvement or participants at the time of the spend. E.g. if an employee took clients to dinner, this would be used to capture who was present at the dinner.
nullable: true
items:
type: string
description: Used to represent attendance involvement or participants at the time of the spend. E.g. if an employee took clients to dinner, this would be used to capture who was present at the dinner.
nullable: true
invoiceInformation:
$ref: '#/components/schemas/InvoiceInformationV1'
reconciledEntries:
uniqueItems: true
type: array
description: A list of reconciliation IDs for reimbursement expenses that are settled by this reimbursement. Only included for reimbursement transactions.
nullable: true
items:
type: string
description: A list of reconciliation IDs for reimbursement expenses that are settled by this reimbursement. Only included for reimbursement transactions.
nullable: true
reconciliationId:
type: string
description: This is an identifier used to reconcile between Pleo and the accounting system. Also known in Pleo as the book ID.
description: Additional information applicable to this accounting entry.
MoneyModel:
required:
- currency
- value
type: object
properties:
currency:
type: string
description: Represents the currency code (ISO 4217) of the supplier.
enum:
- UNDEFINED
- AED
- AFN
- ALL
- AMD
- ANG
- AOA
- ARS
- AUD
- AWG
- AZN
- BAM
- BBD
- BDT
- BGN
- BHD
- BIF
- BMD
- BND
- BOB
- BOV
- BRL
- BSD
- BTN
- BWP
- BYN
- BYR
- BZD
- CAD
- CDF
- CHE
- CHF
- CHW
- CLF
- CLP
- CNY
- COP
- COU
- CRC
- CUC
- CUP
- CVE
- CZK
- DJF
- DKK
- DOP
- DZD
- EGP
- ERN
- ETB
- EUR
- FJD
- FKP
- GBP
- GEL
- GHS
- GIP
- GMD
- GNF
- GTQ
- GYD
- HKD
- HNL
- HRK
- HTG
- HUF
- IDR
- ILS
- INR
- IQD
- IRR
- ISK
- JMD
- JOD
- JPY
- KES
- KGS
- KHR
- KMF
- KPW
- KRW
- KWD
- KYD
- KZT
- LAK
- LBP
- LKR
- LRD
- LSL
- LTL
- LYD
- MAD
- MDL
- MGA
- MKD
- MMK
- MNT
- MOP
- MRO
- MRU
- MUR
- MVR
- MWK
- MXN
- MXV
- MYR
- MZN
- NAD
- NGN
- NIO
- NOK
- NPR
- NZD
- OMR
- PAB
- PEN
- PGK
- PHP
- PKR
- PLN
- PYG
- QAR
- RON
- RSD
- RUB
- RUR
- RWF
- SAR
- SBD
- SCR
- SDG
- SEK
- SGD
- SHP
- SLE
- SLL
- SOS
- SRD
- SSP
- STD
- STN
- SVC
- SYP
- SZL
- THB
- TJS
- TMT
- TND
- TOP
- TRY
- TTD
- TWD
- TZS
- UAH
- UGX
- USD
- USN
- USS
- UYI
- UYU
- UYW
- UZS
- VED
- VEF
- VES
- VND
- VUV
- WST
- XAD
- XAF
- XAG
- XAU
- XBA
- XBB
- XBC
- XBD
- XCD
- XCG
- XDR
- XOF
- XPD
- XPF
- XPT
- XSU
- XTS
- XUA
- XXX
- YER
- ZAR
- ZMW
- ZWG
- ZWL
value:
type: number
description: Represents the amount in cents (amount/100). For example, 896.96 SEK is represented as 89696.
description: The total amount paid or owed to the supplier/vendor, in the currency the supplier/vendor operates in.
AccountV1:
required:
- id
- name
type: object
properties:
code:
type: string
description: The account code or number.
nullable: true
id:
type: string
description: This is the Pleo internal identifier of the account.
format: uuid
example: 00000000-0000-0000-0000-000000000000
identifier:
type: string
description: The internal account identifier in the accounting system.
nullable: true
name:
type: string
description: This is the name of the account as set on the Pleo UI.
example: Meals and Entertainment
description: This is the GL account this accounting entry line is allocated to. The account code or the account identifier be present if an account has been allocated, or both.
nullable: true
PageOrder:
type: string
enum:
- ASC
- ASC_NULLS_FIRST
- ASC_NULLS_LAST
- DESC
- DESC_NULLS_FIRST
- DESC_NULLS_LAST
securitySchemes:
bearerAuth:
type: http
description: 'JWT Bearer token authentication. Include the token in the Authorization header as: `Bearer <token>`'
scheme: bearer
bearerFormat: JWT
basicAuth:
type: http
description: Basic HTTP authentication using API key. Use your API key as the username and leave the password empty. The credentials will be Base64 encoded automatically.
scheme: basic