Get Invoices

Returns invoice information for given invoice id's.

Resource Information

Scope invoices
App Type Agency
Authorization Type Access token
URI /v4/invoices/{invoiceIds}?fields={fields}&lang={lang}
HTTP Method GET
Automation Version(s) 9.0.0

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. 9.0.0
invoiceIds string No   One or more invoice IDs, separated by a comma 9.0.0
lang String No   Indicates the language applied. 9.0.0

Response Information

Field Type Description Automation Version
result[] result{} Contains invoice information. 9.0.0
result.amount double The invoice fee amount. 9.0.0
result.auditStatus string The audit status of the invoice fee item. 9.0.0
result.balance double The amount due. 9.0.0
result.dueDate dateTime The invoice due date. 9.0.0
result.fees[] result.fees{} Contains the invoice fees. 9.0.0
result.fees.acaRequiredFlag string Indicates whether or not the fee schedule is required in order to make it accessible to citizens. 9.0.0
result.fees.accountCode1 string The code associated with the first fee 9.0.0
result.fees.accountCode1Allocation double Allocation proportion or amount of account code 1. 9.0.0
result.fees.accountCode2 string The code associated with the second fee 9.0.0
result.fees.accountCode2Allocation double Allocation proportion or amount of account code 2. 9.0.0
result.fees.accountCode3 string The code associated with the third fee 9.0.0
result.fees.accountCode3Allocation double Allocation proportion or amount of account code 3. 9.0.0
result.fees.allocatedFee1 double The allocated fee for account code 1. 9.0.0
result.fees.allocatedFee2 double The allocated fee for account code 2. 9.0.0
result.fees.allocatedFee3 double The allocated fee for account code 3. 9.0.0
result.fees.amount double The amount of a payment transaction or account balance. 9.0.0
result.fees.applyDate dateTime The date the fee is applied. 9.0.0
result.fees.autoAssessFlag string Indicates whether or not the fee item is automatically assessed. 9.0.0
result.fees.autoInvoiceFlag string Indicates whether or not the fee item is automatically invoiced. 9.0.0
result.fees.balanceDue double The amount due. 9.0.0
result.fees.calcFlag string Indicates whether or not the fee amount is based on fee calculation. 9.0.0
result.fees.calculatedFlag string Indicates whether or not the fee amount is based on fee calculation. 9.0.0
result.fees.code result.fees.code{} A code identifying an associated item 9.0.0
result.fees.code.text string The localized display text. 9.0.0
result.fees.code.value string The value for the specified parameter. 9.0.0
result.fees.description result.fees.description{} The description of the record or item. 9.0.0
result.fees.description.text string The localized display text. 9.0.0
result.fees.description.value string The value for the specified parameter. 9.0.0
result.fees.displayOrder long The order of the item in comparison to the other items. 9.0.0
result.fees.effectDate dateTime Fee item effective date. 9.0.0
result.fees.expireDate dateTime The date when the item expires 9.0.0
result.fees.feeAllocationType string The fee allocation type to each account code. 9.0.0
result.fees.feeNotes string Notes about the fee. 9.0.0
result.fees.id long The unique identifier for the object, assigned by the Civic Platform server. 9.0.0
result.fees.invoiceId long The invoice ID for the fee item. 9.0.0
result.fees.maxFee double The maximum fee item. 9.0.0
result.fees.minFee double The minimum fee item. 9.0.0
result.fees.paymentPeriod result.fees.paymentPeriod{} The time interval for processing invoices. 9.0.0
result.fees.paymentPeriod.text string The localized display text. 9.0.0
result.fees.paymentPeriod.value string The value for the specified parameter. 9.0.0
result.fees.priority long The priority level assigned to the fee item. 9.0.0
result.fees.quantity double The number of units for which the same fee applies. 9.0.0
result.fees.recordId result.fees.recordId{} The unique ID associated with a record. 9.0.0
result.fees.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. 9.0.0
result.fees.recordId.id string The unique identifier for the object, assigned by the Civic Platform server and provided in a response. 9.0.0
result.fees.recordId.serviceProviderCode string The unique agency identifier, the system assigns, on the Accela Civic Platform. 9.0.0
result.fees.recordId.trackingId long The application tracking number (IVR tracking number). 9.0.0
result.fees.recordId.value string The value for the specified parameter. 9.0.0
result.fees.schedule result.fees.schedule{} Contains parameters that define the fee schedule. 9.0.0
result.fees.schedule.text string The localized display text. 9.0.0
result.fees.schedule.value string The value for the specified parameter. 9.0.0
result.fees.status string The fee item status. 9.0.0
result.fees.subGroup result.fees.subGroup{} A grouping of fee items to which the system can ascribe a value. 9.0.0
result.fees.subGroup.text string The localized display text. 9.0.0
result.fees.subGroup.value string The value for the specified parameter. 9.0.0
result.fees.udf1 string User defined field 1 9.0.0
result.fees.udf2 string User defined field 2 9.0.0
result.fees.udf3 string User defined field 3 9.0.0
result.fees.unit result.fees.unit{} The unit of measure used for the object. For fees, this might be square feet, for example. 9.0.0
result.fees.unit.text string The localized display text. 9.0.0
result.fees.unit.value string The value for the specified parameter. 9.0.0
result.fees.variable string The variable associated with the fee item. 9.0.0
result.fees.version result.fees.version{} A unique name or number sequence used to identify the version. 9.0.0
result.fees.version.text string The localized display text. 9.0.0
result.fees.version.value string The value for the specified parameter. 9.0.0
result.id long The unique identifier of the invoice. 9.0.0
result.invBatchDate dateTime The invoice batch date. 9.0.0
result.invComment string A comment related to the invoice. 9.0.0
result.invoiceDate dateTime The invoice date. 9.0.0
result.invoiceNumber string The invoice number string. 9.0.0
result.recordId result.recordId{} The record the invoice applies to. 9.0.0
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. 9.0.0
result.recordId.id string The unique identifier for the object, assigned by the Civic Platform server and provided in a response. 9.0.0
result.recordId.serviceProviderCode string The unique agency identifier, the system assigns, on the Accela Civic Platform. 9.0.0
result.recordId.trackingId long The application tracking number (IVR tracking number). 9.0.0
result.recordId.value string The value for the specified parameter. 9.0.0
result.serviceProviderCode string The agency code. 9.0.0
result.udf1 string Invoice user defined field 1. 9.0.0
result.udf2 string Invoice user defined field 2. 9.0.0
result.udf3 string Invoice user defined field 3. 9.0.0
result.udf4 string Invoice user defined field 4. 9.0.0
status integer The request status. 9.0.0