Documentation
Organization Structure API
- Axis-sections
- Departments
- Legal-Units
- Establishments
Core HR API
- Employees Directory
- Guides
Cleemy Expenses API
- Expense-temp-items
- Expense-claims
- Expense-claim-items
- Exports
Cleemy Invoices API
- Guides
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
Update an ExpenseTempItem by id
Update a temporary expense item by its identifier.
curl --request PUT \
--url https://{host}/api/v3/expenseTempItems/{expenseTempItemId} \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data '{
"purchasedOn": "2023-12-25",
"originalTransaction": {
"grossAmount": 123,
"currencyId": "<string>",
"isExpenseAbroad": false
},
"processedAmounts": {
"grossAmount": 123,
"currencyId": "<string>",
"currency": {
"id": "<string>",
"name": "<string>",
"url": "<string>"
}
},
"expenseNatureId": 2,
"mileage": {
"distance": 123,
"power": 123,
"waypoints": [
"<any>"
]
},
"quantity": 1,
"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
}
],
"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"
}
}
],
"sourceId": {
"id": "<string>"
},
"source": {
"id": 123,
"code": "<string>"
},
"ownerId": 123,
"paymentMethodId": 0,
"paymentMethod": {
"id": 123,
"code": "<string>"
},
"statusId": {
"id": 0
},
"status": {
"id": 123,
"code": "<string>"
},
"deviceId": "<string>"
}'
{
"data": {
"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,
"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": [
{}
],
"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>"
},
"ownerId": 123,
"paymentMethodId": 0,
"paymentMethod": {
"id": 123,
"name": "<string>",
"code": "<string>"
},
"statusId": {
"id": 0
},
"status": {
"id": 123,
"name": "<string>",
"code": "<string>"
},
"deviceId": "<string>"
}
}
Headers
API key. Value must be formatted like so: lucca application={api_key}
.
Path Parameters
Unique identifier of the ExpenseTempItem.
Body
The ExpenseTempItem
, or "temporary expense" is an expense that has not yet been declared (within an expense report) by its owner (the user who made the expense). Once submitted within an expense report, the expense turns into an ExpenseClaimItem
.
Day the expense was made.
Expense amount in original currency.
0.01
ISO code of the currency (eg: 'EUR', 'USD', 'GBP', ...).
Whether the expense was made in a different country than the owner establishment's.
Various amounts in the establishment's currency.
Original transaction amount converted into the establishment's currency.
0.01
ISO code of the currency (eg: 'EUR', 'USD', 'GBP', ...).
Nature of the expense: Meals, Train, Taxi, Hotels, Taxi, Mileage... List depends on the app configuration.
x >= 1
The quantity when the expense type is 'Quantity'.
x >= 1
Unique identifier of the user that made this expense.
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
0
, 1
, 3
"Web"
Additional information when the expense type is 'Invitation'.
Attendees who work for the company (ie: Users in the system).
1
1
1
1
1
1
1
1
1
1
1
1
1
You can read more about this resource here.
x >= 1
Merchant of the expense.
The expense receipts (PDF file, image, ...). Technically, there could be more than one, but in reality, there’s usually just one.
An expense's receipt. Can be downloaded, either as an original or preview file, by following the href
link. Please note that a 302 Redirect may be returned, in which case you have to follow the URL returned in the Location
HTTP header.
The ID of this expense receipt.
"f0d01fd0-5f27-4061-8dca-bee6318b0103"
The original file.
The ID of the expense receipt file.
"cb0aae89-56c9-48db-9052-48981660e0f7"
"receipt-f0d01fd0-5f27-4061-8dca-bee6318b0103.pdf"
Follow this link to download this expense receipt original file.
"https://example.ilucca.net/api/v3/ExpenseReceipts/f0d01fd0-5f27-4061-8dca-bee6318b0103/originalReceiptFile"
Suffix to the name of a file (e.g., .txt, .pdf, .jppg) that indicates its content type or its intended use.
".pdf"
Lower resolution (i.e. thumbnail) file of the original expense receipt.
The ID of the expense receipt file (same as original).
"cb0aae89-56c9-48db-9052-48981660e0f7"
"receipt-f0d01fd0-5f27-4061-8dca-bee6318b0103-preview.pdf"
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).
"https://example.ilucca.net/api/v3/ExpenseReceipts/f0d01fd0-5f27-4061-8dca-bee6318b0103/receiptPreviewFile"
Suffix to the name of a file (e.g., .txt, .pdf, .jppg) that indicates its content type or its intended use.
".pdf"
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
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.
0
, 1
, 2
Response
The ExpenseTempItem
, or "temporary expense" is an expense that has not yet been declared (within an expense report) by its owner (the user who made the expense). Once submitted within an expense report, the expense turns into an ExpenseClaimItem
.
x >= 1
Day the expense was made.
Expense amount in original currency.
0.01
ISO code of the currency (eg: 'EUR', 'USD', 'GBP', ...).
Whether the expense was made in a different country than the owner establishment's.
Various amounts in the establishment's currency.
Original transaction amount converted into the establishment's currency.
0.01
ISO code of the currency (eg: 'EUR', 'USD', 'GBP', ...).
The converted amount after the expense policy has been applied.
0.01
x >= 1
0.01
0.01
Nature of the expense: Meals, Train, Taxi, Hotels, Taxi, Mileage... List depends on the app configuration.
x >= 1
The quantity when the expense type is 'Quantity'.
x >= 1
Unique identifier of the user that made this expense.
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
0
, 1
, 3
"Web"
Calculated quantity when the expense type is 'Quantity' or 'Invitations' (number of attendees).
x >= 1
Additional information when the expense type is 'Invitation'.
Attendees who work for the company (ie: Users in the system).
1
1
1
1
1
1
1
1
1
1
1
1
1
You can read more about this resource here.
x >= 1
x >= 1
Axis-section objects
Axis-section objects
Merchant of the expense.
The expense receipts (PDF file, image, ...). Technically, there could be more than one, but in reality, there’s usually just one.
An expense's receipt. Can be downloaded, either as an original or preview file, by following the href
link. Please note that a 302 Redirect may be returned, in which case you have to follow the URL returned in the Location
HTTP header.
The ID of this expense receipt.
"f0d01fd0-5f27-4061-8dca-bee6318b0103"
The original file.
The ID of the expense receipt file.
"cb0aae89-56c9-48db-9052-48981660e0f7"
"receipt-f0d01fd0-5f27-4061-8dca-bee6318b0103.pdf"
Follow this link to download this expense receipt original file.
"https://example.ilucca.net/api/v3/ExpenseReceipts/f0d01fd0-5f27-4061-8dca-bee6318b0103/originalReceiptFile"
Suffix to the name of a file (e.g., .txt, .pdf, .jppg) that indicates its content type or its intended use.
".pdf"
Lower resolution (i.e. thumbnail) file of the original expense receipt.
The ID of the expense receipt file (same as original).
"cb0aae89-56c9-48db-9052-48981660e0f7"
"receipt-f0d01fd0-5f27-4061-8dca-bee6318b0103-preview.pdf"
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).
"https://example.ilucca.net/api/v3/ExpenseReceipts/f0d01fd0-5f27-4061-8dca-bee6318b0103/receiptPreviewFile"
Suffix to the name of a file (e.g., .txt, .pdf, .jppg) that indicates its content type or its intended use.
".pdf"
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
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.
0
, 1
, 2
Was this page helpful?
curl --request PUT \
--url https://{host}/api/v3/expenseTempItems/{expenseTempItemId} \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data '{
"purchasedOn": "2023-12-25",
"originalTransaction": {
"grossAmount": 123,
"currencyId": "<string>",
"isExpenseAbroad": false
},
"processedAmounts": {
"grossAmount": 123,
"currencyId": "<string>",
"currency": {
"id": "<string>",
"name": "<string>",
"url": "<string>"
}
},
"expenseNatureId": 2,
"mileage": {
"distance": 123,
"power": 123,
"waypoints": [
"<any>"
]
},
"quantity": 1,
"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
}
],
"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"
}
}
],
"sourceId": {
"id": "<string>"
},
"source": {
"id": 123,
"code": "<string>"
},
"ownerId": 123,
"paymentMethodId": 0,
"paymentMethod": {
"id": 123,
"code": "<string>"
},
"statusId": {
"id": 0
},
"status": {
"id": 123,
"code": "<string>"
},
"deviceId": "<string>"
}'
{
"data": {
"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,
"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": [
{}
],
"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>"
},
"ownerId": 123,
"paymentMethodId": 0,
"paymentMethod": {
"id": 123,
"name": "<string>",
"code": "<string>"
},
"statusId": {
"id": 0
},
"status": {
"id": 123,
"name": "<string>",
"code": "<string>"
},
"deviceId": "<string>"
}
}