Here are the different models you can subscribe to while doing a sync.
Model ID | Event Data Key | Description |
---|---|---|
expense_details | details | Contains information about the expense, such as ID, type, creator, status, reimbursable, merchant, category, amount, currency, dates, etc. |
expense_attendees | attendees | Contains a list of attendees associated with the expense, including their name and email. |
expense_policy | policy | Contains the policy related to the expense, including the policy name and ID. |
expense_tax | tax | Contains information about tax associated with the expense. |
expense_payment | payment | Contains details related to the payment for the expense. |
expense_receipts | receipts | Contains 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 thedataType
in sync request body isexpenses
Expense Details
Model ID: expense_details
Name | Type | Description |
---|---|---|
expenseID | String | Unique identifier for the expense |
expenseType | Enum | Type of expense. One ofEXPENSE ,DISTANCE ,TIME ,OTHER |
count | Double | Distance or TIme for which Expense is being claimed |
rate | Double | Amount to be paid per unit of distance |
unit | String | Unit of distance |
creatorEmail | String | Email address of the expense creator |
status | Enum | Current status of the expense. One ofOPEN SUBMITTED ,APPROVED ,REIMBURSED ,ARCHIVED |
isReimbursable | Enum | Indicates whether the expense is reimbursable One of TRUE ,FALSE ,NOT_SPECIFIED |
isACHReimbursed | Enum | Indicates whether the expense is ACH reimbursed One of TRUE ,FALSE ,NOT_SPECIFIED |
isBillable | Enum | Indicates whether the expense is billable One of TRUE ,FALSE ,NOT_SPECIFIED |
merchant | String | Name of the merchant |
category | String | Category of the expense |
amount | Double | Expense amount (e.g., 100.50) |
currency | String | 3 letter ISO currency code, in which the expense is denominated (e.g., "USD", "GBP", "INR") |
expenseDate | Date | Date of the expense (e.g. "2024-01-15T15:00:00Z") |
creationDate | Date | Date of expense creation (e.g."2024-01-17T15:00:00Z") |
submissionDate | Date | Date of expense submission (e.g. "2024-01-18T15:00:00Z") |
approvalDate | Date | Date of expense approval (e.g. "2024-01-18T15:00:00Z") |
reimbursementDate | Date | Date of expense reimbursement (e.g. "2024-01-18T15:00:00Z") |
reportId | String | ID of the report to which the expense belongs |
reportName | String | Name of the report to which the expense belongs |
description | String |
Expense Attendees
Model ID: expense_attendees
Name | Type | Description |
---|---|---|
attendees | List[Attendees] |
Attendees
Name | Type | Description |
---|---|---|
name | String | |
email | String |
Expense Policy
Model ID: expense_policy
Name | Type | Description |
---|---|---|
name | String | Name of Policy |
id | String | Id of Policy |
Expense Tax
Model ID: expense_tax
Name | Type | Description |
---|---|---|
hasTax | Boolean | Indicates whether the expense has tax associated |
taxAmount | Double | applicable if hasTax is true |
taxName | String | applicable if hasTax is true |
taxRate | Double | applicable if hasTax is true |
taxCode | String | applicable if hasTax is true |
Expense Payment
Model ID: expense_payment
Name | Type | Description |
---|---|---|
mode | Enum | One ofCHECK ,ACCOUNT_TRANSFER |
referenceId | String | A reference identifier of the payment made or reimbursed |
date | String | Date at which payment made or reimbursed |
accountId | String | Account Number for payment or reimbursement |
accountName | String | Account Name for payment or reimbursement |
Expense Receipts
Model ID: expense_receipts
Name | Type | Description |
---|---|---|
receipts | List[Receipt] |
Receipt
Name | Type | Description |
---|---|---|
fileName | String | File Name |
id | String | |
type | String | |
link | String | Downloadable 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"
}
]
}