Create Record Fees

Creates fees for the specified record.

Resource Information

Scoperecords

Deprecated scope name:   create_record_fees

App TypeAgency
Authorization TypeAccess token
URI /v4/records/{recordId}/fees?lang={lang}
HTTP MethodPOST
Automation Version(s)7.3.2

Request Information

Field or ParameterTypeRequiredValuesDescriptionAutomation Version
codecode{}No A code identifying an associated item7.3.2
code.textstringNo The localized display text.7.3.2
code.valuestringNo The value for the specified parameter.7.3.2
feeNotesstringNo Notes about the fee.7.3.2
idlongNo The unique identifier for the object, assigned by the Civic Platform server and provided in a response.7.3.2
paymentPeriodpaymentPeriod{}No The time interval for processing invoices.7.3.2
paymentPeriod.textstringNo The localized display text.7.3.2
paymentPeriod.valuestringNo The value for the specified parameter.7.3.2
quantitydoubleNo The number of units for which the same fee applies.7.3.2
scheduleschedule{}No Get All Fee Schedules for Record Type Contains parameters that define the fee schedule.7.3.2
schedule.textstringNo The localized display text.7.3.2
schedule.valuestringNo The value for the specified parameter.7.3.2
versionversion{}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
version.textstringNo The localized display text.7.3.2
version.valuestringNo The value for the specified parameter.7.3.2
fieldsstringNo 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
langStringNo Indicates the language applied.7.3.2
recordIdstringYes Get All Records Search Records Get My Records The unique ID associated with a record.7.3.2

Response Information

FieldTypeDescriptionAutomation Version
result[]result{} 7.3.2
result.codestringA code identifying an associated item7.3.2
result.idstringThe unique identifier for the object, assigned by the Civic Platform server and provided in a response.7.3.2
result.isSuccessbooleanIndicates whether or not the operation on the item is successful. 7.3.2
result.messagestringA text message related to the operation.7.3.2
statusintegerThe record status.7.3.3