Update Export Job Items

Update the status and other attributes of the export job items in batches of 100. This API only supports updating up to 100 items.

PUT /v3/export-jobs/{jobId}/items

Update Export Job Items

cURL

curl --request PUT \
  --url https://external.pleo.io/v3/export-jobs/{jobId}/items \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json;charset=UTF-8' \
  --data '
[
  {
    "accountingEntryId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "pending",
    "exportedAt": "2023-11-07T05:31:56Z",
    "externalId": "<string>",
    "externalUrl": "<string>",
    "failureReason": "<string>",
    "failureReasonType": "receipt_upload_failure"
  }
]
'

200

{
  "data": [
    {
      "accountingEntryId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "exportJobId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "status": "pending",
      "exportedAt": "2023-11-07T05:31:56Z",
      "externalId": "<string>",
      "externalUrl": "<string>",
      "failureReason": "<string>",
      "failureReasonType": "receipt_upload_failure"
    }
  ],
  "errors": [
    {
      "accountingEntryId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "message": "<string>",
      "type": "ACCOUNTING_ENTRY_DOES_NOT_EXIST"
    }
  ]
}

Authorizations

Authorization · string · header · required

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

Path Parameters

jobId · string<uuid> · required

Export Job ID

Body

application/json;charset=UTF-8

accountingEntryId · string<uuid> · required

ID of the accounting entry being updated.

status · enum<string> · required

Status of the export Item after being processed.

Status	Description
pending	The export job item is selected for export, yet it is waiting to be exported.
in_progress	The export job item is currently being exported to the ERP/accounting system.
failed	The export job item could not be exported to the ERP/accounting system.
successful	The export job item is successfully exported to the ERP/accounting system.
abandoned	The export job item could not be exported to the ERP/accounting system because the export job could not be completed.

Available options: pending, in_progress, failed, successful, abandoned

exportedAt · string<date-time>

Date and time when the export job was initiated.

externalId · string

The accounting system identifier of the entry after export.

externalUrl · string

URL to access the resource of the entry in the accounting system.

failureReason · string

Detailed message explaining the failure.

failureReasonType · enum<string>

If the export of this accounting entry failed, specify the failure reason type.

Failure Reason Type	Description
receipt_upload_failure	An error occurred while uploading the receipt file to the accounting system.
receipt_download_failure	An error occurred while downloading the receipt file from Pleo.
receipt_file_size_limit_exceeded	If the receipt file size has exceeded the limit specified by the accounting system.
receipt_conversion_failure	When an attempt to convert the receipt to a different file type and the conversion failed.
unexpected_failure	An unexpected error occurred.
invalid_configuration	This would define a failure reason pertaining to invalid configuration needed to complete the export of the item or interact with the accounting system.
missing_configuration	This would define a failure reason pertaining to incomplete configuration needed to complete the export of the item or interact with the accounting system.
accounting_system_authentication_failure	The integration service could not authenticate with the accounting system.
accounting_system_rate_limit	There was an irrecoverable rate limit issue that the integration service encountered at any stage of the export job process while communicating with the accounting system.
accounting_system_unreachable	This would be an error that occurs if the integration service is unable to reach the accounting system.
validation_failure	If there was an irrecoverable validation error that occurred while validating the export item.
accounting_system_validation_failure	If there was an irrecoverable validation error encountered by the accounting system as part of exporting the item.
authorization_failure	This is an error that may have occurred because the authorization granted with the token that was generated during the installation of the integration, has been revoked or the user that authorized no longer has that access to the accounting system.
accounting_system_timeout	This would be an error that occurs if the integration service encounters an irrecoverable timeout while communicating with the accounting system.
vendor_unknown	Failure due to unknown or invalid vendor account number in the accounting system at time of exporting the item.
account_unknown	Failure due to unknown or invalid account number in the accounting system at time of exporting the item.
tax_code_unknown	Failure due to unknown or invalid tax code in the accounting system at time of exporting the item.
tag_unknown	Failure due to unknown or invalid tag in the accounting system at time of exporting the item.

Available options: receipt_upload_failure, receipt_download_failure, receipt_file_size_limit_exceeded, receipt_conversion_failure, unexpected_failure, invalid_configuration, missing_configuration, accounting_system_authentication_failure, accounting_system_rate_limit, accounting_system_unreachable, validation_failure, accounting_system_validation_failure, authorization_failure, accounting_system_timeout, vendor_unknown, account_unknown, tax_code_unknown, tag_unknown

Response

200

application/json;charset=UTF-8

Export job items updated successfully.

data · object[] · required

Show child attributes

errors · object[] · required

If any errors occurred in updating the export job items, they will be listed here.

Show child attributes