Invoice Collection Failed (Beta)

Request Body Schema

Property name	Data type	Required?	Description
`type`	string	yes	Value: `invoice_collection_failed`
`created_at`	string <date-time>	yes	Date and time this Webhook Event was generated. Given in UTC.
`data`	object (Invoice)	yes	Data relevant to this Webhook Event.

Invoice

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.
`custom_line_items`	Array of objects (Line Items)	yes	Line Items provided for this Invoice that will not be remitted to the user's associated Utility.
`utility_remittance_line_item`	Utility Remittance Line Items	yes	Line Item provided for this invoice that will be remitted to the user's associated Utility.
`total`	integer	yes	Monetary sum of all Line Items. Given in cents.
`status`	string	yes	Enum: `issued`, `collecting`, `payment_failed`, `paid`, `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.
`issued_at`	string <date-time>	no	Date and time this Invoice was issued to the user.
`paid_at`	string <date-time>	no	Date and time this Invoice was paid by the user.
`payment_scheduled_at`	string <date-time>	no	Date and time the user's default Payment Method will be charged for this Invoice.
`payment_transactions`	Array of objects (Payment Transactions)	yes	List of all Payment Transactions for this Invoice.
`sandboxed`	boolean	yes	If `true`, this resource is in the sandboxed environment. If `false`, this resource is in the live environment.

CustomLineItem

Property name	Data type	Required?	Description
`id`	integer	yes	Unique `id` generated by Arc to identify this resource.
`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.
`amount_cents`	integer	yes	Monetary amount of this Custom Line Item. Given in cents.
`name`	string	no	Name for this Custom Line Item, either provided or generated by Arc. Arc generates names for debit type Custom Line Items when `name` is not provided upon Invoice creation and for all credit type Custom Line Items
`type`	string	yes	Enum: `debit`, `credit`

UtilityRemittanceLineItems

Property name	Data type	Required?	Description
`id`	integer	yes	Unique `id` generated by Arc to identify this resource.
`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.
`amount_cents`	integer	yes	Monetary amount that will be remitted to the user's associated Utility. Given in cents.
`name`	string	no	Name for this Utility Remittance Line Item, either provided or generated by Arc. Arc generates a `name` for a Utility Remittance Line Item when `name` is not provided upon Invoice creation.
`type`	string	yes	Enum: `debit`
`utility_statement_id`	integer	yes	Unique `id` generated by Arc to identify the Utility Statement associated with this resource.

PaymentTransaction

Property name	Data type	Required?	Description
`id`	integer	yes	Unique `id` generated by Arc to identify this resource.
`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.
`finished_at`	string	no	Date and time this Payment Transaction was finalized. Note that a finished Payment Transaction does not mean a Payment Transaction was successful. The `status` field should be used to understand the final state of the Payment Transaction.
`status`	string	yes	Enum: `pending`, `failed`, `succeeded`, `cancelled`
`amount_cents`	integer	yes	Monetary amount of this Payment Transaction. Given in cents.
`payment_method_id`	integer	yes	Unique `id` generated by Arc to identify the Payment Method associated with this Payment Transaction.

Request sample

Content type: application/json

{
  "type": "invoice_collection_failed",
  "created_at": "2022-09-24T14:15:22Z",
  "data": {
    "id": 344,
    "client_user_id": "63cbd339-578c-4f0c-9a56-01093247f355",
    "custom_line_items": [
      {
        "id": 826,
        "created_at": "2022-12-15T11:07:42.000-05:00",
        "updated_at": "2022-12-15T11:07:42.000-05:00",
        "amount_cents": 6235,
        "name": "Supply Charge",
        "type": "debit"
      },
      {
        "id": 828,
        "created_at": "2022-12-15T11:07:42.000-05:00",
        "updated_at": "2022-12-15T11:07:42.000-05:00",
        "amount_cents": -3117,
        "name": "Arc Credit",
        "type": "credit"
      }
    ],
    "utility_remittance_line_item": {
      "id": 827,
      "created_at": "2022-12-15T11:07:42.000-05:00",
      "updated_at": "2022-12-15T11:07:42.000-05:00",
      "amount_cents": 5390,
      "name": "Electric Delivery Charge",
      "type": "debit",
      "utility_statement_id": 18964488
    },
    "total": 8508,
    "status": "payment_failed",
    "created_at": "2022-12-15T11:07:42.000-05:00",
    "updated_at": "2022-12-15T11:12:41.000-05:00",
    "issued_at": "2022-12-15T11:07:42.000-05:00",
    "paid_at": null,
    "payment_scheduled_at": "2022-12-18T11:12:41.000-05:00",
    "payment_transactions": [
      {
        "id": 392,
        "finished_at": "2022-12-15T11:12:40.000-05:00",
        "created_at": "2022-12-15T11:12:39.000-05:00",
        "updated_at": "2022-12-15T11:12:40.000-05:00",
        "amount_cents": 8508,
        "status": "failed",
        "payment_method_id": 647816
      }
    ],
    "sandboxed": true
  }
}