Jump to

• Request
• Response

Search Person Accounts

post

https://server:port/spl/rest/apis/customer/v-model/billingContext/searchPersonAccounts

This operation lists accounts associated with a specific person record. It supports various filter options, pagination and an optional textual search across the account's identifier, the account's name if any, and premise address.

Request

There are no request parameters for this operation.

Supported Media Types

• application/xml
• application/json

Request Body - application/xml ()

Root Schema : schema

Type: object

Show Source

• filters: array filters
• limit: number
  Minimum Value: 0

  Maximum Value: 9.99999999999999E8

  Limit

  Example: 25
• offset: number
  Minimum Value: 0

  Maximum Value: 9.99999999999999E8

  Offset

  Example: 0
• personId: string
  Maximum Length: 10

  Person ID is the system-assigned number for other persons related to the account.

  Example: 4429925678
• queryOption: string
  Allowed Values: [ "C1BS", "C1LS", "C1US" ]

  The service may be used to implement a basic list of accounts with minimal filtering options or a more advanced query that supports a textual search and includes either billing or usage details. * `C1BS` - Billing Search, * `C1LS` - List, * `C1US` - Usage Search
• serviceType: string
  Maximum Length: 80

  Service Type defines the type of service associated with the SA type.

  Example: E

{
    "type":"object",
    "properties":{
        "personId":{
            "type":"string",
            "maxLength":10,
            "description":"Person ID is the system-assigned number for other persons related to the account.",
            "example":"4429925678"
        },
        "filters":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "mainCustomer":{
                        "type":"string",
                        "enum":[
                            "N   ",
                            "Y   "
                        ],
                        "description":"Main Customer flag is used to restrict the list to accounts where the person in context is the main customer.\n* `N   ` - No,\n* `Y   ` - Yes",
                        "example":"Y"
                    },
                    "active":{
                        "type":"string",
                        "enum":[
                            "N   ",
                            "Y   "
                        ],
                        "description":"Use this to restrict the list to accounts to those with an active service.\n* `N   ` - No,\n* `Y   ` - Yes"
                    },
                    "searchText":{
                        "type":"string",
                        "maxLength":200,
                        "description":"Search Text"
                    }
                }
            }
        },
        "queryOption":{
            "type":"string",
            "enum":[
                "C1BS",
                "C1LS",
                "C1US"
            ],
            "description":"The service may be used to implement a basic list of accounts with minimal filtering options or a more advanced query that supports a textual search and includes either billing or usage details.\n* `C1BS` - Billing Search,\n* `C1LS` - List,\n* `C1US` - Usage Search"
        },
        "serviceType":{
            "type":"string",
            "maxLength":80,
            "description":"Service Type defines the type of service associated with the SA type.",
            "example":"E"
        },
        "limit":{
            "type":"number",
            "maximum":9.99999999999999E8,
            "minimum":0,
            "description":"Limit",
            "example":"25"
        },
        "offset":{
            "type":"number",
            "maximum":9.99999999999999E8,
            "minimum":0,
            "description":"Offset",
            "example":"0"
        }
    },
    "xml":{
        "name":"C1ActForPers"
    }
}

Nested Schema : filters

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "mainCustomer":{
                "type":"string",
                "enum":[
                    "N   ",
                    "Y   "
                ],
                "description":"Main Customer flag is used to restrict the list to accounts where the person in context is the main customer.\n* `N   ` - No,\n* `Y   ` - Yes",
                "example":"Y"
            },
            "active":{
                "type":"string",
                "enum":[
                    "N   ",
                    "Y   "
                ],
                "description":"Use this to restrict the list to accounts to those with an active service.\n* `N   ` - No,\n* `Y   ` - Yes"
            },
            "searchText":{
                "type":"string",
                "maxLength":200,
                "description":"Search Text"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• active: string
  Allowed Values: [ "N ", "Y " ]

  Use this to restrict the list to accounts to those with an active service. * `N ` - No, * `Y ` - Yes
• mainCustomer: string
  Allowed Values: [ "N ", "Y " ]

  Main Customer flag is used to restrict the list to accounts where the person in context is the main customer. * `N ` - No, * `Y ` - Yes

  Example: Y
• searchText: string
  Maximum Length: 200

  Search Text

{
    "type":"object",
    "properties":{
        "mainCustomer":{
            "type":"string",
            "enum":[
                "N   ",
                "Y   "
            ],
            "description":"Main Customer flag is used to restrict the list to accounts where the person in context is the main customer.\n* `N   ` - No,\n* `Y   ` - Yes",
            "example":"Y"
        },
        "active":{
            "type":"string",
            "enum":[
                "N   ",
                "Y   "
            ],
            "description":"Use this to restrict the list to accounts to those with an active service.\n* `N   ` - No,\n* `Y   ` - Yes"
        },
        "searchText":{
            "type":"string",
            "maxLength":200,
            "description":"Search Text"
        }
    }
}

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• filters: array filters
• limit: number
  Minimum Value: 0

  Maximum Value: 9.99999999999999E8

  Limit

  Example: 25
• offset: number
  Minimum Value: 0

  Maximum Value: 9.99999999999999E8

  Offset

  Example: 0
• personId: string
  Maximum Length: 10

  Person ID is the system-assigned number for other persons related to the account.

  Example: 4429925678
• queryOption: string
  Allowed Values: [ "C1BS", "C1LS", "C1US" ]

  The service may be used to implement a basic list of accounts with minimal filtering options or a more advanced query that supports a textual search and includes either billing or usage details. * `C1BS` - Billing Search, * `C1LS` - List, * `C1US` - Usage Search
• serviceType: string
  Maximum Length: 80

  Service Type defines the type of service associated with the SA type.

  Example: E

{
    "type":"object",
    "properties":{
        "personId":{
            "type":"string",
            "maxLength":10,
            "description":"Person ID is the system-assigned number for other persons related to the account.",
            "example":"4429925678"
        },
        "filters":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "mainCustomer":{
                        "type":"string",
                        "enum":[
                            "N   ",
                            "Y   "
                        ],
                        "description":"Main Customer flag is used to restrict the list to accounts where the person in context is the main customer.\n* `N   ` - No,\n* `Y   ` - Yes",
                        "example":"Y"
                    },
                    "active":{
                        "type":"string",
                        "enum":[
                            "N   ",
                            "Y   "
                        ],
                        "description":"Use this to restrict the list to accounts to those with an active service.\n* `N   ` - No,\n* `Y   ` - Yes"
                    },
                    "searchText":{
                        "type":"string",
                        "maxLength":200,
                        "description":"Search Text"
                    }
                }
            }
        },
        "queryOption":{
            "type":"string",
            "enum":[
                "C1BS",
                "C1LS",
                "C1US"
            ],
            "description":"The service may be used to implement a basic list of accounts with minimal filtering options or a more advanced query that supports a textual search and includes either billing or usage details.\n* `C1BS` - Billing Search,\n* `C1LS` - List,\n* `C1US` - Usage Search"
        },
        "serviceType":{
            "type":"string",
            "maxLength":80,
            "description":"Service Type defines the type of service associated with the SA type.",
            "example":"E"
        },
        "limit":{
            "type":"number",
            "maximum":9.99999999999999E8,
            "minimum":0,
            "description":"Limit",
            "example":"25"
        },
        "offset":{
            "type":"number",
            "maximum":9.99999999999999E8,
            "minimum":0,
            "description":"Offset",
            "example":"0"
        }
    },
    "xml":{
        "name":"C1ActForPers"
    }
}

Nested Schema : filters

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "mainCustomer":{
                "type":"string",
                "enum":[
                    "N   ",
                    "Y   "
                ],
                "description":"Main Customer flag is used to restrict the list to accounts where the person in context is the main customer.\n* `N   ` - No,\n* `Y   ` - Yes",
                "example":"Y"
            },
            "active":{
                "type":"string",
                "enum":[
                    "N   ",
                    "Y   "
                ],
                "description":"Use this to restrict the list to accounts to those with an active service.\n* `N   ` - No,\n* `Y   ` - Yes"
            },
            "searchText":{
                "type":"string",
                "maxLength":200,
                "description":"Search Text"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• active: string
  Allowed Values: [ "N ", "Y " ]

  Use this to restrict the list to accounts to those with an active service. * `N ` - No, * `Y ` - Yes
• mainCustomer: string
  Allowed Values: [ "N ", "Y " ]

  Main Customer flag is used to restrict the list to accounts where the person in context is the main customer. * `N ` - No, * `Y ` - Yes

  Example: Y
• searchText: string
  Maximum Length: 200

  Search Text

{
    "type":"object",
    "properties":{
        "mainCustomer":{
            "type":"string",
            "enum":[
                "N   ",
                "Y   "
            ],
            "description":"Main Customer flag is used to restrict the list to accounts where the person in context is the main customer.\n* `N   ` - No,\n* `Y   ` - Yes",
            "example":"Y"
        },
        "active":{
            "type":"string",
            "enum":[
                "N   ",
                "Y   "
            ],
            "description":"Use this to restrict the list to accounts to those with an active service.\n* `N   ` - No,\n* `Y   ` - Yes"
        },
        "searchText":{
            "type":"string",
            "maxLength":200,
            "description":"Search Text"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

Success response

Body ()

Root Schema : C1ActForPers

Type: object

Show Source

• accounts: array accounts
  The list of accounts for the person in context.
• limit: number
  Minimum Value: 0

  Maximum Value: 9.99999999999999E8

  Limit

  Example: 25
• offset: number
  Minimum Value: 0

  Maximum Value: 9.99999999999999E8

  Offset

  Example: 0
• totalNumberOfRecords: number
  Minimum Value: 0

  Maximum Value: 99999

  Total Number Of Records

  Example: 2

{
    "type":"object",
    "properties":{
        "limit":{
            "type":"number",
            "maximum":9.99999999999999E8,
            "minimum":0,
            "description":"Limit",
            "example":"25"
        },
        "offset":{
            "type":"number",
            "maximum":9.99999999999999E8,
            "minimum":0,
            "description":"Offset",
            "example":"0"
        },
        "totalNumberOfRecords":{
            "type":"number",
            "maximum":99999,
            "minimum":0,
            "description":"Total Number Of Records",
            "example":"2"
        },
        "accounts":{
            "type":"array",
            "description":"The list of accounts for the person in context.",
            "items":{
                "type":"object",
                "properties":{
                    "account":{
                        "type":"object",
                        "properties":{
                            "accountId":{
                                "type":"string",
                                "maxLength":10,
                                "description":"The Account ID is a system-assigned random number that stays with an account for life.",
                                "example":"0279948222"
                            },
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            }
                        }
                    },
                    "accountName":{
                        "type":"string",
                        "maxLength":254,
                        "description":"The name of the account. \n<p>\nNote: This information is optional and assumed to be captured as a characteristic record for the account. The characteristic type used for this purpose needs to be defined as a schema constant."
                    },
                    "setupDate":{
                        "type":"string",
                        "format":"date",
                        "description":"The date the billing account was created.  (Service often begins on that date, but doesn't have to)."
                    },
                    "isActive":{
                        "type":"boolean",
                        "description":"Indicates whether the account is active or not.",
                        "example":"true"
                    },
                    "accountPersonRelationshipType":{
                        "type":"string",
                        "maxLength":8,
                        "description":"Account Relationship Type"
                    },
                    "accountPersonRelationshipTypeDescription":{
                        "type":"string",
                        "maxLength":1,
                        "description":"Display string for relationship the input person has with the Billing Account.",
                        "example":"Main customer"
                    },
                    "mainCustomerName":{
                        "type":"string",
                        "maxLength":254,
                        "description":"Name"
                    },
                    "premiseDetails":{
                        "type":"object",
                        "description":"The premise used for display purposes. When multiple premises are associated with the account, the mailing premise is used.",
                        "properties":{
                            "premiseId":{
                                "type":"string",
                                "maxLength":10,
                                "description":"Premise ID is a system-assigned, unique identifier that shows the primary premise associated with the service agreement."
                            },
                            "premiseAddress1":{
                                "type":"string",
                                "maxLength":254,
                                "description":"Address"
                            },
                            "premiseFormattedAddress":{
                                "type":"string",
                                "maxLength":254,
                                "description":"Premise Info",
                                "example":"129 Sutter St, San Francisco, CA, 94104"
                            },
                            "numberOfPremises":{
                                "type":"number",
                                "maximum":99999,
                                "minimum":0,
                                "description":"Number of Premises related to the billing account",
                                "example":"2"
                            }
                        }
                    },
                    "serviceDetails":{
                        "type":"object",
                        "description":"The types of services associated with the account.",
                        "properties":{
                            "serviceTypes":{
                                "type":"array",
                                "items":{
                                    "type":"object",
                                    "properties":{
                                        "serviceType":{
                                            "type":"string",
                                            "maxLength":80,
                                            "description":"Service Type defines the type of service associated with the SA type.",
                                            "example":"E"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "billingDetails":{
                        "type":"object",
                        "description":"Billing information for the account. These details are only supported in billing search query mode.",
                        "properties":{
                            "annualBilledAmount":{
                                "type":"number",
                                "description":"Sum billed over time period (12 months if available)",
                                "example":"200"
                            },
                            "billingStartDate":{
                                "type":"string",
                                "format":"date",
                                "description":"Billing Start Date",
                                "example":"2021-09-01"
                            },
                            "billingEndDate":{
                                "type":"string",
                                "format":"date",
                                "description":"Billing End Date",
                                "example":"2021-09-01"
                            },
                            "currentBalance":{
                                "type":"number",
                                "description":"The current amount owed by the customer on the billing account (calculated value)",
                                "example":"-252.2"
                            },
                            "totalBalance":{
                                "type":"number",
                                "description":"The amount the customer would need to pay to fully close the account (taking into consideration any deposits, budget billing, loans, etc.)",
                                "example":"361.64"
                            },
                            "currency":{
                                "type":"string",
                                "maxLength":3,
                                "description":"Currency Code defines the currency in which the account's financial transactions are expressed.",
                                "example":"USD"
                            }
                        }
                    },
                    "usageDetails":{
                        "type":"object",
                        "description":"Billed usage information for the account. These details are only supported in usage search query mode.",
                        "properties":{
                            "usageFound":{
                                "type":"boolean",
                                "description":"The Usage found flag indicates that usage data was available in the requested timeframe.",
                                "example":"Y"
                            },
                            "firstBillDate":{
                                "type":"string",
                                "format":"date",
                                "description":"The start date of the earliest bill associated with the reported usage for the account in the past 12 months."
                            },
                            "lastBillDate":{
                                "type":"string",
                                "format":"date",
                                "description":"The end date of the latest bill associated with the reported usage for the account in the past 12 months."
                            },
                            "usageInformation":{
                                "type":"array",
                                "items":{
                                    "type":"object",
                                    "properties":{
                                        "unitOfMeasure":{
                                            "type":"string",
                                            "maxLength":30,
                                            "description":"Unit of Measure"
                                        },
                                        "peakIndicator":{
                                            "type":"string",
                                            "maxLength":1,
                                            "description":"Measures Peak Quantity"
                                        },
                                        "usage":{
                                            "type":"array",
                                            "items":{
                                                "type":"object",
                                                "properties":{
                                                    "usageIdentifier":{
                                                        "type":"string",
                                                        "maxLength":100,
                                                        "description":"Usage Identifier"
                                                    },
                                                    "usageValue":{
                                                        "type":"number",
                                                        "maximum":9999.999999,
                                                        "minimum":0,
                                                        "description":"Usage"
                                                    },
                                                    "timeOfUse":{
                                                        "type":"string",
                                                        "maxLength":30,
                                                        "description":"Time of Use"
                                                    },
                                                    "serviceQuantityIdentifer":{
                                                        "type":"string",
                                                        "maxLength":30,
                                                        "description":"SQI"
                                                    }
                                                }
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    },
    "xml":{
        "name":"C1ActForPers"
    }
}

Nested Schema : accounts

Type: array

The list of accounts for the person in context.

Show Source

• Array of: object items

{
    "type":"array",
    "description":"The list of accounts for the person in context.",
    "items":{
        "type":"object",
        "properties":{
            "account":{
                "type":"object",
                "properties":{
                    "accountId":{
                        "type":"string",
                        "maxLength":10,
                        "description":"The Account ID is a system-assigned random number that stays with an account for life.",
                        "example":"0279948222"
                    },
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    }
                }
            },
            "accountName":{
                "type":"string",
                "maxLength":254,
                "description":"The name of the account. \n<p>\nNote: This information is optional and assumed to be captured as a characteristic record for the account. The characteristic type used for this purpose needs to be defined as a schema constant."
            },
            "setupDate":{
                "type":"string",
                "format":"date",
                "description":"The date the billing account was created.  (Service often begins on that date, but doesn't have to)."
            },
            "isActive":{
                "type":"boolean",
                "description":"Indicates whether the account is active or not.",
                "example":"true"
            },
            "accountPersonRelationshipType":{
                "type":"string",
                "maxLength":8,
                "description":"Account Relationship Type"
            },
            "accountPersonRelationshipTypeDescription":{
                "type":"string",
                "maxLength":1,
                "description":"Display string for relationship the input person has with the Billing Account.",
                "example":"Main customer"
            },
            "mainCustomerName":{
                "type":"string",
                "maxLength":254,
                "description":"Name"
            },
            "premiseDetails":{
                "type":"object",
                "description":"The premise used for display purposes. When multiple premises are associated with the account, the mailing premise is used.",
                "properties":{
                    "premiseId":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Premise ID is a system-assigned, unique identifier that shows the primary premise associated with the service agreement."
                    },
                    "premiseAddress1":{
                        "type":"string",
                        "maxLength":254,
                        "description":"Address"
                    },
                    "premiseFormattedAddress":{
                        "type":"string",
                        "maxLength":254,
                        "description":"Premise Info",
                        "example":"129 Sutter St, San Francisco, CA, 94104"
                    },
                    "numberOfPremises":{
                        "type":"number",
                        "maximum":99999,
                        "minimum":0,
                        "description":"Number of Premises related to the billing account",
                        "example":"2"
                    }
                }
            },
            "serviceDetails":{
                "type":"object",
                "description":"The types of services associated with the account.",
                "properties":{
                    "serviceTypes":{
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "serviceType":{
                                    "type":"string",
                                    "maxLength":80,
                                    "description":"Service Type defines the type of service associated with the SA type.",
                                    "example":"E"
                                }
                            }
                        }
                    }
                }
            },
            "billingDetails":{
                "type":"object",
                "description":"Billing information for the account. These details are only supported in billing search query mode.",
                "properties":{
                    "annualBilledAmount":{
                        "type":"number",
                        "description":"Sum billed over time period (12 months if available)",
                        "example":"200"
                    },
                    "billingStartDate":{
                        "type":"string",
                        "format":"date",
                        "description":"Billing Start Date",
                        "example":"2021-09-01"
                    },
                    "billingEndDate":{
                        "type":"string",
                        "format":"date",
                        "description":"Billing End Date",
                        "example":"2021-09-01"
                    },
                    "currentBalance":{
                        "type":"number",
                        "description":"The current amount owed by the customer on the billing account (calculated value)",
                        "example":"-252.2"
                    },
                    "totalBalance":{
                        "type":"number",
                        "description":"The amount the customer would need to pay to fully close the account (taking into consideration any deposits, budget billing, loans, etc.)",
                        "example":"361.64"
                    },
                    "currency":{
                        "type":"string",
                        "maxLength":3,
                        "description":"Currency Code defines the currency in which the account's financial transactions are expressed.",
                        "example":"USD"
                    }
                }
            },
            "usageDetails":{
                "type":"object",
                "description":"Billed usage information for the account. These details are only supported in usage search query mode.",
                "properties":{
                    "usageFound":{
                        "type":"boolean",
                        "description":"The Usage found flag indicates that usage data was available in the requested timeframe.",
                        "example":"Y"
                    },
                    "firstBillDate":{
                        "type":"string",
                        "format":"date",
                        "description":"The start date of the earliest bill associated with the reported usage for the account in the past 12 months."
                    },
                    "lastBillDate":{
                        "type":"string",
                        "format":"date",
                        "description":"The end date of the latest bill associated with the reported usage for the account in the past 12 months."
                    },
                    "usageInformation":{
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "unitOfMeasure":{
                                    "type":"string",
                                    "maxLength":30,
                                    "description":"Unit of Measure"
                                },
                                "peakIndicator":{
                                    "type":"string",
                                    "maxLength":1,
                                    "description":"Measures Peak Quantity"
                                },
                                "usage":{
                                    "type":"array",
                                    "items":{
                                        "type":"object",
                                        "properties":{
                                            "usageIdentifier":{
                                                "type":"string",
                                                "maxLength":100,
                                                "description":"Usage Identifier"
                                            },
                                            "usageValue":{
                                                "type":"number",
                                                "maximum":9999.999999,
                                                "minimum":0,
                                                "description":"Usage"
                                            },
                                            "timeOfUse":{
                                                "type":"string",
                                                "maxLength":30,
                                                "description":"Time of Use"
                                            },
                                            "serviceQuantityIdentifer":{
                                                "type":"string",
                                                "maxLength":30,
                                                "description":"SQI"
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• account: object account
• accountName: string
  Maximum Length: 254

  The name of the account.

  Note: This information is optional and assumed to be captured as a characteristic record for the account. The characteristic type used for this purpose needs to be defined as a schema constant.

• accountPersonRelationshipType: string
  Maximum Length: 8

  Account Relationship Type
• accountPersonRelationshipTypeDescription: string
  Maximum Length: 1

  Display string for relationship the input person has with the Billing Account.

  Example: Main customer
• billingDetails: object billingDetails
  Billing information for the account. These details are only supported in billing search query mode.
• isActive: boolean
  Indicates whether the account is active or not.

  Example: true
• mainCustomerName: string
  Maximum Length: 254

  Name
• premiseDetails: object premiseDetails
  The premise used for display purposes. When multiple premises are associated with the account, the mailing premise is used.
• serviceDetails: object serviceDetails
  The types of services associated with the account.
• setupDate: string (date)
  The date the billing account was created. (Service often begins on that date, but doesn't have to).
• usageDetails: object usageDetails
  Billed usage information for the account. These details are only supported in usage search query mode.

{
    "type":"object",
    "properties":{
        "account":{
            "type":"object",
            "properties":{
                "accountId":{
                    "type":"string",
                    "maxLength":10,
                    "description":"The Account ID is a system-assigned random number that stays with an account for life.",
                    "example":"0279948222"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "accountName":{
            "type":"string",
            "maxLength":254,
            "description":"The name of the account. \n<p>\nNote: This information is optional and assumed to be captured as a characteristic record for the account. The characteristic type used for this purpose needs to be defined as a schema constant."
        },
        "setupDate":{
            "type":"string",
            "format":"date",
            "description":"The date the billing account was created.  (Service often begins on that date, but doesn't have to)."
        },
        "isActive":{
            "type":"boolean",
            "description":"Indicates whether the account is active or not.",
            "example":"true"
        },
        "accountPersonRelationshipType":{
            "type":"string",
            "maxLength":8,
            "description":"Account Relationship Type"
        },
        "accountPersonRelationshipTypeDescription":{
            "type":"string",
            "maxLength":1,
            "description":"Display string for relationship the input person has with the Billing Account.",
            "example":"Main customer"
        },
        "mainCustomerName":{
            "type":"string",
            "maxLength":254,
            "description":"Name"
        },
        "premiseDetails":{
            "type":"object",
            "description":"The premise used for display purposes. When multiple premises are associated with the account, the mailing premise is used.",
            "properties":{
                "premiseId":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Premise ID is a system-assigned, unique identifier that shows the primary premise associated with the service agreement."
                },
                "premiseAddress1":{
                    "type":"string",
                    "maxLength":254,
                    "description":"Address"
                },
                "premiseFormattedAddress":{
                    "type":"string",
                    "maxLength":254,
                    "description":"Premise Info",
                    "example":"129 Sutter St, San Francisco, CA, 94104"
                },
                "numberOfPremises":{
                    "type":"number",
                    "maximum":99999,
                    "minimum":0,
                    "description":"Number of Premises related to the billing account",
                    "example":"2"
                }
            }
        },
        "serviceDetails":{
            "type":"object",
            "description":"The types of services associated with the account.",
            "properties":{
                "serviceTypes":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "serviceType":{
                                "type":"string",
                                "maxLength":80,
                                "description":"Service Type defines the type of service associated with the SA type.",
                                "example":"E"
                            }
                        }
                    }
                }
            }
        },
        "billingDetails":{
            "type":"object",
            "description":"Billing information for the account. These details are only supported in billing search query mode.",
            "properties":{
                "annualBilledAmount":{
                    "type":"number",
                    "description":"Sum billed over time period (12 months if available)",
                    "example":"200"
                },
                "billingStartDate":{
                    "type":"string",
                    "format":"date",
                    "description":"Billing Start Date",
                    "example":"2021-09-01"
                },
                "billingEndDate":{
                    "type":"string",
                    "format":"date",
                    "description":"Billing End Date",
                    "example":"2021-09-01"
                },
                "currentBalance":{
                    "type":"number",
                    "description":"The current amount owed by the customer on the billing account (calculated value)",
                    "example":"-252.2"
                },
                "totalBalance":{
                    "type":"number",
                    "description":"The amount the customer would need to pay to fully close the account (taking into consideration any deposits, budget billing, loans, etc.)",
                    "example":"361.64"
                },
                "currency":{
                    "type":"string",
                    "maxLength":3,
                    "description":"Currency Code defines the currency in which the account's financial transactions are expressed.",
                    "example":"USD"
                }
            }
        },
        "usageDetails":{
            "type":"object",
            "description":"Billed usage information for the account. These details are only supported in usage search query mode.",
            "properties":{
                "usageFound":{
                    "type":"boolean",
                    "description":"The Usage found flag indicates that usage data was available in the requested timeframe.",
                    "example":"Y"
                },
                "firstBillDate":{
                    "type":"string",
                    "format":"date",
                    "description":"The start date of the earliest bill associated with the reported usage for the account in the past 12 months."
                },
                "lastBillDate":{
                    "type":"string",
                    "format":"date",
                    "description":"The end date of the latest bill associated with the reported usage for the account in the past 12 months."
                },
                "usageInformation":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "unitOfMeasure":{
                                "type":"string",
                                "maxLength":30,
                                "description":"Unit of Measure"
                            },
                            "peakIndicator":{
                                "type":"string",
                                "maxLength":1,
                                "description":"Measures Peak Quantity"
                            },
                            "usage":{
                                "type":"array",
                                "items":{
                                    "type":"object",
                                    "properties":{
                                        "usageIdentifier":{
                                            "type":"string",
                                            "maxLength":100,
                                            "description":"Usage Identifier"
                                        },
                                        "usageValue":{
                                            "type":"number",
                                            "maximum":9999.999999,
                                            "minimum":0,
                                            "description":"Usage"
                                        },
                                        "timeOfUse":{
                                            "type":"string",
                                            "maxLength":30,
                                            "description":"Time of Use"
                                        },
                                        "serviceQuantityIdentifer":{
                                            "type":"string",
                                            "maxLength":30,
                                            "description":"SQI"
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : account

Type: object

Show Source

• _link: string
  _link
• accountId: string
  Maximum Length: 10

  The Account ID is a system-assigned random number that stays with an account for life.

  Example: 0279948222

{
    "type":"object",
    "properties":{
        "accountId":{
            "type":"string",
            "maxLength":10,
            "description":"The Account ID is a system-assigned random number that stays with an account for life.",
            "example":"0279948222"
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : billingDetails

Type: object

Billing information for the account. These details are only supported in billing search query mode.

Show Source

• annualBilledAmount: number
  Sum billed over time period (12 months if available)

  Example: 200
• billingEndDate: string (date)
  Billing End Date

  Example: 2021-09-01
• billingStartDate: string (date)
  Billing Start Date

  Example: 2021-09-01
• currency: string
  Maximum Length: 3

  Currency Code defines the currency in which the account's financial transactions are expressed.

  Example: USD
• currentBalance: number
  The current amount owed by the customer on the billing account (calculated value)

  Example: -252.2
• totalBalance: number
  The amount the customer would need to pay to fully close the account (taking into consideration any deposits, budget billing, loans, etc.)

  Example: 361.64

{
    "type":"object",
    "description":"Billing information for the account. These details are only supported in billing search query mode.",
    "properties":{
        "annualBilledAmount":{
            "type":"number",
            "description":"Sum billed over time period (12 months if available)",
            "example":"200"
        },
        "billingStartDate":{
            "type":"string",
            "format":"date",
            "description":"Billing Start Date",
            "example":"2021-09-01"
        },
        "billingEndDate":{
            "type":"string",
            "format":"date",
            "description":"Billing End Date",
            "example":"2021-09-01"
        },
        "currentBalance":{
            "type":"number",
            "description":"The current amount owed by the customer on the billing account (calculated value)",
            "example":"-252.2"
        },
        "totalBalance":{
            "type":"number",
            "description":"The amount the customer would need to pay to fully close the account (taking into consideration any deposits, budget billing, loans, etc.)",
            "example":"361.64"
        },
        "currency":{
            "type":"string",
            "maxLength":3,
            "description":"Currency Code defines the currency in which the account's financial transactions are expressed.",
            "example":"USD"
        }
    }
}

Nested Schema : premiseDetails

Type: object

The premise used for display purposes. When multiple premises are associated with the account, the mailing premise is used.

Show Source

• numberOfPremises: number
  Minimum Value: 0

  Maximum Value: 99999

  Number of Premises related to the billing account

  Example: 2
• premiseAddress1: string
  Maximum Length: 254

  Address
• premiseFormattedAddress: string
  Maximum Length: 254

  Premise Info

  Example: 129 Sutter St, San Francisco, CA, 94104
• premiseId: string
  Maximum Length: 10

  Premise ID is a system-assigned, unique identifier that shows the primary premise associated with the service agreement.

{
    "type":"object",
    "description":"The premise used for display purposes. When multiple premises are associated with the account, the mailing premise is used.",
    "properties":{
        "premiseId":{
            "type":"string",
            "maxLength":10,
            "description":"Premise ID is a system-assigned, unique identifier that shows the primary premise associated with the service agreement."
        },
        "premiseAddress1":{
            "type":"string",
            "maxLength":254,
            "description":"Address"
        },
        "premiseFormattedAddress":{
            "type":"string",
            "maxLength":254,
            "description":"Premise Info",
            "example":"129 Sutter St, San Francisco, CA, 94104"
        },
        "numberOfPremises":{
            "type":"number",
            "maximum":99999,
            "minimum":0,
            "description":"Number of Premises related to the billing account",
            "example":"2"
        }
    }
}

Nested Schema : serviceDetails

Type: object

The types of services associated with the account.

Show Source

• serviceTypes: array serviceTypes

{
    "type":"object",
    "description":"The types of services associated with the account.",
    "properties":{
        "serviceTypes":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "serviceType":{
                        "type":"string",
                        "maxLength":80,
                        "description":"Service Type defines the type of service associated with the SA type.",
                        "example":"E"
                    }
                }
            }
        }
    }
}

Nested Schema : usageDetails

Type: object

Billed usage information for the account. These details are only supported in usage search query mode.

Show Source

• firstBillDate: string (date)
  The start date of the earliest bill associated with the reported usage for the account in the past 12 months.
• lastBillDate: string (date)
  The end date of the latest bill associated with the reported usage for the account in the past 12 months.
• usageFound: boolean
  The Usage found flag indicates that usage data was available in the requested timeframe.

  Example: Y
• usageInformation: array usageInformation

{
    "type":"object",
    "description":"Billed usage information for the account. These details are only supported in usage search query mode.",
    "properties":{
        "usageFound":{
            "type":"boolean",
            "description":"The Usage found flag indicates that usage data was available in the requested timeframe.",
            "example":"Y"
        },
        "firstBillDate":{
            "type":"string",
            "format":"date",
            "description":"The start date of the earliest bill associated with the reported usage for the account in the past 12 months."
        },
        "lastBillDate":{
            "type":"string",
            "format":"date",
            "description":"The end date of the latest bill associated with the reported usage for the account in the past 12 months."
        },
        "usageInformation":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "unitOfMeasure":{
                        "type":"string",
                        "maxLength":30,
                        "description":"Unit of Measure"
                    },
                    "peakIndicator":{
                        "type":"string",
                        "maxLength":1,
                        "description":"Measures Peak Quantity"
                    },
                    "usage":{
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "usageIdentifier":{
                                    "type":"string",
                                    "maxLength":100,
                                    "description":"Usage Identifier"
                                },
                                "usageValue":{
                                    "type":"number",
                                    "maximum":9999.999999,
                                    "minimum":0,
                                    "description":"Usage"
                                },
                                "timeOfUse":{
                                    "type":"string",
                                    "maxLength":30,
                                    "description":"Time of Use"
                                },
                                "serviceQuantityIdentifer":{
                                    "type":"string",
                                    "maxLength":30,
                                    "description":"SQI"
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : serviceTypes

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "serviceType":{
                "type":"string",
                "maxLength":80,
                "description":"Service Type defines the type of service associated with the SA type.",
                "example":"E"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• serviceType: string
  Maximum Length: 80

  Service Type defines the type of service associated with the SA type.

  Example: E

{
    "type":"object",
    "properties":{
        "serviceType":{
            "type":"string",
            "maxLength":80,
            "description":"Service Type defines the type of service associated with the SA type.",
            "example":"E"
        }
    }
}

Nested Schema : usageInformation

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "unitOfMeasure":{
                "type":"string",
                "maxLength":30,
                "description":"Unit of Measure"
            },
            "peakIndicator":{
                "type":"string",
                "maxLength":1,
                "description":"Measures Peak Quantity"
            },
            "usage":{
                "type":"array",
                "items":{
                    "type":"object",
                    "properties":{
                        "usageIdentifier":{
                            "type":"string",
                            "maxLength":100,
                            "description":"Usage Identifier"
                        },
                        "usageValue":{
                            "type":"number",
                            "maximum":9999.999999,
                            "minimum":0,
                            "description":"Usage"
                        },
                        "timeOfUse":{
                            "type":"string",
                            "maxLength":30,
                            "description":"Time of Use"
                        },
                        "serviceQuantityIdentifer":{
                            "type":"string",
                            "maxLength":30,
                            "description":"SQI"
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• peakIndicator: string
  Maximum Length: 1

  Measures Peak Quantity
• unitOfMeasure: string
  Maximum Length: 30

  Unit of Measure
• usage: array usage

{
    "type":"object",
    "properties":{
        "unitOfMeasure":{
            "type":"string",
            "maxLength":30,
            "description":"Unit of Measure"
        },
        "peakIndicator":{
            "type":"string",
            "maxLength":1,
            "description":"Measures Peak Quantity"
        },
        "usage":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "usageIdentifier":{
                        "type":"string",
                        "maxLength":100,
                        "description":"Usage Identifier"
                    },
                    "usageValue":{
                        "type":"number",
                        "maximum":9999.999999,
                        "minimum":0,
                        "description":"Usage"
                    },
                    "timeOfUse":{
                        "type":"string",
                        "maxLength":30,
                        "description":"Time of Use"
                    },
                    "serviceQuantityIdentifer":{
                        "type":"string",
                        "maxLength":30,
                        "description":"SQI"
                    }
                }
            }
        }
    }
}

Nested Schema : usage

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "usageIdentifier":{
                "type":"string",
                "maxLength":100,
                "description":"Usage Identifier"
            },
            "usageValue":{
                "type":"number",
                "maximum":9999.999999,
                "minimum":0,
                "description":"Usage"
            },
            "timeOfUse":{
                "type":"string",
                "maxLength":30,
                "description":"Time of Use"
            },
            "serviceQuantityIdentifer":{
                "type":"string",
                "maxLength":30,
                "description":"SQI"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• serviceQuantityIdentifer: string
  Maximum Length: 30

  SQI
• timeOfUse: string
  Maximum Length: 30

  Time of Use
• usageIdentifier: string
  Maximum Length: 100

  Usage Identifier
• usageValue: number
  Minimum Value: 0

  Maximum Value: 9999.999999

  Usage

{
    "type":"object",
    "properties":{
        "usageIdentifier":{
            "type":"string",
            "maxLength":100,
            "description":"Usage Identifier"
        },
        "usageValue":{
            "type":"number",
            "maximum":9999.999999,
            "minimum":0,
            "description":"Usage"
        },
        "timeOfUse":{
            "type":"string",
            "maxLength":30,
            "description":"Time of Use"
        },
        "serviceQuantityIdentifer":{
            "type":"string",
            "maxLength":30,
            "description":"SQI"
        }
    }
}

400 Response

Bad Request

Body ()

Root Schema : problemDetailDocument

Type: object

Show Source

• detail: string
  Maximum Length: 60

  The long message description from the Oracle Utilities Application Framework in CDATA format.
• httpStatus: number
  Minimum Value: 0

  Maximum Value: 9999

  The HTTP Status code for the error.
• problemInstance: string
  Maximum Length: 60

  Fully qualified URL consisting of the Base URI Timestamp of error in ISO format, the User used for the transaction, the Message Category within Oracle Utilities Application Framework, the Message Number within Oracle Utilities Application Framework, the Request URL and the HTTP method used for the transaction.
• problemType: string
  Maximum Length: 60

  URL of the format "A/message/X/Y" where A is the base URI, X is the Message Category and Y is the Message Number within Oracle Utilities Application Framework.
• serverMessage: object serverMessage
• stackTrace: string
  Maximum Length: 60

  The stack trace shows where the error occurs during the execution of a program.
• title: string
  Maximum Length: 60

  Fully qualified error message from Oracle Utilities Application Framework in CDATA format.

{
    "type":"object",
    "properties":{
        "problemType":{
            "type":"string",
            "maxLength":60,
            "description":"URL of the format \"A/message/X/Y\" where A is the base URI, X is the Message Category and Y is the Message Number within Oracle Utilities Application Framework."
        },
        "title":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "httpStatus":{
            "type":"number",
            "maximum":9999,
            "minimum":0,
            "description":"The HTTP Status code for the error."
        },
        "detail":{
            "type":"string",
            "maxLength":60,
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        },
        "problemInstance":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified URL consisting of the Base URI Timestamp of error in ISO format, the User used for the transaction, the Message Category within Oracle Utilities Application Framework, the Message Number within Oracle Utilities Application Framework, the Request URL and the HTTP method used for the transaction."
        },
        "stackTrace":{
            "type":"string",
            "maxLength":60,
            "description":"The stack trace shows where the error occurs during the execution of a program."
        },
        "serverMessage":{
            "type":"object",
            "properties":{
                "messageCategory":{
                    "type":"number",
                    "maximum":0,
                    "minimum":0,
                    "description":"Message Category within Oracle Utilities Application Framework."
                },
                "messageNbr":{
                    "type":"number",
                    "maximum":99999,
                    "minimum":-99999,
                    "description":"Message Number within Oracle Utilities Application Framework."
                },
                "callSequence":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Delimited sequence of programs called."
                },
                "programName":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Name of the program that encountered the error."
                },
                "messageText":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
                },
                "longDescription":{
                    "type":"string",
                    "maxLength":60,
                    "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
                }
            }
        }
    }
}

Nested Schema : serverMessage

Type: object

Show Source

• callSequence: string
  Maximum Length: 60

  Delimited sequence of programs called.
• longDescription: string
  Maximum Length: 60

  The long message description from the Oracle Utilities Application Framework in CDATA format.
• messageCategory: number
  Minimum Value: 0

  Maximum Value: 0

  Message Category within Oracle Utilities Application Framework.
• messageNbr: number
  Minimum Value: -99999

  Maximum Value: 99999

  Message Number within Oracle Utilities Application Framework.
• messageText: string
  Maximum Length: 60

  Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
• programName: string
  Maximum Length: 60

  Name of the program that encountered the error.

{
    "type":"object",
    "properties":{
        "messageCategory":{
            "type":"number",
            "maximum":0,
            "minimum":0,
            "description":"Message Category within Oracle Utilities Application Framework."
        },
        "messageNbr":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Message Number within Oracle Utilities Application Framework."
        },
        "callSequence":{
            "type":"string",
            "maxLength":60,
            "description":"Delimited sequence of programs called."
        },
        "programName":{
            "type":"string",
            "maxLength":60,
            "description":"Name of the program that encountered the error."
        },
        "messageText":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "longDescription":{
            "type":"string",
            "maxLength":60,
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        }
    }
}

500 Response

Internal Server Error

Body ()

Root Schema : problemDetailDocument

Type: object

Show Source

• detail: string
  Maximum Length: 60

  The long message description from the Oracle Utilities Application Framework in CDATA format.
• httpStatus: number
  Minimum Value: 0

  Maximum Value: 9999

  The HTTP Status code for the error.
• problemInstance: string
  Maximum Length: 60

  Fully qualified URL consisting of the Base URI Timestamp of error in ISO format, the User used for the transaction, the Message Category within Oracle Utilities Application Framework, the Message Number within Oracle Utilities Application Framework, the Request URL and the HTTP method used for the transaction.
• problemType: string
  Maximum Length: 60

  URL of the format "A/message/X/Y" where A is the base URI, X is the Message Category and Y is the Message Number within Oracle Utilities Application Framework.
• serverMessage: object serverMessage
• stackTrace: string
  Maximum Length: 60

  The stack trace shows where the error occurs during the execution of a program.
• title: string
  Maximum Length: 60

  Fully qualified error message from Oracle Utilities Application Framework in CDATA format.

{
    "type":"object",
    "properties":{
        "problemType":{
            "type":"string",
            "maxLength":60,
            "description":"URL of the format \"A/message/X/Y\" where A is the base URI, X is the Message Category and Y is the Message Number within Oracle Utilities Application Framework."
        },
        "title":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "httpStatus":{
            "type":"number",
            "maximum":9999,
            "minimum":0,
            "description":"The HTTP Status code for the error."
        },
        "detail":{
            "type":"string",
            "maxLength":60,
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        },
        "problemInstance":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified URL consisting of the Base URI Timestamp of error in ISO format, the User used for the transaction, the Message Category within Oracle Utilities Application Framework, the Message Number within Oracle Utilities Application Framework, the Request URL and the HTTP method used for the transaction."
        },
        "stackTrace":{
            "type":"string",
            "maxLength":60,
            "description":"The stack trace shows where the error occurs during the execution of a program."
        },
        "serverMessage":{
            "type":"object",
            "properties":{
                "messageCategory":{
                    "type":"number",
                    "maximum":0,
                    "minimum":0,
                    "description":"Message Category within Oracle Utilities Application Framework."
                },
                "messageNbr":{
                    "type":"number",
                    "maximum":99999,
                    "minimum":-99999,
                    "description":"Message Number within Oracle Utilities Application Framework."
                },
                "callSequence":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Delimited sequence of programs called."
                },
                "programName":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Name of the program that encountered the error."
                },
                "messageText":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
                },
                "longDescription":{
                    "type":"string",
                    "maxLength":60,
                    "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
                }
            }
        }
    }
}

Nested Schema : serverMessage

Type: object

Show Source

• callSequence: string
  Maximum Length: 60

  Delimited sequence of programs called.
• longDescription: string
  Maximum Length: 60

  The long message description from the Oracle Utilities Application Framework in CDATA format.
• messageCategory: number
  Minimum Value: 0

  Maximum Value: 0

  Message Category within Oracle Utilities Application Framework.
• messageNbr: number
  Minimum Value: -99999

  Maximum Value: 99999

  Message Number within Oracle Utilities Application Framework.
• messageText: string
  Maximum Length: 60

  Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
• programName: string
  Maximum Length: 60

  Name of the program that encountered the error.

{
    "type":"object",
    "properties":{
        "messageCategory":{
            "type":"number",
            "maximum":0,
            "minimum":0,
            "description":"Message Category within Oracle Utilities Application Framework."
        },
        "messageNbr":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Message Number within Oracle Utilities Application Framework."
        },
        "callSequence":{
            "type":"string",
            "maxLength":60,
            "description":"Delimited sequence of programs called."
        },
        "programName":{
            "type":"string",
            "maxLength":60,
            "description":"Name of the program that encountered the error."
        },
        "messageText":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "longDescription":{
            "type":"string",
            "maxLength":60,
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        }
    }
}

Back to Top