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.

declaredOn
string
required

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

createdOn
string
required

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

modifiedOn
string
required

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

id
integer
Required range: x > 1
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
paymentReceivedOn
string

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

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
object
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
paymentMethod
object
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.
status
object
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
object
authorizedActions
object

Authorized actions on the expenseClaim for the current user.

ownerId
integer

Unique identifier of the user that made this expenseClaim.

owner
object
authorId
integer

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

author
object
legalEntityId
integer
legalEntity
object
departmentId
integer
department
object
currencyId
string

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

currency
object