Expensya
Expensya is a leading Spend Management solution in Europe, and this connector allows to build on top of our technology, automate integration to third party systems, and extend existing features.
This connector is available in the following products and regions:
Service | Class | Regions |
---|---|---|
Logic Apps | Standard | All Logic Apps regions except the following: - Azure Government regions - Azure China regions - US Department of Defense (DoD) |
Power Automate | Premium | All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
Power Apps | Premium | All Power Apps regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
Contact | |
---|---|
Name | Expensya |
URL | https://www.expensya.com |
[email protected] |
Connector Metadata | |
---|---|
Publisher | EXPENSYA SA |
Website | https://www.expensya.com |
Privacy policy | https://www.expensya.com/en/tou |
Categories | AI;Website |
Expensya Connector contains a group of actions that use the information to perform some simple operations for Power Automate and Expensya.
Pre-requisites
- Sign-up for an Expensya account
- Sign-in to manage an existing Expensya account
- Create to generate an API key
How to get credentials?
- [User-token] (https://help.expensya.com/l/en/article/rzm63doi7u-how-to-use-expensya-s-public-apis) tutorial to generate a user token
Supported Operations
The full list of supported actions can be found here
Creating a connection
The connector supports the following authentication types:
Default | Parameters for creating connection. | All regions | Not shareable |
Default
Applicable: All regions
Parameters for creating connection.
This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.
Name | Type | Description | Required |
---|---|---|---|
API Key | securestring | Get an API Key from Expensya | True |
Throttling Limits
Name | Calls | Renewal Period |
---|---|---|
API calls per connection | 100 | 60 seconds |
Actions
Add Projects |
Add new projects to Expensya. |
Add Quick |
Add a new expense to your expensya account. |
Add Reciept |
Add a new expense to your expensya account with a receipt. |
Export Expense |
Export expenses on specified export format based on given filters. |
Export Report |
Export report as pdf. |
Get Categories |
Get the list of categories with paging. |
Get Expense Image |
This API returns the image of the expense as Stream. The image can be jpg, jpeg, png or pdf. The type of the image is mentioned in the expense object property "FileType". |
Get Expenses |
Get the list of expenses with paging. |
Get Export Formats |
List of export formats. |
Get Project Details |
Get the details of the project. |
Get Projects |
Get the list of projects. |
Get Report History |
Get the history of the report. |
Get Reports |
Get the list of reports with paging. |
Get Users |
Get the list of users with paging. |
Get Validator Reports |
Get the list of validator's reports with paging. |
Invite User |
Add user to Expensya. |
Refresh Token |
Refresh your userToken. |
Revoke Token |
Revoke your user token. |
Update Projects |
Update projects already added to Expensya |
Update Projects State |
Batch update list of projects state. |
Update Report Status |
Update the statuts of the report. |
Update User |
Update user already added in Expensya. |
Update Users Status |
Update expensya users status. |
Add Projects
Add new projects to Expensya.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
HasBillable
|
HasBillable | True | boolean |
Specifies if expenses assigned to this project can be billable to client or not. |
StartDate
|
StartDate | date-time | ||
EndDate
|
EndDate | date-time | ||
IsActive
|
IsActive | True | boolean |
If the project is active or not. |
MileageConfigurations
|
MileageConfigurations | string |
Mileage Configurations of the project. |
|
Address
|
Address | string |
Address of the project. |
|
ZipCode
|
ZipCode | string |
Zip code of the project. |
|
City
|
City | string |
City of the project. |
|
ExternalId
|
ExternalId | True | string |
External identifier of the project. |
Name
|
Name | True | string |
Name of the project. |
ProjectRef
|
ProjectRef | True | string |
Reference of the project. |
Validator_Id
|
Validator_Id | guid |
Unique identifier of the project validator. |
|
Reviewer_Id
|
Reviewer_Id | guid |
Unique identifier of the project reviewer. |
|
ClientName
|
ClientName | string |
Name of the client. |
|
ForAllCompany
|
ForAllCompany | True | boolean |
If the project is for all company or not. |
IsBillableDefaultValue
|
IsBillableDefaultValue | boolean |
Expenses assigned to the project are billable by default. |
|
PayId2
|
PayId2 | string |
First analytical axis. |
|
Currency
|
Currency | string |
Currency of the project. |
|
ExtraData
|
ExtraData | string |
Extrat data for the project. |
|
ProjectUseType
|
ProjectUseType | enum |
Enum flag attribute which is the use type of the project:
|
|
Description
|
Description | string |
Description about the project. |
|
CategoriesIds
|
CategoriesIds | string |
Unique identifiers of the categories.If it's empty, the project will be applicable to all categories. |
|
TagsToAssign
|
TagsToAssign | array of string |
List of tags' names that will be assigned to the project. |
|
TagsToUnassign
|
TagsToUnassign | array of string |
List of tags' names that will be unassigned from the project. |
Returns
Add QuickExpense
Add a new expense to your expensya account.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Format - guid. Unique identifier of the user that expense will be linked to.
|
userId | True | string |
Format - guid. Unique identifier of the user that expense will be linked to. |
FileToSend
|
FileToSend | True | string |
The file to Send on bease64. |
Title
|
Title | string |
Title of the expense. |
|
TransactionAmount
|
TransactionAmount | decimal |
Transaction amount of the expense. |
|
VatRates
|
VatRates | string |
Vate rates of the expense. |
|
VatAmounts
|
VatAmounts | string |
Vate amounts of the expense. |
|
CurrencyCode
|
CurrencyCode | string |
Currency code of the expense. |
|
TransactionDate
|
TransactionDate | date-time | ||
MerchantName
|
MerchantName | string |
Merchant name of the expense. |
|
LocationCountry
|
LocationCountry | string |
Location country of the expense. |
|
LocationCity
|
LocationCity | string |
Location city of the expense. |
|
Comment
|
Comment | string |
Comment of the expense. |
|
MerchantExpenseId
|
MerchantExpenseId | string |
Unique expense identifier of the merchant. |
|
IsEncrypted
|
IsEncrypted | boolean |
If the expense is encrypted ot not. |
|
ExpenseUseType
|
ExpenseUseType | enum |
Enum flag attribute which is the use type of the expense:
|
|
PaymentTypeCode
|
PaymentTypeCode | string |
Payment type code of the expense. |
|
ExpenseTypeCode
|
ExpenseTypeCode | string |
Type code of the expense. |
|
FileType
|
FileType | string |
File type of the expense. |
Returns
- Body
- BaseResult
Add Reciept
Add a new expense to your expensya account with a receipt.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
UserId
|
UserId | True | string |
Unique identifier of the user. |
ReceiptContent
|
ReceiptContent | True | string |
Content of the receipt on base 64. |
ReceiptName
|
ReceiptName | True | string |
Name of the receipt. |
Returns
- Body
- BaseResult
Export Expense
Export expenses on specified export format based on given filters.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Format - guid. Unique identifier of the export.
|
exportId | True | string |
Format - guid. Unique identifier of the export. |
Filter with the unique identifier of the report related to the expenses.
|
reportId | string |
Filter with the unique identifier of the report related to the expenses. |
|
Filter with the unique identifier of the category related to the expenses.
|
categoryId | string |
Filter with the unique identifier of the category related to the expenses. |
|
Filter with the name of the expense.
|
expenseName | string |
Filter with the name of the expense. |
|
Filter with the start date based on dateFilterType (as date-time in RFC3339).
|
startDate | string |
Filter with the start date based on dateFilterType (as date-time in RFC3339). |
|
Filter with the end date based on dateFilterType (as date-time in RFC3339).
|
endDate | string |
Filter with the end date based on dateFilterType (as date-time in RFC3339). |
|
List of expenses state seperated by ','
|
expenseStates | string |
List of expenses state seperated by ',' : Validated = 3 ValidatedByAccountant = 4 Rejected = 99. |
|
List of reports state related to the expenses seperated by ','
|
reportStates | string |
List of reports state related to the expenses seperated by ',' : Active = 0 Submitted = 2 Rejected = 3 Validated = 4 Closed = 5 ValidatedAndExported = 6 |
|
List of unique identifiers of the expenses' owners seperated by ','.
|
userIds | string |
List of unique identifiers of the expenses' owners seperated by ','. |
|
List of e-mails of the expenses' owners seperated by ','.
|
userMail | string |
List of e-mails of the expenses' owners seperated by ','. |
|
List of unique identifiers of the reports related tp expenses by ','.
|
reportIds | string |
List of unique identifiers of the reports related tp expenses by ','. |
|
List of unique identifiers of the expense seperated by ','.
|
expenseIds | string |
List of unique identifiers of the expense seperated by ','. |
|
Filter with the report name related to the expenses.
|
reportName | string |
Filter with the report name related to the expenses. |
|
Filter with the internal identifier of the expenses' report.
|
reportIdShort | string |
Filter with the internal identifier of the expenses' report. |
|
Format - enum. Indicates the target of date filters.
|
dateFilterType | integer |
Format - enum. Indicates the target of date filters: InvoiceDate = 1 ValidationDate = 2 AccountingValidationDate = 3 SubmissionDate = 4 CreationDate = 6. |
|
Filter with the serial of the expense's owner.
|
payId | string |
Filter with the serial of the expense's owner. |
|
Filter with the first analytical axis of the owner of the expense.
|
payId2 | string |
Filter with the first analytical axis of the owner of the expense. |
|
Filter with the second analytical axis of the owner of the expense.
|
payId3 | string |
Filter with the second analytical axis of the owner of the expense. |
|
Filter with the accounting period of the expenses.
|
accountingPeriod | string |
Filter with the accounting period of the expenses. |
|
Indicates if the expenses receipts should be added to the export.
|
includeReceipts | boolean |
Indicates if the expenses receipts should be added to the export. |
|
List of expense use type seperated by ','
|
expenseUseTypes | integer |
List of expense use type seperated by ',' : Invoice = 1 Advance = 2 Purchase = 4 Subscription = 8 MissionOrder = 16. |
|
Indicates if the reports related to the expenses will be archived.
|
archiveExpenses | string |
Indicates if the reports related to the expenses will be archived, applied only for expenses related to validated or validatedAndExported reports. |
Returns
Export Report
Export report as pdf.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Format - guid. Unique identifier of the report.
|
reportId | True | string |
Format - guid. Unique identifier of the report. |
Returns
Get Categories
Get the list of categories with paging.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Filter with the unique identifier of the category.
|
id | string |
Filter with the unique identifier of the category. |
|
Filter with the category name.
|
categoryName | string |
Filter with the category name. |
|
Filter with the unique identifier of the category.
|
costAccount | string |
Filter with the unique identifier of the category. |
|
Filter with the unique identifier of the category.
|
vatAccount | string |
Filter with the unique identifier of the category. |
|
Bring only active categories.
|
isActive | boolean |
Bring only active categories. |
|
List of tags' names seperated by ','.
|
tagsNames | string |
List of tags' names seperated by ','. |
|
The page number.
|
page | integer |
The page number. |
|
The number of elements per page.
|
pageSize | integer |
The number of elements per page. |
|
Format - enum. List can be sorted by.
|
sortBy | integer |
Format - enum. List can be sorted by : Name_FR = 5, Name_EN = 10, CostAccount = 15, IsActive = 20, VatAccount = 25 |
|
Order the list by desc or asc.
|
isDesc | boolean |
Order the list by desc or asc. |
Returns
Get Expense Image
This API returns the image of the expense as Stream. The image can be jpg, jpeg, png or pdf. The type of the image is mentioned in the expense object property "FileType".
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Format - guid. Unique identifier of the expense.
|
expenseId | True | string |
Format - guid. Unique identifier of the expense. |
Returns
Get Expenses
Get the list of expenses with paging.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Filter with the unique report identifier related to the expense.
|
reportId | string |
Filter with the unique report identifier related to the expense. |
|
Filter with the unique category identifier related to the expense.
|
categoryId | string |
Filter with the unique category identifier related to the expense. |
|
Filter with the name of the expense.
|
expenseName | string |
Filter with the name of the expense. |
|
Filter with the start date based on dateFilterType (as date-time in RFC3339).
|
startDate | string |
Filter with the start date based on dateFilterType. Format - date-time (as date-time in RFC3339). |
|
Filter with the end date based on dateFilterType (as date-time in RFC3339).
|
endDate | string |
Filter with the end date based on dateFilterType. Format - date-time (as date-time in RFC3339). |
|
Format - enum. State of the expense's report.
|
reportState | integer |
Format - enum. State of the expense's report. |
|
List Of expenseStates seperated by ','
|
expenseStates | string |
List Of expenseStates seperated by ',' : Uploading = 0 Uploaded = 1 Ready = 2 Validated = 3 ValidatedByAccountant = 4 Rejected = 99. |
|
Shows if the expense is to reimburse.
|
isReimbusable | boolean |
Shows if the expense is to reimburse. |
|
Filter with the value in currency of the owner of the expense.
|
valueInCurrency | number |
Filter with the value in currency of the owner of the expense. |
|
Filter with the unique owner identifier of the expense.
|
ownerId | string |
Filter with the unique owner identifier of the expense. |
|
Filter with the mail of the expense.
|
ownerMail | string |
Filter with the mail of the expense. |
|
Filter with the serial of the expense's owner.
|
ownerPayId | string |
Filter with the serial of the expense's owner. |
|
Filter with the first analytical axis of the owner of the expense.
|
ownerPayId2 | string |
Filter with the first analytical axis of the owner of the expense. |
|
Filter with the second analytical axis of the owner of the expense.
|
ownerPayId3 | string |
Filter with the second analytical axis of the owner of the expense. |
|
Filter with the third analytical axis of the owner of the expense.
|
ownerPayId4 | string |
Filter with the third analytical axis of the owner of the expense. |
|
Filter with the fourth analytical axis of the owner of the expense.
|
ownerPayId5 | string |
Filter with the fourth analytical axis of the owner of the expense. |
|
Filter with fifth analytical axis of the owner of the expense.
|
ownerPayId6 | string |
Filter with the fifth analytical axis of the owner of the expense. |
|
Filter with the unique project identifier related to the expense.
|
projectId | string |
Filter with the unique project identifier related to the expense. |
|
Shows if the expense is billable to client.
|
isBillable | boolean |
Shows if the expense is billable to client. |
|
Format - enum. Indicates the target of date filters.
|
dateFilterType | integer |
Format - enum. Indicates the target of date filters: InvoiceDate = 1 ValidationDate = 2 AccountingValidationDate = 3 SubmissionDate = 4 CreationDate = 6. |
|
List of merchant countries related to the expense seperated by ',' ex: 'FR,ES'
|
merchantCountries | string |
List of merchant countries related to the expense seperated by ',' ex: 'FR,ES' |
|
List of currencies related to the expense seperated by ',' ex: 'EUR,USD'
|
currencies | string |
List of currencies related to the expense seperated by ',' ex: 'EUR,USD' |
|
Filter with the file type of the expense : pdf, jpg ...
|
fileType | string |
Filter with the file type of the expense : pdf, jpg ... |
|
Filter with the internal identifier of the expenses' report.
|
reportIdShort | string |
Filter with the internal identifier of the expenses' report. |
|
List of expense use types seperated by ','.
|
expenseUseTypes | string |
List of expense use types seperated by ',' : Invoice = 1 Advance = 2 Purchase = 4 Subscription = 8 MissionOrder = 16. |
|
Filter with the unique supplier identifier of the expense.
|
supplierId | string |
Filter with the unique supplier identifier of the expense. |
|
List of unique identifiers of the expense seperated by ','.
|
expenseIds | string |
List of unique identifiers of the expense seperated by ','. |
|
Filter with the merchant name of the expense.
|
merchantName | string |
Filter with the merchant name of the expense. |
|
Filter with the merchant VAT number of the expense.
|
vatCode | string |
Filter with the merchant VAT number of the expense. |
|
Filter with excluding tax amount of the expense.
|
valueHTInExpenseCurrency | number |
Filter with excluding tax amount of the expense. |
|
Filter with VAT rate of the expense.
|
vatRate | number |
Filter with VAT rate of the expense. |
|
Filter with VAT value of the expense.
|
vatValue | number |
Filter with VAT value of the expense. |
|
List of unique reports' identifiers related to the expense seperated by ','.
|
reportsIds | string |
List of unique reports' identifiers related to the expense seperated by ','. |
|
Filter with the UTC offset of the expense.
|
dateTimeOffset | integer |
Filter with the UTC offset of the expense. |
|
List of tags' names seperated by ','.
|
tagsNames | string |
List of tags' names seperated by ','. |
|
The page number.
|
page | integer |
The page number. |
|
The number of elements per page.
|
pageSize | integer |
The number of elements per page. |
|
Format - enum. List can be sorted by.
|
sortBy | integer |
Format - enum. List can be sorted by : DateCreation = 11 DateInvoice = 12 Name = 20 Value = 30 ValueInCurrency = 31 HasPhoto = 40 State = 60 Category = 70. |
|
Order the list by desc or asc.
|
isDesc | boolean |
Order the list by desc or asc. |
Returns
Get Export Formats
List of export formats.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Bring only expenses export formats.
|
isForExpenses | boolean |
Bring only expenses export formats, if false brings report export formats. |
|
Format - enum. Indicates the type of export.
|
exportType | integer |
Format - enum. Indicates the type of export: InvoiceAndPurchase = 1 Advance = 2 Balance = 4. |
Returns
Get Project Details
Get the details of the project.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Format - guid. Unique identifier of the project.
|
projectId | True | string |
Format - guid. Unique identifier of the project. |
Returns
Get Projects
Get the list of projects.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Filter with the name of the project.
|
projectName | string |
Filter with the name of the project. |
|
List of unique projects' identifiers seperated by ','.
|
projectIds | string |
List of unique projects' identifiers seperated by ','. |
|
Filter with the name of the project validator.
|
validatorName | string |
Filter with the name of the project validator. |
|
Filter with the reference or the external id of the project.
|
projectReferenceOrExternalId | string |
Filter with the reference or the external id of the project. |
|
Bring the projects that are not shared with all employees.
|
bringAllProjects | boolean |
Bring the projects that are not shared with all employees. |
|
Format - enum. Project use type flag.
|
projectUseType | integer |
Format - enum. Project use type flag: Invoice = 0x1 Purchase = 0x2 Subscription = 0x4 Advance = 0x8 MissionOrder = 0x10 MileageOnly = 0x20 InvoiceOnly = 0x40 VirtualCard = 0x80. |
|
Bring only active projects.
|
isActive | boolean |
Bring only active projects. |
|
List of tags' names seperated by ','.
|
tagsNames | string |
List of tags' names seperated by ','. |
|
List of unique custom fields' identifiers seperated by ','.
|
customFieldsIds | string |
List of unique custom fields' identifiers seperated by ','. |
|
The date of the expense. Format - date-time (as date-time in RFC3339).
|
expenseDate | string |
The date of the expense. Format - date-time (as date-time in RFC3339). |
|
Filter with the unique identifier of expense's owner.
|
userId | string |
Filter with the unique identifier of expense's owner. |
|
The page number.
|
page | integer |
The page number. |
|
The number of elements per page.
|
pageSize | integer |
The number of elements per page. |
|
Format - enum. Sort the list by.
|
sortBy | integer |
Format - enum. Sort the list by : StartDate = 11 EndDate = 12 Name = 20 ProjectRef = 21 FullName = 22 Validator = 23 ClientName = 24 Value = 25. |
|
Order the list by desc or asc.
|
isDesc | boolean |
Order the list by desc or asc. |
Returns
Get Report History
Get the history of the report.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Filter with the unique Identifier of the report.
|
reportId | True | string |
Filter with the unique Identifier of the report. |
Returns
Get Reports
Get the list of reports with paging.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Filter with the name of the report.
|
reportName | string |
Filter with the name of the report. |
|
Filter with the start date based on dateFilterType (as date-time in RFC3339).
|
reportStartDate | string |
Filter with the start date based on dateFilterType. Format - date-time (as date-time in RFC3339). |
|
Filter with the end date based on dateFilterType (as date-time in RFC3339).
|
reportEndDate | string |
Filter with the end date based on dateFilterType. Format - date-time (as date-time in RFC3339). |
|
List of report states seperated by ','.
|
reportStates | string |
List of report states seperated by ',' : Active = 0 Submitted = 2 Rejected = 3 Closed = 5 ValidatedAndExported = 6 Reimbursed = 7 PreSubmitted = 8 InValidation = 50. |
|
Filter with the report inetrnal identifier.
|
reportIdShort | string |
Filter with the report inetrnal identifier. |
|
Filter with the unique identifier of the report's owner.
|
ownerId | string |
Filter with the unique identifier of the report's owner. |
|
Filter with the serial of the report's owner.
|
ownerPayId2 | string |
Filter with the serial of the report's owner. |
|
Filter with the unique identifier of the project that the report is linked to.
|
projectId | string |
Filter with the unique identifier of the project that the report is linked to. |
|
List of tags' names seperated by ','.
|
tagsNames | string |
List of tags' names seperated by ','. |
|
Format - enum. Indicates the target of date filters.
|
dateFilterType | integer |
Format - enum. Indicates the target of date filters: InvoiceDate = 1 ValidationDate = 2 AccountingValidationDate = 3 SubmissionDate = 4 PurchaseAccountingValidationDate = 5 CreationDate = 6 |
|
Format - enum. List can be sorted by.
|
sortBy | integer |
Format - enum. List can be sorted by : DateCreation = 11 StartDate = 13 Name = 20 State = 30 Value = 31 InvoicesCount = 32 InvoicesCount = 32 UserFirstName = 40 UserLastName = 41 Budget = 50 ValueToReimburse = 51 ClientCode = 53 IdShort = 54 |
|
The page number.
|
page | integer |
The page number. |
|
The number of elements per page.
|
pageSize | integer |
The number of elements per page. |
|
Order the list by desc or asc.
|
isDesc | boolean |
Order the list by desc or asc. |
Returns
Get Users
Get the list of users with paging.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Filter with the unique identifier of the user.
|
id | string |
Filter with the unique identifier of the user. |
|
Filter with the first name of the user.
|
firstName | string |
Filter with the first name of the user. |
|
Filter with the last name of the user.
|
lastName | string |
Filter with the last name of the user. |
|
Filter with the mail of the user.
|
string |
Filter with the mail of the user. |
||
Filter with the serial the user.
|
payId | string |
Filter with the serial the user. |
|
Filter with the mail or name or serial of the user.
|
mailOrNameOrPayId | string |
Filter with the mail or name or serial of the user. |
|
Format - enum. Enum flag attribute which is the type of the user.
|
type | integer |
Format - enum. Enum flag attribute which is the type of the user : Employee = 1 Administrator = 2 Accountant = 4 |
|
Format - enum. Enum flag attribute which is the user state.
|
state | integer |
Format - enum. Enum flag attribute which is the user state : Validated = 1 Active = 2. |
|
Filter with the unique identifier of the user's first validator.
|
reviewerId | string |
Filter with the unique identifier of the user's first validator. |
|
Filter with the name of the user's reviwer.
|
reviewerName | string |
Filter with the name of the user's reviwer. |
|
Filter with the unique identifier of the user's second validator.
|
managerId | string |
Filter with the unique identifier of the user's second validator. |
|
Filter with the name of the user's manager.
|
managerName | string |
Filter with the name of the user's manager. |
|
List of unique identifiers of the users seperated by ','.
|
userIds | string |
List of unique identifiers of the users seperated by ','. |
|
List of e-mails of the users seperated by ','.
|
userMails | string |
List of e-mails of the users seperated by ','. |
|
List of tags' names seperated by ','.
|
tagsNames | string |
List of tags' names seperated by ','. |
|
List of simple tags' names seperated by ','.
|
simpleTagsNames | string |
List of simple tags' names seperated by ','. |
|
Format - enum. List can be sorted by.
|
sortBy | integer |
Format - enum. List can be sorted by : CreationDate = 11 LastLoginDate = 12 LastName = 20 FirstName = 21 ManagerLastName = 30 ManagerFirstName = 31 UserState = 40 UserType = 41 Mail = 50 Address = 60 PhoneNumber = 61 PayId = 62 LocalCurrency = 63 |
|
The page number.
|
page | integer |
The page number. |
|
The number of elements per page.
|
pageSize | integer |
The number of elements per page. |
|
Order the list by desc or asc.
|
isDesc | boolean |
Order the list by desc or asc. |
Returns
Get Validator Reports
Get the list of validator's reports with paging.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
The e-mail of the report's validator.
|
validatorMail | True | string |
The e-mail of the report's validator. |
Filter with the name of the report.
|
reportName | string |
Filter with the name of the report. |
|
Filter with the start date based on dateFilterType (as date-time in RFC3339).
|
reportStartDate | string |
Filter with the start date based on dateFilterType. Format - date-time (as date-time in RFC3339). |
|
Filter with the end date based on dateFilterType (as date-time in RFC3339).
|
reportEndDate | string |
Filter with the end date based on dateFilterType. Format - date-time (as date-time in RFC3339). |
|
List of report states seperated by ','.
|
reportStates | string |
List of report states seperated by ',' : Active = 0 Submitted = 2 Rejected = 3 Closed = 5 ValidatedAndExported = 6 Reimbursed = 7 PreSubmitted = 8 InValidation = 50. |
|
Filter with the report inetrnal identifier.
|
reportIdShort | string |
Filter with the report inetrnal identifier. |
|
Filter with the unique identifier of the report's owner.
|
ownerId | string |
Filter with the unique identifier of the report's owner. |
|
Filter with the serial of the report's owner.
|
ownerPayId2 | string |
Filter with the serial of the report's owner. |
|
Filter with the unique identifier of the project that the report is linked to.
|
projectId | string |
Filter with the unique identifier of the project that the report is linked to. |
|
Format - enum. Indicates the target of date filters.
|
dateFilterType | integer |
Format - enum. Indicates the target of date filters: InvoiceDate = 1 ValidationDate = 2 AccountingValidationDate = 3 SubmissionDate = 4 PurchaseAccountingValidationDate = 5 CreationDate = 6 |
|
Format - enum. List can be sorted by.
|
sortBy | integer |
Format - enum. List can be sorted by : DateCreation = 11 StartDate = 13 Name = 20 State = 30 Value = 31 InvoicesCount = 32 InvoicesCount = 32 UserFirstName = 40 UserLastName = 41 Budget = 50 ValueToReimburse = 51 ClientCode = 53 IdShort = 54 |
|
The page number.
|
page | integer |
The page number. |
|
The number of elements per page.
|
pageSize | integer |
The number of elements per page. |
|
Order the list by desc or asc.
|
isDesc | boolean |
Order the list by desc or asc. |
Returns
Invite User
Add user to Expensya.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
LastName
|
LastName | True | string |
Last name of the user. |
FirstName
|
FirstName | True | string |
First name of the user. |
Mail
|
True | string |
Mail of the user. |
|
MailAlias
|
MailAlias | string |
Mail alias of the user and it should be different from user mail. |
|
PayId
|
PayId | string |
Serial of the user. |
|
PayId2
|
PayId2 | string |
First analytical axis. |
|
PayId3
|
PayId3 | string |
Second analytical axis. |
|
PayId4
|
PayId4 | string |
Third analytical axis. |
|
PayId5
|
PayId5 | string |
Forth analytical axis. |
|
PayId6
|
PayId6 | string |
Fifth analytical axis. |
|
Language
|
Language | True | string |
Language of the user: FR, US, SE... |
LocalCurrency
|
LocalCurrency | string |
Local currency of the user: EUR, TND, USD... |
|
LocalCountry
|
LocalCountry | string |
Local country of the user. |
|
ManagerId
|
ManagerId | guid |
Unique identifier of the second validator. |
|
ReviewerId
|
ReviewerId | guid |
Unique identifier of the first validator. |
|
UserType
|
UserType | True | enum |
Enum flag attribute which is the type of the user and it is necessary to combine the user type 'Employee' with the other types for example: Employee + Administrator or Employee + Accountant. The user typs are :
|
Vendor
|
Vendor | string |
Name of the vendor |
|
UserRole
|
UserRole | True | enum |
Enum flag attribute which is the role of the user :
|
DefaultProjectId
|
DefaultProjectId | guid |
Unique identifier of the user default project. |
|
IKRatesId
|
IKRatesId | guid |
Unique identifier of the mileage compensation rates. |
|
Mail
|
True | string |
Mail of the validator |
|
MinimumAmount
|
MinimumAmount | decimal |
If the ammount exceed the ammount the expense should be sent to the validator |
|
TagsToAssign
|
TagsToAssign | array of string |
List of tags' names that will be assigned to the user. |
Returns
- Body
- BaseResult
Refresh Token
Revoke Token
Update Projects
Update projects already added to Expensya
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
HasBillable
|
HasBillable | True | boolean |
Specifies if expenses assigned to this project can be billable to client or not. |
StartDate
|
StartDate | date-time | ||
EndDate
|
EndDate | date-time | ||
IsActive
|
IsActive | True | boolean |
If the project is active or not. |
MileageConfigurations
|
MileageConfigurations | string |
Mileage Configurations of the project. |
|
Address
|
Address | string |
Address of the project. |
|
ZipCode
|
ZipCode | string |
Zip code of the project. |
|
City
|
City | string |
City of the project. |
|
ExternalId
|
ExternalId | True | string |
External identifier of the project. |
Name
|
Name | True | string |
Name of the project. |
ProjectRef
|
ProjectRef | True | string |
Reference of the project. |
Validator_Id
|
Validator_Id | guid |
Unique identifier of the project validator. |
|
Reviewer_Id
|
Reviewer_Id | guid |
Unique identifier of the project reviewer. |
|
ClientName
|
ClientName | string |
Name of the client. |
|
ForAllCompany
|
ForAllCompany | True | boolean |
If the project is for all company or not. |
IsBillableDefaultValue
|
IsBillableDefaultValue | boolean |
Expenses assigned to the project are billable by default. |
|
PayId2
|
PayId2 | string |
First analytical axis. |
|
Currency
|
Currency | string |
Currency of the project. |
|
ExtraData
|
ExtraData | string |
Extrat data for the project. |
|
ProjectUseType
|
ProjectUseType | enum |
Enum flag attribute which is the use type of the project:
|
|
Description
|
Description | string |
Description about the project. |
|
CategoriesIds
|
CategoriesIds | string |
Unique identifiers of the categories.If it's empty, the project will be applicable to all categories. |
|
TagsToAssign
|
TagsToAssign | array of string |
List of tags' names that will be assigned to the project. |
|
TagsToUnassign
|
TagsToUnassign | array of string |
List of tags' names that will be unassigned from the project. |
Returns
Update Projects State
Batch update list of projects state.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
ItemIds
|
ItemIds | True | array of guid |
List of projects' unique identifiers to update. |
ProjectState
|
ProjectState | True | boolean |
New state: true for active and false for disable. |
Returns
Update Report Status
Update the statuts of the report.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Format - guid. Unique identifier of the report.
|
reportId | True | string |
Format - guid. Unique identifier of the report. |
Operation
|
Operation | True | enum |
The operation type that will be apply to the report.
|
Message
|
Message | True | string |
The update comment that will be show to the owner's report. |
InvoiceIdsToReject
|
InvoiceIdsToReject | array of guid |
List of the invoice that will be reject. |
|
AccountingPeriod
|
AccountingPeriod | string |
The accounting period of the report. |
Returns
- Body
- BaseResult
Update User
Update user already added in Expensya.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Format - guid. Unique identifier of the user to update.
|
userId | True | string |
Format - guid. Unique identifier of the user to update. |
Shows if the validators of the user should be updated or not.
|
shouldUpdateValidators | True | boolean |
Shows if the validators of the user should be updated or not. |
LastName
|
LastName | string |
Last name of the user. |
|
FirstName
|
FirstName | string |
First name of the user. |
|
Mail
|
string |
Mail of the user. |
||
MailAlias
|
MailAlias | string |
Mail alias of the user. |
|
PayId
|
PayId | string |
Serial of the user. |
|
PayId2
|
PayId2 | string |
First analytical axis. |
|
PayId3
|
PayId3 | string |
Second analytical axis. |
|
PayId4
|
PayId4 | string |
Third analytical axis. |
|
PayId5
|
PayId5 | string |
Forth analytical axis. |
|
PayId6
|
PayId6 | string |
Fifth analytical axis. |
|
Language
|
Language | string |
Language of the user: FR, US, SE... |
|
LocalCurrency
|
LocalCurrency | string |
Local currency of the user: EUR, TND, USD... |
|
LocalCountry
|
LocalCountry | string |
Local country of the user. |
|
Manager_Id
|
Manager_Id | guid |
Unique identifier of second validator. |
|
Reviewer_Id
|
Reviewer_Id | guid |
Unique identifier of the first validaor. |
|
UserType
|
UserType | enum |
Enum flag attribute which is the type of the user and it is necessary to combine the user type 'Employee' with the other types for exemple: Employee + Administrator or Employee + Accountant. The user typs are :
|
|
Vendor
|
Vendor | string |
The name of the vendor. |
|
UserRole
|
UserRole | enum |
Enum flag attribute which is the role of the user :
|
|
JobTitle
|
JobTitle | string |
Title of the user job. |
|
CanAddPurchase
|
CanAddPurchase | boolean |
If the user can add purchase or not. |
|
DefaultProjectId
|
DefaultProjectId | guid |
Unique identifier of the user default project. |
|
IKRates_Id
|
IKRates_Id | guid |
Unique identifier of the mileage compensation rates. |
|
Mail
|
True | string |
Mail of the validator |
|
MinimumAmount
|
MinimumAmount | decimal |
If the ammount exceed the ammount the expense should be sent to the validator |
|
TagsToAssign
|
TagsToAssign | array of string |
List of tags' names that will be assigned to the user. |
|
TagsToUnassign
|
TagsToUnassign | array of string |
List of tags' names that will be unassigned from the user. |
Returns
- Body
- BaseResult
Update Users Status
Update expensya users status.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
UserId
|
UserId | guid |
Unique identifier of the user. |
|
Operation
|
Operation | enum |
Operation that will be applied to the user.
|
Returns
Definitions
AddOrUpdateEntityResult
Name | Path | Type | Description |
---|---|---|---|
Id
|
Id | guid |
Unique identifier of the updated project. |
ExternalId
|
ExternalId | string |
The External identifier of the updated project. |
ResultCode
|
ResultCode | enum |
Expensya response internal codes:
|
Message
|
Message | string |
Extra details sent by the server. |
BaseResult
Name | Path | Type | Description |
---|---|---|---|
ResultCode
|
ResultCode | enum |
Expensya response internal codes:
|
Message
|
Message | string |
Extra details sent by the server. |
BaseResultExportResponse
Name | Path | Type | Description |
---|---|---|---|
ResultItem
|
ResultItem | ExportResponse | |
ResultCode
|
ResultCode | enum |
Expensya response internal codes:
|
Message
|
Message | string |
Extra details sent by the server. |
BaseResultProjectResponse
Name | Path | Type | Description |
---|---|---|---|
ResultItem
|
ResultItem | ProjectResponse | |
ResultCode
|
ResultCode | enum |
Expensya response internal codes:
|
Message
|
Message | string |
Extra details sent by the server. |
BaseResultListAddOrUpdateEntityResult
Name | Path | Type | Description |
---|---|---|---|
ResultItem
|
ResultItem | array of AddOrUpdateEntityResult |
Item sent by the server. |
ResultCode
|
ResultCode | enum |
Expensya response internal codes:
|
Message
|
Message | string |
Extra details sent by the server. |
BaseResultListEventResponse
Name | Path | Type | Description |
---|---|---|---|
ResultItem
|
ResultItem | array of EventResponse |
Item sent by the server. |
ResultCode
|
ResultCode | enum |
Expensya response internal codes:
|
Message
|
Message | string |
Extra details sent by the server. |
BaseResultListExportFormatResponse
Name | Path | Type | Description |
---|---|---|---|
ResultItem
|
ResultItem | array of ExportFormatResponse |
Item sent by the server. |
ResultCode
|
ResultCode | enum |
Expensya response internal codes:
|
Message
|
Message | string |
Extra details sent by the server. |
BaseResultListUpdateUserResult
Name | Path | Type | Description |
---|---|---|---|
ResultItem
|
ResultItem | array of UpdateUserResult |
Item sent by the server. |
ResultCode
|
ResultCode | enum |
Expensya response internal codes:
|
Message
|
Message | string |
Extra details sent by the server. |
BrokenRuleResponse
Name | Path | Type | Description |
---|---|---|---|
Id
|
Id | guid |
Unique identifier of the broken rule. |
Name
|
Name | string |
Name of the broken rule. |
Description
|
Description | string |
Description of the broken rule. |
DescriptionForCredit
|
DescriptionForCredit | string |
Description for credit of the broken rule. |
Budget
|
Budget | decimal |
Budget of the broken rule. |
RuleType
|
RuleType | enum |
Type of the broken rule :
|
Currency
|
Currency | string |
Currency of the broken rule. |
AllowExceptions
|
AllowExceptions | boolean |
Shows if exceptions are allowed in broken rule. |
RuleElementType
|
RuleElementType | enum |
Type of the rule element :
|
IntervalType
|
IntervalType | enum |
Type of the interval of the broken rule :
|
Language
|
Language | string |
Language of the broken rule. |
RuleCurrenciesWithBudget
|
RuleCurrenciesWithBudget | TupleStringDecimal | |
ForAllCompany
|
ForAllCompany | boolean |
Shows if the broken rule is for all company or not. |
CategoryResponse
Name | Path | Type | Description |
---|---|---|---|
Id
|
Id | guid |
Unique identifier of the category. |
Name
|
Name | string |
Name of the category. |
EntityName
|
EntityName | string |
Entity Name of the category. |
Parent
|
Parent | string |
Parent of the category (category can be linked to an other categroy). |
Description
|
Description | string |
Description of the category. |
PrimitiveCategories
|
PrimitiveCategories | string |
Sub categories. |
ParentCategory_Id
|
ParentCategory_Id | guid |
Unique parent identifier of the category (category can be linked to an other categroy). |
IsActive
|
IsActive | boolean |
Shows if the category is active or not. |
IsActiveAsDefault
|
IsActiveAsDefault | boolean |
Default category when user add new expense. |
CostAccount
|
CostAccount | string |
Cost account of the category. |
VatAccount
|
VatAccount | string |
VAT account of the category. |
ExtraData
|
ExtraData | string |
Additional informations about the category. |
CreationDate
|
CreationDate | date-time |
Creation date of the category. Respects the standard ISO 8601 date format. e.g: 2018-06-04T08:30:15.023Z |
VatClaimRate
|
VatClaimRate | decimal |
VAT claim rate of the category. |
VatClaimRates
|
VatClaimRates | string |
VAT claim rate of the category by year. |
CategoryUseType
|
CategoryUseType | enum |
Category use type :
|
ExternalId
|
ExternalId | string |
External identifier of the category. |
IsReadOnly
|
IsReadOnly | boolean |
Shows if the category is just read only. |
CategoryTags
|
CategoryTags | array of TagResponse |
List of tags of the category. |
EventResponse
Name | Path | Type | Description |
---|---|---|---|
EventDate
|
EventDate | date-time |
Date of the event. Respects the standard ISO 8601 date format. e.g: 2018-06-04T08:30:15.023Z |
EventType
|
EventType | enum |
Type of the event: submitMission, validateMission...
|
UserId
|
UserId | guid |
Unique identifier of the user. |
UserLastName
|
UserLastName | string |
Last name of the user. |
UserFirstName
|
UserFirstName | string |
First name of the user. |
UserMail
|
UserMail | string |
Mail of the user. |
Description
|
Description | string |
Description of the evnt |
ExpenseResponse
Name | Path | Type | Description |
---|---|---|---|
Id
|
Id | guid |
Unique identifier of the expense. |
Name
|
Name | string |
Name of the expense. |
Value
|
Value | decimal |
Value of the expense. |
ValueToReimburse
|
ValueToReimburse | decimal |
Value to reimbures of the expense. |
ReimbursementRate
|
ReimbursementRate | decimal |
Reimbursement rate of the expense. |
Description
|
Description | string |
Description of the expense. |
UseType
|
UseType | enum |
Type of the expense :
|
DateCreation
|
DateCreation | date-time |
Creation date of the expense. Respects the standard ISO 8601 date format. e.g: 2018-06-04T08:30:15.023Z |
DateInvoice
|
DateInvoice | date-time |
Date of the expense. Respects the standard ISO 8601 date format. e.g: 2018-06-04T08:30:15.023Z |
DateUtcOffset
|
DateUtcOffset | double |
Date offset of the expense. |
HasPhoto
|
HasPhoto | boolean |
Shows if the expense has photo. |
Currency
|
Currency | string |
Currency of the expense. |
ValueInCurrency
|
ValueInCurrency | decimal |
Value in currency of the owner of the expense. |
ValueInLocalCurrency
|
ValueInLocalCurrency | decimal |
Value in local currency of the owner of the expense. |
MerchantInvoiceId
|
MerchantInvoiceId | string |
Merchant Invoice external identifier |
MerchantCountry
|
MerchantCountry | string |
Merchant country of the expense. |
MerchantCity
|
MerchantCity | string |
Merchant city of the expense. |
MerchantZipCode
|
MerchantZipCode | string |
Merchant zip code of the expense. |
MerchantAddress
|
MerchantAddress | string |
Merchant address of the expense. |
MerchantName
|
MerchantName | string |
Merchant name of the expense |
MerchantVatNumber
|
MerchantVatNumber | string |
Merchant VAT number of the expense. |
Units
|
Units | decimal |
Number of units of the expense. |
State
|
State | enum |
State of the expense :
|
VAT
|
VAT | VATResponse | |
VATAvgRate
|
VATAvgRate | decimal |
VAT rate of the expense. |
AttachedFilesCount
|
AttachedFilesCount | integer |
Number of attached files to the expense. |
ToReimburse
|
ToReimburse | boolean |
Shows if the expense is to reimburse. |
IsBillable
|
IsBillable | boolean |
Shows if the expense is billable to client. |
CustomFields
|
CustomFields | object |
Custom fields of the expense. |
FileType
|
FileType | string |
File type of the expense. |
DefaultRate
|
DefaultRate | decimal |
Default rate of the expense. |
CreditSource_Id
|
CreditSource_Id | guid |
Unique credit source identifier of the expense. |
User_Id
|
User_Id | guid |
Unique user identifier of the expense. |
Project
|
Project | ProjectResponse | |
Report
|
Report | ReportResponse | |
PaymentInstrument
|
PaymentInstrument | PaymentInstrumentResponse | |
Vehicle
|
Vehicle | VehicleResponse | |
TransactionsSumValue
|
TransactionsSumValue | decimal |
Transactions sum value of the expense. |
TransactionsSumInCurrency
|
TransactionsSumInCurrency | decimal |
Transactions sum value in currency of the expense. |
TransactionsSumInLocalCurrency
|
TransactionsSumInLocalCurrency | decimal |
Transactions sum value in Local currency of the expense. |
PerdiemCountry
|
PerdiemCountry | string |
Country of the perdiem. |
PerdiemCalculationPeriodType
|
PerdiemCalculationPeriodType | enum |
Type of the perdiem calculation period :
|
PerDiemType
|
PerDiemType | enum |
Type of the perdiem :
|
Category
|
Category | CategoryResponse | |
BrokenRules
|
BrokenRules | array of BrokenRuleResponse |
List of broken rules of the expense. |
IsMileage
|
IsMileage | boolean |
Shows if the expense is Mileage. |
CategoryExtraDataStr
|
CategoryExtraDataStr | string |
Extra date for the category of the expense. |
Guests
|
Guests | array of GuestResponse |
List of guests of the expense. |
SubStatus
|
SubStatus | enum |
Enum flag attribute which is the substatus of the expense :
|
OwnerPayId
|
OwnerPayId | string |
Serial of the owner of the expense. |
OwnerPayId2
|
OwnerPayId2 | string |
First analytical axis of the owner of the expense. |
OwnerPayId3
|
OwnerPayId3 | string |
Second analytical axis of the owner of the expense. |
OwnerPayId4
|
OwnerPayId4 | string |
Third analytical axis of the owner of the expense. |
OwnerPayId5
|
OwnerPayId5 | string |
Fourth analytical axis of the owner of the expense. |
OwnerPayId6
|
OwnerPayId6 | string |
Fifth analytical axis of the owner of the expense. |
ExpenseTags
|
ExpenseTags | array of TagResponse |
List of tag of the expense. |
ExportFormatResponse
Name | Path | Type | Description |
---|---|---|---|
Id
|
Id | guid |
Unique identifier of the export format. |
Name
|
Name | string |
The name of export format. |
Extension
|
Extension | string |
The extension of the export format. |
CodePath
|
CodePath | string |
Unique code path of the export format. |
MissionExport
|
MissionExport | boolean |
Shows if the export format is available for reports. |
InvoicesExport
|
InvoicesExport | boolean |
Shows if the export format is available for expenses. |
AutoExport
|
AutoExport | boolean |
Shows if it's an auto export format. |
LastAutoExportDate
|
LastAutoExportDate | date-time |
Date of the last auto export if it happened and if the export format is auto export format. Respects the standard ISO 8601 date format. e.g: 2018-06-04T08:30:15.023Z |
ExportResponse
Name | Path | Type | Description |
---|---|---|---|
FileUrl
|
FileUrl | string |
The url of the exported file. |
FileExtension
|
FileExtension | string |
The extension of the exported file. |
FileName
|
FileName | string |
The name of the exported file. |
GuestResponse
Name | Path | Type | Description |
---|---|---|---|
Mail
|
string |
Mail of the guest. |
|
FullName
|
FullName | string |
Full name of the guest. |
Id
|
Id | guid |
Unique identifier of the guest. |
IsCoworker
|
IsCoworker | boolean |
Shows if the guest is coworker or not. |
ListAndPagesCountResultCategoryResponse
Name | Path | Type | Description |
---|---|---|---|
List
|
List | array of CategoryResponse |
List of elements to return. |
PagesCount
|
PagesCount | integer |
Total number of pages. |
TotalListCount
|
TotalListCount | integer |
Total number of elements per page. |
ResultCode
|
ResultCode | enum |
Expensya response internal codes:
|
Message
|
Message | string |
Extra details sent by the server. |
ListAndPagesCountResultExpenseResponse
Name | Path | Type | Description |
---|---|---|---|
List
|
List | array of ExpenseResponse |
List of elements to return. |
PagesCount
|
PagesCount | integer |
Total number of pages. |
TotalListCount
|
TotalListCount | integer |
Total number of elements per page. |
ResultCode
|
ResultCode | enum |
Expensya response internal codes:
|
Message
|
Message | string |
Extra details sent by the server. |
ListAndPagesCountResultProjectResponse
Name | Path | Type | Description |
---|---|---|---|
List
|
List | array of ProjectResponse |
List of elements to return. |
PagesCount
|
PagesCount | integer |
Total number of pages. |
TotalListCount
|
TotalListCount | integer |
Total number of elements per page. |
ResultCode
|
ResultCode | enum |
Expensya response internal codes:
|
Message
|
Message | string |
Extra details sent by the server. |
ListAndPagesCountResultReportResponse
Name | Path | Type | Description |
---|---|---|---|
List
|
List | array of ReportResponse |
List of elements to return. |
PagesCount
|
PagesCount | integer |
Total number of pages. |
TotalListCount
|
TotalListCount | integer |
Total number of elements per page. |
ResultCode
|
ResultCode | enum |
Expensya response internal codes:
|
Message
|
Message | string |
Extra details sent by the server. |
ListAndPagesCountResultUserResponse
Name | Path | Type | Description |
---|---|---|---|
List
|
List | array of UserResponse |
List of elements to return. |
PagesCount
|
PagesCount | integer |
Total number of pages. |
TotalListCount
|
TotalListCount | integer |
Total number of elements per page. |
ResultCode
|
ResultCode | enum |
Expensya response internal codes:
|
Message
|
Message | string |
Extra details sent by the server. |
LoginResponse
Name | Path | Type | Description |
---|---|---|---|
Id
|
Id | guid | |
UserToken
|
UserToken | string | |
LastName
|
LastName | string | |
FirstName
|
FirstName | string | |
Address
|
Address | string | |
City
|
City | string | |
PhoneNumber
|
PhoneNumber | string | |
Mail
|
string | ||
ZipCode
|
ZipCode | string | |
MailAlias
|
MailAlias | string | |
Language
|
Language | string | |
CreationDate
|
CreationDate | date-time | |
CountryCode
|
CountryCode | string | |
FaxNumber
|
FaxNumber | string | |
Currency
|
Currency | string | |
ShemaVersion
|
ShemaVersion | integer | |
Company_Id
|
Company_Id | guid | |
Login_Id
|
Login_Id | guid | |
Manager_Id
|
Manager_Id | guid | |
UserType
|
UserType | enum |
|
UserRole
|
UserRole | enum |
|
UserTokenDurationSeconds
|
UserTokenDurationSeconds | uint64 | |
ResultCode
|
ResultCode | enum |
Expensya response internal codes:
|
Message
|
Message | string |
Extra details sent by the server. |
PaymentInstrumentResponse
Name | Path | Type | Description |
---|---|---|---|
Name
|
Name | string |
Name of the payment instrument. |
Description
|
Description | string |
Description of the payment instrument. |
IsActive
|
IsActive | boolean |
Shows if the payment instrument is active or not. |
InstrumentType
|
InstrumentType | enum |
Type of the payment instrument :
|
AccountType
|
AccountType | enum |
Type of the payment instrument account :
|
LastDigits
|
LastDigits | string |
Last digits of the payment instrument. |
CardKey
|
CardKey | string |
Card key of the payment instrument. |
JournalCode
|
JournalCode | string |
Journal code of the payment instrument. |
Auxiliary
|
Auxiliary | string |
Auxiliary account of the payment instrument. |
AccountNumber
|
AccountNumber | string |
Account number of the payment instrument. |
ProjectResponse
Name | Path | Type | Description |
---|---|---|---|
Id
|
Id | guid |
Unique identifier of the project. |
HasBillable
|
HasBillable | boolean |
Project is billable to client. |
StartDate
|
StartDate | date-time |
Start date of the project. Respects the standard ISO 8601 date format. e.g: 2018-06-04T08:30:15.023Z |
EndDate
|
EndDate | date-time |
End date of the project. Respects the standard ISO 8601 date format. e.g: 2018-06-04T08:30:15.023Z |
IsActive
|
IsActive | boolean |
Show if the project is Active. |
MileageConfigurationsStr
|
MileageConfigurationsStr | string |
Mileage configuration of the project. |
Address
|
Address | string |
Address of the project. |
ZipCode
|
ZipCode | string |
Zip code of the project. |
City
|
City | string |
City of the project. |
ExternalId
|
ExternalId | string |
External identifier of the project. |
Name
|
Name | string |
Name of the Project. |
ProjectRef
|
ProjectRef | string |
Reference of the project |
Validator_Id
|
Validator_Id | guid |
Unique validator identifier of the project. |
Reviewer_Id
|
Reviewer_Id | guid |
Unique reviwer identifier of the project. |
ClientName
|
ClientName | string |
Client name of the project. |
ForAllCompany
|
ForAllCompany | boolean |
Project is shared with all users. |
IsBillableDefaultValue
|
IsBillableDefaultValue | boolean |
Project is by default billable to client. |
PayId2
|
PayId2 | string |
Second Analytical axis relevant to the project. |
Currency
|
Currency | string |
Currency of the project. |
ExtraData
|
ExtraData | string |
Additional informations about the project. |
ProjectUseType
|
ProjectUseType | enum |
Enum flag attribute that shows to which entity the project will be applied to :
|
CustomField_Id
|
CustomField_Id | guid |
Unique custom field identifier related to the project. |
CustomFieldParent_Id
|
CustomFieldParent_Id | guid |
Unique parent custom Field identifier related to the project. |
CategoriesIdsStr
|
CategoriesIdsStr | string |
Categories identifiers relevant to the project. |
ValidatorFullName
|
ValidatorFullName | string |
Validator full name of the project. |
ValidatorMail
|
ValidatorMail | string |
Validator mail of the project. |
ReviewerFullName
|
ReviewerFullName | string |
Reviwer full name of the project. |
ReviewerMail
|
ReviewerMail | string |
Reviewer mail of the project. |
IsReadOnly
|
IsReadOnly | boolean |
Shows if the project is just read only. |
ProjectTags
|
ProjectTags | array of TagResponse |
List of tags of the project. |
ReportResponse
Name | Path | Type | Description |
---|---|---|---|
Id
|
Id | guid |
Unique report identifier. |
Name
|
Name | string |
Name of the report. |
DateCreation
|
DateCreation | date-time |
Creation date of the report. Respects the standard ISO 8601 date format. e.g: 2018-06-04T08:30:15.023Z |
Budget
|
Budget | decimal |
Budget of the report. |
State
|
State | enum |
State of the report : Active, rejected, valideted...
|
User_Id
|
User_Id | guid |
Unique identifier of report's owner. |
UserLastName
|
UserLastName | string |
Last name of report's owner. |
UserFirstName
|
UserFirstName | string |
First name of report's owner. |
UserMail
|
UserMail | string |
Mail of report's owner. |
Manager_Id
|
Manager_Id | guid |
Unique manager identifier of the report's user. |
Accountant_Id
|
Accountant_Id | guid |
Unique accountant identifier of the report's user. |
Reviewer_Id
|
Reviewer_Id | guid |
Unique reviwer identifier of the report's user |
InvoicesCount
|
InvoicesCount | integer |
Invoices count related to the report. |
Value
|
Value | decimal |
Value of the report. |
ValueToReimburse
|
ValueToReimburse | decimal |
Value to reimburse of the report. |
ValueInLocalCurrency
|
ValueInLocalCurrency | decimal |
Value in user local currency of the report. |
ValueToReimburseInLocalCurrency
|
ValueToReimburseInLocalCurrency | decimal |
Value to reimburse in user local currency of the report. |
StartDate
|
StartDate | date-time |
Start date of the report. Respects the standard ISO 8601 date format. e.g: 2018-06-04T08:30:15.023Z |
EndDate
|
EndDate | date-time |
End date of the report. Respects the standard ISO 8601 date format. e.g: 2018-06-04T08:30:15.023Z |
UserCurrency
|
UserCurrency | string |
User currency of the report. |
UserLocalCurrency
|
UserLocalCurrency | string |
User local currency of the report. |
IdShort
|
IdShort | string |
Auto-generated identifier of the report. |
CurrentValidator_Id
|
CurrentValidator_Id | guid |
Unique current validator identifier of the report. |
InvoiceAttachedFilesCount
|
InvoiceAttachedFilesCount | integer |
Expense attached file count relevant to the report. |
ReportTags
|
ReportTags | array of TagResponse |
List of tags of the report. |
TagResponse
Name | Path | Type | Description |
---|---|---|---|
Id
|
Id | guid |
Unique identifier of the tag. |
Name
|
Name | string |
Name of the tag. |
Description
|
Description | string |
Description of the tag. |
CreationDate
|
CreationDate | date-time |
Creation date of the tag. Respects the standard ISO 8601 date format. e.g: 2018-06-04T08:30:15.023Z |
IsActive
|
IsActive | boolean |
Shows if the tag is active or not. |
TagType
|
TagType | enum |
Enum attribute which is the type of the tag :
|
DefinitionStr
|
DefinitionStr | string |
Definition of the tag. |
UseType
|
UseType | enum |
Enum attribute which is the use type of the tag :
|
UpdateUserResult
Name | Path | Type | Description |
---|---|---|---|
UserResponse
|
UserResponse | UserResponse | |
ResultCode
|
ResultCode | enum |
Expensya response internal codes:
|
Message
|
Message | string |
Extra details sent by the server. |
UserResponse
Name | Path | Type | Description |
---|---|---|---|
Id
|
Id | guid |
Unique identifier of the user. |
LastName
|
LastName | string |
Last name of the user. |
FirstName
|
FirstName | string |
First name of the user. |
Address
|
Address | string |
Address of the user. |
PhoneNumber
|
PhoneNumber | string |
Phone Number of the user. |
Mail
|
string |
Mail of the user. |
|
MailAlias
|
MailAlias | string |
Mail alias of the user. |
ZipCode
|
ZipCode | string |
Zip code of the user. |
FaxNumber
|
FaxNumber | string |
Fax number of the user. |
CreationDate
|
CreationDate | date-time |
Creation date of the user. Respects the standard ISO 8601 date format. e.g: 2018-06-04T08:30:15.023Z |
CountryCode
|
CountryCode | string |
Country code of the user. |
Language
|
Language | string |
Language of the user. |
Currency
|
Currency | string |
Currency of the user. |
LocalCurrency
|
LocalCurrency | string |
Local currency of the user. |
LocalCountry
|
LocalCountry | string |
Local country of the user. |
CanCreateCategories
|
CanCreateCategories | boolean |
Sows if the user has right to create categories. |
Manager_Id
|
Manager_Id | guid |
Unique manager identifier of the user. |
AccountantMail
|
AccountantMail | string |
Accountant mail of the user. |
AccountantPayId
|
AccountantPayId | string |
Accountant analytical axis of the user. |
UserType
|
UserType | enum |
User Type :
|
UserState
|
UserState | enum |
User State :
|
PayId
|
PayId | string |
Analytacal axis of the user. |
PayId2
|
PayId2 | string |
Second analytical axis of the user. |
PayId3
|
PayId3 | string |
Third analytical axis of the user. |
PayId4
|
PayId4 | string |
Fourth analytical axis of the user |
PayId5
|
PayId5 | string |
Fifth analytical axis of the user. |
PayId6
|
PayId6 | string |
Sixth analytical axis of the user. |
ManagerFirstName
|
ManagerFirstName | string |
Manager first name of the user. |
ManagerLastName
|
ManagerLastName | string |
Manager last name of the user. |
ManagerMail
|
ManagerMail | string |
Manager mail of the user. |
ManagerPayId
|
ManagerPayId | string |
Manager analytical axis of the user. |
ManagerUserState
|
ManagerUserState | enum |
Manager state of the user :
|
Reviewer_Id
|
Reviewer_Id | guid |
Unique reviwer identifier of the user. |
ReviewerFirstName
|
ReviewerFirstName | string |
Reviwer first name of the user. |
ReviewerLastName
|
ReviewerLastName | string |
Reviwer last name of the user. |
ReviewerMail
|
ReviewerMail | string |
Reviwer mail of the user. |
ReviewerPayId
|
ReviewerPayId | string |
Reviwer analytical axis of the user. |
ReviewerUserState
|
ReviewerUserState | enum |
Reviwer state of the user :
|
JobTitle
|
JobTitle | string |
Job title of the user. |
Vendor
|
Vendor | string |
Vendor of the user. |
MileageConfigurationsStr
|
MileageConfigurationsStr | string |
Mileage configuration of the user. |
PerDiemConfigName
|
PerDiemConfigName | string |
Perdiem configuration of the user. |
UserRole
|
UserRole | enum |
Roles access of the user :
|
ConfigurationSettingsStr
|
ConfigurationSettingsStr | string |
Additional configurations of the user. |
ConfigurationSettingsReference
|
ConfigurationSettingsReference | string |
Configuration reference of the user. |
LastLoginDate
|
LastLoginDate | date-time |
Last login date of the user. Respects the standard ISO 8601 date format. e.g: 2018-06-04T08:30:15.023Z |
LastSignInDate
|
LastSignInDate | date-time |
Last signIn date of the user. Respects the standard ISO 8601 date format. e.g: 2018-06-04T08:30:15.023Z |
Validators
|
Validators | array of ValidatorResponse |
List of validators of the user. |
UserSimpleTags
|
UserSimpleTags | array of TagResponse |
List of simple tags of the user. |
UserTags
|
UserTags | array of TagResponse |
List of tags of the user. |
RestrictedTags
|
RestrictedTags | array of TagResponse |
Restricted tags with are managed by the user. |
ValidatorResponse
Name | Path | Type | Description |
---|---|---|---|
Mail
|
string | ||
FirstName
|
FirstName | string | |
LastName
|
LastName | string | |
MinimumAmount
|
MinimumAmount | decimal |
VATResponse
Name | Path | Type | Description |
---|---|---|---|
Rates
|
Rates | array of decimal |
VAT rates of the expense. |
Values
|
Values | array of decimal |
AT values of the expense. |
VatFreeAmount
|
VatFreeAmount | decimal |
Free amount of the VAT. |
Tips
|
Tips | decimal |
Tips of the expense |
VehicleResponse
Name | Path | Type | Description |
---|---|---|---|
Name
|
Name | string |
Name of the vehicle. |
DateCreation
|
DateCreation | date-time |
Creation date of the vehicle. Respects the standard ISO 8601 date format. e.g: 2018-06-04T08:30:15.023Z |
CreationYearKm
|
CreationYearKm | decimal |
Distance already filed outside Expensya in the creation year in Km. |
CreationYearMiles
|
CreationYearMiles | decimal |
Distance already filed outside Expensya in the creation year in mile. |
LastYearDistanceKm
|
LastYearDistanceKm | decimal |
Distance already filed outside Expensya in the last year in Km. |
LastUpdatedYear
|
LastUpdatedYear | integer |
Last updated year of the vehicle. |
VehicleType
|
VehicleType | enum |
Type of the vehicle :
|
InternalVehicleType
|
InternalVehicleType | enum |
Internal type of the vehicle :
|
CurrentValidator_Id
|
CurrentValidator_Id | guid |
Unique identifier of the current validator of the vehicle. |
LastValidatorReminderDate
|
LastValidatorReminderDate | date-time |
Last validator reminder date of the vehicle. Respects the standard ISO 8601 date format. e.g: 2018-06-04T08:30:15.023Z |
Comments
|
Comments | string |
Comments of the vehicle. |
State
|
State | enum |
State of the vehicle :
|
ExternalId
|
ExternalId | string |
External identifier of the vehicle. |
AdministrativePower
|
AdministrativePower | integer |
Administrative power of the vehicle. |
IsActive
|
IsActive | boolean |
Shows if the vehicle is active or not. |
AttachedFilesCount
|
AttachedFilesCount | integer |
Count of the attached files to the vehicle. |
CreationType
|
CreationType | enum |
Type of the creation of the vehicle :
|
StartDate
|
StartDate | date-time |
Start date of the vehicle. Respects the standard ISO 8601 date format. e.g: 2018-06-04T08:30:15.023Z |
EndDate
|
EndDate | date-time |
CEnd date of the vehicle. Respects the standard ISO 8601 date format. e.g: 2018-06-04T08:30:15.023Z |
TupleStringDecimal
Name | Path | Type | Description |
---|---|---|---|
Item1
|
Item1 | string | |
Item2
|
Item2 | decimal |