Skip to main content
POST
/
v1
/
export-jobs
Create a new export job
curl --request POST \
  --url https://external.pleo.io/v1/export-jobs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json;charset=UTF-8' \
  --data '
{
  "accountingEntryIds": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "employeeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "isInteractive": true,
  "options": {
    "vendorBasedBookkeeping": false
  }
}
'
{
  "data": {
    "companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "createdAt": "2023-11-07T05:31:56Z",
    "expiresIn": 123,
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "isInteractive": true,
    "numberOfItems": 123,
    "status": "pending",
    "vendorBasedBookkeeping": true,
    "completedAt": "2023-11-07T05:31:56Z",
    "createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "expiredAt": "2023-11-07T05:31:56Z",
    "failureReason": "<string>",
    "failureReasonType": "invalid_configuration",
    "lastUpdatedAt": "2023-11-07T05:31:56Z",
    "startedAt": "2023-11-07T05:31:56Z"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json;charset=UTF-8
​
accountingEntryIds
string<uuid>[]
required

The IDs of accounting entries that you want to include in the export job for transmission.

The IDs of accounting entries that you want to include in the export job for transmission.

​
companyId
string<uuid>
required

The unique company ID for which you want to create the export job.

​
employeeId
string<uuid> | null

This is the Pleo unique identifier of the user that initiated the export job.

​
isInteractive
boolean | null
default:true

Non-Interactive jobs are jobs that are not initiated by a user. These jobs are usually triggered in the background and require no user interaction. Whereas, interactive jobs are the opposite. Set this flag to true, if the export job would be initiated by a user. By default, this is set to true.

​
options
object

Provides additional configurations for the export job.

Response

default - application/json;charset=UTF-8

default response

​
data
object
required