PUT /api/v3/bill/possibleDestinationAccounts

Retrieves destination accounts compatible with moving the specified bills

GetPossibleDestinationAccountsV3 Permissions: MoveExistingBills (Manage)
Use this endpoint before calling PUT /bill/moveBills to discover which accounts have meters matching all commodities represented by the given bills. Returns the list of commodities and matching accounts with their meters.

Request Headers

Header Value Required Description
ECI-ApiKey string Yes Your API key. See Authentication.
Content-Type application/json Yes All requests must specify JSON content type, including the request body.

Request Body

ListIds
Property Description Type
ids Required (defined) integer[]
Example Request Body application/json 
{  "ids": [
    1
  ]
}

Responses

200 OK The request succeeded and the response body contains the requested data.

Response Body Parameters

MoveBillsDestination
Property Description Type
accounts List of valid destination accounts that the selected bills can be moved to, including their available meters. Required (defined) DestinationAccountResponse[]
DestinationAccountResponse properties
Property Description Type
accountCode The account code Required (defined) string
accountId The account identifier Required (defined) integer (int32)
accountInfo The account info Required (defined) string
meters An array of identifiers for meters attached to this account Required (defined) DestinationAccountMeterChild[]
DestinationAccountMeterChild properties
Property Description Type
accountMeterId The AccountMeter identifier Required (defined) integer (int32)
commodity CommodityChild
CommodityChild properties
Property Description Type
commodityCode The commodity code Required (defined) string
commodityIcon Icon
Icon properties
Property Description Type
code The icon code Must be between 0 and 64 characters Required when Color is set string
color The icon color Must be between 0 and 32 characters Required when Code is set string
commodityId The commodity identifier Required (defined) integer (int32)
commodityInfo The commodity info Required (defined) string
meterCode The code of the Meter for this AccountMeter Required (defined) string
meterId The Meter identifier for this AccountMeter Required (defined) integer (int32)
meterInfo The info of the Meter for this AccountMeter Required (defined) string
vendor VendorChild
VendorChild properties
Property Description Type
vendorCode The vendor code string
vendorId The vendor identifier integer (int32)
vendorInfo The vendor info string
commodities List of commodities available for the move operation, used to filter destination accounts by commodity match. Required (defined) CommodityChild[]
CommodityChild properties
Property Description Type
commodityCode The commodity code Required (defined) string
commodityIcon Icon
Icon properties
Property Description Type
code The icon code Must be between 0 and 64 characters Required when Color is set string
color The icon color Must be between 0 and 32 characters Required when Code is set string
commodityId The commodity identifier Required (defined) integer (int32)
commodityInfo The commodity info Required (defined) string
Example Response application/json 
{  "accounts": [
    {    "accountCode": "string",    "accountId": 1,    "accountInfo": "string",    "meters": [
      {      "accountMeterId": 1,      "commodity": {},      "meterCode": "string",      "meterId": 1,      "meterInfo": "string"
    }
    ],    "vendor": {      "vendorCode": "string",      "vendorId": 1,      "vendorInfo": "string"
    }
  }
  ],  "commodities": [
    {    "commodityCode": "string",    "commodityIcon": {      "code": "string",      "color": "string"
    },    "commodityId": 1,    "commodityInfo": "string"
  }
  ]
}
400 Bad Request The request was malformed or contains invalid parameters. Check the request body and query parameters.