Jump to

• Request
• Response

Get Person Accounts

get

https://server:port/spl/rest/apis/customer/v-model/billingContext/personContext/{personId}

Request

Path Parameters

• personId(required): string
  Person ID is the system-assigned number for other persons related to the account.

  Example:

  4429925678

Query Parameters

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

  Example:

  0279948222

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

  Example:

  7640995310

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

Success response

Body ()

Root Schema : C1GetPerActs

Type: object

Show Source

• accounts: object accounts
• inputAccountNotLinked: boolean
  Flag to show if input Account ID is linked to person provided in the inputs.

  Example: true
• inputPremiseNotLinked: boolean
  Flag to show if input Premise ID is linked to account provided in the inputs.

  Example: true
• person: object person
• premise: object premise
• totalNumberOfRecords: number
  Minimum Value: 0

  Maximum Value: 99999

  Total Number Of Records

  Example: 2

{
    "type":"object",
    "properties":{
        "totalNumberOfRecords":{
            "type":"number",
            "maximum":99999,
            "minimum":0,
            "description":"Total Number Of Records",
            "example":"2"
        },
        "inputAccountNotLinked":{
            "type":"boolean",
            "description":"Flag to show if input Account ID is linked to person provided in the inputs.",
            "example":"true"
        },
        "inputPremiseNotLinked":{
            "type":"boolean",
            "description":"Flag to show if input Premise ID is linked to account provided in the inputs.",
            "example":"true"
        },
        "person":{
            "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"
                },
                "primaryName":{
                    "type":"string",
                    "maxLength":254,
                    "description":"Name"
                }
            }
        },
        "premise":{
            "type":"object",
            "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."
                },
                "info":{
                    "type":"string",
                    "maxLength":254,
                    "description":"Premise Info",
                    "example":"129 Sutter St, San Francisco, CA, 94104"
                },
                "primaryText":{
                    "type":"string",
                    "maxLength":1000,
                    "description":"Primary text for Premise Info"
                },
                "secondaryText":{
                    "type":"string",
                    "maxLength":1000,
                    "description":"Secondary Text for Premise Info"
                },
                "tertiaryText":{
                    "type":"string",
                    "maxLength":1000,
                    "description":"Tertiary text for Premise Info"
                }
            }
        },
        "accounts":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "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"
                                    }
                                }
                            },
                            "customerClass":{
                                "type":"object",
                                "properties":{
                                    "customerClass":{
                                        "type":"string",
                                        "maxLength":8,
                                        "description":"Customer Class controls financial parameters related to billing and collections and is required on an account.",
                                        "example":"R"
                                    },
                                    "description":{
                                        "type":"string",
                                        "maxLength":60,
                                        "description":"Description"
                                    }
                                }
                            },
                            "division":{
                                "type":"object",
                                "properties":{
                                    "division":{
                                        "type":"string",
                                        "maxLength":5,
                                        "description":"CIS Division"
                                    },
                                    "description":{
                                        "type":"string",
                                        "maxLength":60,
                                        "description":"Description"
                                    }
                                }
                            },
                            "accountInformation":{
                                "type":"object",
                                "properties":{
                                    "info":{
                                        "type":"string",
                                        "maxLength":254,
                                        "description":"Account Info displays information associated with an Account.",
                                        "example":"Brazil,Mark, Residential, $19,247.81"
                                    },
                                    "primaryText":{
                                        "type":"string",
                                        "maxLength":1000,
                                        "description":"Primary text for Premise Info"
                                    },
                                    "secondaryText":{
                                        "type":"string",
                                        "maxLength":1000,
                                        "description":"Secondary Text for Premise Info"
                                    },
                                    "tertiaryText":{
                                        "type":"string",
                                        "maxLength":1000,
                                        "description":"Tertiary text for Premise Info"
                                    }
                                }
                            },
                            "premiseInformation":{
                                "type":"object",
                                "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."
                                    },
                                    "info":{
                                        "type":"string",
                                        "maxLength":254,
                                        "description":"Premise Info",
                                        "example":"129 Sutter St, San Francisco, CA, 94104"
                                    },
                                    "primaryText":{
                                        "type":"string",
                                        "maxLength":1000,
                                        "description":"Primary text for Premise Info"
                                    },
                                    "secondaryText":{
                                        "type":"string",
                                        "maxLength":1000,
                                        "description":"Secondary Text for Premise Info"
                                    },
                                    "tertiaryText":{
                                        "type":"string",
                                        "maxLength":1000,
                                        "description":"Tertiary text for Premise Info"
                                    }
                                }
                            },
                            "premiseCount":{
                                "type":"number",
                                "maximum":99999,
                                "minimum":0,
                                "description":"Premise Count for the Account"
                            },
                            "accountPersons":{
                                "type":"object",
                                "properties":{
                                    "_data":{
                                        "type":"array",
                                        "items":{
                                            "type":"object",
                                            "properties":{
                                                "person":{
                                                    "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"
                                                        }
                                                    }
                                                },
                                                "personInformation":{
                                                    "type":"object",
                                                    "properties":{
                                                        "info":{
                                                            "type":"string",
                                                            "maxLength":254,
                                                            "description":"Person Info"
                                                        },
                                                        "primaryText":{
                                                            "type":"string",
                                                            "maxLength":1000,
                                                            "description":"Primary text for Premise Info"
                                                        },
                                                        "secondaryText":{
                                                            "type":"string",
                                                            "maxLength":1000,
                                                            "description":"Secondary Text for Premise Info"
                                                        },
                                                        "tertiaryText":{
                                                            "type":"string",
                                                            "maxLength":1000,
                                                            "description":"Tertiary text for Premise Info"
                                                        }
                                                    }
                                                },
                                                "primaryName":{
                                                    "type":"string",
                                                    "maxLength":254,
                                                    "description":"Name"
                                                },
                                                "accountRelationshipType":{
                                                    "type":"object",
                                                    "properties":{
                                                        "accountRelationshipType":{
                                                            "type":"string",
                                                            "maxLength":8,
                                                            "description":"Account Relationship Type"
                                                        },
                                                        "description":{
                                                            "type":"string",
                                                            "maxLength":60,
                                                            "description":"Description"
                                                        }
                                                    }
                                                },
                                                "isMainCustomer":{
                                                    "type":"boolean",
                                                    "description":"Main Customer switch is on if the person is the main customer on the account. Only one person on an account may be designated as the main customer.",
                                                    "example":"false"
                                                },
                                                "isFinanciallyResponsible":{
                                                    "type":"boolean",
                                                    "description":"Financially Responsible switch is on if the person is financially responsible for the account's debt.",
                                                    "example":"true"
                                                }
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    },
    "xml":{
        "name":"C1GetPerActs"
    }
}

Nested Schema : accounts

Type: object

Show Source

• _data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "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"
                            }
                        }
                    },
                    "customerClass":{
                        "type":"object",
                        "properties":{
                            "customerClass":{
                                "type":"string",
                                "maxLength":8,
                                "description":"Customer Class controls financial parameters related to billing and collections and is required on an account.",
                                "example":"R"
                            },
                            "description":{
                                "type":"string",
                                "maxLength":60,
                                "description":"Description"
                            }
                        }
                    },
                    "division":{
                        "type":"object",
                        "properties":{
                            "division":{
                                "type":"string",
                                "maxLength":5,
                                "description":"CIS Division"
                            },
                            "description":{
                                "type":"string",
                                "maxLength":60,
                                "description":"Description"
                            }
                        }
                    },
                    "accountInformation":{
                        "type":"object",
                        "properties":{
                            "info":{
                                "type":"string",
                                "maxLength":254,
                                "description":"Account Info displays information associated with an Account.",
                                "example":"Brazil,Mark, Residential, $19,247.81"
                            },
                            "primaryText":{
                                "type":"string",
                                "maxLength":1000,
                                "description":"Primary text for Premise Info"
                            },
                            "secondaryText":{
                                "type":"string",
                                "maxLength":1000,
                                "description":"Secondary Text for Premise Info"
                            },
                            "tertiaryText":{
                                "type":"string",
                                "maxLength":1000,
                                "description":"Tertiary text for Premise Info"
                            }
                        }
                    },
                    "premiseInformation":{
                        "type":"object",
                        "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."
                            },
                            "info":{
                                "type":"string",
                                "maxLength":254,
                                "description":"Premise Info",
                                "example":"129 Sutter St, San Francisco, CA, 94104"
                            },
                            "primaryText":{
                                "type":"string",
                                "maxLength":1000,
                                "description":"Primary text for Premise Info"
                            },
                            "secondaryText":{
                                "type":"string",
                                "maxLength":1000,
                                "description":"Secondary Text for Premise Info"
                            },
                            "tertiaryText":{
                                "type":"string",
                                "maxLength":1000,
                                "description":"Tertiary text for Premise Info"
                            }
                        }
                    },
                    "premiseCount":{
                        "type":"number",
                        "maximum":99999,
                        "minimum":0,
                        "description":"Premise Count for the Account"
                    },
                    "accountPersons":{
                        "type":"object",
                        "properties":{
                            "_data":{
                                "type":"array",
                                "items":{
                                    "type":"object",
                                    "properties":{
                                        "person":{
                                            "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"
                                                }
                                            }
                                        },
                                        "personInformation":{
                                            "type":"object",
                                            "properties":{
                                                "info":{
                                                    "type":"string",
                                                    "maxLength":254,
                                                    "description":"Person Info"
                                                },
                                                "primaryText":{
                                                    "type":"string",
                                                    "maxLength":1000,
                                                    "description":"Primary text for Premise Info"
                                                },
                                                "secondaryText":{
                                                    "type":"string",
                                                    "maxLength":1000,
                                                    "description":"Secondary Text for Premise Info"
                                                },
                                                "tertiaryText":{
                                                    "type":"string",
                                                    "maxLength":1000,
                                                    "description":"Tertiary text for Premise Info"
                                                }
                                            }
                                        },
                                        "primaryName":{
                                            "type":"string",
                                            "maxLength":254,
                                            "description":"Name"
                                        },
                                        "accountRelationshipType":{
                                            "type":"object",
                                            "properties":{
                                                "accountRelationshipType":{
                                                    "type":"string",
                                                    "maxLength":8,
                                                    "description":"Account Relationship Type"
                                                },
                                                "description":{
                                                    "type":"string",
                                                    "maxLength":60,
                                                    "description":"Description"
                                                }
                                            }
                                        },
                                        "isMainCustomer":{
                                            "type":"boolean",
                                            "description":"Main Customer switch is on if the person is the main customer on the account. Only one person on an account may be designated as the main customer.",
                                            "example":"false"
                                        },
                                        "isFinanciallyResponsible":{
                                            "type":"boolean",
                                            "description":"Financially Responsible switch is on if the person is financially responsible for the account's debt.",
                                            "example":"true"
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : person

Type: object

Show Source

• personId: string
  Maximum Length: 10

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

  Example: 4429925678
• primaryName: string
  Maximum Length: 254

  Name

{
    "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"
        },
        "primaryName":{
            "type":"string",
            "maxLength":254,
            "description":"Name"
        }
    }
}

Nested Schema : premise

Type: object

Show Source

• info: 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.
• primaryText: string
  Maximum Length: 1000

  Primary text for Premise Info
• secondaryText: string
  Maximum Length: 1000

  Secondary Text for Premise Info
• tertiaryText: string
  Maximum Length: 1000

  Tertiary text for Premise Info

{
    "type":"object",
    "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."
        },
        "info":{
            "type":"string",
            "maxLength":254,
            "description":"Premise Info",
            "example":"129 Sutter St, San Francisco, CA, 94104"
        },
        "primaryText":{
            "type":"string",
            "maxLength":1000,
            "description":"Primary text for Premise Info"
        },
        "secondaryText":{
            "type":"string",
            "maxLength":1000,
            "description":"Secondary Text for Premise Info"
        },
        "tertiaryText":{
            "type":"string",
            "maxLength":1000,
            "description":"Tertiary text for Premise Info"
        }
    }
}

Nested Schema : _data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "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"
                    }
                }
            },
            "customerClass":{
                "type":"object",
                "properties":{
                    "customerClass":{
                        "type":"string",
                        "maxLength":8,
                        "description":"Customer Class controls financial parameters related to billing and collections and is required on an account.",
                        "example":"R"
                    },
                    "description":{
                        "type":"string",
                        "maxLength":60,
                        "description":"Description"
                    }
                }
            },
            "division":{
                "type":"object",
                "properties":{
                    "division":{
                        "type":"string",
                        "maxLength":5,
                        "description":"CIS Division"
                    },
                    "description":{
                        "type":"string",
                        "maxLength":60,
                        "description":"Description"
                    }
                }
            },
            "accountInformation":{
                "type":"object",
                "properties":{
                    "info":{
                        "type":"string",
                        "maxLength":254,
                        "description":"Account Info displays information associated with an Account.",
                        "example":"Brazil,Mark, Residential, $19,247.81"
                    },
                    "primaryText":{
                        "type":"string",
                        "maxLength":1000,
                        "description":"Primary text for Premise Info"
                    },
                    "secondaryText":{
                        "type":"string",
                        "maxLength":1000,
                        "description":"Secondary Text for Premise Info"
                    },
                    "tertiaryText":{
                        "type":"string",
                        "maxLength":1000,
                        "description":"Tertiary text for Premise Info"
                    }
                }
            },
            "premiseInformation":{
                "type":"object",
                "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."
                    },
                    "info":{
                        "type":"string",
                        "maxLength":254,
                        "description":"Premise Info",
                        "example":"129 Sutter St, San Francisco, CA, 94104"
                    },
                    "primaryText":{
                        "type":"string",
                        "maxLength":1000,
                        "description":"Primary text for Premise Info"
                    },
                    "secondaryText":{
                        "type":"string",
                        "maxLength":1000,
                        "description":"Secondary Text for Premise Info"
                    },
                    "tertiaryText":{
                        "type":"string",
                        "maxLength":1000,
                        "description":"Tertiary text for Premise Info"
                    }
                }
            },
            "premiseCount":{
                "type":"number",
                "maximum":99999,
                "minimum":0,
                "description":"Premise Count for the Account"
            },
            "accountPersons":{
                "type":"object",
                "properties":{
                    "_data":{
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "person":{
                                    "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"
                                        }
                                    }
                                },
                                "personInformation":{
                                    "type":"object",
                                    "properties":{
                                        "info":{
                                            "type":"string",
                                            "maxLength":254,
                                            "description":"Person Info"
                                        },
                                        "primaryText":{
                                            "type":"string",
                                            "maxLength":1000,
                                            "description":"Primary text for Premise Info"
                                        },
                                        "secondaryText":{
                                            "type":"string",
                                            "maxLength":1000,
                                            "description":"Secondary Text for Premise Info"
                                        },
                                        "tertiaryText":{
                                            "type":"string",
                                            "maxLength":1000,
                                            "description":"Tertiary text for Premise Info"
                                        }
                                    }
                                },
                                "primaryName":{
                                    "type":"string",
                                    "maxLength":254,
                                    "description":"Name"
                                },
                                "accountRelationshipType":{
                                    "type":"object",
                                    "properties":{
                                        "accountRelationshipType":{
                                            "type":"string",
                                            "maxLength":8,
                                            "description":"Account Relationship Type"
                                        },
                                        "description":{
                                            "type":"string",
                                            "maxLength":60,
                                            "description":"Description"
                                        }
                                    }
                                },
                                "isMainCustomer":{
                                    "type":"boolean",
                                    "description":"Main Customer switch is on if the person is the main customer on the account. Only one person on an account may be designated as the main customer.",
                                    "example":"false"
                                },
                                "isFinanciallyResponsible":{
                                    "type":"boolean",
                                    "description":"Financially Responsible switch is on if the person is financially responsible for the account's debt.",
                                    "example":"true"
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• account: object account
• accountInformation: object accountInformation
• accountPersons: object accountPersons
• customerClass: object customerClass
• division: object division
• premiseCount: number
  Minimum Value: 0

  Maximum Value: 99999

  Premise Count for the Account
• premiseInformation: object premiseInformation

{
    "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"
                }
            }
        },
        "customerClass":{
            "type":"object",
            "properties":{
                "customerClass":{
                    "type":"string",
                    "maxLength":8,
                    "description":"Customer Class controls financial parameters related to billing and collections and is required on an account.",
                    "example":"R"
                },
                "description":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Description"
                }
            }
        },
        "division":{
            "type":"object",
            "properties":{
                "division":{
                    "type":"string",
                    "maxLength":5,
                    "description":"CIS Division"
                },
                "description":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Description"
                }
            }
        },
        "accountInformation":{
            "type":"object",
            "properties":{
                "info":{
                    "type":"string",
                    "maxLength":254,
                    "description":"Account Info displays information associated with an Account.",
                    "example":"Brazil,Mark, Residential, $19,247.81"
                },
                "primaryText":{
                    "type":"string",
                    "maxLength":1000,
                    "description":"Primary text for Premise Info"
                },
                "secondaryText":{
                    "type":"string",
                    "maxLength":1000,
                    "description":"Secondary Text for Premise Info"
                },
                "tertiaryText":{
                    "type":"string",
                    "maxLength":1000,
                    "description":"Tertiary text for Premise Info"
                }
            }
        },
        "premiseInformation":{
            "type":"object",
            "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."
                },
                "info":{
                    "type":"string",
                    "maxLength":254,
                    "description":"Premise Info",
                    "example":"129 Sutter St, San Francisco, CA, 94104"
                },
                "primaryText":{
                    "type":"string",
                    "maxLength":1000,
                    "description":"Primary text for Premise Info"
                },
                "secondaryText":{
                    "type":"string",
                    "maxLength":1000,
                    "description":"Secondary Text for Premise Info"
                },
                "tertiaryText":{
                    "type":"string",
                    "maxLength":1000,
                    "description":"Tertiary text for Premise Info"
                }
            }
        },
        "premiseCount":{
            "type":"number",
            "maximum":99999,
            "minimum":0,
            "description":"Premise Count for the Account"
        },
        "accountPersons":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "person":{
                                "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"
                                    }
                                }
                            },
                            "personInformation":{
                                "type":"object",
                                "properties":{
                                    "info":{
                                        "type":"string",
                                        "maxLength":254,
                                        "description":"Person Info"
                                    },
                                    "primaryText":{
                                        "type":"string",
                                        "maxLength":1000,
                                        "description":"Primary text for Premise Info"
                                    },
                                    "secondaryText":{
                                        "type":"string",
                                        "maxLength":1000,
                                        "description":"Secondary Text for Premise Info"
                                    },
                                    "tertiaryText":{
                                        "type":"string",
                                        "maxLength":1000,
                                        "description":"Tertiary text for Premise Info"
                                    }
                                }
                            },
                            "primaryName":{
                                "type":"string",
                                "maxLength":254,
                                "description":"Name"
                            },
                            "accountRelationshipType":{
                                "type":"object",
                                "properties":{
                                    "accountRelationshipType":{
                                        "type":"string",
                                        "maxLength":8,
                                        "description":"Account Relationship Type"
                                    },
                                    "description":{
                                        "type":"string",
                                        "maxLength":60,
                                        "description":"Description"
                                    }
                                }
                            },
                            "isMainCustomer":{
                                "type":"boolean",
                                "description":"Main Customer switch is on if the person is the main customer on the account. Only one person on an account may be designated as the main customer.",
                                "example":"false"
                            },
                            "isFinanciallyResponsible":{
                                "type":"boolean",
                                "description":"Financially Responsible switch is on if the person is financially responsible for the account's debt.",
                                "example":"true"
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : account

Type: object

Show Source

• 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"
        }
    }
}

Nested Schema : accountInformation

Type: object

Show Source

• info: string
  Maximum Length: 254

  Account Info displays information associated with an Account.

  Example: Brazil,Mark, Residential, $19,247.81
• primaryText: string
  Maximum Length: 1000

  Primary text for Premise Info
• secondaryText: string
  Maximum Length: 1000

  Secondary Text for Premise Info
• tertiaryText: string
  Maximum Length: 1000

  Tertiary text for Premise Info

{
    "type":"object",
    "properties":{
        "info":{
            "type":"string",
            "maxLength":254,
            "description":"Account Info displays information associated with an Account.",
            "example":"Brazil,Mark, Residential, $19,247.81"
        },
        "primaryText":{
            "type":"string",
            "maxLength":1000,
            "description":"Primary text for Premise Info"
        },
        "secondaryText":{
            "type":"string",
            "maxLength":1000,
            "description":"Secondary Text for Premise Info"
        },
        "tertiaryText":{
            "type":"string",
            "maxLength":1000,
            "description":"Tertiary text for Premise Info"
        }
    }
}

Nested Schema : accountPersons

Type: object

Show Source

• _data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "person":{
                        "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"
                            }
                        }
                    },
                    "personInformation":{
                        "type":"object",
                        "properties":{
                            "info":{
                                "type":"string",
                                "maxLength":254,
                                "description":"Person Info"
                            },
                            "primaryText":{
                                "type":"string",
                                "maxLength":1000,
                                "description":"Primary text for Premise Info"
                            },
                            "secondaryText":{
                                "type":"string",
                                "maxLength":1000,
                                "description":"Secondary Text for Premise Info"
                            },
                            "tertiaryText":{
                                "type":"string",
                                "maxLength":1000,
                                "description":"Tertiary text for Premise Info"
                            }
                        }
                    },
                    "primaryName":{
                        "type":"string",
                        "maxLength":254,
                        "description":"Name"
                    },
                    "accountRelationshipType":{
                        "type":"object",
                        "properties":{
                            "accountRelationshipType":{
                                "type":"string",
                                "maxLength":8,
                                "description":"Account Relationship Type"
                            },
                            "description":{
                                "type":"string",
                                "maxLength":60,
                                "description":"Description"
                            }
                        }
                    },
                    "isMainCustomer":{
                        "type":"boolean",
                        "description":"Main Customer switch is on if the person is the main customer on the account. Only one person on an account may be designated as the main customer.",
                        "example":"false"
                    },
                    "isFinanciallyResponsible":{
                        "type":"boolean",
                        "description":"Financially Responsible switch is on if the person is financially responsible for the account's debt.",
                        "example":"true"
                    }
                }
            }
        }
    }
}

Nested Schema : customerClass

Type: object

Show Source

• customerClass: string
  Maximum Length: 8

  Customer Class controls financial parameters related to billing and collections and is required on an account.

  Example: R
• description: string
  Maximum Length: 60

  Description

{
    "type":"object",
    "properties":{
        "customerClass":{
            "type":"string",
            "maxLength":8,
            "description":"Customer Class controls financial parameters related to billing and collections and is required on an account.",
            "example":"R"
        },
        "description":{
            "type":"string",
            "maxLength":60,
            "description":"Description"
        }
    }
}

Nested Schema : division

Type: object

Show Source

• description: string
  Maximum Length: 60

  Description
• division: string
  Maximum Length: 5

  CIS Division

{
    "type":"object",
    "properties":{
        "division":{
            "type":"string",
            "maxLength":5,
            "description":"CIS Division"
        },
        "description":{
            "type":"string",
            "maxLength":60,
            "description":"Description"
        }
    }
}

Nested Schema : premiseInformation

Type: object

Show Source

• info: 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.
• primaryText: string
  Maximum Length: 1000

  Primary text for Premise Info
• secondaryText: string
  Maximum Length: 1000

  Secondary Text for Premise Info
• tertiaryText: string
  Maximum Length: 1000

  Tertiary text for Premise Info

{
    "type":"object",
    "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."
        },
        "info":{
            "type":"string",
            "maxLength":254,
            "description":"Premise Info",
            "example":"129 Sutter St, San Francisco, CA, 94104"
        },
        "primaryText":{
            "type":"string",
            "maxLength":1000,
            "description":"Primary text for Premise Info"
        },
        "secondaryText":{
            "type":"string",
            "maxLength":1000,
            "description":"Secondary Text for Premise Info"
        },
        "tertiaryText":{
            "type":"string",
            "maxLength":1000,
            "description":"Tertiary text for Premise Info"
        }
    }
}

Nested Schema : _data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "person":{
                "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"
                    }
                }
            },
            "personInformation":{
                "type":"object",
                "properties":{
                    "info":{
                        "type":"string",
                        "maxLength":254,
                        "description":"Person Info"
                    },
                    "primaryText":{
                        "type":"string",
                        "maxLength":1000,
                        "description":"Primary text for Premise Info"
                    },
                    "secondaryText":{
                        "type":"string",
                        "maxLength":1000,
                        "description":"Secondary Text for Premise Info"
                    },
                    "tertiaryText":{
                        "type":"string",
                        "maxLength":1000,
                        "description":"Tertiary text for Premise Info"
                    }
                }
            },
            "primaryName":{
                "type":"string",
                "maxLength":254,
                "description":"Name"
            },
            "accountRelationshipType":{
                "type":"object",
                "properties":{
                    "accountRelationshipType":{
                        "type":"string",
                        "maxLength":8,
                        "description":"Account Relationship Type"
                    },
                    "description":{
                        "type":"string",
                        "maxLength":60,
                        "description":"Description"
                    }
                }
            },
            "isMainCustomer":{
                "type":"boolean",
                "description":"Main Customer switch is on if the person is the main customer on the account. Only one person on an account may be designated as the main customer.",
                "example":"false"
            },
            "isFinanciallyResponsible":{
                "type":"boolean",
                "description":"Financially Responsible switch is on if the person is financially responsible for the account's debt.",
                "example":"true"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• accountRelationshipType: object accountRelationshipType
• isFinanciallyResponsible: boolean
  Financially Responsible switch is on if the person is financially responsible for the account's debt.

  Example: true
• isMainCustomer: boolean
  Main Customer switch is on if the person is the main customer on the account. Only one person on an account may be designated as the main customer.

  Example: false
• person: object person
• personInformation: object personInformation
• primaryName: string
  Maximum Length: 254

  Name

{
    "type":"object",
    "properties":{
        "person":{
            "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"
                }
            }
        },
        "personInformation":{
            "type":"object",
            "properties":{
                "info":{
                    "type":"string",
                    "maxLength":254,
                    "description":"Person Info"
                },
                "primaryText":{
                    "type":"string",
                    "maxLength":1000,
                    "description":"Primary text for Premise Info"
                },
                "secondaryText":{
                    "type":"string",
                    "maxLength":1000,
                    "description":"Secondary Text for Premise Info"
                },
                "tertiaryText":{
                    "type":"string",
                    "maxLength":1000,
                    "description":"Tertiary text for Premise Info"
                }
            }
        },
        "primaryName":{
            "type":"string",
            "maxLength":254,
            "description":"Name"
        },
        "accountRelationshipType":{
            "type":"object",
            "properties":{
                "accountRelationshipType":{
                    "type":"string",
                    "maxLength":8,
                    "description":"Account Relationship Type"
                },
                "description":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Description"
                }
            }
        },
        "isMainCustomer":{
            "type":"boolean",
            "description":"Main Customer switch is on if the person is the main customer on the account. Only one person on an account may be designated as the main customer.",
            "example":"false"
        },
        "isFinanciallyResponsible":{
            "type":"boolean",
            "description":"Financially Responsible switch is on if the person is financially responsible for the account's debt.",
            "example":"true"
        }
    }
}

Nested Schema : accountRelationshipType

Type: object

Show Source

• accountRelationshipType: string
  Maximum Length: 8

  Account Relationship Type
• description: string
  Maximum Length: 60

  Description

{
    "type":"object",
    "properties":{
        "accountRelationshipType":{
            "type":"string",
            "maxLength":8,
            "description":"Account Relationship Type"
        },
        "description":{
            "type":"string",
            "maxLength":60,
            "description":"Description"
        }
    }
}

Nested Schema : person

Type: object

Show Source

• personId: string
  Maximum Length: 10

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

  Example: 4429925678

{
    "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"
        }
    }
}

Nested Schema : personInformation

Type: object

Show Source

• info: string
  Maximum Length: 254

  Person Info
• primaryText: string
  Maximum Length: 1000

  Primary text for Premise Info
• secondaryText: string
  Maximum Length: 1000

  Secondary Text for Premise Info
• tertiaryText: string
  Maximum Length: 1000

  Tertiary text for Premise Info

{
    "type":"object",
    "properties":{
        "info":{
            "type":"string",
            "maxLength":254,
            "description":"Person Info"
        },
        "primaryText":{
            "type":"string",
            "maxLength":1000,
            "description":"Primary text for Premise Info"
        },
        "secondaryText":{
            "type":"string",
            "maxLength":1000,
            "description":"Secondary Text for Premise Info"
        },
        "tertiaryText":{
            "type":"string",
            "maxLength":1000,
            "description":"Tertiary text for Premise Info"
        }
    }
}

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