Get All Fee Schedules

Gets all fee schedules in the system

Resource Information

Scope	payments Deprecated scope name: get_settings_fees
App Type	All
Authorization Type	Access token
URI	/v4/settings/fees?schedule={schedule}&version={version}&lang={lang}&fields={fields}
HTTP Method	GET
Automation Version(s)	7.3.2

Request Information

Field or Parameter	Type	Required	Values	Description	Automation Version
fields	string	No	�	Comma-delimited names of fields to be returned in the response. Note: Field names are case-sensitive and only first-level fields are supported. Invalid field names are ignored.	7.3.2
lang	String	No	�	Indicates the language applied.	7.3.2
schedule	string	No	Get All Fee Schedules for Record Type	Contains parameters that define the fee schedule.	7.3.2
version	string	No	�	A unique name or number sequence used to identify the version. This field works with the 'Effective Date' and 'Disabled on Date' fields to determine which version is active. Only one version can be active at a time.	7.3.2

Response Information

Field	Type	Description	Automation Version
result[]	result{}	�	7.3.2
result.acaRequiredFlag	string	Indicates whether or not the fee schedule is required in order to make it accessible to citizens.	7.3.2
result.accCodeL1	string	The code associated with the first fee	7.3.2
result.accCodeL2	string	The code associated with the second fee	7.3.2
result.accCodeL3	string	The code associated with the third fee	7.3.2
result.accountCode1Allocation	double	Allocation proportion or amount of account code 1.	7.3.2
result.accountCode2Allocation	double	Allocation proportion or amount of account code 2.	7.3.2
result.accountCode3Allocation	double	Allocation proportion or amount of account code 3.	7.3.2
result.allocatedFee1	double	The allocated fee for account code 1.	7.3.2
result.allocatedFee2	double	The allocated fee for account code 2.	7.3.2
result.allocatedFee3	double	The allocated fee for account code 3.	7.3.2
result.amount	double	The amount of a payment transaction or account balance.	7.3.2
result.applyDate	dateTime	The date the fee is applied.	7.3.2
result.auditDate	dateTime	The creation or last modified date.	7.3.2
result.autoAssessFlag	string	Indicates whether or not the fee item is automatically assessed.	7.3.2
result.autoInvoiceFlag	string	Indicates whether or not the fee item is automatically invoiced.	7.3.2
result.balanceDue	double	The amount due.	7.3.2
result.calcFlag	string	Indicates whether or not the fee amount is based on fee calculation.	7.3.2
result.calculatedFlag	string	Indicates whether or not the fee amount is based on fee calculation.	7.3.2
result.code	result.code{}	A code identifying an associated item	7.3.2
result.code.text	string	The localized display text.	7.3.2
result.code.value	string	The value for the specified parameter.	7.3.2
result.description	result.description{}	The description of the record or item.	7.3.2
result.description.text	string	The localized display text.	7.3.2
result.description.value	string	The value for the specified parameter.	7.3.2
result.displayOrder	long	The order of the item in comparison to the other items.	7.3.2
result.effectDate	dateTime	Fee item effective date.	7.3.2
result.expireDate	dateTime	The date when the item expires	7.3.2
result.feeAllocationType	string	The fee allocation type to each account code.	7.3.2
result.feeNotes	string	Notes about the fee.	7.3.2
result.id	long	The unique identifier for the object, assigned by the Civic Platform server and provided in a response.	7.3.2
result.invoiceId	long	The invoice ID for the fee item.	7.3.2
result.maxFee	double	The maximum fee item.	7.3.2
result.minFee	double	The minimum fee item.	7.3.2
result.paymentPeriod	result.paymentPeriod{}	The time interval for processing invoices.	7.3.2
result.paymentPeriod.text	string	The localized display text.	7.3.2
result.paymentPeriod.value	string	The value for the specified parameter.	7.3.2
result.priority	long	The priority level assigned to the fee item.	7.3.2
result.quantity	double	The number of units for which the same fee applies.	7.3.2
result.recordId	result.recordId{}	The unique ID associated with a record.	7.3.2
result.recordId.customId	string	An ID based on a different numbering convention from the numbering convention used by the record ID (xxxxx-xx-xxxxx). Accela Automation auto-generates and applies an alternate ID value when you submit a new application.	7.3.2
result.recordId.id	string	The unique identifier for the object, assigned by the Civic Platform server and provided in a response.	7.3.2
result.recordId.serviceProviderCode	string	The unique agency identifier, the system assigns, on the Accela Civic Platform.	7.3.2
result.recordId.trackingId	long	The application tracking number (IVR tracking number).	7.3.2
result.schedule	result.schedule{}	Contains parameters that define the fee schedule.	7.3.2
result.schedule.text	string	The localized display text.	7.3.2
result.schedule.value	string	The value for the specified parameter.	7.3.2
result.status	string	The fee item status.	7.3.2
result.subGroup	result.subGroup{}	A grouping of fee items to which the system can ascribe a value.	7.3.2
result.subGroup.text	string	The localized display text.	7.3.2
result.subGroup.value	string	The value for the specified parameter.	7.3.2
result.udf1	string	User defined field 1	7.3.2
result.udf2	string	User defined field 2	7.3.2
result.udf3	string	User defined field 3	7.3.2
result.udf4	string	User defined field 4	7.3.2
result.unit	result.unit{}	The unit of measure used for the object. For fees, this might be square feet, for example.	7.3.2
result.unit.text	string	The localized display text.	7.3.2
result.unit.value	string	The value for the specified parameter.	7.3.2
result.variable	string	The variable associated with the fee item.	7.3.2
result.version	result.version{}	A unique name or number sequence used to identify the version. This field works with the 'Effective Date' and 'Disabled on Date' fields to determine which version is active. Only one version can be active at a time.	7.3.2
result.version.text	string	The localized display text.	7.3.2
result.version.value	string	The value for the specified parameter.	7.3.2
status	integer	The record status.	7.3.3