List ExpenseClaims

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

{
  "data": {
    "items": [
      {
        "declaredOn": "2023-11-07T05:31:56Z",
        "createdOn": "2023-11-07T05:31:56Z",
        "modifiedOn": "2023-11-07T05:31:56Z",
        "id": 2,
        "name": "<string>",
        "paymentReceivedOn": "2023-11-07T05:31:56Z",
        "sourceId": {
          "id": "<string>"
        },
        "source": {
          "id": 123,
          "name": "<string>",
          "code": "<string>"
        },
        "paymentMethodId": 0,
        "paymentMethod": {
          "id": 123,
          "name": "<string>",
          "code": "<string>"
        },
        "statusId": {
          "id": 0
        },
        "status": {
          "id": 123,
          "name": "<string>",
          "code": "<string>"
        },
        "approvalStateId": {
          "id": 0
        },
        "approvalState": {
          "id": 123,
          "name": "<string>",
          "code": "<string>"
        },
        "authorizedActions": {
          "isCancellable": true,
          "isEditable": true,
          "isApprovable": true,
          "isControllable": true,
          "isUnControllable": true
        },
        "ownerId": 123,
        "owner": {
          "id": 2,
          "name": "<string>",
          "url": "<string>",
          "firstName": "<string>",
          "lastName": "<string>"
        },
        "authorId": 123,
        "author": {
          "id": 123,
          "name": "<string>",
          "url": "<string>"
        },
        "legalEntityId": 123,
        "legalEntity": {
          "id": 123,
          "name": "<string>",
          "url": "<string>"
        },
        "departmentId": 123,
        "department": {
          "id": 123,
          "name": "<string>",
          "url": "<string>"
        },
        "currencyId": "<string>",
        "currency": {
          "id": "<string>",
          "name": "<string>",
          "url": "<string>"
        }
      }
    ]
  }
}

GET

api

expenseClaims

List ExpenseClaims

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

{
  "data": {
    "items": [
      {
        "declaredOn": "2023-11-07T05:31:56Z",
        "createdOn": "2023-11-07T05:31:56Z",
        "modifiedOn": "2023-11-07T05:31:56Z",
        "id": 2,
        "name": "<string>",
        "paymentReceivedOn": "2023-11-07T05:31:56Z",
        "sourceId": {
          "id": "<string>"
        },
        "source": {
          "id": 123,
          "name": "<string>",
          "code": "<string>"
        },
        "paymentMethodId": 0,
        "paymentMethod": {
          "id": 123,
          "name": "<string>",
          "code": "<string>"
        },
        "statusId": {
          "id": 0
        },
        "status": {
          "id": 123,
          "name": "<string>",
          "code": "<string>"
        },
        "approvalStateId": {
          "id": 0
        },
        "approvalState": {
          "id": 123,
          "name": "<string>",
          "code": "<string>"
        },
        "authorizedActions": {
          "isCancellable": true,
          "isEditable": true,
          "isApprovable": true,
          "isControllable": true,
          "isUnControllable": true
        },
        "ownerId": 123,
        "owner": {
          "id": 2,
          "name": "<string>",
          "url": "<string>",
          "firstName": "<string>",
          "lastName": "<string>"
        },
        "authorId": 123,
        "author": {
          "id": 123,
          "name": "<string>",
          "url": "<string>"
        },
        "legalEntityId": 123,
        "legalEntity": {
          "id": 123,
          "name": "<string>",
          "url": "<string>"
        },
        "departmentId": 123,
        "department": {
          "id": 123,
          "name": "<string>",
          "url": "<string>"
        },
        "currencyId": "<string>",
        "currency": {
          "id": "<string>",
          "name": "<string>",
          "url": "<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=declaredOn,desc

declaredOn

string

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

paging

string

required

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

Example:

"100,0"

statusId

string

1: Created; 2: PartiallyApproved; 3: Approved; 4: Controlled; 5: ApprovedAndControlled; 6: PaymentInitiated; 7: Paid; 8: Refused; 9: Cancelled. Examples: 2,3 or PartiallyApproved,Approved.

Response

data

object

Show child attributes

data.items

The ExpenseClaim Resource · object[]

Show child attributes

data.items.declaredOn

string<date-time>

required

Day the expenseClaim has been declared (Time zone Europe/Paris).

data.items.createdOn

string<date-time>

required

Day the expenseClaim has been created (Time zone Europe/Paris).

data.items.modifiedOn

string<date-time>

required

Day the expenseClaim has been modified (Time zone Europe/Paris).

data.items.id

integer

Required range: x >= 1

data.items.name

string

Name of the expense claim. If empty, it will be generated with the month and year of the last of claim item.

Maximum string length: 255

data.items.paymentReceivedOn

string<date-time>

Day the expenseClaim has been paid (Time zone Europe/Paris).

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

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

ClaimStatusId · object

Status of the expenseClaim.

1: the expenseClaim is created.
2: the expenseClaim has been partially approved.
3: the expenseClaim has been approved.
4: the expenseClaim has been controlled.
5: the expenseClaim has been approved and controlled.
6: the payment of the expenseClaim has been initiated.
7: the expenseClaim has been paid.
8: the expenseClaim has been refused.
9: the expenseClaim has been cancelled.

Show child attributes

data.items.statusId.id

enum<number>

Available options:

0,

1,

2,

3,

4,

5,

6,

7,

8

data.items.status

Enum · object

Show child attributes

data.items.status.id

number

data.items.status.name

string

data.items.status.code

string

data.items.approvalStateId

ApprovalStateId · object

State of the approval of the expenseClaim.

0: the approval is created.
1: the expenseClaim has been partially approved.
2: the expenseClaim has been approved.
3: the expenseClaim has been refused.
4: the expenseClaim has been cancelled.

Show child attributes

data.items.approvalStateId.id

enum<number>

Available options:

0,

1,

2,

3,

4

data.items.approvalState

Enum · object

Show child attributes

data.items.approvalState.id

number

data.items.approvalState.name

string

data.items.approvalState.code

string

data.items.authorizedActions

object

Authorized actions on the expenseClaim for the current user.

Show child attributes

data.items.authorizedActions.isCancellable

boolean

The expenseClaim can be deleted by the current authenticated user.

data.items.authorizedActions.isEditable

boolean

The expenseClaim can be edited by the current authenticated user.

data.items.authorizedActions.isApprovable

boolean

The expenseClaim can be approved by the current authenticated user.

data.items.authorizedActions.isControllable

boolean

The expenseClaim can be controlled by the current authenticated user.

data.items.authorizedActions.isUnControllable

boolean

The current authenticated user can cancel the control of the expenseClaim.

data.items.ownerId

integer

Unique identifier of the user that made this expenseClaim.

data.items.owner

Owner · object

Show child attributes

data.items.owner.id

integer

Required range: x >= 1

data.items.owner.name

string

data.items.owner.url

string<uri>

data.items.owner.firstName

string

data.items.owner.lastName

string

data.items.authorId

integer

Unique identifier of the user that created this grouping of expense.

data.items.author

EntityBase · object

Show child attributes

data.items.author.id

integer

data.items.author.name

string

data.items.author.url

string

data.items.legalEntityId

integer

data.items.legalEntity

EntityBase · object

Show child attributes

data.items.legalEntity.id

integer

data.items.legalEntity.name

string

data.items.legalEntity.url

string

data.items.departmentId

integer

data.items.department

EntityBase · object

Show child attributes

data.items.department.id

integer

data.items.department.name

string

data.items.department.url

string

data.items.currencyId

string

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

data.items.currency

Currency · object

Show child attributes

data.items.currency.id

string

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

data.items.currency.name

string

Label of the currency (eg: Pound sterling).

data.items.currency.url

string<uri>

Create a new ExpenseClaim

The expense-claim-item resource

⌘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 ExpenseClaims

Headers

Query Parameters

Response