Sign in

v1

latestOpenAPI 3.1.02026-07-1342111193.6 KB
Bundle (Beta)

Utility Remittance - Get a Utility Remittance Item.

Returns a single Utility Remittance Item specified by ID.

get/bundle/utility_remittance/utility_remittance_items/{utility_remittance_item_id}

Path parameters

utility_remittance_item_idstring required

Headers

Arcadia-Versionstring required

The Arcadia-Version for the request

Response

Success

idnumber required

Unique id generated by Arcadia to identify this resource.

utility_statement_idnumber required

Unique id generated by Arcadia to identify the Utility Statement associated with this resource.

client_user_idstring required

Your organization's unique key provided to associate Arcadia resources with your user.

amount_centsinteger required

Monetary amount of this Utility Remittance Item. Given in cents.

status'scheduled' | 'remitted' | 'void' required
created_atstring date-time required

Date and time at which this resource was created. Given in UTC.

updated_atstring date-time required

Date and time at which this resource was most recently updated. Given in UTC.

scheduled_atstring date-time nullable required

Date and time this Utility Remittance Item is scheduled to be remitted to the user's associated Utility. Given in UTC.

remitted_atstring date-time nullable required

Date and time this Utility Remittance Item was successfully remitted to the user's associated Utility. Given in UTC.

sandboxedboolean required

If true, this resource is in the sandboxed environment. If false, this resource is in the live environment.

Example response

{
  "client_user_id": "fff57dc7-3a2b-4395-8a62-e3486d46dabe"
}