List ExpenseTempItems

curl --request GET \
  --url https://{host}/api/v3/expenseTempItems \
  --header 'Authorization: <authorization>'

{
  "data": {
    "items": [
      {
        "id": 2,
        "purchasedOn": "2023-12-25",
        "originalTransaction": {
          "grossAmount": 123,
          "currencyId": "<string>",
          "isExpenseAbroad": false
        },
        "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": 2,
        "quantity": 1,
        "ownerId": 123,
        "paymentMethodId": 0,
        "deviceId": "<string>",
        "mileage": {
          "distance": 123,
          "power": 123,
          "waypoints": [
            "<unknown>"
          ]
        },
        "effectiveQuantity": 2,
        "attendees": {
          "internal": [
            {
              "id": 123,
              "name": "<string>",
              "url": "<string>",
              "displayName": "<string>",
              "modifiedOn": "<string>",
              "lastName": "<string>",
              "firstName": "<string>",
              "login": "<string>",
              "mail": "<string>",
              "dtContractStart": "<string>",
              "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>"
                }
              ],
              "dtContractEnd": "<unknown>"
            }
          ],
          "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": [
              {}
            ],
            "childrenAxisSections": [
              {}
            ]
          }
        ],
        "customFields": {},
        "merchant": "<string>",
        "comment": "<string>",
        "expenseReceipts": [
          {
            "id": "f0d01fd0-5f27-4061-8dca-bee6318b0103",
            "originalReceipt": {
              "id": "cb0aae89-56c9-48db-9052-48981660e0f7",
              "name": "receipt-f0d01fd0-5f27-4061-8dca-bee6318b0103.pdf",
              "href": "https://example.ilucca.net/api/v3/ExpenseReceipts/f0d01fd0-5f27-4061-8dca-bee6318b0103/originalReceiptFile",
              "extension": ".pdf"
            },
            "receiptPreview": {
              "id": "cb0aae89-56c9-48db-9052-48981660e0f7",
              "name": "receipt-f0d01fd0-5f27-4061-8dca-bee6318b0103-preview.pdf",
              "href": "https://example.ilucca.net/api/v3/ExpenseReceipts/f0d01fd0-5f27-4061-8dca-bee6318b0103/receiptPreviewFile",
              "extension": ".pdf"
            }
          }
        ],
        "authorizedActions": {
          "isCancellable": true,
          "isEditable": true
        },
        "sourceId": {
          "id": "<string>"
        },
        "source": {
          "id": 123,
          "name": "<string>",
          "code": "<string>"
        },
        "paymentMethod": {
          "id": 123,
          "name": "<string>",
          "code": "<string>"
        },
        "statusId": {
          "id": 0
        },
        "status": {
          "id": 123,
          "name": "<string>",
          "code": "<string>"
        }
      }
    ]
  }
}

GET

api

expenseTempItems

List ExpenseTempItems

curl --request GET \
  --url https://{host}/api/v3/expenseTempItems \
  --header 'Authorization: <authorization>'

{
  "data": {
    "items": [
      {
        "id": 2,
        "purchasedOn": "2023-12-25",
        "originalTransaction": {
          "grossAmount": 123,
          "currencyId": "<string>",
          "isExpenseAbroad": false
        },
        "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": 2,
        "quantity": 1,
        "ownerId": 123,
        "paymentMethodId": 0,
        "deviceId": "<string>",
        "mileage": {
          "distance": 123,
          "power": 123,
          "waypoints": [
            "<unknown>"
          ]
        },
        "effectiveQuantity": 2,
        "attendees": {
          "internal": [
            {
              "id": 123,
              "name": "<string>",
              "url": "<string>",
              "displayName": "<string>",
              "modifiedOn": "<string>",
              "lastName": "<string>",
              "firstName": "<string>",
              "login": "<string>",
              "mail": "<string>",
              "dtContractStart": "<string>",
              "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>"
                }
              ],
              "dtContractEnd": "<unknown>"
            }
          ],
          "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": [
              {}
            ],
            "childrenAxisSections": [
              {}
            ]
          }
        ],
        "customFields": {},
        "merchant": "<string>",
        "comment": "<string>",
        "expenseReceipts": [
          {
            "id": "f0d01fd0-5f27-4061-8dca-bee6318b0103",
            "originalReceipt": {
              "id": "cb0aae89-56c9-48db-9052-48981660e0f7",
              "name": "receipt-f0d01fd0-5f27-4061-8dca-bee6318b0103.pdf",
              "href": "https://example.ilucca.net/api/v3/ExpenseReceipts/f0d01fd0-5f27-4061-8dca-bee6318b0103/originalReceiptFile",
              "extension": ".pdf"
            },
            "receiptPreview": {
              "id": "cb0aae89-56c9-48db-9052-48981660e0f7",
              "name": "receipt-f0d01fd0-5f27-4061-8dca-bee6318b0103-preview.pdf",
              "href": "https://example.ilucca.net/api/v3/ExpenseReceipts/f0d01fd0-5f27-4061-8dca-bee6318b0103/receiptPreviewFile",
              "extension": ".pdf"
            }
          }
        ],
        "authorizedActions": {
          "isCancellable": true,
          "isEditable": true
        },
        "sourceId": {
          "id": "<string>"
        },
        "source": {
          "id": 123,
          "name": "<string>",
          "code": "<string>"
        },
        "paymentMethod": {
          "id": 123,
          "name": "<string>",
          "code": "<string>"
        },
        "statusId": {
          "id": 0
        },
        "status": {
          "id": 123,
          "name": "<string>",
          "code": "<string>"
        }
      }
    ]
  }
}

Headers

Authorization

string

required

API key. Value must be formatted like so: lucca application={api_key}.

Query Parameters

ownerId

integer[]

Comma-separated list of user identifiers (int).

orderBy

string

{fieldName},{'asc'||'desc'}. Example: ?orderby=purchasedOn,desc

purchasedOn

string

Examples: between,2022-01-01,202201-31.

paging

string

required

{offset},{limit}. Defaults to 0,1000.

Example:

"100,0"

Response

data

object

Show child attributes

data.items

The ExpenseTempItem Resource · object[]

Show child attributes

data.items.id

integer

required

Required range: x >= 1

data.items.purchasedOn

string<date>

required

Day the expense was made.

data.items.originalTransaction

object

required

Expense amount in original currency.

Show child attributes

data.items.originalTransaction.grossAmount

number

required

Must be a multiple of 0.01

data.items.originalTransaction.currencyId

string

required

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

data.items.originalTransaction.isExpenseAbroad

boolean

default:false

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

data.items.processedAmounts

object

required

Various amounts in the establishment's currency.

Show child attributes

data.items.processedAmounts.grossAmount

number

required

Original transaction amount converted into the establishment's currency.

Must be a multiple of 0.01

data.items.processedAmounts.currencyId

string

required

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

data.items.processedAmounts.currency

Currency · object

Show child attributes

data.items.processedAmounts.currency.id

string

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

data.items.processedAmounts.currency.name

string

Label of the currency (eg: Pound sterling).

data.items.processedAmounts.currency.url

string<uri>

data.items.processedAmounts.netAmount

number

The converted amount after the expense policy has been applied.

Must be a multiple of 0.01

data.items.processedAmounts.vatBases

object[]

Show child attributes

data.items.processedAmounts.vatBases.countryVatRateId

integer

Required range: x >= 1

data.items.processedAmounts.vatBases.countryVatRate

object

Applicable VAT rate for this amount.

Show child attributes

data.items.processedAmounts.vatBases.countryVatRate.id

integer

Required range: x >= 1

data.items.processedAmounts.vatBases.countryVatRate.name

string

data.items.processedAmounts.vatBases.countryVatRate.url

string<uri>

data.items.processedAmounts.vatBases.vatAmount

number

Must be a multiple of 0.01

data.items.processedAmounts.vatBases.amountExcludingVat

number

Must be a multiple of 0.01

data.items.expenseNatureId

integer

required

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

Required range: x >= 1

data.items.quantity

integer

default:1

required

The quantity when the expense type is 'Quantity'.

Required range: x >= 1

data.items.ownerId

integer

required

Unique identifier of the user that made this expense.

data.items.paymentMethodId

enum<integer>

required

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

data.items.deviceId

string

required

Allowed value: "Web"

data.items.mileage

object

Additional information when the expense type is mileage.

Show child attributes

data.items.mileage.distance

number

Distance where the unit depends on the establishment.

data.items.mileage.power

number

Tax horsepower of the vehicle.

data.items.mileage.waypoints

any[]

The collection of waypoints including intermediate waypoints.

data.items.effectiveQuantity

integer

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

Required range: x >= 1

data.items.attendees

object

Additional information when the expense type is 'Invitation'.

Show child attributes

data.items.attendees.internal

User · object[]

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

Show child attributes

data.items.attendees.internal.id

number

required

data.items.attendees.internal.name

string

required

Minimum string length: 1

data.items.attendees.internal.url

string

required

Minimum string length: 1

data.items.attendees.internal.displayName

string

required

Minimum string length: 1

data.items.attendees.internal.modifiedOn

string

required

Minimum string length: 1

data.items.attendees.internal.lastName

string

required

Minimum string length: 1

data.items.attendees.internal.firstName

string

required

Minimum string length: 1

data.items.attendees.internal.mail

string

required

Minimum string length: 1

data.items.attendees.internal.dtContractStart

string

required

Minimum string length: 1

data.items.attendees.internal.birthDate

string

required

Minimum string length: 1

data.items.attendees.internal.employeeNumber

string

required

Minimum string length: 1

data.items.attendees.internal.calendar

object

required

Show child attributes

data.items.attendees.internal.calendar.id

number

required

data.items.attendees.internal.calendar.url

string

required

Minimum string length: 1

data.items.attendees.internal.calendar.name

string

required

Minimum string length: 1

data.items.attendees.internal.culture

object

required

Show child attributes

data.items.attendees.internal.culture.id

number

required

data.items.attendees.internal.culture.name

string

required

Minimum string length: 1

data.items.attendees.internal.culture.url

string

required

Minimum string length: 1

data.items.attendees.internal.picture

object

required

Show child attributes

data.items.attendees.internal.picture.id

string

required

Minimum string length: 1

data.items.attendees.internal.picture.url

string

required

Minimum string length: 1

data.items.attendees.internal.picture.name

string

required

Minimum string length: 1

data.items.attendees.internal.applicationData

object

required

Show child attributes

data.items.attendees.internal.applicationData.profile_figgo

object

required

Show child attributes

data.items.attendees.internal.applicationData.profile_figgo.id

number

required

data.items.attendees.internal.applicationData.profile_figgo.name

string

required

Minimum string length: 1

data.items.attendees.internal.applicationData.profile_figgo.url

string

required

Minimum string length: 1

data.items.attendees.internal.applicationData.profile_utime

object

required

Show child attributes

data.items.attendees.internal.applicationData.profile_utime.id

number

required

data.items.attendees.internal.applicationData.profile_utime.name

string

required

Minimum string length: 1

data.items.attendees.internal.applicationData.profile_utime.url

string

required

Minimum string length: 1

data.items.attendees.internal.legalEntity

object

required

Show child attributes

data.items.attendees.internal.legalEntity.id

number

required

data.items.attendees.internal.legalEntity.name

string

required

Minimum string length: 1

data.items.attendees.internal.legalEntity.url

string

required

Minimum string length: 1

data.items.attendees.internal.department

object

required

Show child attributes

data.items.attendees.internal.department.id

number

required

data.items.attendees.internal.department.name

string

required

Minimum string length: 1

data.items.attendees.internal.department.url

string

required

Minimum string length: 1

data.items.attendees.internal.manager

object

required

Show child attributes

data.items.attendees.internal.manager.id

number

required

data.items.attendees.internal.manager.name

string

required

Minimum string length: 1

data.items.attendees.internal.manager.url

string

required

Minimum string length: 1

data.items.attendees.internal.rolePrincipal

object

required

Show child attributes

data.items.attendees.internal.rolePrincipal.id

number

required

data.items.attendees.internal.rolePrincipal.name

string

required

Minimum string length: 1

data.items.attendees.internal.rolePrincipal.url

string

required

Minimum string length: 1

data.items.attendees.internal.habilitedRoles

object[]

required

Minimum array length: 1

Show child attributes

data.items.attendees.internal.habilitedRoles.id

number

required

data.items.attendees.internal.habilitedRoles.name

string

required

Minimum string length: 1

data.items.attendees.internal.habilitedRoles.url

string

required

Minimum string length: 1

data.items.attendees.internal.userWorkCycles

object[]

required

Minimum array length: 1

Show child attributes

data.items.attendees.internal.userWorkCycles.Id

number

required

data.items.attendees.internal.userWorkCycles.OwnerID

number

required

data.items.attendees.internal.userWorkCycles.WorkCycleID

number

required

data.items.attendees.internal.userWorkCycles.StartsOn

string

required

Minimum string length: 1

data.items.attendees.internal.userWorkCycles.EndsOn

string

required

Minimum string length: 1

data.items.attendees.internal.dtContractEnd

any

data.items.attendees.external

object[]

External attendees (eg: clients, candidates).

Show child attributes

data.items.attendees.external.id

integer

Required range: x >= 1

data.items.attendees.external.displayName

string

data.items.axisSections

The Axis Section resource · object[] | null

Show child attributes

data.items.axisSections.id

integer

Required range: x >= 1

data.items.axisSections.code

string

data.items.axisSections.name

string

data.items.axisSections.multilingualName

string

data.items.axisSections.description

string

data.items.axisSections.ownerId

integer

Required range: x >= 1

data.items.axisSections.startOn

string<date-time>

data.items.axisSections.endOn

string<date-time>

data.items.axisSections.active

boolean

data.items.axisSections.axisId

integer

data.items.axisSections.parentAxisSections

object[]

data.items.axisSections.childrenAxisSections

object[]

data.items.customFields

object

Values for custom fields.

Show child attributes

data.items.customFields.{key}

object

Show child attributes

data.items.customFields.{key}.code

string

Value inputted by the user.

data.items.customFields.{key}.name

string

Label corresponding to the input value based on the configuration (eg: 'Yes' for checkbox).

data.items.merchant

string | null

Merchant of the expense.

data.items.comment

string | null

data.items.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

data.items.expenseReceipts.id

string<uuid>

The ID of this expense receipt.

Example:

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

data.items.expenseReceipts.originalReceipt

object

The original file.

Show child attributes

data.items.expenseReceipts.originalReceipt.id

string<uuid>

The ID of the expense receipt file.

Example:

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

data.items.expenseReceipts.originalReceipt.name

string

Example:

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

data.items.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"

data.items.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"

data.items.expenseReceipts.receiptPreview

object

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

Show child attributes

data.items.expenseReceipts.receiptPreview.id

string<uuid>

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

Example:

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

data.items.expenseReceipts.receiptPreview.name

string

Example:

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

data.items.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"

data.items.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"

data.items.authorizedActions

object

Authorized actions on the expense for the current user.

Show child attributes

data.items.authorizedActions.isCancellable

boolean

Expense can be deleted by the current authenticated user.

data.items.authorizedActions.isEditable

boolean

Expense can be edited by the current authenticated user.

data.items.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

data.items.sourceId.id

string

data.items.source

Enum · object

Show child attributes

data.items.source.id

number

data.items.source.name

string

data.items.source.code

string

data.items.paymentMethod

Enum · object

Show child attributes

data.items.paymentMethod.id

number

data.items.paymentMethod.name

string

data.items.paymentMethod.code

string

data.items.statusId

StatusId · object

Status of the expense.

0: the expense is not valid.
1: the expense has been completed by the system and review is still pending
2: the expense has been completed and reviewed and it can be declared.

Show child attributes

data.items.statusId.id

enum<number>

Available options:

0,

1,

2

data.items.status

Enum · object

Show child attributes

data.items.status.id

number

data.items.status.name

string

data.items.status.code

string

The expense-temp-item resource

Create a new temporary expense

⌘I

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

List ExpenseTempItems

Headers

Query Parameters

Response