The expense-claim-item resource

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

purchasedOn

string<date-time>

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

lineNumber

integer

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

Required range: x >= 0

isControlled

boolean

if the item has been controlled

createdOn

string<date-time>

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

modifiedOn

string<date-time>

Date-time the item was last modified.

originalTransaction

object

Expense amount in original currency.

Show child attributes

originalTransaction.grossAmount

number

Must be a multiple of 0.01

originalTransaction.currencyId

string

ISO code of the currency (eg: 'EUR', 'USD', 'GBP', ...).

originalTransaction.isExpenseAbroad

boolean

Whether the expense was made in a different country than the owner establishment's.

originalTransaction.currency

Currency · object

Show child attributes

originalTransaction.currency.id

string

ISO code of the currency (eg: 'EUR', 'USD', 'GBP', ...).

originalTransaction.currency.name

string

Label of the currency (eg: Pound sterling).

originalTransaction.currency.url

string<uri>

mileage

object

Additional information when the expense type is mileage.

Show child attributes

mileage.distance

number

Distance where the unit depends on the establishment.

mileage.power

number

Tax horsepower of the vehicle.

mileage.waypoints

any[]

The collection of waypoints including intermediate waypoints.

quantity

integer

default:1

The quantity when the expense type is 'Quantity'.

Required range: x >= 1

attendees

object

Additional information when the expense type is 'Invitation'.

Show child attributes

attendees.internal

User · object[]

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

Show child attributes

attendees.internal.id

number

required

attendees.internal.name

string

required

Minimum string length: 1

attendees.internal.url

string

required

Minimum string length: 1

attendees.internal.displayName

string

required

Minimum string length: 1

attendees.internal.modifiedOn

string

required

Minimum string length: 1

attendees.internal.lastName

string

required

Minimum string length: 1

attendees.internal.firstName

string

required

Minimum string length: 1

attendees.internal.mail

string

required

Minimum string length: 1

attendees.internal.dtContractStart

string

required

Minimum string length: 1

attendees.internal.birthDate

string

required

Minimum string length: 1

attendees.internal.employeeNumber

string

required

Minimum string length: 1

attendees.internal.calendar

object

required

Show child attributes

attendees.internal.calendar.id

number

required

attendees.internal.calendar.url

string

required

Minimum string length: 1

attendees.internal.calendar.name

string

required

Minimum string length: 1

attendees.internal.culture

object

required

Show child attributes

attendees.internal.culture.id

number

required

attendees.internal.culture.name

string

required

Minimum string length: 1

attendees.internal.culture.url

string

required

Minimum string length: 1

attendees.internal.picture

object

required

Show child attributes

attendees.internal.picture.id

string

required

Minimum string length: 1

attendees.internal.picture.url

string

required

Minimum string length: 1

attendees.internal.picture.name

string

required

Minimum string length: 1

attendees.internal.applicationData

object

required

Show child attributes

attendees.internal.applicationData.profile_figgo

object

required

Show child attributes

attendees.internal.applicationData.profile_figgo.id

number

required

attendees.internal.applicationData.profile_figgo.name

string

required

Minimum string length: 1

attendees.internal.applicationData.profile_figgo.url

string

required

Minimum string length: 1

attendees.internal.applicationData.profile_utime

object

required

Show child attributes

attendees.internal.applicationData.profile_utime.id

number

required

attendees.internal.applicationData.profile_utime.name

string

required

Minimum string length: 1

attendees.internal.applicationData.profile_utime.url

string

required

Minimum string length: 1

attendees.internal.legalEntity

object

required

Show child attributes

attendees.internal.legalEntity.id

number

required

attendees.internal.legalEntity.name

string

required

Minimum string length: 1

attendees.internal.legalEntity.url

string

required

Minimum string length: 1

attendees.internal.department

object

required

Show child attributes

attendees.internal.department.id

number

required

attendees.internal.department.name

string

required

Minimum string length: 1

attendees.internal.department.url

string

required

Minimum string length: 1

attendees.internal.manager

object

required

Show child attributes

attendees.internal.manager.id

number

required

attendees.internal.manager.name

string

required

Minimum string length: 1

attendees.internal.manager.url

string

required

Minimum string length: 1

attendees.internal.rolePrincipal

object

required

Show child attributes

attendees.internal.rolePrincipal.id

number

required

attendees.internal.rolePrincipal.name

string

required

Minimum string length: 1

attendees.internal.rolePrincipal.url

string

required

Minimum string length: 1

attendees.internal.habilitedRoles

object[]

required

Minimum array length: 1

Show child attributes

attendees.internal.habilitedRoles.id

number

required

attendees.internal.habilitedRoles.name

string

required

Minimum string length: 1

attendees.internal.habilitedRoles.url

string

required

Minimum string length: 1

attendees.internal.userWorkCycles

object[]

required

Minimum array length: 1

Show child attributes

attendees.internal.userWorkCycles.Id

number

required

attendees.internal.userWorkCycles.OwnerID

number

required

attendees.internal.userWorkCycles.WorkCycleID

number

required

attendees.internal.userWorkCycles.StartsOn

string

required

Minimum string length: 1

attendees.internal.userWorkCycles.EndsOn

string

required

Minimum string length: 1

attendees.internal.dtContractEnd

any

attendees.external

object[]

External attendees (eg: clients, candidates).

Show child attributes

attendees.external.id

integer

Required range: x >= 1

attendees.external.displayName

string

axisSections

The Axis Section resource · object[] | null

Axis sections values.

Show child attributes

axisSections.id

integer

Required range: x >= 1

customFields

object

Values for custom fields.

Show child attributes

customFields.{key}

object

Show child attributes

customFields.{key}.code

string

Value inputted by the user.

merchant

string | null

Merchant of the expense.

comment

string | null

expenseReceipts

ExpenseReceipt · object[] | null

The expense receipts (PDF file, image, ...). Technically, there could be more than one, but in reality, there’s usually just one.

Show child attributes

expenseReceipts.id

string<uuid>

The ID of this expense receipt.

Example:

"f0d01fd0-5f27-4061-8dca-bee6318b0103"

expenseReceipts.originalReceipt

object

The original file.

Show child attributes

expenseReceipts.originalReceipt.id

string<uuid>

The ID of the expense receipt file.

Example:

"cb0aae89-56c9-48db-9052-48981660e0f7"

expenseReceipts.originalReceipt.name

string

Example:

"receipt-f0d01fd0-5f27-4061-8dca-bee6318b0103.pdf"

expenseReceipts.originalReceipt.href

string<uri>

Follow this link to download this expense receipt original file.

Example:

"https://example.ilucca.net/api/v3/ExpenseReceipts/f0d01fd0-5f27-4061-8dca-bee6318b0103/originalReceiptFile"

expenseReceipts.originalReceipt.extension

string

Suffix to the name of a file (e.g., .txt, .pdf, .jppg) that indicates its content type or its intended use.

Example:

".pdf"

expenseReceipts.receiptPreview

object

Lower resolution (i.e. thumbnail) file of the original expense receipt.

Show child attributes

expenseReceipts.receiptPreview.id

string<uuid>

The ID of the expense receipt file (same as original).

Example:

"cb0aae89-56c9-48db-9052-48981660e0f7"

expenseReceipts.receiptPreview.name

string

Example:

"receipt-f0d01fd0-5f27-4061-8dca-bee6318b0103-preview.pdf"

expenseReceipts.receiptPreview.href

string<uri>

Follow this link to download this expense receipt preview image (i.e. thumbnail), even if the original file is not an image (e.g. PDF).

Image size can be negotiated via the ?imageSize query parameter. Available sizes are: Small | Medium | Large | Full (e.g.: ?imageSize=Small).

If the original file is a PDF, then you may request any given page (default is the first) by adding the ?pageNumber query parameter (takes an integer that starts at 1).

Example:

"https://example.ilucca.net/api/v3/ExpenseReceipts/f0d01fd0-5f27-4061-8dca-bee6318b0103/receiptPreviewFile"

expenseReceipts.receiptPreview.extension

string

Suffix to the name of a file (e.g., .txt, .pdf, .jppg) that indicates its content type or its intended use.

Example:

".pdf"

sourceId

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

Show child attributes

sourceId.id

string

source

Enum · object

Show child attributes

source.id

number

source.code

string

ownerId

integer

Unique identifier of the user that made this expense.

paymentMethodId

enum<integer>

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

Documentation

Files

Organization Structure API

Core HR API

Expenses API

Invoices API

Absences API

Office API

Project API

Schedule API

Timesheet API

Mealvouchers API

Compensation API

Training API

The expense-claim-item resource