Skip to main content

When a user wants to declare his expenses, he creates an ExpenseClaim.

An ExpenseClaim is created by regrouping one or more ExpenseTempItems and converting them into ExpenseClaimItems.

Once created, an ExpenseClaim has to be approved by his manager.

Multiple ExpenseClaims can be created through a single request.

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
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
source
Enum · object
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
paymentMethod
Enum · object
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.
status
Enum · object
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.
approvalState
Enum · object
owner
Owner · object
authorId
integer

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

author
EntityBase · object
departmentId
integer
department
EntityBase · object
currencyId
string

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

currency
Currency · object