The expense-claim-item resource

Status

Introduction

Files

Organization Structure API

Axis-sections
Departments
Legal-Units
Establishments

Core HR API

Employees Directory
Guides

Cleemy Expenses API

Timmi Absences API

Leaves
Leave-requests
Sick-leaves
Imports
Guides

Timmi Office API

User-locations
Work-locations

Timmi Project API

Clients
Projects
Project services
Organizations
Financials

Timmi Settings API

UserDates
Workcycle-exceptions
Working-time-arrangement

Timmi Timesheet API

Time-entries
Timesheets
Reports
Guides

Pagga Mealvouchers API

Statutory
Computation

Pagga Remuneration API

Fixed-natures
Fixed-items
Variable-natures
Variable-items

Poplee Training API

Training-demands
Realized-trainings

The ExpenseClaimItem, is an expense that has been declared (within an expense report) by its owner (the user who made the expense).

purchasedOn

string

required

Day the expense was made.

expenseNatureId

integer

required

Nature of the expense: Meals, Train, Taxi, Hotels, Taxi, Mileage... List depends on the app configuration.

Required range: x >= 0

integer

Required range: x >= 0

expenseClaimId

integer

Id of the expense claim in which the item is contained.

Required range: x >= 0

lineNumber

integer

Incremental number used to order expense claim items in an expense claim

Required range: x >= 0

isControlled

boolean

<true> if the item has been controlled

createdOn

string

Date-time the item was created. Corresponds to the submition date of the expense claim.

modifiedOn

string

Date-time the item was last modified.

originalTransaction

object

Expense amount in original currency.

processedAmounts

object

Various amounts in the establishment's currency.

mileage

object | null

Additional information when the expense type is mileage.

quantity

integer

default:1

The quantity when the expense type is 'Quantity'.

Required range: x >= 1

effectiveQuantity

integer

Calculated quantity when the expense type is 'Quantity' or 'Invitations' (number of attendees).

Required range: x >= 1

attendees

object | null

Additional information when the expense type is 'Invitation'.

attendees.internal

object[]

Attendees who work for the company (ie: Users in the system).

attendees.internal.id

number

required

attendees.internal.name

string

required

Minimum length: 1

attendees.internal.url

string

required

Minimum length: 1

attendees.internal.displayName

string

required

Minimum length: 1

attendees.internal.modifiedOn

string

required

Minimum length: 1

attendees.internal.lastName

string

required

Minimum length: 1

attendees.internal.firstName

string

required

Minimum length: 1

attendees.internal.mail

string

required

Minimum length: 1

attendees.internal.dtContractStart

string

required

Minimum length: 1

attendees.internal.birthDate

string

required

Minimum length: 1

attendees.internal.employeeNumber

string

required

Minimum length: 1

attendees.internal.calendar

object

required

attendees.internal.culture

object

required

attendees.internal.picture

object

required

attendees.internal.applicationData

object

required

attendees.internal.legalEntity

object

required

attendees.internal.department

object

required

attendees.internal.manager

object

required

attendees.internal.rolePrincipal

object

required

attendees.internal.habilitedRoles

object[]

required

attendees.internal.userWorkCycles

object[]

required

attendees.internal.dtContractEnd

any

attendees.external

object[]

External attendees (eg: clients, candidates).

Id of the custom field.

axisSections

object[] | null

Axis sections values.

axisSections.id

integer

Required range: x >= 1

axisSections.code

string

axisSections.name

string

axisSections.multilingualName

string

axisSections.description

string

axisSections.ownerId

integer

Required range: x >= 1

axisSections.startOn

string

axisSections.endOn

string

axisSections.active

boolean

axisSections.axisId

integer

axisSections.parentAxisSections

object[]

axisSections.parentAxisSections.id

integer

Required range: x >= 1

axisSections.parentAxisSections.code

string

axisSections.parentAxisSections.name

string

axisSections.parentAxisSections.multilingualName

string

axisSections.parentAxisSections.description

string

axisSections.parentAxisSections.ownerId

integer

Required range: x >= 1

axisSections.parentAxisSections.startOn

string

axisSections.parentAxisSections.endOn

string

axisSections.parentAxisSections.active

boolean

axisSections.parentAxisSections.axisId

integer

axisSections.parentAxisSections.parentAxisSections

object[]

axisSections.parentAxisSections.childrenAxisSections

object[]

axisSections.childrenAxisSections

object[]

axisSections.childrenAxisSections.id

integer

Required range: x >= 1

axisSections.childrenAxisSections.code

string

axisSections.childrenAxisSections.name

string

axisSections.childrenAxisSections.multilingualName

string

axisSections.childrenAxisSections.description

string

axisSections.childrenAxisSections.ownerId

integer

Required range: x >= 1

axisSections.childrenAxisSections.startOn

string

axisSections.childrenAxisSections.endOn

string

axisSections.childrenAxisSections.active

boolean

axisSections.childrenAxisSections.axisId

integer

axisSections.childrenAxisSections.parentAxisSections

object[]

axisSections.childrenAxisSections.childrenAxisSections

object[]

customFields

object | null

Values for custom fields.

merchant

string | null

Merchant of the expense.

comment

string | null

expenseReceipts

object[] | null

The original receipt (PDF file, image, ...).

An expense's receipt.

authorizedActions

object

Authorized actions on the expense for the current user.

sourceId

object

The source describes how the expense was created:

0: Legacy
1: OldImport
2: ImportByCb
3: ImportByNature
4: Anytime
5: BudgetInsight
6: Api
7: Ocr
8: Reconciliation
9: InvoiceAggregator
10: EmailAttachments
11: FtpStatementImport
12: CleemyPayment

source

object

ownerId

integer

Unique identifier of the user that made this expense.

paymentMethodId

enum<number>

How this expense was made: the owner used his money, an enterprise debit card, or a Cleemy card:

0: User
1: CorporateCard
3: Cleemy Card

Available options:

0,

1,

3

Was this page helpful?

List ExpenseClaims List ExpenseClaimItems

{
  "id": 1,
  "expenseClaimId": 1,
  "lineNumber": 1,
  "isControlled": true,
  "purchasedOn": "2023-11-07T05:31:56Z",
  "createdOn": "2023-11-07T05:31:56Z",
  "modifiedOn": "2023-11-07T05:31:56Z",
  "originalTransaction": {
    "grossAmount": 123,
    "currencyId": "<string>",
    "isExpenseAbroad": true,
    "currency": {
      "id": "<string>",
      "name": "<string>",
      "url": "<string>"
    }
  },
  "processedAmounts": {
    "grossAmount": 123,
    "currencyId": "<string>",
    "currency": {
      "id": "<string>",
      "name": "<string>",
      "url": "<string>"
    },
    "netAmount": 123,
    "vatBases": [
      {
        "countryVatRateId": 2,
        "countryVatRate": {
          "id": 2,
          "name": "<string>",
          "url": "<string>"
        },
        "vatAmount": 123,
        "amountExcludingVat": 123
      }
    ]
  },
  "expenseNatureId": 1,
  "mileage": {
    "distance": 123,
    "power": 123,
    "waypoints": [
      "<any>"
    ]
  },
  "quantity": 1,
  "effectiveQuantity": 2,
  "attendees": {
    "internal": [
      {
        "id": 123,
        "name": "<string>",
        "url": "<string>",
        "displayName": "<string>",
        "modifiedOn": "<string>",
        "lastName": "<string>",
        "firstName": "<string>",
        "login": "<string>",
        "mail": "<string>",
        "dtContractStart": "<string>",
        "dtContractEnd": "<any>",
        "birthDate": "<string>",
        "employeeNumber": "<string>",
        "calendar": {
          "id": 123,
          "url": "<string>",
          "name": "<string>"
        },
        "culture": {
          "id": 123,
          "name": "<string>",
          "url": "<string>"
        },
        "picture": {
          "id": "<string>",
          "url": "<string>",
          "name": "<string>"
        },
        "applicationData": {
          "profile_figgo": {
            "id": 123,
            "name": "<string>",
            "url": "<string>"
          },
          "profile_utime": {
            "id": 123,
            "name": "<string>",
            "url": "<string>"
          }
        },
        "legalEntity": {
          "id": 123,
          "name": "<string>",
          "url": "<string>"
        },
        "department": {
          "id": 123,
          "name": "<string>",
          "url": "<string>"
        },
        "manager": {
          "id": 123,
          "name": "<string>",
          "url": "<string>"
        },
        "rolePrincipal": {
          "id": 123,
          "name": "<string>",
          "url": "<string>"
        },
        "habilitedRoles": [
          {
            "id": 123,
            "name": "<string>",
            "url": "<string>"
          }
        ],
        "userWorkCycles": [
          {
            "Id": 123,
            "OwnerID": 123,
            "WorkCycleID": 123,
            "StartsOn": "<string>",
            "EndsOn": "<string>"
          }
        ]
      }
    ],
    "external": [
      {
        "id": 2,
        "displayName": "<string>"
      }
    ]
  },
  "axisSections": [
    {
      "id": 2,
      "code": "<string>",
      "name": "<string>",
      "multilingualName": "<string>",
      "description": "<string>",
      "ownerId": 2,
      "startOn": "2023-11-07T05:31:56Z",
      "endOn": "2023-11-07T05:31:56Z",
      "active": true,
      "axisId": 123,
      "parentAxisSections": [
        {
          "id": 2,
          "code": "<string>",
          "name": "<string>",
          "multilingualName": "<string>",
          "description": "<string>",
          "ownerId": 2,
          "startOn": "2023-11-07T05:31:56Z",
          "endOn": "2023-11-07T05:31:56Z",
          "active": true,
          "axisId": 123,
          "parentAxisSections": [
            {
              "id": 2,
              "code": "<string>",
              "name": "<string>",
              "multilingualName": "<string>",
              "description": "<string>",
              "ownerId": 2,
              "startOn": "2023-11-07T05:31:56Z",
              "endOn": "2023-11-07T05:31:56Z",
              "active": true,
              "axisId": 123,
              "parentAxisSections": [
                {}
              ],
              "childrenAxisSections": [
                {}
              ]
            }
          ],
          "childrenAxisSections": [
            {
              "id": 2,
              "code": "<string>",
              "name": "<string>",
              "multilingualName": "<string>",
              "description": "<string>",
              "ownerId": 2,
              "startOn": "2023-11-07T05:31:56Z",
              "endOn": "2023-11-07T05:31:56Z",
              "active": true,
              "axisId": 123,
              "parentAxisSections": [
                {}
              ],
              "childrenAxisSections": [
                {}
              ]
            }
          ]
        }
      ],
      "childrenAxisSections": [
        {
          "id": 2,
          "code": "<string>",
          "name": "<string>",
          "multilingualName": "<string>",
          "description": "<string>",
          "ownerId": 2,
          "startOn": "2023-11-07T05:31:56Z",
          "endOn": "2023-11-07T05:31:56Z",
          "active": true,
          "axisId": 123,
          "parentAxisSections": [
            {
              "id": 2,
              "code": "<string>",
              "name": "<string>",
              "multilingualName": "<string>",
              "description": "<string>",
              "ownerId": 2,
              "startOn": "2023-11-07T05:31:56Z",
              "endOn": "2023-11-07T05:31:56Z",
              "active": true,
              "axisId": 123,
              "parentAxisSections": [
                {}
              ],
              "childrenAxisSections": [
                {}
              ]
            }
          ],
          "childrenAxisSections": [
            {
              "id": 2,
              "code": "<string>",
              "name": "<string>",
              "multilingualName": "<string>",
              "description": "<string>",
              "ownerId": 2,
              "startOn": "2023-11-07T05:31:56Z",
              "endOn": "2023-11-07T05:31:56Z",
              "active": true,
              "axisId": 123,
              "parentAxisSections": [
                {}
              ],
              "childrenAxisSections": [
                {}
              ]
            }
          ]
        }
      ]
    }
  ],
  "customFields": {},
  "merchant": "<string>",
  "comment": "<string>",
  "expenseReceipts": [
    {
      "id": "<string>"
    }
  ],
  "authorizedActions": {
    "isCancellable": true,
    "isEditable": true
  },
  "sourceId": {
    "id": "<string>"
  },
  "source": {
    "id": 123,
    "name": "<string>",
    "code": "<string>"
  },
  "ownerId": 123,
  "paymentMethodId": 0
}