The API comes in the form of sets of related objects, each one representing a part of the system. These objects are accessed by API end points called Resources. Press a key to jump to that letter.
Manages the majority of AccessRole operations.
| Verb | API element | Parameters | Description | ||||||
|---|---|---|---|---|---|---|---|---|---|
| OPTIONS | AccessRoles |
Gets all of the available end points from the AccessRole part of the API. |
|||||||
| GET | AccessRoles |
Gets all AccessRoles in the system. |
|||||||
| GET | AccessRoles/{id} |
|
Gets a single AccessRole, by its Id. |
||||||
| GET | AccessRoles/Find?Name={Name}&CanEditCostCode={CanEditCostCode}&CanEditDepartment={CanEditDepartment}&CanEditProjectCode={CanEditProjectCode}&SearchOperator={SearchOperator} |
|
Finds all AccessRoles matching specified criteria. |
||||||
| POST | AccessRoles |
|
Adds an AccessRole. |
||||||
| PUT | AccessRoles/{id} |
|
Edits an AccessRole. |
||||||
| PATCH | AccessRoles/{id}/AssignToEmployee/{eid} |
|
Applies the supplied AccessRole to the supplied Employee. |
||||||
| PATCH | AccessRoles/{id}/RevokeFromEmployee/{eid} |
|
Unlinks the supplied AccessRole from the supplied Employee. |
||||||
| DELETE | AccessRoles/{id} |
|
Deletes an AccessRole. |
Contains account specific actions.
| Verb | API element | Parameters | Description | ||||||
|---|---|---|---|---|---|---|---|---|---|
| OPTIONS | Account |
Gets ALL of the available end points from the API. |
|||||||
| GET | Account/GetClaimantAccountDetails?employeeId={employeeId}&companyId={companyId} |
|
Gets a claimant's account details, when called as the claimant's approver |
||||||
| GET | Account/GetSubAccountDescription/{subAccountId} |
|
Given an Id of a Sub Account, returns the description. |
||||||
| GET | Account/PasswordPolicy |
Gets the password complexity that users on this account must adhere to. |
|||||||
| GET | Account/ForgottenPassword?email={email}&brandName={brandName} |
|
Requests a reminder of logon credentials for the user matching the email parameter. |
||||||
| GET | Account/SessionTimeoutSettings |
Gets the session timeout settings |
|||||||
| GET | Account/GetExpediteGuidelines |
Gets the Expedite HTML guidelines. |
|||||||
| GET | Account/GetAccountsWithExchangeRatesUpdateEnabled |
Get accounts with auto populate of exchange rates general option enabled |
|||||||
| POST | Account/Login |
|
Log into the API using the same credentials you would to log into Assure Expenses online. You will be provided with a LoginResponse. The properties of this response should be included in the header of all subsequent requests. |
||||||
| POST | Account/Logout |
Logs the calling user out revoking the active AuthToken. This means the user will have to follow the logon process again to use the system. |
|||||||
| POST | Account/ChangePassword |
|
Allows a user to change their password. |
||||||
| POST | Account/ValidateResetKey |
|
Validates an employee's password reset key. |
Contains operations for handling Address Lookups.
| Verb | API element | Parameters | Description | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| OPTIONS | Addresses |
Gets all of the available end points from the Address part of the API. |
|||||||||
| GET | Addresses/{id} |
|
Gets a single Address, by its Id. |
||||||||
| GET | Addresses/GetAccountWideLabel/{id} |
|
Gets an account wide label for an Address, by its Id. |
||||||||
| GET | Addresses/GetAddressDetailsFromSEL/{id} |
|
Gets an Address from SEL data sources based on its AddressId |
||||||||
| GET | Addresses/GetHomeAndOfficeAddresses |
Gets the home and office addresses for the current employee |
|||||||||
| GET | Addresses/GetRouteForExpenseItem?expenseId={expenseId} |
|
Gets the journey route and mapping details for an Expense Id |
||||||||
| POST | Addresses |
|
Adds an Address. Do not try to set AccountWide labels or favourites here. Use the patch methods. Similarly, setting distances here wont work either. Use the AddressDistances resource instead. |
||||||||
| POST | Addresses/SaveAddress |
|
The save address. |
||||||||
| POST | Addresses/FindAddress |
|
Gets an Address via a simple search lookup. |
||||||||
| POST | Addresses/GetAddressDetailsFromPostCodeAnywhere |
|
Used to retrieve the full details of an address by its address provider ID. This returns the full details of a single Address. |
||||||||
| POST | Addresses/GetAddressDetailsFromPostCodeAnywhereInteractiveFind |
|
Used to "drill down" into search address provider results to obtain more results, using an address provider identifier (not the ID of a retrievable address, but the ID of a non-retrievable search result such as a locality). Returns one or more search results, which will either be retreivable addresses or non-retrievable search results (such as a street). |
||||||||
| POST | Addresses/AddRemovePersonalFavouriteAddress |
|
Adds or removes a favourite address for an employee |
||||||||
| POST | Addresses/GetRouteForAddressIdentifiers |
|
Gets the address route and mapping details form a list of address identifiers |
||||||||
| POST | Addresses/GetRouteForAddresses |
|
Gets the journey route and mapping details for address identifiers |
||||||||
| POST | Addresses/AddLabel |
|
Adds label to this Address. Note that if an address has any labels, then one must be the primary label. Set this with the primary option. |
||||||||
| PUT | Addresses/{id} |
|
Edits an Address. Do not try to set AccountWide labels or favourites here. Use the patch methods. Similarly, setting distances here wont work either. Use the AddressDistances resource instead. |
||||||||
| PATCH | Addresses/AssignToEmployeeAsHome |
|
Links an Address to an Employee as a HOME address. This is achieved by creating a HomeAddressLinkage, which will be visible on the Employee. Note that rather than edit an existing linkage, you should remove the existing linkage and recreate it. |
||||||||
| PATCH | Addresses/EditEmployeeHomeAddressLinkage |
|
Edits a HomeAddressLinkage, which will be visible on the Employee.
StartDate |
||||||||
| PATCH | Addresses/AssignToEmployeeAsWork |
|
Applies the supplied Address to the supplied Employee as a WORK address. This is achieved by creating a WorkAddressLinkage, which will be visible on the Employee. Note that rather than edit an existing linkage, you should remove the existing linkage and recreate it. |
||||||||
| PATCH | Addresses/EditEmployeeWorkAddressLinkage |
|
Edits a WorkAddressLinkage, which will be visible on the Employee.
StartDate |
||||||||
| PATCH | Addresses/UnlinkFromEmployee/{linkageId}/{eid} |
|
Unlinks the supplied Address from the supplied Employee. These links are represented by either a WorkAddressLinkage or a HomeAddressLinkage. Rather than providing the id of the Address and the Employee, just provide the Id of the Home/WorkAddressLinkage and it will be removed. Note that rather than edit an existing linkage, you should remove the existing linkage and recreate it. |
||||||||
| PATCH | Addresses/{id}/Archive/{archive} |
|
Archives an Address. |
||||||||
| PATCH | Addresses/{id}/SetAccountWideFavourite/{isToBeFavourite} |
|
Sets whether or not this Address is an Account-wide favourite. |
||||||||
| PATCH | Addresses/{id}/AddAccountWideLabel/{label}/{primary} |
|
Adds an Account-wide label to this Address. Note that if an address has any labels, then one must be the primary label. Set this with the primary option. |
||||||||
| PATCH | Addresses/EditAccountWideLabel/{id}/{label}/{primary} |
|
Edits an Account-wide label. Note that if an address has any labels, then one must be the primary label. Set this with the primary option. Note that the id parameter here refers to the Label's Id, NOT the Id of the Address... |
||||||||
| PATCH | Addresses/MakeAccountWideLabelPrimary/{id} |
|
Makes a label the primary label for an address. The primary status of current primary label (if there is one) will be removed. |
||||||||
| PATCH | Addresses/RemoveAccountWideLabel/{id} |
|
Removes an Account-wide label from this Address. |
||||||||
| PATCH | Addresses/{id}/Cleanse |
|
Cleanses an Address, meaning that the Account-wide labels, the favourite status, and any recommended distances, are removed. |
||||||||
| PATCH | Addresses/RemoveLabel/{id} |
|
Removes label from this Address. |
||||||||
| DELETE | Addresses/{id} |
|
Deletes an Address. |
Manages operations on AddressRecommendedDistances.
| Verb | API element | Parameters | Description | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| OPTIONS | AddressRecommendedDistances |
Gets all of the available end points from the AddressRecommendedDistances part of the API. |
|||||||||
| GET | AddressRecommendedDistances/ByAddress/{id} |
|
Gets all AddressRecommendedDistances for the given Address Id. |
||||||||
| GET | AddressRecommendedDistances/{id} |
|
Gets a single AddressRecommendedDistance, by its Id. |
||||||||
| GET | AddressRecommendedDistances/GetRecommendedOrCustomDistance?originAddressId={originAddressId}&destinationAddressId={destinationAddressId}&vehicleId={vehicleId} |
|
Gets a recommended or custom distance for origin and destination address Ids |
||||||||
| POST | AddressRecommendedDistances |
|
Adds an AddressRecommendedDistance. |
||||||||
| PUT | AddressRecommendedDistances/{id} |
|
Edits an AddressRecommendedDistance. |
||||||||
| DELETE | AddressRecommendedDistances/{id} |
|
Deletes an AddressRecommendedDistance. |
The advances controller.
| Verb | API element | Parameters | Description | ||||
|---|---|---|---|---|---|---|---|
| OPTIONS | Advances |
Gets all of the available end points from the Advance part of the API. |
|||||
| GET | Advances/GetAdvancesForCurrency?currencyId={currencyId} |
|
Gets the available Advances for the currency supplied and current employee. |
||||
| GET | Advances/GetAdvancesForUser |
Gets the available Advances for the currency supplied and current employee. |
|||||
| GET | Advances/GetUnsettledAdvancesForCurrentUser |
Gets the available MyAdvanceResponse containing a list of MyAdvance for the current user. |
|||||
| POST | Advances/RequestAdvance |
|
Gets the available Advances for the currency supplied and current employee. |
||||
| PUT | Advances/UpdateAdvance |
|
Updates the existing Advances for the currency supplied and current employee. |
||||
| PUT | Advances/ApproveAdvance?advanceId={advanceId} |
|
The approve advance. |
||||
| PUT | Advances/PayAdvance?advanceId={advanceId} |
|
The pay advance. |
||||
| DELETE | Advances/DeleteAdvance?advanceId={advanceId} |
|
The delete advance endponit. |
Manages operations on Allowances.
| Verb | API element | Parameters | Description | ||||||
|---|---|---|---|---|---|---|---|---|---|
| OPTIONS | Allowances |
Gets all of the available end points from the Allowances part of the API. |
|||||||
| GET | Allowances |
Gets all Allowances in the system. |
|||||||
| GET | Allowances/{id} |
|
Gets a single Allowance, by its Id. |
||||||
| GET | Allowances/Find?Label={Label}&Description={Description}&SearchOperator={SearchOperator} |
|
Finds all Allowances matching specified criteria. |
||||||
| POST | Allowances |
|
Adds an Allowance. |
||||||
| PUT | Allowances/{id} |
|
Edits an Allowance. |
||||||
| DELETE | Allowances/{id} |
|
Deletes an Allowance. |
Manages operations on BankAccount.
| Verb | API element | Parameters | Description | ||||||
|---|---|---|---|---|---|---|---|---|---|
| OPTIONS | BankAccounts |
Gets all of the available end points from the BankAccount part of the API. |
|||||||
| GET | BankAccounts |
Gets all the BankAccounts in the system. |
|||||||
| GET | BankAccounts/{id} |
|
Gets the BankAccount matching the specified id. |
||||||
| GET | BankAccounts/Employee?employeeId={employeeId}&includeArchived={includeArchived} |
|
Gets the BankAccount matching the specified employee id. |
||||||
| GET | BankAccounts/GetBankAccountsForCurrentUser |
Gets a list of BankAccount for current user. |
|||||||
| POST | BankAccounts |
|
Saves a BankAccount. |
||||||
| PUT | BankAccounts |
|
Updates a BankAccount. |
||||||
| PUT | BankAccounts/ChangeBankAccountStatus?id={id}&archive={archive} |
|
Archives or un-archives a BankAccount as the current user |
||||||
| PATCH | BankAccounts/{id}/Archive/{archive} |
|
Archives or un-archives a BankAccount as an administrator |
||||||
| DELETE | BankAccounts/DeleteBankAccount?id={id} |
|
Deletes the current user's BankAccount by its Id |
||||||
| DELETE | BankAccounts/{id} |
|
Deletes a BankAccount. |
Manages operations on BudgetHolders
| Verb | API element | Parameters | Description | ||||||
|---|---|---|---|---|---|---|---|---|---|
| OPTIONS | BudgetHolders |
Gets all of the available end points from the BudgetHolders part of the API. |
|||||||
| GET | BudgetHolders |
Gets all BudgetHolders in the system. |
|||||||
| GET | BudgetHolders/{id} |
|
Gets a single BudgetHolder, by its Id. |
||||||
| GET | BudgetHolders/Find?Label={Label}&Description={Description}&EmployeeId={EmployeeId}&SearchOperator={SearchOperator} |
|
Finds all BudgetHolder matching specified criteria. |
||||||
| POST | BudgetHolders |
|
Adds a BudgetHolder. |
||||||
| PUT | BudgetHolders/{id} |
|
Edits a BudgetHolder. |
||||||
| DELETE | BudgetHolders/{id} |
|
Deletes a BudgetHolder. |
Provides methods for handling CardProviders.
| Verb | API element | Parameters | Description |
|---|---|---|---|
| OPTIONS | CardProviders |
Gets all of the available end points from the CardProviders part of the API. |
|
| GET | CardProviders |
Returns list of CardProviders |
Manages operations on ClaimableItems.
| Verb | API element | Parameters | Description | ||||
|---|---|---|---|---|---|---|---|
| OPTIONS | ClaimableItems |
Gets all of the available end points from the ClaimableItems part of the API. |
|||||
| GET | ClaimableItems |
Gets all ClaimableItem in the system. |
|||||
| POST | ClaimableItems/AddClaimableItems |
|
Add the claimable items for the user, item will appear when user adds a new expense. |
Manages operations on ClaimReasons
| Verb | API element | Parameters | Description | ||||||
|---|---|---|---|---|---|---|---|---|---|
| OPTIONS | ClaimReasons |
Gets all of the available end points from the ClaimReasons part of the API. |
|||||||
| GET | ClaimReasons |
Gets all ClaimReasons in the system. |
|||||||
| GET | ClaimReasons/{id} |
|
Gets a single ClaimReason, by its Id. |
||||||
| GET | ClaimReasons/Find?Label={Label}&Description={Description}&SearchOperator={SearchOperator} |
|
Finds all ClaimReasons matching specified criteria. |
||||||
| POST | ClaimReasons |
|
Adds a ClaimReason. |
||||||
| PUT | ClaimReasons/{id} |
|
Edits a ClaimReason. |
||||||
| DELETE | ClaimReasons/{id} |
|
Deletes a ClaimReason. |
Manages operations on Claims.
| Verb | API element | Parameters | Description | ||||||
|---|---|---|---|---|---|---|---|---|---|
| OPTIONS | Claims |
Gets all of the available end points from the Claims part of the API. |
|||||||
| GET | Claims/{id} |
|
Gets a single Claim, by its Id. |
||||||
| GET | Claims/{crn} |
|
Gets a single Claim, by its ClaimReferenceNumber (CRN). |
||||||
| GET | Claims/GetClaimBasicById/{id} |
|
Gets a single Claim, by its Id. |
||||||
| GET | Claims/GetClaimDefinition?id={id} |
|
Gets a single ClaimDefinitionResponse, by its Id. |
||||||
| GET | Claims/GetDefaultClaimDefinition |
This is used to help build the new claim form. Gets a single ClaimDefinitionResponse with the determined claim name and UDF information. |
|||||||
| GET | Claims/CheckJustificationsHaveBeenProvidedByAuthoriser?id={id} |
|
Checks that the flags associated against the expense items relating to the claim Id have justifications from the authoriser, if mandatory |
||||||
| GET | Claims/ExpenseItems?claimId={claimId} |
|
Gets all of the expense items on a claim. |
||||||
| GET | Claims/ExpenseItemsForApprover?claimId={claimId} |
|
Gets all of the expense items on a claim for the approver. |
||||||
| GET | Claims/BasicExpenseItemsForApprover?claimId={claimId} |
|
Gets all of the basic expense items on a claim for the approver. |
||||||
| GET | Claims/GetClaimExpenseOverview?claimId={claimId} |
|
Gets the basic expense item details that belong to a claim |
||||||
| GET | Claims/AwaitingApproval |
Gets the list of claims awaiting approval by the employee |
|||||||
| GET | Claims/GetUnsubmitted |
Gets the list of unsubmitted claims that belong to the current user. |
|||||||
| GET | Claims/GetSubmitted |
Gets the list of submitted claims that belong to the current user. |
|||||||
| GET | Claims/GetPrevious |
Gets the list of previous claims that belong to the current user. |
|||||||
| GET | Claims/SearchApprovedClaims?searchInput={searchInput} |
|
Gets the list of previous claims that belong to the current user and match the search criteria. |
||||||
| GET | Claims/AwaitingApprovalCount |
Gets the count of claims awaiting approval by the mobile user. |
|||||||
| GET | Claims/GetClaimCountByEmployeeAndClaimStage?claimStage={claimStage} |
|
Gets the total number of claims in the account for the current employee at a given claim stage. If not supplied, the claim stage will default to ClaimStage.Any |
||||||
| GET | Claims/GetTotalClaimCount |
Gets the total number of claims in the system for the account |
|||||||
| GET | Claims/GetDefaultClaimNumber?employeeId={employeeId} |
|
Gets the default claim number |
||||||
| GET | Claims/GetCurrentClaimsForAllUsers |
Gets all current claims for all users in the system. |
|||||||
| GET | Claims/GetClaimSubmissionDetails?id={id} |
|
Gets ClaimSubmission details, by its Id. |
||||||
| GET | Claims/GetClaimHistory?claimId={claimId} |
|
Gets claim history |
||||||
| GET | Claims/GetClaimCountForAllStages |
Gets the number of claims at the stages of Current, Submitted, and Previous for the current employee. |
|||||||
| GET | Claims/GetClaimantStatistics |
Gets the claimants statistical counts for the current employee. |
|||||||
| POST | Claims/AddDefaultClaim?employeeId={employeeId} |
|
Adds the default claim number. |
||||||
| POST | Claims/CreateClaim |
|
Creates a new claim for the user. |
||||||
| POST | Claims/DetermineIfClaimCanBeSubmitted?claimId={claimId} |
|
Checks if a claim can be submitted |
||||||
| POST | Claims/DetermineIfClaimCanBeUnsubmitted?claimId={claimId} |
|
Checks if a claim can be unsubmitted |
||||||
| POST | Claims/SubmitClaim |
|
Submit claim. |
||||||
| POST | Claims/UnsubmitClaim?claimId={claimId} |
|
Unsubmit claim. |
||||||
| POST | Claims/GetApprover?total={total}&employeeId={employeeId} |
|
Generates the GetApprover HTML, which is used to allow users to select who the claim should go to in the next stage. |
||||||
| POST | Claims/SaveClaimantJustifications |
|
Saves justifications provided by the claimant for the given flagged item ids. |
||||||
| POST | Claims/GenerateFlagsGrid |
|
Generates the data for the expense flag grid |
||||||
| POST | Claims/SaveEnvelopeInformationAgainstAClaim |
|
Saves envelope information against a claim |
||||||
| POST | Claims/AssignClaims |
|
Assign the claims related to the provided claimIds to the current user. |
||||||
| POST | Claims/UnassignClaim?claimId={claimId} |
|
Unassigns the claim related to the provided claimId from the current user |
||||||
| PUT | Claims/Allocate?claimId={claimId} |
|
Allocates a claim for payment. |
||||||
| PUT | Claims/ApproveClaim?claimId={claimId} |
|
Approves a claim, sending to the next stage if applicable. |
||||||
| PUT | Claims/UpdateClaim |
|
Updates the claim details for the user. |
||||||
| PUT | Claims/SaveAuthoriserJustification |
|
Saves justifications provided by the approver for the given flagged item ids. |
||||||
| DELETE | Claims/DeleteClaim?claimId={claimId} |
|
Deletes a claim for the user. |
Manages operations on CorporateCards
| Verb | API element | Parameters | Description | ||||||
|---|---|---|---|---|---|---|---|---|---|
| OPTIONS | CorporateCards |
Gets all of the available end points from the CorporateCards part of the API. |
|||||||
| GET | CorporateCards |
Gets all CorporateCards in the system. |
|||||||
| GET | CorporateCards/{id} |
|
Gets a single CorporateCard, by its Id. |
||||||
| GET | CorporateCards/ByEmployee/{id} |
|
Gets all the Corporate Cards for the supplied Employee. |
||||||
| GET | CorporateCards/Find?CardProviderId={CardProviderId}&IsActive={IsActive}&EmployeeId={EmployeeId}&SearchOperator={SearchOperator} |
|
Finds all CorporateCard matching specified criteria. |
||||||
| GET | CorporateCards/CardStatementsForCurrentUser | ||||||||
| GET | CorporateCards/AdditionalTransactionInfo/{transactionId} |
|
Gets additional transaction information for supplied transaction id. |
||||||
| GET | CorporateCards/AdditionalTransactionInfoAsApprover/{transactionId}/{expenseId} |
|
Gets additional transaction information for the supplied transaction Id as an approver. |
||||||
| GET | CorporateCards/CreditCardTransactions?statementId={statementId} |
|
Gets the transactions for the supplied statementId id. |
||||||
| POST | CorporateCards |
|
Adds a CorporateCard. |
||||||
| POST | CorporateCards/ImportTransactions |
|
Imports credit card transaction data. |
||||||
| PUT | CorporateCards/{id} |
|
Edits a CorporateCard. |
||||||
| PUT | CorporateCards/UnmatchTransaction?expenseId={expenseId} |
|
Unmatch a transaction from expense item. |
||||||
| PUT | CorporateCards/MatchTransaction?transactionId={transactionId}&expenseId={expenseId} |
|
Match a transaction to an expense item |
||||||
| PUT | CorporateCards/AllocateCardToEmployee |
|
Allocates a corporate card to an employee. |
||||||
| DELETE | CorporateCards/{id} |
|
Deletes a CorporateCard. |
||||||
| DELETE | CorporateCards/DeleteStatementById?statementId={statementId} |
|
Deletes a statement by its Id. |
Manages operations on CostCodes.
| Verb | API element | Parameters | Description | ||||||
|---|---|---|---|---|---|---|---|---|---|
| OPTIONS | CostCodes |
Gets all of the available end points from the CostCode part of the API. |
|||||||
| GET | CostCodes |
Gets all CostCodes in the system. |
|||||||
| GET | CostCodes/GetAllActive |
Gets all active costs codes |
|||||||
| GET | CostCodes/{id} |
|
Gets a single CostCode, by its Id. |
||||||
| GET | CostCodes/Find?Label={Label}&Description={Description}&SearchOperator={SearchOperator} |
|
Finds all CostCodes matching specified criteria. |
||||||
| POST | CostCodes |
|
Adds a CostCode. |
||||||
| PUT | CostCodes/{id} |
|
Edits a CostCode. |
||||||
| PATCH | CostCodes/{id}/Archive/{archive} |
|
Archives or un-archives a CostCode, depeding on what is passed in. |
||||||
| DELETE | CostCodes/{id} |
|
Deletes a CostCode. |
Handles the creation, deletion and update of Countries within the SpendManagementAPI.
| Verb | API element | Parameters | Description | ||||||
|---|---|---|---|---|---|---|---|---|---|
| OPTIONS | Countries |
Gets all of the available end points from the Countries part of the API. |
|||||||
| GET | Countries |
Gets all Countries available for the user. |
|||||||
| GET | Countries/{id} |
|
Gets a Country matching the specified id |
||||||
| GET | Countries/Find?CountryId={CountryId}&GlobalCountryId={GlobalCountryId}&Label={Label}&CountryCode={CountryCode}&Alpha3CountryCode={Alpha3CountryCode}&Numeric3CountryCode={Numeric3CountryCode}&Archived={Archived}&SearchOperator={SearchOperator} |
|
Finds all Countries matching specified criteria. Search for CountryId = 0 to get all unmapped global countries. Available querystring parameters : SearchOperator,Alpha3CountryCode,Country,CountryCode,CountryId,GlobalCountryId,Numeric3CountryCode,Archived. Use SearchOperator=0 to specify an AND query or SearchOperator=1 for an OR query |
||||||
| POST | Countries |
|
Adds a Country for the current user and sets up VAT rates for that country |
||||||
| PUT | Countries/{id} |
|
Archive/ unarchive an existing country record. Add/ update/ delete VAT rates. Use the ForDelete flag on the VatRate to delete a VAT rate associated with the country. |
||||||
| PATCH | Countries/{id}/Archive/{archive} |
|
Archives or un-archives a Country, depending on what is passed in. |
||||||
| DELETE | Countries/{id} |
|
Deletes a Country associated with the current user |
Manages operations on Currencies.
| Verb | API element | Parameters | Description | ||||||
|---|---|---|---|---|---|---|---|---|---|
| OPTIONS | Currencies |
Gets all of the available end points from the Currencies part of the API. |
|||||||
| GET | Currencies |
Gets all Currencies available. |
|||||||
| GET | Currencies/{id} |
|
Gets a Currency matching the specified id. |
||||||
| GET | Currencies/ByNumericCode/{id} |
|
Gets a Currency matching the specific code, as per ISO 3166-1 |
||||||
| GET | Currencies/ByAlphaCode/{id} |
|
Gets a Currency matching the specific APLHA code, as per ISO 3166-1 - Alpha3 |
||||||
| GET | Currencies/ByGlobalCurrencyId/{id} |
|
Gets a Currency matching the global currency I.D. |
||||||
| GET | Currencies/Find?CurrencyId={CurrencyId}&GlobalCurrencyId={GlobalCurrencyId}&Archived={Archived}&Label={Label}&Symbol={Symbol}&SearchOperator={SearchOperator} |
|
Finds all Currencies matching specified criteria. Available querystring parameters : SearchOperator,AlphaCode,Name,NumericCode,CurrencyId,GlobalCurrencyId,Symbol,Archived. Use SearchOperator=0 to specify an AND query or SearchOperator=1 for an OR query |
||||||
| GET | Currencies/GetActiveCurrenciesForAccount/{accountId} |
|
Gets all the active currencies for a specific account. |
||||||
| POST | Currencies |
|
Adds a Currency for the current user. Currency type for the user can also be provided with the currency. |
||||||
| PUT | Currencies/{id} |
|
Archive/ unarchive the specified Currency by setting the Archived property to true Updates the Currency type for the current user. Cannot be used to update the GlobalCountry associated with the currency |
||||||
| PATCH | Currencies/{id}/Archive/{archive} |
|
Archives or un-archives a Currency, depending on what is passed in. |
||||||
| DELETE | Currencies/{id} |
|
Deleted the specified Currency. |
Manage Currency Exchange Rates
| Verb | API element | Parameters | Description | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| OPTIONS | CurrencyExchangeRates |
Gets all of the available end points from the CurrencyExchangeRates part of the API. |
|||||||||
| GET | CurrencyExchangeRates/{id} |
|
Gets exchange rates for specified currency id |
||||||||
| POST | CurrencyExchangeRates/GetExchangeRate?dateTimeOfRate={dateTimeOfRate}&fromCurrencyId={fromCurrencyId}&toCurrencyId={toCurrencyId} |
|
Gets the exchange rate for the specified criteria |
||||||||
| POST | CurrencyExchangeRates/AddToAccount?accountId={accountId} |
|
Internal method used by the currency auto updating tool. Adds exchange rates directly to the specified account. |
||||||||
| PUT | CurrencyExchangeRates/{id} |
|
Updates the exchange rate tables for a currency id |
||||||||
| PATCH | CurrencyExchangeRates/{id}/UpdateExchangeRates |
|
Merges a batch of exchange rates with the existing exchange rates and updates the currency type |
||||||||
| PATCH | CurrencyExchangeRates/{id}/DeleteExchangeRate/{exchangeRateTypeId}/{toCurrencyId} |
|
Deletes the specified exchange rate id |
||||||||
| DELETE | CurrencyExchangeRates/{id} |
|
Deletes the records for specified currency id |
| Verb | API element | Parameters | Description | ||||
|---|---|---|---|---|---|---|---|
| GET | CustomEntities/{id} |
|
Get the definition of an exising Custom Entity by the system ID |
Manages operations on Departments.
| Verb | API element | Parameters | Description | ||||||
|---|---|---|---|---|---|---|---|---|---|
| OPTIONS | Departments |
Gets all of the available end points from the Departments part of the API. |
|||||||
| GET | Departments |
Gets all Departments in the system. |
|||||||
| GET | Departments/GetAllActive |
Gets all active departments |
|||||||
| GET | Departments/{id} |
|
Gets a single Department, by its Id. |
||||||
| GET | Departments/Find?Label={Label}&Description={Description}&SearchOperator={SearchOperator} |
|
Finds all Departments matching specified criteria. |
||||||
| POST | Departments |
|
Adds a Department. |
||||||
| PUT | Departments/{id} |
|
Edits a Department. |
||||||
| PATCH | Departments/{id}/Archive/{archive} |
|
Archives or un-archives a Department, depending on what is passed in. |
||||||
| DELETE | Departments/{id} |
|
Deletes a Department. |
Contains Duty Of Care Email Reminder Specific Actions.
| Verb | API element | Parameters | Description | ||||
|---|---|---|---|---|---|---|---|
| OPTIONS | DutyOfCare |
Gets ALL of the available end points from the API. |
|||||
| GET | DutyOfCare/GetDutyOfCareResults?expenseDate={expenseDate} |
|
Gets the duty of care results for the expense date. |
||||
| GET | DutyOfCare/VehicleDocumentsRequiredForDOC |
Gets the duty of care documents required when a vehicle has been added. |
|||||
| GET | DutyOfCare/GetSornVehicles?expenseDate={expenseDate} |
|
The get SORN vehicles for the current user. |
||||
| POST | DutyOfCare/FilterVehicleDocumentsWithLookupInformation |
|
Gets the duty of care documents required when a vehicle has been added. |
||||
| PUT | DutyOfCare/GetDutyOfCareResultsForEmployee |
|
Gets the DutyOfCareCheckResults for a claimant/expense, when called as the claimant's approver |
||||
| PUT | DutyOfCare/GetSornVehiclesForEmployee |
|
Gets the SornVehiclesResponse for a claimant/expense, when called as the claimant. |
Contains operations for managing EmailNotifications.
| Verb | API element | Parameters | Description | ||||||
|---|---|---|---|---|---|---|---|---|---|
| OPTIONS | EmailNotifications |
Gets all of the available end points from the EmailNotifications part of the API. |
|||||||
| GET | EmailNotifications/getStandardNotifications |
Returns list of standard EmailNotifications. |
|||||||
| GET | EmailNotifications/getNhsNotifications |
Returns list of NHS EmailNotifications. |
|||||||
| PATCH | EmailNotifications/{id}/AssignToEmployee/{eid} |
|
Applies the supplied EmailNotification to the supplied Employee. |
||||||
| PATCH | EmailNotifications/{id}/RevokeFromEmployee/{eid} |
|
Unlinks the supplied AccessRole from the supplied Employee. |
Manages operations on Employees.
| Verb | API element | Parameters | Description | ||||||
|---|---|---|---|---|---|---|---|---|---|
| OPTIONS | Employees |
Gets all of the available end points from the Employees part of the API. |
|||||||
| GET | Employees |
Gets all Employees in the system. |
|||||||
| GET | Employees/{id} |
|
Gets the Employee matching the specified id. |
||||||
| GET | Employees/Find?Title={Title}&UserName={UserName}&Forename={Forename}&Surname={Surname}&SearchOperator={SearchOperator} |
|
Finds all Employees matching the specified criteria. |
||||||
| POST | Employees |
|
Adds an Employee. You can leave out much of the information initially. You can update the record with corporate cards, cars, pool car associations, mobile devices, access role associations, work and home addresses and item roles by using the respective resources. |
||||||
| POST | Employees/PassengerSearch |
|
Finds all Passengers matching the specified criteria. |
||||||
| PUT | Employees/{id} |
|
Updates the Employee record. Either provide only the elements to be updated or get the element data and then provide the modified record. Elements that support a ForDelete flag can be deleted. If the ForDelete flag is not supported, please provide the complete list for that element if the list is being modified. |
||||||
| PATCH | Employees/ActivateEmployees/{sendWelcomeAndPasswordEmail} |
|
Activates an Employee, optionally sending welcome and password emails. Provide a list of Employee Ids to activate. |
||||||
| PATCH | Employees/{id}/Archive/{archive} |
|
Archives or un-archives a Employee, depending on what is passed in. |
||||||
| PATCH | Employees/{id}/ChangePassword |
|
Changes an Employees password. |
||||||
| DELETE | Employees/{id} |
|
Deletes an Employee. |
Manages operations on ESR.
ExpenseCategories are the user definable categories under which you can submit an expense claim.
| Verb | API element | Parameters | Description | ||||||
|---|---|---|---|---|---|---|---|---|---|
| OPTIONS | ExpenseCategories |
Gets all of the available end points from the ExpenseCategories part of the API. |
|||||||
| GET | ExpenseCategories |
Gets the entire list of ExpenseCategories. |
|||||||
| GET | ExpenseCategories/{id} |
|
Gets a particular Expense Category by its Id. |
||||||
| GET | ExpenseCategories/Find?Label={Label}&SearchOperator={SearchOperator} |
|
Finds all ExpenseCategories matching specified criteria. |
||||||
| GET | ExpenseCategories/GetEmployeeExpenseCategories |
Gets the Expense Categories for an employee |
|||||||
| GET | ExpenseCategories/GetEmployeeCategoriesAndSubCategories |
Gets the Expense Categories and Sub Categories for an employee |
|||||||
| POST | ExpenseCategories |
|
Adds an Expense Category. |
||||||
| PUT | ExpenseCategories/{id} |
|
Edits an ExpenseCategory. |
||||||
| DELETE | ExpenseCategories/{id} |
|
Deletes an ExpenseCategory. |
Manages operations on ExpenseItems.
| Verb | API element | Parameters | Description | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| OPTIONS | ExpenseItems |
Gets all of the available end points from the ExpenseItems part of the API. |
|||||||||
| GET | ExpenseItems/{id} |
|
Gets a single ExpenseItem, by its Id. |
||||||||
| GET | ExpenseItems/GetExpenseItemCostCodeBreakdown/{id} |
|
Gets the costcode breakdown for an expense item by the expense item Id |
||||||||
| GET | ExpenseItems/GetJourneySteps?expenseId={expenseId} |
|
Gets all the journey steps for an expense id. |
||||||||
| GET | ExpenseItems/GetHomeToOfficeMileageComment?expenseId={expenseId} |
|
Gets the message explaining what, if any, the home to calculation type is for this expense. |
||||||||
| GET | ExpenseItems/GetExpenseItemFlags?expenseId={expenseId}&validationPointId={validationPointId}&validationTypeId={validationTypeId} |
|
Returns the list of FlagSummary associated with an expense item |
||||||||
| GET | ExpenseItems/GetExpenseItemDefinition?id={id} |
|
This endpoint helps to build the add/edit expense form. |
||||||||
| POST | ExpenseItems |
|
Adds an ExpenseItem. |
||||||||
| POST | ExpenseItems/SaveExpenseItem |
|
Saves an ExpenseItem |
||||||||
| POST | ExpenseItems/DeleteExpenseItem/{id} |
|
Deletes an expense item by its Id |
||||||||
| POST | ExpenseItems/DisputeExpenseItem?id={id} |
|
Saves the employee's reason for disputing a returned item |
||||||||
| PUT | ExpenseItems/UpdateExpenseItem |
|
Updates an ExpenseItem. |
||||||||
| PUT | ExpenseItems/ApproveItems |
|
Sets ExpenseItems to approved. |
||||||||
| PUT | ExpenseItems/UnapproveItem |
|
Sets an ExpenseItem to unapproved. |
||||||||
| PUT | ExpenseItems/ReturnExpenseItems |
|
Sets ExpenseItems to returned. |
Manages operations on ExpenseSubCategories.
| Verb | API element | Parameters | Description | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| OPTIONS | ExpenseSubCategories |
Gets all of the available end points from the ExpenseSubCategory part of the API. |
|||||||||
| GET | ExpenseSubCategories |
Gets all ExpenseSubCategories available. |
|||||||||
| GET | ExpenseSubCategories/{id} |
|
Gets an ExpenseSubCategory matching the specified id. |
||||||||
| GET | ExpenseSubCategories/GetMySubCatsByItemRoles |
Gets a list of the user's ExpenseSubCategoryItemRoleBasic. |
|||||||||
| GET | ExpenseSubCategories/GetMyMileageSubCats |
Gets all mileage ExpenseSubCategories that belong to the user's item roles. |
|||||||||
| GET | ExpenseSubCategories/GetEmployeeMileageSubCats |
Gets all mileage ExpenseSubCategoryBasic that belong to the employees's item roles. |
|||||||||
| GET | ExpenseSubCategories/GetBySubcatNames/{ids} |
|
Gets a list of ExpenseSubCategoryNames for a list of subcat Ids |
||||||||
| GET | ExpenseSubCategories/GetExpenseSubcategoryBasicById/{id} |
|
Gets the ExpenseSubCategoryBasic for the subcat Id |
||||||||
| GET | ExpenseSubCategories/Find?SubCatId={SubCatId}&CategoryId={CategoryId}&SubCat={SubCat}&AccountCode={AccountCode}&PdCat={PdCat}&Reimbursable={Reimbursable}&AlternateAccountCode={AlternateAccountCode}&ShortSubCategory={ShortSubCategory}&VatApplicable={VatApplicable}&SearchOperator={SearchOperator} |
|
Finds all ExpenseSubCategories matching specified criteria. |
||||||||
| GET | ExpenseSubCategories/GetExpenseSubCategoryByCategory?categoryId={categoryId}&isCorpCard={isCorpCard}&isMobileJourney={isMobileJourney} |
|
Gets a List of ExpenseItemSubCats that belong to a Category ID |
||||||||
| POST | ExpenseSubCategories |
|
Adds a new ExpenseSubCategory with VAT rates. |
||||||||
| PUT | ExpenseSubCategories/{id} |
|
Updates the ExpenseSubCategory, adds, updates, deletes VAT rates. To delete an associated VAT rate, set the ForDelete flag to true. |
||||||||
| DELETE | ExpenseSubCategories/{id} |
|
Deletes theExpenseSubCategory with given id. |
Manages operations on FilterRules.
| Verb | API element | Parameters | Description | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| OPTIONS | FilterRules |
Gets all of the available end points from the FilterRule part of the API. |
|||||||||||
| GET | FilterRules |
Gets all FilterRules in the system. |
|||||||||||
| GET | FilterRules/{id} |
|
Gets a filter rule FilterRuleResponse , by its Id. |
||||||||||
| GET | FilterRules/GetFilterRulesForAFilterType?filterType={filterType} |
|
Gets the GetFilterRulesResponse for a specific type. The filter type value |
||||||||||
| GET | FilterRules/GetItems?filterType={filterType}&useDescription={useDescription} |
|
Gets the FilterRules for the crieria. The filter type valueWhether the item description should be used, or the item name |
||||||||||
| GET | FilterRules/GetFilterRuleControlNameForChild?filterType={filterType} |
|
Gets the FilterRuleControlNameResponse for a specific type. The filter type value |
||||||||||
| GET | FilterRules/GetParentOrChildItem?filterType={filterType}&id={id}&isParent={isParent}&useDescription={useDescription} |
|
Gets the FilterRuleControlNameResponse for the criteria. The filter type valueThe indentifier of the element i.e. costcode Id.Whether the item is a parent and therefore the Id should be returned as wellWhether the item description should be used, or the item name |
||||||||||
| GET | FilterRules/FilterCostCodes?filterType={filterType}&id={id} |
|
|||||||||||
| GET | FilterRules/FilterDepartments?filterType={filterType}&id={id} |
|
|||||||||||
| GET | FilterRules/FilterProjectCodes?filterType={filterType}&id={id} |
|
Provides methods for handling FinancialYears.
| Verb | API element | Parameters | Description |
|---|---|---|---|
| OPTIONS | FinancialYears |
Gets all of the available end points from the FinancialYears part of the API. |
|
| GET | FinancialYears |
Returns list of FinancialYears |
Manages operations on Flag.
| Verb | API element | Parameters | Description | ||||
|---|---|---|---|---|---|---|---|
| OPTIONS | FlagManagement |
Gets all of the available end points from the Flag part of the API. |
|||||
| POST | FlagManagement/CreateFlag |
|
Creates a flag |
||||
| POST | FlagManagement/AssociateItemRolesWithFlag |
|
Associates item roles with a flag |
||||
| POST | FlagManagement/AssociateExpenseItemsWithFlag |
|
Associates expense items with a flag |
||||
| POST | FlagManagement/AssociateFieldsWithFlag |
|
Associates fields with a flag |
||||
| DELETE | FlagManagement/DeleteFlag/{id} |
|
Deletes a flag |
Manages operations on General Options.
| Verb | API element | Parameters | Description | ||||||
|---|---|---|---|---|---|---|---|---|---|
| OPTIONS | GeneralOptions |
Gets all of the available end points from the General Options part of the API. |
|||||||
| GET | GeneralOptions/GetAllBySubAccount?subAccountId={subAccountId} |
|
Gets all GeneralOptions for the given subaccount Id. |
||||||
| GET | GeneralOptions/GetByKeyAndSubAccount?key={key}&subAccountId={subAccountId} |
|
Gets a single GeneralOption, by its key and subaccount Id. |
||||||
| PUT | GeneralOptions |
|
Updates a the value of a GeneralOption, by its key and subaccount Id. |
||||||
| PUT | GeneralOptions/UpdateMultipleGeneralOptions |
|
Updates multiple GeneralOptions, by its key and subaccount Id. |
||||||
| PUT | GeneralOptions/SaveDisplayFieldSetting |
|
Saves the that can be enabled/disabled in general options to display specific fields when claiming for an expense |
Manages operations on Global Locales.
| Verb | API element | Parameters | Description |
|---|---|---|---|
| OPTIONS | Globals |
Gets all of the available end points from the Globals part of the API. |
|
| GET | Globals/Locales |
Returns list of Locales. |
|
| GET | Globals/GlobalCountries |
Returns list of GlobalCountries. |
|
| GET | Globals/GlobalCurrencies |
Returns list of GlobalCurrencies. |
Manages operations on Holiday.
| Verb | API element | Parameters | Description | ||||||
|---|---|---|---|---|---|---|---|---|---|
| OPTIONS | Holidays |
Gets all of the available end points from the Holiday part of the API. |
|||||||
| GET | Holidays |
Gets all Holiday available to the current user. |
|||||||
| GET | Holidays/GetAllHolidaysForEmployee/{id} |
|
Gets all Holiday available to a given user |
||||||
| GET | Holidays/GetHolidayForEmployee/{employeeId}/{holidayId} |
|
Gets a Holiday by its Id and the id of the employee it is assigned to. |
||||||
| POST | Holidays/Save |
|
Saves a Holiday for the current user. |
||||||
| POST | Holidays/AddHolidayForEmployee |
|
Saves a Holiday for a given user. |
||||||
| PUT | Holidays/Update |
|
Updates a Holiday for the current user. |
||||||
| PUT | Holidays/UpdateHolidayForEmployee |
|
Updates a Holiday for a given user. |
||||||
| DELETE | Holidays/{id} |
|
Deletes a Holiday by its Id. |
||||||
| DELETE | Holidays/DeleteHolidayForEmployee/{employeeId}/{holidayId} |
|
Deletes a Holiday by its Id and the Id of the it is assigned to. |
Manages operations on Hotel.
| Verb | API element | Parameters | Description | ||||
|---|---|---|---|---|---|---|---|
| OPTIONS | Hotels |
Gets all of the available end points from the Hotel part of the API. |
|||||
| GET | Hotels/GetHotelsByName?hotelName={hotelName} |
|
Gets a list of hotels that that match the hotel name search criteria |
||||
| POST | Hotels |
|
Saves a Hotel. |
Manages operations on List.
| Verb | API element | Parameters | Description | ||||||
|---|---|---|---|---|---|---|---|---|---|
| OPTIONS | ItemRoles |
Gets all of the available end points from the List part of the API. |
|||||||
| GET | ItemRoles |
Gets all List available. |
|||||||
| GET | ItemRoles/{id} |
|
Gets an ItemRole matching the specified id. |
||||||
| GET | ItemRoles/Find?ItemRoleId={ItemRoleId}&ItemRoleName={ItemRoleName}&ExpenseSubCategoryId={ExpenseSubCategoryId}&SearchOperator={SearchOperator} |
|
Finds all List matching specified criteria. Available querystring parameters : SearchOperator,ItemRoleId,RoleName, ExpenseSubCategory Use SearchOperator=0 to specify an AND query or SearchOperator=1 for an OR query |
||||||
| POST | ItemRoles |
|
Adds an ItemRole with associated subcategory ids. |
||||||
| POST | ItemRoles/AssignToEmployee/{eid} |
|
Assigns the item role with start date and end date to the employee |
||||||
| PUT | ItemRoles/{id} |
|
Updates ItemRole name, description and replaces existing subcategories |
||||||
| PUT | ItemRoles/UpdateItemRoleForSubCats?itemRoleId={itemRoleId} |
|
Associates Sub Categories with an Item Role |
||||||
| PATCH | ItemRoles/{id}/AssignToEmployee/{eid} |
|
|||||||
| PATCH | ItemRoles/{id}/RevokeFromEmployee/{eid} |
|
|||||||
| DELETE | ItemRoles/{id} |
|
Deletes an ItemRole with specified id. |
The controller handling journeys from mobile devices.
| Verb | API element | Parameters | Description | ||||
|---|---|---|---|---|---|---|---|
| OPTIONS | Journeys |
Gets ALL of the available end points from the API. |
|||||
| GET | Journeys/GetEmployeeActiveJourneys |
Gets all active journeys for an Employee |
|||||
| POST | Journeys/SaveJourneys |
|
Saves journeys for a mobile user. |
||||
| POST | Journeys/ReconcileMobileJourney |
|
Converts a MobileJourney to a ExpenseItemDefinition, which can then be used to create an expense item. |
||||
| PUT | Journeys/UpdateJourneys |
|
Update journeys for a mobile user. |
||||
| DELETE | Journeys/DeleteMobileJourney?journeyId={journeyId} |
|
Deletes a mobile journey |
Manages operations on Mileage Categories.
| Verb | API element | Parameters | Description | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| OPTIONS | MileageCategories |
Gets all of the available end points from the MileageCategories part of the API. |
|||||||||
| GET | MileageCategories |
Gets all MileageCategories in the system. |
|||||||||
| GET | MileageCategories/{id} |
|
Gets a single MileageCategory, by its Id. |
||||||||
| GET | MileageCategories/GetMileageCategoriesForVehicleOnExpense?vehicleId={vehicleId}&subCatId={subCatId}&expenseDate={expenseDate} |
|
Gets a list of GetMileageCategoriesResponse for the supplied vehicleId/subcatId If subcat has enforced mileage category then return this, not the vehicle's mileage categories |
||||||||
| GET | MileageCategories/Find?MileageCategoryId={MileageCategoryId}&VehicleJourneyRate={VehicleJourneyRate}&Comment={Comment}&FinancialYearId={FinancialYearId}&SearchOperator={SearchOperator} |
|
Finds all MileageCategories specified criteria. Available querystring parameters : SearchOperator, MileageCategoryId, MileageCategoryName, Comment, FinancialYearId Use SearchOperator=0 to specify an AND query or SearchOperator=1 for an OR query |
||||||||
| POST | MileageCategories/SaveMileageCategory |
|
Saves a MileageCategory. |
||||||||
| POST | MileageCategories/SaveMileageCategoryDateRanges?mileageCategoryId={mileageCategoryId} |
|
Saves a list of DateRanges for the supplied MileageCategoryId. |
||||||||
| POST | MileageCategories/SaveDateRangeThresholds?mileageCategoryId={mileageCategoryId}&dateRangeId={dateRangeId} |
|
Saves a list of Thresholds for the supplied DateRangeId and MileageCategoryId. |
||||||||
| POST | MileageCategories/SaveThresholdFuelRate?mileageThresholdId={mileageThresholdId} |
|
Saves a list of FuelRAtes for the supplied mileageThresholdId. |
||||||||
| PUT | MileageCategories/UpdateMileageCategory |
|
Updates a MileageCategory. |
||||||||
| PUT | MileageCategories/UpdateMileageCategoryDateRanges?mileageCategoryId={mileageCategoryId} |
|
Updates a list of DateRanges for the supplied MileageCategoryId. |
||||||||
| PUT | MileageCategories/UpdateDateRangeThresholds?mileageCategoryId={mileageCategoryId}&dateRangeId={dateRangeId} |
|
Updates a list of Thresholds for the supplied DateRangeId and MileageCategoryId. |
||||||||
| DELETE | MileageCategories/{id} |
|
Deletes a MileageCategory with specified id |
The mobile broadcast messages version 1 controller.
| Verb | API element | Parameters | Description |
|---|---|---|---|
| OPTIONS | MobileBroadcastMessages |
Gets ALL of the available end points from the API. |
|
| GET | MobileBroadcastMessages |
Gets all the active MobileBroadcastMessagesResponse |
The mobile information messages version 1 controller.
| Verb | API element | Parameters | Description |
|---|---|---|---|
| OPTIONS | MobileInformationMessages |
Gets ALL of the available end points from the API. |
|
| GET | MobileInformationMessages |
Gets all the active MobileInformationMessagesResponse |
Manages operations on MyDetails.
| Verb | API element | Parameters | Description | ||||
|---|---|---|---|---|---|---|---|
| OPTIONS | MyDetails |
Gets all of the available end points from the MyDetail part of the API. |
|||||
| GET | MyDetails/{id} |
|
Gets the Employee matching the specified id. |
||||
| GET | MyDetails/GetMyDetails |
Gets the Employee for the current employee |
|||||
| PUT | MyDetails/ChangeMydetail |
|
Updates the "My Details" part of an Employee. |
||||
| PUT | MyDetails/NotifyAdminOfChange |
|
Sends an email to the account administrator with the employee's requested changes to their "My Detail" part of an employee |
Manages get operations on NHS Trusts.
| Verb | API element | Parameters | Description | ||||
|---|---|---|---|---|---|---|---|
| OPTIONS | NHSTrusts |
Gets all of the available end points from the NhsTrust part of the API. |
|||||
| GET | NHSTrusts |
Gets all NhsTrusts in the system. |
|||||
| GET | NHSTrusts/{id} |
|
Gets a single NhsTrust, by its Id. |
Manages operations on OdometerReadings.
| Verb | API element | Parameters | Description | ||||||
|---|---|---|---|---|---|---|---|---|---|
| OPTIONS | OdometerReadings |
Gets all of the available end points from the OdometerReadings part of the API. |
|||||||
| GET | OdometerReadings/ForCar/{id} |
|
Gets all OdometerReadings in the system for a given car. |
||||||
| GET | OdometerReadings/GetLatestOdometerReading?id={id} |
|
Gets the latest OdometerReading in the system for a given car. |
||||||
| GET | OdometerReadings/GetVehiclesOdometer |
Gets all vehicles in system that require odometer readings for given user. |
|||||||
| GET | OdometerReadings/{id} |
|
Gets a single OdometerReading, by its Id. |
||||||
| POST | OdometerReadings |
|
Adds an OdometerReading. |
||||||
| POST | OdometerReadings/SaveOdometerReadings |
|
Adds list of OdometerReadings. |
||||||
| PUT | OdometerReadings/{id} |
|
Edits an OdometerReading. |
||||||
| DELETE | OdometerReadings/{id} |
|
Deletes an OdometerReading. |
Manages operations on Organisations.
| Verb | API element | Parameters | Description | ||||
|---|---|---|---|---|---|---|---|
| OPTIONS | Organisations |
Gets all of the available end points from the Organisation part of the API. |
|||||
| GET | Organisations |
Gets all Organisations in the system. |
|||||
| GET | Organisations/Find?Label={Label}&Comment={Comment}&Code={Code}&Archived={Archived}&AddressLine1={AddressLine1}&City={City}&PostCode={PostCode} |
|
Finds all Organisation matching specified criteria. |
||||
| POST | Organisations |
|
Adds an Organisation. |
Facilitates the management of P11D Categories. See P11DCategory.
| Verb | API element | Parameters | Description | ||||||
|---|---|---|---|---|---|---|---|---|---|
| OPTIONS | P11DCategories |
Gets all of the available end points from the P11DCategories part of the API. |
|||||||
| GET | P11DCategories |
Gets all P11DCategories within the system. |
|||||||
| GET | P11DCategories/{id} |
|
Gets a P11DCategory with the supplied id. |
||||||
| GET | P11DCategories/Find?Label={Label}&SearchOperator={SearchOperator} |
|
Finds all P11DCategories matching specified criteria. |
||||||
| POST | P11DCategories |
|
Adds a P11DCategory. |
||||||
| PUT | P11DCategories/{id} |
|
Edits a P11DCategory. |
||||||
| DELETE | P11DCategories/{id} |
|
Deletes a P11DCategory. |
Manages operations on ProjectCodes
| Verb | API element | Parameters | Description | ||||||
|---|---|---|---|---|---|---|---|---|---|
| OPTIONS | ProjectCodes |
Gets all of the available end points from the ProjectCodes part of the API. |
|||||||
| GET | ProjectCodes |
Gets all ProjectCodes in the system. |
|||||||
| GET | ProjectCodes/{id} |
|
Gets a single ProjectCode, by its Id. |
||||||
| GET | ProjectCodes/GetAllActive |
Gets all active project codes |
|||||||
| GET | ProjectCodes/Find?Label={Label}&Description={Description}&SearchOperator={SearchOperator} |
|
Finds all ProjectCodes matching specified criteria. |
||||||
| POST | ProjectCodes |
|
Adds a ProjectCode. |
||||||
| PUT | ProjectCodes/{id} |
|
Edits a ProjectCode. |
||||||
| PATCH | ProjectCodes/{id}/Archive/{archive} |
|
Archives or un-archives a ProjectCode, depeding on what is passed in. |
||||||
| DELETE | ProjectCodes/{id} |
|
Deletes a ProjectCode. |
Manages operations on Receipt.
| Verb | API element | Parameters | Description | ||||||
|---|---|---|---|---|---|---|---|---|---|
| OPTIONS | Receipt |
Gets all of the available end points from the Receipt part of the API. |
|||||||
| GET | Receipt/{expenseId}?generateThumbnails={generateThumbnails} |
|
Gets a list of receipts for the expense Id |
||||||
| POST | Receipt/UploadReceipt |
|
Uploads a base64 encoded receipt. |
||||||
| POST | Receipt/UploadReceiptWithFullReceiptReturn |
|
Uploads a base64 encoded receipt and returns the receipt data for the uploaded receipt. |
||||||
| POST | Receipt/DeleteReceiptWithApproverJustification |
|
Updates the claim history with the approver's reason for deleteing the receipt, then deletes the receipt. |
||||||
| DELETE | Receipt/{id} |
|
Deletes a receipt by its Id. |
Manages Operations on SignOffGroups.
| Verb | API element | Parameters | Description | ||||||
|---|---|---|---|---|---|---|---|---|---|
| OPTIONS | SignOffGroups |
Gets all of the available end points from the SignOffGroups part of the API. |
|||||||
| GET | SignOffGroups |
Gets all SignOffGroups in the system. |
|||||||
| GET | SignOffGroups/{id} |
|
Gets a single SignOffGroup, by its Id. |
||||||
| GET | SignOffGroups/Find?GroupId={GroupId}&GroupName={GroupName}&SearchOperator={SearchOperator} |
|
Finds all SignOffGroups matching specified criteria. Available querystring parameters : SearchOperator,GroupId,GroupName Use SearchOperator=0 to specify an AND query or SearchOperator=1 for an OR query |
||||||
| POST | SignOffGroups |
|
Adds a SignOffGroup |
||||||
| PUT | SignOffGroups/{id} |
|
Edits a SignOffGroup. |
||||||
| DELETE | SignOffGroups/{id} |
|
Deletes a SignOffGroup with the specified id. |
Manages operations on Teams.
| Verb | API element | Parameters | Description | ||||||
|---|---|---|---|---|---|---|---|---|---|
| OPTIONS | Teams |
Gets all of the available end points from the Teams part of the API. |
|||||||
| GET | Teams |
Gets all Teams in the system. |
|||||||
| GET | Teams/{id} |
|
Gets a single Team, by its Id. |
||||||
| GET | Teams/Find?Label={Label}&Description={Description}&SearchOperator={SearchOperator} |
|
Finds all Teams matching specified criteria. |
||||||
| POST | Teams |
|
Adds a Team. |
||||||
| PUT | Teams/{id} |
|
Edits a Team. |
||||||
| PATCH | Teams/{id}/ModifyEmployees |
|
Modifies the list of employees for a given Team. |
||||||
| PATCH | Teams/{id}/ChangeLeader/{teamLeaderId} |
|
Changes the team leader of the Team. |
||||||
| DELETE | Teams/{id} |
|
Deletes a Team. |
Manages operations on Tooltips.
| Verb | API element | Parameters | Description | ||||
|---|---|---|---|---|---|---|---|
| OPTIONS | Tooltips |
Gets all of the available end points from the Tooltip part of the API. |
|||||
| GET | Tooltips/{id} |
|
Gets a specific Tooltip in the system. |
Contains a few utility methods for getting UserDefinedFields.
| Verb | API element | Parameters | Description | ||||
|---|---|---|---|---|---|---|---|
| OPTIONS | UserDefinedFields |
Gets all of the available end points from the UserDefinedFields part of the API. |
|||||
| GET | UserDefinedFields |
Gets all the UserDefinedFields |
|||||
| GET | UserDefinedFields/{id} |
|
Gets the UserDefinedField for the specified id |
||||
| POST | UserDefinedFields/SaveUserDefinedField |
|
Saves a UserDefinedFieldRequest |
||||
| DELETE | UserDefinedFields/{id} |
|
Deleted the specified UserDefinedField by its Id |
Manages operations on Vehicles.
| Verb | API element | Parameters | Description | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| OPTIONS | Vehicles |
Gets all of the available end points from the Vehicles part of the API. |
|||||||||
| GET | Vehicles |
Gets all Pool cars for this account. |
|||||||||
| GET | Vehicles/{id} |
|
Gets a single Vehicle, by its Id. |
||||||||
| GET | Vehicles/Find?Make={Make}&Model={Model}&Registration={Registration}&Active={Active}&Approved={Approved}&StartsBeforeOrOn={StartsBeforeOrOn}&StartsAfter={StartsAfter}&EndsBeforeOrOn={EndsBeforeOrOn}&EndsAfter={EndsAfter}&OdometerReadingOver={OdometerReadingOver}&OdometerReadingUnder={OdometerReadingUnder}&SearchOperator={SearchOperator} |
|
Finds all Vehicles matching specified criteria. |
||||||||
| GET | Vehicles/GetVehicleDefinition |
This endpoint helps to build the add vehicle form by returning the data required to popualte the form's controls |
|||||||||
| GET | Vehicles/GetMyVehicles |
Gets the list of the user's Vehicles. |
|||||||||
| GET | Vehicles/GetMyVehiclesForAddEditExpense?claimId={claimId}&expenseDate={expenseDate}&subcatId={subcatId} |
|
Gets the list of the user's Vehicles for the add/edit expense screen. |
||||||||
| GET | Vehicles/GetUnapprovedVehiclesCount |
Gets a count of unapproved vehicles for the current user |
|||||||||
| GET | Vehicles/LookupVehicle/{registrationNumber} |
|
Performs a lookup via an instance of |
||||||||
| POST | Vehicles |
|
Adds a Vehicle.
EmployeeId must be set to 0 for poolcars and to a valid employee id for an employee-owned car. |
||||||||
| PUT | Vehicles/{id} |
|
Edits a Vehicle.
EmployeeId must be set to 0 for poolcars and to a valid employee id for an employee-owned car. |
||||||||
| PATCH | Vehicles/{id}/LinkPoolCarUser/{eid} |
|
Links an Employee to a Vehicle. That is to say that the user is allowed to use that pool car. |
||||||||
| PATCH | Vehicles/{id}/UnLinkPoolCarUser/{eid} |
|
Un-Links an Employee from a Vehicle. That is to say that the user is not allowed to use that pool car. |
||||||||
| PATCH | Vehicles/{id}/UnLinkAllPoolCarUsers |
|
Un-Links ALL Employees from a Vehicle. That is to say that the pool car will then have no users. |
||||||||
| DELETE | Vehicles/{id} |
|
Deletes a Vehicle. |