Sign in

v1

latestOpenAPI 3.1.02026-07-1342111193.6 KB
Bundle (Beta)

Utility Remittance - Create a Utility Remittance Item

Creates and schedules a Utility Remittance Item for a Utility Statement. You can specify a date for remittance using scheduled_at. Note that scheduled_at must be a date in the future. If the date you specify falls on a weekend or a banking holiday, remittance will be scheduled for the next business day. If scheduled_at is omitted, remittance will be scheduled for the next business day. When creating a Utility Remittance Item, you can specify how much to remit for the corresponding Utility Statement by specifying amount_cents. In most cases, this should correspond to the utility_charge on a Utility Statement. If amount_cents is omitted, the Utility Remittance Item will be created using the utility_charge on the specified Utility Statement. At this time, amount_cents cannot exceed 3000000 cents ($30,000). Note that overpaying or underpaying the amount on a Utility Statement comes with risk. This field should be used with caution. Please note that this endpoint is rate limited to 200 requests per 10 seconds. You will receive a 429 error if you exceed this limit. Please wait and try again. The RateLimit-Reset header will indicate when you can make another request.

post/bundle/utility_remittance/utility_statements/{utility_statement_id}/utility_remittance_items

Path parameters

utility_statement_idinteger required

Headers

Arcadia-Versionstring required

The Arcadia-Version for the request

Request body

scheduled_atstring date

You can specify a date for remittance using scheduled_at. Note that scheduled_at must be a date in the future. If the date you specify falls on a weekend or a banking holiday, remittance will be scheduled for the next business day. If scheduled_at is omitted, remittance will be scheduled for the next business day.

amount_centsinteger

You can specify how much to remit for this Utility Statement using amount_cents. In most cases, this should correspond to the utility_charge on a Utility Statement. If amount_cents is omitted, the Utility Remittance Item will be created using the utility_charge on the specified Utility Statement. At this time, amount_cents cannot exceed 3000000 cents ($30,000). Note that overpaying or underpaying the amount on a Utility Statement comes with risk. This field should be used with caution.

Example request

{
  "scheduled_at": "2021-07-28"
}

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"
}