Expense
Represents a single expense transaction in the system.
Expense API Reference ->
Properties
| Property | Type | Description |
|---|---|---|
| _id | string | Unique identifier for the expense |
| amount | number | The expense amount |
| fees | number | Associated fees for the transaction |
| charge | number | Total charge including fees |
| original_currency | string | Original currency code of the transaction |
| currency | string | Currency code used for the expense |
| original_amount | number | Original amount in the transaction currency |
| transaction_ref | string | Unique reference for the transaction |
| provider_ref | string | Reference provided by the payment provider |
| employee_id | string | Unique identifier for the employee |
| person | string | Name of the person associated with the expense |
| transaction_date | string (ISO 8601 date-time) | Date and time of the transaction |
| MerchantCategoryCode | string | Category code for the merchant |
| MerchantIdentifier | string | Identifier for the merchant |
| fx_rate | number | Foreign exchange rate applied |
| card_vcn | string | Virtual Card Number used for the transaction |
| receiver | string | Identifier of the receiver of the payment |
| accno | string | Account number (if applicable) |
| payment_type | string | Type of payment (e.g., "CARD") |
| channel | string | Channel used for the transaction |
| subcategory | object | Subcategory details for the expense |
| subcategory._id | string | Unique identifier for the subcategory |
| subcategory.category | object | Main category details |
| subcategory.category._id | string | Unique identifier for the main category |
| subcategory.category.groupid | string | Group ID for the main category |
| subcategory.category.name | string | Name of the main category |
| subcategory.code | string | Code for the subcategory |
| subcategory.name | string | Name of the subcategory |
| team | object | Team details associated with the expense |
| team._id | string | Unique identifier for the team |
| team.name | string | Name of the team |
| team.code | string | Code for the team |
| tag | array | Array of tags associated with the expense |
| notes | string | Additional notes for the expense |
| risk | string | Risk level of the transaction |
| risk_notes | string | Notes regarding the risk assessment |
| ip | string | IP addresses associated with the transaction |
| attachments | array of strings | URLs of attached documents |
| payment_status | string | Status of the payment |
| status | string | Overall status of the expense |
| review_participants | array | List of participants in the review process |
| review_mandate | number | Number of required reviews |
| review_level | number | Current level of review |
| events | array | Array of events associated with the expense |
| exported | boolean | Indicates if the expense has been exported |
| sync_successful | boolean | Indicates if the expense has been successfully synced |
| org_wallet_ref | string | Reference to the organization's wallet |
| vendor | string | Name or identifier of the vendor |
| customer | null | Customer information (if applicable) |
| account_number | string | Account number associated with the expense |
| reviews | array of objects | List of review actions taken on the expense |
| reviews[].person | string | Name of the person who performed the review |
| reviews[].notes | string | Notes added during the review |
| reviews[].status | string | Status of the review |
| reviews[]._id | string | Unique identifier for the review |
| reviews[].reviewed_on | string (ISO 8601 date-time) | Date and time of the review |
| createdAt | string (ISO 8601 date-time) | Date and time when the expense was created |
| updatedAt | string (ISO 8601 date-time) | Date and time when the expense was last updated |
| __v | number | Version number of the document |
| id | string | Alias for _id |
Example
{
"_id": "66e055c6a915de8a964b4334",
"amount": 250,
"fees": 14,
"charge": 264,
"original_currency": "KES",
"currency": "KES",
"original_amount": 250,
"transaction_ref": "T-SITI7A2DPRQVHH",
"provider_ref": "SIA04NCCZY",
"employee_id": "0D1549CF0B9EC5061BC1F9E1",
"person": "J Kemboi",
"transaction_date": "2024-09-10T14:20:53.000Z",
"MerchantCategoryCode": "",
"MerchantIdentifier": "",
"fx_rate": 1,
"card_vcn": "520182200003877",
"receiver": "8301258",
"accno": "",
"payment_type": "CARD",
"channel": "BUY GOODS",
"subcategory": {
"_id": "64ec5b4affaef6ff2a284548",
"category": {
"_id": "64ec5b4affaef6ff2a284545",
"groupid": "1",
"name": "Business Meals"
},
"code": "495",
"name": "Employee Meals"
},
"team": {
"_id": "64ec5b57ffaef6ff2a2845b3",
"name": "Tech",
"code": "0003"
},
"tag": [],
"notes": "Lunch",
"risk": "low",
"risk_notes": "valid",
"ip": "41.81.135.128, 172.69.171.146",
"attachments": [
"https://s3.eu-west-2.amazonaws.com/boya.corporate.upload/receipts/T-SITI7A2DPRQVHH_Screenshot_20240910_171931_WhatsApp.jpg"
],
"payment_status": "paid",
"status": "pending",
"review_participants": [],
"review_mandate": 1,
"review_level": 1,
"events": [],
"exported": false,
"sync_successful": false,
"org_wallet_ref": "1",
"vendor": "6235126 - SUMPTIOUS SNACK BASKET via BOA",
"customer": null,
"account_number": "P007195",
"reviews": [
{
"person": "J Kemboi",
"notes": "Added supporting documents https://s3.eu-west-2.amazonaws.com/boya.corporate.upload/receipts/T-SITI7A2DPRQVHH_Screenshot_20240910_171931_WhatsApp.jpg",
"status": "pending",
"_id": "66e06d84421bce54ca2ee152",
"reviewed_on": "2024-09-10T16:02:12.274Z"
}
],
"createdAt": "2024-09-10T14:20:54.290Z",
"updatedAt": "2024-09-10T16:02:12.275Z",
"__v": 1,
"id": "66e055c6a915de8a964b4334"
}