Arcadia · Schema

UtilityRemittanceItem

EnergyUtilitiesClean EnergyBilling DataInterval DataCarbonSolarTariff

Properties

Name	Type	Description
id	number	Unique `id` generated by Arcadia to identify this resource.
utility_statement_id	number	Unique `id` generated by Arcadia to identify the Utility Statement associated with this resource.
client_user_id	string	Your organization's unique key provided to associate Arcadia resources with your user.
amount_cents	integer	Monetary amount of this Utility Remittance Item. Given in cents.
status	string
created_at	string	Date and time at which this resource was created. Given in UTC.
updated_at	string	Date and time at which this resource was most recently updated. Given in UTC.
scheduled_at	string	Date and time this Utility Remittance Item is scheduled to be remitted to the user's associated Utility. Given in UTC.
remitted_at	string	Date and time this Utility Remittance Item was successfully remitted to the user's associated Utility. Given in UTC.
sandboxed	boolean	If `true`, this resource is in the sandboxed environment. If `false`, this resource is in the live environment.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://api.arcadia.com/schemas/UtilityRemittanceItem",
  "title": "UtilityRemittanceItem",
  "required": [
    "id",
    "utility_statement_id",
    "client_user_id",
    "amount_cents",
    "status",
    "created_at",
    "updated_at",
    "scheduled_at",
    "remitted_at",
    "sandboxed"
  ],
  "properties": {
    "id": {
      "description": "Unique `id` generated by Arcadia to identify this resource.",
      "type": "number"
    },
    "utility_statement_id": {
      "description": "Unique `id` generated by Arcadia to identify the Utility Statement associated with this resource.",
      "type": "number"
    },
    "client_user_id": {
      "description": "Your organization's unique key provided to associate Arcadia resources with your user.",
      "type": "string",
      "example": "fff57dc7-3a2b-4395-8a62-e3486d46dabe"
    },
    "amount_cents": {
      "description": "Monetary amount of this Utility Remittance Item. Given in cents.",
      "type": "integer"
    },
    "status": {
      "type": "string",
      "enum": [
        "scheduled",
        "remitted",
        "void"
      ]
    },
    "created_at": {
      "description": "Date and time at which this resource was created. Given in UTC.",
      "type": "string",
      "format": "date-time"
    },
    "updated_at": {
      "description": "Date and time at which this resource was most recently updated. Given in UTC.",
      "type": "string",
      "format": "date-time"
    },
    "scheduled_at": {
      "description": "Date and time this Utility Remittance Item is scheduled to be remitted to the user's associated Utility. Given in UTC.",
      "format": "date-time",
      "type": "string",
      "nullable": true
    },
    "remitted_at": {
      "description": "Date and time this Utility Remittance Item was successfully remitted to the user's associated Utility. Given in UTC.",
      "format": "date-time",
      "type": "string",
      "nullable": true
    },
    "sandboxed": {
      "description": "If `true`, this resource is in the sandboxed environment. If `false`, this resource is in the live environment.",
      "type": "boolean",
      "example": "false"
    }
  },
  "additionalProperties": false
}