Webhook Event posted when a Utility Remittance Item is scheduled for remittance with the associated user's Utility.
Request Body Schema
| Property name | Data type | Required? | Description |
|---|---|---|---|
type | string | yes | Value: utility_remittance_item_scheduled |
created_at | string <date-time> | yes | Date and time this Webhook Event was generated. Given in UTC. |
data | object (UtilityRemittanceItem) | yes | Data relevant to this Webhook Event. |
UtilityRemittanceItem
| Property name | Data type | Required? | Description |
|---|---|---|---|
id | integer | yes | Unique id generated by Arc to identify this resource. |
client_user_id | string | yes | Your organization's unique key provided to associate Arc resources with your user. |
utility_statement_id | integer | yes | Unique id generated by Arc to identify the Utility Statement associated with this resource. |
amount_cents | integer | yes | Monetary amount of this Utility Remittance Item. Given in cents. |
status | string | yes | Enum:scheduled,remitted,void |
created_at | string <date-time> | yes | Date and time at which this resource was created. Given in UTC. |
updated_at | string <date-time> | yes | Date and time at which this resource was most recently updated. Given in UTC. |
scheduled_at | null or string <date-time> | yes | Date and time this Utility Remittance Item is scheduled to be remitted to the user's associated Utility. Given in UTC. |
remitted_at | null or string <date-time> | yes | Date and time this Utility Remittance Item was successfully remitted to the user's associated Utility. Given in UTC. |
sandboxed | boolean | yes | If true, this resource is in the sandboxed environment. If false, this resource is in the live environment. |
Request sample
Content type: application/json
{
"type": "utility_remittance_item_scheduled",
"created_at": "2022-09-30T14:15:22Z",
"data": {
"id": 352,
"client_user_id": 'testing-123',
"utility_statement_id": "17925627",
"amount_cents": 2329,
"status": "scheduled",
"scheduled_at": null,
"created_at": "2022-09-29 16:49:14 UTC",
"updated_at": "2022-09-29 16:49:14 UTC",
"scheduled_at": null,
"remitted_at": null,
"sandboxed": true
}
}