Expenses API Element Types

Enums
Requests
Reference Types

Enumerations

AccessRoleLevel

Property	Value
EmployeesResponsibleFor	1
SelectedRoles	2
AllData	3

AccountType

Property	Value
None	0
Savings	1
Current	2
CreditCard	3

AddressActionOutcome

Property	Value
Success	0
WrongEmployeeId	1
AddressExists	2
SaveUnsuccessfulMessage	3

AddressCreationMethod

Property	Value
None	0
CapturePlus	1
Global	2
EsrOutbound	3
ImplementationImportRoutine	4
DataImportWizard	5
ManualByAdministrator	6
ManualByClaimant	7

AddressSource

Property	Value
SEL	0
PCA	1
Favourite	2

AddressType

Property	Value
Work	0
Home	1

ApiStatusCode

Property	Value
Failure	0
Success	1
PartialSuccessWithWarnings	2
InternalError	1000
GenericError	1001
ValidationError	1002

AttributeFormat

Property	Value
NotSet	0
SingleLine	1
MultiLine	2
DateTime	3
DateOnly	4
TimeOnly	5
FormattedText	6
SingleLineWide	7
ListStandard	8
ListWide	9
ContactEmail	10
ContactPhone	11
ContactSMS	12

CalculationType

Property	Value
NormalItem	1
Meal	2
PencePerMile	3
DailyAllowance	4
FuelReceipt	5
PencePerMileReceipt	6
FixedAllowance	7
FuelCardMileage	8
ItemReimburse	9
FixedMileageDeduction	10

CardType

Property	Value
CreditCard	1
PurchaseCard	2

CheckAndPayAction

Property	Value
ApproveItems	0
UnapproveItem	1
ReturnItems	2

ClaimBasicOutcome

Property	Value
SingleClaimOnly	0
DuplicateClaimName	1
Success	2
Fail	3
NewClaimIdMustBeZero	4

ClaimDefinitionOutcome

Property	Value
SingleClaimOnly	0
DuplicateClaimName	1
Success	2
Fail	3

ClaimStage

Property	Value
Current	1
Submitted	2
Previous	3
Any	4

ClaimStatus

Property	Value
None	0
Submitted	1
BeingProcessed	2
NextStageAwaitingAction	3
ItemReturnedAwaitingEmployee	4
ItemCorrectedAwaitingApprover	5
ClaimApproved	6
ClaimPaid	7
AwaitingAllocation	8

ClaimType

Property	Value
Mixed	0
Cash	1
Credit	2
Purchase	3

ClaimUnsubmittableReason

Property	Value
Unsubmitable	0
Unsubmitted	1
SplitApprovalApprovedByAnotherChecker	-1
ItemsApproved	-2
ItemsNotReturnedByOtherApprovers	-3
AlreadyPaid	-4
StartedApprovalProcess	-5
ClaimHasBeenInvolvedInSelStage	-6
EscalatedProcess	-7

CorporateCardType

Property	Value
CreditCard	1
PurchaseCard	2

CurrencyType

Property	Value
Static	1
Monthly	2
Range	3

CustomEntityFormSectionType

Property	Value
Fields	1
TorchAttachments	2
Attachments	3

CustomerType

Property	Value
Standard	1
NHS	2

DateRangeType

Property	Value
Before	0
AfterOrEqualTo	1
Between	2
Any	3

EmailNotificationType

Property	Value
StandardNotification	1
ESRSummaryNotification	2
ESROutboundFileDetected	3
ESROutboundFileStartProcess	4
ESRLineManagerRoleUpdate	5
ESROutboundInvalidPostcodes	6
SupportTicketNotification	7
AuditLogCleared	8
ExcessMileage	9

EnvelopeStatus

Property	Value
Unknown	0
Generated	1
SentToPrint	10
PrintQA	11
PrintQAPassed	12
PrintQAFailed	13
IssuedToAccount	20
DispatchedToClient	21
AttachedToClaim	22
ReceivedBySEL	23
UnconfirmedNotSent	24
ConfirmedSent	25
Scanned	30
PendingAdminReassignment	32
ReceiptsAttached	40
Validated	50
ReadyForStorage	60
InStorage	61
ReadyForDestruction	70
Destroyed	71

ExpediteOperatorValidationProgress

Property	Value
CannotUpdate	-1
Available	0
InProgress	1
Completed	2

ExpenseActionOutcome

Property	Value
Successs	0
VATGreaterThanTotal	1
ExpenseDateNotInBetweenVehicleDates	2
RecommendedMileageExceeded	3
CreditCardItemsAlreadyReconciled	4
PurchaseCardItemsAlreadyReconciled	5
AddressesNotMatched	6
BankAccountCouldntBeAssigned	7
WalletReceiptConversionFailed	8
SubcatNotYetActive	9
SubcatExpired	10
ESRPersonIdNotAssigned	11

ExpenseItemPermissionResult

Property	Value
Pass	0
EmployeeDoesNotOwnClaim	1
ClaimHasBeenSubmitted	2
ClaimHasBeenApproved	3
ExpenseItemHasBeenEdited	4
NoReasonForAmendmentProvidedByApprover	5

ExpenseItemType

Property	Value
Cash	1
CreditCard	2
PurchaseCard	3

ExpenseValidationMatchingResult

Property	Value
FoundAndMatched	1
FoundNotMatched	2
FoundUnreadable	3
NotFound	4

ExpenseValidationProgress

Property	Value
ValidationServiceDisabled	-20
NotValidated	-12
NotSelectedForValidation	-11
SubcatValidationDisabled	-10
StageNotInSignoffGroup	-9
NotRequired	-6
NoReceipts	-4
Required	0
InProgress	10
WaitingForClaimant	15
CompletedFailed	20
CompletedWarning	21
CompletedPassed	22
InvalidatedFailed	30
InvalidatedWarning	31
InvalidatedPassed	32

ExpenseValidationStatus

Property	Value
Fail	-1
NotApplicable	0
Pass	1
Warning	2

FavouriteAction

Property	Value
Add	0
Delete	1

FieldFormat

Property	Value
NotSet	0
SingleLine	1
MultiLine	2
DateTime	3
DateOnly	4
TimeOnly	5
FormattedText	6

FieldType

Property	Value
NotSet	0
Text	1
Integer	2
DateTime	3
List	4
TickBox	5
Currency	6
Number	7
Hyperlink	8
Relationship	9
LargeText	10
RunWorkflow	11
RelationshipTextbox	12
AutoCompleteTextbox	13
OTMSummary	15
DynamicHyperlink	16
CurrencyList	17
Comment	19
Spacer	20
LookupDisplayField	21
Attachment	22
Contact	23

FilterType

Property	Value
All	0
Costcode	1
Department	2
Location	3
Projectcode	4
Reason	5
Userdefined	6

FlagAction

Property	Value
None	0
FlagItem	1
BlockItem	2

FlagColour

Property	Value
None	0
Information	1
Amber	2
Red	3

FlagFailureReason

Property	Value
None	0
Blocked	1
ClaimantJustificationRequired	2

FlagFrequencyType

Property	Value
InTheLast	1
Every	2

FlagInclusionType

Property	Value
All	1
List	2

FlagPeriodType

Property	Value
Days	1
Weeks	2
Months	3
Years	4
CalendarWeeks	5
CalendarMonths	6
CalendarYears	7
FinancialYears	8

FlagType

Property	Value
Duplicate	1
LimitWithoutReceipt	2
LimitWithReceipt	3
ItemOnAWeekend	4
InvalidDate	5
FrequencyOfItemCount	6
FrequencyOfItemSum	7
GroupLimitWithoutReceipt	8
GroupLimitWithReceipt	9
Custom	10
Aggregate	11
ItemNotReimbursable	12
UnusedAllowanceAvailable	13
TipLimitExceeded	14
HomeToLocationGreater	15
MileageExceeded	16
ItemReimbursable	17
ReceiptNotAttached	18
NumberOfPassengersLimit	19
OneItemInAGroup	20
JourneyDoesNotStartAndFinishAtHomeOrOffice	21
RestrictDailyMileage	22
ExchangeRateOverridden	23

Gender

Property	Value
Male	0
Female	1

HolidayProvision

Property	Value
TakeNoAction	1
SkipStage	2
AssignClaimToSomeoneElse	3

HomeToLocationType

Property	Value
None	0
CalculateHomeAndOfficeToLocationDiff	1
FlagHomeAndOfficeToLocationDiff	2
DeductHomeToOfficeFromEveryJourney	3
DeductHomeToOfficeEveryTimeHomeIsVisited	4
DeductHomeToOfficeIfStartOrFinishHome	5
DeductFirstAndLastHome	6
DeductFullHomeToOfficeEveryTimeHomeIsVisited	7
DeductFullHomeToOfficeIfStartOrFinishHome	8

InvalidDateFlagType

Property	Value
SetDate	1
LastXMonths	2

MileageUom

Property	Value
Mile	0
Km	1

Notify

Property	Value
JustNotifyUserOfClaim	1
UserIsToCheckClaim	2

NotifyAdminOfChangesOutcome

Property	Value
EmailSentSuccessfully	0
ErrorDuringSending	1
AccountHasNoAdministrator	2
AccountAdministratorHasNoEmailAddress	3
AccountDoesNotPermitChangeOfDetailsNotifications	4

OcrProcessingStatus

Property	Value
NoStatus	-1
AwaitingProcessing	0
Processing	1
Complete	2

OrganisationActionOutcome

Property	Value
Success	0
UnexpectedError	1
OrganisationNameAlreadyExists	2

PartSubmittalFieldType

Property	Value
Radio	0
Checkbox	1

RangeType

Property	Value
GreaterThanOrEqualTo	0
Between	1
LessThan	2
Any	3

ReceiptCreationMethod

Property	Value
Unknown	0
UploadedByClaimant	1
UploadedByExpedite	2
UploadedByMobile	3
EmailedIn	4

SampleDirection

Property	Value
Request	0
Response	1

SaveEditClaimOutcome

Property	Value
DuplicateClaimName	0
Success	1

SearchOperator

Property	Value
And	0
Or	1

SignoffType

Property	Value
None	0
BudgetHolder	1
Employee	2
Team	3
LineManager	4
ClaimantSelectsOwnChecker	5
ApprovalMatrix	6
DeterminedByClaimantFromApprovalMatrix	7
CostCodeOwner	8
AssignmentSupervisor	9
SELScanAttach	100
SELValidation	101

SpendManagementElement

Property	Value
None	-1
AccessRoles	6
Advances	7
Allowances	8
AuditLog	9
BroadcastMessages	10
BudgetHolders	11
CarDocuments	12
Cars	13
CheckAndPay	14
Colours	15
CompanyDetails	16
CorporateCards	17
CostCodes	1
Countries	19
Currencies	20
DefaultPrintView	21
Departments	2
Emails	22
EmailServer	23
EmailSuffixes	24
Employees	25
ESRElements	26
ESRTrustDetails	27
ExpenseCategories	28
ExpenseItems	29
ExpensesPolicy	30
FAQS	31
FinancialExports	32
FlagsAndLimits	33
GeneralOptions	34
SignOffGroups	35
ImportDataWizard	36
Invoices	58
ItemRoles	37
Locations	38
MainAdministrator	39
NewExpenses	40
P11D	41
PasswordOptions	42
PoolCars	43
ProjectCodes	3
Reasons	46
RegionalSettings	47
Reports	48
Teams	49
UserDefinedFields	50
VehicleJourneyRateCategories	51
Workflows	4
ClaimantReports	18
Setup	5
SupplierDetails	52
SupplierCategory	53
SupplierContacts	54
SupplierStatus	55
UserdefinedGroupings	56
Products	59
ProductCategories	60
ProductLicences	61
InvoicesApproval	62
DocumentConfigurations	63
RechargeClients	64
RechargeAssociations	65
RechargePayments	66
RechargeOneTimeCharges	67
ContractDetails	68
ContractAdditional	69
ContractProducts	70
InvoiceNotes	71
InvoiceForecasts	72
ContractNotes	74
ProductNotes	75
PrintOut	82
DefaultView	83
CompanyLogo	84
FilterRules	85
Tooltips	86
CompanyPolicy	87
EmployeeExpenses	88
Groups	90
ContractSavings	91
Tasks	92
VersionRegistry	93
ContractAudience	94
AttachmentAudience	95
ReportsExport	96
Attachments	97
NotesSummary	98
LinkedContracts	99
ExpenseClaims	100
Audiences	101
CustomEntities	102
DocumentTemplates	103
Claims	104
Expenses	105
Views	107
ContractHistory	108
ContractCategories	109
ContractTypes	110
ContractStatus	111
InflatorMetrics	112
TermTypes	113
SalesTax	114
LicenceRenewalTypes	115
Units	118
Sites	119
TaskTypes	120
ExpenseItemJourneyStep	121
EmployeeWorkAddressLocations	122
EmployeeHomeAddressLocations	123
EmployeeLineManager	124
ESRAssignment	125
CostCodeBreakdown	126
EmployeeCreditCards	128
FinancialStatus	129
InvoiceFrequencyTypes	130
InvoiceStatus	131
SubAccounts	132
CustomEntityForms	133
CustomEntityViews	134
CustomEntityInstances	135
ProductLicenceTypes	136
AddNewContract	137
AttachmentMimeTypes	138
ViewFinancials	139
NoteCategories	140
RechargeAccountCodes	142
SupplierNotes	143
SupplierContactNotes	144
ContractVariations	145
ContractLinks	146
ContractSchedules	147
ContractSupplierReassignment	148
InvoiceStatusHistory	149
AccessKeys	154
Holidays	156
ContractProductReassignment	157
CustomMimeHeaders	159
CompanyHelpAndSupportInformation	161
IPAdressFiltering	162
AttachmentBackups	163
MobileDevices	165
ImportTemplates	166
ImportHistory	167
ApprovalMatrix	176
GreenLightMenu	177
ClaimViewer	178
Addresses	179
Organisations	180
Api	181
SupportTickets	182
EnvelopeManagement	183
FinancialYear	184
SingleSignOn	185
Receipts	186
VehicleEngineType	187
FrameWorkSuperUser	188
BankAccounts	189
ViewFunds	190
EmployeeBankAccounts	191
AuthoriserLevel	192
Scheduler	193
ExpeditePaymentReport	194
LogonMessages	195
FuelReceiptToVATCalculation	196
DvlaConnect	197
VehicleLookup	198
ReceiptReader	199
MyDetails	200
RedirectClaims	201
AddExpenseForEmployeeViaAPI	202
MyTeamsVehicleDocumentsAwaitingReview	203
MyVehicleDocuments	204
MyTeamsVehicleDocumentsAll	205
MyDrivingLicences	206
MyTeamsDrivingLicencesAll	207
ClaimantEndorsements	208
AutoPopulatedEndorsements	209
ClaimantEntitlements	210
AutoPopulatedEntitlements	211
MyDrivingLicenceReviews	212
MyTeamsDrivingLicenceReviewsAwaitingReview	213
MyTeamsDrivingLicenceReviewsAll	214
ClaimantNonGBLicenceReviews	215
DateofIssue	216
LicenceCategoryGroup	217

StageInclusionType

Property	Value
None	0
Always	1
ClaimTotalExceeds	2
ExpenseItemExceeds	3
IncludesCostCode	4
ClaimTotalBelow	5
IncludesExpenseItem	6
OlderThanDays	7
IncludesDepartment	8
ValidationFailedTwice	9
ClaimReimbursableAmountExceeds	10

SubmitRejectionReason

Property	Value
Success	0
NoItems	1
NoSignoffGroup	2
DelegatesProhibited	3
CannotSignoffOwnClaim	4
OutstandingFlags	5
MinimumAmountNotReached	6
MaximumAmountExceeded	7
NoLineManager	8
ApproverOnHoliday	9
FrequencyLimitBreached	10
AssignmentSupervisorNotSpecified	11
CostCodeOwnerNotSpecified	12
CreditCardHasUreconciledItems	13
EmployeeHasUnmatchedCardItems	14
UserNotAllowedToApproveOwnClaimDespiteSignoffGroup	15
UserNotAllowedToApproveOwnClaim	16
InvalidItemChecker	17
ClaimPaid	18
StageRequiresFurtherCheckers	19
ClaimSentToNextStage	20
ApproverCannotApproveOwnClaim	21
ItemsStillToApprove	22
ClaimNameAlreadyExists	23
OutstandingFlagsRequiringJustificationByApprover	24
AssignmentSupervisorNotSpecifiedWhenApproving	25
CostCodeOwnerNotSpecifiedWhenApproving	26
AlreadySubmitted	27

ThresholdType

Property	Value
Annual	0
Journey	1

TypeOfUserDefinedField

Property	Value
Text	1
Integer	2
DateTime	3
List	4
TickBox	5
Currency	6
Number	7
Hyperlink	8
Relationship	9
LargeText	10

UDFAppliesTo

Property	Value
Employees	0
ExpenseItems	1
Claims	2
ExpenseItemCategories	3
Cars	4
Companies	5
CostCodes	6
Departments	7
ProjectCodes	8

UpdateClaimOutcome

Property	Value
ClaimAlreadyExists	-1
UpdateSuccessful	0

ValidationPoint

Property	Value
AddExpense	0
SubmitClaim	1

ValidationType

Property	Value
Any	0
DoesNotRequireSave	1
RequiresSave	2

VehicleEngineType

Property	Value
None	0
Petrol	1
Diesel	2
LPG	3
Hybrid	4
Electric	5
DieselEuroV	6
BiFuel	7
Conversion	8
E85	9
HybridElectric	10
Other	99

VehicleType

Property	Value
None	0
Bicycle	1
Car	2
Motorcycle	3
Moped	4
LGV	5
HGV	6
Minibus	7
Bus	8
Van	9

Request Types

Account

Request to Process calculation.

Property	Type	Comments	Rules
AccountId	int	Account Id for the process	Required

ActivateEmployeesRequest

Accepts a list of employee ids to be activated

Property	Type	Comments	Rules
EmployeeIds	List<int>	List of Employee Ids.

AddRemovePersonalFavouriteAddressRequest

The add remove personal favourite address request.

Property	Type	Comments
Identifier	string	Gets or sets the Identifier for the address. (either addressId or global identifier)
FavouriteId	int	Gets or sets the address id. Set to 0 if new favourite, or set to FavouriteId to delete a favourite by its Id
FavouriteAction	Common.Enum.FavouriteAction	Gets or sets the action which needs to take place for the favourite address

AddressLabelRequest

The address label request.

Property	Type	Comments
Identifier	string	Gets or sets the identifier.
Label	string	Gets or sets the label.
LabelId	int	Gets or sets the label id.

AddressRequest

The address request. Used for searching for an address.

Property	Type	Comments
SearchTerm	string	Gets or sets the search term, i.e. postcode, street name.
CountryId	int	Gets or sets the country Id the address belongs to.
ExpenseDate	DateTime	Gets or sets the date of the expense.
EsrAssignmentId	Nullable<int>	Gets or sets the Esr assignment id. Used to filter office addresses for an assignment, if applicable

AdvanceRequest

The advance request.

Property	Type	Comments
AdvanceId	int	Gets or sets the advance Id.
AdvanceName	string	Gets or sets the advance name.
AdvanceReason	string	Gets or sets the advance reason.
Amount	decimal	Gets or sets the amount.
CurrencyId	int	Gets or sets the currency id.
RequiredByDate	Nullable<DateTime>	Gets or sets the required by date, if any.

AllocateCardToEmployeeRequest

The allocate card to employee request.

Property	Type	Comments
EmployeeId	int	Gets or sets the employee id.
StatementId	int	Gets or sets the statement id.
CardNumber	string	Gets or sets the card number.

AssignClaimsRequest

The assign claims request.

Property	Type	Comments	Rules
ClaimIds	List<int>	Gets or sets the claim ids.

AssociateExpenseItemsWithFlagRequest

The associate expense items with flag request.

Property	Type	Comments	Rules
FlagId	int	Gets or sets the flag id.
ExpenseItemIds	List<int>	Gets or sets the expense item ids.

AssociateFieldsWithFlagRequest

The associate fields with flag request.

Property	Type	Comments	Rules
FlagId	int	Gets or sets the flag id.
FieldIds	List<Guid>	Gets or sets the field ids.

AssociateItemRolesWithFlagRequest

The associate with item roles flag request.

Property	Type	Comments	Rules
FlagId	int	Gets or sets the flag id.
ItemRoleIds	List<int>	Gets or sets the item role ids.

ChangePasswordRequest

Encapsulates the details required for a user to change their password.

Property	Type	Comments	Rules
OldPassword	string	Gets or sets the old password.
ResetKey	string	Gets or sets the reset key.
NewPassword	string	Gets or sets the new password.	Required

CheckAndPayActionRequest

Handles the CheckAndPayActionRequest (approve, unapprove) request

Property	Type	Comments	Rules

ClaimableItemsRequest

Defines a request that update the subcategories and will appear when user adds a new expense.

Property	Type	Comments	Rules
SubCatIds	List<int>	Gets or sets the list of sub category Ids.	Required

ClaimEnvelopeInfo

The claim envelope info.

Property	Type	Comments
PhysicalState	string	Gets or sets the physical state of the envelope
ExcessCharge	string	Gets or sets any excess charges from postage or handling.
ProcessedAfterMarkedLost	string	Gets or sets details about if the envelope was processed / received / scanned after it had been marked lost.

ClaimSubmissionRequest

Defines a request that describes claim submission details.

Property	Type	Comments
ClaimId	int	Gets or sets the claim id.
ClaimName	string	Gets or sets the claim name.
Description	string	Gets or sets the claim description.
Cash	bool	Gets or sets a value indicating whether cash claim or not, True if a cash claim.
Credit	bool	Gets or sets a value indicating whether credit claim or not, True if a credit claim.
Purchase	bool	Gets or sets a value indicating whether purchase claim or not, True if a purchase claim.
Approver	Nullable<int>	Gets or sets the claim approver id.
OdometerReadings	List<List<object>>	Gets or sets the odometer readings.
BusinessMileage	bool	Gets or sets a value indicating whether business mileage.
IgnoreApproverOnHoliday	bool	Gets or sets a value indicating whether ignore approver on holiday.
ViewFilter	byte	Gets or sets the viewFilter.
ContinueAlthoughAuthoriserIsOnHoliday	bool	Gets or sets a value indicating whether continue although authoriser is on holiday.

CorporateCardImportRequest

Defines a request that describes corporate card import details (including file data).

Property	Type	Comments
AccountId	int	Gets or sets the Account Id for the Corporate Card import
CorporateCardId	int	Gets or sets the Corporate Card Id based on the filename
Filename	string	The original filename used for the query.
CorporateCardFileReceipt	string	Gets or sets the Corporate Card File data. This should be a Base 64 string
ResponseInformation	Models.Common.ApiResponseInformation	The error will contain a status code and a list of errors

CustomEntityRequest

Custom Entity request class.

Property	Type	Comments
RecordId	int	Gets or sets the record id.
EntityId	int	Gets or sets the entity id.
ViewId	int	Gets or sets the view id.

CustomEntityToCopy

Request to copy system greenlight entity.

Property	Type	Comments	Rules
EntityId	int	Custom entityid to copy.	Required
TargetAccountId	int	Accountid of the target database.	Required

DeleteReceiptAsApproverRequest

A request to hold the details of the delete receipt as an approver details.

Property	Type	Comments
ExpenseId	int	Gets or sets the expense id.
ReceiptId	int	Gets or sets the receipt Id of the receipt.
DeleteReason	string	Gets or sets the approver's reason for the receipt deletion.

DrivingLicenceRequest

Request for save driving licence information

Property	Type	Comments	Rules

EmployeeHolidayRequest

Extends the to take in a user to assign the holiday to

Property	Type	Comments	Rules
EmployeeId	int	The id of the employee to assign the holiday to	Required
Id	int	Gets or sets the holiday Id.
StartDate	DateTime	Gets or sets the holiday start date.	Required
EndDate	DateTime	Gets or sets the holiday end date.	Required

EsrAssignmentRequest

The Esr Assignment request.

Property	Type	Comments	Rules
EsrAssignment	ESRAssignments	Gets or sets the ESR assignment.

FindAccessRolesRequest

Facilitates the finding of AccessRoles, by providing a few optional search / filter parameters.

Property	Type	Comments
Name	string	Find by name (checks whether the name contains what's here, not an exact match.)
CanEditCostCode	Nullable<bool>	Setting this to true or false will filter the results by CanEditCostCode
CanEditDepartment	Nullable<bool>	Setting this to true or false will filter the results by CanEditDepartment
CanEditProjectCode	Nullable<bool>	Setting this to true or false will filter the results by CanEditProjectCode

FindAllowancesRequest

Facilitates the finding of Allowances, by providing a few optional search / filter parameters.

Property	Type	Comments	Rules
Label	string	Search by label.
Description	string	Search by description.

FindBudgetHoldersRequest

Facilitates the finding of BudgetHolders, by providing a few optional search / filter parameters.

Property	Type	Comments
Label	string	Search by label.
Description	string	Search by description.
EmployeeId	Nullable<int>	Search by Employee Id.

FindClaimReasonsRequest

Facilitates the finding of ClaimReasons, by providing a few optional search / filter parameters.

Property	Type	Comments	Rules
Label	string	Search by label.
Description	string	Search by description.

FindCorporateCardsRequest

Facilitates the finding of CorporateCards, by providing a few optional search / filter parameters.

Property	Type	Comments
CardProviderId	Nullable<int>	The Id of the Card Provider.
IsActive	Nullable<bool>	Whether the card is active.
EmployeeId	Nullable<int>	Find by Employee Id.

FindCostCodesRequest

Facilitates the finding of CostCodes, by providing a few optional search / filter parameters.

Property	Type	Comments	Rules
Label	string	Search by label.
Description	string	Search by description.

FindCountryRequest

Facilitates the finding of Countries, by providing a few optional search / filter parameters.

Property	Type	Comments
CountryId	Nullable<int>	The Country Id.
GlobalCountryId	Nullable<int>	The Global Country Id.
Label	string	The name of the country.
CountryCode	string	The Country code, in ISO 3166-1 format.
Alpha3CountryCode	string	The 3 Letter country code, as per ISO 3166-1 alpha 3.
Numeric3CountryCode	Nullable<int>	The 3 number country code, as per ISO 3166-1.
Archived	Nullable<bool>	Whether the country is archived.

FindCurrencyExchangeRateRequest

Facilitates the finding of an exchange rate by providing search parameters.

Property	Type	Comments	Rules
FromCurrencyId	int	The I.D. of the currency you are converting from.	Required
ToCurrencyId	int	The I.D. of the currency you are converting to.	Required
DateTimeOfRate	DateTime	The date and time of the exchange rate lookup. In the format of yyyy-MM-dd hh:mm:ss	Required

FindCurrencyRequest

Facilitates the finding of Currencies, by providing a few optional search / filter parameters.

Property	Type	Comments
CurrencyId	Nullable<int>	The Currency Id.
GlobalCurrencyId	Nullable<int>	The Global Currency Id.
Archived	Nullable<bool>	Whether they are archived or not.
Label	string	With this Label.
Symbol	string	With this symbol.

FindDepartmentsRequest

Facilitates the finding of Departments, by providing a few optional search / filter parameters.

Property	Type	Comments	Rules
Label	string	Search by label.
Description	string	Search by description.

FindEmployeeRequest

Facilitates the finding of Employees, by providing a few optional search / filter parameters.

Property	Type	Comments
Title	string	Find users by Title.
UserName	string	Find users by Username.
Forename	string	Find users by first name.
Surname	string	Find users by last name.

FindExpenseCategoriesRequest

Facilitates the finding of ExpenseCategories, by providing a few optional search / filter parameters.

Property	Type	Comments	Rules
Label	string	Search for an ExpenseCategory that may contain these letters.	Required

FindExpenseSubCategoriesRequest

Facilitates the finding of ExpenseSubCategories, by providing a few optional search / filter parameters.

Property	Type	Comments
SubCatId	Nullable<int>	Sub Category Id
CategoryId	Nullable<int>	Expense CategoryId
SubCat	string	Sub Category Name
AccountCode	string	Account Code
PdCat	string	P11d Category
Reimbursable	Nullable<bool>	Re-imbursable
AlternateAccountCode	string	Alternate Account Code
ShortSubCategory	string	Abbreviation
VatApplicable	Nullable<bool>	Vat Applicable

FindItemRolesRequest

Facilitates the finding of ItemRoles, by providing a few optional search / filter parameters.

Property	Type	Comments
ItemRoleId	Nullable<int>	Role Id
ItemRoleName	string	Role Name
ExpenseSubCategoryId	Nullable<int>	Expense Sub Category Id

FindMileageCategoriesRequest

Facilitates the finding of MileageCategories, by providing a few optional search / filter parameters.

Property	Type	Comments
MileageCategoryId	Nullable<int>	Gets or sets the Mileage Category Id
VehicleJourneyRate	string	Gets or sets the Vehicle Journey Rate
Comment	string	Gets or sets the Comment
FinancialYearId	Nullable<int>	Gets or sets the FinancialYearId

FindNhsTrustRequest

Facilitates the finding of Departments, by providing a few optional search / filter parameters.

Property	Type	Comments	Rules
TrustVpd	string	Search by VPD.
Label	string	Search by label.

FindOdometerReadingsRequest

Facilitates the finding of OdometerReadings, by providing a few optional search / filter parameters.

Property	Type	Comments
Before	Nullable<DateTime>	Search for OdometerReadings that were taken before this date.
After	Nullable<DateTime>	Search for OdometerReadings that were taken after this date.
OdometerReadingOver	Nullable<int>	Search for OdometerReadings with an Odometer reading over this value.
OdometerReadingUnder	Nullable<int>	Search for OdometerReadings with an Odometer reading under this value.

FindOrganisationRequest

Facilitates the finding of Organisations

Property	Type	Comments	Rules
Label	string	The name / label for this Organisation.	Max Length: 256
Comment	string	A comment of this Organisation object.	Max Length: 4000
Code	string	The Organisation code	Max Length: 60
Archived	bool	Where the Organisation is archived
AddressLine1	string	The first line of the address	Max Length: 256
City	string	The city	Max Length: 256
PostCode	string	The Postcode	Max Length: 32

FindP11DCategoryRequest

Facilitates the finding of P11DCategories, by providing a few optional search / filter parameters.

Property	Type	Comments	Rules
Label	string	The name or label for this P11d Category

FindProjectCodesRequest

Facilitates the finding of ProjectCodes, by providing a few optional search / filter parameters.

Property	Type	Comments	Rules
Label	string	Search by label.
Description	string	Search by description.

FindSignOffGroupsRequest

Facilitates the finding of SignOffGroups, by providing a few optional search / filter parameters.

Property	Type	Comments	Rules
GroupId	Nullable<int>	Find my GroupId.
GroupName	string	Find with matching group name.

FindTeamsRequest

Facilitates the finding of Teams, by providing a few optional search / filter parameters.

Property	Type	Comments	Rules
Label	string	Search by label.
Description	string	Search by description.

FindVehiclesRequest

Facilitates the finding of Cars, by providing a few optional search / filter parameters.

Property	Type	Comments
Make	string	Search for a car by make.
Model	string	Search for a car by model.
Registration	string	Search for a car by Reg number.
Active	Nullable<bool>	Search for active cars.
Approved	Nullable<bool>	Search for approved cars.
StartsBeforeOrOn	Nullable<DateTime>	Search for cars that begin before this date.
StartsAfter	Nullable<DateTime>	Search for cars that begin after this date.
EndsBeforeOrOn	Nullable<DateTime>	Search for cars that begin before this date.
EndsAfter	Nullable<DateTime>	Search for cars that begin after this date.
OdometerReadingOver	Nullable<int>	Search for cars with an Odometer reading over this value.
OdometerReadingUnder	Nullable<int>	Search for cars with an Odometer reading under this value.

FlagJustification

A class to hold the details of a flag justification

Property	Type	Comments
ClaimId	int	The Id of the claim
ExpenseId	int	The Id of the expense item
FlaggedItemId	int	The Id of the flag
Justification	string	The justification for the flag

FlagsJustificationRequest

Defines a request that saves flag justifications provided by for the given flagged item id

Property	Type	Comments	Rules
FlagsJustificationRequests	Models.Requests.FlagJustification>	Gets or sets the justification requests.

GetClaimantsEsrAssignmentsRequest

The request for getting a claimants assignments

Property	Type	Comments	Rules
EmployeeId	int	Gets or sets the employee id.	Required
ExpenseId	int	Gets or sets the expense id.	Required
ExpenseDate	DateTime	Gets or sets the expense date.	Required

GetClaimantsRequest

Get claimants advances

Property	Type	Comments	Rules
EmployeeId	int	Gets or sets the employee id.	Required
ExpenseId	int	Gets or sets the expense id.	Required

GetClaimantsVehiclesRequest

The get claimants vehicles request.

Property	Type	Comments	Rules
EmployeeId	int	Gets or sets the employee id.	Required
ExpenseId	int	Gets or sets the expense id.	Required
ExpenseDate	DateTime	Gets or sets the expense date.	Required
SubCatId	int	Gets or sets the sub cat id.	Required

GetExpenseSubCategoryNamesByIdsRequest

Facilitates the retrieval of subcat names from their Ids

Property	Type	Comments	Rules
SubCatIds	List<int>	A list of Subcat Ids.	Required

GetFlagsGridRequest

Handles the request for the expenses flag gird

Property	Type	Comments	Rules

GlobalIdentifierRequest

The global identifier request.

Property	Type	Comments	Rules
GlobalIdentifier	string	Gets or sets the global identified.

HolidayRequest

The holiday request.

Property	Type	Comments	Rules
Id	int	Gets or sets the holiday Id.
StartDate	DateTime	Gets or sets the holiday start date.	Required
EndDate	DateTime	Gets or sets the holiday end date.	Required

ImportTransactionRequest

The import transaction request.

Property	Type	Comments
CardProviderName	string	Gets or sets the card provider name.
StatementDate	DateTime	Gets or sets the statement date.
TransactionData	string	Gets or sets the transactionData to import.

LoginRequest

Encapsulates the extra details required to log in to the API.

Property	Type	Comments	Rules
Username	string	The username.	Required
Password	string	The password to match the	Required
Company	string	The company for which the API user is using the API.	Required

MileageCategoryRequest

The MileageCategoryRequest Used to Create or Update a MileageCategory

Property	Type	Comments	Rules
Label	string	The label for this mileage category.	Required
Comment	string	The comment for this mileage category.
ThresholdType	ThresholdType	The ThresholdType for this mileage category.	Required
CalculateNewJourneyTotal	bool	Whether new journey totals should be calculated for this mileage category.
UnitOfMeasure	MileageUOM	The unit of measure for this mileage category.	Required Must be a valid enum member
Currency	int	The Id of the currency that applies to this mileage category.
NhsMileageCode	string	The user rates table.	Required
StartEngineSize	int	The user rates from engine size.
EndEngineSize	int	The user rates to engine size.
FinancialYearId	Nullable<int>	The Id of the financial year for this mileage category.

MileageDateRangeRequest

The MileageDateRangeRequest

Property	Type	Comments	Rules
DateRanges	List<DateRange>	A list of DateRanges

MileageThresholdRequest

Thw MileageThresholdRequest

Property	Type	Comments	Rules
Thresholds	List<Threshold>	A list of DateRanges

MyDetailRequest

The my detail request.

Property	Type	Comments	Rules
EmployeeId	int	Gets or sets the employee id.
Title	string	Gets or sets the title of the employee. Mr, Ms etc.	Required
Forename	string	Gets or sets the forename of the employee.	Required
Surname	string	Gets or sets the surname of the employee.	Required
TelephoneExtensionNumber	string	Gets or sets the telephone extension number for this employee.
TelephoneNumber	string	Gets or sets the telephone number for this employee.
MobileNumber	string	Gets or sets the mobilr number for this employee.
PagerNumber	string	Gets or sets the pager number for this employee.
EmailAddress	string	Gets or sets the email address for this employee.
PersonalEmailAddress	string	Gets or sets the personal email address for this employee.

ReceiptRequest

Class holds a receipt post.

Property	Type	Comments
ExpenseId	int	Gets or sets the expense id.
Receipt	string	Gets or sets the receipt image data. This should be a Base 64 string
FileType	string	The file type of the receipt.

ResetKeyRequest

Encapsulates requests to the validate reset key method of

Property	Type	Comments	Rules
ResetKey	string	Gets or sets the reset key.	Required

ReturnExpenseItemsRequest

THe request for returning expense items

Property	Type	Comments	Rules

SaveEnvelopesRequest

The save envelopes request.

Property	Type	Comments	Rules
ClaimId	int	Gets or sets the claim id.
ClaimEnvelopes	Models.Requests.ClaimEnvelopeInfo>	Gets or sets a list of ClaimEnvelopeInfo.

TeamLinkToMembersRequest

Defines a request that describes the linking of a team to team members.

Property	Type	Comments	Rules
EmployeeIds	List<int>	A list of employee Ids.	Required

ThresholdFuelRateRequest

The ThresholdFuelRateRequest

Property	Type	Comments	Rules
FuelRate	FuelRate	A FuelRate

UpdateExpenseItemRequest

The request for updating an expense item.

Property	Type	Comments	Rules

UpdateMultipleGeneralOptions

Contains a list of global or account specific option in the system.

Property	Type	Comments	Rules
GeneralOptions	List<GeneralOption>	A list GeneralOption

UserDefinedFieldRequest

The user defined field request.

Property	Type	Comments
UserDefinedFieldId	int	Gets or sets the user defined field id.
Description	string	Gets or sets the description.
DisplayName	string	Gets or sets the display name.
Tooltip	string	Gets or sets the tooltip.
Mandatory	bool	Gets or sets a value indicating whether mandatory.
FieldType	FieldType	Gets or sets the field type.
HyperlinkPath	string	Gets or sets the hyperlink path.
HyperlinkText	string	Gets or sets the hyperlink text.
Precision	Nullable<int>	Gets or sets the precision.
MaxLength	Nullable<int>	Gets or sets the max length.
Default	string	Gets or sets the default.
ItemSpecific	bool	Gets or sets a value indicating whether is item specific.
AllowEmployeeToPopulate	bool	Whether the employee is allowed to populate.
TableId	Guid	Gets or sets the table id.
Format	AttributeFormat	Gets or sets the format.
AppliesToTableId	Guid	Gets or sets the applies to table Id.
MaxRows	int	Gets or sets the max rows.
ListItems	List<UdfListElement>	Gets or sets the list items.
AllowSearch	bool	Gets or sets a value indicating whether allow search.
Order	int	Gets or sets the order.
Encrypted	bool	Gets or sets a value indicating whether the field is encrypted.

UserRequest

Generates a

Property	Type	Comments	Rules
AccountId	int	The Id of the Account for the User
Email	string	The Email of the User

Reference Types

AccessRights

A group of permissions that correspond to operations the user can perform.

Property	Type	Comments
CanView	bool	Whether the Employee can View the element / area.
CanAdd	bool	Whether the Employee can Add the element / area.
CanEdit	bool	Whether the Employee can Edit the element / area.
CanDelete	bool	Whether the Employee can Delete the element / area.

AccessRole

Represents a permission that can be applied to an Employee to allow them access to a specfific part of the system.

Property	Type	Comments	Rules
Id	int	RoleID of the access role.
Label	string	Label of the access role.	Required Max Length: 100
Description	string	Description for the access role.	Max Length: 4000
ElementAccess	List<ElementAccessDetail>	List of individual ElementAccessDetail that correspond to the SpandManagement system.
ExpenseClaimMinimumAmount	Nullable<decimal>	The minimum amount a claim is allowed to be before it cannot be submitted, or null if no minimum is set.
ExpenseClaimMaximumAmount	Nullable<decimal>	The maximum amount a claim is allowed to be before it cannot be submitted, or null if no maximum is set.
AccessLevel	AccessRoleLevel	Gets the access level the user has within reports.	Required Must be a valid enum member
AccessRoleLinks	List<int>	Returns a list of AccessRoleIDs, which this role can access to report on.
CanEditCostCode	bool	Can this user modify their cost code allocations.	Required
CanEditDepartment	bool	Can this user modify their department allocations.	Required
CanEditProjectCode	bool	Can this user modify their project code allocations.	Required
MustHaveBankAccount	bool	Does the Employee require a Bank Account to claim Expenses?	Required
CustomEntityAccess	List<CustomEntityGroupAccess>	List of individual custom entity access indexed by entity id.
AllowWebsiteAccess	bool	Allow this role access to the website.	Required
AllowMobileAccess	bool	Allow this role access to the Mobile.	Required
AllowApiAccess	bool	Allow this role access to the Api.	Required

AccessRoleBasic

An access role in it's most basic format

Property	Type	Comments
Id	int	RoleID of the access role.
Label	string	Label of the access role.
Description	string	Description for the access role.

Address

A Global Address represents a location on the planet.

Property	Type	Comments	Rules
Id	int	The address location id.
GlobalIdentifier	string	The identifier from Postcode Anywhere
AddressSource	AddressSource	Denotes where the address came from
AddressName	string	The name for the address, usually a company name when supplied.	Max Length: 250
FriendlyName	string	Gets or sets the friendly name or the address.
Line1	string	The first line of the address, usually a number and street.	Required Max Length: 256
Line2	string	The second line of the address.	Max Length: 256
Line3	string	The second line of the address.	Max Length: 256
City	string	The city.	Max Length: 256
County	string	The county this address is in.	Max Length: 256
Country	int	The country (global country id) the address is in.
Postcode	string	The address's postal code.	Max Length: 32
AccountWideLabels	List<int>	A list of the account-wide labels for this Address. Editing this list will have no effect. Use the PATCH resources.
IsAccountWideFavourite	bool	Is the address favourited for the entire account. Use the PATCH resource to set this.
FavouriteId	int	Gets or sets whether the address has a favouriteId
PrimaryAccountWideLabel	Nullable<int>	The primary Label out of the account wide labels, if there are any. You can set the primary account wide label by using the PATCH resource.
RecommendedDistances	List<int>	A list of the manual recommended distances between between this Address and other Addresses. Editing this list will have no effect. Use the AddressRecommendedDistance resource.
IsRetriveable	bool	Gets or sets whether the address is retriveable
AddressActionOutcome	Common.Enum.AddressActionOutcome	Gets or sets the address action outcome.
Label	string	Gets or sets the label.
LabelId	int	Gets or sets the label id.
StartDate	Nullable<DateTime>	Gets or sets the start date for the address.
EndDate	Nullable<DateTime>	Gets or sets the end date for the address.
IsHomeAddress	bool	Gets or sets a value indicating whether is home address.
IsOfficeAddress	bool	Gets or sets a value indicating whether is office address.
StepSummary	string	Gets the step summary.
AddressFriendlyText	string	Gets the address friendly text.
EsrAssignmentId	int	The ESR assignment Id associated with the address
Archived	bool	Whether this object is in an archived status.

AddressLabel

The address label.

Property	Type	Comments
Id	int	Gets or sets the address location id.
GlobalIdentifier	string	Gets or sets the identifier from Postcode Anywhere
FriendlyName	string	Gets or sets the address friendly text.
Label	string	Gets or sets the label.
LabelId	int	Gets or sets the label id.
PrimaryAccountWideLabel	Nullable<int>	Gets or sets the primary account wide label Id.

Represents a recommended (user defined) distance between two Addresses. Important: The Id pattern here works slightly differently. Due to the highly flexible nature of Addresses and distances in Expenses, multiple journey distances can be recorded for two addresses. To find other pairs, look up addresses by the Address Ids.

Property	Type	Comments
Id	int	The unique Id of this record in the database.
AddressAId	int	The Id of the first address.
AddressBId	int	The Id of the target address.
RecommendedDistance	decimal	The recommended (manually entered) distance between the two addresses.

Advance

A class to hold the basic details about an advance

Property	Type	Comments
FloatId	int	Gets or sets the float id.
EmployeeId	int	Gets or sets the employee id.
CurrencyId	int	Gets or sets the currency id.
Name	string	Gets or sets the advance name.
DisplayName	string	Gets or sets the display name. A concatination of the advance name and currency name
Available	bool	Gets or sets the value if advance is available or not
Outcome	string	Gets or sets the outcome of an action against an Advance.

Allowance

An Allowance represents a sum of money that can be claimed against.

Property	Type	Comments	Rules
Id	int	The unique Id for this Allowance object.
Label	string	The name / label for this Allowance object.	Required Max Length: 50
Description	string	A description of this Allowance object.	Max Length: 4000
CurrencyId	int	The Id of the Currency under which this allowance is paid.	Required
NightHours	int	How many hours the employee must be away before they can claim the higher NightRate.
NightRate	decimal	The rate that the claim can be paid at, above the hours specified by NightHours.
AllowanceRates	List<AllowanceRate>	Defines allowance rates further to the initial Night Rate allowance.

AllowanceRate

An Allowance Rate is attached to an allowance to say: "After THIS many hours, pay the claimant THIS rate.".

Property	Type	Comments	Rules
Id	int	The Key / Id of this Allowance Rate.
AllowanceId	int	The Primary Key / Id of the Allowance that this AllowanceRate is tied to.	Required
HourThreshold	int	The threshold (hours) at which the HourlyRate will be charged.
HourlyRate	decimal	The rate of charge after the HourThreshold has been reached.

AllowExpenseItems

The response for AllowExpenseItems

Property	Type	Comments
NumberOfApprovedItems	Nullable<int>	The number of approved items
HasReturnedItems	bool	Does the claim have returned items
FlaggedItemsManager	FlaggedItemsManager	The FlaggedItemsManager
HasMessage	bool	Does the result have a message
NoDefaultAuthoriserPresent	bool	Is there no default authoriser present

AssociatedExpense

An expense that is associated with a flag where it has caused the flag to occur.

Property	Type	Comments	Rules
ClaimName	string	Gets or sets the claim name the expense belongs to.	ReadOnly
Date	DateTime	Gets or sets the date of the expense item.	ReadOnly
ReferenceNumber	string	Gets or sets the reference number of the expense item.	ReadOnly
Total	string	Gets or sets the total of the expense item.	ReadOnly
ExpenseItem	string	Gets or sets the name of the expense item (subat).	ReadOnly
ExpenseId	int	Gets or sets the expense id.	ReadOnly

AssociatedExpenseItem

An expense item (subcat) that belongs to the expense item collection on a flag.

Property	Type	Comments	Rules
SubcatId	int	Gets or sets the subcat id.	ReadOnly
Name	string	Gets or sets the name of the subcat.	ReadOnly

Attachment

The attachment.

Property	Type	Comments
AttachmentId	int	Gets or sets the attachment's identifier
CreatedOn	DateTime	Gets or sets the created on date.
FileData	byte[]	Gets or sets the file data bytes.
Filename	string	Gets or sets the filename.
OwnerRecordId	int	Gets or sets the record id of the entity that relates to this attachment.
Title	string	Gets or sets the title.

Attribute

Holds the attribute details for a user defined field

Property	Type	Comments
Attributeid	int	Get attribute Id
Attributename	string	Get attribute name
Displayname	string	Get friendly display name of attribute
Description	string	Get attribute description
Tooltip	string	Get associated tool tip
Mandatory	bool	Get mandatory indication
DisplayInMobile	bool	Gets a value indicating whether the attribute should be displayed to mobile users.
Fieldtype	TypeOfUserDefinedField	Get field type
Createdon	DateTime	Get attribute creation date
Createdby	int	Get User ID of attribute creator
Modifiedon	Nullable<DateTime>	Get attribute last modification date
Modifiedby	Nullable<int>	Get User ID of attributes modifer
Fieldid	Guid	Get field id for reporting of attribute
Iskeyfield	bool	Get whether the attribute is a key field
Isauditidentifer	bool	Get whether attribute is used as audit log field identifier
Isunique	bool	Gets whether the attribute value is to be unique
AllowEdit	bool	Gets whether the attribute can be edited
AllowDelete	bool	Gets whether the attribute can be deleted
IsSystemAttribute	bool	Gets whether the attribute was generated by the application and not a user
BoolAttribute	bool	A generic boolean attribute for the attribute. Attachment attribute - include image library Formatted text box - strip font tags from html before save.
MaxLength	int	The max length for the field
FieldFormat	FieldFormat	The format of the field
Precision	int	The precision of a number field
HyperLink	UI.WebControls.HyperLink	Details of the hyperlink for a hyperlink field
DefautCheckValue	string	The default value for a checkbox field
ListElements	List<UserDefinedFieldListElement>	The list of values that make up the list field type

AuthoriserJustification

The authoriser justification.

Property	Type	Comments	Rules
FlaggedItemId	int	Gets the flagged item this justification relates to	ReadOnly
Stage	int	Gets the stage this justification relates to	ReadOnly
FullName	string	Gets the full name of the employee that provided the justification	ReadOnly
Justification	string	Gets the justification provided	ReadOnly
DateStamp	DateTime	Gets the date and time the comment was made	ReadOnly
DelegateID	Nullable<int>	Gets or sets the id of the employee if a delegate logged the justification.	ReadOnly
Time	string	Gets the elapsed time from now.

BankAccount

The bank account type.

Property	Type	Comments
BankAccountId	int	Get or sets the bank account ID
EmployeeId	int	Get or sets the employeeID of the employee who owns this bank account
AccountName	string	Get or sets the name given to this account by the user
AccountNumber	string	Get or sets the unique number given to this account by the user
AccountType	int	Get or sets the account type
SortCode	string	Get or sets the sort code
Reference	string	Get or sets the reference value
CurrencyId	int	Get or sets the currency id
CurrencyName	string	Gets or sets the currency name.
CountryId	int	Get or sets country id
Archived	bool	archived
Outcome	string	The outcome of an action against a bank account i.e. save/edit
Iban	string	Gets or sets Iban of an account number
SwiftCode	string	Gets or sets the Swift code of an account number

BankAccount

Represents a User's Bank Account information.

Property	Type	Comments
AccountId	int	The AccountId
AccountName	string	The Account Name
AccountHolderName	string	The account holder name.
AccountNumber	string	The account number.
AccountType	string	The account type.
SortCode	string	The sort code.
AccountReference	string	The account reference.

BankAccountMasterData

A class to describe the master data used to build up the Add/Edit Bank Accounts

Property	Type	Comments
EmployeeId	int	Gets or sets the employee id.
CountryList	IList<Country>	Gets or sets a list of
CurrencyList	IList<Currency>	Gets or sets a list of
PrimaryCurrencyId	int	Gets or sets the primary currency id.
PrimaryCountryId	int	Gets or sets the primary country id.

BaseCurrency

The Base Currency superclass has 2 subclasses, CurrencyMonth and CurrencyDateRange. It contains the common property, ExchangeRateTable.

Property	Type	Comments	Rules
ExchangeRateTable	SortedList<int, double>	The sorted list of Exchange Rates.	Required
ApiExchangeRateTable	List<CurrencyWithRate>	Gets or sets the exchange rate table received from the api. Api could not cope with a sorted list hence needed the class CurrencyWithRate.

BudgetHolder

A Budget Holder is the encapsulation of an Employee => Budget assignment. A budget holder can be linked to a particular stage in a group.

Property	Type	Comments	Rules
Id	int	The unique Id for this BudgetHolder object.
Label	string	The name / label for this BudgetHolder object.	Required Max Length: 50
Description	string	A description of this BudgetHolder object.	Required Max Length: 4000
EmployeeId	Nullable<int>	The Id of the Employee who is responsible for this budget.	Required

CardProvider

Represents a company that provides Credit / Debit cards, such as American Express or Barclaycard.

Property	Type	Comments
CardProviderId	int	The card provider Id.
CardProviderName	string	The name of the card provider.
CardType	CorporateCardType	The type of the card.

CardStatement

Entity represents Card Statements.

Property	Type	Comments
StatementId	int	Gets or sets the Statement Id for the Card Statement
StatementName	string	Gets or sets the Statement Name for the Card Statement
StatementType	ExpenseItemType	Gets or sets the Statement Type for the Card Statement

Claim

Represents an expense claim in the system. This is the mechanism by which claimants account for the money they have spent and wish to claim back. A claim contains a list of ExpenseItems.

Property	Type	Comments	Rules
Id	int	The unique Id of this claim in the database.	Required
ClaimNumber	int	The Claim Number.	Required
EmployeeId	int	The Employee Id.	Required
AccountId	int	The Account Id.	Required
Name	string	The Name given to this claim.	Required Max Length: 50
Description	string	The description given to this claim.	Max Length: 2000
Stage	int	The SignoffGroup stage that this claim is currently at.
Approved	bool	Whether this Claim has been approved.
DateSubmitted	Nullable<DateTime>	The date that this claim was submitted (if it has been submitted).
Submitted	bool	Whether the claim has been submitted or not.
DatePaid	Nullable<DateTime>	The date that this claim was paid (if it has been paid).
Status	ClaimStatus	The current status of this claim.	Required Must be a valid enum member
TeamId	int	The Id of the team relating to this claim.
CheckerId	int	The Id of the checker, whomever it is.
SplitApprovalStage	bool	Whether the approval stage should be split.
CurrencyId	int	The Id of the currency that this claim is in.
ClaimType	ClaimType	The type of this claim.	Required Must be a valid enum member
ReferenceNumber	string	Gets the reference number for the claim.	Max Length: 11
ClaimStage	ClaimStage	Gets whether the claim is at current, submitted or previous	Required Must be a valid enum member
HasClaimHistory	bool	Gets whether there is any history associated with this claim
CurrentApprover	string	Gets the approver currently responsible for authorising the claim
TotalStageCount	int	Gets the total number of stages the claim has to go through to be authorised
HasReturnedItems	bool	Gets whether the claim includes any expense items that have been returned for amendment
HasCashItems	bool	Gets whether there are any cash card items on the claim
HasCreditCardItems	bool	Gets whether there are any credit card items on the claim
HasPurchaseCardItems	bool	Gets whether there are any purchase card items on the claim
HasFlaggedItems	bool	Gets whether there are any flagged items on the claim
NumberOfItems	int	Gets the total number of items on the claim
StartDate	Nullable<DateTime>	Gets the earliest item date on the claim
EndDate	Nullable<DateTime>	Gets the latest item date on the claim
Total	decimal	Gets the total monetary value of the claim
AmountPayable	decimal	Gets the monetary amount the claimant will receive back
NumberOfReceipts	int	Gets the total number of receipts on the claim
NumberOfUnapprovedItems	int	Gets the number of items that have not yet been approved
PurchaseCardTotal	decimal	Gets the total monetary value of purchase card items
CreditCardTotal	decimal	Gets the total monetary value of credit card items
ExpenseItems	List<int>	Returns a list of all of the Ids of each expense item in this claim.
Envelopes	List<int>	Returns a list of the Ids of each Envelope attached to this claim.
IncompleteEnvelopes	List<int>	Returns a list of the Ids of each Envelope that has an imcomplete status.
PayBeforeValidate	bool	Gets or sets a value indicating whether pay before validate is active.

ClaimantStatistics

A class to store claimant statistics

Property	Type	Comments
ReceiptWalletCount	int	The number of receipt wallets.
CurrentClaimsCount	int	Holds the count of claims at the current stage
SubmittedClaimsCount	int	Holds the count of claims at the submitted stage
PreviousClaimsCount	int	Holds the count of claims at the previous stage

ClaimBasic

A simple version of the Claim class

Property	Type	Comments	Rules
EmployeeId	int	The employee id number.	Required
ClaimId	int	The claim id number.	Required
ClaimNumber	int	The claim number.	Required
ClaimName	string	The given claim name.	Required Max Length: 50
Description	string	The claim description	Required Max Length: 2000
EmployeeName	string	The employee name	Max Length: 350
BaseCurrency	int	The base currency of the claim.
Stage	int	The current stage of the claim in the sign off group	Required
TotalStageCount	int	Gets the total number of stages the claim has to go through to be authorised
ClaimStage	ClaimStage	Gets or sets the stage. The SignoffGroup stage that this claim is currently at.
Status	ClaimStatus	The current status of the claim.	Required Must be a valid enum member
Approved	bool	Specified if the claim is currently approved.
Submitted	bool	Shows whether the claim has been submitted or not.
CheckerId	Nullable<int>	The id number of the claim checker
ItemCheckerId	Nullable<int>	Gets or set the ItemCheckerId for the claim.
DisplayDeclaration	bool	Whether to show the declaration at the current claim stage.
ReferenceNumber	string	The reference number for the claim.	Max Length: 11
CurrencySymbol	string	The currency symbol use for the base currency of the claim.	Max Length: 50
CurrencyLabel	string	The currency label for the base currency of the claim.
AmountPayable	decimal	Gets the monetary amount the claimant will receive back
Total	decimal	Gets the total amount the claimant will receive back
DisplayOneClickSignoff	bool	Whether one click sign off is permitted
NumberOfItems	int	The number of expense items on the claim
DateSubmitted	Nullable<DateTime>	The date the claim was submitted
DatePaid	Nullable<DateTime>	Gets or sets the date paid.
ClaimBasicOutcome	ClaimBasicOutcome	The outcome of the claimbasic action
ClaimEnvelopeInfo	List<ClaimEnvelopeInfo>	Gets or sets the list of envelope information.
CurrentApprover	string	Gets the approver currently responsible for authorising the claim
Claimant	string	Gets or sets the claimant name
CanBeUnassigned	bool	Gets or sets a value indicating whether a claim can be unassigned from the current approver

ClaimCountForAllStages

A class to hold the count of claims at the various stages

Property	Type	Comments
CurrentClaimsCount	int	Holds the count of claims at the current stage
SubmittedClaimsCount	int	Holds the count of claims at the submitted stage
PreviousClaimsCount	int	Holds the count of claims at the previous stage

ClaimDefinition

A basic definition of the claims object.

Property	Type	Comments	Rules
Id	int	The id number of the claim.	Required
Name	string	The name of the claim.	Required Max Length: 50
Description	string	A description of the claim.	Max Length: 2000
UserDefinedFields	List<UserDefinedFieldValue>	A list of user defined fields
ClaimDefinitionOutcome	ClaimDefinitionOutcome	The result of a ClaimDefinition action

ClaimDefinitionResponse

A basic definition of the claims object.

Property	Type	Comments	Rules
Id	int	The id number of the claim.	Required
Name	string	The name of the claim.	Required Max Length: 50
Description	string	A description of the claim.	Max Length: 2000
UserDefinedFields	List<UserDefinedFieldType>	A list of user defined fields./>
ClaimDefinitionOutcome	ClaimDefinitionOutcome	The result of a ClaimDefinition action

ClaimExpenseItem

The claim expense item.

Property	Type	Comments	Rules
ExpenseItem	ExpenseItem	Gets or sets the expense item.
Subcat	ExpenseSubCategory	Gets or sets the subcat.

ClaimExpenseOverview

The claim expense item overview to hold the basic details of an expense item

Property	Type	Comments
Id	int	Gets or sets ExpenseId of this item in the database.
Returned	bool	Gets or sets a value indicating whether this item is returned to the claimant.
Date	DateTime	Gets or sets date of this item.
JourneySteps	List<JourneyStep>	Gets or sets the sorted list of int, JourneyStep that apply to this item.
Flags	List<FlagSummary>	Gets or sets the flags.
BaseCurrency	int	Gets or sets Base Currency (in case a conversion is needed).
CurrencySymbol	string	Gets or sets the currency symbol.
GrandTotalVat	decimal	Gets or sets the grand vat total.
GlobalTotal	decimal	Gets or sets Global Total.
GrandTotalGlobal	decimal	Gets or sets Global Grand Total.
HasSplitItems	bool	Gets a value indicating that current expense item has split items in it.
SubCatDescription	string	Gets or sets the sub cat description.

ClaimReason

Represents a reason by which a user can claim expenses back.

Property	Type	Comments	Rules
Id	int	The unique Id for this ClaimReason object.
Label	string	The name / label for this ClaimReason object.	Required Max Length: 50
Description	string	A description of this ClaimReason object.	Max Length: 4000
AccountCodeVat	string	The Account code for VAT.	Max Length: 50
AccountCodeNoVat	string	The non-VAT account code.	Max Length: 50
Archived	bool	Archived value of a reason.

ClaimSignOffDetails

Represents the details for a signed off Claim.

Property	Type	Comments	Rules
SignOffGroupId	Nullable<int>	The Sign off group id.
CreditCardSignOffGroupId	Nullable<int>	The sign off group for credit card.
PurchaseCardSignOffGroupId	Nullable<int>	The sign off group for purchase card.
AdvancesSignOffGroupId	Nullable<int>	The sign off group for advances.
ItemRoles	List<int>	The list of associated Item Roles for this Employee. Do not try to modify this user's List by changing this list. Instead use the List resource.	ReadOnly

CorporateCard

Represents a corporate card against which items can be paid for and expenses claimed.

Property	Type	Comments	Rules
Id	int	The Card Id.
EmployeeId	int	The owning Employee. EmployeeID is essential to adding a CorporateCard. A card cannot currently exist without a valid Employee to own it.
CardType	CardType	The type of card that this card is. Card Type - Purchase Card : 0, Credit Card : 1	Must be a valid enum member
CardProviderId	int	The Id of the Card Provider.
CardNumber	string	The long Card Number.
IsActive	bool	Whether the card is active.

CostCentreBreakdown

Cost Centre Percentage.

Property	Type	Comments
DepartmentId	Nullable<int>	Gets or sets the code for the element to which the percentage is allocated (the project code type)
DepartmentDescription	string	Gets or sets the department description.
CostCodeId	Nullable<int>	Gets or sets the code for the element to which the percentage is allocated (the project code type)
CostCodeDescription	string	Gets or sets the cost code description.
ProjectCodeId	Nullable<int>	Gets or sets the code for the element to which the percentage is allocated (the project code type)
ProjectCodeDescription	string	Gets or sets the project code description.
Percentage	int	Gets or sets the percentage of allocation

CostCode

A CostCode is a unit of financial information against which you record expenditure.
An Employee or an ExpenseSubCategory.

Property	Type	Comments	Rules
Id	int	The Id of this object.
Label	string	The name / label for this CostCode object.	Required Max Length: 50
Description	string	A description of this CostCode object.	Max Length: 4000
OwnerId	Nullable<int>	The Id of the Owner of this cost code (if there is one).	Required if OwnerType is populated.
OwnerType	Accounts.Elements.ModuleElements>	The SpendManagementElement Type of the Owner (if there is one.) Should be one of these three: SpendManagementElement.Employee, SpendManagementElement.BudgetHolder, or SpendManagementElement.Team.	Required if OwnerId is populated. Must be a SpendManagementElement
UserDefined	List<UserDefinedFieldValue>	A sorted dictionary of any User Defined Fields.
Archived	bool	Whether this object is in an archived status.

CostcodeBreakdownSettings

Costcode breakdown settings from general options

Property	Type	Comments
UseDepartmentCodes	bool	Is department assigned to item
DepartmentsOn	bool	Is department visible for claimant
UseDepartmentCodeDescription	bool	Is description visible for department
UseDeptOnGenDetails	bool	Whether show department in general detail section or not
UseCostCodes	bool	Is costcode assigned to item
CostCodesOn	bool	Is costcode visible for claimant
UseCostCodeDescription	bool	Is description visible for costcode
UseCostCodeOnGenDetails	bool	Whether show costcode in general detail section or not
UseProjectCodes	bool	Is projectcode assigned to item
ProjectCodesOn	bool	Is projectcode visible for claimant
UseProjectCodeDescription	bool	Is description visible for projectcode
UseProjectCodeOnGenDetails	bool	Whether show projectcode in general detail section or not
UseDefaultAllocation	bool	Whether to use default costcode allocation or not

CostCodeBreakdownWithLabelData

The cost code breakdown with label class.

Property	Type	Comments
DepartmentId	Nullable<int>	Gets or sets the department for the element to which the percentage is allocated
DepartmentDecription	string	Gets or sets the department description for the element to which the percentage is allocated
CostCodeId	Nullable<int>	Gets or sets the cost code for the element to which the percentage is allocated
CostCodeDecription	string	Gets or sets the cost code description for the element to which the percentage is allocated
ProjectCodeId	Nullable<int>	Gets or sets the project code for the element to which the percentage is allocated
ProjectDecription	string	Gets or sets the project code description for the element to which the percentage is allocated
Percentage	int	Gets or sets the percentage of allocation

CostcodeSettings

Cose code settings

Property	Type	Comments
DisplayAs	string	What to display in the field label
DisplayForCash	bool	Whether to showFrom field for cash items
DisplayForCreditCard	bool	Whether to showFrom field for credit card items
DisplayForPurchaseCard	bool	Whether to showFrom field for purchase card items
DisplayOnIndividualItem	bool	Whether to showFrom field for individual expense items
MandatoryForCash	bool	WhetherFrom field is mandatory for cash items
MandatoryForCreditCard	bool	WhetherFrom field is mandatory for credit card items
CanAddFromField	bool	Whether the account permits employees to add a new From field from Add/Edit Expense

Country

Represents a real world country that users are allowed to make claims in. There are a fixed amount of Countries in the world, so SpendManagement represents these with a Global set. Each account can then choose how many from the global set they would like including in their custom configuration of Expenses. That is what this Country object is for. The GlobalCountryId propery can be used with the Globals resource to find more information on countries.

Property	Type	Comments	Rules
CountryId	int	The unique ID of the country.
CountryName	string	The country name
GlobalCountryId	int	The Id of the Global Country that this represents. Use the Globals resource to find GlobalCountries.	Required
VatRates	IEnumerable<VatRate>	The VAT rates for this country.
Archived	bool	Whether this object is in an archived status.

CountrySettings

The fields settings for Country

Property	Type	Comments
DisplayAs	string	What to display in the field label
DisplayForCash	bool	Whether to show Country for cash items
DisplayForCreditCard	bool	Whether to show Country for credit card items
DisplayForPurchaseCard	bool	Whether to show Country for purchase card items
DisplayOnIndividualItem	bool	Whether to show Country for individual expense items
MandatoryForCash	bool	Whether Country is mandatory for cash items
MandatoryForCreditCard	bool	Whether Country is mandatory for credit card items
CanAddNewCountry	bool	Whether the account permits employees to add a new Country from Add/Edit Expense

CountrySubCat

Represents a join between a Country and an ExpenseSubCategory.

Property	Type	Comments
SubCatId	int	The Id of the ExpenseSubCategory.
CountryId	int	The Id of the Country.
AccountCode	string	The Account Code.

CreditCardTransaction

The credit card transaction.

Property	Type	Comments
TransactionId	int	Gets or sets the tranaction id.
TransactionDateTime	Nullable<DateTime>	Gets or sets the transaction date time.
Description	string	Gets or sets the description.
CardNumber	string	Gets or sets the card number.
TransactionAmount	decimal	Gets or sets the transaction amount.
OrginalAmount	Nullable<decimal>	Gets or sets the orginal amount.
Label	string	Gets or sets the label.
ExchangeRate	Nullable<decimal>	Gets or sets the exchange rate.
Country	string	Gets or sets the country.
AllocatedAmount	Nullable<decimal>	Gets or sets the allocated amount.
UnallocatedAmount	Nullable<decimal>	Gets or sets the unallocated amount.
CurrencySymbol	string	Gets or sets the currency symbol of the transaction.
CurrencyId	int	Gets or sets the currency Id of the transaction.
PrimaryCurrencySymbol	string	Gets or sets the primary currency symbol of the employee.
RemainingAmountToBeReconciled	decimal	Gets or sets the orginal remaining amount on the transaction (this is in the orginating currency)

Currency

Represents a monetary currency. There are a finite amount of Currencies in the world, so SpendManagement represents these with a Global set. Each account can then choose how many from the global set they would like including in their custom configuration of Expenses. That is what this Currency object is for. The GlobalCurrencyId propery can be used with the Globals resource to find more information on currencies.

Property	Type	Comments	Rules
CurrencyId	int	The unique Id of the currency.	Required
CurrencyName	string	The currency name
GlobalCurrencyId	int	The Global Currency Id. Use the Globals resource to find GlobalCurrencies.	Required
AlphaCode	string	Gets or sets the alpha code of the currency
Archived	bool	Whether this object is in an archived status.

CurrencyDateRange

Represents a date range specific currency for exchage rates.

Property	Type	Comments	Rules
CurrencyDateRangeId	int	The unique Id.
StartDate	DateTime	The start date.
EndDate	DateTime	The end date.
ExchangeRateTable	SortedList<int, double>	The sorted list of Exchange Rates.	Required
ApiExchangeRateTable	List<CurrencyWithRate>	Gets or sets the exchange rate table received from the api. Api could not cope with a sorted list hence needed the class CurrencyWithRate.

CurrencyExchangeRates

Currency exchange rates are collections of conversion values that affect Currencies.

Property	Type	Comments	Rules
CurrencyId	int	The unique Id of the exchange rate.	Required
CurrencyType	CurrencyType	The Type of the currency this exchange rate applies to.	Required
ExchangeRates	ExchangeRates	The list of actual exchange rates for their types.

CurrencyExchangeRatesList

The currency exchange rates list.

Property	Type	Comments	Rules

CurrencyMonth

Represents a monthly style currency for exchange rates.

Property	Type	Comments	Rules
CurrencyMonthId	int	The unique Id.
Month	int	The Month.
Year	int	The Year.
ExchangeRateTable	SortedList<int, double>	The sorted list of Exchange Rates.	Required
ApiExchangeRateTable	List<CurrencyWithRate>	Gets or sets the exchange rate table received from the api. Api could not cope with a sorted list hence needed the class CurrencyWithRate.

CurrencySettings

The fields settings for Currency

Property	Type	Comments
DisplayAs	string	What to display in the field label
DisplayForCash	bool	Whether to show Currency for cash items
DisplayForCreditCard	bool	Whether to show Currency for credit card items
DisplayForPurchaseCard	bool	Whether to show Currency for purchase card items
DisplayOnIndividualItem	bool	Whether to show Currency for individual expense items
MandatoryForCash	bool	Whether Currency is mandatory for cash items
MandatoryForCreditCard	bool	Whether Currency is mandatory for credit card items
CanAddNewCurrency	bool	Whether the account permits employees to add a new Currency from Add/Edit Expense

CurrencyWithRate

The class that contains currency id with its exchange rate

Property	Type	Comments	Rules
CurrencyId	int	Gets or sets the currency id
ExchangeRate	double	Gets or sets the exchange rate

CustomEntity

An instance of a Custom Entity

Property	Type	Comments	Rules
Fields	List<CustomEntityFormField>	Gets or sets a list of custom entity form fields
Id	int	Gets or sets the identifier of this custom entity

CustomEntityAttribute

The Custom Entity Attribute API Class

Property	Type	Comments
Description	string	Gets or sets the description of the field
DisplayName	string	Gets or sets the field's name
FieldId	Guid	Gets or sets the field's unique identifier
Id	int	Gets or sets the field's database identifier
Tooltip	string	Gets or sets the field's tooltip
Type	FieldType	Gets or sets the field type enumerator
Format	AttributeFormat	Gets or sets the attribute format enumerator

CustomEntityElementAccess

Defines the permissions for accessing a Greenlight element.

Property	Type	Comments
Id	int	Returns the custom entity Form id
CustomEntityId	int	Returns the related custom entity's Id
Type	CustomEntityElementType	The type of this element (form/view etc)
AccessRights	AccessRights	The Access Rights for this CustomEntityAccess

CustomEntityForm

Custom Entity Form API Class

Property	Type	Comments	Rules
Id	int	Gets or sets the identifier of the form
Tabs	List<CustomEntityFormTab>	Gets or sets the list of custom entity form tabs related to this form Note that only the first tab is populated, this is by design for the corporate diligence mobile app

CustomEntityFormAccess

Defines the permissions for accessing a Greenlight form.

Property	Type	Comments
Id	int	Returns the custom entity Form id
CustomEntityId	int	Returns the related custom entity's Id
Type	CustomEntityElementType	The type of this element (form/view etc)
AccessRights	AccessRights	The Access Rights for this CustomEntityAccess

CustomEntityFormField

The Custom Entity Form Field API Class

Property	Type	Comments
Attribute	CustomEntityAttribute	Gets or sets the field's attribute
Column	byte	Gets or sets the column position of this field
Row	byte	Gets or sets the row position of this field
LabelText	string	Gets or sets the field's label text

CustomEntityFormSection

Custom Entity Form Section API Class

Property	Type	Comments
Fields	List<CustomEntityFormField>	Gets or sets a list of custom entity form fields
Id	int	Gets or sets the identifier of this section
HeaderCaption	string	Gets or sets the header caption text for this section
Type	CustomEntityFormSectionType	Gets or sets the type

CustomEntityFormTab

Custom Entity Form Tab API Class

Property	Type	Comments
Id	int	Gets or sets the identifier of the tab
HeaderCaption	string	Gets or sets the tab header text
Sections	List<CustomEntityFormSection>	Gets or sets a list of custom entity form sections

CustomEntityGroupAccess

Defines the permissions for accessing a custom entity / Greenlight

Property	Type	Comments	Rules
Id	int	The Id of the Greenlight group
CustomEntityName	string	Gets or Sets the Name of the Greenlight Entity
AccessRights	AccessRights	The Access Rights for this CustomEntityAccess	Required
ElementAccess	IList<CustomEntityElementAccess>	A List of ElementAccess objects for this GreenLight custom object.

CustomEntityLookupDisplayAttribute

The Custom Entity Lookup Display Attribute API Class

Property	Type	Comments
OriginalType	FieldType	Gets or sets the lookup display attribute's underlying field type
OriginalFormat	AttributeFormat	Gets or sets the lookup display attribute's underlying format
Description	string	Gets or sets the description of the field
DisplayName	string	Gets or sets the field's name
FieldId	Guid	Gets or sets the field's unique identifier
Id	int	Gets or sets the field's database identifier
Tooltip	string	Gets or sets the field's tooltip
Type	FieldType	Gets or sets the field type enumerator
Format	AttributeFormat	Gets or sets the attribute format enumerator

CustomEntityRecord

Custom Entity Record API Class

Property	Type	Comments
Id	int	Gets or sets the identifier of the record
Data	SortedList<object, object>	Gets or sets the data for the record. The key is an object because cCustomEntities.getEntityRecord() returns a list that uses integer keys, whereas cGridNew (used for getting multiple records) returns a list that uses string keys.
Attachments	List<Attachment>	Gets or sets the list of attachments associated with this custom entity record
TorchAttachments	List<Attachment>	Gets or sets the list of torch history attachments associated with this custom entity record

CustomEntityView

Custom Entity View API class.

Property	Type	Comments
Id	int	Gets or sets the unique Id of this View
EntityId	int	Gets or sets the related custom entity Id.
Description	string	Gets or sets the description
Name	string	Gets or sets the name.
EntityPluralName	string	Gets or sets the plural name of the view's custom entity.
IconUri	string	Gets or sets the URI to the corresponding icon.
DefaultEditForm	CustomEntityForm	Gets or sets the default edit form.
Archived	bool	Whether this object is in an archived status.

CustomEntityViewAccess

Defines the permissions for accessing a Greenlight view.

Property	Type	Comments
Id	int	Returns the custom entity Form id
CustomEntityId	int	Returns the related custom entity's Id
Type	CustomEntityElementType	The type of this element (form/view etc)
AccessRights	AccessRights	The Access Rights for this CustomEntityAccess

DateRange

Defines a time period of days where a MileageCategory applies.

Property	Type	Comments
MileageDateId	int	The unique date Id.
MileageCategoryId	int	The Id of the mileage category.
DateValue1	Nullable<DateTime>	The first date value.
DateValue2	Nullable<DateTime>	The second date value.
Thresholds	List<Threshold>	The list of thresholds that apply to this date range.
DateRangeType	DateRangeType	The type of date range.

Department

A department is a collection of Employees.

Property	Type	Comments	Rules
Id	int	The Id of this department.
Label	string	The label or name of this department.	Required Max Length: 50
Description	string	The description of this department.	Required Max Length: 4000
UserDefined	List<UserDefinedFieldValue>	A list of user-defined objects.
Archived	bool	Whether this object is in an archived status.

DepartmentSettings

Department settings

Property	Type	Comments
DisplayAs	string	What to display in the field label
DisplayForCash	bool	Whether to showFrom field for cash items
DisplayForCreditCard	bool	Whether to showFrom field for credit card items
DisplayForPurchaseCard	bool	Whether to showFrom field for purchase card items
DisplayOnIndividualItem	bool	Whether to showFrom field for individual expense items
MandatoryForCash	bool	WhetherFrom field is mandatory for cash items
MandatoryForCreditCard	bool	WhetherFrom field is mandatory for credit card items
CanAddFromField	bool	Whether the account permits employees to add a new From field from Add/Edit Expense

DocumentExpiry

A class which contains informtion about the document expiry

Property	Type	Comments
carId	int	Gets or sets the Id of the car for which the document is invalid
HasExpired	bool	Gets of sets the flag indicating whether or not the document has expired
Reason	string	Gets or sets information regarding which document name that expired, and when
IsValidLicence	bool	Gets or sets a value indicating whether licence is valid.
IsReviewFailed	bool	Gets or sets the flag indicating whether or not the document has failed review.
IsAwaitingReview	bool	Gets or sets the flag indicating whether or not the document is awaiting review.
UpdateDocument	bool	Gets or sets the flag indicating whether or not the document needs to be updated.
DutyOfCareExpiryMessages	string	Gets or sets the duty of care expiry messages.

DrivingLicenceDetails

Gives driving licence details

Property	Type	Comments	Rules

DrivingLicenceReviewRequest

Driving licence review request class

Property	Type	Comments	Rules
DrivingLicenceDetails	DutyOfCare.DrivingLicenceReviewDetails>	Gets or sets the driving licence details.

DuplicateFlaggedItem

The duplicate flagged item.

Property	Type	Comments	Rules
DuplicateExpenseID	int	Gets the id of the expense that caused the duplicate.
Fields	List<string>	Gets or sets a list of field descriptions that applies to this flag.	ReadOnly
FlaggedItemId	int	Gets or sets the flagged item id.
Flagtype	Common.Enum.FlagType	Gets the flagtype.
FlagDescription	string	Gets the standard text description provided by SEL
FlagText	string	Gets the custom text supplied by the client
FlagId	int	Gets the flag id.
FlagColour	FlagColour	Gets the flag colour.
ClaimantJustification	string	Gets the claimant justification.
AssociatedExpenses	List<AssociatedExpense>	Gets the associated expenses.
FailureReason	FlagFailureReason	Gets or sets the reason why a flag has failed validation
AuthoriserJustifications	List<AuthoriserJustification>	Gets the justifications provided by the authorisers
ExpenseDate	DateTime	Gets or sets the date of the expense the flagged item is for
ExpenseTotal	decimal	Gets or sets the total of the expense the flagged item is for
ExpenseSubcat	string	Gets or sets the expense item the flaged item is for
ExpenseCurrencySymbol	string	Gets or set the currency symbol of the expense
FlagTypeDescription	string	Gets or sets the Description for the flagged item
NotesForAuthoriser	string	Gets or sets the Notes for authorise for the flagged item
AssociatedExpenseItems	List<AssociatedExpenseItem>	Gets or sets a list of associated expense items for the flagged item
Action	FlagAction	Gets or sets the FlagAction for the flagged item
CustomFlagText	string	Gets or sets the custom flag text provided by administrators to show to claimants in the event of a breach.
ClaimantJustificationDelegateID	Nullable<int>	Gets or sets the id of the employee providing the justification if it was a delegate
DelegateName	string	The full name of the delegate providing the justification
ClaimantJustificationMandatory	bool	Gets or sets whether it is mandatory for the claimant to provide a justification
AuthoriserJustificationMandatory	bool	Gets or sets whether it is mandatory for the authoriser to provide a justification
DisplayFlagImmediately	bool	Gets a value indicating whether as soon as the expense has been added the claimant should be notified about this flag
Active	bool	Get or set whether the flagged item is active
ClaimantJustificationRequired	bool	Gets a value indicating whether the claimant must supply a justification if the item has been flagged

DutyOfCareDocument

A class to hold the DOC document name

Property	Type	Comments	Rules
DocumentName	string	Gets or sets the document name.

ElementAccessDetail

Defines, for a user, the appropriate access types for a given Element.

Property	Type	Comments	Rules
Id	int	The numeric value of the SpendManagementElement.	Required Must be a valid enum member
Label	string	The name of the SpendManagementElement.
AccessRights	AccessRights	The Access Rights for this ElementAccess.	Required

EmailAlias

Used to store information related to the email alias.

Property	Type	Comments	Rules
EmployeeId	int	Gets the employee identifier.	ReadOnly
AccountId	int	Gets the account identifier.	ReadOnly

EmailNotification

Encapsultes the data necessaray fpr a user to subscribe to events, via email.

Property	Type	Comments
Id	int	The unique Id of this EmailNotification.
Label	string	The Name of this EmailNotification.
Description	string	The description of this EmailNotification.
EmailTemplateId	int	The Id of the email template for this EmailNotification.
Enabled	bool	Whether this EmailNotification is enabled.
CustomerType	CustomerType	The CustomerType of this EmailNotification.
EmailNotificationType	EmailNotificationType	The EmailNotificationType of this EmailNotification.

Employee

Represents an Employee within the system. The employee is the base of Spend Management.

Property	Type	Comments	Rules
Id	int	The unique Id of this Employee.	Required
Title	string	The title of the employee. Mr, Ms etc.	Required
UserName	string	The user name of this Employee.	Required
Forename	string	The forename of the employee.	Required
Surname	string	The surname of the employee.	Required
EmployeeDetails	EmployeeDetails	General employee information.
OwnedVehicles	List<int>	The list of associated vehicles for this Employee. Do not try to modify this user's owned cars by changing this list. Instead use the Vehicles resource.	ReadOnly
PoolCars	List<int>	The list of associated pool cars for this Employee. Do not try to modify this user's pool cars by changing this list. Instead use the Vehicles resource.	ReadOnly
CorporateCards	List<int>	The list of associated corporate cards for this Employee. Do not try to modify this user's cards by changing this list. Instead use the CorporateCards resources.	ReadOnly
WorkAddresses	List<WorkAddressLinkage>	The list of work addresses at which this Employee works. These come in the form of an WorkAddressLinkage. Do not try to modify this user's WorkAddresses by changing this list. Instead use the Addresses resource.	ReadOnly
HomeAddresses	List<HomeAddressLinkage>	The list of home addresses for this Employee. These come in the form of an HomeAddressLinkage. Do not try to modify this user's HomeAddresses by changing this list. Instead use the Addresses resource.	ReadOnly
IsActive	bool	Whether the employee status is set to active.
DvlaConsentDate	Nullable<DateTime>	Gets or sets a value consent date of DVLA. The DVLA consent date is the consent provided date by the claimant.
DriverId	Nullable<int>	Gets or sets a value of driverId. The Driver ID of the licence holder.
LastPasswordChange	DateTime	The datetime of the last change.	ReadOnly
CurrentClaimReference	Nullable<int>	The current (most recent) claim number for this employee.	ReadOnly
CurrentExpenseItemReference	Nullable<int>	The current (most recent) expense item reference number for this employee.	ReadOnly
UserDefinedFields	List<UserDefinedFieldValue>	Any user defined fields.
ExcessMileage	double	The excess mileage value for the employee
SendPasswordKeyAndWelcomeEmail	bool	Gets or sets a field indicating whether to send a wecome email and password key. Only applicable when creating a new employee or activating an existing employee.
Archived	bool	Whether this object is in an archived status.

EmployeeBasic

The very basic parts to identify an employee.

Property	Type	Comments	Rules
Id	int	The unique Id of this Employee.
Title	string	The title of the employee. Mr, Ms etc.	Required
UserName	string	The user name of this Employee.	Required
Forename	string	The forename of the employee.	Required
Surname	string	The surname of the employee.	Required

EmployeeDetails

Represents the more general, Expenses-related inforamtion for an Employee.

Property	Type	Comments	Rules
ContactDetails	EmploymentContactDetails	The business contact details for this employee.
EmployeePermissions	EmployeePermissions	An EmployeePermissions object, which contains access roles associated with the user.
WorkDetails	WorkDetails	The Work details of the employee.
NhsDetails	NhsDetails	The NHS details of the employee.
PersonalDetails	PersonalDetails	The personal details of the employee.
ClaimSignOffDetails	ClaimSignOffDetails	The claim sign off details for the employee.
EmailNotifications	List<int>	A list of the Ids of Email Notifications applied to this Employee.	ReadOnly

EmployeeFullNameAndPosition

Defines a and all it's members

Property	Type	Comments	Rules
FullName	string	The full name
Position	string	The position

EmployeePermissions

Represents all of the AccessRoles that apply to an Employee. The access roles are represented by ids, to keep the objects simpler.

Property	Type	Comments	Rules
DefaultSubAccountId	Nullable<int>	The Default Sub Account Id of the employee. Leave this as null if you don't know what a sub account is or you don't have any sub accounts set up for your organisation.
AccessRoles	List<int>	The list of associated AccessRoles for this Employee. Do not try to modify this user's AccessRoles by changing this list. Instead use the AccessRoles resource.

EmployeePoolCar

Represents a shorthand way of linking an Employee to a PoolCar, without needing all the nested properties inherent in the PoolCar.

Property	Type	Comments	Rules
PoolCarId	int	The Id of the PoolCar.
ForDelete	bool	Gets or sets a value indicating whether the element supports deletion

EmployeesToPopulateDrivingLicence

Employee details to fetch driving licence from dvla portal

Property	Type	Comments	Rules

EmployeeToPopulateDrivingLicence

Gives employee details to fetch driving licence

Property	Type	Comments
DrivingLicenceNumber	string	Licence number
DrivingLicenceFirstname	string	Firstname as in licence
DrivingLicenceSurname	string	Surname as in licence
DrivingLicenceDateOfBirth	DateTime	Date of birth as in licence
DrivingLicenceSex	int	Gender
DriverId	long	Driver id which we get while providing consent
EmployeeId	int	Employeeid
DvlaLookUpDate	Nullable<DateTime>	Date on which last lookup performed against the driving licence for the employee

EmploymentContactDetails

Represents the basic contact details for an emnployee.

Property	Type	Comments
ExtensionNumber	string	The extension number of the employee.
MobileNumber	string	The mobile number of the employee.
PagerNumber	string	The mobile number of the employee.
EmailAddress	string	The email address of the employee.
FaxNumber	string	The fax number of the employee.
TelephoneNumber	string	The telephone number of the employee.

EsrAssignment

Represents an assigment of an Electronic Staff Record.

Property	Type	Comments
AssignmentId	long	The Assignment Id.
AssignmentNumber	string	The assignment number.
IsActive	bool	Whether the ESRAssignment is active.
IsPrimaryAssignment	bool	Whether this is the primary assignment.
StartDate	DateTime	The effective start date.
EndDate	Nullable<DateTime>	The effective end date.

ESRAssignmentBasic

A class which holds basic details of an ESR Assignment

Property	Type	Comments
AssignmentId	long	Gets or sets the assignment id.
AssignmentNumber	string	Gets or sets the assignment number.
AssignmentText	string	Gets or sets the assignment text.
EarliestAssignmentStartDate	DateTime	Gets or sets the earliest assignment start date.
EffectiveStartDate	Nullable<DateTime>	Gets or sets the effective start date.
EffectiveEndDate	Nullable<DateTime>	Gets or sets the effective end date.
Active	bool	Gets or sets if the assignment is active.

ESRAssignments

ESR assignments class.

Property	Type	Comments
Assignmentid	long	The unique Id for this ESR object.
EsrAssignId	long	The internal ESR assignment identifier.
AssignmentNumber	string	Gets or sets the assignment number assigned to employee.
CreatedBy	Nullable<int>	Gets or sets the creator of the assignment.
Active	bool	Gets or sets a value indicating whether assignment active or not.
Earliestassignmentstartdate	Nullable<DateTime>	Gets or sets the earliest assignment start date.
Finalassignmentenddate	Nullable<DateTime>	Gets or sets the final assignment end date.
Assignmentstatus	ESRAssignmentStatus	Gets or sets the assignment status assigne to employee.
Payrollpaytype	string	Gets or sets the assignment payroll paytype.
Payrollname	string	Gets or sets the assignment payroll name.
Payrollperiodtype	string	Gets or sets the assignment payroll periodtype.
Assignmentaddress1	string	Gets or sets the assignment address 1.
Assignmentaddress2	string	Gets or sets the assignment address 2.
Assignmentaddresstown	string	Gets or sets the assignment address town.
Assignmentaddresscountry	string	Gets or sets the assignment address country.
Assignmentaddresspostcode	string	Gets or sets the assignment address postcode.
Assignmentaddresscounty	string	Gets or sets the assignment address county.
Supervisorflag	bool	Gets or sets a value indicating whether supervisor flag.
Supervisorassignmentnumber	string	Gets or sets the supervisor assignmentnumber.
Supervisoremployementnumber	string	Gets or sets the supervisor employement number.
Supervisorfullname	string	Gets or sets the supervisor fullname.
Accrualplan	string	Gets or sets the assignment accrual plan.
Employeecategory	string	Gets or sets the employee category.
Assignmentcategory	string	Gets or sets the assignment category.
Primaryassignment	bool	Gets or sets a value indicating whether primary assignment.
Esrprimaryassignmentstring	string	Gets or sets the esr primary assignment value.
Normalhours	decimal	Gets or sets the assignment normal hours.
Normalhoursfrequency	string	Gets or sets the assignment normal hours frequency.
Gradecontracthours	decimal	Gets or sets the assignment grade contract hours.
Noofsessions	decimal	Gets or sets the assignment noof sessions.
Sessionsfrequency	string	Gets or sets the assignment sessions frequency.
Workpatterndetails	string	Gets or sets the assignment work pattern details.
Workpatternstartday	string	Gets or sets the assignment work pattern start day.
Flexibleworkingpattern	string	Gets or sets the flexible working pattern.
Availabilityschedule	string	Gets or sets the availability schedule.
Organisation	string	Gets or sets the organisation.
Legalentity	string	Gets or sets the legal entity.
Positionname	string	Gets or sets the position name.
Jobrole	string	Gets or sets the job role.
Occupationcode	string	Gets or sets the occupation code.
Assignmentlocation	string	Gets or sets the assignment location.
Grade	string	Gets or sets the grade.
Jobname	string	Gets or sets the job name.
Group	string	Gets or sets the group.
Tandaflag	string	Gets or sets the tanda flag.
Nightworkeroptout	string	Gets or sets the night worker optout.
Projectedhiredate	Nullable<DateTime>	Gets or sets the projected hire date.
Vacancyid	Nullable<int>	Gets or sets the vacancyid.
EsrLocationId	Nullable<long>	Gets or sets the esr location id.
CreatedOn	Nullable<DateTime>	Gets or sets the created on.
ModifiedOn	Nullable<DateTime>	Gets or sets the modified on.
ModifiedBy	Nullable<int>	Gets or sets the modified by.
EffectiveStartDate	Nullable<DateTime>	Gets or sets the effective start date.
EffectiveEndDate	Nullable<DateTime>	Gets or sets the effective end date.
SignOffOwner	Interfaces.IOwnership	The signoff owner
NumberOfSessions	decimal	Gets or sets the number of sessions.
EmployeeId	int	Gets or sets The employeeId the assignment is assoicated with.

ExchangeRates

Represents a set of exchange rates for a given currency.

Property	Type	Comments
MonthlyExchangeRates	List<CurrencyMonth>	The Currency Month - Only required when currency type = Monthly
DateRangeExchangeRates	List<CurrencyDateRange>	The Currency Date Range - Only required when currency type = Range
StaticExchangeRates	BaseCurrency	The Static Currency Rates - Only required when currency type = Static

ExpenseCategory

An expense category is a method of grouping similar ExpenseSubCategories.

Property	Type	Comments	Rules
Id	int	The Id of the ExpenseCategory.
Label	string	The Category Label.	Required Max Length: 50
Description	string	A description of the Expense Category.	Required Max Length: 4000

ExpenseItem

An Expense Item is part of a User's Claim. An ExpenseSubCategory is like a template against which a User submits expenses. ExpenseItem is like an instance of that template.

Property	Type	Comments	Rules
Id	int	The unique Id of this item in the database.
ReferenceNumber	string	The friendly code for this item.
ExpenseSubCategoryId	int	The Id of the ExpenseSubCategory (or template) that this item is an instance of.
ExpenseSubCategoryDescription	string	Gets or set the expense sub category description
ParentId	Nullable<int>	The Id of the parent ExpenseItem.
SplitItems	List<ExpenseItem>	If this item has been split then this contains a list of ExpenseItem making up the split expense
ClaimId	int	The Id of the claim to which this item belongs.
ClaimReasonId	int	The Id of the ClaimReason applicable to this item.
ClaimReasonInfo	string	The value for the reasonId lookup.
CurrencyId	int	The Id of the currency this item is to be claimed in.
CurrencySymbol	string	The symbol of the currency this item is to be claimed in.
CountryId	int	The Id of the country this item is to be claimed in.
ItemType	ExpenseItemType	The type of this item.
Date	DateTime	The date of this item.
PrimaryItem	bool	Whether this item is the primary item.
Returned	bool	Whether this item is returned to the claimant.
DisputeNotes	string	The notes for disputing this item.
TempAllow	bool	Whether the item should be temporarily allowed.
Corrected	bool	Whether this item has been corrected.
ItemCheckerId	Nullable<int>	The Id of the Item Checker.
ItemCheckerTeamId	Nullable<int>	The ID of the Team who is checking this expense item
FloatId	int	The Id of the float that has been configured.
AdvanceDescription	string	Gets or sets the description for the advance.
TransactionId	int	The Id of the transaction.
Quantity	double	The quantity of items
Net	decimal	The Net value of this item.
VAT	decimal	The amount of VAT on this item.
Total	decimal	The total value of this item.
AmountPayable	decimal	The amount payable.
VATNumber	string	The VAT number of the receipt issuer.
AccountCode	string	The account code.
BaseCurrency	int	The Base Currency (in case a conversion is needed).
BaseCurrencyGlobal	int	The Global Base Currency.
ForeignVAT	decimal	The VAT value for the foreign country.
ExchangeRate	double	The exchange rate between the home country and the item's target country.
ExchangeRateGlobal	double	The exchange rate, but the global value.
ConvertedTotal	decimal	The total after conversion.
GrandTotal	decimal	The Grand Total.
GlobalTotal	decimal	The Global Total.
GrandTotalGlobal	decimal	The Global Grand Total.
GrandTotalConverted	decimal	The Converted Global Grand Total.
GrandTotalNet	decimal	The Net Grand Total.
GrandTotalVAT	decimal	The Grand Total VAT.
GrandTotalAmountPayable	decimal	The amount of the Grand Total that is payable.
GrandTotalOther	int	Another grand total.
GrandTotalRemoteWorkers	int	The grand total for remote workers.
GrandTotalPersonalGuests	int	The grand total for personal guests.
UserSaysHasReceipts	bool	Whether the receipt has a VAT number and VAT rate
NormalReceipt	bool	Whether the expense item will have a receipt.
ReceiptAttached	bool	Whether this item has a receipt attached.
CarId	int	The Id of the vehicle used in this item.
VehicleDescription	string	Gets or sets the vehicle description.
MileageId	int	The Id of the Mileage item.
JourneySteps	List<JourneyStep>	The sorted list of int, JourneyStep that apply to this item.
DistanceUom	MileageUom	The distance's unit of measure of measure.
HomeToOfficeDeductionMethod	HomeToLocationType	The method by which mileage from home to office is deducted from travel for this item.
NumPassengers	byte	Number of passengers present in the vehicle for this item.
Miles	decimal	The number of miles for this item (if this is a travelling expense).
MileageBusiness	decimal	The number of business miles travelled (if this is a travelling expense).
MileagePersonal	decimal	The number of personal miles travelled (if this is a travelling expense).
FuelLitresPersonal	int	The number of litres of fuel for personal usage (if this is a travelling expense).
FuelLitresBusiness	int	The number of litres of fuel for business usage (if this is a travelling expense).
Attendees	string	A string list of people who were present.
NumStaff	byte	The number of staff present for this item.
NumDirectors	byte	The number of directors present for this item.
NumPersonalGuests	byte	The number of directors present for this item.
NumRemoteWorkers	byte	The number of directors present for this item.
NumOthers	byte	The number of others (non staff) for this item.
EventInHomeCity	bool	Whether this item was incurred in claimant's home town.
Tip	decimal	The tip given for a meal type item.
NumRooms	byte	Number of rooms for an accommodation item.
NumNights	byte	The number of nights stayed.
HotelId	int	The Id of the hotel.
HotelName	string	The name of the hotel.
Reason	string	The reason given for the existence of this item.
Notes	string	Notes
CompanyId	int	The company id of the other company related to this item.
CompanyName	string	The name of the company related to this item.
FromId	int	The Id of the From.
FromDescription	string	Gets or sets the From address description
ToId	int	The Id of the To.
ToDescription	string	Gets or sets the To address description
AllowanceId	int	The ID of the allowance for this item.
AllowanceStartDate	DateTime	The start date of the allowance.
AllowanceEndDate	DateTime	The end date of the allowance.
AllowanceDeduction	decimal	The ammount deductable from the allowance for this item.
CostCentreBreakdowns	List<CostCentreBreakdown>	The list of Cost Centre Breakdowns that apply to this item.
Flags	List<FlagSummary>	The list of flags for this item.
BlockedFlags	FlaggedItemsManager	The list blocked flags for this item
UserDefined	List<UserDefinedFieldValue>	User defined data for this item.
AddedAsMobileExpense	bool	Whether this was added as a mobile expense.
ESRAssignmentId	long	The Id for the attached ESR (if there is one)
ESRAssignmentDescription	string	Gets or sets the ESR Assignment description.
ValidationProgress	ExpenseValidationProgress	The current progress of this item in validation.
ValidationResults	List<int>	A list of the Ids of the Results of validation on this expense item. See ExpenseValidationResults.	ReadOnly
Edited	bool	Gets or sets a value indicating whether the expense item has been edited.
Paid	bool	Gets or sets a value indicating whether the expense item is paid.
OriginalExpenseId	Nullable<int>	Gets or sets the original expense id if this is a copied item from a previously paid then edited expense item.
BankAccountId	int	Gets or sets the bank account Id for the expense item
OperatorValidationProgress	ExpediteOperatorValidationProgress	Gets or sets the validation progress status by any expedite operator
ExpenseActionOutcome	Common.Enum.ExpenseActionOutcome	Gets or sets the expense action outcome.
MobileMetricDeviceId	Nullable<int>	Gets or sets the mobile metric device id, which is the internal identifier for the device.
WalletReceiptId	int	Gets or sets the ID of the wallet receipt to associate with this item.

ExpenseItemFlagSummary

Handles the flag summary details for an expense item

Property	Type	Comments
ExpenseId	int	Gets or sets the expense id.
FlagCollection	List<FlagSummary>	Gets or sets the Flag Collection
ExpenseTotal	string	Gets the expense total.
ExpenseDate	string	Gets the expense date.
ExpenseSubcat	string	Gets the name of the expense item (subcat).

ExpenseSubCategoriesMileageBasic

The expense sub categories mileage basic.

Property	Type	Comments
SubCatId	int	Gets or sets unique Id of the sub category.
SubCat	string	Gets or sets name of the sub category.
NoPassengersApplicable	bool	Gets or sets a value indicating whether number of passengers applicable for the sub category.
PassengersNameApplicable	bool	Gets or sets a value indicating whether to show names of passengers for the sub category.
AllowHeavyBulkyMileage	bool	Gets or sets a value indicating whether to allow heavy bulky mileage for the sub category.

ExpenseSubCategory

Represents an expenses sub category - so for an example, for an ExpenseCategory called "Travel", there could be ExpenseSubCategories called"mileage", "pedal cycle", "flights" and so on.

Property	Type	Comments	Rules
SubCatId	int	The unique Id of the sub category.
ParentCategoryId	Nullable<int>	The Id of the parent category.	Required
SubCat	string	The name of the sub category.
Description	string	The description of the sub category.
AllowanceAmount	decimal	The Allowance Amount of the sub category.
AccountCode	string	The Account Code for the sub category.
AddAsNet	bool	Whether to add the values for this category as Net.
PdCatId	Nullable<int>	The P11dCategory for the sub category.
CalculationType	CalculationType	The calculation type for the sub category.
Comment	string	The comment to be shown to claimants.
Reimbursable	bool	Whether the sub category is re-imbursable.
AlternateAccountCode	string	The Alternate Account Code for the sub category.
ShortSubCategory	string	The Abbreviation for the sub category.
VatApplicable	bool	Whether VAT is applicable for the sub category.
VatReceipt	bool	VAT Receipt needed
VatRates	List<SubCatVatRate>	The applicable VAT rates for the sub category.
MileageApplicable	bool	Whether to show the number of miles for the sub category.
StaffApplicable	bool	Whether to show the number of staff for the sub category.
OthersApplicable	bool	Whether to show the number of others for the sub category.
TipApplicable	bool	Whether to show the tip for the sub category.
TipLimit	Nullable<decimal>	Gets or sets the tip limit.
PersonalMilesApplicable	bool	Whether to the show the number of personal miles for the sub category.
BusinessMilesApplicable	bool	Whether to show the number of Business Miles for the sub category.
AttendeesApplicable	bool	Whether to show the Attendees list for the sub category.
EventInHomeApp	bool	Whether to show the event in home city for the sub category.
ReceiptApplicable	bool	Whether to show normal receipt for the sub category.
NoPersonalGuestApplicable	bool	Whether to show the number of spouses / partners for the sub category.
PassengersApplicable	bool	Whether to show passengers for the sub category.
NoPassengersApplicable	bool	Whether number of passengers applicable for the sub category.
PassengersNameApplicable	bool	Whether to show names of passengers for the sub category.
SplitEntertainment	bool	Whether entertainment is to be split for the sub category.
EntertainmentId	int	The associated entertainment subcategory Id for the sub category.
NoNightsApplicable	bool	Whether number of nights applicable applies to the sub category.
AttendeesMandatory	bool	Whether attendee list is mandatory for the sub category.
NoDirectorsApplicable	bool	Whether number of directors applicable for the sub category.
HotelApplicable	bool	Whether hotel name is applicable for the sub category.
NoRoomsApplicable	bool	Whether the number of rooms is applicable for the sub category.
HotelMandatory	bool	Whether the hotel number is mandatory for the sub category.
VatNumberApplicable	bool	Whether the VAT number is shown for the sub category.
VatNumberMandatory	bool	Whether the VAT number is mandatory for the sub category.
NoRemoteWorkersApplicable	bool	Whether the number of remote workers is shown for the sub category.
SplitPersonal	bool	Whether to split to partners/ spouses for the sub category.
SplitRemote	bool	Whether to show the split to remote workers for the sub category.
PersonalId	int	The sub category to split personal amount to.
RemoteId	int	The sub category id to split remote worker amount to.
ReasonApplicable	bool	Whether the reason is applicable for the sub category.
OtherDetailsApplicable	bool	Whether other details are applicable for the sub category.
UserDefined	List<UserDefinedFieldValue>	The list of user defined fields associated with this sub category.
FromApplicable	bool	Whether the 'From' field is applicable for the sub category.
ToApplicable	bool	Whether the 'To' field is applicable for the sub category.
Countries	List<CountrySubCat>	Gets or sets the list of country - subcategory associations for the sub category.
Allowances	List<int>	List of allowances for the sub category.
AssociatedUdfs	List<int>	List of associated user defined functions for the sub category.
Split	List<ExpenseSubCategory>	List of expense items to split for the sub category.
CompanyApplicable	bool	Whether Company is applicable for the sub category.
EnableHomeToLocationMileage	bool	Whether home to location mileage is enabled for the sub category.
HomeToLocationType	HomeToLocationType	The Home-to-Location type for the sub category.
MileageCategory	Nullable<int>	The Mileage Category for the sub category, if one exists.
IsRelocationMileage	bool	Whether the mileage is relocation mileage.
ReimbursableSubCatId	Nullable<int>	The Re-imbursable Sub category id for the sub category.
AllowHeavyBulkyMileage	bool	Whether to allow heavy bulky mileage for the sub category.
HomeToOfficeAsZero	bool	Whether home to office is zero for the sub category.
StartDate	Nullable<DateTime>	The start date for the sub category.
EndDate	Nullable<DateTime>	The end date for the sub category.
Validate	bool	Whether expense items for this subcat should be validated.
ValidationRequirements	ExpenseValidationCriterion>	The requirements against which items for this should be validated.
HomeToOfficeFixedMiles	Nullable<float>	The number of fixed miles to deduct
PublicTransportRate	Nullable<int>	The public transport rate to deduct
EnableDoc	bool	Enable Duty of care check at expense item level, for Mileage expense item type.
CurrencySymbol	string	Gets or sets the currency symbol.
MaximumLimitWithoutReceipt	decimal	Gets or sets the maximum limit without receipt.
MaximumLimit	decimal	Gets or sets the maximum limit.
UserDefinedFields	List<UserDefinedFieldType>	Gets or sets UDFs(item specific ones only) for respective sub category.
ValidDates	List<SubCatDates>	Gets or sets a or which define the valid ranges for this
ForcedFixedMileageDeduction	bool	Enable Force Fixed Mileage Deduction against a Mileage expense item type.
NumberOfMiles	decimal	The Number of Miles to be deducted against a Mileage expense item type.
DailyDeductionItemId	int	The Mileage expense item type that will have the Forced Fixed Mileage Deduction.

ExpenseSubCategoryBasic

Property	Type	Comments
SubcatId	int	The subcat id
Subcat	string	The subcat name
VatApp	bool	Whether VAT is applicable for the sub category.
CalculationType	CalculationType	The calculation type
P11DCategoryId	int	P11D Category Id
CategoryId	int	Category Id
StartDate	Nullable<DateTime>	Subcat start date
EndDate	Nullable<DateTime>	Subcat end date

ExpenseSubCategoryItemRoleBasic

Represents a basic version of a subcat

Property	Type	Comments
SubcatId	int	The subcat id
Subcat	string	The subcat name
ShortSubcat	string	The Short Subcat Name
Maximum	decimal	Maximum
ReceiptMaximum	decimal	The Receipt Maximum
CategoryId	int	The CategoryId
CalculationType	CalculationType	The calculation type
FromApp	bool	Whether the 'From' field is applicable for the sub category.
ToApp	bool	Whether the 'To' field is applicable for the sub category.
Description	string	The Description
CurrencySymbol	string	The symbol of the currency

ExpenseSubCategoryNames

Property	Type	Comments	Rules
SubCatId	int	The Subcat Id.
Name	string	The Subcat name.

Favourite

A class fo handleing employee personal favourite

Property	Type	Comments
FavouriteId	int	Gets or sets the favourite id.
EmployeeId	Nullable<int>	Gets or sets the employee id.
AddressId	int	Gets or sets the address id.
GlobalIdentifier	string	Gets or sets the global identifier.
AddressFriendlyName	string	Gets or sets the address friendly name.

FilterRule

A class to deal with information relating to a FilterRule

Property	Type	Comments
FilterId	int	The filter Id
Parent	FilterType	The Filter Type Parent
Child	FilterType	The Filter Type Child
RuleValues	Dictionary<int, FilterRuleValues>	The List of Rule Values that apply to this Filter Rule
ParentUdfId	int	The Parent Udf Id
ChildUdfId	int	The Child Udf Id
Enabled	bool	Is enabled?
CreatedOn	DateTime	The created on date
CreatedBy	int	The id of the person who created the filter rule

FilterRuleItem

A class to deal with a filter rule Item. This could be a control name or details or element details

Property	Type	Comments	Rules
Item	string	The Item details

FilterRuleListItem

A class to deal with the ListItem information of a filter rule

Property	Type	Comments	Rules
Description	string	The item description
Identifier	string	The identifier

FilterRuleValues

A class to hold the filter rule values that belong to a FilterRule.

Property	Type	Comments
FilterRuleId	int	The filter rule id.
ParentId	int	The parent id.
ChildId	int	The child id.
FilterId	int	The filter id.
CreatedOn	DateTime	When the value was created.
CreatedBy	int	Who created the filter rule value.

FinancialYear

Financial Year Class. Year Start and Year End are a 1900 based date to determine the financial year.

Property	Type	Comments
FinancialYearID	int	Financial Year Id.
Description	string	Description.
Active	bool	Whether the financial year is active.
Primary	bool	Whether the financial year is primary.
YearStart	string	Financial Year Start
YearEnd	string	Financial Year End

Flag

The flag request.

Property	Type	Comments	Rules
FlagId	int	Gets or sets the flag id.
FlagType	FlagType	Gets or sets the flag type.
FlagAction	FlagAction	Gets or sets the flag action.
CustomFlagText	string	Gets or sets the custom flag text.
InvalidDateFlagType	InvalidDateFlagType	Gets or sets the invalid date flag type.
Date	Nullable<DateTime>	Gets or sets the date.
Months	Nullable<byte>	Gets or sets the months.
AmberTolerance	Nullable<decimal>	Gets or sets the amber tolerance.
Frequency	Nullable<byte>	Gets or sets the frequency.
FlagFrequencyType	FlagFrequencyType	Gets or sets the flag frequency type.
Period	Nullable<byte>	Gets or sets the period.
FlagPeriodType	FlagPeriodType	Gets or sets the flag period type.
Limit	Nullable<decimal>	Gets or sets the limit.
Description	string	Gets or sets the description.
Active	bool	Gets or sets a value indicating whether active.
ClaimantJustificationRequired	bool	Gets or sets a value indicating whether claimant justification required.
DisplayImmediately	bool	Gets or sets a value indicating whether display immediately.
FlagTolerancePercentage	Nullable<decimal>	Gets or sets the flag tolerance percentage.
FinancialYear	Nullable<int>	Gets or sets the financial year.
TipLimit	Nullable<decimal>	Gets or sets the tip limit.
FlagLevel	FlagColour	Gets or sets the flag level.
ApproverJustificationRequired	bool	Gets or sets a value indicating whether approver justification required.
IncreaseLimitByNumOthers	bool	Gets or sets a value indicating whether increase limit by num others.
DisplayLimit	bool	Gets or sets a value indicating whether display limit.
NotesForAuthoriser	string	Gets or sets the notesforauthoriser.
ItemRoleInclusionType	FlagInclusionType	Gets or sets the item role inclusion type.
ExpenseItemInclusionType	FlagInclusionType	Gets or sets the expense item inclusion type.
PassengerLimit	Nullable<int>	Gets or sets the passenger limit.
ValidateSelectedExpenseItem	bool	Gets or sets a value indicating whether validate selected expense item.
FlagDescritpion	string	Gets or sets the flag description.
FlagTypeDescription	string	Gets or sets the flag item description.	ReadOnly
DailyMileageLimit	Nullable<decimal>	Gets or sets the Daily Mileage Limit (used for Flag types

FlaggedItem

Represents an item which has been flagged by the flags and limits module.

Property	Type	Comments
FlaggedItemId	int	Gets or sets the flagged item id.
Flagtype	Common.Enum.FlagType	Gets the flagtype.
FlagDescription	string	Gets the standard text description provided by SEL
FlagText	string	Gets the custom text supplied by the client
FlagId	int	Gets the flag id.
FlagColour	FlagColour	Gets the flag colour.
ClaimantJustification	string	Gets the claimant justification.
AssociatedExpenses	List<AssociatedExpense>	Gets the associated expenses.
FailureReason	FlagFailureReason	Gets or sets the reason why a flag has failed validation
AuthoriserJustifications	List<AuthoriserJustification>	Gets the justifications provided by the authorisers
ExpenseDate	DateTime	Gets or sets the date of the expense the flagged item is for
ExpenseTotal	decimal	Gets or sets the total of the expense the flagged item is for
ExpenseSubcat	string	Gets or sets the expense item the flaged item is for
ExpenseCurrencySymbol	string	Gets or set the currency symbol of the expense
FlagTypeDescription	string	Gets or sets the Description for the flagged item
NotesForAuthoriser	string	Gets or sets the Notes for authorise for the flagged item
AssociatedExpenseItems	List<AssociatedExpenseItem>	Gets or sets a list of associated expense items for the flagged item
Action	FlagAction	Gets or sets the FlagAction for the flagged item
CustomFlagText	string	Gets or sets the custom flag text provided by administrators to show to claimants in the event of a breach.
ClaimantJustificationDelegateID	Nullable<int>	Gets or sets the id of the employee providing the justification if it was a delegate
DelegateName	string	The full name of the delegate providing the justification
ClaimantJustificationMandatory	bool	Gets or sets whether it is mandatory for the claimant to provide a justification
AuthoriserJustificationMandatory	bool	Gets or sets whether it is mandatory for the authoriser to provide a justification
DisplayFlagImmediately	bool	Gets a value indicating whether as soon as the expense has been added the claimant should be notified about this flag
Active	bool	Get or set whether the flagged item is active
ClaimantJustificationRequired	bool	Gets a value indicating whether the claimant must supply a justification if the item has been flagged

FlaggedItemsManager

Handles the Flagged items for an expense item.

Property	Type	Comments
Claimant	bool	Gets or sets whether it is the claimant generating the current summary.
Stage	Nullable<int>	Gets or sets The stage the claim is at the flag line is on.
Authorising	bool	Gets or sets whether the claim is currently being authorised.
SubmittingClaim	bool	Gets or sets a value indicating whether submitting claim.
OnlyDisplayBlockedItems	bool	Gets or sets whether to only showed the flagged items that have caused a block.
PageSource	string
AllowingOrApproving	bool	Gets or sets whether the authoriser is currently allowing items or approving the claim.
ClaimantName	string	Gets or sets the claimant name.
ExpenseCollection	List<ExpenseItemFlagSummary>	Gets or sets the expense collection.
Count	int	The number of flagged items in the collection.

FlagSummary

A flagged item and associated flag id.

Property	Type	Comments	Rules
FlagId	int	Gets the flag id.	ReadOnly
sComments	string	Gets the flagDescription as sComments to pass to the mobile ap
FlaggedItem	FlaggedItem	Gets the flagged item.

FromSettings

The fields settings for From field

Property	Type	Comments
DisplayAs	string	What to display in the field label
DisplayForCash	bool	Whether to showFrom field for cash items
DisplayForCreditCard	bool	Whether to showFrom field for credit card items
DisplayForPurchaseCard	bool	Whether to showFrom field for purchase card items
DisplayOnIndividualItem	bool	Whether to showFrom field for individual expense items
MandatoryForCash	bool	WhetherFrom field is mandatory for cash items
MandatoryForCreditCard	bool	WhetherFrom field is mandatory for credit card items
CanAddFromField	bool	Whether the account permits employees to add a new From field from Add/Edit Expense

FuelRate

A Fuelrate defines the vehicle journey rate threshold rate.

Property	Type	Comments
MileageThresholdRateId	Nullable<int>	The unique Id of this threshold rate.
MileageThresholdId	Nullable<int>	The Id of the mileage threshold.
VehicleEngineTypeId	VehicleEngineType	The vehicle engine type id.
RatePerUnit	Nullable<decimal>	The rate per unit.
AmountForVat	Nullable<decimal>	The vat amount.

GeneralOption

Represents a global or account specific option in the system.

Property	Type	Comments
SubAccountId	int	The sub account this general option is specific to.
Key	string	The look-up identifier for this general option.
Value	string	The value to store in this general option.
PostKey	string	The form post key.
IsGlobal	bool	Specifies if this general option is applicable to all accounts.

GeneralOptionsDisplayFieldSetting

Represents a setting that can be enabled in general options to display these fields when claiming for an expense

Property	Type	Comments
Code	string	Gets or sets the generic code for the field
DisplayAs	string	Gets or sets the friendly name that can be set to the field
DisplayForCash	bool	Gets or sets a value indicating whether the field should be displayed for cash items.
DisplayForCreditCard	bool	Gets or sets a value indicating whether the field should be displayed for credit card items.
DisplayForPurchaseCard	bool	Gets or sets a value indicating whether the field should be displayed for purchase card items.
DisplayOnIndividualItem	bool	Gets or sets a value indicating whether the field should be displayed in general details ot for individual items.
MandatoryForCash	bool	Gets or sets a value indicating whether the field should be mandatory for cash items.
MandatoryForCreditCard	bool	Gets or sets a value indicating whether the field should be mandatory for credit card items.
MandatoryForPurchaseCard	bool	Gets or sets a value indicating whether the field should be mandatory for purchase card items.

GlobalCountry

A Global Country is an immutable country that exists on Earth. Different Accounts pull in which countries they wish to use, by way of a Country.

Property	Type	Comments
GlobalCountryid	int	The unique Id for this global country.
Country	string	The name of this global country.
CountryCode	string	The country code for this global country.
Alpha3CountryCode	string	The ISO 3166-1 alpha-3 country code (three digit country code).
Numeric3CountryCode	int	The ISO 3166-1 numeric-3 country code (three digit number country code).
PostcodeRegex	string	The regex format for this countries postcode if we have it, if not it returns an empty string.
PostcodeAnywhereEnabled	bool	Whether or not this country can be used with Postcode Anywhere (for address search and distance/directions lookups).

GlobalCurrency

A Global Currency is an immutable curency that exists on Earth. Different Accounts pull in which currency they wish to use, by way of a Currency.

Property	Type	Comments
GlobalCurrencyId	int	The unique Id of this global currency.
Label	string	The label for this global currency.
AlphaCode	string	The Alpha code, as per ISO 3166-1 alpha 3.
NumericCode	string	The 3 Letter currency code, as per ISO 3166-1.
Symbol	string	The Symbol for this global currency.

HomeAddressLinkage

Ties an Address to an Employee.

Property	Type	Comments	Rules
Id	int	The unique Id of this item in the database.
StartDate	Nullable<DateTime>	Gets or sets the start date for this Address.
EndDate	Nullable<DateTime>	Gets or sets the end date for this Address.
EmployeeId	int	The Id of the Employee to be linked to the Address.	Required
AddressId	int	The Id of the Address to be linked to the Employee.	Required

HomeContactDetails

Contact Details for the employee.

Property	Type	Comments
EmailAddress	string	The email address of the employee.
FaxNumber	string	The fax number of the employee.
TelephoneNumber	string	The telephone number of the employee.

Hotel

A Type to hold information relating to a hotel

Property	Type	Comments	Rules
Id	int	The Id of the Hotel	Required
HotelName	string	The name of the hotel	Required
Address1	string	The first line of the address
Address2	string	The second line of the address
City	string	The city
County	string	The county
PostCode	string	The post code
Country	string	The country

IBankAccount

Interface for defining BankAccount properties and methods

Property	Type	Comments
BankAccountId	int	Get or sets the bank account ID
EmployeeId	int	Get or sets the employeeID of the employee who owns this bank account
AccountName	string	Get or sets the name given to this account by the user
AccountNumber	string	Get or sets the unique number given to this account by the user
AccountType	int	Get or sets the account type
SortCode	string	Get or sets the sort code
Reference	string	Get or sets the reference value
CurrencyId	int	Get or sets the currency id
CurrencyName	string	Gets or sets the currency name.
CountryId	int	Get or sets country id
Archived	bool	archived
Outcome	string	The outcome of an action against a bank account i.e. save/edit
Iban	string	Gets or sets Iban of an account number
SwiftCode	string	Gets or sets the Swift code of an account number

ItemRole

An ItemRole is a collection of ExpenseSubCategories, grouped togther in a neat group to be able to be assigned to a user. It is the equivalent in terms of structure to how an AccessRole object contains multiple sets of permisssion, which are assigned in bulk to a User.

Property	Type	Comments
ItemRoleId	int	The unique Id of the item role.
RoleName	string	The name of the item role.
Description	string	The description of the item role.
SubCatItemRoles	List<SubCatItemRole>	The associated sub categories for the item role.

JourneyStep

A representation of Journey Steps for expenses.

Property	Type	Comments
ExpenseId	int	The expense id associated with
StartLocation	Address	The start location.
EndLocation	Address	The end location.
NumberOfMiles	decimal	The number of miles.
RecordedMiles	decimal	The recorded amount of miles.
NumberOfPassengers	byte	The number of passengers.
Passengers	List<Passenger>	The passenger details on the journey step
StepNumber	byte
ExceededRecommendedMileage	bool	The current step number of the journey.
ExceededRecommendedMileageComment	string	Comment for when the recommended mileage has been exceeded.
NumberOfActualMiles	decimal	The number of miles entered by the user. Does not takes into account reduction for home to office rules etc
HeavyBulkyEquipment	bool	Check to see if any heavy bulky equipment mileage is associated

JourneyStepValidation

Defines a and all it's members

Property	Type	Comments	Rules
Valid	bool	States whether the was valid or not
Message	string	The validation message for the

ListItemData

Represents the data that makes up a list item

Property	Type	Comments	Rules
Value	int	The value of the list item
Text	string	The text of a list item

Locale

Represents the Locale of an object. This will usually be the language specific information for a user.

Property	Type	Comments
LocaleId	int	The unique Id of this Locale.
LocaleCode	string	The unique code of this Locale.
LocaleName	string	The name of this Locale.
IsActive	bool	Whether the locale is currently active.

MileageCategory

Defines the amount of money an employee will get paid per unit of distance, and within particular date ranges.

Property	Type	Comments	Rules
MileageCategoryId	int	The unique Id for this mileage category.
Label	string	The label for this mileage category.	Required
Comment	string	The comment for this mileage category.
ThresholdType	ThresholdType	The ThresholdType for this mileage category.	Required
CalculateNewJourneyTotal	bool	Whether new journey totals should be calculated for this mileage category.
DateRanges	List<DateRange>	A list of date ranges that define when this mileage category applies.
UnitOfMeasure	MileageUOM	The unit of measure for this mileage category.	Required Must be a valid enum member
Currency	int	The Id of the currency that applies to this mileage category.
NhsMileageCode	string	The user rates table.	Required
StartEngineSize	int	The user rates from engine size.
EndEngineSize	int	The user rates to engine size.
FinancialYearId	Nullable<int>	The Id of the financial year for this mileage category.
TooltipInfo	string	The tooltip for the mileage category
HomeToOfficeDeductionRules	string	Gets or sets the home to office deduction rules.

MileageCategoryBasic

The mileage category basic

Property	Type	Comments
MileageCategoryId	int	Gets or sets the mileage category id.
Label	string	Gets or sets the label.
UnitOfMeasure	MileageUom	Gets or sets the unit of measure.
TooltipInfo	string	Gets or sets the tooltip information
HomeToOfficeDeductionRules	string	Gets or sets the text home to office deduction rules

MobileJourneyStep

Defines a and all it's members

Property	Type	Comments
Postcode	string	Gets or sets the postcode.
AddressLine1	string	Gets or sets the Street.
City	string	Gets or sets the City.

MyAdvance

A class that defines all the fields that makes up an advance.

Property	Type	Comments
AccountId	int	Gets or sets the account id.
AdvanceId	int	Gets or sets the advance id.
EmployeeId	int	Gets or sets the employee id.
CurrencyId	int	Gets or sets the currency id.
CurrencyName	string	Gets or sets the currency name.
CurrencySymbol	string	Gets or sets the currency symbol.
Name	string	Gets or sets the advance name.
Reason	string	Gets or sets the reason for the advance.
RequiredBy	DateTime	Gets or sets the date time the advance is required by.
Approved	bool	Gets or sets a value indicating whether the advance has been approved.
Approver	int	Gets or sets the employee id of the approver.
ApproverName	string	Gets or sets the approver name.
Amount	decimal	Gets or sets the amount.
ForeignAmount	decimal	Gets or sets the foreign amount.
ExchangeRate	double	Gets or sets the exchange rate.
Stage	byte	Gets or sets the stage.
StageDescription	string	Gets the stage description.
Rejected	bool	Gets or sets a value indicating whether the advance was rejected.
RejectReason	string	Gets or sets the reject reason.
Disputed	bool	Gets or sets a value indicating whether the advance is disputed.
Dispute	string	Gets or sets the reason for dispute.
Paid	bool	Gets or sets a value indicating whether the advance is paid.
DatePaid	DateTime	Gets or sets the date paid.
IssueNumber	int	Gets or sets the issue number.
BaseCurrency	int	Gets or sets the base currency.
AdvanceUsed	decimal	Gets or sets the is the advance is used.
Settled	bool	Gets or sets a value indicating whether the advance is settled.
Allocations	SortedList<int, decimal>	Gets or sets the allocations.
CreatedOn	DateTime	Gets or sets the created on.
CreatedBy	int	Gets or sets the created by.
ModifiedOn	DateTime	Gets or sets the modified on.
ModifiedBy	int	Gets or sets the modified by.

NhsDetails

Represents all the details of an NHS Trust (unit / company / area).

Property	Type	Comments	Rules
TrustId	Nullable<int>	The unique trust Id. You can find Trusts by looking at the NhsTrusts resource.
NhsUniqueId	string	The NHS Unique Id for this NHS trust.

NhsTrust

Represents an NHS Trust. This is usually a regional sub-company or unit.

Property	Type	Comments
Id	int	The unique Id of this NHS Trust in the expenses database.
TrustVpd	string	The unique Id of this NHS Trust, internally for the NHS.
Label	string	The name of the NHS Trust.
Archived	bool	Whether this object is in an archived status.

OdometerReading

Represents an individual reading of a vehicles odometer. An Odometer is the clock of how many miles or kilometres the vehicle has travelled in its lifetime.

Property	Type	Comments
OdometerReadingId	int	The unique Id of this odometer reading.
CarId	int	The Id of the Vehicle this reading is attached to.
ReadingDate	DateTime	The date this odometer reading was taken.
OldReading	int	The value of the odometer at the last reading.
NewReading	int	The new value of the odometer at this reading.
ForDelete	bool	Gets or sets a value indicating whether the element can be deleted

OdometerReadings

Represents a container for Odometer Readings, with a few extra pieces of data.

Property	Type	Comments	Rules
OdometerReadingRequired	bool	Whether Odometer Readings are required to be kept for this Vehicle. If this is set to true, then the OdometerReadings property must be populated when claimants claim.
StartOdometerReading	long	Gets or sets starting odometer reading
EndOdometerReading	int	Gets or sets ending odometer reading
OdometerReadingList	List<int>	Gets or sets the list of individual odometer readings' Ids.	ReadOnly

OptionalGeneralDetails

Represents all of the personal information for a given user. This includes names, locale and enrcypted password data.

Property	Type	Comments
Gender	string	The Gender of the employee.
DateOfBirth	Nullable<DateTime>	The Date of birth of the employee.
MiddleName	string	The middle name(s), if any, of the employee.
MaidenName	string	The maiden name, if any, of the employee.
PreferredName	string	The preferred name of the employee.
LocaleId	Nullable<int>	The Id of the locale of the employee.

Organisation

A Organisation is a unit of financial information against which you record expenditure.
An Employee or an ExpenseSubCategory.

Property	Type	Comments	Rules
Id	int	The Id of this object.
Label	string	The name / label for this Organisation object.	Required Max Length: 256
ParentOrganisationId	Nullable<int>	The Parent Organisation ID
Comment	string	A comment of this Organisation object.	Max Length: 4000
Code	string	The Organisation code	Max Length: 60
PrimaryAddressId	Nullable<int>	The primary address ID
AddressLine1	string	The first line of the address
City	string	The City
PostCode	string	The Postcode
OrganisationActionOutcome	OrganisationActionOutcome	The outcome of an action relating to Organisations
Archived	bool	Whether this object is in an archived status.

OrganisationSettings

The fields settings for Organisation

Property	Type	Comments
DisplayAs	string	What to display in the field label
DisplayForCash	bool	Whether to show Organisation for cash items
DisplayForCreditCard	bool	Whether to show Organisation for credit card items
DisplayForPurchaseCard	bool	Whether to show Organisation for purchase card items
DisplayOnIndividualItem	bool	Whether to show Organisation for individual expense items
MandatoryForCash	bool	Organisation is mandatory for cash items
MandatoryForCreditCard	bool	Organisation is mandatory for credit card items
MandatoryForPurchaseCard	bool	Organisation is mandatory for purchase card items
CanAddNewOrganisation	bool	Whether the account permits employees to add a new organisation from Add/Edit Expense

OtherDetailsSettings

The fields settings for OtherDetails

Property	Type	Comments
DisplayAs	string	What to display in the field label
DisplayForCash	bool	Whether to show OtherDetails for cash items
DisplayForCreditCard	bool	Whether to show OtherDetails for credit card items
DisplayForPurchaseCard	bool	Whether to show OtherDetails for purchase card items
DisplayOnIndividualItem	bool	Whether to show OtherDetails for individual expense items
MandatoryForCash	bool	Whether OtherDetails is mandatory for cash items
MandatoryForCreditCard	bool	Whether OtherDetails is mandatory for credit card items
CanAddNewOtherDetails	bool	Whether the account permits employees to add a new OtherDetails from Add/Edit Expense

P11DCategory

A P11D Category is a category that the system uses to group expense items, for compliance when filling out P11D forms. You assign Expense Items to a P11D Category. P11D forms are submitted to HMRC.
For more information on P11D, see http://www.hmrc.gov.uk/payerti/exb/forms.htm.

Property	Type	Comments	Rules
Id	int	The unique Id.
Label	string	The name or label for this Expense Category.	Required Max Length: 50
ExpenseSubCategoryIds	List<int>	A List of ExpenseSubCategory IDs items that full under this P11DCategory. Important: Use the ExpenseSubCategories resource to add and update those. You can link them using this resource.

Passenger

The passenger class for holding information about a passenger

Property	Type	Comments	Rules
PassengerId	Nullable<int>	Gets or sets the PassengerId.
Name	string	Gets or sets the name.

PersonalDetails

Represents a collection of information about an Employee.

Property	Type	Comments	Rules
BasicInfo	OptionalGeneralDetails	The optional basic information for the employee.
HomeContactDetails	HomeContactDetails	The home contact details for the employee.

ProjectCode

A ProjectCode is a unit of business information against which you record expenditure, in a similar way to CostCodes.

Property	Type	Comments	Rules
Id	int	The Id for the Project Code.
Label	string	The label or name for the Project Code.	Required Max Length: 50
Description	string	The description for the Project Code.	Required Max Length: 4000
Rechargeable	bool	Whether this project code is rechargeable.
UserDefined	List<UserDefinedFieldValue>	A list of user-defined objects.
Archived	bool	Whether this object is in an archived status.

ProjectcodeSettings

Project code settings

Property	Type	Comments
DisplayAs	string	What to display in the field label
DisplayForCash	bool	Whether to showFrom field for cash items
DisplayForCreditCard	bool	Whether to showFrom field for credit card items
DisplayForPurchaseCard	bool	Whether to showFrom field for purchase card items
DisplayOnIndividualItem	bool	Whether to showFrom field for individual expense items
MandatoryForCash	bool	WhetherFrom field is mandatory for cash items
MandatoryForCreditCard	bool	WhetherFrom field is mandatory for credit card items
CanAddFromField	bool	Whether the account permits employees to add a new From field from Add/Edit Expense

ReasonSettings

The fields settings for Reason

Property	Type	Comments
DisplayAs	string	What to display in the field label
DisplayForCash	bool	Whether to show Reason for cash items
DisplayForCreditCard	bool	Whether to show Reason for credit card items
DisplayForPurchaseCard	bool	Whether to show Reason for purchase card items
DisplayOnIndividualItem	bool	Whether to show Reason for individual expense items
MandatoryForCash	bool	Whether Reason is mandatory for cash items
MandatoryForCreditCard	bool	Whether Reason is mandatory for credit card items
CanAddNewReason	bool	Whether the account permits employees to add a new Reason from Add/Edit Expense

Receipt

Representing receipt object details uploaded for an expense item.

Property	Type	Comments
Id	int	Gets or sets the id.
ReceiptUrl	string	Gets or sets the receipt url.
ReceiptData	string	Gets or sets a Base64 string which represents the receipt data.
ReceiptThumbnailUrl	string	Gets or sets the receipt thumbnaile url.
ReceiptThumbnailData	string	Gets or sets a Base64 string which represents the receipt thumbnail data.
Extension	string	Gets or sets the extension.
MimeHeader	string	Gets or sets the mime header.
IsApprover	bool	Gets or sets a value indicating whether is approver.

ReturnedExpenseItem

Property	Type	Comments	Rules

SaveUpdateClaimResult

The result of Saving or Editing a Claim

Property	Type	Comments	Rules
Id	int	The id of the claim.
SaveEditClaimOutcome	SaveEditClaimOutcome	The outcome of the action

SignOffGroup

Represents a group of stages that a claim has to go through in order to be approved and therefore paid.

Property	Type	Comments
GroupId	int	The unique Id of the signoffgroup.
GroupName	string	The name of the signoffgroup.
Description	string	The description of the signoffgroup.
OneClickAuthorization	bool	Whether the signoffgroup supports OneClickAuthorization.
Stages	List<Stage>	The list of stages that comprises this signoffgroup.

SignoffGroupBasic

The basic description of a Signoff Group

Property	Type	Comments	Rules
GroupId	int	The unique Id of the signoffgroup.	Required
GroupName	string	The name of the signoffgroup.	Required
Description	string	The description of the signoffgroup.

SornVehicle

The Sorn vehicle.

Property	Type	Comments	Rules
vehicleId	int	Gets or sets the vehicle id.
Registration	string	Gets or set the vehicle registration

SSOEmployee

Defines a

Property	Type	Comments
CompanyId	string	The Company Id of the
AccountId	int	The Account Id of the
EmployeeId	int	The Employee Id of the
Username	string	The Username of the
Active	bool	Whether the is active

Stage

Defines a stage in a SignOffGroup.

Property	Type	Comments	Rules
SignOffId	int	The unique Id of this stage.
SignOffType	SignoffType	The SignOffType of this stage.
SignOffStage	byte	The name or label of this stage.
Relid	int	The Id of this stage's related user.
RelSignOffPerson	string	The name of this stage's related user.	ReadOnly
StageInclusionType	StageInclusionType	The InclusionType of this stage.
Amount	decimal	The amount of this stage.
Notify	Notify	The notify for this stage.
OnHolidayProvision	HolidayProvision	The action to be taken when the approver is on holiday.
HolidayType	SignoffType	The holiday delegate sign off type.
HolidayId	int	The specific id of holiday delegate type.
HolidayDelegate	string	The holiday delegate name.	ReadOnly
IncludeId	int	The included item id of the inclusion type specified.
IncludedItem	string	The included item description.
ClaimantMail	bool	The claimant mail of this stage.
SingleSignOff	bool	The single sign off of this stage.
SendMail	bool	The send mail of this stage.
DisplayDeclaration	bool	The display declaration of this stage.
EmployeeId	int	The employee id of this stage.
ExtraLevels	int	The extra levels of this stage.
ApproveHigherLevelsOnly	bool	Whether to approve higher levels only for this stage.
AllocateForPayment	bool	Flag this stage as to when payment should be allocated (cannot be set on the first stage)
IsPostValidationCleanupStage	bool	Flag this stage as the auto-created post-validation stage
ValidationCorrectionThreshold	Nullable<int>	Correction verification threshold percentage
ApproverJustificationsRequired	bool	Gets or sets a value indicating whether or not an approver must specify a justification for this .
ClaimPercentageToValidate	Nullable<decimal>	Gets or sets the percentage of items in a claim that will be sent for validation.

SubCatDates

A class to represent start and end dates for Sub cat item roles

Property	Type	Comments	Rules
StartDate	DateTime	Gets or sets the start date for this item
EndDate	DateTime	Gets or sets the end date for this item

SubCatItemRole

Links ExpenseSubCategories and List.

Property	Type	Comments
ItemRoleSubCatId	int	The unique Id of the SubCatItemRole.
SubCatId	int	The Id of the related SubCategory.
AddToTemplate	bool	Whether to add to the template.
MaximumAllowedWithReceipt	decimal	The maximum claim allowed with a receipt.
MaximumAllowedWithoutReceipt	decimal	The maximum claim allowed without a receipt.
ForDelete	bool	Gets or sets a value indicating whether the element can be deleted

SubCatVatRate

Links an ExpenseSubCategory to a VAT Rate.

Property	Type	Comments	Rules
VatRateId	int	The related Vat Rate Id.	ReadOnly
SubCatId	int	The related Sub Category Id.
VatAmount	double	The VAT Amount for this SubCatVatRate.
VatReceipt	bool	Whether this has a receipt.
VatLimitWithout	Nullable<decimal>	The VAT limit without receipt.
VatLimitWith	Nullable<decimal>	The VAT limit with receipt.
VatPercent	byte	The VAT percentage.
RangeType	DateRangeType	The DateRangeType for this SubCatVatRate.
DateValue1	Nullable<DateTime>	The first date value for this SubCatVatRate.
DateValue2	Nullable<DateTime>	The second date value for this SubCatVatRate.
ForDelete	bool	Whether to mark this for delete in a bulk update.

SubmitClaimResult

A class for handling the result of a claims submission

Property	Type	Comments
Reason	Common.Enum.SubmitRejectionReason	The reason for rejection
FrequencyValue	int
FrequencyPeriod	byte	The frequency Value
FlagResults	FlaggedItemsManager	The flagged items
ClaimID	int	The claim Id
Approver	bool	Is the approver?
MinimumAmount	Nullable<decimal>	The minimum amount
MaximumAmount	Nullable<decimal>	The maximum account
NewLocationURL	string	The new location URL
NoDefaultAuthoriserPresent	bool	Is there a no default authoriser present?

Team

A Team is a group of Employees.

Property	Type	Comments	Rules
Id	int	The unique Id for this Team object.
Label	string	The name / label for this Team object.	Required Max Length: 50
Description	string	A description of this Team object.	Required Max Length: 4000
TeamMembers	List<int>	A list of the Ids of all the Employees that are assigned to this team.
TeamLeaderId	Nullable<int>	Gets the nominated team leader employee Id (NULL if unspecified)

Threshold

A threshold defines details for paying an expense, up to a certain value, before another threshold applies.

Property	Type	Comments
MileageThresholdId	int	The unique Id of this threshold.
MileageDateId	int	The Id of the related DateRange.
MileageCategoryId	int	The Id of the related MileageCategory.
RangeValue1	Nullable<decimal>	The first range value.
RangeValue2	Nullable<decimal>	The second range value.
RangeType	RangeType	The RangeType of this threshold.
Passenger1Rate	decimal	The first passenger rate for this threshold.
PassengerXRate	decimal	The nth passenger rate for this threshold.
HeavyBulkyEquipmentRate	decimal	The allowance given for heavy and bulky equipment
Rates	IEnumerable<VehicleJourneyRateThresholdRate>	Gets or sets the fuel rates for this threshold.

A Tooltip provides help text to clarify elements of the system.

Property	Type	Comments	Rules
Id	Guid	The Id of this object.	Required
HelpText	string	The name / label for this Tooltip object.	Required Max Length: 4000

ToSettings

The fields settings for To field

Property	Type	Comments
DisplayAs	string	What to display in the field label
DisplayForCash	bool	Whether to show To field for cash items
DisplayForCreditCard	bool	Whether to show To field for credit card items
DisplayForPurchaseCard	bool	Whether to show To field for purchase card items
DisplayOnIndividualItem	bool	Whether to show To field for individual expense items
MandatoryForCash	bool	Whether To field is mandatory for cash items
MandatoryForCreditCard	bool	Whether To field is mandatory for credit card items
CanAddToField	bool	Whether the account permits employees to add a new From field from Add/Edit Expense

UdfListElement

A class to hold the list element details for a list type user defined field

Property	Type	Comments
ElementValue	int	Gets or sets the element value.
ElementText	string	Gets or sets the element text.
ElementOrder	int	Gets or sets the element order.
Archived	bool	Gets or sets a value indicating whether element is archived.

UserDefinedField

Represents a User Defined Field. This is a method of extending the system to allow for user properties to be saved along with Expenses objects.

Property	Type	Comments	Rules
UserDefinedId	int	The user defined field Id.
AppliesTo	UDFAppliesTo	The element that the user defined field applies to.	Required Must be a valid enum member
Order	int	The field order.
Archived	bool	Whether the field is archived.
DisplayName	string	Display Name.
Description	string	Description.
Tooltip	string	Tooltip.
Mandatory	bool	Whether the field is mandatory.
FieldType	FieldType	Field Type.
HyperlinkPath	string	The url for the hyperlink.
HyperlinkText	string	The text for the hyperlink.
Precision	Nullable<int>	The precision of the number.
MaxLength	Nullable<int>	The maximum length allowed for the text.
Default	string	The maximum length allowed for the text.
ListElements	List<UserDefinedFieldListElement>	List of elements if FieldType = List.

UserDefinedFieldListElement

Represents a User Defined Field. This is a method of extending the system to allow for user properties to be saved along with Expenses objects.

Property	Type	Comments
ElementValue	int	The element value.
ElementText	string	The element text.
ElementOrder	int	The element order.
Archived	bool	Whether this list element is archived.

UserDefinedFieldType

Hold the data realting to a User Defined Field

Property	Type	Comments
UserDefinedFieldId	int	The unique Id of the user defined field
Attribute	Attribute	The attribute data that is associated
Value	object	The value of the user defined field
Order	int	The order of the user defined field
AllowEmployeeToPopulate	bool	Gets or sets a value indicating whether an employee can populate the user defined field.

UserDefinedFieldValue

The structure for passing the value for a user defined field into the system.

Property	Type	Comments	Rules
Id	int	The id number for the user defined field.	ReadOnly
Value	object	The value supplied for the user defined field.

VatRate

Defines a rate of VAT (value added tax).

Property	Type	Comments
ExpenseSubCategoryId	int	The Id of the ExpenseSubCategory.
Vat	double	The VAT rate itself.
VatPercent	double	The VAT percentage.
ForDelete	bool	Whether to delete this item during a bulk update.

Vehicle

Represents a Vehicle that can be owned either by a single Employee, or a pool-car style vehicle, which has mulitple 'owners'. If the vehicle's EmployeId property is set, then the car is not a poolcar, but belongs to an employee.

Property	Type	Comments	Rules
Id	int	The unique ID of this vehicle.
Make	string	The make of this vehicle.
Model	string	The model of this vehicle.
Registration	string	The registration number of this vehicle.
UnitOfMeasure	MileageUOM	The unit of measurement for distance of this vehicle.	Required Must be a valid enum member
FuelType	int	The fuel type of this vehicle.	Required
EngineSize	int	The engine size of this vehicle.
IsActive	bool	Whether the vehicle is active.
IsExemptFromHomeToLocationMileage	bool	Whether the vehicle is exempt from Home to Location mileage.
CarUsageStartDate	Nullable<DateTime>	The car usage start date.
CarUsageEndDate	Nullable<DateTime>	The car usage end date.
FinancialYearId	Nullable<int>	The financial year of mileage categories associated with this vehicle.
MileageCategoryIds	List<int>	The associated mileage category Ids for this vehicle.
OdometerReadings	OdometerReadings	The odometer readings for this vehicle. Must me populated if the OdometerReadingsRequired property is set to true.
Approved	bool	Whether the vehicle has been approved.
EmployeeId	Nullable<int>	Contains the Id of the owner, if this car is not a Pool Car.
PoolCarUsers	List<int>	Contains the Ids of the Employees allowed to use this Car (if it is a Pool Car).
UserDefined	List<UserDefinedFieldValue>	The User defined fields.
VehicleTypeId	VehicleType	Contains the typeid of vehicle, like bicycle, car, motorcycle, moped	Required Must be a valid enum member
VehicleDescription	string	Get or Sets the vehcile description
IsPoolVehicle	bool	Gets or Sets whether the vehicle is a pool vehicle
PreviousVehicleId	int	Gets or sets the Id of the vehicle if the current vehicle is replacing another
UnapprovedVehicleCount	int	Gets or sets the number of unapproved vehicles for the employee
TaxExpiry	string	Gets or sets the Tax Expiry of this vehicle
IsTaxValid	bool	Gets or sets the tax status of this vehicle
MotExpiry	string	Gets or sets the MOT Expiry of this vehicle
IsMotValid	bool	Gets or sets the MOT status of this vehicle
MotStart	string	Gets or sets the mot start date.

VehicleDefinition

The vehicle definition containing data to help build the add vehicle form

Property	Type	Comments
VehicleEngineTypes	List<VehicleEngineType>	Gets or sets the vehicle engine types.
VehicleJourneyRates	IList<MileageCategory>	Gets or sets a list of valid vehicle journey rates.
UserDefinedFields	List<UserDefinedFieldType>	Gets or sets a list of user defined fields./>
FinancialYears	List<FinancialYear>	Gets or sets a list of FinancialYears

VehicleEngineType

A class to hold details of a Vehicle Engine Type

Property	Type	Comments
VehicleEngineTypeId	Nullable<int>	Gets or sets the vehicle engine type id.
Code	string	Gets or sets the code.
Name	string	Gets or sets the name.
CreatedBy	int	Gets or sets the created by.
CreatedOn	DateTime	Gets or sets the created on.
ModifiedBy	Nullable<int>	Gets or sets the modified by.
ModifiedOn	Nullable<DateTime>	Gets or sets the modified on.

WorkAddressLinkage

A WorkAddressLinkage is a subtype of AddressLinkage.

Property	Type	Comments	Rules
IsTemporary	bool	Gets or sets a value indicating whether the address is temporary.	Required
IsActive	bool	Gets or sets a value indicating whether the address is active.	Required
Rotational	bool	Gets or sets a value indicating whether the address is rotational.	ReadOnly
PrimaryRotational	bool	Gets or sets a value indicating whether the address is the primary rotational address.	ReadOnly
Id	int	The unique Id of this item in the database.
StartDate	Nullable<DateTime>	Gets or sets the start date for this Address.
EndDate	Nullable<DateTime>	Gets or sets the end date for this Address.
EmployeeId	int	The Id of the Employee to be linked to the Address.	Required
AddressId	int	The Id of the Address to be linked to the Employee.	Required

WorkDetails

Represents a collection of information about an Employee's job.

Property	Type	Comments	Rules
CreditAccount	string	The credit account for the employee.
PayRollNumber	string	The payroll number for the employee.
Position	string	The position of the employee.
NationalInsuranceNumber	string	The national insurance number of the employee.
HireDate	Nullable<DateTime>	The hire date of the employee.
TerminationDate	Nullable<DateTime>	The termination date of the employee.
EmployeeNumber	string	The employee number.
PrimaryCountryId	Nullable<int>	The primary country id - List of countries can be obtained by calling /countries/Find?CountryId=0 for unassigned global countries
PrimaryCurrencyId	Nullable<int>	The primary currency id - List of currencies can be obtained by calling /currencies/Find?CurrencyId=0 for unassigned global currencies
LineManagerUserId	Nullable<int>	The user ID of the employee's line manager.
StartMileage	int	The starting mileage that this employee has driven.
StartMileageDate	Nullable<DateTime>	The starting date for mileage.
EsrPersonId	Nullable<long>	The Esr Person Id, if ESR is enabled.	ReadOnly
EsrEffectiveStartDate	Nullable<DateTime>	The effective start date for ESR, if enabled.	ReadOnly
EsrEffectiveEndDate	Nullable<DateTime>	The effective end date for ESR, if enabled.	ReadOnly
CostCentreBreakdowns	List<CostCentreBreakdown>	The list of Cost Centre Breakdowns that apply to this container.