HomeGuidesAPI Reference
Log In

Invoice Collection Succeeded (Beta)

Webhook Event posted when an Invoice has been successfully collected.

Request Body Schema

Property nameData typeRequired?Description
typestringyesValue: invoice_collection_succeeded
created_atstring <date-time>yesDate and time this Webhook Event was generated. Given in UTC.
dataobject (Invoice)yesData relevant to this Webhook Event

Invoice

Property nameData typeRequired?Description
idintegeryesUnique id generated by Arc to identify this resource.
client_user_idstringyesYour organization's unique key provided to associate Arc resources with your user.
custom_line_itemsArray of objects (Line Items)yesLine Items provided for this Invoice that will not be remitted to the user's associated Utility.
utility_remittance_line_itemUtility Remittance Line ItemsyesLine Item provided for this invoice that will be remitted to the user's associated Utility.
totalintegeryesMonetary sum of all Line Items. Given in cents.
statusstringyesEnum:
issued,
collecting,
payment_failed,
paid,
void
created_atstring <date-time>yesDate and time at which this resource was created. Given in UTC.
updated_atstring <date-time>yesDate and time at which this resource was most recently updated. Given in UTC.
issued_atstring <date-time>noDate and time this Invoice was issued to the user.
paid_atstring <date-time>noDate and time this Invoice was paid by the user.
payment_scheduled_atstring <date-time>noDate and time the user's default Payment Method will be charged for this Invoice.
payment_transactionsArray of objects (Payment Transactions)yesList of all Payment Transactions for this Invoice.
sandboxedbooleanyesIf true, this resource is in the sandboxed environment. If false, this resource is in the live environment.

CustomLineItem

Property nameData typeRequired?Description
idintegeryesUnique id generated by Arc to identify this resource.
created_atstring <date-time>yesDate and time at which this resource was created. Given in UTC.
updated_atstring <date-time>yesDate and time at which this resource was most recently updated. Given in UTC.
amount_centsintegeryesMonetary amount of this Custom Line Item. Given in cents.
namestringnoName 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.
typestringyesEnum:
debit,
credit

UtilityRemittanceLineItem

Property nameData typeRequired?Description
idintegeryesUnique id generated by Arc to identify this resource.
created_atstring <date-time>yesDate and time at which this resource was created. Given in UTC.
updated_atstring <date-time>yesDate and time at which this resource was most recently updated. Given in UTC.
amount_centsintegeryesMonetary amount that will be remitted to the user's associated Utility. Given in cents.
namestringnoName 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.
typestringyesEnum:
debit
utility_statement_idintegeryesUnique id generated by Arc to identify the Utility Statement associated with this resource.

PaymentTransaction

Property nameData typeRequired?Description
idintegeryesUnique id generated by Arc to identify this resource.
created_atstring <date-time>yesDate and time at which this resource was created. Given in UTC.
updated_atstring <date-time>yesDate and time at which this resource was most recently updated. Given in UTC.
finished_atstringnoDate 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.
statusstringyesEnum:
pending,
failed,
succeeded,
cancelled
amount_centsintegeryesMonetary amount of this Payment Transaction. Given in cents.
payment_method_idintegeryesUnique id generated by Arc to identify the Payment Method associated with this Payment Transaction.

Request sample

Content type: application/json

{
  "type": "invoice_collection_succeeded",
  "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": "paid",
    "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": "succeeded",
        "payment_method_id": 647816
      }
    ],
    "sandboxed": true
  }
}