Expense Data Models

Here are the different models you can subscribe to while doing a sync.

Model IDEvent Data KeyDescription
expense_detailsdetailsContains information about the expense, such as ID, type, creator, status, reimbursable, merchant, category, amount, currency, dates, etc.
expense_attendeesattendeesContains a list of attendees associated with the expense, including their name and email.
expense_policypolicyContains the policy related to the expense, including the policy name and ID.
expense_taxtaxContains information about tax associated with the expense.
expense_paymentpaymentContains details related to the payment for the expense.
expense_receiptsreceiptsContains details related to the receipts for the expense.

All these models have been detailed out below for your reference.

📘

Use the Model ID for syncs

While invoking sync APIs, pass these model IDs in order to get the desired data.
Make sure the dataTypein sync request body isexpenses

Expense Details

Model ID: expense_details

NameTypeDescription
expenseIDStringUnique identifier for the expense
expenseTypeEnumType of expense. One of
EXPENSE,
DISTANCE,
TIME,
OTHER
countDoubleDistance or TIme for which Expense is being claimed
rateDoubleAmount to be paid per unit of distance
unitStringUnit of distance
creatorEmailStringEmail address of the expense creator
statusEnumCurrent status of the expense. One of
OPEN
SUBMITTED,
APPROVED,
REIMBURSED,
ARCHIVED
isReimbursableEnumIndicates whether the expense is reimbursable
One of
TRUE,
FALSE,
NOT_SPECIFIED
isACHReimbursedEnumIndicates whether the expense is ACH reimbursed
One of
TRUE,
FALSE,
NOT_SPECIFIED
isBillableEnumIndicates whether the expense is billable
One of
TRUE,
FALSE,
NOT_SPECIFIED
merchantStringName of the merchant
categoryStringCategory of the expense
amountDoubleExpense amount (e.g., 100.50)
currencyString3 letter ISO currency code, in which the expense is denominated (e.g., "USD", "GBP", "INR")
expenseDateDateDate of the expense (e.g. "2024-01-15T15:00:00Z")
creationDateDateDate of expense creation (e.g."2024-01-17T15:00:00Z")
submissionDateDateDate of expense submission (e.g. "2024-01-18T15:00:00Z")
approvalDateDateDate of expense approval (e.g. "2024-01-18T15:00:00Z")
reimbursementDateDateDate of expense reimbursement (e.g. "2024-01-18T15:00:00Z")
reportIdStringID of the report to which the expense belongs
reportNameStringName of the report to which the expense belongs
descriptionString

Expense Attendees

Model ID: expense_attendees

NameTypeDescription
attendeesList[Attendees]

Attendees

NameTypeDescription
nameString
emailString

Expense Policy

Model ID: expense_policy

NameTypeDescription
nameStringName of Policy
idStringId of Policy

Expense Tax

Model ID: expense_tax

NameTypeDescription
hasTaxBooleanIndicates whether the expense has tax associated
taxAmountDoubleapplicable if hasTax is true
taxNameStringapplicable if hasTax is true
taxRateDoubleapplicable if hasTax is true
taxCodeStringapplicable if hasTax is true

Expense Payment

Model ID: expense_payment

NameTypeDescription
modeEnumOne of
CHECK,
ACCOUNT_TRANSFER
referenceIdStringA reference identifier of the payment made or reimbursed
dateStringDate at which payment made or reimbursed
accountIdStringAccount Number for payment or reimbursement
accountNameStringAccount Name for payment or reimbursement

Expense Receipts

Model ID: expense_receipts

NameTypeDescription
receiptsList[Receipt]

Receipt

NameTypeDescription
fileNameStringFile Name
idString
typeString
linkStringDownloadable link of the file.

Event Data Example

{
  "details": {
    "expenseID": "493401557704610128",
    "expenseType": "EXPENSE",
    "time": 35.6,
    "rate": 66.99,
    "unit": "mi",
    "creatorEmail": "[email protected]",
    "status": "OPEN",
    "isReimbursable": true,
    "isACHReimbursed": false,
    "isBillable": true,
    "merchant": "Crosswords",
    "category": "Home Office",
    "amount": 500.0,
    "currency": "INR",
    "expenseDate": "2024-01-15T00:00:00Z",
    "creationDate": "2024-01-16T00:00:00Z",
    "submissionDate": "2024-01-15T00:00:00Z",
    "approvalDate": "2024-01-15T00:00:00Z",
    "reimbursementDate": "2024-01-15T00:00:00Z"
  },
  "attendees": [
    {
      "name": "Jhon Doe",
      "email": "[email protected]"
    },
    {
      "name": "Emily K",
      "email": "[email protected]"
    }
  ],
  "policy": {
    "name": "Knit",
    "id": "9C791392D6FEE761"
  },
  "tax": {
    "hasTax": true,
    "taxAmount": 500.0,
    "taxName": "VAT",
    "taxRate": 15.0,
    "taxCode": "VAT"
  },
  "payment": {
    "mode": "CHECK",
    "referenceId": "567890",
    "date": "2024-01-15T00:00:00Z",
    "accountId": "JPMF8934FJ3",
    "accountName": "Personal Bank Account"
  },
  "receipts": [
    {
      "fileName": "Receipt1.pdf",
      "link": "https://download.me/receipt123",
      "id": "receipt123",
      "fileType": "pdf"
    },
    {
      "fileName": "Receipt2.pdf",
      "link": "https://download.me/receipt456",
      "id": "receipt456",
      "fileType": "pdf"
    }
  ]
}