Skip to main content

Expense

Security​

Authorization

apiKeyAPI Key
Namex-access-token
Inheader

/v1/expenses​

GET​

Summary​

Fetch Expenses.

Description​

API to fetch existing expenses.

Parameters​
NameLocated inDescriptionRequiredSchema
limitquerylimitNointeger
pagequerypageNointeger
queryqueryqueryNostring
searchquerysearchNostring
sortquerysortNostring
sortDirquerysortDirNostring
viewqueryviewNostring
Responses​
CodeDescriptionSchema
200Make Payment's have been fetched successfully.ExpenseResponse
401Unauthorized
403Forbidden
404Not Found
Security​
Security SchemaScopes
Authorizationglobal

POST​

Summary​

Expense.

Description​

API to add a new expense.

Parameters​
NameLocated inDescriptionRequiredSchema
expenseDtobodyexpenseDtoYesExpenseDto
Responses​
CodeDescriptionSchema
200OKExpenseResponse
201Expense has been added successfully.ExpenseResponse
400Expense failed because of insufficient data.
401Unauthorized
403Forbidden
404Not Found
Security​
Security SchemaScopes
Authorizationglobal

/v1/expenses/admin/categories​

GET​

Summary​

Fetch Category

Description​

API to fetch category.

Responses​
CodeDescriptionSchema
200Category has been fetched successfully.[ ExpenseCategoryDto ]
401Unauthorized
403Forbidden
404Not Found
Security​
Security SchemaScopes
Authorizationglobal

/v1/expenses/breakdown​

GET​

Summary​

Fetch Expense breakdown

Description​

API to fetch expense breakdown for the current year

Parameters​
NameLocated inDescriptionRequiredSchema
typequerytypeNostring
Responses​
CodeDescriptionSchema
200Expense status count and amount fetched successfullyExpenseTrendReportDto
401Unauthorized
403Forbidden
404Not Found
Security​
Security SchemaScopes
Authorizationglobal

/v1/expenses/bulkUnassign​

POST​

Summary​

Bulk UnAssign Manager role

Description​

API to bulk un-assign manager(s).

Parameters​
NameLocated inDescriptionRequiredSchema
userGroupRoleDtobodyuserGroupRoleDtoYes[ UserGroupRoleDto ]
Responses​
CodeDescriptionSchema
200Manager(s) unassigned successfully.[ UserGroupRoleDto ]
201Created
401Unauthorized
403Forbidden
404Not Found
Security​
Security SchemaScopes
Authorizationglobal

/v1/expenses/bulkUser​

POST​

Summary​

Bulk User Creation

Description​

API to create a user(s).

Parameters​
NameLocated inDescriptionRequiredSchema
userGroupRoleDtobodyuserGroupRoleDtoYes[ UserGroupRoleDto ]
Responses​
CodeDescription
200OK
201Member(s) has been created successfully.
401Unauthorized
403Forbidden
404Not Found
Security​
Security SchemaScopes
Authorizationglobal

/v1/expenses/category​

GET​

Summary​

Fetch Category

Description​

API to fetch category.

Responses​
CodeDescriptionSchema
200Category has been fetched successfully.[ ExpenseCategoryDto ]
401Unauthorized
403Forbidden
404Not Found
Security​
Security SchemaScopes
Authorizationglobal

POST​

Summary​

Category Creation

Description​

API to create a category.

Parameters​
NameLocated inDescriptionRequiredSchema
expenseCategoryRequestbodyexpenseCategoryRequestYesExpenseCategoryRequest
Responses​
CodeDescriptionSchema
200OKExpenseCategoryDto
201Category has been created successfully.ExpenseCategoryDto
401Unauthorized
403Forbidden
404Not Found
Security​
Security SchemaScopes
Authorizationglobal

/v1/expenses/category/{id}​

PUT​

Summary​

updateCategory

Parameters​
NameLocated inDescriptionRequiredSchema
expenseCategoryRequestbodyexpenseCategoryRequestYesExpenseCategoryRequest
idpathidYeslong
Responses​
CodeDescriptionSchema
200OKExpenseCategoryDto
201Created
401Unauthorized
403Forbidden
404Not Found
Security​
Security SchemaScopes
Authorizationglobal

DELETE​

Summary​

Category Delete

Description​

API to delete a category.

Parameters​
NameLocated inDescriptionRequiredSchema
idpathidYeslong
Responses​
CodeDescription
200OK
201Category has been deleted successfully.
204No Content
401Unauthorized
403Forbidden
Security​
Security SchemaScopes
Authorizationglobal

/v1/expenses/default-users​

GET​

Summary​

Fetch Default Users

Description​

API to fetch default users

Parameters​
NameLocated inDescriptionRequiredSchema
limitquerylimitNointeger
pagequerypageNointeger
Responses​
CodeDescriptionSchema
200Default users have been fetched successfully.[ ExpenseMembersResponse ]
401Unauthorized
403Forbidden
404Not Found
Security​
Security SchemaScopes
Authorizationglobal

/v1/expenses/export​

GET​

Summary​

Expenses export

Description​

API to export Expenses.

Parameters​
NameLocated inDescriptionRequiredSchema
categoryIdquerycategoryIdNolong
fileFormatqueryfileFormatNostring
fromDatequeryfromDateYesdateTime
statusquerystatusNostring
toDatequerytoDateYesdateTime
viewqueryviewNostring
Responses​
CodeDescriptionSchema
200Expense Report data has been exported.Resource
401Unauthorized
403Forbidden
404Not Found
Security​
Security SchemaScopes
Authorizationglobal

/v1/expenses/group​

GET​

Summary​

Fetch Groups

Description​

API to fetch groups

Parameters​
NameLocated inDescriptionRequiredSchema
limitquerylimitNointeger
pagequerypageNointeger
queryqueryqueryNostring
searchquerysearchNostring
sortquerysortNostring
sortDirquerysortDirNostring
Responses​
CodeDescriptionSchema
200Group has been fetched successfully.ExtAppGroupDto
401Unauthorized
403Forbidden
404Not Found
Security​
Security SchemaScopes
Authorizationglobal

POST​

Summary​

Group Creation

Description​

API to create a group.

Parameters​
NameLocated inDescriptionRequiredSchema
extAppGroupRequestbodyextAppGroupRequestYesExtAppGroupRequest
Responses​
CodeDescriptionSchema
200OKExtAppGroupDto
201Group has been created successfully.ExtAppGroupDto
401Unauthorized
403Forbidden
404Not Found
Security​
Security SchemaScopes
Authorizationglobal

/v1/expenses/group/{groupId}/users​

GET​

Summary​

Fetch Users

Description​

API to fetch group users

Parameters​
NameLocated inDescriptionRequiredSchema
groupIdpathgroupIdYeslong
Responses​
CodeDescriptionSchema
200Members has been fetched successfully.[ ExpenseMembersResponse ]
401Unauthorized
403Forbidden
404Not Found
Security​
Security SchemaScopes
Authorizationglobal

/v1/expenses/group/{id}​

GET​

Summary​

Fetch Group

Description​

API to fetch group by id

Parameters​
NameLocated inDescriptionRequiredSchema
idpathidYeslong
Responses​
CodeDescriptionSchema
200Group has been fetched successfully.ExtAppGroupDto
400Group does not exist.
401Unauthorized
403Forbidden
404Not Found
Security​
Security SchemaScopes
Authorizationglobal

PUT​

Summary​

Group Update

Description​

API to update a group

Parameters​
NameLocated inDescriptionRequiredSchema
extAppGroupDtobodyextAppGroupDtoYesExtAppGroupDto
idpathidYeslong
Responses​
CodeDescriptionSchema
200Group has been created successfully.ExtAppGroupDto
201Created
400Group does not exist.
401Unauthorized
403Forbidden
404Not Found
Security​
Security SchemaScopes
Authorizationglobal

DELETE​

Summary​

Group Delete

Description​

API to delete a group

Parameters​
NameLocated inDescriptionRequiredSchema
idpathidYeslong
Responses​
CodeDescription
200OK
204Group has been deleted successfully.
401Unauthorized
403Forbidden
Security​
Security SchemaScopes
Authorizationglobal

/v1/expenses/import​

POST​

Summary​

Expense.

Description​

API to add a new expense.

Parameters​
NameLocated inDescriptionRequiredSchema
expenseDtosbodyexpenseDtosYes[ ExpenseDto ]
Responses​
CodeDescriptionSchema
200OK[ ExpenseResponse ]
201Expense has been added successfully.[ ExpenseResponse ]
400Expense failed because of insufficient data.
401Unauthorized
403Forbidden
404Not Found
Security​
Security SchemaScopes
Authorizationglobal

/v1/expenses/integration-mapping​

GET​

Summary​

Get integration setting.

Description​

API to get integration setting.

Responses​
CodeDescriptionSchema
200Expense attributes has been updated successfully.IntegrationMappingResponse
401Unauthorized
403Forbidden
404Get integration setting failed.
Security​
Security SchemaScopes
Authorizationglobal

PUT​

Summary​

Update integration setting

Description​

API to update existing integration setting.

Parameters​
NameLocated inDescriptionRequiredSchema
integrationMappingResponsebodyintegrationMappingResponseYesIntegrationMappingResponse
Responses​
CodeDescriptionSchema
200Integration mapping has been updated successfullyIntegrationMappingResponse
201Created
401Unauthorized
403Forbidden
404Integration setting with id not found.
Security​
Security SchemaScopes
Authorizationglobal

/v1/expenses/je/{operation}​

POST​

Summary​

sync/revert je

Description​

API to add make sync/revert je.

Parameters​
NameLocated inDescriptionRequiredSchema
expenseIdsDtosbodyexpenseIdsDtosYesExpenseIdsDto
operationpathoperationYesstring
Responses​
CodeDescriptionSchema
200Sync/revert successfulstring
201Created
401Unauthorized
403Forbidden
404Failed to sync/revert je.
Security​
Security SchemaScopes
Authorizationglobal

/v1/expenses/moveUser​

POST​

Summary​

Move User

Description​

API to move a user

Parameters​
NameLocated inDescriptionRequiredSchema
moveUserGroupRoleDtobodymoveUserGroupRoleDtoYesMoveUserGroupRoleDto
Responses​
CodeDescriptionSchema
200Member(s) has been created successfully.UserGroupRoleDto
201Created
401Unauthorized
403Forbidden
404Not Found
Security​
Security SchemaScopes
Authorizationglobal

/v1/expenses/multi​

POST​

Summary​

Multi expenses

Description​

API to add multiple expenses.

Parameters​
NameLocated inDescriptionRequiredSchema
expensesDtobodyexpensesDtoYesMultiExpensesDto
Responses​
CodeDescriptionSchema
200OKExpenseResponse
201Expense has been added successfully.ExpenseResponse
400Expense failed because of insufficient data.
401Unauthorized
403Forbidden
404Not Found
Security​
Security SchemaScopes
Authorizationglobal

/v1/expenses/process/image​

GET​

Summary​

Get Text Extract from Image

Description​

API to get texts from Image

Parameters​
NameLocated inDescriptionRequiredSchema
relativeFilePathqueryrelativeFilePathNostring
Responses​
CodeDescriptionSchema
200Image texts fetched successfully.ClaimVo
401Unauthorized
403Forbidden
404Not Found
Security​
Security SchemaScopes
Authorizationglobal

/v1/expenses/push/{pushToClient}​

POST​

Summary​

Push Information..

Description​

API to push extracted image information to the server.

Parameters​
NameLocated inDescriptionRequiredSchema
pushToClientpathpushToClientYesboolean
textExtractDtobodytextExtractDtoYesTextExtractDto
Responses​
CodeDescriptionSchema
200OKClaimVo
201Created
401Unauthorized
403Forbidden
404Not Found
Security​
Security SchemaScopes
Authorizationglobal

/v1/expenses/receipt/upload​

POST​

Summary​

Upload receipt

Description​

Upload receipt

Parameters​
NameLocated inDescriptionRequiredSchema
fileformDatafileYesfile
Responses​
CodeDescriptionSchema
200OKAttachmentsResponse
201Upload receipt successfulAttachmentsResponse
400Upload receipt failed
401Unauthorized
403Forbidden
404Not Found
Security​
Security SchemaScopes
Authorizationglobal

/v1/expenses/roles​

GET​

Summary​

Fetch Roles

Description​

API to fetch roles

Responses​
CodeDescriptionSchema
200Role has been fetched successfully.ExtAppGroupDto
401Unauthorized
403Forbidden
404Not Found
Security​
Security SchemaScopes
Authorizationglobal

/v1/expenses/roles/users​

GET​

Summary​

Get users

Description​

API to get users.

Responses​
CodeDescriptionSchema
200users fetched successfullyUserDto
401Unauthorized
403Forbidden
404Failed to fetch users.
Security​
Security SchemaScopes
Authorizationglobal

/v1/expenses/scan​

POST​

Summary​

Scanned Information.

Description​

API to store scanned document information.

Parameters​
NameLocated inDescriptionRequiredSchema
scannerDtobodyscannerDtoYesScannerDto
Responses​
CodeDescriptionSchema
200OKExpenseDto
201Scanned information stored successfully.ExpenseDto
400Scanned information failed to store because of insufficient data.
401Unauthorized
403Forbidden
404Not Found
Security​
Security SchemaScopes
Authorizationglobal

/v1/expenses/status​

GET​

Summary​

Fetch Expense count,status and amount

Description​

API to fetch expense count,amount grouped by status

Parameters​
NameLocated inDescriptionRequiredSchema
queryqueryqueryNostring
viewqueryviewNostring
Responses​
CodeDescriptionSchema
200Expense status count and amount fetched successfully[ ExpenseResponseWithCount ]
401Unauthorized
403Forbidden
404Not Found
Security​
Security SchemaScopes
Authorizationglobal

/v1/expenses/toggle-integration-mapping/{status}​

PATCH​

Summary​

Toggle setting.

Description​

API to update attributes of existing expense.

Parameters​
NameLocated inDescriptionRequiredSchema
statuspathstatusYesstring
Responses​
CodeDescriptionSchema
200API to toggle integration setting.IntegrationMappingResponse
204No Content
401Unauthorized
403Forbidden
404Toggle failed.
Security​
Security SchemaScopes
Authorizationglobal

/v1/expenses/trend​

GET​

Summary​

Fetch Expense trend report

Description​

API to fetch expense trend for the current year

Parameters​
NameLocated inDescriptionRequiredSchema
trend_viewquerytrend_viewNostring
Responses​
CodeDescriptionSchema
200Expense status count and amount fetched successfullyExpenseTrendReportDto
401Unauthorized
403Forbidden
404Not Found
Security​
Security SchemaScopes
Authorizationglobal

/v1/expenses/update​

POST​

Summary​

Approve expenses in bulk

Description​

API to approve multiple expenses

Parameters​
NameLocated inDescriptionRequiredSchema
idsbodyidsYes[ long ]
viewqueryviewYesstring
Responses​
CodeDescriptionSchema
200Expense has been updated successfully.BulkResponse
201Created
401Unauthorized
403Forbidden
404Not Found
Security​
Security SchemaScopes
Authorizationglobal

/v1/expenses/user​

POST​

Summary​

User Creation

Description​

API to create a user(s).

Parameters​
NameLocated inDescriptionRequiredSchema
userGroupRoleDtobodyuserGroupRoleDtoYesUserGroupRoleDto
Responses​
CodeDescriptionSchema
200OKUserGroupRoleDto
201Member(s) has been created successfully.UserGroupRoleDto
401Unauthorized
403Forbidden
404Not Found
Security​
Security SchemaScopes
Authorizationglobal

/v1/expenses/user/{id}​

DELETE​

Summary​

User Deletion

Description​

API to delete a user from a group.

Parameters​
NameLocated inDescriptionRequiredSchema
userGroupRoleDtobodyuserGroupRoleDtoYesUserGroupRoleDto
Responses​
CodeDescription
200OK
204Member has been deleted successfully from the group.
401Unauthorized
403Forbidden
Security​
Security SchemaScopes
Authorizationglobal

/v1/expenses/user/{userId}​

GET​

Summary​

Expense Detail by Users

Description​

API to fetch expense details by users and date

Parameters​
NameLocated inDescriptionRequiredSchema
fromDatequeryfromDateYesdateTime
toDatequerytoDateYesdateTime
userIdpathuserIdYeslong
Responses​
CodeDescriptionSchema
200Make Payment's have been fetched successfully.ExpenseResponse
401Unauthorized
403Forbidden
404Not Found
Security​
Security SchemaScopes
Authorizationglobal

/v1/expenses/userroles​

GET​

Summary​

Get User Roles.

Description​

API to fetch Users group and role information

Responses​
CodeDescriptionSchema
200OKUserGroupRolesResponseDto
401Unauthorized
403Forbidden
404Not Found
Security​
Security SchemaScopes
Authorizationglobal

/v1/expenses/users/{id}​

GET​

Summary​

Fetch Users

Description​

API to fetch group users

Parameters​
NameLocated inDescriptionRequiredSchema
idpathidYeslong
Responses​
CodeDescriptionSchema
200Members has been fetched successfully.[ object ]
401Unauthorized
403Forbidden
404Not Found
Security​
Security SchemaScopes
Authorizationglobal

/v1/expenses/{id}​

GET​

Summary​

Get Expense by id.

Description​

API to fetch Expense by id

Parameters​
NameLocated inDescriptionRequiredSchema
idpathidYeslong
Responses​
CodeDescriptionSchema
200OKExpenseResponse
401Unauthorized
403Forbidden
404Not Found
Security​
Security SchemaScopes
Authorizationglobal

PUT​

Summary​

Update expense.

Description​

API to update existing expense.

Parameters​
NameLocated inDescriptionRequiredSchema
expenseDtobodyexpenseDtoYesExpenseDto
idpathidYeslong
Responses​
CodeDescriptionSchema
200Expense has been updated successfully.ExpenseResponse
201Created
401Unauthorized
403Forbidden
404Expense with id not found.
Security​
Security SchemaScopes
Authorizationglobal

DELETE​

Summary​

Delete expense.

Description​

API to delete expense.

Parameters​
NameLocated inDescriptionRequiredSchema
idpathidYeslong
Responses​
CodeDescriptionSchema
200OKResponseEntity
204Expense has been deleted successfully.ResponseEntity
401Unauthorized
403Forbidden
404Expense with id not found.
Security​
Security SchemaScopes
Authorizationglobal

PATCH​

Summary​

Update expense attributes.

Description​

API to update attributes of existing expense.

Parameters​
NameLocated inDescriptionRequiredSchema
expenseRequestbodyexpenseRequestYesobject
idpathidYeslong
Responses​
CodeDescriptionSchema
200Expense attributes has been updated successfully.ExpenseDto
204No Content
401Unauthorized
403Forbidden
404Expense with id not found.
Security​
Security SchemaScopes
Authorizationglobal

Models​

Address​

NameTypeDescriptionRequired
address1stringAddress line 1
Example: "218, Robinson Road"No
address2stringAddress line 2
Example: "Downtown"No
citystringCity
Example: "C001"No
countrystringCountry
Example: "C001"No
postalCodestringPostal Code
Example: 123456No
preferredbooleanIs this a default address?
Example: trueNo
statestringState
Example: "CS001"No

AttachmentsResponse​

NameTypeDescriptionRequired
fileNamestringNo
relativePathstringNo

BulkResponse​

NameTypeDescriptionRequired
httpStatusCodeintegerHTTP Status code
Example: 404No
idlongID
Example: 2No

CategotyAccountDto​

NameTypeDescriptionRequired
expenseAccountstringExpense Account.
Example: "ACC70003"No
idstringCategory id.
Example: "60d4298aff91a82207a7be2b"No
liabilityAccountstringLiability Account.
Example: "ACC70003"No
namestringCategory name.
Example: "Food"No

ClaimVo​

NameTypeDescriptionRequired
extractedbooleanNo
extractedDates[ string ]No
invoiceNumberstringNo
taxstringNo
totalAmountfloatNo

EntityVo​

NameTypeDescriptionRequired
scorefloatNo
textstringNo
typestringEnum: "DATE", "QUANTITY", "COMMERCIAL_ITEM", "OTHER"No

ExpenseCategoryDto​

NameTypeDescriptionRequired
groups[ ExtAppGroupDto ]No
idlongPrimary Key
Example: 1No
namestringExpense Category Name
Example: "food"No
sysGeneratedbooleanBoolean value
Example: falseNo
tenantIdlongTenant Id
Example: 1No

ExpenseCategoryRequest​

NameTypeDescriptionRequired
groupIds[ long ]List of Group id
Example: [1,2]No
namestringExpense Name
Example: "food"No

ExpenseDto​

NameTypeDescriptionRequired
attachmentIds[ integer ]Attachments idsNo
attachments[ string ]Attachments url'sNo
categoryIdlongExpense category.
Example: 1No
currencystringCurrency code.

Enum: "AFN", "ALL", "DZD", "AOA", "ARS", "AMD", "AWG", "AZN", "BSD", "BHD", "BDT", "BBD", "BYN", "BZD", "BMD", "BTN", "BOB", "BAM", "BRL", "BND", "BGN", "BIF", "KHR", "CAD", "CVE", "KYD", "CLP", "CNY", "COP", "KMF", "CDF", "CRC", "CZK", "HRK", "CUC", "DJF", "DOP", "EGP", "ERN", "ETB", "FKP", "FJD", "XAF", "GMD", "GEL", "GHS", "GIP", "DKK", "GTQ", "GNF", "GYD", "HTG", "HNL", "HKD", "HUF", "ISK", "INR", "IDR", "IRR", "IQD", "JMD", "JPY", "JOD", "KZT", "KES", "KWD", "KGS", "LAK", "LBP", "LSL", "LRD", "LYD", "MOP", "MKD", "MGA", "MWK", "MYR", "MVR", "MRO", "MUR", "MXN", "MDL", "MNT", "MZN", "MMK", "NAD", "NPR", "NIO", "NGN", "KPW", "OMR", "PKR", "ILS", "PAB", "PGK", "PYG", "PEN", "PHP", "PLN", "QAR", "RON", "RUB", "RWF", "SHP", "XCD", "WST", "STD", "SAR", "RSD", "SCR", "SLL", "SGD", "ANG", "SBD", "SOS", "ZAR", "KRW", "SSP", "EUR", "LKR", "SDG", "SRD", "NOK", "SZL", "SEK", "CHF", "SYP", "TWD", "TJS", "TZS", "THB", "XOF", "NZD", "TOP", "TTD", "TND", "TRY", "TMT", "AUD", "UGX", "UAH", "AED", "GBP", "USD", "UYU", "UZS", "VUV", "VEF", "VND", "XPF", "MAD", "YER", "ZMW", "BWP", "CNH" Example: "SGD" | No | | deletedAttachmentIds | [ long ] | Deleted attachment id | No | | expenseGroup | string | expensegroup | No | | invoiceNo | string | Invoice number. _Example: "INV001" | No | | merchant | string | Merchant name. Example: "Uber" | No | | otherDetails | string | Other details. Example: "Utilities bill" | No | | purpose | string | Expense purpose. Example: "official meeting" | No | | spendDate | dateTime | Spend date. Example: "2019-09-27" | No | | status | string | Expense status. Enum: "DRAFT", "PENDING", "APPROVED", "REJECTED" Example: "PENDING" | No | | taxAmount | number | Tax amount. Example: 0.7 | No | | taxCode | string | Tax code. Example: "TX0001" | No | | totalAmount | number | Total amount. Example: 10.5 | No | | valid | boolean | | No |

ExpenseIdsDto​

NameTypeDescriptionRequired
ids[ long ]Expense ids.No

ExpenseMembersResponse​

NameTypeDescriptionRequired
firstNamestringUser First Name
Example: "John"Yes
groupExtAppGroupDtoGroup
Example: "Default"No
idlongPrimary Key
Example: 1No
lastNamestringUser Last Name
Example: "Doe"Yes
rolestringRole
Example: "Employee"No
userNamestringUsername
Example: "d.6511223344"No

ExpenseResponse​

NameTypeDescriptionRequired
approvalDatestringExpense approval date.
Example: "2019-10-27"No
approvedBylongExpense approved id.
Example: 4567No
approved_dtdateTimeExpense approval date.
Example: "2019-10-27"No
approverNamestringExpense approver Name.
Example: "admin 1"No
attachmentIds[ integer ]Attachments idsNo
attachments[ string ]Attachments url'sNo
categorystringCategory name.
Example: "Food"No
categoryIdlongExpense category.
Example: 1No
currencystringCurrency code.

Enum: "AFN", "ALL", "DZD", "AOA", "ARS", "AMD", "AWG", "AZN", "BSD", "BHD", "BDT", "BBD", "BYN", "BZD", "BMD", "BTN", "BOB", "BAM", "BRL", "BND", "BGN", "BIF", "KHR", "CAD", "CVE", "KYD", "CLP", "CNY", "COP", "KMF", "CDF", "CRC", "CZK", "HRK", "CUC", "DJF", "DOP", "EGP", "ERN", "ETB", "FKP", "FJD", "XAF", "GMD", "GEL", "GHS", "GIP", "DKK", "GTQ", "GNF", "GYD", "HTG", "HNL", "HKD", "HUF", "ISK", "INR", "IDR", "IRR", "IQD", "JMD", "JPY", "JOD", "KZT", "KES", "KWD", "KGS", "LAK", "LBP", "LSL", "LRD", "LYD", "MOP", "MKD", "MGA", "MWK", "MYR", "MVR", "MRO", "MUR", "MXN", "MDL", "MNT", "MZN", "MMK", "NAD", "NPR", "NIO", "NGN", "KPW", "OMR", "PKR", "ILS", "PAB", "PGK", "PYG", "PEN", "PHP", "PLN", "QAR", "RON", "RUB", "RWF", "SHP", "XCD", "WST", "STD", "SAR", "RSD", "SCR", "SLL", "SGD", "ANG", "SBD", "SOS", "ZAR", "KRW", "SSP", "EUR", "LKR", "SDG", "SRD", "NOK", "SZL", "SEK", "CHF", "SYP", "TWD", "TJS", "TZS", "THB", "XOF", "NZD", "TOP", "TTD", "TND", "TRY", "TMT", "AUD", "UGX", "UAH", "AED", "GBP", "USD", "UYU", "UZS", "VUV", "VEF", "VND", "XPF", "MAD", "YER", "ZMW", "BWP", "CNH" Example: "SGD" | No | | deletedAttachmentIds | [ long ] | Deleted attachment id | No | | expenseDate | string | Expense spend date. Example: "2019-10-27" | No | | expenseGroup | string | expensegroup | No | | groupCode | string | Expense group code. _Example: "Group Code" | No | | groupName | string | Expense group name. Example: "Claims" | No | | invoiceNo | string | Invoice number. Example: "INV001" | No | | merchant | string | Merchant name. Example: "Uber" | No | | otherDetails | string | Other details. Example: "Utilities bill" | No | | purpose | string | Expense purpose. Example: "official meeting" | No | | receipts | [ string ] | Receipt urls | No | | spendDate | dateTime | Spend date. Example: "2019-09-27" | No | | status | string | Expense status. Enum: "DRAFT", "PENDING", "APPROVED", "REJECTED" Example: "PENDING" | No | | taxAmount | number | Tax amount. Example: 0.7 | No | | taxCode | string | Tax code. Example: "TX0001" | No | | totalAmount | number | Total amount. Example: 10.5 | No | | userId | long | User id. Example: 1234 | No | | userName | string | Expense created by. Example: "user 1" | No | | valid | boolean | | No |

ExpenseResponseWithCount​

NameTypeDescriptionRequired
countlongNo
statusstringNo
totalAmountnumberNo

ExpenseTrendReportDto​

NameTypeDescriptionRequired
data[ TenureData ]No
maxClaimAmountnumberNo
totalClaimAmountnumberNo
totalCountintegerNo

ExtAppGroupDto​

NameTypeDescriptionRequired
codestringCode Generated by Procedure
Example: "E-0000001"No
idlongPrimary Key
Example: 1No
memberCountlongMember Count
Example: 10No
namestringGroup Name
Example: "default"No
tenantIdlongTenant Id
Example: 1No

ExtAppGroupRequest​

NameTypeDescriptionRequired
namestringGroup Name
Example: "default"No

File​

NameTypeDescriptionRequired
absolutebooleanNo
absoluteFileFileNo
absolutePathstringNo
canonicalFileFileNo
canonicalPathstringNo
directorybooleanNo
filebooleanNo
freeSpacelongNo
hiddenbooleanNo
namestringNo
parentstringNo
parentFileFileNo
pathstringNo
totalSpacelongNo
usableSpacelongNo

GroupMembersResponse​

NameTypeDescriptionRequired
rolestringNo
userIdlongNo

GroupRoles​

NameTypeDescriptionRequired
groupIdlongGroup Id.No
groupNamestringGroup Name.No
roles[ string ]Roles.No

InputStream​

NameTypeDescriptionRequired
InputStreamobject

IntegrationMappingResponse​

NameTypeDescriptionRequired
activebooleanstatus.
Example: trueNo
countryCodestringCountry code.
Example: "US"No
idlongIntegration mapping id.No
mappingMappingResponseCategory mappingNo
tenantIdlongTenant id.
Example: 1234No

MappingResponse​

NameTypeDescriptionRequired
category[ CategotyAccountDto ]Category.No
expenseAccountstringExpense Account.
Example: "ACC70003"No
liabilityAccountstringLiability Account.
Example: "ACC70003"No

MoveUserGroupRoleDto​

NameTypeDescriptionRequired
newGroupIdlongNew Group id
Example: 1No
newRolestringNew Role Name
Example: "manager"No
oldGroupIdlongOld Group id
Example: 1No
oldRolestringOld Role Name
Example: "manager"No
userIdlongUser id to be deleted
Example: 1No

MultiExpensesDto​

NameTypeDescriptionRequired
expneseGroupNamestringGroup name.
Example: "Other"No
expneses[ ExpenseDto ]Multiple expense.No

Pageable​

NameTypeDescriptionRequired
offsetlongNo
pageNumberintegerNo
pageSizeintegerNo
pagedbooleanNo
sortSortNo
unpagedbooleanNo

Page«ExpenseMembersResponse»​

NameTypeDescriptionRequired
content[ ExpenseMembersResponse ]No
emptybooleanNo
firstbooleanNo
lastbooleanNo
numberintegerNo
numberOfElementsintegerNo
pageablePageableNo
sizeintegerNo
sortSortNo
totalElementslongNo
totalPagesintegerNo

Page«ExpenseResponse»​

NameTypeDescriptionRequired
content[ ExpenseResponse ]No
emptybooleanNo
firstbooleanNo
lastbooleanNo
numberintegerNo
numberOfElementsintegerNo
pageablePageableNo
sizeintegerNo
sortSortNo
totalElementslongNo
totalPagesintegerNo

Page«ExtAppGroupDto»​

NameTypeDescriptionRequired
content[ ExtAppGroupDto ]No
emptybooleanNo
firstbooleanNo
lastbooleanNo
numberintegerNo
numberOfElementsintegerNo
pageablePageableNo
sizeintegerNo
sortSortNo
totalElementslongNo
totalPagesintegerNo

Resource​

NameTypeDescriptionRequired
descriptionstringNo
fileFileNo
filenamestringNo
inputStreamInputStreamNo
openbooleanNo
readablebooleanNo
uriURINo
urlURLNo

ResponseEntity​

NameTypeDescriptionRequired
bodyobjectNo
statusCodestringEnum: "100 CONTINUE", "101 SWITCHING_PROTOCOLS", "102 PROCESSING", "103 CHECKPOINT", "200 OK", "201 CREATED", "202 ACCEPTED", "203 NON_AUTHORITATIVE_INFORMATION", "204 NO_CONTENT", "205 RESET_CONTENT", "206 PARTIAL_CONTENT", "207 MULTI_STATUS", "208 ALREADY_REPORTED", "226 IM_USED", "300 MULTIPLE_CHOICES", "301 MOVED_PERMANENTLY", "302 FOUND", "302 MOVED_TEMPORARILY", "303 SEE_OTHER", "304 NOT_MODIFIED", "305 USE_PROXY", "307 TEMPORARY_REDIRECT", "308 PERMANENT_REDIRECT", "400 BAD_REQUEST", "401 UNAUTHORIZED", "402 PAYMENT_REQUIRED", "403 FORBIDDEN", "404 NOT_FOUND", "405 METHOD_NOT_ALLOWED", "406 NOT_ACCEPTABLE", "407 PROXY_AUTHENTICATION_REQUIRED", "408 REQUEST_TIMEOUT", "409 CONFLICT", "410 GONE", "411 LENGTH_REQUIRED", "412 PRECONDITION_FAILED", "413 PAYLOAD_TOO_LARGE", "413 REQUEST_ENTITY_TOO_LARGE", "414 URI_TOO_LONG", "414 REQUEST_URI_TOO_LONG", "415 UNSUPPORTED_MEDIA_TYPE", "416 REQUESTED_RANGE_NOT_SATISFIABLE", "417 EXPECTATION_FAILED", "418 I_AM_A_TEAPOT", "419 INSUFFICIENT_SPACE_ON_RESOURCE", "420 METHOD_FAILURE", "421 DESTINATION_LOCKED", "422 UNPROCESSABLE_ENTITY", "423 LOCKED", "424 FAILED_DEPENDENCY", "426 UPGRADE_REQUIRED", "428 PRECONDITION_REQUIRED", "429 TOO_MANY_REQUESTS", "431 REQUEST_HEADER_FIELDS_TOO_LARGE", "451 UNAVAILABLE_FOR_LEGAL_REASONS", "500 INTERNAL_SERVER_ERROR", "501 NOT_IMPLEMENTED", "502 BAD_GATEWAY", "503 SERVICE_UNAVAILABLE", "504 GATEWAY_TIMEOUT", "505 HTTP_VERSION_NOT_SUPPORTED", "506 VARIANT_ALSO_NEGOTIATES", "507 INSUFFICIENT_STORAGE", "508 LOOP_DETECTED", "509 BANDWIDTH_LIMIT_EXCEEDED", "510 NOT_EXTENDED", "511 NETWORK_AUTHENTICATION_REQUIRED"No
statusCodeValueintegerNo

Role​

NameTypeDescriptionRequired
idlongNo
rolestringNo

ScannerDto​

NameTypeDescriptionRequired
content[ string ]Document content.No
documentNamestringDocument name.
Example: "expense.png"No
documentTypestringDocument type.

Enum: "EXPENSE", "CONTACT" Example: "EXPENSE" | No |

ShortRoleInfo​

NameTypeDescriptionRequired
appNamestringApplication Name

Enum: "CONSOLE", "ERP", "ORGANISATION", "ATTENDANCE", "EXPENSE", "CRM", "PEOPLE", "CHAT", "ALL", "REPORT_BUILDER", "SHOP", "WORKFLOW_ENGINE", "CRM_PLUS" Example: "ERP" | No | | roleGroupName | string | Role Group Example: "admin" | No | | shortCode | string | Role Group Example: "admin" | No |

Sort​

NameTypeDescriptionRequired
emptybooleanNo
sortedbooleanNo
unsortedbooleanNo

TenureData​

NameTypeDescriptionRequired
amountnumberNo
axisValuestringNo
countintegerNo
dayintegerNo
monthstringEnum: "JANUARY", "FEBRUARY", "MARCH", "APRIL", "MAY", "JUNE", "JULY", "AUGUST", "SEPTEMBER", "OCTOBER", "NOVEMBER", "DECEMBER"No
namestringNo
yearYearNo

Text​

NameTypeDescriptionRequired
confidenceScorefloatNo
hightfloatNo
orderintegerNo
sizefloatNo
textstringNo
widthfloatNo

TextExtractDto​

NameTypeDescriptionRequired
entityVoList[ EntityVo ]No
fileNamestringNo
tenantIdlongNo
textList[ Text ]No
userIdlongNo
wssessionIdstringNo

URI​

NameTypeDescriptionRequired
absolutebooleanNo
authoritystringNo
fragmentstringNo
hoststringNo
opaquebooleanNo
pathstringNo
portintegerNo
querystringNo
rawAuthoritystringNo
rawFragmentstringNo
rawPathstringNo
rawQuerystringNo
rawSchemeSpecificPartstringNo
rawUserInfostringNo
schemestringNo
schemeSpecificPartstringNo
userInfostringNo

URL​

NameTypeDescriptionRequired
authoritystringNo
contentobjectNo
defaultPortintegerNo
filestringNo
hoststringNo
pathstringNo
portintegerNo
protocolstringNo
querystringNo
refstringNo
userInfostringNo

UserDto​

NameTypeDescriptionRequired
emailIdstringNo
erpTenantIdlongNo
iamUserIdlongNo
isTerminatedbooleanNo
roles[ UserRoleDto ]No
tenantIdstringNo
terminationStagestringNo
userIdstringNo

UserGroupRoleDto​

NameTypeDescriptionRequired
groupIdlongGroup id
Example: 1No
httpStatusstringResponse HTTP Status

Enum: "100 CONTINUE", "101 SWITCHING_PROTOCOLS", "102 PROCESSING", "103 CHECKPOINT", "200 OK", "201 CREATED", "202 ACCEPTED", "203 NON_AUTHORITATIVE_INFORMATION", "204 NO_CONTENT", "205 RESET_CONTENT", "206 PARTIAL_CONTENT", "207 MULTI_STATUS", "208 ALREADY_REPORTED", "226 IM_USED", "300 MULTIPLE_CHOICES", "301 MOVED_PERMANENTLY", "302 FOUND", "302 MOVED_TEMPORARILY", "303 SEE_OTHER", "304 NOT_MODIFIED", "305 USE_PROXY", "307 TEMPORARY_REDIRECT", "308 PERMANENT_REDIRECT", "400 BAD_REQUEST", "401 UNAUTHORIZED", "402 PAYMENT_REQUIRED", "403 FORBIDDEN", "404 NOT_FOUND", "405 METHOD_NOT_ALLOWED", "406 NOT_ACCEPTABLE", "407 PROXY_AUTHENTICATION_REQUIRED", "408 REQUEST_TIMEOUT", "409 CONFLICT", "410 GONE", "411 LENGTH_REQUIRED", "412 PRECONDITION_FAILED", "413 PAYLOAD_TOO_LARGE", "413 REQUEST_ENTITY_TOO_LARGE", "414 URI_TOO_LONG", "414 REQUEST_URI_TOO_LONG", "415 UNSUPPORTED_MEDIA_TYPE", "416 REQUESTED_RANGE_NOT_SATISFIABLE", "417 EXPECTATION_FAILED", "418 I_AM_A_TEAPOT", "419 INSUFFICIENT_SPACE_ON_RESOURCE", "420 METHOD_FAILURE", "421 DESTINATION_LOCKED", "422 UNPROCESSABLE_ENTITY", "423 LOCKED", "424 FAILED_DEPENDENCY", "426 UPGRADE_REQUIRED", "428 PRECONDITION_REQUIRED", "429 TOO_MANY_REQUESTS", "431 REQUEST_HEADER_FIELDS_TOO_LARGE", "451 UNAVAILABLE_FOR_LEGAL_REASONS", "500 INTERNAL_SERVER_ERROR", "501 NOT_IMPLEMENTED", "502 BAD_GATEWAY", "503 SERVICE_UNAVAILABLE", "504 GATEWAY_TIMEOUT", "505 HTTP_VERSION_NOT_SUPPORTED", "506 VARIANT_ALSO_NEGOTIATES", "507 INSUFFICIENT_STORAGE", "508 LOOP_DETECTED", "509 BANDWIDTH_LIMIT_EXCEEDED", "510 NOT_EXTENDED", "511 NETWORK_AUTHENTICATION_REQUIRED" Example: "200 OK" | No | | message | string | Response error message, if any Example: "User does not exist" | No | | role | string | Role Name Example: "manager" | No | | userId | long | User id to be deleted Example: 1 | No |

UserGroupRolesResponseDto​

NameTypeDescriptionRequired
groupRolesList[ GroupRoles ]Group Roles List.No
tenantIdlongTenant id.No
userIdlongUser id.No

UserRoleDto​

NameTypeDescriptionRequired
appNamestringNo
namestringNo
roleIdstringNo

UserShortInfoWithRole​

NameTypeDescriptionRequired
address[ Address ]List of Address.No
authUserIdstringAuth0 User ID
Example: `"auth05d70ec986e382a0d12a4ff22"`No
contactstringUser Contact
Example: 12345678No
deletedbooleanDelete Flag
Example: falseNo
departmentstringUser Department
Example: "Finance"No
designationstringUser Designation
Example: "Accountant"No
emailstringUser email
Example: "jsmith@example.com"No
firstNamestringUser First Name
Example: "John"No
genderLookUpCodestringGender
Example: "Mr."No
iamUserIdlongIam User Id
Example: 1No
idlongPrimary Key
Example: 1No
isEmailVerifiedbooleanEmail is verified or not.No
lastNamestringUser Last Name
Example: "Doe"No
mfaenabledbooleanNo
profileUrlstringUser profile image path.
Example: "http://deskera.com/user/myprofile.png"No
roleShortInfo[ ShortRoleInfo ]No
statusstringStatus like Active/ InActive
Example: "active"No
tenantIdlongTenant Id
Example: 1No
userNamestringUser Name
Example: "jsmith@example.com"No

Year​

NameTypeDescriptionRequired
leapbooleanNo
valueintegerNo