Get an expense for a company

GET /expenses/{expenseId}

Get an expense for a company

cURL

curl --request GET \
  --url https://openapi.pleo.io/v1/expenses/{expenseId} \
  --header 'Authorization: Bearer <token>'

200

{
  "id": "<string>",
  "performedAt": "2023-11-07T05:31:56Z",
  "amountOriginal": {
    "value": 123,
    "currency": "<string>"
  },
  "type": "CARD",
  "lines": [
    {
      "amountSettled": {
        "value": 123,
        "currency": "<string>"
      },
      "accountId": "<string>",
      "taxCodeId": "<string>",
      "tagIds": [
        {
          "id": "<string>",
          "tagGroupId": "<string>"
        }
      ]
    }
  ],
  "status": "NOT_EXPORTED",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "employeeId": "<string>",
  "employeeCode": "<string>",
  "departmentId": "<string>",
  "amountSettled": {
    "value": 123,
    "currency": "<string>"
  },
  "note": "<string>",
  "cardTransaction": {
    "state": "AUTHORIZATION",
    "merchant": {
      "name": "<string>",
      "id": "<string>"
    },
    "authorizedAt": "2023-11-07T05:31:56Z",
    "settledAt": "2023-11-07T05:31:56Z",
    "reversedAt": "2023-11-07T05:31:56Z"
  },
  "accountId": "<string>",
  "taxCodeId": "<string>",
  "tagIds": [
    {
      "id": "<string>",
      "tagGroupId": "<string>"
    }
  ],
  "receiptIds": [
    "<string>"
  ],
  "settledExpenseIds": [
    "<string>"
  ],
  "supplier": {
    "CIF": "<string>",
    "documentNumber": "<string>"
  },
  "deletedAt": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization · string · header · required

Open API Bearer token

Path Parameters

expenseId · string · required

Unique UUID of the expense.

Example:

"0f0e000-000d-0d00-000b-00db0d000fae"

Response

200

application/json

An expense has been returned

id · string · required

The unique UUID identifier of the expense

performedAt · string<date-time> · required

The date the expense was performed in the format YYYY-MM-DDTHH:mi:ss.SSSZ

amountOriginal · object · required

The amount and currency the transaction was originally in

Show child attributes

type · enum<string> · required

The type of this expense.

Available options: CARD, PERSONAL_TRANSFER, BILL_INVOICE, LOAD, MANUAL, MANUAL_TRANSFER, PLEO_INVOICE, EMPLOYEE_BANK_TRANSFER, CASHBACK

lines · object[] · required

This is a breakdown of the expense lines for this expense, could also be potentially empty for non-card related expenses

Show child attributes

status · enum<string> · required

This is related to export status information

Available options: NOT_EXPORTED, QUEUED, EXPORTING, EXPORTED

createdAt · string<date-time> · required

Date and time this record was created in the pleo system in the format YYYY-MM-DDTHH:mi:ss.SSSZ

updatedAt · string<date-time> · required

Date and time this record was last updated in the pleo system in the format YYYY-MM-DDTHH:mi:ss.SSSZ

employeeId · string

Unique UUID identifier of the employee that performed the expense

employeeCode · string

External identifier of the employee that performed the expense

departmentId · string

Unique UUID identifier of the department for which the employee executing the expense belongs to

amountSettled · object

The settlement amount and currency

Show child attributes

note · string

Additional comments on the expense added to enhance the purpose of the expense

cardTransaction · object

This is the card transaction details of this expense specifically related CARD expense types.

Show child attributes

accountId · string

This is the UUID pleo accounting category identifier for this expense, e.g. entertainment, travel etc.

taxCodeId · string

This is the UUID tax code identifier for this expense

tagIds · object[]

These are additional accounting-related information pertaining to the expense, these are usually extracted from the external accounting system.

Show child attributes

receiptIds · string[]

Unique identifiers (UUIDs) for the receipts attached to this expense

settledExpenseIds · string[]

Unique identifiers (UUIDs) of the related settled Expenses in case the expense is a reimbursement of *TRANSFER family

supplier · object

Expense supplier information.

Show child attributes

deletedAt · string<date-time>

Date and time this record was deleted in the pleo system in the format YYYY-MM-DDTHH:mi:ss.SSSZ