The expense-claim-item resource

{
  "purchasedOn": "2023-11-07T05:31:56Z",
  "expenseNatureId": 1,
  "id": 1,
  "expenseClaimId": 1,
  "lineNumber": 1,
  "isControlled": true,
  "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
      }
    ]
  },
  "mileage": {
    "distance": 123,
    "power": 123,
    "waypoints": [
      "<unknown>"
    ]
  },
  "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>",
        "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>"
  },
  "ownerId": 123
}

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

integer

read-only

Required range: x >= 0

expenseClaimId

integer

read-only

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

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

processedAmounts

object

read-only

Various amounts in the establishment's currency.

Show child attributes

mileage

object

Additional information when the expense type is mileage.

Show child attributes

quantity

integer

default:1

The quantity when the expense type is 'Quantity'.

Required range: x >= 1

effectiveQuantity

integer

read-only

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

Required range: x >= 1

attendees

object

Additional information when the expense type is 'Invitation'.

Show child attributes

axisSections

The Axis Section resource · object[] | null

Axis sections values.

Show child attributes

customFields

object

Values for custom fields.

Show child attributes

merchant

string | null

Merchant of the expense.

comment

string | null

expenseReceipts

ExpenseReceipt · object[] | null

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

Important: to attach a receipt when creating or updating an expense, you must first upload the file via POST /lucca-files/api/uploads, then create an ExpenseReceipt via POST /api/v3/expenseReceipts (providing the uploadId), and finally reference the receipt by its id here. Passing the file upload ID directly will result in a 403 Forbidden error. See the Attaching receipts guide.

Show child attributes

authorizedActions

object

read-only

Authorized actions on the expense for the current user.

Show child attributes

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

source

Enum · object

Show child attributes

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

List ExpenseClaims

List ExpenseClaimItems