Connectors Reference

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.

 

Status: Preview

Tier: Premium

Version: 1.0

 

Actions:

Name

Summary

GetExpenseImage (string expenseId)

Get Expense Image

ExportExpenses (string exportId, [Optional]string reportId, [Optional]string categoryId, [Optional]string expenseName, [Optional]string startDate, [Optional]string endDate, [Optional]string expenseStates, [Optional]string reportStates, [Optional]string userIds, [Optional]string userMail, [Optional]string reportIds, [Optional]string expenseIds, [Optional]string reportName, [Optional]string reportIdShort, [Optional]integer dateFilterType, [Optional]string payId, [Optional]string payId2, [Optional]string payId3, [Optional]string accountingPeriod, [Optional]boolean includeReceipts, [Optional]integer expenseUseTypes, [Optional]string archiveExpenses)

Export Expense

PrintMission (string reportId)

Export Report

ExportFormats ([Optional]boolean isForExpenses, [Optional]integer exportType)

Get Export Formats

AddProjects ([Optional]array addOrUpdateProjectInputArray)

Add Projects

UpdateProjects ([Optional]array addOrUpdateProjectInputArray)

Update Projects

AddReciept ([Optional]AddReceiptInput addReceiptInput)

Add Reciept

RevokeUserToken ()

Revoke Token

ValidatorReports (string validatorMail, [Optional]string reportName, [Optional]string reportStartDate, [Optional]string reportEndDate, [Optional]string reportStates, [Optional]string reportIdShort, [Optional]string ownerId, [Optional]string ownerPayId2, [Optional]string projectId, [Optional]integer dateFilterType, [Optional]integer sortBy, [Optional]integer page, [Optional]integer pageSize, [Optional]boolean isDesc)

Get Validator Reports

GetCategoriesV2 ([Optional]string id, [Optional]string categoryName, [Optional]string costAccount, [Optional]string vatAccount, [Optional]boolean isActive, [Optional]string tagsNames, [Optional]integer page, [Optional]integer pageSize, [Optional]integer sortBy, [Optional]boolean isDesc)

Get Categories

GetExpensesWithPagingV2 ([Optional]string reportId, [Optional]string categoryId, [Optional]string expenseName, [Optional]string startDate, [Optional]string endDate, [Optional]integer reportState, [Optional]string expenseStates, [Optional]boolean isReimbusable, [Optional]number valueInCurrency, [Optional]string ownerId, [Optional]string ownerMail, [Optional]string ownerPayId, [Optional]string ownerPayId2, [Optional]string ownerPayId3, [Optional]string ownerPayId4, [Optional]string ownerPayId5, [Optional]string ownerPayId6, [Optional]string projectId, [Optional]boolean isBillable, [Optional]integer dateFilterType, [Optional]string merchantCountries, [Optional]string currencies, [Optional]string fileType, [Optional]string reportIdShort, [Optional]string expenseUseTypes, [Optional]string supplierId, [Optional]string expenseIds, [Optional]string merchantName, [Optional]string vatCode, [Optional]number valueHTInExpenseCurrency, [Optional]number vatRate, [Optional]number vatValue, [Optional]string reportsIds, [Optional]integer dateTimeOffset, [Optional]string tagsNames, [Optional]integer page, [Optional]integer pageSize, [Optional]integer sortBy, [Optional]boolean isDesc)

Get Expenses

GetProjectDetailsV2 (string projectId)

Get Project Details

GetProjectsV2 ([Optional]string projectName, [Optional]string projectIds, [Optional]string validatorName, [Optional]string projectReferenceOrExternalId, [Optional]boolean bringAllProjects, [Optional]integer projectUseType, [Optional]boolean isActive, [Optional]string tagsNames, [Optional]string customFieldsIds, [Optional]string expenseDate, [Optional]string userId, [Optional]integer page, [Optional]integer pageSize, [Optional]integer sortBy, [Optional]boolean isDesc)

Get Projects

UpdateProjectStateV2 ([Optional]UpdateProjectStateInput updateProjectStateInput)

Update Projects State

AddQuickExpenseV2 (string userId, [Optional]QuickExpenseInput quickExpenseInput)

Add QuickExpense

RefreshUserTokenV2 ()

Refresh Token

UpdateReportStatus (string reportId, [Optional]ReportUpdateStatusInput reportUpdateStatusInput)

Update Report Status

GetReportHistoryV2 (string reportId)

Get Report History

CompanyReports ([Optional]string reportName, [Optional]string reportStartDate, [Optional]string reportEndDate, [Optional]string reportStates, [Optional]string reportIdShort, [Optional]string ownerId, [Optional]string ownerPayId2, [Optional]string projectId, [Optional]string tagsNames, [Optional]integer dateFilterType, [Optional]integer sortBy, [Optional]integer page, [Optional]integer pageSize, [Optional]boolean isDesc)

Get Reports

InviteUserV2 ([Optional]UserInviteInput userInviteInput)

Invite User

UpateUserV2 (string userId, boolean shouldUpdateValidators, [Optional]UserUpdateInput userUpdateInput)

Update User

CompanyUsers ([Optional]string id, [Optional]string firstName, [Optional]string lastName, [Optional]string mail, [Optional]string payId, [Optional]string mailOrNameOrPayId, [Optional]integer type, [Optional]integer state, [Optional]string reviewerId, [Optional]string reviewerName, [Optional]string managerId, [Optional]string managerName, [Optional]string userIds, [Optional]string userMails, [Optional]string tagsNames, [Optional]string simpleTagsNames, [Optional]integer sortBy, [Optional]integer page, [Optional]integer pageSize, [Optional]boolean isDesc)

Get Users

UpdateUsersStateV2 ([Optional]array updateUserStateInputArray)

Update Users Status

 

Triggers:

Name

Summary

 

Objects:

Name

Summary

AddOrUpdateEntityResult

 

AddOrUpdateProjectInput

 

AddReceiptInput

 

BaseResult

 

BaseResultExportResponse

 

BaseResultListAddOrUpdateEntityResult

 

BaseResultListEventResponse

 

BaseResultListExportFormatResponse

 

BaseResultListUpdateUserResult

 

BaseResultProjectResponse

 

BrokenRuleResponse

 

CategoryResponse

 

EventResponse

 

ExpenseResponse

 

ExportFormatResponse

 

ExportResponse

 

GuestResponse

 

KeyValuePairGuidString

 

ListAndPagesCountResultCategoryResponse

 

ListAndPagesCountResultExpenseResponse

 

ListAndPagesCountResultProjectResponse

 

ListAndPagesCountResultReportResponse

 

ListAndPagesCountResultUserResponse

 

LoginResponse

 

PaymentInstrumentResponse

 

ProjectResponse

 

QuickExpenseInput

 

ReportResponse

 

ReportUpdateStatusInput

 

TagResponse

 

TupleStringDecimal

 

UpdateProjectStateInput

 

UpdateUserResult

 

UpdateUserStateInput

 

UserInviteInput

 

UserResponse

 

UserUpdateInput

 

ValidatorInput

 

ValidatorResponse

 

VATResponse

 

VehicleResponse

 

 

Actions:

GetExpenseImage

Summary: Get Expense Image

Description: 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".

 

Syntax:

Expensya.GetExpenseImage (string expenseId)

 

Parameters:

Name

Type

Summary

Required

Related Action

expenseId

string

(Format - guid. Unique identifier of the expense.)

Format - guid. Unique identifier of the expense.

True

 

Returns:

          Type:string(stream)

 

ExportExpenses

Summary: Export Expense

Description: Export expenses on specified export format based on given filters.

 

Syntax:

Expensya.ExportExpenses (string exportId, [Optional]string reportId, [Optional]string categoryId, [Optional]string expenseName, [Optional]string startDate, [Optional]string endDate, [Optional]string expenseStates, [Optional]string reportStates, [Optional]string userIds, [Optional]string userMail, [Optional]string reportIds, [Optional]string expenseIds, [Optional]string reportName, [Optional]string reportIdShort, [Optional]integer dateFilterType, [Optional]string payId, [Optional]string payId2, [Optional]string payId3, [Optional]string accountingPeriod, [Optional]boolean includeReceipts, [Optional]integer expenseUseTypes, [Optional]string archiveExpenses)

 

Parameters:

Name

Type

Summary

Required

Related Action

exportId

string

(Format - guid. Unique identifier of the export.)

Format - guid. Unique identifier of the export.

True

reportId

string

(Filter with the unique identifier of the report related to the expenses.)

Filter with the unique identifier of the report related to the expenses.

False

categoryId

string

(Filter with the unique identifier of the category related to the expenses.)

Filter with the unique identifier of the category related to the expenses.

False

expenseName

string

(Filter with the name of the expense.)

Filter with the name of the expense.

False

startDate

string

(Filter with the start date based on dateFilterType (as date-time in RFC3339).)

Filter with the start date based on dateFilterType (as date-time in RFC3339).

False

endDate

string

(Filter with the end date based on dateFilterType (as date-time in RFC3339).)

Filter with the end date based on dateFilterType (as date-time in RFC3339).

False

expenseStates

string

(List of expenses state seperated by ',')

List of expenses state seperated by ',' : Validated = 3 ValidatedByAccountant = 4 Rejected = 99.

False

reportStates

string

(List of reports state related to the expenses seperated by ',')

List of reports state related to the expenses seperated by ',' : Active = 0 Submitted = 2 Rejected = 3 Validated = 4 Closed = 5 ValidatedAndExported = 6

False

userIds

string

(List of unique identifiers of the expenses' owners seperated by ','.)

List of unique identifiers of the expenses' owners seperated by ','.

False

userMail

string

(List of e-mails of the expenses' owners seperated by ','.)

List of e-mails of the expenses' owners seperated by ','.

False

reportIds

string

(List of unique identifiers of the reports related tp expenses by ','.)

List of unique identifiers of the reports related tp expenses by ','.

False

expenseIds

string

(List of unique identifiers of the expense seperated by ','.)

List of unique identifiers of the expense seperated by ','.

False

reportName

string

(Filter with the report name related to the expenses.)

Filter with the report name related to the expenses.

False

reportIdShort

string

(Filter with the internal identifier of the expenses' report. )

Filter with the internal identifier of the expenses' report.

False

dateFilterType

integer

(Format - enum. Indicates the target of date filters.)

Format - enum. Indicates the target of date filters: InvoiceDate = 1 ValidationDate = 2 AccountingValidationDate = 3 SubmissionDate = 4 CreationDate = 6.

False

payId

string

(Filter with the serial of the expense's owner.)

Filter with the serial of the expense's owner.

False

payId2

string

(Filter with the first analytical axis of the owner of the expense.)

Filter with the first analytical axis of the owner of the expense.

False

payId3

string

(Filter with the second analytical axis of the owner of the expense.)

Filter with the second analytical axis of the owner of the expense.

False

accountingPeriod

string

(Filter with the accounting period of the expenses.)

Filter with the accounting period of the expenses.

False

includeReceipts

boolean

(Indicates if the expenses receipts should be added to the export.)

Indicates if the expenses receipts should be added to the export.

False

expenseUseTypes

integer

(List of expense use type seperated by ',')

List of expense use type seperated by ',' : Invoice = 1 Advance = 2 Purchase = 4 Subscription = 8 MissionOrder = 16.

False

archiveExpenses

string

(Indicates if the reports related to the expenses will be archived.)

Indicates if the reports related to the expenses will be archived, applied only for expenses related to validated or validatedAndExported reports.

False

 

Returns:

          Type:BaseResultExportResponse

 

PrintMission

Summary: Export Report

Description: Export report as pdf.

 

Syntax:

Expensya.PrintMission (string reportId)

 

Parameters:

Name

Type

Summary

Required

Related Action

reportId

string

(Format - guid. Unique identifier of the report.)

Format - guid. Unique identifier of the report.

True

 

Returns:

          Type:BaseResultExportResponse

 

ExportFormats

Summary: Get Export Formats

Description: List of export formats.

 

Syntax:

Expensya.ExportFormats ([Optional]boolean isForExpenses, [Optional]integer exportType)

 

Parameters:

Name

Type

Summary

Required

Related Action

isForExpenses

boolean

(Bring only expenses export formats.)

Bring only expenses export formats, if false brings report export formats.

False

exportType

integer

(Format - enum. Indicates the type of export.)

Format - enum. Indicates the type of export: InvoiceAndPurchase = 1 Advance = 2 Balance = 4.

False

 

Returns:

          Type:BaseResultListExportFormatResponse

 

AddProjects

Summary: Add Projects

Description: Add new projects to Expensya.

 

Syntax:

Expensya.AddProjects ([Optional]array addOrUpdateProjectInputArray)

 

Parameters:

Name

Type

Summary

Required

Related Action

addOrUpdateProjectInputArray

array of (AddOrUpdateProjectInput)

 

 

False

 

Returns:

          Type:BaseResultListAddOrUpdateEntityResult

 

UpdateProjects

Summary: Update Projects

Description: Update projects already added to Expensya

 

Syntax:

Expensya.UpdateProjects ([Optional]array addOrUpdateProjectInputArray)

 

Parameters:

Name

Type

Summary

Required

Related Action

addOrUpdateProjectInputArray

array of (AddOrUpdateProjectInput)

 

 

False

 

Returns:

          Type:BaseResultListAddOrUpdateEntityResult

 

AddReciept

Summary: Add Reciept

Description: Add a new expense to your expensya account with a receipt.

 

Syntax:

Expensya.AddReciept ([Optional]AddReceiptInput addReceiptInput)

 

Parameters:

Name

Type

Summary

Required

Related Action

addReceiptInput

AddReceiptInput

 

 

False

 

Returns:

          Type:BaseResult

 

RevokeUserToken

Summary: Revoke Token

Description: Revoke your user token.

 

Syntax:

Expensya.RevokeUserToken ()

 

Returns:

          Type:BaseResult

 

ValidatorReports

Summary: Get Validator Reports

Description: Get the list of validator's reports with paging.

 

Syntax:

Expensya.ValidatorReports (string validatorMail, [Optional]string reportName, [Optional]string reportStartDate, [Optional]string reportEndDate, [Optional]string reportStates, [Optional]string reportIdShort, [Optional]string ownerId, [Optional]string ownerPayId2, [Optional]string projectId, [Optional]integer dateFilterType, [Optional]integer sortBy, [Optional]integer page, [Optional]integer pageSize, [Optional]boolean isDesc)

 

Parameters:

Name

Type

Summary

Required

Related Action

validatorMail

string

(The e-mail of the report's validator.)

The e-mail of the report's validator.

True

reportName

string

(Filter with the name of the report.)

Filter with the name of the report.

False

reportStartDate

string

(Filter with the start date based on dateFilterType (as date-time in RFC3339).)

Filter with the start date based on dateFilterType. Format - date-time (as date-time in RFC3339).

False

reportEndDate

string

(Filter with the end date based on dateFilterType (as date-time in RFC3339).)

Filter with the end date based on dateFilterType. Format - date-time (as date-time in RFC3339).

False

reportStates

string

(List of report states seperated by ','.)

List of report states seperated by ',' : Active = 0 Submitted = 2 Rejected = 3 Closed = 5 ValidatedAndExported = 6 Reimbursed = 7 PreSubmitted = 8 InValidation = 50.

False

reportIdShort

string

(Filter with the report inetrnal identifier.)

Filter with the report inetrnal identifier.

False

ownerId

string

(Filter with the unique identifier of the report's owner.)

Filter with the unique identifier of the report's owner.

False

ownerPayId2

string

(Filter with the serial of the report's owner.)

Filter with the serial of the report's owner.

False

projectId

string

(Filter with the unique identifier of the project that the report is linked to.)

Filter with the unique identifier of the project that the report is linked to.

False

dateFilterType

integer

(Format - enum. Indicates the target of date filters.)

Format - enum. Indicates the target of date filters: InvoiceDate = 1 ValidationDate = 2 AccountingValidationDate = 3 SubmissionDate = 4 PurchaseAccountingValidationDate = 5 CreationDate = 6

False

sortBy

integer

(Format - enum. List can be sorted by.)

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

False

page

integer

(The page number.)

The page number.

False

pageSize

integer

(The number of elements per page.)

The number of elements per page.

False

isDesc

boolean

(Order the list by desc or asc.)

Order the list by desc or asc.

False

 

Returns:

          Type:ListAndPagesCountResultReportResponse

 

GetCategoriesV2

Summary: Get Categories

Description: Get the list of categories with paging.

 

Syntax:

Expensya.GetCategoriesV2 ([Optional]string id, [Optional]string categoryName, [Optional]string costAccount, [Optional]string vatAccount, [Optional]boolean isActive, [Optional]string tagsNames, [Optional]integer page, [Optional]integer pageSize, [Optional]integer sortBy, [Optional]boolean isDesc)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(Filter with the unique identifier of the category.)

Filter with the unique identifier of the category.

False

categoryName

string

(Filter with the category name.)

Filter with the category name.

False

costAccount

string

(Filter with the unique identifier of the category.)

Filter with the unique identifier of the category.

False

vatAccount

string

(Filter with the unique identifier of the category.)

Filter with the unique identifier of the category.

False

isActive

boolean

(Bring only active categories.)

Bring only active categories.

False

tagsNames

string

(List of tags' names seperated by ','.)

List of tags' names seperated by ','.

False

page

integer

(The page number.)

The page number.

False

pageSize

integer

(The number of elements per page.)

The number of elements per page.

False

sortBy

integer

(Format - enum. List can be sorted by.)

Format - enum. List can be sorted by : Name_FR = 5, Name_EN = 10, CostAccount = 15, IsActive = 20, VatAccount = 25

False

isDesc

boolean

(Order the list by desc or asc.)

Order the list by desc or asc.

False

 

Returns:

          Type:ListAndPagesCountResultCategoryResponse

 

GetExpensesWithPagingV2

Summary: Get Expenses

Description: Get the list of expenses with paging.

 

Syntax:

Expensya.GetExpensesWithPagingV2 ([Optional]string reportId, [Optional]string categoryId, [Optional]string expenseName, [Optional]string startDate, [Optional]string endDate, [Optional]integer reportState, [Optional]string expenseStates, [Optional]boolean isReimbusable, [Optional]number valueInCurrency, [Optional]string ownerId, [Optional]string ownerMail, [Optional]string ownerPayId, [Optional]string ownerPayId2, [Optional]string ownerPayId3, [Optional]string ownerPayId4, [Optional]string ownerPayId5, [Optional]string ownerPayId6, [Optional]string projectId, [Optional]boolean isBillable, [Optional]integer dateFilterType, [Optional]string merchantCountries, [Optional]string currencies, [Optional]string fileType, [Optional]string reportIdShort, [Optional]string expenseUseTypes, [Optional]string supplierId, [Optional]string expenseIds, [Optional]string merchantName, [Optional]string vatCode, [Optional]number valueHTInExpenseCurrency, [Optional]number vatRate, [Optional]number vatValue, [Optional]string reportsIds, [Optional]integer dateTimeOffset, [Optional]string tagsNames, [Optional]integer page, [Optional]integer pageSize, [Optional]integer sortBy, [Optional]boolean isDesc)

 

Parameters:

Name

Type

Summary

Required

Related Action

reportId

string

(Filter with the unique report identifier related to the expense.)

Filter with the unique report identifier related to the expense.

False

categoryId

string

(Filter with the unique category identifier related to the expense.)

Filter with the unique category identifier related to the expense.

False

expenseName

string

(Filter with the name of the expense.)

Filter with the name of the expense.

False

startDate

string

(Filter with the start date based on dateFilterType (as date-time in RFC3339).)

Filter with the start date based on dateFilterType. Format - date-time (as date-time in RFC3339).

False

endDate

string

(Filter with the end date based on dateFilterType (as date-time in RFC3339).)

Filter with the end date based on dateFilterType. Format - date-time (as date-time in RFC3339).

False

reportState

integer

(Format - enum. State of the expense's report.)

Format - enum. State of the expense's report.

False

expenseStates

string

(List Of expenseStates seperated by ',')

List Of expenseStates seperated by ',' : Uploading = 0 Uploaded = 1 Ready = 2 Validated = 3 ValidatedByAccountant = 4 Rejected = 99.

False

isReimbusable

boolean

(Shows if the expense is to reimburse.)

Shows if the expense is to reimburse.

False

valueInCurrency

number

(Filter with the value in currency of the owner of the expense.)

Filter with the value in currency of the owner of the expense.

False

ownerId

string

(Filter with the unique owner identifier of the expense.)

Filter with the unique owner identifier of the expense.

False

ownerMail

string

(Filter with the mail of the expense.)

Filter with the mail of the expense.

False

ownerPayId

string

(Filter with the serial of the expense's owner.)

Filter with the serial of the expense's owner.

False

ownerPayId2

string

(Filter with the first analytical axis of the owner of the expense.)

Filter with the first analytical axis of the owner of the expense.

False

ownerPayId3

string

(Filter with the second analytical axis of the owner of the expense.)

Filter with the second analytical axis of the owner of the expense.

False

ownerPayId4

string

(Filter with the third analytical axis of the owner of the expense.)

Filter with the third analytical axis of the owner of the expense.

False

ownerPayId5

string

(Filter with the fourth analytical axis of the owner of the expense.)

Filter with the fourth analytical axis of the owner of the expense.

False

ownerPayId6

string

(Filter with fifth analytical axis of the owner of the expense.)

Filter with the fifth analytical axis of the owner of the expense.

False

projectId

string

(Filter with the unique project identifier related to the expense.)

Filter with the unique project identifier related to the expense.

False

isBillable

boolean

(Shows if the expense is billable to client.)

Shows if the expense is billable to client.

False

dateFilterType

integer

(Format - enum. Indicates the target of date filters.)

Format - enum. Indicates the target of date filters: InvoiceDate = 1 ValidationDate = 2 AccountingValidationDate = 3 SubmissionDate = 4 CreationDate = 6.

False

merchantCountries

string

(List of merchant countries related to the expense seperated by ',' ex: 'FR,ES')

List of merchant countries related to the expense seperated by ',' ex: 'FR,ES'

False

currencies

string

(List of currencies related to the expense seperated by ',' ex: 'EUR,USD')

List of currencies related to the expense seperated by ',' ex: 'EUR,USD'

False

fileType

string

(Filter with the file type of the expense : pdf, jpg ...)

Filter with the file type of the expense : pdf, jpg ...

False

reportIdShort

string

(Filter with the internal identifier of the expenses' report.)

Filter with the internal identifier of the expenses' report.

False

expenseUseTypes

string

(List of expense use types seperated by ','.)

List of expense use types seperated by ',' : Invoice = 1 Advance = 2 Purchase = 4 Subscription = 8 MissionOrder = 16.

False

supplierId

string

(Filter with the unique supplier identifier of the expense.)

Filter with the unique supplier identifier of the expense.

False

expenseIds

string

(List of unique identifiers of the expense seperated by ','.)

List of unique identifiers of the expense seperated by ','.

False

merchantName

string

(Filter with the merchant name of the expense.)

Filter with the merchant name of the expense.

False

vatCode

string

(Filter with the merchant VAT number of the expense.)

Filter with the merchant VAT number of the expense.

False

valueHTInExpenseCurrency

number

(Filter with excluding tax amount of the expense.)

Filter with excluding tax amount of the expense.

False

vatRate

number

(Filter with VAT rate of the expense.)

Filter with VAT rate of the expense.

False

vatValue

number

(Filter with VAT value of the expense.)

Filter with VAT value of the expense.

False

reportsIds

string

(List of unique reports' identifiers related to the expense seperated by ','.)

List of unique reports' identifiers related to the expense seperated by ','.

False

dateTimeOffset

integer

(Filter with the UTC offset of the expense.)

Filter with the UTC offset of the expense.

False

tagsNames

string

(List of tags' names seperated by ','.)

List of tags' names seperated by ','.

False

page

integer

(The page number.)

The page number.

False

pageSize

integer

(The number of elements per page.)

The number of elements per page.

False

sortBy

integer

(Format - enum. List can be sorted by.)

Format - enum. List can be sorted by : DateCreation = 11 DateInvoice = 12 Name = 20 Value = 30 ValueInCurrency = 31 HasPhoto = 40 State = 60 Category = 70.

False

isDesc

boolean

(Order the list by desc or asc.)

Order the list by desc or asc.

False

 

Returns:

          Type:ListAndPagesCountResultExpenseResponse

 

GetProjectDetailsV2

Summary: Get Project Details

Description: Get the details of the project.

 

Syntax:

Expensya.GetProjectDetailsV2 (string projectId)

 

Parameters:

Name

Type

Summary

Required

Related Action

projectId

string

(Format - guid. Unique identifier of the project.)

Format - guid. Unique identifier of the project.

True

 

Returns:

          Type:BaseResultProjectResponse

 

GetProjectsV2

Summary: Get Projects

Description: Get the list of projects.

 

Syntax:

Expensya.GetProjectsV2 ([Optional]string projectName, [Optional]string projectIds, [Optional]string validatorName, [Optional]string projectReferenceOrExternalId, [Optional]boolean bringAllProjects, [Optional]integer projectUseType, [Optional]boolean isActive, [Optional]string tagsNames, [Optional]string customFieldsIds, [Optional]string expenseDate, [Optional]string userId, [Optional]integer page, [Optional]integer pageSize, [Optional]integer sortBy, [Optional]boolean isDesc)

 

Parameters:

Name

Type

Summary

Required

Related Action

projectName

string

(Filter with the name of the project.)

Filter with the name of the project.

False

projectIds

string

(List of unique projects' identifiers seperated by ','.)

List of unique projects' identifiers seperated by ','.

False

validatorName

string

(Filter with the name of the project validator.)

Filter with the name of the project validator.

False

projectReferenceOrExternalId

string

(Filter with the reference or the external id of the project.)

Filter with the reference or the external id of the project.

False

bringAllProjects

boolean

(Bring the projects that are not shared with all employees.)

Bring the projects that are not shared with all employees.

False

projectUseType

integer

(Format - enum. Project use type flag.)

Format - enum. Project use type flag: Invoice = 0x1 Purchase = 0x2 Subscription = 0x4 Advance = 0x8 MissionOrder = 0x10 MileageOnly = 0x20 InvoiceOnly = 0x40 VirtualCard = 0x80.

False

isActive

boolean

(Bring only active projects.)

Bring only active projects.

False

tagsNames

string

(List of tags' names seperated by ','.)

List of tags' names seperated by ','.

False

customFieldsIds

string

(List of unique custom fields' identifiers seperated by ','.)

List of unique custom fields' identifiers seperated by ','.

False

expenseDate

string

(The date of the expense. Format - date-time (as date-time in RFC3339).)

The date of the expense. Format - date-time (as date-time in RFC3339).

False

userId

string

(Filter with the unique identifier of expense's owner.)

Filter with the unique identifier of expense's owner.

False

page

integer

(The page number.)

The page number.

False

pageSize

integer

(The number of elements per page.)

The number of elements per page.

False

sortBy

integer

(Format - enum. Sort the list by.)

Format - enum. Sort the list by : StartDate = 11 EndDate = 12 Name = 20 ProjectRef = 21 FullName = 22 Validator = 23 ClientName = 24 Value = 25.

False

isDesc

boolean

(Order the list by desc or asc.)

Order the list by desc or asc.

False

 

Returns:

          Type:ListAndPagesCountResultProjectResponse

 

UpdateProjectStateV2

Summary: Update Projects State

Description: Batch update list of projects state.

 

Syntax:

Expensya.UpdateProjectStateV2 ([Optional]UpdateProjectStateInput updateProjectStateInput)

 

Parameters:

Name

Type

Summary

Required

Related Action

updateProjectStateInput

UpdateProjectStateInput

 

 

False

 

Returns:

          Type:BaseResultListAddOrUpdateEntityResult

 

AddQuickExpenseV2

Summary: Add QuickExpense

Description: Add a new expense to your expensya account.

 

Syntax:

Expensya.AddQuickExpenseV2 (string userId, [Optional]QuickExpenseInput quickExpenseInput)

 

Parameters:

Name

Type

Summary

Required

Related Action

userId

string

(Format - guid. Unique identifier of the user that expense will be linked to.)

Format - guid. Unique identifier of the user that expense will be linked to.

True

quickExpenseInput

QuickExpenseInput

 

 

False

 

Returns:

          Type:BaseResult

 

RefreshUserTokenV2

Summary: Refresh Token

Description: Refresh your userToken.

 

Syntax:

Expensya.RefreshUserTokenV2 ()

 

Returns:

          Type:LoginResponse

 

UpdateReportStatus

Summary: Update Report Status

Description: Update the statuts of the report.

 

Syntax:

Expensya.UpdateReportStatus (string reportId, [Optional]ReportUpdateStatusInput reportUpdateStatusInput)

 

Parameters:

Name

Type

Summary

Required

Related Action

reportId

string

(Format - guid. Unique identifier of the report.)

Format - guid. Unique identifier of the report.

True

reportUpdateStatusInput

ReportUpdateStatusInput

 

 

False

 

Returns:

          Type:BaseResult

 

GetReportHistoryV2

Summary: Get Report History

Description: Get the history of the report.

 

Syntax:

Expensya.GetReportHistoryV2 (string reportId)

 

Parameters:

Name

Type

Summary

Required

Related Action

reportId

string

(Filter with the unique Identifier of the report.)

Filter with the unique Identifier of the report.

True

 

Returns:

          Type:BaseResultListEventResponse

 

CompanyReports

Summary: Get Reports

Description: Get the list of reports with paging.

 

Syntax:

Expensya.CompanyReports ([Optional]string reportName, [Optional]string reportStartDate, [Optional]string reportEndDate, [Optional]string reportStates, [Optional]string reportIdShort, [Optional]string ownerId, [Optional]string ownerPayId2, [Optional]string projectId, [Optional]string tagsNames, [Optional]integer dateFilterType, [Optional]integer sortBy, [Optional]integer page, [Optional]integer pageSize, [Optional]boolean isDesc)

 

Parameters:

Name

Type

Summary

Required

Related Action

reportName

string

(Filter with the name of the report.)

Filter with the name of the report.

False

reportStartDate

string

(Filter with the start date based on dateFilterType (as date-time in RFC3339).)

Filter with the start date based on dateFilterType. Format - date-time (as date-time in RFC3339).

False

reportEndDate

string

(Filter with the end date based on dateFilterType (as date-time in RFC3339).)

Filter with the end date based on dateFilterType. Format - date-time (as date-time in RFC3339).

False

reportStates

string

(List of report states seperated by ','.)

List of report states seperated by ',' : Active = 0 Submitted = 2 Rejected = 3 Closed = 5 ValidatedAndExported = 6 Reimbursed = 7 PreSubmitted = 8 InValidation = 50.

False

reportIdShort

string

(Filter with the report inetrnal identifier.)

Filter with the report inetrnal identifier.

False

ownerId

string

(Filter with the unique identifier of the report's owner.)

Filter with the unique identifier of the report's owner.

False

ownerPayId2

string

(Filter with the serial of the report's owner.)

Filter with the serial of the report's owner.

False

projectId

string

(Filter with the unique identifier of the project that the report is linked to.)

Filter with the unique identifier of the project that the report is linked to.

False

tagsNames

string

(List of tags' names seperated by ','.)

List of tags' names seperated by ','.

False

dateFilterType

integer

(Format - enum. Indicates the target of date filters.)

Format - enum. Indicates the target of date filters: InvoiceDate = 1 ValidationDate = 2 AccountingValidationDate = 3 SubmissionDate = 4 PurchaseAccountingValidationDate = 5 CreationDate = 6

False

sortBy

integer

(Format - enum. List can be sorted by.)

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

False

page

integer

(The page number.)

The page number.

False

pageSize

integer

(The number of elements per page.)

The number of elements per page.

False

isDesc

boolean

(Order the list by desc or asc.)

Order the list by desc or asc.

False

 

Returns:

          Type:ListAndPagesCountResultReportResponse

 

InviteUserV2

Summary: Invite User

Description: Add user to Expensya.

 

Syntax:

Expensya.InviteUserV2 ([Optional]UserInviteInput userInviteInput)

 

Parameters:

Name

Type

Summary

Required

Related Action

userInviteInput

UserInviteInput

 

 

False

 

Returns:

          Type:BaseResult

 

UpateUserV2

Summary: Update User

Description: Update user already added in Expensya.

 

Syntax:

Expensya.UpateUserV2 (string userId, boolean shouldUpdateValidators, [Optional]UserUpdateInput userUpdateInput)

 

Parameters:

Name

Type

Summary

Required

Related Action

userId

string

(Format - guid. Unique identifier of the user to update.)

Format - guid. Unique identifier of the user to update.

True

shouldUpdateValidators

boolean

(Shows if the validators of the user should be updated or not.)

Shows if the validators of the user should be updated or not.

True

userUpdateInput

UserUpdateInput

 

 

False

 

Returns:

          Type:BaseResult

 

CompanyUsers

Summary: Get Users

Description: Get the list of users with paging.

 

Syntax:

Expensya.CompanyUsers ([Optional]string id, [Optional]string firstName, [Optional]string lastName, [Optional]string mail, [Optional]string payId, [Optional]string mailOrNameOrPayId, [Optional]integer type, [Optional]integer state, [Optional]string reviewerId, [Optional]string reviewerName, [Optional]string managerId, [Optional]string managerName, [Optional]string userIds, [Optional]string userMails, [Optional]string tagsNames, [Optional]string simpleTagsNames, [Optional]integer sortBy, [Optional]integer page, [Optional]integer pageSize, [Optional]boolean isDesc)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(Filter with the unique identifier of the user.)

Filter with the unique identifier of the user.

False

firstName

string

(Filter with the first name of the user.)

Filter with the first name of the user.

False

lastName

string

(Filter with the last name of the user.)

Filter with the last name of the user.

False

mail

string

(Filter with the mail of the user.)

Filter with the mail of the user.

False

payId

string

(Filter with the serial the user.)

Filter with the serial the user.

False

mailOrNameOrPayId

string

(Filter with the mail or name or serial of the user.)

Filter with the mail or name or serial of the user.

False

type

integer

(Format - enum. Enum flag attribute which is the type of the user.)

Format - enum. Enum flag attribute which is the type of the user : Employee = 1 Administrator = 2 Accountant = 4

False

state

integer

(Format - enum. Enum flag attribute which is the user state.)

Format - enum. Enum flag attribute which is the user state : Validated = 1 Active = 2.

False

reviewerId

string

(Filter with the unique identifier of the user's first validator.)

Filter with the unique identifier of the user's first validator.

False

reviewerName

string

(Filter with the name of the user's reviwer.)

Filter with the name of the user's reviwer.

False

managerId

string

(Filter with the unique identifier of the user's second validator.)

Filter with the unique identifier of the user's second validator.

False

managerName

string

(Filter with the name of the user's manager.)

Filter with the name of the user's manager.

False

userIds

string

(List of unique identifiers of the users seperated by ','.)

List of unique identifiers of the users seperated by ','.

False

userMails

string

(List of e-mails of the users seperated by ','.)

List of e-mails of the users seperated by ','.

False

tagsNames

string

(List of tags' names seperated by ','.)

List of tags' names seperated by ','.

False

simpleTagsNames

string

(List of simple tags' names seperated by ','.)

List of simple tags' names seperated by ','.

False

sortBy

integer

(Format - enum. List can be sorted by.)

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

False

page

integer

(The page number.)

The page number.

False

pageSize

integer

(The number of elements per page.)

The number of elements per page.

False

isDesc

boolean

(Order the list by desc or asc.)

Order the list by desc or asc.

False

 

Returns:

          Type:ListAndPagesCountResultUserResponse

 

UpdateUsersStateV2

Summary: Update Users Status

Description: Update expensya users status.

 

Syntax:

Expensya.UpdateUsersStateV2 ([Optional]array updateUserStateInputArray)

 

Parameters:

Name

Type

Summary

Required

Related Action

updateUserStateInputArray

array of (UpdateUserStateInput)

 

 

False

 

Returns:

          Type:BaseResultListUpdateUserResult

 


 

AddOrUpdateEntityResult

Summary:

Description:

 

          Properties:

Name

Type

Summary

Id

string(guid)

 

Unique identifier of the updated project.

ExternalId

string

 

The External identifier of the updated project.

ResultCode

integer(enum)

 

Expensya response internal codes:       Success = 0      PartialSuccess = 1,      InvalidData = 7,      NotAdmin = 20,      NotAllowed = 30,      Failed = 70,      NothingToDo = 91,      AlreadyExists = 1006...   Values: [, , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , ]

Message

string

 

Extra details sent by the server.


 

AddOrUpdateProjectInput

Summary:

Description:

 

          Properties:

Name

Type

Summary

HasBillable

boolean

 

Specifies if expenses assigned to this project can be billable to client or not.

StartDate

string(date-time)

 

 

EndDate

string(date-time)

 

 

IsActive

boolean

 

If the project is active or not.

MileageConfigurations

string

 

Mileage Configurations of the project.

Address

string

 

Address of the project.

ZipCode

string

 

Zip code of the project.

City

string

 

City of the project.

ExternalId

string

 

External identifier of the project.

Name

string

 

Name of the project.

ProjectRef

string

 

Reference of the project.

Validator_Id

string(guid)

 

Unique identifier of the project validator.

Reviewer_Id

string(guid)

 

Unique identifier of the project reviewer.

ClientName

string

 

Name of the client.

ForAllCompany

boolean

 

If the project is for all company or not.

IsBillableDefaultValue

boolean

 

Expenses assigned to the project are billable by default.

PayId2

string

 

First analytical axis.

Currency

string

 

Currency of the project.

ExtraData

string

 

Extrat data for the project.

ProjectUseType

integer(enum)

 

Enum flag attribute which is the use type of the project:       Invoice = 1      Purchase = 2      Subscription = 4      Advance = 8      MissionOrder = 16      MileageOnly = 32      InvoiceOnly = 64      VirtualCard = 128    Values: [, , , , , , , ]

Description

string

 

Description about the project.

CategoriesIds

string

 

Unique identifiers of the categories.If it's empty, the project will be applicable to all categories.

TagsToAssign

array of (string)

 

List of tags' names that will be assigned to the project.

TagsToUnassign

array of (string)

 

List of tags' names that will be unassigned from the project.


 

AddReceiptInput

Summary:

Description:

 

          Properties:

Name

Type

Summary

UserId

string

 

Unique identifier of the user.

ReceiptContent

string

 

Content of the receipt on base 64.

ReceiptName

string

 

Name of the receipt.


 

BaseResult

Summary:

Description:

 

          Properties:

Name

Type

Summary

ResultCode

integer(enum)

 

Expensya response internal codes:       Success = 0      PartialSuccess = 1,      InvalidData = 7,      NotAdmin = 20,      NotAllowed = 30,      Failed = 70,      NothingToDo = 91,      AlreadyExists = 1006...   Values: [, , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , ]

Message

string

 

Extra details sent by the server.


 

BaseResultExportResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

ResultItem

ExportResponse

 

 

ResultCode

integer(enum)

 

Expensya response internal codes:       Success = 0      PartialSuccess = 1,      InvalidData = 7,      NotAdmin = 20,      NotAllowed = 30,      Failed = 70,      NothingToDo = 91,      AlreadyExists = 1006...   Values: [, , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , ]

Message

string

 

Extra details sent by the server.


 

BaseResultListAddOrUpdateEntityResult

Summary:

Description:

 

          Properties:

Name

Type

Summary

ResultItem

array of (AddOrUpdateEntityResult)

 

Item sent by the server.

ResultCode

integer(enum)

 

Expensya response internal codes:       Success = 0      PartialSuccess = 1,      InvalidData = 7,      NotAdmin = 20,      NotAllowed = 30,      Failed = 70,      NothingToDo = 91,      AlreadyExists = 1006...   Values: [, , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , ]

Message

string

 

Extra details sent by the server.


 

BaseResultListEventResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

ResultItem

array of (EventResponse)

 

Item sent by the server.

ResultCode

integer(enum)

 

Expensya response internal codes:       Success = 0      PartialSuccess = 1,      InvalidData = 7,      NotAdmin = 20,      NotAllowed = 30,      Failed = 70,      NothingToDo = 91,      AlreadyExists = 1006...   Values: [, , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , ]

Message

string

 

Extra details sent by the server.


 

BaseResultListExportFormatResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

ResultItem

array of (ExportFormatResponse)

 

Item sent by the server.

ResultCode

integer(enum)

 

Expensya response internal codes:       Success = 0      PartialSuccess = 1,      InvalidData = 7,      NotAdmin = 20,      NotAllowed = 30,      Failed = 70,      NothingToDo = 91,      AlreadyExists = 1006...   Values: [, , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , ]

Message

string

 

Extra details sent by the server.


 

BaseResultListUpdateUserResult

Summary:

Description:

 

          Properties:

Name

Type

Summary

ResultItem

array of (UpdateUserResult)

 

Item sent by the server.

ResultCode

integer(enum)

 

Expensya response internal codes:       Success = 0      PartialSuccess = 1,      InvalidData = 7,      NotAdmin = 20,      NotAllowed = 30,      Failed = 70,      NothingToDo = 91,      AlreadyExists = 1006...   Values: [, , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , ]

Message

string

 

Extra details sent by the server.


 

BaseResultProjectResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

ResultItem

ProjectResponse

 

 

ResultCode

integer(enum)

 

Expensya response internal codes:       Success = 0      PartialSuccess = 1,      InvalidData = 7,      NotAdmin = 20,      NotAllowed = 30,      Failed = 70,      NothingToDo = 91,      AlreadyExists = 1006...   Values: [, , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , ]

Message

string

 

Extra details sent by the server.


 

BrokenRuleResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

Id

string(guid)

 

Unique identifier of the broken rule.

Name

string

 

Name of the broken rule.

Description

string

 

Description of the broken rule.

DescriptionForCredit

string

 

Description for credit of the broken rule.

Budget

number(decimal)

 

Budget of the broken rule.

RuleType

integer(enum)

 

Type of the broken rule :       Mandatory = 0      Warning = 1      ReimbursableByCeiling = 2      ReimbursableByFlatRate = 3    Values: [, , , ]

Currency

string

 

Currency of the broken rule.

AllowExceptions

boolean

 

Shows if exceptions are allowed in broken rule.

RuleElementType

integer(enum)

 

Type of the rule element :       Invoices = 0      VirtualCards = 1    Values: [, ]

IntervalType

integer(enum)

 

Type of the interval of the broken rule :       Day = 0      WeekDays = 1      Month = 2      Year = 3      Invoice = 4    Values: [, , , , ]

Language

string

 

Language of the broken rule.

RuleCurrenciesWithBudget

TupleStringDecimal

 

 

ForAllCompany

boolean

 

Shows if the broken rule is for all company or not.


 

CategoryResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

Id

string(guid)

 

Unique identifier of the category.

Name

string

 

Name of the category.

EntityName

string

 

Entity Name of the category.

Parent

string

 

Parent of the category (category can be linked to an other categroy).

Description

string

 

Description of the category.

PrimitiveCategories

string

 

Sub categories.

ParentCategory_Id

string(guid)

 

Unique parent identifier of the category (category can be linked to an other categroy).

IsActive

boolean

 

Shows if the category is active or not.

IsActiveAsDefault

boolean

 

Default category when user add new expense.

CostAccount

string

 

Cost account of the category.

VatAccount

string

 

VAT account of the category.

ExtraData

string

 

Additional informations about the category.

CreationDate

string(date-time)

 

Creation date of the category. Respects the standard ISO 8601 date format. e.g: 2018-06-04T08:30:15.023Z

VatClaimRate

number(decimal)

 

VAT claim rate of the category.

VatClaimRates

string

 

VAT claim rate of the category by year.

CategoryUseType

integer(enum)

 

Category use type :       Invoices = 1      Purchases = 2      Subscriptions = 4    Values: [, , ]

ExternalId

string

 

External identifier of the category.

IsReadOnly

boolean

 

Shows if the category is just read only.

CategoryTags

array of (TagResponse)

 

List of tags of the category.


 

EventResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

EventDate

string(date-time)

 

Date of the event. Respects the standard ISO 8601 date format. e.g: 2018-06-04T08:30:15.023Z

EventType

integer(enum)

 

Type of the event: submitMission, validateMission...      SubmitMission = 1      ValidateMission = 2      RejectMission = 3      ReimburseMission = 4      CloseMission = 5      CommentMission = 6      ValidateAndExportMission = 7      UpdateInvoiceByValidator = 8      CreateMission = 9      ExportMission = 10      ExportMissionToQuickBooks = 11      PreSubmitMission = 12      ReviewAndSubmitMission = 13      UpdateAccountingPeriodByAdminOrAccountant = 14      AddUserCollectorConnection = 15      UpdateUserCollectorConnection = 16      GetUserCollectedBills = 17      StopAutoRenew = 18      ValidateUserCollectorConnection = 19      SwitchAsDelegatedUser = 20      DeleteUserCollectorConnection = 21      ExportMissionToIbiza = 22      ValidateVirtualCard = 23      RejectVirtualCard = 24      RequestVirtualCard = 25      RequestVirtualCardAndAutoApproved = 26      ValidatedPurchaseByAccountant = 27      AutoValidateMission = 28      AddProPaymentInstrument = 29      UpdateProPaymentInstrument = 30      DisableVirtualCard = 31      ExportMissionToInexweb = 32      ExportPurchaseToSapByDesign = 33      CreateRule = 34      DeleteRule = 35      UpdateRule = 36      DeleteMission = 37      RestoreMission = 38      AutoValidateAndExportMission = 39      DisconnectIntegration = 41      ExportMissionToVSA = 42      ExportInvoiceToSiebel = 43      CreateInvoice = 97      DeleteInvoice = 98      UpdateInvoice = 99      AddTag = 100      UpdateTag = 101      DeleteTag = 102      AddCompanyIntegrationSettings = 103      UpdateCompanyIntegrationSettings = 104      IntegrationStart = 105      IntegrationComplete = 106      IgnoreMissionInExport = 107      AttachCompanyToPartner = 108      PreSubmitVirtualCard = 109      ApproveVirtualCard = 110      CommentVirtualCard = 111      ReviewAndSubmitVirtualCard = 112      AutoImport = 113      AutoExport = 114      Export = 115      Import = 116      SubmitVehicle = 117      ValidateVehicle = 118      ApproveVehicle = 119      RejectVehicle = 120      CommentVehicle = 121      DisableVehicle = 122      PreSubmitVehicle = 123      AutoApproveVehicle = 124      AddBalanceExport = 125      Payment = 126      ReSubmitVehicleAfterApproval = 127      ExportMissionByAPI = 128      SplitMissionInvoicesByProblems = 129    Values: [, , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , ]

UserId

string(guid)

 

Unique identifier of the user.

UserLastName

string

 

Last name of the user.

UserFirstName

string

 

First name of the user.

UserMail

string

 

Mail of the user.

Description

string

 

Description of the evnt


 

ExpenseResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

Id

string(guid)

 

Unique identifier of the expense.

Name

string

 

Name of the expense.

Value

number(decimal)

 

Value of the expense.

ValueToReimburse

number(decimal)

 

Value to reimbures of the expense.

ReimbursementRate

number(decimal)

 

Reimbursement rate of the expense.

Description

string

 

Description of the expense.

UseType

integer(enum)

 

Type of the expense :       Invoice = 1      Advance = 2      Purchase = 4      Subscription = 8      MissionOrder = 16    Values: [, , , , ]

DateCreation

string(date-time)

 

Creation date of the expense. Respects the standard ISO 8601 date format. e.g: 2018-06-04T08:30:15.023Z

DateInvoice

string(date-time)

 

Date of the expense. Respects the standard ISO 8601 date format. e.g: 2018-06-04T08:30:15.023Z

DateUtcOffset

number(double)

 

Date offset of the expense.

HasPhoto

boolean

 

Shows if the expense has photo.

Currency

string

 

Currency of the expense.

ValueInCurrency

number(decimal)

 

Value in currency of the owner of the expense.

ValueInLocalCurrency

number(decimal)

 

Value in local currency of the owner of the expense.

MerchantInvoiceId

string

 

Merchant Invoice external identifier

MerchantCountry

string

 

Merchant country of the expense.

MerchantCity

string

 

Merchant city of the expense.

MerchantZipCode

string

 

Merchant zip code of the expense.

MerchantAddress

string

 

Merchant address of the expense.

MerchantName

string

 

Merchant name of the expense

MerchantVatNumber

string

 

Merchant VAT number of the expense.

Units

number(decimal)

 

Number of units of the expense.

State

integer(enum)

 

State of the expense :       Uploading = 0      Uploaded = 1      Ready = 2      Validated = 3      ValidatedByAccountant = 4      Rejected = 99    Values: [, , , , , ]

VAT

VATResponse

 

 

VATAvgRate

number(decimal)

 

VAT rate of the expense.

AttachedFilesCount

integer(int32)

 

Number of attached files to the expense.

ToReimburse

boolean

 

Shows if the expense is to reimburse.

IsBillable

boolean

 

Shows if the expense is billable to client.

CustomFields

array of (KeyValuePairGuidString)

 

Custom fields of the expense.

FileType

string

 

File type of the expense.

DefaultRate

number(decimal)

 

Default rate of the expense.

CreditSource_Id

string(guid)

 

Unique credit source identifier of the expense.

User_Id

string(guid)

 

Unique user identifier of the expense.

Project

ProjectResponse

 

 

Report

ReportResponse

 

 

PaymentInstrument

PaymentInstrumentResponse

 

 

Vehicle

VehicleResponse

 

 

TransactionsSumValue

number(decimal)

 

Transactions sum value of the expense.

TransactionsSumInCurrency

number(decimal)

 

Transactions sum value in currency of the expense.

TransactionsSumInLocalCurrency

number(decimal)

 

Transactions sum value in Local currency of the expense.

PerdiemCountry

string

 

Country of the perdiem.

PerdiemCalculationPeriodType

integer(enum)

 

Type of the perdiem calculation period :       CalendarDay = 0      TwentyFourHours = 1    Values: [, ]

PerDiemType

integer(enum)

 

Type of the perdiem :       Time = 0      Distance = 1      IEG = 2    Values: [, , ]

Category

CategoryResponse

 

 

BrokenRules

array of (BrokenRuleResponse)

 

List of broken rules of the expense.

IsMileage

boolean

 

Shows if the expense is Mileage.

CategoryExtraDataStr

string

 

Extra date for the category of the expense.

Guests

array of (GuestResponse)

 

List of guests of the expense.

SubStatus

integer(enum)

 

Enum flag attribute which is the substatus of the expense :       All = 0      Exported = 2      Payed = 4      ExportedToIbiza = 8      RecordedByInexweb = 16      ExportedToQBO = 32      ExportedToInexweb = 64      RejectedByInexweb = 128      ExportedToVSA = 256      ExportedBalance = 512      ExportedToSiebel = 1024    Values: [, , , , , , , , , , ]

OwnerPayId

string

 

Serial of the owner of the expense.

OwnerPayId2

string

 

First analytical axis of the owner of the expense.

OwnerPayId3

string

 

Second analytical axis of the owner of the expense.

OwnerPayId4

string

 

Third analytical axis of the owner of the expense.

OwnerPayId5

string

 

Fourth analytical axis of the owner of the expense.

OwnerPayId6

string

 

Fifth analytical axis of the owner of the expense.

ExpenseTags

array of (TagResponse)

 

List of tag of the expense.


 

ExportFormatResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

Id

string(guid)

 

Unique identifier of the export format.

Name

string

 

The name of export format.

Extension

string

 

The extension of the export format.

CodePath

string

 

Unique code path of the export format.

MissionExport

boolean

 

Shows if the export format is available for reports.

InvoicesExport

boolean

 

Shows if the export format is available for expenses.

AutoExport

boolean

 

Shows if it's an auto export format.

LastAutoExportDate

string(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

Summary:

Description:

 

          Properties:

Name

Type

Summary

FileUrl

string

 

The url of the exported file.

FileExtension

string

 

The extension of the exported file.

FileName

string

 

The name of the exported file.


 

GuestResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

Mail

string

 

Mail of the guest.

FullName

string

 

Full name of the guest.

Id

string(guid)

 

Unique identifier of the guest.

IsCoworker

boolean

 

Shows if the guest is coworker or not.


 

KeyValuePairGuidString

Summary:

Description:

 

          Properties:

Name

Type

Summary

Key

string(guid)

 

 

Value

string

 

 


 

ListAndPagesCountResultCategoryResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

List

array of (CategoryResponse)

 

List of elements to return.

PagesCount

integer(int32)

 

Total number of pages.

TotalListCount

integer(int32)

 

Total number of elements per page.

ResultCode

integer(enum)

 

Expensya response internal codes:       Success = 0      PartialSuccess = 1,      InvalidData = 7,      NotAdmin = 20,      NotAllowed = 30,      Failed = 70,      NothingToDo = 91,      AlreadyExists = 1006...   Values: [, , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , ]

Message

string

 

Extra details sent by the server.


 

ListAndPagesCountResultExpenseResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

List

array of (ExpenseResponse)

 

List of elements to return.

PagesCount

integer(int32)

 

Total number of pages.

TotalListCount

integer(int32)

 

Total number of elements per page.

ResultCode

integer(enum)

 

Expensya response internal codes:       Success = 0      PartialSuccess = 1,      InvalidData = 7,      NotAdmin = 20,      NotAllowed = 30,      Failed = 70,      NothingToDo = 91,      AlreadyExists = 1006...   Values: [, , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , ]

Message

string

 

Extra details sent by the server.


 

ListAndPagesCountResultProjectResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

List

array of (ProjectResponse)

 

List of elements to return.

PagesCount

integer(int32)

 

Total number of pages.

TotalListCount

integer(int32)

 

Total number of elements per page.

ResultCode

integer(enum)

 

Expensya response internal codes:       Success = 0      PartialSuccess = 1,      InvalidData = 7,      NotAdmin = 20,      NotAllowed = 30,      Failed = 70,      NothingToDo = 91,      AlreadyExists = 1006...   Values: [, , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , ]

Message

string

 

Extra details sent by the server.


 

ListAndPagesCountResultReportResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

List

array of (ReportResponse)

 

List of elements to return.

PagesCount

integer(int32)

 

Total number of pages.

TotalListCount

integer(int32)

 

Total number of elements per page.

ResultCode

integer(enum)

 

Expensya response internal codes:       Success = 0      PartialSuccess = 1,      InvalidData = 7,      NotAdmin = 20,      NotAllowed = 30,      Failed = 70,      NothingToDo = 91,      AlreadyExists = 1006...   Values: [, , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , ]

Message

string

 

Extra details sent by the server.


 

ListAndPagesCountResultUserResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

List

array of (UserResponse)

 

List of elements to return.

PagesCount

integer(int32)

 

Total number of pages.

TotalListCount

integer(int32)

 

Total number of elements per page.

ResultCode

integer(enum)

 

Expensya response internal codes:       Success = 0      PartialSuccess = 1,      InvalidData = 7,      NotAdmin = 20,      NotAllowed = 30,      Failed = 70,      NothingToDo = 91,      AlreadyExists = 1006...   Values: [, , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , ]

Message

string

 

Extra details sent by the server.


 

LoginResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

Id

string(guid)

 

 

UserToken

string

 

 

LastName

string

 

 

FirstName

string

 

 

Address

string

 

 

City

string

 

 

PhoneNumber

string

 

 

Mail

string

 

 

ZipCode

string

 

 

MailAlias

string

 

 

Language

string

 

 

CreationDate

string(date-time)

 

 

CountryCode

string

 

 

FaxNumber

string

 

 

Currency

string

 

 

ShemaVersion

integer(int32)

 

 

Company_Id

string(guid)

 

 

Login_Id

string(guid)

 

 

Manager_Id

string(guid)

 

 

UserType

integer(enum)

 

None = 0      Employee = 1      Administrator = 2      Accountant = 4      CanRefund = 8      NotDisabledInImport = 16      NotUpdatedInImport = 32      UserTypeToIgnore = 56

UserRole

integer(enum)

 

All = 0      Users = 2      Missions = 4      Invoices = 8      Projects = 16      Rules = 32      Settings = 64      Integrations = 128      SubscriptionAndBills = 256      BiReports = 512      Categories = 1024      Mileage = 2048      ReadOnly = 4096      Vehicles = 8192      SuppliersManagement = 16384      Advances = 32768      VirtualPayment = 65536      Purchases = 131072      CustomFields = 262144      ProPaymentInstruments = 524288      MissionOrders = 1048576      BankAccounts = 2097152      Bookings = 4194304      Contact = 8388608      IntegrationsHistory = 16777216      TechnicalIntegration = 33554432      Reimbursements = 67108864

UserTokenDurationSeconds

integer(uint64)

 

 

ResultCode

integer(enum)

 

Expensya response internal codes:       Success = 0      PartialSuccess = 1,      InvalidData = 7,      NotAdmin = 20,      NotAllowed = 30,      Failed = 70,      NothingToDo = 91,      AlreadyExists = 1006...   Values: [, , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , ]

Message

string

 

Extra details sent by the server.


 

PaymentInstrumentResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

Name

string

 

Name of the payment instrument.

Description

string

 

Description of the payment instrument.

IsActive

boolean

 

Shows if the payment instrument is active or not.

InstrumentType

integer(enum)

 

Type of the payment instrument :       Cash = 0      Card = 1      Check = 2      EWallet = 3      Coupon = 4      Wire = 5      Bank = 6      Other = 99    Values: [, , , , , , , ]

AccountType

integer(enum)

 

Type of the payment instrument account :       None = 0      Professional = 1      Personal = 2    Values: [, , ]

LastDigits

string

 

Last digits of the payment instrument.

CardKey

string

 

Card key of the payment instrument.

JournalCode

string

 

Journal code of the payment instrument.

Auxiliary

string

 

Auxiliary account of the payment instrument.

AccountNumber

string

 

Account number of the payment instrument.


 

ProjectResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

Id

string(guid)

 

Unique identifier of the project.

HasBillable

boolean

 

Project is billable to client.

StartDate

string(date-time)

 

Start date of the project. Respects the standard ISO 8601 date format. e.g: 2018-06-04T08:30:15.023Z

EndDate

string(date-time)

 

End date of the project. Respects the standard ISO 8601 date format. e.g: 2018-06-04T08:30:15.023Z

IsActive

boolean

 

Show if the project is Active.

MileageConfigurationsStr

string

 

Mileage configuration of the project.

Address

string

 

Address of the project.

ZipCode

string

 

Zip code of the project.

City

string

 

City of the project.

ExternalId

string

 

External identifier of the project.

Name

string

 

Name of the Project.

ProjectRef

string

 

Reference of the project

Validator_Id

string(guid)

 

Unique validator identifier of the project.

Reviewer_Id

string(guid)

 

Unique  reviwer identifier of the project.

ClientName

string

 

Client name of the project.

ForAllCompany

boolean

 

Project is shared with all users.

IsBillableDefaultValue

boolean

 

Project is by default billable to client.

PayId2

string

 

Second Analytical axis relevant to the project.

Currency

string

 

Currency of the project.

ExtraData

string

 

Additional informations about the project.

ProjectUseType

integer(enum)

 

Enum flag attribute that shows to which entity the project will be applied to :       Invoice = 1      Purchase = 2      Subscription = 4      Advance = 8      MissionOrder = 16      MileageOnly = 32      InvoiceOnly = 64      VirtualCard = 128    Values: [, , , , , , , ]

CustomField_Id

string(guid)

 

Unique custom field identifier related to the project.

CustomFieldParent_Id

string(guid)

 

Unique parent custom Field identifier related to the project.

CategoriesIdsStr

string

 

Categories identifiers relevant to the project.

ValidatorFullName

string

 

Validator full name of the project.

ValidatorMail

string

 

Validator mail of the project.

ReviewerFullName

string

 

Reviwer full name of the project.

ReviewerMail

string

 

Reviewer mail of the project.

IsReadOnly

boolean

 

Shows if the project is just read only.

ProjectTags

array of (TagResponse)

 

List of tags of the project.


 

QuickExpenseInput

Summary:

Description:

 

          Properties:

Name

Type

Summary

FileToSend

string

 

The file to Send on bease64.

Title

string

 

Title of the expense.

TransactionAmount

number(decimal)

 

Transaction amount of the expense.

VatRates

string

 

Vate rates of the expense.

VatAmounts

string

 

Vate amounts of the expense.

CurrencyCode

string

 

Currency code of the expense.

TransactionDate

string(date-time)

 

 

MerchantName

string

 

Merchant name of the expense.

LocationCountry

string

 

Location country of the expense.

LocationCity

string

 

Location city of the expense.

Comment

string

 

Comment of the expense.

MerchantExpenseId

string

 

Unique expense identifier of the merchant.

IsEncrypted

boolean

 

If the expense is encrypted ot not.

ExpenseUseType

integer(enum)

 

Enum flag attribute which is the use type of the expense:       Invoice = 1      Advance = 2      Purchase = 4      Subscription = 8      MissionOrder = 16    Values: [, , , , ]

PaymentTypeCode

string

 

Payment type code of the expense.

ExpenseTypeCode

string

 

Type code of the expense.

FileType

string

 

File type of the expense.


 

ReportResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

Id

string(guid)

 

Unique report identifier.

Name

string

 

Name of the report.

DateCreation

string(date-time)

 

Creation date of the report. Respects the standard ISO 8601 date format. e.g: 2018-06-04T08:30:15.023Z

Budget

number(decimal)

 

Budget of the report.

State

integer(enum)

 

State of the report : Active, rejected, valideted...      Active = 0      Submitted = 2      Rejected = 3      Validated = 4      Closed = 5      ValidatedAndExported = 6      Reimbursed = 7      PreSubmitted = 8      InValidation = 50    Values: [, , , , , , , , ]

User_Id

string(guid)

 

Unique identifier of report's owner.

UserLastName

string

 

Last name of report's owner.

UserFirstName

string

 

First name of report's owner.

UserMail

string

 

Mail of report's owner.

Manager_Id

string(guid)

 

Unique manager identifier of the report's user.

Accountant_Id

string(guid)

 

Unique accountant identifier of the report's user.

Reviewer_Id

string(guid)

 

Unique reviwer identifier of the report's user

InvoicesCount

integer(int32)

 

Invoices count related to the report.

Value

number(decimal)

 

Value of the report.

ValueToReimburse

number(decimal)

 

Value to reimburse of the report.

ValueInLocalCurrency

number(decimal)

 

Value in user local currency of the report.

ValueToReimburseInLocalCurrency

number(decimal)

 

Value to reimburse in user local currency of the report.

StartDate

string(date-time)

 

Start date of the report. Respects the standard ISO 8601 date format. e.g: 2018-06-04T08:30:15.023Z

EndDate

string(date-time)

 

End date of the report. Respects the standard ISO 8601 date format. e.g: 2018-06-04T08:30:15.023Z

UserCurrency

string

 

User currency of the report.

UserLocalCurrency

string

 

User local currency of the report.

IdShort

string

 

Auto-generated identifier of the report.

CurrentValidator_Id

string(guid)

 

Unique current validator identifier of the report.

InvoiceAttachedFilesCount

integer(int32)

 

Expense attached file count relevant to the report.

ReportTags

array of (TagResponse)

 

List of tags of the report.


 

ReportUpdateStatusInput

Summary:

Description:

 

          Properties:

Name

Type

Summary

Operation

integer(enum)

 

The operation type that will be apply to the report.      None = 0      Submit = 2      Reject = 3      Validate = 4      Close = 5      ValidateAndExport = 6      Reimburse = 7      ValidatedByAccountant = 8      Tag = 9      CloseAndTag = 10      Disable = 11    Values: [, , , , , , , , , , ]

Message

string

 

The update comment that will be show to the owner's report.

InvoiceIdsToReject

array of (string(guid))

 

List of the invoice that will be reject.

AccountingPeriod

string

 

The accounting period of the report.


 

TagResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

Id

string(guid)

 

Unique identifier of the tag.

Name

string

 

Name of the tag.

Description

string

 

Description of the tag.

CreationDate

string(date-time)

 

Creation date of the tag. Respects the standard ISO 8601 date format. e.g: 2018-06-04T08:30:15.023Z

IsActive

boolean

 

Shows if the tag is active or not.

TagType

integer(enum)

 

Enum attribute which is the type of the tag :       Tag = 1      SimpleTag = 2    Values: [, ]

DefinitionStr

string

 

Definition of the tag.

UseType

integer(enum)

 

Enum attribute which is the use type of the tag :       Invoice = 2      Mileage = 4      Purchase = 8      Subscription = 16      Mission = 32      User = 64      Balance = 128    Values: [, , , , , , ]


 

TupleStringDecimal

Summary:

Description:

 

          Properties:

Name

Type

Summary

Item1

string

 

 

Item2

number(decimal)

 

 


 

UpdateProjectStateInput

Summary:

Description:

 

          Properties:

Name

Type

Summary

ItemIds

array of (string(guid))

 

List of projects' unique identifiers to update.

ProjectState

boolean

 

New state: true for active and false for disable.


 

UpdateUserResult

Summary:

Description:

 

          Properties:

Name

Type

Summary

UserResponse

UserResponse

 

 

ResultCode

integer(enum)

 

Expensya response internal codes:       Success = 0      PartialSuccess = 1,      InvalidData = 7,      NotAdmin = 20,      NotAllowed = 30,      Failed = 70,      NothingToDo = 91,      AlreadyExists = 1006...   Values: [, , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , ]

Message

string

 

Extra details sent by the server.


 

UpdateUserStateInput

Summary:

Description:

 

          Properties:

Name

Type

Summary

UserId

string(guid)

 

Unique identifier of the user.

Operation

integer(enum)

 

Operation that will be applied to the user.      Validate = 2      Activate = 3      Deactivate = 4    Values: [, , ]


 

UserInviteInput

Summary:

Description:

 

          Properties:

Name

Type

Summary

LastName

string

 

Last name of the user.

FirstName

string

 

First name of the user.

Mail

string

 

Mail of the user.

MailAlias

string

 

Mail alias of the user and it should be different from user mail.

PayId

string

 

Serial of the user.

PayId2

string

 

First analytical axis.

PayId3

string

 

Second analytical axis.

PayId4

string

 

Third analytical axis.

PayId5

string

 

Forth analytical axis.

PayId6

string

 

Fifth analytical axis.

Language

string

 

Language of the user: FR, US, SE...

LocalCurrency

string

 

Local currency of the user: EUR, TND, USD...

LocalCountry

string

 

Local country of the user.

ManagerId

string(guid)

 

Unique identifier of the second validator.

ReviewerId

string(guid)

 

Unique identifier of the first validator.

UserType

integer(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 :       None = 0      Employee = 1      Administrator = 2      Accountant = 4      CanRefund = 8      NotDisabledInImport = 16      NotUpdatedInImport = 32      UserTypeToIgnore = 56    Values: [, , , , , , , ]

Vendor

string

 

Name of the vendor

UserRole

integer(enum)

 

Enum flag attribute which is the role of the user :       All = 0      Users = 2      Missions = 4      Invoices = 8      Projects = 16      Rules = 32      Settings = 64      Integrations = 128      SubscriptionAndBills = 256      BiReports = 512      Categories = 1024      Mileage = 2048      ReadOnly = 4096      Vehicles = 8192      SuppliersManagement = 16384      Advances = 32768      VirtualPayment = 65536      Purchases = 131072      CustomFields = 262144      ProPaymentInstruments = 524288      MissionOrders = 1048576      BankAccounts = 2097152      Bookings = 4194304      Contact = 8388608      IntegrationsHistory = 16777216      TechnicalIntegration = 33554432      Reimbursements = 67108864    Values: [, , , , , , , , , , , , , , , , , , , , , , , , , , ]

DefaultProjectId

string(guid)

 

Unique identifier of the user default project.

IKRatesId

string(guid)

 

Unique identifier of the mileage compensation rates.

AdditionalValidators

array of (ValidatorInput)

 

List of additional validators of the user.

TagsToAssign

array of (string)

 

List of tags' names that will be assigned to the user.


 

UserResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

Id

string(guid)

 

Unique identifier of the user.

LastName

string

 

Last name of the user.

FirstName

string

 

First name of the user.

Address

string

 

Address of the user.

PhoneNumber

string

 

Phone Number of the user.

Mail

string

 

Mail of the user.

MailAlias

string

 

Mail alias of the user.

ZipCode

string

 

Zip code of the user.

FaxNumber

string

 

Fax number of the user.

CreationDate

string(date-time)

 

Creation date of the user. Respects the standard ISO 8601 date format. e.g: 2018-06-04T08:30:15.023Z

CountryCode

string

 

Country code of the user.

Language

string

 

Language of the user.

Currency

string

 

Currency of the user.

LocalCurrency

string

 

Local currency of the user.

LocalCountry

string

 

Local country of the user.

CanCreateCategories

boolean

 

Sows if the user has right to create categories.

Manager_Id

string(guid)

 

Unique manager identifier of the user.

AccountantMail

string

 

Accountant mail of the user.

AccountantPayId

string

 

Accountant analytical axis of the user.

UserType

integer(enum)

 

User Type :       None = 0      Employee = 1      Administrator = 2      Accountant = 4      CanRefund = 8      NotDisabledInImport = 16      NotUpdatedInImport = 32      UserTypeToIgnore = 56    Values: [, , , , , , , ]

UserState

integer(enum)

 

User State :       None = 0      Validated = 1      Active = 2    Values: [, , ]

PayId

string

 

Analytacal axis of the user.

PayId2

string

 

Second analytical axis of the user.

PayId3

string

 

Third analytical axis of the user.

PayId4

string

 

Fourth analytical axis of the user

PayId5

string

 

Fifth analytical axis of the user.

PayId6

string

 

Sixth analytical axis of the user.

ManagerFirstName

string

 

Manager first name of the user.

ManagerLastName

string

 

Manager last name of the user.

ManagerMail

string

 

Manager mail of the user.

ManagerPayId

string

 

Manager analytical axis of the user.

ManagerUserState

integer(enum)

 

Manager state of the user :       None = 0      Validated = 1      Active = 2    Values: [, , ]

Reviewer_Id

string(guid)

 

Unique reviwer identifier of the user.

ReviewerFirstName

string

 

Reviwer first name of the user.

ReviewerLastName

string

 

Reviwer last name of the user.

ReviewerMail

string

 

Reviwer mail of the user.

ReviewerPayId

string

 

Reviwer analytical axis of the user.

ReviewerUserState

integer(enum)

 

Reviwer state of the user :       None = 0      Validated = 1      Active = 2    Values: [, , ]

JobTitle

string

 

Job title of the user.

Vendor

string

 

Vendor of the user.

MileageConfigurationsStr

string

 

Mileage configuration of the user.

PerDiemConfigName

string

 

Perdiem configuration of the user.

UserRole

integer(enum)

 

Roles access of the user :       All = 0      Users = 2      Missions = 4      Invoices = 8      Projects = 16      Rules = 32      Settings = 64      Integrations = 128      SubscriptionAndBills = 256      BiReports = 512      Categories = 1024      Mileage = 2048      ReadOnly = 4096      Vehicles = 8192      SuppliersManagement = 16384      Advances = 32768      VirtualPayment = 65536      Purchases = 131072      CustomFields = 262144      ProPaymentInstruments = 524288      MissionOrders = 1048576      BankAccounts = 2097152      Bookings = 4194304      Contact = 8388608      IntegrationsHistory = 16777216      TechnicalIntegration = 33554432      Reimbursements = 67108864    Values: [, , , , , , , , , , , , , , , , , , , , , , , , , , ]

ConfigurationSettingsStr

string

 

Additional configurations of the user.

ConfigurationSettingsReference

string

 

Configuration reference of the user.

LastLoginDate

string(date-time)

 

Last login date of the user. Respects the standard ISO 8601 date format. e.g: 2018-06-04T08:30:15.023Z

LastSignInDate

string(date-time)

 

Last signIn date of the user. Respects the standard ISO 8601 date format. e.g: 2018-06-04T08:30:15.023Z

Validators

array of (ValidatorResponse)

 

List of validators of the user.

UserSimpleTags

array of (TagResponse)

 

List of simple tags of the user.

UserTags

array of (TagResponse)

 

List of tags of the user.

RestrictedTags

array of (TagResponse)

 

Restricted tags with are managed by the user.


 

UserUpdateInput

Summary:

Description:

 

          Properties:

Name

Type

Summary

LastName

string

 

Last name of the user.

FirstName

string

 

First name of the user.

Mail

string

 

Mail of the user.

MailAlias

string

 

Mail alias of the user.

PayId

string

 

Serial of the user.

PayId2

string

 

First analytical axis.

PayId3

string

 

Second analytical axis.

PayId4

string

 

Third analytical axis.

PayId5

string

 

Forth analytical axis.

PayId6

string

 

Fifth analytical axis.

Language

string

 

Language of the user: FR, US, SE...

LocalCurrency

string

 

Local currency of the user: EUR, TND, USD...

LocalCountry

string

 

Local country of the user.

Manager_Id

string(guid)

 

Unique identifier of second validator.

Reviewer_Id

string(guid)

 

Unique identifier of the first validaor.

UserType

integer(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 :       None = 0      Employee = 1      Administrator = 2      Accountant = 4      CanRefund = 8      NotDisabledInImport = 16      NotUpdatedInImport = 32      UserTypeToIgnore = 56    Values: [, , , , , , , ]

Vendor

string

 

The name of the vendor.

UserRole

integer(enum)

 

Enum flag attribute which is the role of the user :       All = 0      Users = 2      Missions = 4      Invoices = 8      Projects = 16      Rules = 32      Settings = 64      Integrations = 128      SubscriptionAndBills = 256      BiReports = 512      Categories = 1024      Mileage = 2048      ReadOnly = 4096      Vehicles = 8192      SuppliersManagement = 16384      Advances = 32768      VirtualPayment = 65536      Purchases = 131072      CustomFields = 262144      ProPaymentInstruments = 524288      MissionOrders = 1048576      BankAccounts = 2097152      Bookings = 4194304      Contact = 8388608      IntegrationsHistory = 16777216      TechnicalIntegration = 33554432      Reimbursements = 67108864    Values: [, , , , , , , , , , , , , , , , , , , , , , , , , , ]

JobTitle

string

 

Title of the user job.

CanAddPurchase

boolean

 

If the user can add purchase or not.

DefaultProjectId

string(guid)

 

Unique identifier of the user default project.

IKRates_Id

string(guid)

 

Unique identifier of the mileage compensation rates.

AdditionalValidators

array of (ValidatorInput)

 

List of additional validators of the user.

TagsToAssign

array of (string)

 

List of tags' names that will be assigned to the user.

TagsToUnassign

array of (string)

 

List of tags' names that will be unassigned from the user.


 

ValidatorInput

Summary:

Description:

 

          Properties:

Name

Type

Summary

Mail

string

 

Mail of the validator

MinimumAmount

number(decimal)

 

If the ammount exceed the ammount the expense should be sent to the validator


 

ValidatorResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

Mail

string

 

 

FirstName

string

 

 

LastName

string

 

 

MinimumAmount

number(decimal)

 

 


 

VATResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

Rates

array of (number(decimal))

 

VAT rates  of the expense.

Values

array of (number(decimal))

 

AT values  of the expense.

VatFreeAmount

number(decimal)

 

Free amount of the VAT.

Tips

number(decimal)

 

Tips of the expense


 

VehicleResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

Name

string

 

Name of the vehicle.

DateCreation

string(date-time)

 

Creation date of the vehicle. Respects the standard ISO 8601 date format. e.g: 2018-06-04T08:30:15.023Z

CreationYearKm

number(decimal)

 

Distance already filed outside Expensya in the creation year in Km.

CreationYearMiles

number(decimal)

 

Distance already filed outside Expensya in the creation year in mile.

LastYearDistanceKm

number(decimal)

 

Distance already filed outside Expensya in the last year in Km.

LastUpdatedYear

integer(int32)

 

Last updated year of the vehicle.

VehicleType

integer(enum)

 

Type of the vehicle :       Car = 1      Moped = 2      Scooter = 3      Motocyle = 4      Bicycle = 5    Values: [, , , , ]

InternalVehicleType

integer(enum)

 

Internal type of the vehicle :       None = 0      Personal = 1      Professional = 2    Values: [, , ]

CurrentValidator_Id

string(guid)

 

Unique identifier of the current validator of the vehicle.

LastValidatorReminderDate

string(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

string

 

Comments of the vehicle.

State

integer(enum)

 

State of the vehicle :       Disabled = 0      Active = 1      Submitted = 2      Approved = 3      Rejected = 4      All = -1    Values: [, , , , , ]

ExternalId

string

 

External identifier of the vehicle.

AdministrativePower

integer(int32)

 

Administrative power of the vehicle.

IsActive

boolean

 

Shows if the vehicle is active or not.

AttachedFilesCount

integer(int32)

 

Count of the attached files to the vehicle.

CreationType

integer(enum)

 

Type of the creation of the vehicle :       UserCreated = 0      DefaultVehicle = 1    Values: [, ]

StartDate

string(date-time)

 

Start date of the vehicle. Respects the standard ISO 8601 date format. e.g: 2018-06-04T08:30:15.023Z

EndDate

string(date-time)

 

CEnd date of the vehicle. Respects the standard ISO 8601 date format. e.g: 2018-06-04T08:30:15.023Z