List ExpenseClaims

Status

Introduction

Files

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

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

GET

api

expenseClaims

curl --request GET \
  --url https://example.ilucca.net/api/v3/expenseClaims

{
  "data": {
    "items": [
      {
        "id": 2,
        "name": "<string>",
        "declaredOn": "2023-11-07T05:31:56Z",
        "createdOn": "2023-11-07T05:31:56Z",
        "modifiedOn": "2023-11-07T05:31:56Z",
        "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>"
        }
      }
    ]
  }
}

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.

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

200

application/json

data

object

data.items

object[]

data.items.declaredOn

string

required

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

data.items.createdOn

string

required

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

data.items.modifiedOn

string

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 length: 255

data.items.paymentReceivedOn

string

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

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

data.items.source

object

data.items.paymentMethodId

enum<number>

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

object

data.items.statusId

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.

data.items.status

object

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

data.items.approvalState

object

data.items.authorizedActions

object

Authorized actions on the expenseClaim for the current user.

data.items.ownerId

integer

Unique identifier of the user that made this expenseClaim.

data.items.owner

object

data.items.authorId

integer

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

data.items.author

object

data.items.legalEntityId

integer

data.items.legalEntity

object

data.items.departmentId

integer

data.items.department

object

data.items.currencyId

string

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

data.items.currency

object

Was this page helpful?

Create a new ExpenseClaim The expense-claim-item resource

curl --request GET \
  --url https://example.ilucca.net/api/v3/expenseClaims

{
  "data": {
    "items": [
      {
        "id": 2,
        "name": "<string>",
        "declaredOn": "2023-11-07T05:31:56Z",
        "createdOn": "2023-11-07T05:31:56Z",
        "modifiedOn": "2023-11-07T05:31:56Z",
        "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>"
        }
      }
    ]
  }
}