API Permissions
Roles, menus, screen aliases, and system menus
Overview
Your IT team or third-party suppliers can authenticate and run eligible
APIs to create processes and activities outside of the Catch-e application.
For example, a Novated Lease Calculator on your website.
Role Access
To check role access to APIs
System / Roles - select the target role record
API Access - if this field is checked, the Roles / Apis tab will be available.
Roles / API tab
The Roles / API tab is only shown for roles where "Access Type" is 'web-services'.
'web_services' is a standard role with this access type.
Only 'admin' users can view this tab and enable/disable permissions.
Available permissions are listed in alphanumeric order.
Go to the APIs page to see a list of the APIs that these permissions enable.
Note: To optimise security, only enable permissions for the individual APIs that you need.
Permissions
Permissions | Description |
ApiPermissions:Get | Request a list of API permissions, Request a list of role assigned API permissions |
ApiPermissions:Update | Set role API permissions |
Approvals:Unpost | Unpost an approval |
Approvals:Update | Patch an approval, Update an approval |
Attachments:Delete | Delete an attachment |
Attachments:Get | Get an attachment by attachment id, Get an attachment resource pre-signed URL |
Attachments:Save | Save an attachment |
BespokeFields:Get | Get a bespoke field by bespoke field id, Get bespoke field values, Get a list of bespoke fields |
Cards:Create | Upload and validate a card import CSV, Create cards |
Cards:Get | Get a list of cards, Get a card by card id, Download the error report CSV for a card import batch, Download the final result CSV for a card import batch |
Cards:Update | Upload and validate a card import CSV, Update a list of cards, Update card, Process a validated card import batch |
ChannelGroups:Create | Create a new channel group |
ChannelGroups:Delete | Delete a channel group |
ChannelGroups:Get | Get a list of configured channel groups, Get a channel group by channel group id |
ChannelGroups:Update | Update an existing channel group |
ChannelQuoteDefaults:Create | Create a new channel quote default |
ChannelQuoteDefaults:Get | Get a list of channel quote defaults, Get a channel quote default by channel default id |
ChannelQuoteDefaults:Update | Update an channel quote default |
Channels:Create | Create a new channel |
Channels:Delete | Delete a channel |
Channels:Get | Get a list of configured channels, Get a channel by channel id |
Channels:Update | Update an existing channel |
ClientCostCentres:Get | Get a list of client cost centres |
ClientDivisions:Get | Get a list of client divisions |
ClientIndustries:Get | Get a list of client industries |
ClientPackagingDefaults:Get | Get client packaging defaults |
ClientPackagingDefaults:Set | Set client packaging defaults |
Clients:Create | Copy client, Create clients |
Clients:Get | Get a list of clients, Get client |
Clients:Update | Patch a list of clients, Patch a client |
Companies:Get | Get a list of configured companies, Get a company by company id |
CompetitorMargins:Get | Get a list of competitor margins |
Competitors:Get | Get a list of competitors |
Contacts:Create | Create a new contact job title, Create a new contact type allocation, Update contact type allocation, Create a new contact type, Create a new allocation for a contact, Create a new contact |
Contacts:Delete | Delete a contact job title, Delete contact type allocation, Delete a contact type, Delete allocation, Delete a contact |
Contacts:Get | Get a list of contact job titles, Get a contact job title by contact job title id, Get a list of contact type allocations, Get a list of contact types, Get a contact type by contact type id, Get a list of contacts, Get a contact by contact id |
Contacts:Update | Update an existing contact job title, Update an existing contact type, Update an existing contact |
ContractBilling:Edit | Edit budgets for a contract that has not yet billed |
ContractBilling:Get | Calculate contract start periodic date, Get a single Contract billing/invoice line item, Get contract billing status, Get billing/invoice line items for a Contract, Has contract started billing |
ContractBilling:Unpost | Check if an invoice batch can be unposted, Unpost an invoice batch, Check if an invoice can be unposted, Unpost an invoice |
ContractBilling:Vary | Modify future billings for a contract that has started billing |
ContractBudgets:CreateFinalEntries | Create contract budget final entries, Perform a contract budget create final entries pre-check |
ContractBudgets:Delete | Delete contract budgets |
ContractBudgets:Get | Get a contract budget by contract budget id, Get contract budgets for the specified search criteria |
ContractBudgets:Insert | Insert new contract budgets |
ContractBudgets:Update | Update contract budgets |
ContractEventDescriptions:Get | Get contract event descriptions |
ContractEvents:Delete | Delete a contract event |
ContractEvents:Get | Get contract events |
ContractEventValues:Get | Get contract event values |
ContractMaintenance:Get | Get contract maintenance |
ContractPaymentSchedules:Edit | Edit payment schedules for one or more payment structures |
ContractPaymentSchedules:Get | Get a list of contract payment schedules |
ContractPaymentStructures:Get | Get a contract payment structure, Get a list of contract payment structures, Has contract posted payments |
ContractPaymentStructures:Vary | Modify payment structures for a contract |
ContractPayoutStatuses:Get | Get a contract payout status by contract payout status id, Get a list of configured contract payout statuses |
ContractPayouts:Create | Raise a new contract payout |
ContractPayouts:Delete | Delete contract payout |
ContractPayouts:Get | Get a list of contract payouts, Get a contract payout by contract payout id, Get a contract payout access by contract payout id, Get available payout transitions by contract payout id, Prepare a calculated value estimate for a given contract, Get initial payout transitions by contract payout id |
ContractPayouts:InvoiceSent | Transition a Contract Payout into invoice-sent state |
ContractPayouts:Open | Transition a Contract Payout into open state |
ContractPayouts:Update | Update an existing contract payout, Transition a Contract Payout into accepted state, Transition a Contract Payout into financier state, Transition a Contract Payout into requested state, Transition a Contract Payout into review state, Transition a Contract Payout into sent state |
CorporateTypes:Get | Get a list of corporate types |
Countries:Get | Get a list of countries |
DealTypes:Get | Get a list of deal types |
DiscountTypes:Get | Get a list of discount types |
DmzUploadFileDestinations:Create | Create DMZ upload file destination |
DmzUploadFileDestinations:SetEncryptionKey | Set DMZ upload file destination encryption key |
DocumentConversion | Convert a document into a specified target type |
DomainIdentityStatus:Get | Get domain identity status |
DriverAssets:Create | Create assets for drivers |
DriverAssets:Delete | Delete assets for a driver, Delete individual asset for a driver |
DriverAssets:Get | Get assets for a driver, Get asset for a driver |
DriverAssets:Update | Update assets for a driver, Update asset for a driver |
DriverBankAccounts:Get | Get Driver Bank Accounts, Get a driver bank account |
DriverBankAccounts:Update | Update a list of driver bank accounts, Update driver bank account |
DriverEventActions:Get | Get driver event actions |
DriverEventDescriptions:Get | Get driver event descriptions |
DriverEvents:Create | Create driver events |
DriverEvents:Get | Get driver events, Get a driver event |
DriverEvents:Update | Patch a list of driver events, Patch a driver event |
DriverEventValues:Get | Get driver event values |
DriverLiabilities:Create | Create liabilities for drivers |
DriverLiabilities:Delete | Delete individual liability for a driver |
DriverLiabilities:Get | Get liabilities for a driver, Get liability for a driver |
DriverLiabilities:Update | Update liabilities for a driver, Update liability for a driver |
Drivers:Deidentification | De-identify driver data |
Drivers:Update | Update a list of drivers, Update a driver |
EmployeeClaims:GetAutoBuildPostingClasses | Get posting classes for auto-build claims |
EmployeeClaims:UnPost | Un-post a salary-packaged claim |
EmployeePackageItemPayCycles:Get | Get package item pay cycles by package item pay cycle id, Get package item pay cycles |
EmployeePackageItems:Create | Create package items for employees |
EmployeePackageItems:Delete | Delete package item for employee |
EmployeePackageItems:Edit | Change the bank account for an employee package item, Edit package item for employee |
EmployeePackageItems:Get | Get package items for employees, Get an employee package item by employee package item id, Calculate potential package item end dates, Calculate potential package item start dates, Get package item by package item id, Get package items ids, Get package items, Get Employee Contract Life Budget and Disbursement, Get driver pay cycle details by driver id |
EmployeePackageItems:Vary | Vary package item for employee |
EmployeePayments:Create | Auto-post payments |
Events:ReconcileSubscriptions | Reconcile event subscriptions |
Events:Subscribe | Subscribe to events, Delete an event subscription |
ExportTable | Download data for an existing table data export request, Request a list of tables authorised for data export, Request a table data export |
Files:Import | Import file |
FinanceAssetTypes:Get | Get finance asset types |
FinanceLiabilityFinanciers:Get | Get finance liability financiers |
FinanceLiabilityTypes:Get | Get finance liability types |
FinanceTypes:Get | Get a list of finance types |
FinancierMarginRate:Get | Get a financier margin rate by financier margin rate id |
FinancierMarginRates:Get | Get a list of financier margin rates |
FormsHelper:Get | Get empty JSON payload with default values for a model for a method name |
FuelTypes:Get | Get a list of fuel types |
FuelTypeTranslations:Get | Get a list of fuel type translations |
GbControls:Get | Get a gb control, Get a list of gb controls |
GbControls:Update | Set gb control |
GNAF:AutocompleteAddressRecord | Autocomplete (lookup) a geocoded national address record (G-NAF) |
GNAF:GetAddressRecord | Get a geocoded national address record (G-NAF) |
ImportPublicHolidays | Import public holiday data |
ImportTable | Cancel a table data import, Get table data import status, Trigger table data import procedure, Get table data import statuses, Request a table data import, Request a list of tables authorised for data import |
InclusionPlans:Get | Get an inclusion plan by inclusion plan id, Get a list of inclusion plans |
Inclusions:Get | Get an inclusion by inclusion id, Get a list of inclusions |
InsuranceLoadingRates:Get | Get insurance loading rates |
InsuranceLoadingTypes:Get | Get an insurance loading type by insurance loading type id, Get a list of insurance loading types |
InsuranceTypes:Get | Get an insurance type by insurance type id, Get a list of insurance types |
InsurerLocations:Get | Get an insurer location by insurer location id, Get a list of insurer locations |
InterfaceAngleFinance:LoanApplication | Submit loan application via Angle Finance API interface, Perform an Angle Finance loan application pre-check, Resubmit an existing loan application, Update loan application status via Angle Finance API interface |
InterfaceAutoGuru:ImportApprovals | Import approvals from AutoGuru |
InterfaceEricInsurance:GetPricing | Get pricing from Eric Insurance API interface |
InterfaceExports:255FinanceGet | Get a 255 Finance export batch |
InterfaceExports:255FinancePrepare | Prepare a 255 Finance export batch |
InterfaceExports:255FinanceSubmit | Submit a 255 Finance export batch |
InterfaceExports:BecsBatchDelete | Delete BECS disbursements batch |
InterfaceExports:BecsBatchGet | Get BECS disbursements batch |
InterfaceExports:BecsDisbursementsBatchCreate | Create BECS disbursements batch |
InterfaceExports:BpayBankAccounts | Get a list of configured bank accounts |
InterfaceExports:BpayBatchCreate | Create next BPAY batch |
InterfaceExports:BpayBatchDelete | Delete Bpay disbursements batch |
InterfaceExports:BpayBatchGet | Get BPAY batch |
InterfaceExports:BpayBatchUpdate | Update BPAY batch |
InterfaceExports:BpayControls | Get controls for an existing batch, Get controls estimate for the next batch |
InterfaceLAPS:GetPricing | Get pricing from LAPS API interface |
InterfaceSalesforceApex:SyncContract | Sync contract with Salesforce Apex interface |
InterfaceSalesforceApex:SyncQuote | Sync quote with Salesforce Apex interface |
InterfaceSalesforceLegacy:SyncQuote | Sync quote with Salesforce (legacy) interface |
Locations:Get | Get a list of locations |
Locks:Delete | Delete specified locks |
Locks:Get | List currently held locks, List currently held record locks |
LtiPlans:Get | Get a list of LTI plans |
LtiTopUpBenefits:Get | Get a list of LTI Top Up Benefits |
Mail:SuppressedDestinationDelete | Delete suppressed destination |
Mail:SuppressedDestinationGet | Get suppressed destination |
MaintenanceImports:Check | Check Maintenance Import |
MaintenanceImports:Get | Get Maintenance Imports |
MaintenanceImports:Post | Post Maintenance Import |
MaintenanceImports:Purge | Purge Maintenance Imports |
MaintenanceImports:Upload | Upload a Maintenance Import file |
MaintenanceServiceProfiles:Get | Get a list of maintenance service profiles |
OpportunityStages:Get | Get a list of opportunity stages |
Originators:Get | Get a list of Originators |
PackageItemDefaults:Get | Get a package item defaults by package item default Id, Get Package item defaults |
PackageItems:CalculateDeductions | Calculate remaining package item payroll cycles for the current FBT year, Calculate deduction per pay for a package item, Calculate total deduction for a package item |
PayCycles:Get | Get payment method by payment method id, Get Pay cycles |
PayeePaymentMethods:Get | Get Payee Payment method by payee payment method id, Get payee payment methods |
Payees:Get | Get Payee by payee id, Get Payees |
PaymentMethods:Get | Get payment method by payment method id, Get Payment methods |
PayRunMailBatch:Create | Create a pay run mail batch |
Ping | Ping the API |
PostingClasses:Get | Get Posting Class, Get Posting Classes |
PostingMaps:Get | Get Posting Maps |
PowerPlantTypes:Get | Get a list of power plant types |
Queries:Create | Create a new Query |
Queries:Delete | Delete a query |
Queries:ExecuteScript | Execute a script query, Get execute script request status |
Queries:Get | Request a gb query table data import, Get a list of queries, Get query by query Id, Get archived query by query Id |
Queries:Print | Execute the query |
QuoteEventCodes:Get | Get quote event codes |
QuoteEvents:Get | Get quote events, Get a quote event |
QuoteEvents:Update | Patch a list of quote events, Patch a quote event |
Quotes:Accept | Accept quote |
Quotes:Copy | Copy quote |
Quotes:Get | Get quote |
Quotes:RefreshBaseRate | Refresh quote base rate |
Quotes:RenderPDF | Render quote PDF |
Quotes:TemplateDeveloper | Render quote PDF with a template archive |
QuotesSubStatuses:Get | Get quote sub statuses |
QuoteVariants:Get | Get a list of variants, Get a variant by variant id, Get a body type by body type id, Get a list of variant body types, Get a list of variant data sources, Get a make by make id, Get a list of variant makes, Get a model by model id, Get an array of model years for a given vehicle model, Get a list of variant models, Get variant optional equipment by variant id, Get photos for a specific variant, Get a list of variant profiles, Get variant standard equipment by variant id |
QuoteVariants:Update | Patch a variant |
Record:Get | Read values for a single record |
ReferenceData:Create | Add Variant Standard Equipment, Create new variant dealer discount |
ReferenceData:Delete | Delete a list of variant standard equipments, Delete a list of variant discounts, Delete a Variant Dealer Discount, Delete Variant Standard Equipment |
ReferenceData:Get | Get a list of Variant Standard Equipments, Get list of variant dealer discounts, Get a variant dealer discount by Variant dealer discount id |
ReferenceData:Update | Update an existing variant dealer discount |
ReportGroups:Get | Get report group by report group id, Get Report Groups |
RoadsideAssistancePlans:Get | Get a list of roadside assistance plans |
SalaryPackageDisbursementCycles:Get | Get a disbursement cycle by disbursement cycle id, Get a list of configured disbursement cycles |
SalaryPackageFinancialInstitutions:Get | Get a list of configured financial institutions |
SchedulerMaintenance:Acknowledge | Acknowledge scheduler maintenance events |
SchedulerMaintenance:Get | Get scheduler maintenance events |
SignonToken:Create | Generate a signon token |
SupplierPaymentTerms:Get | Get a supplier payment term, Get supplier payment terms |
Suppliers:Create | Create suppliers |
Suppliers:Get | Get a list of configured suppliers, Get a supplier by supplier id, Get a supplier payment details by supplier id |
Suppliers:Update | Update supplier |
TyreRimInsurancePlans:Get | Get a list of tyre and rim insurance plans |
Tyres:Get | Get a list of tyres |
UniqueIds:Get | Get a unique id for a specified table |
UniqueIds:Reset | Reset unique ids |
UserLogins:Create | Create a new user login |
UserLogins:Get | Get a list of configured user logins, Get a user login by user login id |
UserLogins:Update | Update an existing user login |
Users:Get | Get valid users |
VehicleData:ImportGlass | Get Glass vehicle data import status, Trigger Glass vehicle data import procedure, Request a Glass vehicle data import |
VehicleData:ImportJato | Get JATO vehicle data import status, Trigger JATO vehicle data import procedure, Request a JATO vehicle data import |
VehicleTypes:Get | Get a list of vehicle types |
VehicleUsageTypes:Get | Get a list of vehicle usage types |
WalkawayPlans:Get | Get a list of walkaway plans |
WorkCodes:Get | Get a list of work codes |
Action Buttons
Button | Description |
View | Click to view the permissions available to be run by this role |
Edit | Click to edit the permissions available to be run by this role |
Save | When you have finished editing, click to save |
Cancel | Click to discard your current changes |
Legend
Permission - The permission is available by default
Permission (Restricted) - This permission is not visible on the Roles / APIs screen unless it has been configured for external use. Contact your Account Manager to discuss
Role Permissions
All roles can generate a token from the authenticate API.
But other APIs can only be run if the role has permission to do so.
To optimise security, only enable necessary API permissions for the role.
To review or enable permissions for a role.
System / Roles - select the target role record
Navigate to the Roles / Apis tab
Edit and check on the required permissions
If you are not actively using an API, leave the permission off for better security.
Logins
Create separate logins for each API process and each supplier also.
If issues arise, it is easier to investigate if the role and user are clearly identifiable.
This also makes it easier for you to decommission an API process by suspending the related login/s without affecting other system areas.
Key fields from sample records are shown below:
Example Set-up
Role / User - Web Quotes
Role
Role 'abc'
Access Type 'web-services'
User
User Login 'webquote_ABC'
Role 'abc'
Organisation 'ABC Web Development'
Role / User - CRM
Role
Role 'crm'
Access Type 'web-services'
User
User Login 'crm_client_data'
Role 'crm'
Organisation 'CRM Company'
Role / User - Fleet Manager
Role
Role 'fleet_manager'
Access Type 'external'
Restrict Key 'client_id'
User
User Login 'Fancy Fleet'
Role 'fleet_manager'
Organisation 'Fancy Fleet'
Was this helpful?
Still need help? Ask the team