{"openapi":"3.0.0","info":{"title":"Oracle Utilities REST API for Metering and Customer Information","description":"This documentation helps you to get started using the REST APIs for Oracle Utilities Metering and Customer Information.","version":"2022.03.24","x-summary":"This documentation helps you to get started using the REST APIs for Oracle Utilities Metering and Customer Information."},"tags":[{"name":"Credit & Collections/Collection Process","description":"A collection process is a series of events (e.g., letters, To Do entries) meant to encourage an account to pay its delinquent debt. Linked to the collection process are the specific service agreements that contributed to the delinquent debt."},{"name":"Credit & Collections/Cut Process","description":"A cut process is a series of events (e.g., letters, To Do entries, field activities) that lead to the disconnection of service if outstanding debt is not paid."},{"name":"Credit & Collections/Overdue Process","description":"An overdue process is a series of events (e.g., letters, To Do entries) meant to encourage an account to pay its delinquent debt.  The system creates an overdue process when an account violates your overdue rules. In addition, a user can manually create an overdue process at their discretion."},{"name":"Credit & Collections/Severance Process","description":"A severance process is a series of events (e.g., letters, To Do entries, field activities) that lead to the severance of a service agreement if the outstanding debt is not paid. A separate severance process is required for each service agreement to be severed."},{"name":"Credit & Collections/Write Off Process","description":"A write-off process is a series of events (e.g., letters, collection agency referrals) meant to encourage an account to pay its delinquent debt. Linked to the write-off process are the specific service agreements that contributed to the delinquent debt."},{"name":"Devices/Device Configurations","description":"Device configurations manage details of a device such as measuring components of a physical meter."},{"name":"Devices/Item","description":"Items can be either \"badged\" or \"unbadged\" . Badged items are devices that are individually tracked and can be installed at service point locations that typically have consumption but are not directly measured and therefore do not have any measuring components."},{"name":"Devices/Measuring Component","description":"Measuring components are points for which data will be received and stored in the system.  A measuring component can be associated to a device, which can have one or more measuring components, or it can be \"virtual\" or \"stand-alone\" meaning that it is not associated to a device."},{"name":"Devices/Meter","description":"Meters are devices that measure utility consumption and can be installed at service point locations. There are different classes of meters with different attributes and behavior\n\nSmart Meter: these meters are associated to a head end system and support smart meter commands. The measuring components associated to these devices are expected to be read very frequently. These meters support periodic estimation\nAMR Meter: these meters may also be associated to a head end system but they do not support smart meter commands. The measuring components are read frequently.\nManual Meter: these meters are seldom read and do not support smart meter commands."},{"name":"Financial Transactions/Account Financial History","description":"Account Financial History shows how an account's current and payoff balance have changed over time."},{"name":"Financial Transactions/Adjustment","description":"An adjustment is a type of financial transaction that effects a service agreement's debt and financial impact on the general ledger."},{"name":"Financial Transactions/Bill","description":"A bill is produced for an account and many bills are produced for an account over time. Bills charge for the services or products supplied to a customer.\n\nNote: All REST services that are in the Integration Suite Web Service Categories require the related Integration Suite add-on product option to use."},{"name":"Financial Transactions/Bill Segment","description":"A bill typically contains one bill segment for every active service agreement linked to its account. A bill segment contains information showing how the segment was calculated and how it should be printed on the customer's bill.\n\nNote: All REST services that are in the Integration Suite Web Service Category require the related Integration Suite add-on product option to use."},{"name":"Financial Transactions/Budget","description":"The Budget contains information about all service agreements linked to an account that are eligible to participate in a budget billing plan."},{"name":"Financial Transactions/Pay Plan","description":"A pay plan (PP) is an agreement with a customer to make payments on specific dates. Pay plans differ from payment arrangements in that pay plans have user-defined scheduled payment dates, which are independent from the customer's billing dates. In other words, payment arrangements appear on the customer's bills, pay plan scheduled payments do not."},{"name":"Financial Transactions/Payment","description":"Payments record the financial impact to offset arrears of an account. A payment can have multiple payment segments for the financial impact to offset arrears of each service agreement."},{"name":"Financial Transactions/Payment Event","description":"A payment event records an overall transaction whenever any form of payment is received.  The payment event can span payments across multiple accounts and can include multiple payment tenders.\n\nNote: All REST services that are in the Integration Suite Web Service Categories require the related Integration Suite add-on product option to use."},{"name":"Financial Transactions/PaymentTender","description":"Payment tenders exist for every form of tender remitted as part of a payment event. A payment event must have at least one tender otherwise nothing was remitted. A payment event may have many tenders when multiple payment methods are associated with an event (e.g., paying with cash, a check, and a credit card)."},{"name":"Interactions/Case","description":"Cases are a highly configurable object that can be used to handle various types of requests that can be tracked and require a workflow to enable resolution."},{"name":"Interactions/Customer Activity History","description":"Historical customer activity records and navigation details for activity types including customer contacts, bills, payments, field activities, service orders, service tasks.\n\nNote: All REST services that are in the Customer Experience Web Service Categories require the related Customer Experience add-on product option to use."},{"name":"Interactions/Customer Contact","description":"Customer contacts are used to record when and why a customer contacted your company or to initiate an outbound communication such as a letter that can be extracted for print and delivery."},{"name":"Service/Web User","description":"Web users can be associated with customer persons to keep logins from an integrated self-service application, such as Oracle Utilities Digital Self-Service."},{"name":"Service/Web User Account","description":"Web users can be associated with customer accounts that are linked to a login from an integrated self-service application, such as Oracle Utilities Digital Self-Service."},{"name":"Service/Work Queue","description":"Work queue of To Do Entries assigned to the user.\n\nNote: All REST services that are in the Customer Experience Web Service Categories require the related Customer Experience add-on product option to use."},{"name":"Usage/Usage Transaction","description":"Usage Transactions are records of a given usage calculation for a period of time for a Usage Subscription. All of the Service Quantities (often referred to as bill determinants) calculated are stored in the Usage Transaction.\n\nWhen calculating a Usage Transaction, the first step in calculating the usage is for the system to determine the usage calculation group holding the rules set used in calculating or validating the quantities.  Usage transaction requests must specify the date range for the usage transaction. This date range is referred to as the calculation period for the usage transaction."},{"name":"V-Model/Account","description":"Accounts manage the financial relationship with an end customer for which bills are created based on service agreements.   The account contains information that controls when the bills are generated and how they are formatted for related persons."},{"name":"V-Model/Business Person Queries","description":"Get Business Summary retrieves summary details for the provided person id.  This summary is intended for persons of type business that may have multiple active billing accounts and premise service locations."},{"name":"V-Model/Communications Preferences","description":"Centralized maintenance of a person's communication preferences by notification types allowed for an account."},{"name":"V-Model/Install Events","description":"Install Events manage the physical installation of devices such as meters or badged items at service point connection locations including relationships to markets and service providers and communication between devices or schedules for manual meter reading."},{"name":"V-Model/Landlord Agreements","description":"A landlord agreement maintains a landlord's service reversion preferences.  A landlord will have at least one landlord agreement. However, if the landlord has different service reversion preferences for different properties, you can create multiple landlord agreements - one for each set of preferences. After a landlord's reversion preferences have been defined, the landlord agreement record can be linked to the respective premises."},{"name":"V-Model/Person","description":"Person records can exist for individuals or businesses with which your company has contact related to a service provided . Besides customers, persons can exist for landlords, contractors, third-party guarantors, energy distributors or other service providers, collection agencies and so on."},{"name":"V-Model/Person Context","description":"Retrieves a list of related accounts for a person along with other related persons to each account."},{"name":"V-Model/Person Information Synchronization","description":"Synchronization of person records for an individual or business with which your company has interactions and could be synchronized with CX applications.\n\nSynchronized person information includes primary name and contact information such as phone number or email address."},{"name":"V-Model/Premise","description":"The premise record contains geographic information about your service addresses. A premise can have service points at which meters can be installed to measure utility services supplied to the premise."},{"name":"V-Model/Program Context","description":"Program Context includes name value pairs to indicate customer context such as various programs in which the customer may be enrolled."},{"name":"V-Model/Service Agreement","description":"A service agreement is as a contract between your company and a customer. The service agreement contains the terms and conditions controlling how the system calculates charges for the specific service or product supplied to the customer."},{"name":"V-Model/Service Points/C2M","description":"Service points are a physical location (usually meter connection socket) at which a company supplies service that can be used to store information describing the type of service supplied and how it is measured.\n\nDevices are installed at service points, and the relationship between individual service points and devices can change over time."},{"name":"V-Model/Service Points/CC&B","description":"Service points are a physical location (usually meter connection socket) at which a company supplies service.  Devices are installed at service points, and the relationship between individual service points and devices can change over time."},{"name":"V-Model/Service Points/MDM","description":"Service points are a physical location (usually meter connection socket) at which a company supplies service that can be used to store information describing the type of service supplied and how it is measured."},{"name":"V-Model/Usage Subscription","description":"A Usage Subscription is an ongoing request to send one or more Service Points' usage detail to one or more external systems. The Usage Subscription defines which usage calculation group should be used to calculate Service Quantities (often referred to as bill determinants).\nUsage subscriptions must reference a:\nService Provider: The service provider is used as the identity of the subscribing system."},{"name":"V-Model/V Model Relationships"}],"paths":{"/spl/rest/apis/customer/v-model/accounts":{"post":{"summary":"Create Account","description":"This operation handles the Integration Suite API to Create Account","operationId":"createAccount","tags":["V-Model/Account"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CREATEACCOUNT_request"}},"application/xml":{"schema":{"$ref":"#/components/schemas/CREATEACCOUNT_request"}}}},"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CREATEACCOUNT_response"}},"application/xml":{"schema":{"$ref":"#/components/schemas/CREATEACCOUNT_response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}}},"x-internal-id":"https:--server:port-spl-rest-apis-customer-v-model-accounts--post","x-filename-id":"https-server-port-spl-rest-apis-customer-v-model-accounts-post"}},"/spl/rest/apis/customer/v-model/accounts/{accountId}":{"delete":{"summary":"Delete Account","description":"This operation handles the Integration Suite API to Delete Account","operationId":"deleteAccount","parameters":[{"in":"path","name":"accountId","required":true,"schema":{"type":"string"}}],"tags":["V-Model/Account"],"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DELETEACCOUNT_response"}},"application/xml":{"schema":{"$ref":"#/components/schemas/DELETEACCOUNT_response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}}},"x-internal-id":"https:--server:port-spl-rest-apis-customer-v-model-accounts-{accountId}-delete","x-filename-id":"https-server-port-spl-rest-apis-customer-v-model-accounts-accountid-delete"},"get":{"summary":"Get Account","description":"This operation handles the Integration Suite API to Get Account","operationId":"getAccount","parameters":[{"in":"path","name":"accountId","required":true,"schema":{"type":"string"}}],"tags":["V-Model/Account"],"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GETACCOUNT_response"}},"application/xml":{"schema":{"$ref":"#/components/schemas/GETACCOUNT_response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}}},"x-internal-id":"https:--server:port-spl-rest-apis-customer-v-model-accounts-{accountId}-get","x-filename-id":"https-server-port-spl-rest-apis-customer-v-model-accounts-accountid-get"},"put":{"summary":"Update Account","description":"This operation handles the Integration Suite API to Update Account","operationId":"updateAccount","parameters":[{"in":"path","name":"accountId","required":true,"schema":{"type":"string"}}],"tags":["V-Model/Account"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UPDATEACCOUNT_request"}},"application/xml":{"schema":{"$ref":"#/components/schemas/UPDATEACCOUNT_request"}}}},"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UPDATEACCOUNT_response"}},"application/xml":{"schema":{"$ref":"#/components/schemas/UPDATEACCOUNT_response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}}},"x-internal-id":"https:--server:port-spl-rest-apis-customer-v-model-accounts-{accountId}-put","x-filename-id":"https-server-port-spl-rest-apis-customer-v-model-accounts-accountid-put"}},"/spl/rest/apis/customer/v-model/premises":{"post":{"summary":"Create Premise","description":"This Operation handles the Integration Suite API to Create Premise.","operationId":"createPremise","tags":["V-Model/Premise"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CREATEPREMISE_request"}},"application/xml":{"schema":{"$ref":"#/components/schemas/CREATEPREMISE_request"}}}},"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CREATEPREMISE_response"}},"application/xml":{"schema":{"$ref":"#/components/schemas/CREATEPREMISE_response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}}},"x-internal-id":"https:--server:port-spl-rest-apis-customer-v-model-premises--post","x-filename-id":"https-server-port-spl-rest-apis-customer-v-model-premises-post"}},"/spl/rest/apis/customer/v-model/premises/{premiseId}":{"put":{"summary":"Update Premise","description":"This Operation handles the Integration Suite API to Update Premise .","operationId":"updatePremise","parameters":[{"in":"path","name":"premiseId","required":true,"schema":{"type":"string"}}],"tags":["V-Model/Premise"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UPDATEPREMISE_request"}},"application/xml":{"schema":{"$ref":"#/components/schemas/UPDATEPREMISE_request"}}}},"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UPDATEPREMISE_response"}},"application/xml":{"schema":{"$ref":"#/components/schemas/UPDATEPREMISE_response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}}},"x-internal-id":"https:--server:port-spl-rest-apis-customer-v-model-premises-{premiseId}-put","x-filename-id":"https-server-port-spl-rest-apis-customer-v-model-premises-premiseid-put"},"get":{"summary":"Get Premise","description":"This Operation handles the Integration Suite API to Get Premise .","operationId":"getPremise","parameters":[{"in":"path","name":"premiseId","required":true,"schema":{"type":"string"}}],"tags":["V-Model/Premise"],"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GETPREMISE_response"}},"application/xml":{"schema":{"$ref":"#/components/schemas/GETPREMISE_response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}}},"x-internal-id":"https:--server:port-spl-rest-apis-customer-v-model-premises-{premiseId}-get","x-filename-id":"https-server-port-spl-rest-apis-customer-v-model-premises-premiseid-get"},"delete":{"summary":"Delete Premise","description":"This Operation handles the Integration Suite API to Delete Premise.","operationId":"deletePremise","parameters":[{"in":"path","name":"premiseId","required":true,"schema":{"type":"string"}}],"tags":["V-Model/Premise"],"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DELETEPREMISE_response"}},"application/xml":{"schema":{"$ref":"#/components/schemas/DELETEPREMISE_response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}}},"x-internal-id":"https:--server:port-spl-rest-apis-customer-v-model-premises-{premiseId}-delete","x-filename-id":"https-server-port-spl-rest-apis-customer-v-model-premises-premiseid-delete"}},"/spl/rest/apis/customer/financials/payPlans":{"post":{"summary":"Create Pay Plan","description":"","operationId":"createPayPlan","tags":["Financial Transactions/Pay Plan"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CREATEPAYPLAN_request"}},"application/xml":{"schema":{"$ref":"#/components/schemas/CREATEPAYPLAN_request"}}}},"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CREATEPAYPLAN_response"}},"application/xml":{"schema":{"$ref":"#/components/schemas/CREATEPAYPLAN_response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}}},"x-internal-id":"https:--server:port-spl-rest-apis-customer-financials-payPlans--post","x-filename-id":"https-server-port-spl-rest-apis-customer-financials-payplans-post"}},"/spl/rest/apis/customer/financials/payPlans/{payPlanId}":{"put":{"summary":"Update Pay Plan","description":"","operationId":"updatePayPlan","parameters":[{"in":"path","name":"payPlanId","required":true,"schema":{"type":"string"}}],"tags":["Financial Transactions/Pay Plan"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UPDATEPAYPLAN_request"}},"application/xml":{"schema":{"$ref":"#/components/schemas/UPDATEPAYPLAN_request"}}}},"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UPDATEPAYPLAN_response"}},"application/xml":{"schema":{"$ref":"#/components/schemas/UPDATEPAYPLAN_response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}}},"x-internal-id":"https:--server:port-spl-rest-apis-customer-financials-payPlans-{payPlanId}-put","x-filename-id":"https-server-port-spl-rest-apis-customer-financials-payplans-payplanid-put"},"get":{"summary":"Get Pay Plan","description":"","operationId":"getPayPlan","parameters":[{"in":"path","name":"payPlanId","required":true,"schema":{"type":"string"}}],"tags":["Financial Transactions/Pay Plan"],"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GETPAYPLAN_response"}},"application/xml":{"schema":{"$ref":"#/components/schemas/GETPAYPLAN_response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}}},"x-internal-id":"https:--server:port-spl-rest-apis-customer-financials-payPlans-{payPlanId}-get","x-filename-id":"https-server-port-spl-rest-apis-customer-financials-payplans-payplanid-get"}},"/spl/rest/apis/customer/financials/accountFinancialHistory/{accountId}":{"get":{"summary":"Get Account Financial History","description":"This operation handles the Integration Suite API to Get Account Financial History","operationId":"getAccountFinancialHistory","parameters":[{"in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"in":"query","name":"limit","required":false,"schema":{"type":"number"}},{"in":"query","name":"offset","required":false,"schema":{"type":"number"}},{"in":"query","name":"searchBy","required":false,"schema":{"type":"string"}}],"tags":["Financial Transactions/Account Financial History"],"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GETACCOUNTFINANCIALHISTORY_response"}},"application/xml":{"schema":{"$ref":"#/components/schemas/GETACCOUNTFINANCIALHISTORY_response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}}},"x-internal-id":"https:--server:port-spl-rest-apis-customer-financials-accountFinancialHistory-{accountId}-get","x-filename-id":"https-server-port-spl-rest-apis-customer-financials-accountfinancialhistory-accountid-get"}},"/spl/rest/apis/customer/financials/adjustments/{adjustmentId}":{"patch":{"summary":"Action Adjustment","description":"","operationId":"actionAdjustment","parameters":[{"in":"path","name":"adjustmentId","required":true,"schema":{"type":"string"}},{"in":"query","name":"name","required":false,"schema":{"type":"string"}}],"tags":["Financial Transactions/Adjustment"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ACTIONADJUSTMENT_request"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ACTIONADJUSTMENT_request"}}}},"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ACTIONADJUSTMENT_response"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ACTIONADJUSTMENT_response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}}},"x-internal-id":"https:--server:port-spl-rest-apis-customer-financials-adjustments-{adjustmentId}-patch","x-filename-id":"https-server-port-spl-rest-apis-customer-financials-adjustments-adjustmentid-patch"},"put":{"summary":"Update Adjustment","description":"","operationId":"updateAdjustment","parameters":[{"in":"path","name":"adjustmentId","required":true,"schema":{"type":"string"}}],"tags":["Financial Transactions/Adjustment"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UPDATEADJUSTMENT_request"}},"application/xml":{"schema":{"$ref":"#/components/schemas/UPDATEADJUSTMENT_request"}}}},"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UPDATEADJUSTMENT_response"}},"application/xml":{"schema":{"$ref":"#/components/schemas/UPDATEADJUSTMENT_response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}}},"x-internal-id":"https:--server:port-spl-rest-apis-customer-financials-adjustments-{adjustmentId}-put","x-filename-id":"https-server-port-spl-rest-apis-customer-financials-adjustments-adjustmentid-put"},"get":{"summary":"Get Adjustment","description":"","operationId":"getAdjustment","parameters":[{"in":"path","name":"adjustmentId","required":true,"schema":{"type":"string"}}],"tags":["Financial Transactions/Adjustment"],"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GETADJUSTMENT_response"}},"application/xml":{"schema":{"$ref":"#/components/schemas/GETADJUSTMENT_response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}}},"x-internal-id":"https:--server:port-spl-rest-apis-customer-financials-adjustments-{adjustmentId}-get","x-filename-id":"https-server-port-spl-rest-apis-customer-financials-adjustments-adjustmentid-get"},"delete":{"summary":"Delete Adjustment","description":"","operationId":"deleteAdjustment","parameters":[{"in":"path","name":"adjustmentId","required":true,"schema":{"type":"string"}}],"tags":["Financial Transactions/Adjustment"],"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DELETEADJUSTMENT_response"}},"application/xml":{"schema":{"$ref":"#/components/schemas/DELETEADJUSTMENT_response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}}},"x-internal-id":"https:--server:port-spl-rest-apis-customer-financials-adjustments-{adjustmentId}-delete","x-filename-id":"https-server-port-spl-rest-apis-customer-financials-adjustments-adjustmentid-delete"}},"/spl/rest/apis/customer/financials/adjustments":{"post":{"summary":"Create Adjustment","description":"","operationId":"craeteAdjustment","tags":["Financial Transactions/Adjustment"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CRAETEADJUSTMENT_request"}},"application/xml":{"schema":{"$ref":"#/components/schemas/CRAETEADJUSTMENT_request"}}}},"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CRAETEADJUSTMENT_response"}},"application/xml":{"schema":{"$ref":"#/components/schemas/CRAETEADJUSTMENT_response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}}},"x-internal-id":"https:--server:port-spl-rest-apis-customer-financials-adjustments--post","x-filename-id":"https-server-port-spl-rest-apis-customer-financials-adjustments-post"}},"/spl/rest/apis/customer/financials/budgets/{accountId}":{"get":{"summary":"Get Budget","description":"","operationId":"getBudget","parameters":[{"in":"path","name":"accountId","required":true,"schema":{"type":"string"}}],"tags":["Financial Transactions/Budget"],"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GETBUDGET_response"}},"application/xml":{"schema":{"$ref":"#/components/schemas/GETBUDGET_response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}}},"x-internal-id":"https:--server:port-spl-rest-apis-customer-financials-budgets-{accountId}-get","x-filename-id":"https-server-port-spl-rest-apis-customer-financials-budgets-accountid-get"}},"/spl/rest/apis/customer/financials/budgets/{accountId}/action":{"patch":{"summary":"Action Budget","description":"","operationId":"actionBudget","parameters":[{"in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"in":"query","name":"name","required":false,"schema":{"type":"string"}}],"tags":["Financial Transactions/Budget"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ACTIONBUDGET_request"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ACTIONBUDGET_request"}}}},"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ACTIONBUDGET_response"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ACTIONBUDGET_response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}}},"x-internal-id":"https:--server:port-spl-rest-apis-customer-financials-budgets-{accountId}-action-patch","x-filename-id":"https-server-port-spl-rest-apis-customer-financials-budgets-accountid-action-patch"}},"/spl/rest/apis/customer/interactions/cases/{caseId}/action":{"patch":{"summary":"Action Case","description":"This script handles the Integration Suite API to Action Case Operation of the C1-Case REST service.","operationId":"actionCase","parameters":[{"in":"path","name":"caseId","required":true,"schema":{"type":"string"}},{"in":"query","name":"name","required":false,"schema":{"type":"string"}}],"tags":["Interactions/Case"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ACTIONCASE_request"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ACTIONCASE_request"}}}},"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ACTIONCASE_response"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ACTIONCASE_response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}}},"x-internal-id":"https:--server:port-spl-rest-apis-customer-interactions-cases-{caseId}-action-patch","x-filename-id":"https-server-port-spl-rest-apis-customer-interactions-cases-caseid-action-patch"}},"/spl/rest/apis/customer/interactions/cases":{"post":{"summary":"Create Case","description":"This Operation handles the Integration Suite API to Create Case Operation of the C1-Case REST service.","operationId":"createCase","tags":["Interactions/Case"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CREATECASE_request"}},"application/xml":{"schema":{"$ref":"#/components/schemas/CREATECASE_request"}}}},"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CREATECASE_response"}},"application/xml":{"schema":{"$ref":"#/components/schemas/CREATECASE_response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}}},"x-internal-id":"https:--server:port-spl-rest-apis-customer-interactions-cases--post","x-filename-id":"https-server-port-spl-rest-apis-customer-interactions-cases-post"}},"/spl/rest/apis/customer/interactions/cases/{caseId}":{"put":{"summary":"Update Case","description":"This Operation handles the Integration Suite API to Update Case Operation of the C1-Case REST service.","operationId":"updateCase","parameters":[{"in":"path","name":"caseId","required":true,"schema":{"type":"string"}}],"tags":["Interactions/Case"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UPDATECASE_request"}},"application/xml":{"schema":{"$ref":"#/components/schemas/UPDATECASE_request"}}}},"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UPDATECASE_response"}},"application/xml":{"schema":{"$ref":"#/components/schemas/UPDATECASE_response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}}},"x-internal-id":"https:--server:port-spl-rest-apis-customer-interactions-cases-{caseId}-put","x-filename-id":"https-server-port-spl-rest-apis-customer-interactions-cases-caseid-put"},"get":{"summary":"Get Case","description":"This Operation handles the Integration Suite API to Get Case Operation of the C1-Case REST service.","operationId":"getCase","parameters":[{"in":"path","name":"caseId","required":true,"schema":{"type":"string"}}],"tags":["Interactions/Case"],"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GETCASE_response"}},"application/xml":{"schema":{"$ref":"#/components/schemas/GETCASE_response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}}},"x-internal-id":"https:--server:port-spl-rest-apis-customer-interactions-cases-{caseId}-get","x-filename-id":"https-server-port-spl-rest-apis-customer-interactions-cases-caseid-get"},"delete":{"summary":"Delete Case","description":"This script handles the Integration Suite API to Delete Case Operation of the C1-Case REST service.","operationId":"deleteCase","parameters":[{"in":"path","name":"caseId","required":true,"schema":{"type":"string"}}],"tags":["Interactions/Case"],"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DELETECASE_response"}},"application/xml":{"schema":{"$ref":"#/components/schemas/DELETECASE_response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}}},"x-internal-id":"https:--server:port-spl-rest-apis-customer-interactions-cases-{caseId}-delete","x-filename-id":"https-server-port-spl-rest-apis-customer-interactions-cases-caseid-delete"}},"/spl/rest/apis/customer/interactions/cases/search/case":{"get":{"summary":"Search Case","description":"","operationId":"searchCase","parameters":[{"in":"query","name":"accountId","required":false,"schema":{"type":"string"}},{"in":"query","name":"limit","required":false,"schema":{"type":"number"}},{"in":"query","name":"offset","required":false,"schema":{"type":"number"}},{"in":"query","name":"personId","required":false,"schema":{"type":"string"}},{"in":"query","name":"premiseId","required":false,"schema":{"type":"string"}}],"tags":["Interactions/Case"],"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SEARCHCASE_response"}},"application/xml":{"schema":{"$ref":"#/components/schemas/SEARCHCASE_response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}}},"x-internal-id":"https:--server:port-spl-rest-apis-customer-interactions-cases-search-case-get","x-filename-id":"https-server-port-spl-rest-apis-customer-interactions-cases-search-case-get"}},"/ouaf/rest/apis/meter/v-model/servicePoints":{"post":{"summary":"Create Service Point","description":"This Operation handles the Integration Suite API to Create Service Point.","operationId":"createServicePoint","tags":["V-Model/Service Points/MDM"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CREATESERVICEPOINT_request"}},"application/xml":{"schema":{"$ref":"#/components/schemas/CREATESERVICEPOINT_request"}}}},"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CREATESERVICEPOINT_response"}},"application/xml":{"schema":{"$ref":"#/components/schemas/CREATESERVICEPOINT_response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}}},"x-internal-id":"https:--server:port-ouaf-rest-apis-meter-v-model-servicePoints--post","x-filename-id":"https-server-port-ouaf-rest-apis-meter-v-model-servicepoints-post"}},"/ouaf/rest/apis/meter/v-model/servicePoints/{servicePointId}":{"put":{"summary":"Update Service Point","description":"This operation handles the Integration Suite API to Update Service Point.","operationId":"updateServicePoint","parameters":[{"in":"path","name":"servicePointId","required":true,"schema":{"type":"string"}}],"tags":["V-Model/Service Points/MDM"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UPDATESERVICEPOINT_request"}},"application/xml":{"schema":{"$ref":"#/components/schemas/UPDATESERVICEPOINT_request"}}}},"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UPDATESERVICEPOINT_response"}},"application/xml":{"schema":{"$ref":"#/components/schemas/UPDATESERVICEPOINT_response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}}},"x-internal-id":"https:--server:port-ouaf-rest-apis-meter-v-model-servicePoints-{servicePointId}-put","x-filename-id":"https-server-port-ouaf-rest-apis-meter-v-model-servicepoints-servicepointid-put"},"get":{"summary":"Get Service Point","description":"This Operation handles the Integration Suite API to Get Service Point","operationId":"getServicePoint","parameters":[{"in":"path","name":"servicePointId","required":true,"schema":{"type":"string"}}],"tags":["V-Model/Service Points/MDM"],"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GETSERVICEPOINT_response"}},"application/xml":{"schema":{"$ref":"#/components/schemas/GETSERVICEPOINT_response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}}},"x-internal-id":"https:--server:port-ouaf-rest-apis-meter-v-model-servicePoints-{servicePointId}-get","x-filename-id":"https-server-port-ouaf-rest-apis-meter-v-model-servicepoints-servicepointid-get"},"delete":{"summary":"Delete Service Point","description":"This script handles the Integration Suite API to Delete Service Point Operation of the D1-ServicePoint REST service.\n\nNote: All REST services that are in the Integration Suite Web Service Categories require the related Integration Suite add-on product option to use.","operationId":"deleteServicePoint","parameters":[{"in":"path","name":"servicePointId","required":true,"schema":{"type":"string"}}],"tags":["V-Model/Service Points/MDM"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DELETESERVICEPOINT_request"}},"application/xml":{"schema":{"$ref":"#/components/schemas/DELETESERVICEPOINT_request"}}}},"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DELETESERVICEPOINT_response"}},"application/xml":{"schema":{"$ref":"#/components/schemas/DELETESERVICEPOINT_response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}}},"x-internal-id":"https:--server:port-ouaf-rest-apis-meter-v-model-servicePoints-{servicePointId}-delete","x-filename-id":"https-server-port-ouaf-rest-apis-meter-v-model-servicepoints-servicepointid-delete"}},"/spl/rest/apis/customer/v-model/cxPersons/{cxContactId}":{"put":{"summary":"Sync Person","description":"","operationId":"syncPerson","parameters":[{"in":"path","name":"cxContactId","required":true,"schema":{"type":"string"}}],"tags":["V-Model/Person Information Synchronization"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SYNCPERSON_request"}},"application/xml":{"schema":{"$ref":"#/components/schemas/SYNCPERSON_request"}}}},"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SYNCPERSON_response"}},"application/xml":{"schema":{"$ref":"#/components/schemas/SYNCPERSON_response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}}},"x-internal-id":"https:--server:port-spl-rest-apis-customer-v-model-cxPersons-{cxContactId}-put","x-filename-id":"https-server-port-spl-rest-apis-customer-v-model-cxpersons-cxcontactid-put"}},"/spl/rest/apis/customer/interactions/customerActivityHistory/{accountId}":{"get":{"summary":"Get Customer Activity History","description":"","operationId":"getCustomerActivityHistory","parameters":[{"in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"in":"query","name":"fromDateTime","required":true,"schema":{"type":"string"}},{"in":"query","name":"limit","required":false,"schema":{"type":"number"}},{"in":"query","name":"toDateTime","required":true,"schema":{"type":"string"}}],"tags":["Interactions/Customer Activity History"],"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GETCUSTOMERACTIVITYHISTORY_response"}},"application/xml":{"schema":{"$ref":"#/components/schemas/GETCUSTOMERACTIVITYHISTORY_response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}}},"x-internal-id":"https:--server:port-spl-rest-apis-customer-interactions-customerActivityHistory-{accountId}-get","x-filename-id":"https-server-port-spl-rest-apis-customer-interactions-customeractivityhistory-accountid-get"}},"/spl/rest/apis/customer/service/workQueue":{"get":{"summary":"Get Work Queue","description":"This operation handles the Integration Suite API to Get Work Queue","operationId":"getWorkQueue","tags":["Service/Work Queue"],"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GETWORKQUEUE_response"}},"application/xml":{"schema":{"$ref":"#/components/schemas/GETWORKQUEUE_response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}}},"x-internal-id":"https:--server:port-spl-rest-apis-customer-service-workQueue--get","x-filename-id":"https-server-port-spl-rest-apis-customer-service-workqueue-get"}},"/spl/rest/apis/customer/v-model/communicationsPreferences/{accountId}/{personId}":{"get":{"summary":"Get Communications Preferences","description":"","operationId":"getCommunicationsPreferences","parameters":[{"in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"in":"path","name":"personId","required":true,"schema":{"type":"string"}}],"tags":["V-Model/Communications Preferences"],"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GETCOMMUNICATIONSPREFERENCES_response"}},"application/xml":{"schema":{"$ref":"#/components/schemas/GETCOMMUNICATIONSPREFERENCES_response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}}},"x-internal-id":"https:--server:port-spl-rest-apis-customer-v-model-communicationsPreferences-{accountId}-{personId}-get","x-filename-id":"https-server-port-spl-rest-apis-customer-v-model-communicationspreferences-accountid-personid-get"},"patch":{"summary":"Patch Communications Preferences","description":"","operationId":"patchCommunicationsPreferences","parameters":[{"in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"in":"path","name":"personId","required":true,"schema":{"type":"string"}}],"tags":["V-Model/Communications Preferences"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PATCHCOMMUNICATIONSPREFERENCES_request"}},"application/xml":{"schema":{"$ref":"#/components/schemas/PATCHCOMMUNICATIONSPREFERENCES_request"}}}},"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PATCHCOMMUNICATIONSPREFERENCES_response"}},"application/xml":{"schema":{"$ref":"#/components/schemas/PATCHCOMMUNICATIONSPREFERENCES_response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}}},"x-internal-id":"https:--server:port-spl-rest-apis-customer-v-model-communicationsPreferences-{accountId}-{personId}-patch","x-filename-id":"https-server-port-spl-rest-apis-customer-v-model-communicationspreferences-accountid-personid-patch"}},"/spl/rest/apis/customer/v-model/communicationsPreferences/{accountId}/{personId}/addresses":{"patch":{"summary":"Update Mailing Address","description":"","operationId":"updateMailingAddresses","parameters":[{"in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"in":"path","name":"personId","required":true,"schema":{"type":"string"}}],"tags":["V-Model/Communications Preferences"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UPDATEMAILINGADDRESSES_request"}},"application/xml":{"schema":{"$ref":"#/components/schemas/UPDATEMAILINGADDRESSES_request"}}}},"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UPDATEMAILINGADDRESSES_response"}},"application/xml":{"schema":{"$ref":"#/components/schemas/UPDATEMAILINGADDRESSES_response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}}},"x-internal-id":"https:--server:port-spl-rest-apis-customer-v-model-communicationsPreferences-{accountId}-{personId}-addresses-patch","x-filename-id":"https-server-port-spl-rest-apis-customer-v-model-communicationspreferences-accountid-personid-addresses-patch"},"get":{"summary":"Get Mailing Addresses","description":"","operationId":"getMailingAddresses","parameters":[{"in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"in":"path","name":"personId","required":true,"schema":{"type":"string"}}],"tags":["V-Model/Communications Preferences"],"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GETMAILINGADDRESSES_response"}},"application/xml":{"schema":{"$ref":"#/components/schemas/GETMAILINGADDRESSES_response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}}},"x-internal-id":"https:--server:port-spl-rest-apis-customer-v-model-communicationsPreferences-{accountId}-{personId}-addresses-get","x-filename-id":"https-server-port-spl-rest-apis-customer-v-model-communicationspreferences-accountid-personid-addresses-get"}},"/spl/rest/apis/customer/financials/bills/{billId}/action":{"patch":{"summary":"Action Bill","description":"This Operation handles the Integration Suite API to Action Bill.\n\n\n\nNote: All REST services that are in the Integration Suite APIs Web Service Categories require the related Integration Suite add-on product option to use.","operationId":"actionBill","parameters":[{"in":"path","name":"billId","required":true,"schema":{"type":"string"}},{"in":"query","name":"name","required":false,"schema":{"type":"string"}}],"tags":["Financial Transactions/Bill"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ACTIONBILL_request"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ACTIONBILL_request"}}}},"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ACTIONBILL_response"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ACTIONBILL_response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}}},"x-internal-id":"https:--server:port-spl-rest-apis-customer-financials-bills-{billId}-action-patch","x-filename-id":"https-server-port-spl-rest-apis-customer-financials-bills-billid-action-patch"}},"/spl/rest/apis/customer/financials/bills":{"post":{"summary":"Create Bill","description":"This operation handles the Integration Suite API to Create Bill.","operationId":"createBill","tags":["Financial Transactions/Bill"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CREATEBILL_request"}},"application/xml":{"schema":{"$ref":"#/components/schemas/CREATEBILL_request"}}}},"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CREATEBILL_response"}},"application/xml":{"schema":{"$ref":"#/components/schemas/CREATEBILL_response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}}},"x-internal-id":"https:--server:port-spl-rest-apis-customer-financials-bills--post","x-filename-id":"https-server-port-spl-rest-apis-customer-financials-bills-post"}},"/spl/rest/apis/customer/financials/bills/{billId}":{"put":{"summary":"Update Bill","description":"This Operation handles the Integration Suite API to Update Bill .","operationId":"updateBill","parameters":[{"in":"path","name":"billId","required":true,"schema":{"type":"string"}}],"tags":["Financial Transactions/Bill"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UPDATEBILL_request"}},"application/xml":{"schema":{"$ref":"#/components/schemas/UPDATEBILL_request"}}}},"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UPDATEBILL_response"}},"application/xml":{"schema":{"$ref":"#/components/schemas/UPDATEBILL_response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}}},"x-internal-id":"https:--server:port-spl-rest-apis-customer-financials-bills-{billId}-put","x-filename-id":"https-server-port-spl-rest-apis-customer-financials-bills-billid-put"},"get":{"summary":"Get Bill","description":"This Operation  handles the Integration Suite API to Get Bill","operationId":"getBill","parameters":[{"in":"path","name":"billId","required":true,"schema":{"type":"string"}}],"tags":["Financial Transactions/Bill"],"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GETBILL_response"}},"application/xml":{"schema":{"$ref":"#/components/schemas/GETBILL_response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}}},"x-internal-id":"https:--server:port-spl-rest-apis-customer-financials-bills-{billId}-get","x-filename-id":"https-server-port-spl-rest-apis-customer-financials-bills-billid-get"},"delete":{"summary":"Delete Bill","description":"This Operation handles the Integration Suite API to Delete Bill.","operationId":"deleteBill","parameters":[{"in":"path","name":"billId","required":true,"schema":{"type":"string"}}],"tags":["Financial Transactions/Bill"],"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DELETEBILL_response"}},"application/xml":{"schema":{"$ref":"#/components/schemas/DELETEBILL_response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}}},"x-internal-id":"https:--server:port-spl-rest-apis-customer-financials-bills-{billId}-delete","x-filename-id":"https-server-port-spl-rest-apis-customer-financials-bills-billid-delete"}},"/spl/rest/apis/customer/v-model/serviceAgreements":{"post":{"summary":"Create Service Agreement","description":"This Operation handles the Integration Suite API to Create Service Agreement.","operationId":"createServiceAgreement","tags":["V-Model/Service Agreement"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CREATESERVICEAGREEMENT_request"}},"application/xml":{"schema":{"$ref":"#/components/schemas/CREATESERVICEAGREEMENT_request"}}}},"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CREATESERVICEAGREEMENT_response"}},"application/xml":{"schema":{"$ref":"#/components/schemas/CREATESERVICEAGREEMENT_response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}}},"x-internal-id":"https:--server:port-spl-rest-apis-customer-v-model-serviceAgreements--post","x-filename-id":"https-server-port-spl-rest-apis-customer-v-model-serviceagreements-post"}},"/spl/rest/apis/customer/v-model/serviceAgreements/{serviceAgreementId}":{"put":{"summary":"Update Service Agreement","description":"This Operation handles the Integration Suite API to Update Service Agreement.","operationId":"updateServiceAgreement","parameters":[{"in":"path","name":"serviceAgreementId","required":true,"schema":{"type":"string"}}],"tags":["V-Model/Service Agreement"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UPDATESERVICEAGREEMENT_request"}},"application/xml":{"schema":{"$ref":"#/components/schemas/UPDATESERVICEAGREEMENT_request"}}}},"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UPDATESERVICEAGREEMENT_response"}},"application/xml":{"schema":{"$ref":"#/components/schemas/UPDATESERVICEAGREEMENT_response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}}},"x-internal-id":"https:--server:port-spl-rest-apis-customer-v-model-serviceAgreements-{serviceAgreementId}-put","x-filename-id":"https-server-port-spl-rest-apis-customer-v-model-serviceagreements-serviceagreementid-put"},"get":{"summary":"Get Service Agreement","description":"This Operation handles the Integration Suite API to Get Service Agreement.","operationId":"getServiceAgreement","parameters":[{"in":"path","name":"serviceAgreementId","required":true,"schema":{"type":"string"}}],"tags":["V-Model/Service Agreement"],"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GETSERVICEAGREEMENT_response"}},"application/xml":{"schema":{"$ref":"#/components/schemas/GETSERVICEAGREEMENT_response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}}},"x-internal-id":"https:--server:port-spl-rest-apis-customer-v-model-serviceAgreements-{serviceAgreementId}-get","x-filename-id":"https-server-port-spl-rest-apis-customer-v-model-serviceagreements-serviceagreementid-get"},"delete":{"summary":"Delete Service Agreement","description":"This script handles the Integration Suite API to Delete Service Agreement  Operation of the C1-ServiceAgreement REST service.\n\nNote: All REST services that are in the Integration Suite APIs Web Service Categories require the related Integration Suite add-on product option to use.","operationId":"deleteServiceAgreement","parameters":[{"in":"path","name":"serviceAgreementId","required":true,"schema":{"type":"string"}}],"tags":["V-Model/Service Agreement"],"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DELETESERVICEAGREEMENT_response"}},"application/xml":{"schema":{"$ref":"#/components/schemas/DELETESERVICEAGREEMENT_response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}}},"x-internal-id":"https:--server:port-spl-rest-apis-customer-v-model-serviceAgreements-{serviceAgreementId}-delete","x-filename-id":"https-server-port-spl-rest-apis-customer-v-model-serviceagreements-serviceagreementid-delete"}},"/ouaf/rest/apis/meter/devices/items":{"post":{"summary":"Create Item","description":"This Operation handles the Integration Suite API to Create Item","operationId":"createItem","tags":["Devices/Item"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CREATEITEM_request"}},"application/xml":{"schema":{"$ref":"#/components/schemas/CREATEITEM_request"}}}},"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CREATEITEM_response"}},"application/xml":{"schema":{"$ref":"#/components/schemas/CREATEITEM_response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}}},"x-internal-id":"https:--server:port-ouaf-rest-apis-meter-devices-items--post","x-filename-id":"https-server-port-ouaf-rest-apis-meter-devices-items-post"}},"/ouaf/rest/apis/meter/devices/items/{itemId}":{"put":{"summary":"Update Item","description":"This operation handles the Integration Suite API to Update Item","operationId":"updateItem","parameters":[{"in":"path","name":"itemId","required":true,"schema":{"type":"string"}}],"tags":["Devices/Item"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UPDATEITEM_request"}},"application/xml":{"schema":{"$ref":"#/components/schemas/UPDATEITEM_request"}}}},"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UPDATEITEM_response"}},"application/xml":{"schema":{"$ref":"#/components/schemas/UPDATEITEM_response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}}},"x-internal-id":"https:--server:port-ouaf-rest-apis-meter-devices-items-{itemId}-put","x-filename-id":"https-server-port-ouaf-rest-apis-meter-devices-items-itemid-put"},"get":{"summary":"Get Item","description":"This Operation handles the Integration Suite API to Get Item.","operationId":"getItem","parameters":[{"in":"path","name":"itemId","required":true,"schema":{"type":"string"}}],"tags":["Devices/Item"],"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GETITEM_response"}},"application/xml":{"schema":{"$ref":"#/components/schemas/GETITEM_response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}}},"x-internal-id":"https:--server:port-ouaf-rest-apis-meter-devices-items-{itemId}-get","x-filename-id":"https-server-port-ouaf-rest-apis-meter-devices-items-itemid-get"},"delete":{"summary":"Delete Item","description":"This script handles the Integration Suite API to Delete Item Operation of the D1-Item REST service.\n\nNote: All REST services that are in the Integration Suite Web Service Categories require the related Integration Suite add-on product option to use.","operationId":"deleteItem","parameters":[{"in":"path","name":"itemId","required":true,"schema":{"type":"string"}}],"tags":["Devices/Item"],"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DELETEITEM_response"}},"application/xml":{"schema":{"$ref":"#/components/schemas/DELETEITEM_response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}}},"x-internal-id":"https:--server:port-ouaf-rest-apis-meter-devices-items-{itemId}-delete","x-filename-id":"https-server-port-ouaf-rest-apis-meter-devices-items-itemid-delete"}},"/ouaf/rest/apis/meter/devices/meters":{"post":{"summary":"Create Meter","description":"This script handles the Integration Suite API to Create Meter Operation","operationId":"createMeter","tags":["Devices/Meter"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CREATEMETER_request"}},"application/xml":{"schema":{"$ref":"#/components/schemas/CREATEMETER_request"}}}},"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CREATEMETER_response"}},"application/xml":{"schema":{"$ref":"#/components/schemas/CREATEMETER_response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}}},"x-internal-id":"https:--server:port-ouaf-rest-apis-meter-devices-meters--post","x-filename-id":"https-server-port-ouaf-rest-apis-meter-devices-meters-post"}},"/ouaf/rest/apis/meter/devices/meters/{meterId}":{"put":{"summary":"Update Meter","description":"This script handles the Integration Suite API to Update Meter","operationId":"updateMeter","parameters":[{"in":"path","name":"meterId","required":true,"schema":{"type":"string"}}],"tags":["Devices/Meter"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UPDATEMETER_request"}},"application/xml":{"schema":{"$ref":"#/components/schemas/UPDATEMETER_request"}}}},"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UPDATEMETER_response"}},"application/xml":{"schema":{"$ref":"#/components/schemas/UPDATEMETER_response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}}},"x-internal-id":"https:--server:port-ouaf-rest-apis-meter-devices-meters-{meterId}-put","x-filename-id":"https-server-port-ouaf-rest-apis-meter-devices-meters-meterid-put"},"get":{"summary":"Get Meter Details","description":"This script handles the Integration Suite API to Get Meter Details","operationId":"getMeter","parameters":[{"in":"query","name":"expand","required":false,"schema":{"type":"string"}},{"in":"path","name":"meterId","required":true,"schema":{"type":"string"}}],"tags":["Devices/Meter"],"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GETMETER_response"}},"application/xml":{"schema":{"$ref":"#/components/schemas/GETMETER_response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}}},"x-internal-id":"https:--server:port-ouaf-rest-apis-meter-devices-meters-{meterId}-get","x-filename-id":"https-server-port-ouaf-rest-apis-meter-devices-meters-meterid-get"},"delete":{"summary":"Delete Meter","description":"This script handles the Integration Suite API to Delete Meter","operationId":"deleteMeter","parameters":[{"in":"path","name":"meterId","required":true,"schema":{"type":"string"}}],"tags":["Devices/Meter"],"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DELETEMETER_response"}},"application/xml":{"schema":{"$ref":"#/components/schemas/DELETEMETER_response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}}},"x-internal-id":"https:--server:port-ouaf-rest-apis-meter-devices-meters-{meterId}-delete","x-filename-id":"https-server-port-ouaf-rest-apis-meter-devices-meters-meterid-delete"}},"/spl/rest/apis/customer/v-model/servicePoints":{"post":{"summary":"Create Service Point","description":"This Operation handles the Integration Suite API to Create Service Point.","operationId":"createServicePoint","tags":["V-Model/Service Points/CC&B"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CREATESERVICEPOINT_request"}},"application/xml":{"schema":{"$ref":"#/components/schemas/CREATESERVICEPOINT_request"}}}},"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CREATESERVICEPOINT_response"}},"application/xml":{"schema":{"$ref":"#/components/schemas/CREATESERVICEPOINT_response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}}},"x-internal-id":"https:--server:port-spl-rest-apis-customer-v-model-servicePoints--post","x-filename-id":"https-server-port-spl-rest-apis-customer-v-model-servicepoints-post"}},"/spl/rest/apis/customer/v-model/servicePoints/{servicePointId}":{"put":{"summary":"Update Service Point","description":"This Operation handles the Integration Suite API to Update Service Point.","operationId":"updateServicePoint","parameters":[{"in":"path","name":"servicePointId","required":true,"schema":{"type":"string"}}],"tags":["V-Model/Service Points/CC&B"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UPDATESERVICEPOINT_request"}},"application/xml":{"schema":{"$ref":"#/components/schemas/UPDATESERVICEPOINT_request"}}}},"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UPDATESERVICEPOINT_response"}},"application/xml":{"schema":{"$ref":"#/components/schemas/UPDATESERVICEPOINT_response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}}},"x-internal-id":"https:--server:port-spl-rest-apis-customer-v-model-servicePoints-{servicePointId}-put","x-filename-id":"https-server-port-spl-rest-apis-customer-v-model-servicepoints-servicepointid-put"},"get":{"summary":"Get Service Point","description":"This Operation handles the Integration Suite API to Get Service Point.","operationId":"getServicePoint","parameters":[{"in":"path","name":"servicePointId","required":true,"schema":{"type":"string"}}],"tags":["V-Model/Service Points/CC&B"],"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GETSERVICEPOINT_response"}},"application/xml":{"schema":{"$ref":"#/components/schemas/GETSERVICEPOINT_response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}}},"x-internal-id":"https:--server:port-spl-rest-apis-customer-v-model-servicePoints-{servicePointId}-get","x-filename-id":"https-server-port-spl-rest-apis-customer-v-model-servicepoints-servicepointid-get"},"delete":{"summary":"Delete Service Point","description":"This script handles the Integration Suite API to Delete Service Point Operation of the C1-ServicePoint REST service.\n\nNote: All REST services that are in the Integration Suite APIs Web Service Categories require the related Integration Suite add-on product option to use.","operationId":"deleteServicePoint","parameters":[{"in":"path","name":"servicePointId","required":true,"schema":{"type":"string"}}],"tags":["V-Model/Service Points/CC&B"],"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DELETESERVICEPOINT_response"}},"application/xml":{"schema":{"$ref":"#/components/schemas/DELETESERVICEPOINT_response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}}},"x-internal-id":"https:--server:port-spl-rest-apis-customer-v-model-servicePoints-{servicePointId}-delete","x-filename-id":"https-server-port-spl-rest-apis-customer-v-model-servicepoints-servicepointid-delete"}},"/spl/rest/apis/customer/financials/billSegments/{billSegmentId}/action":{"patch":{"summary":"Action Bill Segment","description":"This operation handles the Integration Suite API to Action Bill Segment.","operationId":"actionBillSegment","parameters":[{"in":"path","name":"billSegmentId","required":true,"schema":{"type":"string"}},{"in":"query","name":"name","required":false,"schema":{"type":"string"}}],"tags":["Financial Transactions/Bill Segment"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ACTIONBILLSEGMENT_request"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ACTIONBILLSEGMENT_request"}}}},"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ACTIONBILLSEGMENT_response"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ACTIONBILLSEGMENT_response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}}},"x-internal-id":"https:--server:port-spl-rest-apis-customer-financials-billSegments-{billSegmentId}-action-patch","x-filename-id":"https-server-port-spl-rest-apis-customer-financials-billsegments-billsegmentid-action-patch"}},"/spl/rest/apis/customer/financials/billSegments":{"post":{"summary":"Create Bill Segment","description":"This operation handles the Integration Suite API to Create Bill Segment.","operationId":"createBillSegment","tags":["Financial Transactions/Bill Segment"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CREATEBILLSEGMENT_request"}},"application/xml":{"schema":{"$ref":"#/components/schemas/CREATEBILLSEGMENT_request"}}}},"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CREATEBILLSEGMENT_response"}},"application/xml":{"schema":{"$ref":"#/components/schemas/CREATEBILLSEGMENT_response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}}},"x-internal-id":"https:--server:port-spl-rest-apis-customer-financials-billSegments--post","x-filename-id":"https-server-port-spl-rest-apis-customer-financials-billsegments-post"}},"/spl/rest/apis/customer/financials/billSegments/{billSegmentId}":{"put":{"summary":"Update Bill Segment","description":"This operation handles the Integration Suite API to Update Bill Segment.","operationId":"updateBillSegment","parameters":[{"in":"path","name":"billSegmentId","required":true,"schema":{"type":"string"}}],"tags":["Financial Transactions/Bill Segment"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UPDATEBILLSEGMENT_request"}},"application/xml":{"schema":{"$ref":"#/components/schemas/UPDATEBILLSEGMENT_request"}}}},"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UPDATEBILLSEGMENT_response"}},"application/xml":{"schema":{"$ref":"#/components/schemas/UPDATEBILLSEGMENT_response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}}},"x-internal-id":"https:--server:port-spl-rest-apis-customer-financials-billSegments-{billSegmentId}-put","x-filename-id":"https-server-port-spl-rest-apis-customer-financials-billsegments-billsegmentid-put"},"get":{"summary":"Get Bill Segment","description":"This operation handles the Integration Suite API to Get Bill Segment.","operationId":"getBillSegment","parameters":[{"in":"path","name":"billSegmentId","required":true,"schema":{"type":"string"}}],"tags":["Financial Transactions/Bill Segment"],"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GETBILLSEGMENT_response"}},"application/xml":{"schema":{"$ref":"#/components/schemas/GETBILLSEGMENT_response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}}},"x-internal-id":"https:--server:port-spl-rest-apis-customer-financials-billSegments-{billSegmentId}-get","x-filename-id":"https-server-port-spl-rest-apis-customer-financials-billsegments-billsegmentid-get"},"delete":{"summary":"Delete Bill Segment","description":"This operation handles the Integration Suite API to Delete Bill Segment.","operationId":"deleteBillSegment","parameters":[{"in":"path","name":"billSegmentId","required":true,"schema":{"type":"string"}}],"tags":["Financial Transactions/Bill Segment"],"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DELETEBILLSEGMENT_response"}},"application/xml":{"schema":{"$ref":"#/components/schemas/DELETEBILLSEGMENT_response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}}},"x-internal-id":"https:--server:port-spl-rest-apis-customer-financials-billSegments-{billSegmentId}-delete","x-filename-id":"https-server-port-spl-rest-apis-customer-financials-billsegments-billsegmentid-delete"}},"/spl/rest/apis/customer/v-model/personContext/{personId}":{"get":{"summary":"Get Person Context","description":"","operationId":"getPersonContext","parameters":[{"in":"path","name":"personId","required":true,"schema":{"type":"string"}}],"tags":["V-Model/Person Context"],"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GETPERSONCONTEXT_response"}},"application/xml":{"schema":{"$ref":"#/components/schemas/GETPERSONCONTEXT_response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}}},"x-internal-id":"https:--server:port-spl-rest-apis-customer-v-model-personContext-{personId}-get","x-filename-id":"https-server-port-spl-rest-apis-customer-v-model-personcontext-personid-get"}},"/ouaf/rest/apis/meter/devices/deviceConfigurations":{"post":{"summary":"create Device Configuration","description":"This operation handles the Integration Suite API to Update Device Configuration Operation of the D1-DeviceConfiguration REST service.","operationId":"createDeviceConfiguration","tags":["Devices/Device Configurations"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CREATEDEVICECONFIGURATION_request"}},"application/xml":{"schema":{"$ref":"#/components/schemas/CREATEDEVICECONFIGURATION_request"}}}},"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CREATEDEVICECONFIGURATION_response"}},"application/xml":{"schema":{"$ref":"#/components/schemas/CREATEDEVICECONFIGURATION_response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}}},"x-internal-id":"https:--server:port-ouaf-rest-apis-meter-devices-deviceConfigurations--post","x-filename-id":"https-server-port-ouaf-rest-apis-meter-devices-deviceconfigurations-post"}},"/ouaf/rest/apis/meter/devices/deviceConfigurations/{deviceConfigurationId}":{"put":{"summary":"Update Device Configuration","description":"This operation handles the Integration Suite API to Update Device Configuration Operation of the D1-DeviceConfiguration REST service.","operationId":"updateDeviceConfiguration","parameters":[{"in":"path","name":"deviceConfigurationId","required":true,"schema":{"type":"string"}}],"tags":["Devices/Device Configurations"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UPDATEDEVICECONFIGURATION_request"}},"application/xml":{"schema":{"$ref":"#/components/schemas/UPDATEDEVICECONFIGURATION_request"}}}},"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UPDATEDEVICECONFIGURATION_response"}},"application/xml":{"schema":{"$ref":"#/components/schemas/UPDATEDEVICECONFIGURATION_response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}}},"x-internal-id":"https:--server:port-ouaf-rest-apis-meter-devices-deviceConfigurations-{deviceConfigurationId}-put","x-filename-id":"https-server-port-ouaf-rest-apis-meter-devices-deviceconfigurations-deviceconfigurationid-put"},"get":{"summary":"Get Device Configuration","description":"This operation handles the Integration Suite API to Get Device Configuration Operation of the D1-DeviceConfiguration REST service.","operationId":"getDeviceConfiguration","parameters":[{"in":"path","name":"deviceConfigurationId","required":true,"schema":{"type":"string"}}],"tags":["Devices/Device Configurations"],"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GETDEVICECONFIGURATION_response"}},"application/xml":{"schema":{"$ref":"#/components/schemas/GETDEVICECONFIGURATION_response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}}},"x-internal-id":"https:--server:port-ouaf-rest-apis-meter-devices-deviceConfigurations-{deviceConfigurationId}-get","x-filename-id":"https-server-port-ouaf-rest-apis-meter-devices-deviceconfigurations-deviceconfigurationid-get"},"delete":{"summary":"Delete Device Configuration","description":"This operation handles the Integration Suite API to delete Device Configuration Operation of the D1-DeviceConfiguration REST service.","operationId":"deleteDeviceConfiguration","parameters":[{"in":"path","name":"deviceConfigurationId","required":true,"schema":{"type":"string"}}],"tags":["Devices/Device Configurations"],"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DELETEDEVICECONFIGURATION_response"}},"application/xml":{"schema":{"$ref":"#/components/schemas/DELETEDEVICECONFIGURATION_response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}}},"x-internal-id":"https:--server:port-ouaf-rest-apis-meter-devices-deviceConfigurations-{deviceConfigurationId}-delete","x-filename-id":"https-server-port-ouaf-rest-apis-meter-devices-deviceconfigurations-deviceconfigurationid-delete"}},"/ouaf/rest/apis/meter/v-model/installEvents":{"post":{"summary":"Create Install Event","description":"This Operation handles the Integration Suite API to Create Install Event","operationId":"createInstallEvent","tags":["V-Model/Install Events"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CREATEINSTALLEVENT_request"}},"application/xml":{"schema":{"$ref":"#/components/schemas/CREATEINSTALLEVENT_request"}}}},"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CREATEINSTALLEVENT_response"}},"application/xml":{"schema":{"$ref":"#/components/schemas/CREATEINSTALLEVENT_response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}}},"x-internal-id":"https:--server:port-ouaf-rest-apis-meter-v-model-installEvents--post","x-filename-id":"https-server-port-ouaf-rest-apis-meter-v-model-installevents-post"}},"/ouaf/rest/apis/meter/v-model/installEvents/{installEventId}":{"put":{"summary":"Update Install Event Details","description":"This Operation handles the Integration Suite API to Update Install Event","operationId":"updateInstallEvent","parameters":[{"in":"path","name":"installEventId","required":true,"schema":{"type":"string"}}],"tags":["V-Model/Install Events"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UPDATEINSTALLEVENT_request"}},"application/xml":{"schema":{"$ref":"#/components/schemas/UPDATEINSTALLEVENT_request"}}}},"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UPDATEINSTALLEVENT_response"}},"application/xml":{"schema":{"$ref":"#/components/schemas/UPDATEINSTALLEVENT_response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}}},"x-internal-id":"https:--server:port-ouaf-rest-apis-meter-v-model-installEvents-{installEventId}-put","x-filename-id":"https-server-port-ouaf-rest-apis-meter-v-model-installevents-installeventid-put"},"get":{"summary":"Get Install Event","description":"This Operation  handles the Integration Suite API to Get Install Event","operationId":"getInstallEvent","parameters":[{"in":"path","name":"installEventId","required":true,"schema":{"type":"string"}}],"tags":["V-Model/Install Events"],"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GETINSTALLEVENT_response"}},"application/xml":{"schema":{"$ref":"#/components/schemas/GETINSTALLEVENT_response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}}},"x-internal-id":"https:--server:port-ouaf-rest-apis-meter-v-model-installEvents-{installEventId}-get","x-filename-id":"https-server-port-ouaf-rest-apis-meter-v-model-installevents-installeventid-get"},"delete":{"summary":"Delete Install Event Details","description":"This script handles the Integration Suite API to Delete Install Event Operation of the D1-InstallEvent REST service.\n\nNote: All REST services that are in the Integration Suite Web Service Categories require the related Integration Suite add-on product option to use.","operationId":"deleteInstallEvent","parameters":[{"in":"path","name":"installEventId","required":true,"schema":{"type":"string"}}],"tags":["V-Model/Install Events"],"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DELETEINSTALLEVENT_response"}},"application/xml":{"schema":{"$ref":"#/components/schemas/DELETEINSTALLEVENT_response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}}},"x-internal-id":"https:--server:port-ouaf-rest-apis-meter-v-model-installEvents-{installEventId}-delete","x-filename-id":"https-server-port-ouaf-rest-apis-meter-v-model-installevents-installeventid-delete"}},"/spl/rest/apis/cross/v-model/servicePoints":{"post":{"summary":"Create Service Point","description":"This Operation handles the Integration Suite API to Create Service Point.","operationId":"createServicePoint","tags":["V-Model/Service Points/C2M"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CREATESERVICEPOINT_request"}},"application/xml":{"schema":{"$ref":"#/components/schemas/CREATESERVICEPOINT_request"}}}},"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CREATESERVICEPOINT_response"}},"application/xml":{"schema":{"$ref":"#/components/schemas/CREATESERVICEPOINT_response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}}},"x-internal-id":"https:--server:port-spl-rest-apis-cross-v-model-servicePoints--post","x-filename-id":"https-server-port-spl-rest-apis-cross-v-model-servicepoints-post"}},"/spl/rest/apis/cross/v-model/servicePoints/{servicePointId}":{"put":{"summary":"Update Service Point","description":"This Operation handles the Integration Suite API to Update Service Point","operationId":"updateServicePoint","parameters":[{"in":"path","name":"servicePointId","required":true,"schema":{"type":"string"}}],"tags":["V-Model/Service Points/C2M"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UPDATESERVICEPOINT_request"}},"application/xml":{"schema":{"$ref":"#/components/schemas/UPDATESERVICEPOINT_request"}}}},"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UPDATESERVICEPOINT_response"}},"application/xml":{"schema":{"$ref":"#/components/schemas/UPDATESERVICEPOINT_response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}}},"x-internal-id":"https:--server:port-spl-rest-apis-cross-v-model-servicePoints-{servicePointId}-put","x-filename-id":"https-server-port-spl-rest-apis-cross-v-model-servicepoints-servicepointid-put"},"get":{"summary":"Get Service Point","description":"This Operation handles the Integration Suite API to Get Service Point","operationId":"getServicePoint","parameters":[{"in":"path","name":"servicePointId","required":true,"schema":{"type":"string"}}],"tags":["V-Model/Service Points/C2M"],"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GETSERVICEPOINT_response"}},"application/xml":{"schema":{"$ref":"#/components/schemas/GETSERVICEPOINT_response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}}},"x-internal-id":"https:--server:port-spl-rest-apis-cross-v-model-servicePoints-{servicePointId}-get","x-filename-id":"https-server-port-spl-rest-apis-cross-v-model-servicepoints-servicepointid-get"},"delete":{"summary":"Delete Service Point","description":"This script handles the Integration Suite API to Delete Service Point Operation of the X1-ServicePoint REST service.\n\nNote: All REST services that are in the Integration Suite APIs Web Service Categories require the related Integration Suite add-on product option to use.","operationId":"deleteServicePoint","parameters":[{"in":"path","name":"servicePointId","required":true,"schema":{"type":"string"}}],"tags":["V-Model/Service Points/C2M"],"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DELETESERVICEPOINT_response"}},"application/xml":{"schema":{"$ref":"#/components/schemas/DELETESERVICEPOINT_response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}}},"x-internal-id":"https:--server:port-spl-rest-apis-cross-v-model-servicePoints-{servicePointId}-delete","x-filename-id":"https-server-port-spl-rest-apis-cross-v-model-servicepoints-servicepointid-delete"}},"/spl/rest/apis/cross/v-model/vModelRelationships/{accountId}":{"get":{"summary":"Get V Model Relationship","description":"This Operation handles the Integration Suite API to Get V Model Relationship.","operationId":"getVModelRelationships","parameters":[{"in":"path","name":"accountId","required":true,"schema":{"type":"string"}}],"tags":["V-Model/V Model Relationships"],"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GETVMODELRELATIONSHIPS_response"}},"application/xml":{"schema":{"$ref":"#/components/schemas/GETVMODELRELATIONSHIPS_response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}}},"x-internal-id":"https:--server:port-spl-rest-apis-cross-v-model-vModelRelationships-{accountId}-get","x-filename-id":"https-server-port-spl-rest-apis-cross-v-model-vmodelrelationships-accountid-get"}},"/spl/rest/apis/cross/v-model/businessPersonQueries":{"post":{"summary":"Business Person Summary","description":"","operationId":"businessesSummary","tags":["V-Model/Business Person Queries"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BUSINESSESSUMMARY_request"}},"application/xml":{"schema":{"$ref":"#/components/schemas/BUSINESSESSUMMARY_request"}}}},"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BUSINESSESSUMMARY_response"}},"application/xml":{"schema":{"$ref":"#/components/schemas/BUSINESSESSUMMARY_response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}}},"x-internal-id":"https:--server:port-spl-rest-apis-cross-v-model-businessPersonQueries--post","x-filename-id":"https-server-port-spl-rest-apis-cross-v-model-businesspersonqueries-post"}},"/spl/rest/apis/cross/v-model/businessPersonQueries/personSearch":{"post":{"summary":"Business Person Search","description":"","operationId":"businessPersonSearch","tags":["V-Model/Business Person Queries"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BUSINESSPERSONSEARCH_request"}},"application/xml":{"schema":{"$ref":"#/components/schemas/BUSINESSPERSONSEARCH_request"}}}},"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BUSINESSPERSONSEARCH_response"}},"application/xml":{"schema":{"$ref":"#/components/schemas/BUSINESSPERSONSEARCH_response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}}},"x-internal-id":"https:--server:port-spl-rest-apis-cross-v-model-businessPersonQueries-personSearch-post","x-filename-id":"https-server-port-spl-rest-apis-cross-v-model-businesspersonqueries-personsearch-post"}},"/ouaf/rest/apis/meter/v-model/usageSubscriptions":{"post":{"summary":"Create Usage Subscription","description":"This Operation handles the Integration Suite API to Create Usage Subscription.","operationId":"createUsageSubscription","tags":["V-Model/Usage Subscription"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CREATEUSAGESUBSCRIPTION_request"}},"application/xml":{"schema":{"$ref":"#/components/schemas/CREATEUSAGESUBSCRIPTION_request"}}}},"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CREATEUSAGESUBSCRIPTION_response"}},"application/xml":{"schema":{"$ref":"#/components/schemas/CREATEUSAGESUBSCRIPTION_response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}}},"x-internal-id":"https:--server:port-ouaf-rest-apis-meter-v-model-usageSubscriptions--post","x-filename-id":"https-server-port-ouaf-rest-apis-meter-v-model-usagesubscriptions-post"}},"/ouaf/rest/apis/meter/v-model/usageSubscriptions/{usageSubscriptionId}":{"put":{"summary":"Update Usage Subscription","description":"This Operation handles the Integration Suite API to Update Usage Subscription.","operationId":"updateUsageSubscription","parameters":[{"in":"path","name":"usageSubscriptionId","required":true,"schema":{"type":"string"}}],"tags":["V-Model/Usage Subscription"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UPDATEUSAGESUBSCRIPTION_request"}},"application/xml":{"schema":{"$ref":"#/components/schemas/UPDATEUSAGESUBSCRIPTION_request"}}}},"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UPDATEUSAGESUBSCRIPTION_response"}},"application/xml":{"schema":{"$ref":"#/components/schemas/UPDATEUSAGESUBSCRIPTION_response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}}},"x-internal-id":"https:--server:port-ouaf-rest-apis-meter-v-model-usageSubscriptions-{usageSubscriptionId}-put","x-filename-id":"https-server-port-ouaf-rest-apis-meter-v-model-usagesubscriptions-usagesubscriptionid-put"},"get":{"summary":"Get Usage Subscription","description":"This Operation  handles the Integration Suite API to Get Usage Subscription.","operationId":"getUsageSubscription","parameters":[{"in":"path","name":"usageSubscriptionId","required":true,"schema":{"type":"string"}}],"tags":["V-Model/Usage Subscription"],"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GETUSAGESUBSCRIPTION_response"}},"application/xml":{"schema":{"$ref":"#/components/schemas/GETUSAGESUBSCRIPTION_response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}}},"x-internal-id":"https:--server:port-ouaf-rest-apis-meter-v-model-usageSubscriptions-{usageSubscriptionId}-get","x-filename-id":"https-server-port-ouaf-rest-apis-meter-v-model-usagesubscriptions-usagesubscriptionid-get"},"delete":{"summary":"Delete Usage Subscription","description":"This script handles the Integration Suite API to Delete Usage Subscription Operation of the D1-UsageSubscription REST service.\n\nNote: All REST services that are in the Integration Suite APIs Web Service Categories require the related Integration Suite add-on product option to use.","operationId":"deleteUsageSubscription","parameters":[{"in":"path","name":"usageSubscriptionId","required":true,"schema":{"type":"string"}}],"tags":["V-Model/Usage Subscription"],"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DELETEUSAGESUBSCRIPTION_response"}},"application/xml":{"schema":{"$ref":"#/components/schemas/DELETEUSAGESUBSCRIPTION_response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}}},"x-internal-id":"https:--server:port-ouaf-rest-apis-meter-v-model-usageSubscriptions-{usageSubscriptionId}-delete","x-filename-id":"https-server-port-ouaf-rest-apis-meter-v-model-usagesubscriptions-usagesubscriptionid-delete"}},"/ouaf/rest/apis/meter/devices/measuringComponents":{"post":{"summary":"Create Measuring Component","description":"","operationId":"createMeasuringComponent","tags":["Devices/Measuring Component"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CREATEMEASURINGCOMPONENT_request"}},"application/xml":{"schema":{"$ref":"#/components/schemas/CREATEMEASURINGCOMPONENT_request"}}}},"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CREATEMEASURINGCOMPONENT_response"}},"application/xml":{"schema":{"$ref":"#/components/schemas/CREATEMEASURINGCOMPONENT_response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}}},"x-internal-id":"https:--server:port-ouaf-rest-apis-meter-devices-measuringComponents--post","x-filename-id":"https-server-port-ouaf-rest-apis-meter-devices-measuringcomponents-post"}},"/ouaf/rest/apis/meter/devices/measuringComponents/{measuringComponentId}":{"put":{"summary":"Update Measuring Component","description":"","operationId":"updateMeasuringComponent","parameters":[{"in":"path","name":"measuringComponentId","required":true,"schema":{"type":"string"}}],"tags":["Devices/Measuring Component"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UPDATEMEASURINGCOMPONENT_request"}},"application/xml":{"schema":{"$ref":"#/components/schemas/UPDATEMEASURINGCOMPONENT_request"}}}},"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UPDATEMEASURINGCOMPONENT_response"}},"application/xml":{"schema":{"$ref":"#/components/schemas/UPDATEMEASURINGCOMPONENT_response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}}},"x-internal-id":"https:--server:port-ouaf-rest-apis-meter-devices-measuringComponents-{measuringComponentId}-put","x-filename-id":"https-server-port-ouaf-rest-apis-meter-devices-measuringcomponents-measuringcomponentid-put"},"get":{"summary":"Get Measuring Component","description":"","operationId":"getMeasuringComponent","parameters":[{"in":"path","name":"measuringComponentId","required":true,"schema":{"type":"string"}}],"tags":["Devices/Measuring Component"],"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GETMEASURINGCOMPONENT_response"}},"application/xml":{"schema":{"$ref":"#/components/schemas/GETMEASURINGCOMPONENT_response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}}},"x-internal-id":"https:--server:port-ouaf-rest-apis-meter-devices-measuringComponents-{measuringComponentId}-get","x-filename-id":"https-server-port-ouaf-rest-apis-meter-devices-measuringcomponents-measuringcomponentid-get"},"delete":{"summary":"Delete Measuring Component","description":"","operationId":"deleteMeasuringComponent","parameters":[{"in":"path","name":"measuringComponentId","required":true,"schema":{"type":"string"}}],"tags":["Devices/Measuring Component"],"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DELETEMEASURINGCOMPONENT_response"}},"application/xml":{"schema":{"$ref":"#/components/schemas/DELETEMEASURINGCOMPONENT_response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}}},"x-internal-id":"https:--server:port-ouaf-rest-apis-meter-devices-measuringComponents-{measuringComponentId}-delete","x-filename-id":"https-server-port-ouaf-rest-apis-meter-devices-measuringcomponents-measuringcomponentid-delete"}},"/spl/rest/apis/customer/collections/overdueProcesses/{overdueProcessId}/action":{"patch":{"summary":"Action  Overdue Process","description":"","operationId":"actionOverdueProcess","parameters":[{"in":"query","name":"name","required":false,"schema":{"type":"string"}},{"in":"path","name":"overdueProcessId","required":true,"schema":{"type":"string"}}],"tags":["Credit & Collections/Overdue Process"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ACTIONOVERDUEPROCESS_request"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ACTIONOVERDUEPROCESS_request"}}}},"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ACTIONOVERDUEPROCESS_response"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ACTIONOVERDUEPROCESS_response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}}},"x-internal-id":"https:--server:port-spl-rest-apis-customer-collections-overdueProcesses-{overdueProcessId}-action-patch","x-filename-id":"https-server-port-spl-rest-apis-customer-collections-overdueprocesses-overdueprocessid-action-patch"}},"/spl/rest/apis/customer/collections/overdueProcesses/{overdueProcessId}":{"put":{"summary":"Update  Overdue Process","description":"","operationId":"updateOverdueProcess","parameters":[{"in":"path","name":"overdueProcessId","required":true,"schema":{"type":"string"}}],"tags":["Credit & Collections/Overdue Process"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UPDATEOVERDUEPROCESS_request"}},"application/xml":{"schema":{"$ref":"#/components/schemas/UPDATEOVERDUEPROCESS_request"}}}},"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UPDATEOVERDUEPROCESS_response"}},"application/xml":{"schema":{"$ref":"#/components/schemas/UPDATEOVERDUEPROCESS_response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}}},"x-internal-id":"https:--server:port-spl-rest-apis-customer-collections-overdueProcesses-{overdueProcessId}-put","x-filename-id":"https-server-port-spl-rest-apis-customer-collections-overdueprocesses-overdueprocessid-put"},"get":{"summary":"Get Overdue Process","description":"","operationId":"getOverdueProcess","parameters":[{"in":"path","name":"overdueProcessId","required":true,"schema":{"type":"string"}}],"tags":["Credit & Collections/Overdue Process"],"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GETOVERDUEPROCESS_response"}},"application/xml":{"schema":{"$ref":"#/components/schemas/GETOVERDUEPROCESS_response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}}},"x-internal-id":"https:--server:port-spl-rest-apis-customer-collections-overdueProcesses-{overdueProcessId}-get","x-filename-id":"https-server-port-spl-rest-apis-customer-collections-overdueprocesses-overdueprocessid-get"}},"/spl/rest/apis/customer/collections/overdueProcesses":{"post":{"summary":"Create  Overdue Process","description":"","operationId":"createOverdueProcess","tags":["Credit & Collections/Overdue Process"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CREATEOVERDUEPROCESS_request"}},"application/xml":{"schema":{"$ref":"#/components/schemas/CREATEOVERDUEPROCESS_request"}}}},"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CREATEOVERDUEPROCESS_response"}},"application/xml":{"schema":{"$ref":"#/components/schemas/CREATEOVERDUEPROCESS_response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}}},"x-internal-id":"https:--server:port-spl-rest-apis-customer-collections-overdueProcesses--post","x-filename-id":"https-server-port-spl-rest-apis-customer-collections-overdueprocesses-post"}},"/spl/rest/apis/customer/collections/writeoffProcesses":{"post":{"summary":"Create Write Off Process","description":"","operationId":"createWriteOffProcess","tags":["Credit & Collections/Write Off Process"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CREATEWRITEOFFPROCESS_request"}},"application/xml":{"schema":{"$ref":"#/components/schemas/CREATEWRITEOFFPROCESS_request"}}}},"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CREATEWRITEOFFPROCESS_response"}},"application/xml":{"schema":{"$ref":"#/components/schemas/CREATEWRITEOFFPROCESS_response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}}},"x-internal-id":"https:--server:port-spl-rest-apis-customer-collections-writeoffProcesses--post","x-filename-id":"https-server-port-spl-rest-apis-customer-collections-writeoffprocesses-post"}},"/spl/rest/apis/customer/collections/writeoffProcesses/{writeOffProcessId}":{"put":{"summary":"Update Write Off Process","description":"","operationId":"updateWriteOffProcess","parameters":[{"in":"path","name":"writeOffProcessId","required":true,"schema":{"type":"string"}}],"tags":["Credit & Collections/Write Off Process"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UPDATEWRITEOFFPROCESS_request"}},"application/xml":{"schema":{"$ref":"#/components/schemas/UPDATEWRITEOFFPROCESS_request"}}}},"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UPDATEWRITEOFFPROCESS_response"}},"application/xml":{"schema":{"$ref":"#/components/schemas/UPDATEWRITEOFFPROCESS_response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}}},"x-internal-id":"https:--server:port-spl-rest-apis-customer-collections-writeoffProcesses-{writeOffProcessId}-put","x-filename-id":"https-server-port-spl-rest-apis-customer-collections-writeoffprocesses-writeoffprocessid-put"},"get":{"summary":"Get Write Off Process","description":"","operationId":"getWriteOffProcess","parameters":[{"in":"path","name":"writeOffProcessId","required":true,"schema":{"type":"string"}}],"tags":["Credit & Collections/Write Off Process"],"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GETWRITEOFFPROCESS_response"}},"application/xml":{"schema":{"$ref":"#/components/schemas/GETWRITEOFFPROCESS_response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}}},"x-internal-id":"https:--server:port-spl-rest-apis-customer-collections-writeoffProcesses-{writeOffProcessId}-get","x-filename-id":"https-server-port-spl-rest-apis-customer-collections-writeoffprocesses-writeoffprocessid-get"}},"/spl/rest/apis/customer/collections/collectionProcesss":{"post":{"summary":"Create collection Process","description":"","operationId":"createCollectionProcess","tags":["Credit & Collections/Collection Process"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CREATECOLLECTIONPROCESS_request"}},"application/xml":{"schema":{"$ref":"#/components/schemas/CREATECOLLECTIONPROCESS_request"}}}},"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CREATECOLLECTIONPROCESS_response"}},"application/xml":{"schema":{"$ref":"#/components/schemas/CREATECOLLECTIONPROCESS_response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}}},"x-internal-id":"https:--server:port-spl-rest-apis-customer-collections-collectionProcesss--post","x-filename-id":"https-server-port-spl-rest-apis-customer-collections-collectionprocesss-post"}},"/spl/rest/apis/customer/collections/collectionProcesss/{collectionProcessId}":{"put":{"summary":"Update Collection Process","description":"","operationId":"updateCollectionProcess","parameters":[{"in":"path","name":"collectionProcessId","required":true,"schema":{"type":"string"}}],"tags":["Credit & Collections/Collection Process"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UPDATECOLLECTIONPROCESS_request"}},"application/xml":{"schema":{"$ref":"#/components/schemas/UPDATECOLLECTIONPROCESS_request"}}}},"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UPDATECOLLECTIONPROCESS_response"}},"application/xml":{"schema":{"$ref":"#/components/schemas/UPDATECOLLECTIONPROCESS_response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}}},"x-internal-id":"https:--server:port-spl-rest-apis-customer-collections-collectionProcesss-{collectionProcessId}-put","x-filename-id":"https-server-port-spl-rest-apis-customer-collections-collectionprocesss-collectionprocessid-put"},"get":{"summary":"Get Collection Process","description":"","operationId":"getCollectionProcess","parameters":[{"in":"path","name":"collectionProcessId","required":true,"schema":{"type":"string"}}],"tags":["Credit & Collections/Collection Process"],"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GETCOLLECTIONPROCESS_response"}},"application/xml":{"schema":{"$ref":"#/components/schemas/GETCOLLECTIONPROCESS_response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}}},"x-internal-id":"https:--server:port-spl-rest-apis-customer-collections-collectionProcesss-{collectionProcessId}-get","x-filename-id":"https-server-port-spl-rest-apis-customer-collections-collectionprocesss-collectionprocessid-get"}},"/spl/rest/apis/customer/collections/severanceProcesses":{"post":{"summary":"Create Severance Process","description":"","operationId":"createSeveranceProcess","tags":["Credit & Collections/Severance Process"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CREATESEVERANCEPROCESS_request"}},"application/xml":{"schema":{"$ref":"#/components/schemas/CREATESEVERANCEPROCESS_request"}}}},"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CREATESEVERANCEPROCESS_response"}},"application/xml":{"schema":{"$ref":"#/components/schemas/CREATESEVERANCEPROCESS_response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}}},"x-internal-id":"https:--server:port-spl-rest-apis-customer-collections-severanceProcesses--post","x-filename-id":"https-server-port-spl-rest-apis-customer-collections-severanceprocesses-post"}},"/spl/rest/apis/customer/collections/severanceProcesses/{severanceProcessId}":{"put":{"summary":"Update Severance Process","description":"","operationId":"updateSeveranceProcess","parameters":[{"in":"path","name":"severanceProcessId","required":true,"schema":{"type":"string"}}],"tags":["Credit & Collections/Severance Process"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UPDATESEVERANCEPROCESS_request"}},"application/xml":{"schema":{"$ref":"#/components/schemas/UPDATESEVERANCEPROCESS_request"}}}},"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UPDATESEVERANCEPROCESS_response"}},"application/xml":{"schema":{"$ref":"#/components/schemas/UPDATESEVERANCEPROCESS_response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}}},"x-internal-id":"https:--server:port-spl-rest-apis-customer-collections-severanceProcesses-{severanceProcessId}-put","x-filename-id":"https-server-port-spl-rest-apis-customer-collections-severanceprocesses-severanceprocessid-put"},"get":{"summary":"Get Severance Process","description":"","operationId":"getSeveranceProcess","parameters":[{"in":"path","name":"severanceProcessId","required":true,"schema":{"type":"string"}}],"tags":["Credit & Collections/Severance Process"],"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GETSEVERANCEPROCESS_response"}},"application/xml":{"schema":{"$ref":"#/components/schemas/GETSEVERANCEPROCESS_response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}}},"x-internal-id":"https:--server:port-spl-rest-apis-customer-collections-severanceProcesses-{severanceProcessId}-get","x-filename-id":"https-server-port-spl-rest-apis-customer-collections-severanceprocesses-severanceprocessid-get"}},"/spl/rest/apis/customer/v-model/landlordAgreements":{"post":{"summary":"Create Landlord Agreement","description":"This script handles the Integration Suite API to Create Landlord Agreement .","operationId":"createLandlordAgreement","tags":["V-Model/Landlord Agreements"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CREATELANDLORDAGREEMENT_request"}},"application/xml":{"schema":{"$ref":"#/components/schemas/CREATELANDLORDAGREEMENT_request"}}}},"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CREATELANDLORDAGREEMENT_response"}},"application/xml":{"schema":{"$ref":"#/components/schemas/CREATELANDLORDAGREEMENT_response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}}},"x-internal-id":"https:--server:port-spl-rest-apis-customer-v-model-landlordAgreements--post","x-filename-id":"https-server-port-spl-rest-apis-customer-v-model-landlordagreements-post"}},"/spl/rest/apis/customer/v-model/landlordAgreements/{landLordId}":{"put":{"summary":"Update Landlord Agreement","description":"This script handles the Integration Suite API to Update Landlord Agreement","operationId":"updateLandlordAgreement","parameters":[{"in":"path","name":"landLordId","required":true,"schema":{"type":"string"}}],"tags":["V-Model/Landlord Agreements"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UPDATELANDLORDAGREEMENT_request"}},"application/xml":{"schema":{"$ref":"#/components/schemas/UPDATELANDLORDAGREEMENT_request"}}}},"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UPDATELANDLORDAGREEMENT_response"}},"application/xml":{"schema":{"$ref":"#/components/schemas/UPDATELANDLORDAGREEMENT_response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}}},"x-internal-id":"https:--server:port-spl-rest-apis-customer-v-model-landlordAgreements-{landLordId}-put","x-filename-id":"https-server-port-spl-rest-apis-customer-v-model-landlordagreements-landlordid-put"},"get":{"summary":"Get Landlord Agreement","description":"","operationId":"getLandlordAgreement","parameters":[{"in":"path","name":"landLordId","required":true,"schema":{"type":"string"}}],"tags":["V-Model/Landlord Agreements"],"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GETLANDLORDAGREEMENT_response"}},"application/xml":{"schema":{"$ref":"#/components/schemas/GETLANDLORDAGREEMENT_response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}}},"x-internal-id":"https:--server:port-spl-rest-apis-customer-v-model-landlordAgreements-{landLordId}-get","x-filename-id":"https-server-port-spl-rest-apis-customer-v-model-landlordagreements-landlordid-get"},"delete":{"summary":"Delete Landlord Agreement","description":"This script handles the Integration Suite API to Delete Person Operation","operationId":"deleteLandlordAgreement","parameters":[{"in":"path","name":"landLordId","required":true,"schema":{"type":"string"}}],"tags":["V-Model/Landlord Agreements"],"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DELETELANDLORDAGREEMENT_response"}},"application/xml":{"schema":{"$ref":"#/components/schemas/DELETELANDLORDAGREEMENT_response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}}},"x-internal-id":"https:--server:port-spl-rest-apis-customer-v-model-landlordAgreements-{landLordId}-delete","x-filename-id":"https-server-port-spl-rest-apis-customer-v-model-landlordagreements-landlordid-delete"}},"/spl/rest/apis/cross/v-model/programContexts/{accountId}/{personId}":{"get":{"summary":"Get Program Contexts","description":"This Operation handles the Integration Suite API to Get Program Contexts.","operationId":"getProgramContexts","parameters":[{"in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"in":"path","name":"personId","required":true,"schema":{"type":"string"}}],"tags":["V-Model/Program Context"],"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GETPROGRAMCONTEXTS_response"}},"application/xml":{"schema":{"$ref":"#/components/schemas/GETPROGRAMCONTEXTS_response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}}},"x-internal-id":"https:--server:port-spl-rest-apis-cross-v-model-programContexts-{accountId}-{personId}-get","x-filename-id":"https-server-port-spl-rest-apis-cross-v-model-programcontexts-accountid-personid-get"}},"/spl/rest/apis/customer/service/webUsers":{"post":{"summary":"Create Web User","description":"This operation handles the Integration Suite API to Create Web User","operationId":"createWebUser","tags":["Service/Web User"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CREATEWEBUSER_request"}},"application/xml":{"schema":{"$ref":"#/components/schemas/CREATEWEBUSER_request"}}}},"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CREATEWEBUSER_response"}},"application/xml":{"schema":{"$ref":"#/components/schemas/CREATEWEBUSER_response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}}},"x-internal-id":"https:--server:port-spl-rest-apis-customer-service-webUsers--post","x-filename-id":"https-server-port-spl-rest-apis-customer-service-webusers-post"}},"/spl/rest/apis/customer/service/webUsers/{webUserId}":{"put":{"summary":"Update Web User","description":"This operation handles the Integration Suite API to Update Web User","operationId":"updateWebUser","parameters":[{"in":"path","name":"webUserId","required":true,"schema":{"type":"string"}}],"tags":["Service/Web User"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UPDATEWEBUSER_request"}},"application/xml":{"schema":{"$ref":"#/components/schemas/UPDATEWEBUSER_request"}}}},"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UPDATEWEBUSER_response"}},"application/xml":{"schema":{"$ref":"#/components/schemas/UPDATEWEBUSER_response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}}},"x-internal-id":"https:--server:port-spl-rest-apis-customer-service-webUsers-{webUserId}-put","x-filename-id":"https-server-port-spl-rest-apis-customer-service-webusers-webuserid-put"},"get":{"summary":"Get Web User","description":"This operation handles the Integration Suite API to retrieve Web User","operationId":"getWebUser","parameters":[{"in":"path","name":"webUserId","required":true,"schema":{"type":"string"}}],"tags":["Service/Web User"],"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GETWEBUSER_response"}},"application/xml":{"schema":{"$ref":"#/components/schemas/GETWEBUSER_response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}}},"x-internal-id":"https:--server:port-spl-rest-apis-customer-service-webUsers-{webUserId}-get","x-filename-id":"https-server-port-spl-rest-apis-customer-service-webusers-webuserid-get"},"delete":{"summary":"Delete Web User","description":"This operation handles the Integration Suite API to Delete Web User","operationId":"deleteWebUser","parameters":[{"in":"path","name":"webUserId","required":true,"schema":{"type":"string"}}],"tags":["Service/Web User"],"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DELETEWEBUSER_response"}},"application/xml":{"schema":{"$ref":"#/components/schemas/DELETEWEBUSER_response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}}},"x-internal-id":"https:--server:port-spl-rest-apis-customer-service-webUsers-{webUserId}-delete","x-filename-id":"https-server-port-spl-rest-apis-customer-service-webusers-webuserid-delete"}},"/spl/rest/apis/customer/service/webUserAccounts":{"post":{"summary":"Create Web User Account","description":"This operation handles the Integration Suite API to Create Web User Account","operationId":"createWebUserAccount","tags":["Service/Web User Account"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CREATEWEBUSERACCOUNT_request"}},"application/xml":{"schema":{"$ref":"#/components/schemas/CREATEWEBUSERACCOUNT_request"}}}},"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CREATEWEBUSERACCOUNT_response"}},"application/xml":{"schema":{"$ref":"#/components/schemas/CREATEWEBUSERACCOUNT_response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}}},"x-internal-id":"https:--server:port-spl-rest-apis-customer-service-webUserAccounts--post","x-filename-id":"https-server-port-spl-rest-apis-customer-service-webuseraccounts-post"}},"/spl/rest/apis/customer/service/webUserAccounts/{webUserId}/{accountId}":{"delete":{"summary":"Delete Web User Account","description":"This operation handles the Integration Suite API to Delete Web User Account","operationId":"deleteWebUserAccount","parameters":[{"in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"in":"path","name":"webUserId","required":true,"schema":{"type":"string"}}],"tags":["Service/Web User Account"],"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DELETEWEBUSERACCOUNT_response"}},"application/xml":{"schema":{"$ref":"#/components/schemas/DELETEWEBUSERACCOUNT_response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}}},"x-internal-id":"https:--server:port-spl-rest-apis-customer-service-webUserAccounts-{webUserId}-{accountId}-delete","x-filename-id":"https-server-port-spl-rest-apis-customer-service-webuseraccounts-webuserid-accountid-delete"},"put":{"summary":"Update Web User Account","description":"This operation handles the Integration Suite API to Update Web User Account","operationId":"updateWebUserAccount","parameters":[{"in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"in":"path","name":"webUserId","required":true,"schema":{"type":"string"}}],"tags":["Service/Web User Account"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UPDATEWEBUSERACCOUNT_request"}},"application/xml":{"schema":{"$ref":"#/components/schemas/UPDATEWEBUSERACCOUNT_request"}}}},"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UPDATEWEBUSERACCOUNT_response"}},"application/xml":{"schema":{"$ref":"#/components/schemas/UPDATEWEBUSERACCOUNT_response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}}},"x-internal-id":"https:--server:port-spl-rest-apis-customer-service-webUserAccounts-{webUserId}-{accountId}-put","x-filename-id":"https-server-port-spl-rest-apis-customer-service-webuseraccounts-webuserid-accountid-put"},"get":{"summary":"Get Web User Account","description":"This operation handles the Integration Suite API to Get Web User Account","operationId":"getWebUserAccount","parameters":[{"in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"in":"path","name":"webUserId","required":true,"schema":{"type":"string"}}],"tags":["Service/Web User Account"],"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GETWEBUSERACCOUNT_response"}},"application/xml":{"schema":{"$ref":"#/components/schemas/GETWEBUSERACCOUNT_response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}}},"x-internal-id":"https:--server:port-spl-rest-apis-customer-service-webUserAccounts-{webUserId}-{accountId}-get","x-filename-id":"https-server-port-spl-rest-apis-customer-service-webuseraccounts-webuserid-accountid-get"}},"/spl/rest/apis/customer/service/webUserAccounts/{webUserId}":{"get":{"summary":"Search Web User Accounts","description":"This operation handles the Integration Suite API to Search Web User Accounts","operationId":"searchWebUserAccount","parameters":[{"in":"query","name":"accountId","required":false,"schema":{"type":"string"}},{"in":"query","name":"addressLine","required":false,"schema":{"type":"string"}},{"in":"query","name":"city","required":false,"schema":{"type":"string"}},{"in":"query","name":"limit","required":false,"schema":{"type":"number"}},{"in":"query","name":"nickname","required":false,"schema":{"type":"string"}},{"in":"query","name":"offset","required":false,"schema":{"type":"number"}},{"in":"query","name":"postal","required":false,"schema":{"type":"string"}},{"in":"query","name":"state","required":false,"schema":{"type":"string"}},{"in":"path","name":"webUserId","required":true,"schema":{"type":"string"}}],"tags":["Service/Web User Account"],"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SEARCHWEBUSERACCOUNT_response"}},"application/xml":{"schema":{"$ref":"#/components/schemas/SEARCHWEBUSERACCOUNT_response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}}},"x-internal-id":"https:--server:port-spl-rest-apis-customer-service-webUserAccounts-{webUserId}-get","x-filename-id":"https-server-port-spl-rest-apis-customer-service-webuseraccounts-webuserid-get"}},"/spl/rest/apis/customer/service/webUserAccounts/{accountId}/accountVerificationInfo":{"get":{"summary":"Get Account Verification Details","description":"This operation handles the Integration Suite API to Get Account Verification Details","operationId":"getAccountVerificationInfo","parameters":[{"in":"path","name":"accountId","required":true,"schema":{"type":"string"}}],"tags":["Service/Web User Account"],"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GETACCOUNTVERIFICATIONINFO_response"}},"application/xml":{"schema":{"$ref":"#/components/schemas/GETACCOUNTVERIFICATIONINFO_response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}}},"x-internal-id":"https:--server:port-spl-rest-apis-customer-service-webUserAccounts-{accountId}-accountVerificationInfo-get","x-filename-id":"https-server-port-spl-rest-apis-customer-service-webuseraccounts-accountid-accountverificationinfo-get"}},"/spl/rest/apis/customer/interactions/customerContacts":{"post":{"summary":"Create Customer Contact","description":"This script handles the Integration Suite API to Create Customer Contact","operationId":"createCustomerContact","tags":["Interactions/Customer Contact"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CREATECUSTOMERCONTACT_request"}},"application/xml":{"schema":{"$ref":"#/components/schemas/CREATECUSTOMERCONTACT_request"}}}},"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CREATECUSTOMERCONTACT_response"}},"application/xml":{"schema":{"$ref":"#/components/schemas/CREATECUSTOMERCONTACT_response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}}},"x-internal-id":"https:--server:port-spl-rest-apis-customer-interactions-customerContacts--post","x-filename-id":"https-server-port-spl-rest-apis-customer-interactions-customercontacts-post"}},"/spl/rest/apis/customer/interactions/customerContacts/{customerContactId}":{"put":{"summary":"Update Customer Contact","description":"This script handles the Integration Suite API to Update Customer Contact","operationId":"updateCustomerContact","parameters":[{"in":"path","name":"customerContactId","required":true,"schema":{"type":"string"}}],"tags":["Interactions/Customer Contact"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UPDATECUSTOMERCONTACT_request"}},"application/xml":{"schema":{"$ref":"#/components/schemas/UPDATECUSTOMERCONTACT_request"}}}},"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UPDATECUSTOMERCONTACT_response"}},"application/xml":{"schema":{"$ref":"#/components/schemas/UPDATECUSTOMERCONTACT_response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}}},"x-internal-id":"https:--server:port-spl-rest-apis-customer-interactions-customerContacts-{customerContactId}-put","x-filename-id":"https-server-port-spl-rest-apis-customer-interactions-customercontacts-customercontactid-put"},"get":{"summary":"Get Customer Contact","description":"This script handles the Integration Suite API to Get Customer Contact","operationId":"getCustomerContact","parameters":[{"in":"path","name":"customerContactId","required":true,"schema":{"type":"string"}}],"tags":["Interactions/Customer Contact"],"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GETCUSTOMERCONTACT_response"}},"application/xml":{"schema":{"$ref":"#/components/schemas/GETCUSTOMERCONTACT_response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}}},"x-internal-id":"https:--server:port-spl-rest-apis-customer-interactions-customerContacts-{customerContactId}-get","x-filename-id":"https-server-port-spl-rest-apis-customer-interactions-customercontacts-customercontactid-get"},"delete":{"summary":"Delete Customer Contact","description":"This script handles the Integration Suite API to Delete Customer Contact Operation","operationId":"deleteCustomerContact","parameters":[{"in":"path","name":"customerContactId","required":true,"schema":{"type":"string"}}],"tags":["Interactions/Customer Contact"],"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DELETECUSTOMERCONTACT_response"}},"application/xml":{"schema":{"$ref":"#/components/schemas/DELETECUSTOMERCONTACT_response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}}},"x-internal-id":"https:--server:port-spl-rest-apis-customer-interactions-customerContacts-{customerContactId}-delete","x-filename-id":"https-server-port-spl-rest-apis-customer-interactions-customercontacts-customercontactid-delete"}},"/spl/rest/apis/customer/collections/cutProcesses/{cutProcessId}/action":{"patch":{"summary":"Action Cut Process","description":"","operationId":"actionCutProcess","parameters":[{"in":"path","name":"cutProcessId","required":true,"schema":{"type":"string"}},{"in":"query","name":"name","required":false,"schema":{"type":"string"}}],"tags":["Credit & Collections/Cut Process"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ACTIONCUTPROCESS_request"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ACTIONCUTPROCESS_request"}}}},"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ACTIONCUTPROCESS_response"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ACTIONCUTPROCESS_response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}}},"x-internal-id":"https:--server:port-spl-rest-apis-customer-collections-cutProcesses-{cutProcessId}-action-patch","x-filename-id":"https-server-port-spl-rest-apis-customer-collections-cutprocesses-cutprocessid-action-patch"}},"/spl/rest/apis/customer/collections/cutProcesses/{cutProcessId}":{"put":{"summary":"Update Cut Process","description":"","operationId":"updateCutProcess","parameters":[{"in":"path","name":"cutProcessId","required":true,"schema":{"type":"string"}}],"tags":["Credit & Collections/Cut Process"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UPDATECUTPROCESS_request"}},"application/xml":{"schema":{"$ref":"#/components/schemas/UPDATECUTPROCESS_request"}}}},"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UPDATECUTPROCESS_response"}},"application/xml":{"schema":{"$ref":"#/components/schemas/UPDATECUTPROCESS_response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}}},"x-internal-id":"https:--server:port-spl-rest-apis-customer-collections-cutProcesses-{cutProcessId}-put","x-filename-id":"https-server-port-spl-rest-apis-customer-collections-cutprocesses-cutprocessid-put"},"get":{"summary":"Get Cut Process","description":"","operationId":"getCutProcess","parameters":[{"in":"path","name":"cutProcessId","required":true,"schema":{"type":"string"}}],"tags":["Credit & Collections/Cut Process"],"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GETCUTPROCESS_response"}},"application/xml":{"schema":{"$ref":"#/components/schemas/GETCUTPROCESS_response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}}},"x-internal-id":"https:--server:port-spl-rest-apis-customer-collections-cutProcesses-{cutProcessId}-get","x-filename-id":"https-server-port-spl-rest-apis-customer-collections-cutprocesses-cutprocessid-get"}},"/ouaf/rest/apis/meter/usage/usageTransactions/{usageTransactionId}/action":{"patch":{"summary":"Patch Usage Transaction","description":"This script handles the Integration Suite API to Patch Usage Transaction Operation of the D1-UsageTransaction REST service.","operationId":"actionUsageTransaction","parameters":[{"in":"query","name":"name","required":false,"schema":{"type":"string"}},{"in":"path","name":"usageTransactionId","required":true,"schema":{"type":"string"}}],"tags":["Usage/Usage Transaction"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ACTIONUSAGETRANSACTION_request"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ACTIONUSAGETRANSACTION_request"}}}},"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ACTIONUSAGETRANSACTION_response"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ACTIONUSAGETRANSACTION_response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}}},"x-internal-id":"https:--server:port-ouaf-rest-apis-meter-usage-usageTransactions-{usageTransactionId}-action-patch","x-filename-id":"https-server-port-ouaf-rest-apis-meter-usage-usagetransactions-usagetransactionid-action-patch"}},"/ouaf/rest/apis/meter/usage/usageTransactions":{"post":{"summary":"Create Usage Transaction","description":"This Operation handles the Integration Suite API to Create Usage Transaction.","operationId":"createUsageTransaction","tags":["Usage/Usage Transaction"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CREATEUSAGETRANSACTION_request"}},"application/xml":{"schema":{"$ref":"#/components/schemas/CREATEUSAGETRANSACTION_request"}}}},"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CREATEUSAGETRANSACTION_response"}},"application/xml":{"schema":{"$ref":"#/components/schemas/CREATEUSAGETRANSACTION_response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}}},"x-internal-id":"https:--server:port-ouaf-rest-apis-meter-usage-usageTransactions--post","x-filename-id":"https-server-port-ouaf-rest-apis-meter-usage-usagetransactions-post"}},"/ouaf/rest/apis/meter/usage/usageTransactions/{usageTransactionId}":{"put":{"summary":"Update Usage Transaction","description":"This Operation handles the Integration Suite API to Update Usage Transaction","operationId":"updateUsageTransaction","parameters":[{"in":"path","name":"usageTransactionId","required":true,"schema":{"type":"string"}}],"tags":["Usage/Usage Transaction"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UPDATEUSAGETRANSACTION_request"}},"application/xml":{"schema":{"$ref":"#/components/schemas/UPDATEUSAGETRANSACTION_request"}}}},"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UPDATEUSAGETRANSACTION_response"}},"application/xml":{"schema":{"$ref":"#/components/schemas/UPDATEUSAGETRANSACTION_response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}}},"x-internal-id":"https:--server:port-ouaf-rest-apis-meter-usage-usageTransactions-{usageTransactionId}-put","x-filename-id":"https-server-port-ouaf-rest-apis-meter-usage-usagetransactions-usagetransactionid-put"},"get":{"summary":"Get Usage Transaction","description":"This Operation handles the Integration Suite API to Get Usage Transaction","operationId":"getUsageTransaction","parameters":[{"in":"path","name":"usageTransactionId","required":true,"schema":{"type":"string"}}],"tags":["Usage/Usage Transaction"],"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GETUSAGETRANSACTION_response"}},"application/xml":{"schema":{"$ref":"#/components/schemas/GETUSAGETRANSACTION_response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}}},"x-internal-id":"https:--server:port-ouaf-rest-apis-meter-usage-usageTransactions-{usageTransactionId}-get","x-filename-id":"https-server-port-ouaf-rest-apis-meter-usage-usagetransactions-usagetransactionid-get"},"delete":{"summary":"Delete Usage Transaction","description":"This script handles the Integration Suite API to Delete Usage Transaction Operation of the D1-UsageTransaction REST service.\n\nNote: All REST services that are in the Integration Suite Web Service Categories require the related Integration Suite add-on product option to use.","operationId":"deleteUsageTransaction","parameters":[{"in":"path","name":"usageTransactionId","required":true,"schema":{"type":"string"}}],"tags":["Usage/Usage Transaction"],"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DELETEUSAGETRANSACTION_response"}},"application/xml":{"schema":{"$ref":"#/components/schemas/DELETEUSAGETRANSACTION_response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}}},"x-internal-id":"https:--server:port-ouaf-rest-apis-meter-usage-usageTransactions-{usageTransactionId}-delete","x-filename-id":"https-server-port-ouaf-rest-apis-meter-usage-usagetransactions-usagetransactionid-delete"}},"/spl/rest/apis/customer/v-model/persons":{"post":{"summary":"Create Person","description":"This script handles the Integration Suite API to Create Person .","operationId":"createPerson","tags":["V-Model/Person"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CREATEPERSON_request"}},"application/xml":{"schema":{"$ref":"#/components/schemas/CREATEPERSON_request"}}}},"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CREATEPERSON_response"}},"application/xml":{"schema":{"$ref":"#/components/schemas/CREATEPERSON_response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}}},"x-internal-id":"https:--server:port-spl-rest-apis-customer-v-model-persons--post","x-filename-id":"https-server-port-spl-rest-apis-customer-v-model-persons-post"}},"/spl/rest/apis/customer/v-model/persons/{personId}":{"put":{"summary":"Update Person","description":"This script handles the Integration Suite API to Update Person","operationId":"updatePerson","parameters":[{"in":"path","name":"personId","required":true,"schema":{"type":"string"}}],"tags":["V-Model/Person"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UPDATEPERSON_request"}},"application/xml":{"schema":{"$ref":"#/components/schemas/UPDATEPERSON_request"}}}},"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UPDATEPERSON_response"}},"application/xml":{"schema":{"$ref":"#/components/schemas/UPDATEPERSON_response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}}},"x-internal-id":"https:--server:port-spl-rest-apis-customer-v-model-persons-{personId}-put","x-filename-id":"https-server-port-spl-rest-apis-customer-v-model-persons-personid-put"},"get":{"summary":"Get Person","description":"This script handles the Integration Suite API to Get Person Operation","operationId":"getPerson","parameters":[{"in":"path","name":"personId","required":true,"schema":{"type":"string"}}],"tags":["V-Model/Person"],"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GETPERSON_response"}},"application/xml":{"schema":{"$ref":"#/components/schemas/GETPERSON_response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}}},"x-internal-id":"https:--server:port-spl-rest-apis-customer-v-model-persons-{personId}-get","x-filename-id":"https-server-port-spl-rest-apis-customer-v-model-persons-personid-get"},"delete":{"summary":"Delete Person","description":"This script handles the Integration Suite API to Delete Person Operation","operationId":"deletePerson","parameters":[{"in":"path","name":"personId","required":true,"schema":{"type":"string"}}],"tags":["V-Model/Person"],"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DELETEPERSON_response"}},"application/xml":{"schema":{"$ref":"#/components/schemas/DELETEPERSON_response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}}},"x-internal-id":"https:--server:port-spl-rest-apis-customer-v-model-persons-{personId}-delete","x-filename-id":"https-server-port-spl-rest-apis-customer-v-model-persons-personid-delete"}},"/spl/rest/apis/customer/financials/paymentEvents/{paymentEventId}/action":{"patch":{"summary":"Action Payment Event","description":"This operation handles the Integration Suite API to Action Payment Event Operation of the C1-PaymentEvent REST service.","operationId":"actionPaymentEvent","parameters":[{"in":"query","name":"name","required":false,"schema":{"type":"string"}},{"in":"path","name":"paymentEventId","required":true,"schema":{"type":"string"}}],"tags":["Financial Transactions/Payment Event"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ACTIONPAYMENTEVENT_request"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ACTIONPAYMENTEVENT_request"}}}},"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ACTIONPAYMENTEVENT_response"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ACTIONPAYMENTEVENT_response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}}},"x-internal-id":"https:--server:port-spl-rest-apis-customer-financials-paymentEvents-{paymentEventId}-action-patch","x-filename-id":"https-server-port-spl-rest-apis-customer-financials-paymentevents-paymenteventid-action-patch"}},"/spl/rest/apis/customer/financials/paymentEvents":{"post":{"summary":"Create Payment Event","description":"This operation handles the Integration Suite API to Create Payment Event Operation of the C1-PaymentEvent REST service.","operationId":"createPaymentEvent","tags":["Financial Transactions/Payment Event"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CREATEPAYMENTEVENT_request"}},"application/xml":{"schema":{"$ref":"#/components/schemas/CREATEPAYMENTEVENT_request"}}}},"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CREATEPAYMENTEVENT_response"}},"application/xml":{"schema":{"$ref":"#/components/schemas/CREATEPAYMENTEVENT_response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}}},"x-internal-id":"https:--server:port-spl-rest-apis-customer-financials-paymentEvents--post","x-filename-id":"https-server-port-spl-rest-apis-customer-financials-paymentevents-post"}},"/spl/rest/apis/customer/financials/paymentEvents/{paymentEventId}":{"put":{"summary":"Update Payment Event","description":"This operation handles the Integration Suite API to Update Payment Event Operation of the C1-PaymentEvent REST service.","operationId":"updatePaymentEvent","parameters":[{"in":"path","name":"paymentEventId","required":true,"schema":{"type":"string"}}],"tags":["Financial Transactions/Payment Event"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UPDATEPAYMENTEVENT_request"}},"application/xml":{"schema":{"$ref":"#/components/schemas/UPDATEPAYMENTEVENT_request"}}}},"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UPDATEPAYMENTEVENT_response"}},"application/xml":{"schema":{"$ref":"#/components/schemas/UPDATEPAYMENTEVENT_response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}}},"x-internal-id":"https:--server:port-spl-rest-apis-customer-financials-paymentEvents-{paymentEventId}-put","x-filename-id":"https-server-port-spl-rest-apis-customer-financials-paymentevents-paymenteventid-put"},"get":{"summary":"Get Payment Event","description":"This operation handles the Integration Suite API to Get Payment Event Operation of the C1-PaymentEvent REST service.","operationId":"getPaymentEvent","parameters":[{"in":"path","name":"paymentEventId","required":true,"schema":{"type":"string"}}],"tags":["Financial Transactions/Payment Event"],"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GETPAYMENTEVENT_response"}},"application/xml":{"schema":{"$ref":"#/components/schemas/GETPAYMENTEVENT_response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}}},"x-internal-id":"https:--server:port-spl-rest-apis-customer-financials-paymentEvents-{paymentEventId}-get","x-filename-id":"https-server-port-spl-rest-apis-customer-financials-paymentevents-paymenteventid-get"},"delete":{"summary":"Delete Payment Event","description":"This operation handles the Integration Suite API to Delete Payment Event Operation of the C1-PaymentEvent REST service.","operationId":"deletePaymentEvent","parameters":[{"in":"path","name":"paymentEventId","required":true,"schema":{"type":"string"}}],"tags":["Financial Transactions/Payment Event"],"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DELETEPAYMENTEVENT_response"}},"application/xml":{"schema":{"$ref":"#/components/schemas/DELETEPAYMENTEVENT_response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}}},"x-internal-id":"https:--server:port-spl-rest-apis-customer-financials-paymentEvents-{paymentEventId}-delete","x-filename-id":"https-server-port-spl-rest-apis-customer-financials-paymentevents-paymenteventid-delete"}},"/spl/rest/apis/customer/financials/paymentTenders/{paymentTenderId}/action":{"patch":{"summary":"Action Payment Tender","description":"This script handles the Integration Suite API to Action Payment Tender Operation of the C1-PaymentTender REST service.\n\n\n\nNote: All REST services that are in the Integration Suite APIs Web Service Categories require the related Integration Suite add-on product option to use.","operationId":"actionPaymentTender","parameters":[{"in":"query","name":"name","required":false,"schema":{"type":"string"}},{"in":"path","name":"paymentTenderId","required":true,"schema":{"type":"string"}}],"tags":["Financial Transactions/PaymentTender"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ACTIONPAYMENTTENDER_request"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ACTIONPAYMENTTENDER_request"}}}},"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ACTIONPAYMENTTENDER_response"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ACTIONPAYMENTTENDER_response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}}},"x-internal-id":"https:--server:port-spl-rest-apis-customer-financials-paymentTenders-{paymentTenderId}-action-patch","x-filename-id":"https-server-port-spl-rest-apis-customer-financials-paymenttenders-paymenttenderid-action-patch"}},"/spl/rest/apis/customer/financials/paymentTenders/{paymentTenderId}":{"put":{"summary":"Update Payment Tender","description":"","operationId":"updatePaymentTender","parameters":[{"in":"path","name":"paymentTenderId","required":true,"schema":{"type":"string"}}],"tags":["Financial Transactions/PaymentTender"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UPDATEPAYMENTTENDER_request"}},"application/xml":{"schema":{"$ref":"#/components/schemas/UPDATEPAYMENTTENDER_request"}}}},"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UPDATEPAYMENTTENDER_response"}},"application/xml":{"schema":{"$ref":"#/components/schemas/UPDATEPAYMENTTENDER_response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}}},"x-internal-id":"https:--server:port-spl-rest-apis-customer-financials-paymentTenders-{paymentTenderId}-put","x-filename-id":"https-server-port-spl-rest-apis-customer-financials-paymenttenders-paymenttenderid-put"},"get":{"summary":"Get Payment Tender","description":"This Operation handles the Integration Suite API to Get Payment Tender.","operationId":"getPaymentTender","parameters":[{"in":"path","name":"paymentTenderId","required":true,"schema":{"type":"string"}}],"tags":["Financial Transactions/PaymentTender"],"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GETPAYMENTTENDER_response"}},"application/xml":{"schema":{"$ref":"#/components/schemas/GETPAYMENTTENDER_response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}}},"x-internal-id":"https:--server:port-spl-rest-apis-customer-financials-paymentTenders-{paymentTenderId}-get","x-filename-id":"https-server-port-spl-rest-apis-customer-financials-paymenttenders-paymenttenderid-get"}},"/spl/rest/apis/customer/financials/paymentTenders":{"post":{"summary":"Create Payment Tender","description":"","operationId":"createPaymentTender","tags":["Financial Transactions/PaymentTender"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CREATEPAYMENTTENDER_request"}},"application/xml":{"schema":{"$ref":"#/components/schemas/CREATEPAYMENTTENDER_request"}}}},"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CREATEPAYMENTTENDER_response"}},"application/xml":{"schema":{"$ref":"#/components/schemas/CREATEPAYMENTTENDER_response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}}},"x-internal-id":"https:--server:port-spl-rest-apis-customer-financials-paymentTenders--post","x-filename-id":"https-server-port-spl-rest-apis-customer-financials-paymenttenders-post"}},"/spl/rest/apis/customer/financials/payments/{paymentId}/action":{"patch":{"summary":"Action Payment","description":"This operation handles the Integration Suite API to Action Payment","operationId":"actionPayment","parameters":[{"in":"query","name":"name","required":false,"schema":{"type":"string"}},{"in":"path","name":"paymentId","required":true,"schema":{"type":"string"}}],"tags":["Financial Transactions/Payment"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ACTIONPAYMENT_request"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ACTIONPAYMENT_request"}}}},"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ACTIONPAYMENT_response"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ACTIONPAYMENT_response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}}},"x-internal-id":"https:--server:port-spl-rest-apis-customer-financials-payments-{paymentId}-action-patch","x-filename-id":"https-server-port-spl-rest-apis-customer-financials-payments-paymentid-action-patch"}},"/spl/rest/apis/customer/financials/payments":{"post":{"summary":"Create Payment","description":"This operation handles the Integration Suite API to Create Payment","operationId":"createPayment","tags":["Financial Transactions/Payment"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CREATEPAYMENT_request"}},"application/xml":{"schema":{"$ref":"#/components/schemas/CREATEPAYMENT_request"}}}},"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CREATEPAYMENT_response"}},"application/xml":{"schema":{"$ref":"#/components/schemas/CREATEPAYMENT_response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}}},"x-internal-id":"https:--server:port-spl-rest-apis-customer-financials-payments--post","x-filename-id":"https-server-port-spl-rest-apis-customer-financials-payments-post"}},"/spl/rest/apis/customer/financials/payments/{paymentId}":{"put":{"summary":"Update Payment","description":"This operation handles the Integration Suite API to Update Payment","operationId":"updatePayment","parameters":[{"in":"path","name":"paymentId","required":true,"schema":{"type":"string"}}],"tags":["Financial Transactions/Payment"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UPDATEPAYMENT_request"}},"application/xml":{"schema":{"$ref":"#/components/schemas/UPDATEPAYMENT_request"}}}},"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UPDATEPAYMENT_response"}},"application/xml":{"schema":{"$ref":"#/components/schemas/UPDATEPAYMENT_response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}}},"x-internal-id":"https:--server:port-spl-rest-apis-customer-financials-payments-{paymentId}-put","x-filename-id":"https-server-port-spl-rest-apis-customer-financials-payments-paymentid-put"},"get":{"summary":"Get Payment","description":"This operation handles the Integration Suite API to Get Payment","operationId":"getPayment","parameters":[{"in":"path","name":"paymentId","required":true,"schema":{"type":"string"}}],"tags":["Financial Transactions/Payment"],"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GETPAYMENT_response"}},"application/xml":{"schema":{"$ref":"#/components/schemas/GETPAYMENT_response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}}},"x-internal-id":"https:--server:port-spl-rest-apis-customer-financials-payments-{paymentId}-get","x-filename-id":"https-server-port-spl-rest-apis-customer-financials-payments-paymentid-get"},"delete":{"summary":"Delete Payment","description":"This operation handles the Integration Suite API to Delete Payment","operationId":"deletePayment","parameters":[{"in":"path","name":"paymentId","required":true,"schema":{"type":"string"}}],"tags":["Financial Transactions/Payment"],"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DELETEPAYMENT_response"}},"application/xml":{"schema":{"$ref":"#/components/schemas/DELETEPAYMENT_response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}},"application/xml":{"schema":{"$ref":"#/components/schemas/problemDetailDocument"}}}}},"x-internal-id":"https:--server:port-spl-rest-apis-customer-financials-payments-{paymentId}-delete","x-filename-id":"https-server-port-spl-rest-apis-customer-financials-payments-paymentid-delete"}}},"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{"CREATEACCOUNT_request":{"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":"1589809032"},"billCycle":{"type":"object","description":"Bill Cycle Code controls the schedule of when a bill should be generated for an account.","properties":{"billCycle":{"type":"string","maxLength":4,"description":"Bill Cycle Code controls the schedule of when a bill should be generated for an account.","example":"MO17"}}},"setUpDate":{"type":"string","format":"date","description":"Set Up Date is the date the account was initially created.","example":"2001-01-01"},"currency":{"type":"object","description":"Currency Code defines the currency in which the account's financial transactions are expressed.","properties":{"currency":{"type":"string","maxLength":3,"description":"Currency Code defines the currency in which the account's financial transactions are expressed.","example":"USD"}}},"accountManagementGroup":{"type":"object","description":"The Account Management Group controls the roles assigned to To Do entries associated with an account.","properties":{"accountManagementGroup":{"type":"string","maxLength":10,"description":"The Account Management Group controls the roles assigned to To Do entries associated with an account.","example":"LANDLORD"}}},"alertInformation":{"type":"string","maxLength":4000,"description":"Alerts highlight important information to any customer service representative who looks at the account."},"billAfterDate":{"type":"string","format":"date","description":"Bill After Date postpones billing until after a future date.","example":"2001-01-01"},"shouldProtectBillCycle":{"type":"boolean","description":"When defined as true, the system does not change the bill cycle when a service agreement is activated. By default, service agreement activation can modify the bill cycle.","example":"false"},"division":{"type":"object","description":"CIS Division defines the jurisdiction that governs this account.","properties":{"division":{"type":"string","maxLength":5,"description":"CIS Division defines the jurisdiction that governs this account.","example":"CA"}}},"mailingPremise":{"type":"object","description":"Mailing Premise ID defines the address on bills for persons who have their bill sent to the account's mailing premise. This field can be updated by the system when a service agreement is activated.","properties":{"mailingPremiseId":{"type":"string","maxLength":10,"description":"Mailing Premise ID defines the address on bills for persons who have their bill sent to the account's mailing premise. This field can be updated by the system when a service agreement is activated.","example":"3308038454"}}},"shouldProtectMailingPremise":{"type":"boolean","description":"When defined as true, the mailing premise is not modified when a service agreement is activated. If defined as false, the mailing address can be updated when a service agreement is activated.","example":"true"},"collectionClass":{"type":"object","description":"Collection Class controls how the account's debt is compared against collection criteria to determine if a collection process should be started.","properties":{"collectionClass":{"type":"string","maxLength":10,"description":"Collection Class controls how the account's debt is compared against collection criteria to determine if a collection process should be started.","example":"RESID"}}},"lastCreditReviewDate":{"type":"string","format":"date","description":"Last Credit Review Date is the date when the account's debt was last reviewed by the account debt monitor (ADM) background process.","example":"2016-10-26"},"postponeCreditReviewUntilDate":{"type":"string","format":"date","description":"Defining a future data prevents an account from being reviewed by credit and collections processes, such as the account debt monitor and the write-off monitor, until after the defined date."},"customerClass":{"type":"object","description":"Customer Class controls financial parameters related to billing and collections.","properties":{"customerClass":{"type":"string","maxLength":8,"description":"Customer Class controls financial parameters related to billing and collections.","example":"R"}}},"billPrintIntercept":{"type":"object","description":"Provide a user's ID to require review of the account's printed bills before they are sent to the customer.","properties":{"billPrintIntercept":{"type":"string","maxLength":8,"description":"Provide a user's ID to require review of the account's printed bills before they are sent to the customer.","example":"MBRAZIL\n(Brazil, Mark)"}}},"doNotReviewDeposit":{"type":"boolean","description":"When defined as true, the account is not considered by the Deposit Review background process or by the Deposit Refund background process.","example":"true"},"budgetPlan":{"type":"object","description":"Budget Plan controls how the account's debt is managed for budget-related purposes.","properties":{"budgetPlan":{"type":"string","maxLength":8,"description":"Budget Plan controls how the account's debt is managed for budget-related purposes.","example":"RES BUD"}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The version number is used for internal concurrency checks.","example":"2"},"shouldProtectDivision":{"type":"boolean","description":"When defined as true, assigned CIS divisions are not modified when a service agreement is activated. By default, service agreement activation can modify the CIS division.","example":"false"},"accessGroup":{"type":"object","description":"Access Group controls which users are allowed to view and update this account's information, including bills, service agreements, payments, and premises.","properties":{"accessGroup":{"type":"string","maxLength":12,"description":"Access Group controls which users are allowed to view and update this account's information, including bills, service agreements, payments, and premises.","example":"***"}}},"characteristics":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"effectiveDate":{"type":"string","format":"date","description":"Effective Date defines the date on which the characteristic becomes effective. The effective date defaults from the Installation Record.","example":"2001-01-01"},"characteristicType":{"type":"object","properties":{"characteristicType":{"type":"string","maxLength":8,"description":"Characteristic Type indicates the type of characteristic.","example":"NEWACCT"}}},"characteristicValue":{"type":"object","properties":{"_link":{"type":"string","description":"(_link)"},"value":{"type":"string","description":"(value)"},"value2":{"type":"string","description":"(value2)"},"value3":{"type":"string","description":"(value3)"},"value4":{"type":"string","description":"(value4)"},"value5":{"type":"string","description":"(value5)"}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The version number is used for internal concurrency checks.","example":"2"}}}}}},"alerts":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"alertType":{"type":"object","properties":{"alertType":{"type":"string","maxLength":10,"description":"Alert Type indicates the type of alert to show for the account.","example":"PA BLOCK \n(Payment Arrangements are not allowed for this Account)"}}},"startDate":{"type":"string","format":"date","description":"Start Date indicates the date on which the alert starts showing for the account.","example":"2001-01-01"},"endDate":{"type":"string","format":"date","description":"End Date indicates the date on which the alert stops showing for the account.","example":"2001-01-01"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The version number is used for internal concurrency checks.","example":"2"}}}}}},"autoPay":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"accountAutoPay":{"type":"object","properties":{"accountAutoPayId":{"type":"string","maxLength":10,"description":"Auto Pay ID"}}},"startDate":{"type":"string","format":"date","description":"Start Date indicates the date on which the alert starts showing for the account.","example":"2001-01-01"},"endDate":{"type":"string","format":"date","description":"End Date indicates the date on which the alert stops showing for the account.","example":"2001-01-01"},"autoPaySource":{"type":"object","properties":{"autoPaySource":{"type":"string","maxLength":12,"description":"Auto Pay Source is used to define the source of the funds, such as a banking institution, used to satisfy the automatic payment request."}}},"externalAccountId":{"type":"string","maxLength":50,"description":"Use External Account ID to define the customer's bank account or credit card number.","example":"******789"},"expireDate":{"type":"string","format":"date","description":"Expires On date is used if the Auto Pay Source Code references a tender type that requires an expiration date.","example":"2001-01-01"},"entityName":{"type":"string","maxLength":254,"description":"Name of the customer as it appears in the financial institution's system.","example":"Brazil, Mark"},"comments":{"type":"string","maxLength":254,"description":"Comments can describe anything interesting or unusual about the automatic payment request."},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The version number is used for internal concurrency checks.","example":"2"},"autoPayMaxWithdrawalAmount":{"type":"number","description":"Maximum Withdrawal Amount limits the amount of money that is automatically debited from an account.","example":"$50.00"},"autoPayMethod":{"type":"object","properties":{"autoPayMethod":{"type":"string","enum":["C1DD","C1PA"],"description":"Auto Pay Method defines whether the system should process automatic payments as Direct Debit or Payment Advice."}}}}}}}},"messages":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"billMessage":{"type":"object","properties":{"billMessage":{"type":"string","maxLength":4,"description":"Bill Message is a message that appears on the customer's bill."}}},"billMessageType":{"type":"string","enum":["P   ","T   "],"description":"Bill Message Type indicates if the message should remain permanent or temporarily only be linked to the next bill produced for the account.\n* `P   ` - Permanent,\n* `T   ` - Temporary","example":"T"},"messageParameters":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"messageParameterValue":{"type":"string","maxLength":2000,"description":"Message Parameter Value"},"sequence":{"type":"number","maximum":999,"minimum":-999,"description":"Sequence"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The version number is used for internal concurrency checks.","example":"2"}}}}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The version number is used for internal concurrency checks.","example":"2"}}}}}},"creditRatingHistory":{"type":"object","description":"Account Credit Rating History collection contains one entry for each credit rating history record associated with the account.","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"user":{"type":"object","properties":{"userId":{"type":"string","maxLength":8,"description":"User that created the record.","example":"CDX"}}},"collectionProcess":{"type":"object","properties":{"collectionProcessId":{"type":"string","maxLength":10,"description":"Collection Process ID is the unique system-generated identifier for this collection process.","example":"1589809419"}}},"startDate":{"type":"string","format":"date","description":"Start Date indicates the date on which the alert starts showing for the account.","example":"2001-01-01"},"severanceProcessId":{"type":"object","properties":{"severanceProcessId":{"type":"string","maxLength":10,"description":"Severance Process ID is the unique system-generated identifier for this severance process.","example":"1589809419"}}},"endDate":{"type":"string","format":"date","description":"End Date indicates the date on which the alert stops showing for the account.","example":"2001-01-01"},"affectCreditRatingBy":{"type":"number","maximum":99999,"minimum":-99999,"description":"Affect Credit Rating By is the effect of the credit rating transaction on the account's credit score.","example":"100"},"cashOnlyPoints":{"type":"number","maximum":99999,"minimum":-99999,"description":"Affect Cash-Only Score By is the effect of the credit rating transaction on the account's cash-only score.","example":"100"},"creditRatingCreatedBy":{"type":"string","enum":["COLL","CUTP","MN  ","NSF ","ODP ","OT  ","PP  ","SEV ","WO  "],"description":"The credit rating transaction includes a Created By flag that is customizable using the Lookup table.\n* `COLL` - Collection Process,\n* `CUTP` - Cut Process,\n* `MN  ` - Manual,\n* `NSF ` - NSF Assessment,\n* `ODP ` - Overdue Process,\n* `OT  ` - Other,\n* `PP  ` - Pay Plan,\n* `SEV ` - Severance Process,\n* `WO  ` - Write Off","example":"PP"},"eventSequence":{"type":"number","maximum":999,"minimum":-999,"description":"A sequence is used to define the order of the credit rating event records.","example":"0"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The version number is used for internal concurrency checks.","example":"2"},"comments":{"type":"string","maxLength":254,"description":"Comments can describe anything interesting or unusual about the automatic payment request."},"payPlanId":{"type":"object","properties":{"payPlanId":{"type":"string","maxLength":10,"description":"Pay Plan ID"}}},"writeOffProcess":{"type":"object","properties":{"writeOffProcessId":{"type":"string","maxLength":10,"description":"Write Off Process ID"}}}}}}}},"nonCashDeposits":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"sequence":{"type":"number","maximum":99999,"minimum":-99999,"description":"A sequence is used to define the order of the records."},"nonCashDepositType":{"type":"object","properties":{"nonCashDepositType":{"type":"string","maxLength":8,"description":"Non-Cash Deposit Type"}}},"depositClass":{"type":"object","properties":{"depositClass":{"type":"string","maxLength":8,"description":"Deposit Class"}}},"startDate":{"type":"string","format":"date","description":"Start Date indicates the date on which the alert starts showing for the account.","example":"2001-01-01"},"endDate":{"type":"string","format":"date","description":"End Date indicates the date on which the alert stops showing for the account.","example":"2001-01-01"},"depositAmount":{"type":"string","maxLength":15,"description":"Amount of the non-cash deposit."},"documentNumber":{"type":"string","maxLength":20,"description":"Document Number associated with the non-cash deposit.For example, the letter of credit number, the surety bond number, and so on."},"thirdPartySa":{"type":"object","properties":{"thirdPartySaId":{"type":"string","maxLength":10,"description":"Deposit SA ID associated if a third-party has paid the cash deposit for the account.","example":"1589809502"}}},"comments":{"type":"string","maxLength":254,"description":"Comments can describe anything interesting or unusual about the automatic payment request."},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The version number is used for internal concurrency checks.","example":"2"}}}}}},"accountPersons":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"personId":{"type":"object","properties":{"personId":{"type":"string","maxLength":10,"description":"Person ID"}}},"accountRelationshipType":{"type":"object","properties":{"accountRelationshipType":{"type":"string","maxLength":8,"description":"Account Relationship Type"}}},"billAddressSource":{"type":"string","enum":["ACOV","PER ","PREM"],"description":"Address Source indicates the mailing address source if bills are routed using the postal service.","example":"PREM"},"isMainCustomer":{"type":"boolean","description":"Main Customer is defined as true if the person is the main customer on the account. Only one person on an account can be designated as the main customer.","example":"true"},"isFinanciallyResponsible":{"type":"boolean","description":"Financially Responsible is defined as true if the person is financially responsible for the account's debt.","example":"true"},"isThirdPartyGuarantor":{"type":"boolean","description":"Third Party Guarantor is defined as true if the person is a third-party guarantor of the account's debt.","example":"false"},"shouldReceiveCopyOfBill":{"type":"boolean","description":"Receives Copy of Bill is defined as true if the person receives a copy of the account's bills.","example":"true"},"billRouteType":{"type":"object","properties":{"billRouteType":{"type":"string","maxLength":8,"description":"Bill Route Type indicates how the bill is sent to the customer. This field's default value is retrieved from the Installation record."}}},"billFormat":{"type":"string","enum":["D   ","S   "],"description":"Bill Format indicates if the customer should receive a detailed or a summary bill.\n* `D   ` - Detailed,\n* `S   ` - Summary","example":"D"},"numberOfBillCopies":{"type":"number","maximum":99,"minimum":-99,"description":"Number of Bill Copies Indicates how many copies of the bill the person receives.","example":"1"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The version number is used for internal concurrency checks.","example":"2"},"customerPOId":{"type":"string","maxLength":20,"description":"Customer PO ID indicates if the customer wants a purchase order number printed on their copy of the bill."},"receivesNotification":{"type":"boolean","description":"Allow Communication Preference defined as true if the person's contacts can be used on communication preferences for this account.","example":"true"},"prefixSuffixName":{"type":"string","maxLength":50,"description":"Additional information to append to a customer's name when correspondence or bills are sent to this person."},"prefixOrSuffix":{"type":"string","enum":["PX  ","SX  "],"description":"The Prefix or Suffix flag indicates if the Prefix or Suffix Name is appended to the front or the back of the customer's name on correspondence.\n* `PX  ` - Prefix to Name,\n* `SX  ` - Suffix to Name","example":"PX"},"quoteRouteType":{"type":"object","properties":{"quoteRouteType":{"type":"string","maxLength":12,"description":"Quote Route Type"}}},"shouldReceiveCopyOfQuote":{"type":"boolean","description":"Receives Copy of Quote is defined as true if the person receives a copy of the account's quotes.","example":"false"},"webAccess":{"type":"string","enum":["ALWD","NALW"],"description":"Web Access indicates if the related person is allowed web access for customer self-service.\n* `ALWD` - Allowed,\n* `NALW` - Not allowed","example":"NALW"},"personAddressOverride":{"type":"array","items":{"type":"object","properties":{"address1":{"type":"string","maxLength":254,"description":"The first line of the address."},"address2":{"type":"string","maxLength":254,"description":"The second line of the address."},"address3":{"type":"string","maxLength":254,"description":"The third line of the address."},"address4":{"type":"string","maxLength":254,"description":"The fourth line of the address."},"city":{"type":"string","maxLength":90,"description":"The city of the address."},"streetNumber1":{"type":"string","maxLength":6,"description":"The first street number line of the address."},"streetNumber2":{"type":"string","maxLength":4,"description":"The second street number line of the address."},"county":{"type":"string","maxLength":90,"description":"The county of the address."},"postal":{"type":"string","maxLength":12,"description":"The postal code of the address."},"houseType":{"type":"string","enum":["AB  ","WW  "],"description":"House Type indicates the type of house.\n* `AB  ` - House Boat References,\n* `WW  ` - House Trailer Reference"},"taxVendorGeographicalCode":{"type":"string","maxLength":11,"description":"Geographic code used to apply proper taxation rules to the physical address location."},"isInCityLimit":{"type":"boolean","description":"In City Limit is defined as true if the address is considered within the physical city limits."},"state":{"type":"object","properties":{"state":{"type":"string","maxLength":6,"description":"State"}}},"country":{"type":"object","properties":{"country":{"type":"string","maxLength":3,"description":"Country"}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The version number is used for internal concurrency checks.","example":"2"}}}}}}}}}},"xml":{"name":"C1-CXAccount"}},"GETACCOUNT_response":{"type":"object","properties":{"_self":{"type":"string","description":"_self"},"accountId":{"type":"string","maxLength":10,"description":"The Account ID is a system-assigned random number that stays with an account for life.","example":"1589809032"},"billCycle":{"type":"object","description":"Bill Cycle Code controls the schedule of when a bill should be generated for an account.","properties":{"_link":{"type":"string","description":"_link"},"billCycle":{"type":"string","maxLength":4,"description":"Bill Cycle Code controls the schedule of when a bill should be generated for an account.","example":"MO17"}}},"setUpDate":{"type":"string","format":"date","description":"Set Up Date is the date the account was initially created.","example":"2001-01-01"},"currency":{"type":"object","description":"Currency Code defines the currency in which the account's financial transactions are expressed.","properties":{"_link":{"type":"string","description":"_link"},"currency":{"type":"string","maxLength":3,"description":"Currency Code defines the currency in which the account's financial transactions are expressed.","example":"USD"}}},"accountManagementGroup":{"type":"object","description":"The Account Management Group controls the roles assigned to To Do entries associated with an account.","properties":{"_link":{"type":"string","description":"_link"},"accountManagementGroup":{"type":"string","maxLength":10,"description":"Account Management Group"}}},"alertInformation":{"type":"string","maxLength":4000,"description":"Alerts highlight important information to any customer service representative who looks at the account."},"billAfterDate":{"type":"string","format":"date","description":"Bill After Date postpones billing until after a future date.","example":"2001-01-01"},"shouldProtectBillCycle":{"type":"boolean","description":"When defined as true, the system does not change the bill cycle when a service agreement is activated. By default, service agreement activation can modify the bill cycle.","example":"false"},"division":{"type":"object","description":"CIS Division defines the jurisdiction that governs this account.","properties":{"_link":{"type":"string","description":"_link"},"division":{"type":"string","maxLength":5,"description":"CIS Division defines the jurisdiction that governs this account.","example":"CA"}}},"mailingPremise":{"type":"object","description":"Mailing Premise ID defines the address on bills for persons who have their bill sent to the account's mailing premise. This field can be updated by the system when a service agreement is activated.","properties":{"_link":{"type":"string","description":"_link"},"mailingPremiseId":{"type":"string","maxLength":10,"description":"Mailing Premise ID defines the address on bills for persons who have their bill sent to the account's mailing premise. This field can be updated by the system when a service agreement is activated."}}},"shouldProtectMailingPremise":{"type":"boolean","description":"When defined as true, the mailing premise is not modified when a service agreement is activated. If defined as false, the mailing address can be updated when a service agreement is activated.","example":"true"},"collectionClass":{"type":"object","description":"Collection Class controls how the account's debt is compared against collection criteria to determine if a collection process should be started.","properties":{"_link":{"type":"string","description":"_link"},"collectionClass":{"type":"string","maxLength":10,"description":"Collection Class controls how the account's debt is compared against collection criteria to determine if a collection process should be started.","example":"RESID"}}},"lastCreditReviewDate":{"type":"string","format":"date","description":"Last Credit Review Date is the date when the account's debt was last reviewed by the account debt monitor (ADM) background process.","example":"2016-10-26"},"postponeCreditReviewUntilDate":{"type":"string","format":"date","description":"Defining a future data prevents an account from being reviewed by credit and collections processes, such as the account debt monitor and the write-off monitor, until after the defined date."},"customerClass":{"type":"object","description":"Customer Class controls financial parameters related to billing and collections.","properties":{"_link":{"type":"string","description":"_link"},"customerClass":{"type":"string","maxLength":8,"description":"Customer Class controls financial parameters related to billing and collections.","example":"R"}}},"billPrintIntercept":{"type":"object","description":"Provide a user's ID to require review of the account's printed bills before they are sent to the customer.","properties":{"_link":{"type":"string","description":"_link"},"billPrintIntercept":{"type":"string","maxLength":8,"description":"Provide a user's ID to require review of the account's printed bills before they are sent to the customer.","example":"MBRAZIL\n(Brazil, Mark)"}}},"doNotReviewDeposit":{"type":"boolean","description":"When defined as true, the account is not considered by the Deposit Review background process or by the Deposit Refund background process.","example":"true"},"budgetPlan":{"type":"object","description":"Budget Plan controls how the account's debt is managed for budget-related purposes.","properties":{"_link":{"type":"string","description":"_link"},"budgetPlan":{"type":"string","maxLength":8,"description":"Budget Plan controls how the account's debt is managed for budget-related purposes.","example":"RES BUD"}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The version number is used for internal concurrency checks.","example":"2"},"shouldProtectDivision":{"type":"boolean","description":"When defined as true, assigned CIS divisions are not modified when a service agreement is activated. By default, service agreement activation can modify the CIS division.","example":"false"},"accessGroup":{"type":"object","description":"Access Group controls which users are allowed to view and update this account's information, including bills, service agreements, payments, and premises.","properties":{"_link":{"type":"string","description":"_link"},"accessGroup":{"type":"string","maxLength":12,"description":"Access Group controls which users are allowed to view and update this account's information, including bills, service agreements, payments, and premises.","example":"***"}}},"characteristics":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"effectiveDate":{"type":"string","format":"date","description":"Effective Date defines the date on which the characteristic becomes effective. The effective date defaults from the Installation Record.","example":"2001-01-01"},"characteristicType":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"characteristicType":{"type":"string","maxLength":8,"description":"Characteristic Type"}}},"typeOfCharacteristicValue":{"type":"string","maxLength":4,"description":"Type of Char Value"},"characteristicValue":{"type":"object","properties":{"_link":{"type":"string","description":"(_link)"},"value":{"type":"string","description":"(value)"},"value2":{"type":"string","description":"(value2)"},"value3":{"type":"string","description":"(value3)"},"value4":{"type":"string","description":"(value4)"},"value5":{"type":"string","description":"(value5)"}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The version number is used for internal concurrency checks.","example":"2"}}}}}},"alerts":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"alertType":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"alertType":{"type":"string","maxLength":10,"description":"Alert Type"}}},"startDate":{"type":"string","format":"date","description":"Start Date indicates the date on which the alert starts showing for the account.","example":"2001-01-01"},"endDate":{"type":"string","format":"date","description":"End Date indicates the date on which the alert stops showing for the account.","example":"2001-01-01"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The version number is used for internal concurrency checks.","example":"2"}}}}}},"autoPay":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"accountAutoPay":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"accountAutoPayId":{"type":"string","maxLength":10,"description":"Auto Pay ID"}}},"startDate":{"type":"string","format":"date","description":"Start Date indicates the date on which the alert starts showing for the account.","example":"2001-01-01"},"endDate":{"type":"string","format":"date","description":"End Date indicates the date on which the alert stops showing for the account.","example":"2001-01-01"},"autoPaySource":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"autoPaySource":{"type":"string","maxLength":12,"description":"Auto Pay Source is used to define the source of the funds, such as a banking institution, used to satisfy the automatic payment request."}}},"externalAccountId":{"type":"string","maxLength":50,"description":"Use External Account ID to define the customer's bank account or credit card number.","example":"******789"},"expireDate":{"type":"string","format":"date","description":"Expires On date is used if the Auto Pay Source Code references a tender type that requires an expiration date.","example":"2001-01-01"},"entityName":{"type":"string","maxLength":254,"description":"Name of the customer as it appears in the financial institution's system.","example":"Brazil, Mark"},"comments":{"type":"string","maxLength":254,"description":"Comments can describe anything interesting or unusual about the automatic payment request."},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The version number is used for internal concurrency checks.","example":"2"},"autoPayMaxWithdrawalAmount":{"type":"number","description":"Maximum Withdrawal Amount limits the amount of money that is automatically debited from an account."},"autoPayMethod":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"autoPayMethod":{"type":"string","enum":["C1DD","C1PA"],"description":"Auto Pay Method defines whether the system should process automatic payments as Direct Debit or Payment Advice."}}}}}}}},"messages":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"billMessage":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"billMessage":{"type":"string","maxLength":4,"description":"Bill Message is a message that appears on the customer's bill."}}},"billMessageExpanded":{"type":"string","maxLength":254,"description":"Message on Bill"},"billMessageType":{"type":"string","enum":["P   ","T   "],"description":"Bill Message Type indicates if the message should remain permanent or temporarily only be linked to the next bill produced for the account.\n* `P   ` - Permanent,\n* `T   ` - Temporary","example":"T"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The version number is used for internal concurrency checks.","example":"2"}}}}}},"creditRatingHistory":{"type":"object","description":"Account Credit Rating History collection contains one entry for each credit rating history record associated with the account.","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"creditRatingHistoryId":{"type":"string","maxLength":10,"description":"The Credit Rating History contains one entry for each credit rating history record associated with the account.","example":"1589809596"},"user":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"userId":{"type":"string","maxLength":8,"description":"User that created the record.","example":"CDX"}}},"collectionProcess":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"collectionProcessId":{"type":"string","maxLength":10,"description":"Collection Process ID is the unique system-generated identifier for this collection process.","example":"1589809419"}}},"startDate":{"type":"string","format":"date","description":"Start Date indicates the date on which the alert starts showing for the account.","example":"2001-01-01"},"severanceProcessId":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"severanceProcessId":{"type":"string","maxLength":10,"description":"Severance Process ID is the unique system-generated identifier for this severance process.","example":"1589809419"}}},"endDate":{"type":"string","format":"date","description":"End Date indicates the date on which the alert stops showing for the account.","example":"2001-01-01"},"affectCreditRatingBy":{"type":"number","maximum":99999,"minimum":-99999,"description":"Affect Credit Rating By is the effect of the credit rating transaction on the account's credit score.","example":"100"},"cashOnlyPoints":{"type":"number","maximum":99999,"minimum":-99999,"description":"Affect Cash-Only Score By is the effect of the credit rating transaction on the account's cash-only score.","example":"100"},"createDate":{"type":"string","format":"date","description":"Creation Date"},"creditRatingCreatedBy":{"type":"string","enum":["COLL","CUTP","MN  ","NSF ","ODP ","OT  ","PP  ","SEV ","WO  "],"description":"The credit rating transaction includes a Created By flag that is customizable using the Lookup table.\n* `COLL` - Collection Process,\n* `CUTP` - Cut Process,\n* `MN  ` - Manual,\n* `NSF ` - NSF Assessment,\n* `ODP ` - Overdue Process,\n* `OT  ` - Other,\n* `PP  ` - Pay Plan,\n* `SEV ` - Severance Process,\n* `WO  ` - Write Off","example":"PP"},"eventSequence":{"type":"number","maximum":999,"minimum":-999,"description":"A sequence is used to define the order of the credit rating event records.","example":"0"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The version number is used for internal concurrency checks.","example":"2"},"comments":{"type":"string","maxLength":254,"description":"Comments can describe anything interesting or unusual about the automatic payment request."},"payPlanId":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"payPlanId":{"type":"string","maxLength":10,"description":"Pay Plan ID"}}},"writeOffProcess":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"writeOffProcessId":{"type":"string","maxLength":10,"description":"Write Off Process ID"}}}}}}}},"nonCashDeposits":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"sequence":{"type":"number","maximum":99999,"minimum":-99999,"description":"A sequence is used to define the order of the records."},"nonCashDepositType":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"nonCashDepositType":{"type":"string","maxLength":8,"description":"Non-Cash Deposit Type"}}},"depositClass":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"depositClass":{"type":"string","maxLength":8,"description":"Deposit Class"}}},"startDate":{"type":"string","format":"date","description":"Start Date indicates the date on which the alert starts showing for the account.","example":"2001-01-01"},"endDate":{"type":"string","format":"date","description":"End Date indicates the date on which the alert stops showing for the account.","example":"2001-01-01"},"depositAmount":{"type":"string","maxLength":15,"description":"Amount of the non-cash deposit."},"documentNumber":{"type":"string","maxLength":20,"description":"Document Number associated with the non-cash deposit.For example, the letter of credit number, the surety bond number, and so on."},"thirdPartySa":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"thirdPartySaId":{"type":"string","maxLength":10,"description":"Deposit SA ID associated if a third-party has paid the cash deposit for the account.","example":"1589809502"}}},"comments":{"type":"string","maxLength":254,"description":"Comments can describe anything interesting or unusual about the automatic payment request."},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The version number is used for internal concurrency checks.","example":"2"}}}}}},"accountPersons":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"personId":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"personId":{"type":"string","maxLength":10,"description":"Person ID"}}},"accountRelationshipType":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"accountRelationshipType":{"type":"string","maxLength":8,"description":"Account Relationship Type"}}},"billAddressSource":{"type":"string","enum":["ACOV","PER ","PREM"],"description":"Address Source indicates the mailing address source if bills are routed using the postal service.","example":"PREM"},"isMainCustomer":{"type":"boolean","description":"Main Customer is defined as true if the person is the main customer on the account. Only one person on an account can be designated as the main customer.","example":"true"},"isFinanciallyResponsible":{"type":"boolean","description":"Financially Responsible is defined as true if the person is financially responsible for the account's debt.","example":"true"},"isThirdPartyGuarantor":{"type":"boolean","description":"Third Party Guarantor is defined as true if the person is a third-party guarantor of the account's debt.","example":"false"},"shouldReceiveCopyOfBill":{"type":"boolean","description":"Receives Copy of Bill is defined as true if the person receives a copy of the account's bills.","example":"true"},"billRouteType":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"billRouteType":{"type":"string","maxLength":8,"description":"Bill Route Type indicates how the bill is sent to the customer. This field's default value is retrieved from the Installation record."}}},"billFormat":{"type":"string","enum":["D   ","S   "],"description":"Bill Format indicates if the customer should receive a detailed or a summary bill.\n* `D   ` - Detailed,\n* `S   ` - Summary","example":"D"},"numberOfBillCopies":{"type":"number","maximum":99,"minimum":-99,"description":"Number of Bill Copies Indicates how many copies of the bill the person receives.","example":"1"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The version number is used for internal concurrency checks.","example":"2"},"customerPOId":{"type":"string","maxLength":20,"description":"Customer PO ID indicates if the customer wants a purchase order number printed on their copy of the bill."},"receivesNotification":{"type":"boolean","description":"Allow Communication Preference defined as true if the person's contacts can be used on communication preferences for this account.","example":"true"},"prefixSuffixName":{"type":"string","maxLength":50,"description":"Additional information to append to a customer's name when correspondence or bills are sent to this person."},"prefixOrSuffix":{"type":"string","enum":["PX  ","SX  "],"description":"The Prefix or Suffix flag indicates if the Prefix or Suffix Name is appended to the front or the back of the customer's name on correspondence.\n* `PX  ` - Prefix to Name,\n* `SX  ` - Suffix to Name","example":"PX"},"quoteRouteType":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"quoteRouteType":{"type":"string","maxLength":12,"description":"Quote Route Type"}}},"shouldReceiveCopyOfQuote":{"type":"boolean","description":"Receives Copy of Quote is defined as true if the person receives a copy of the account's quotes.","example":"false"},"webAccess":{"type":"string","enum":["ALWD","NALW"],"description":"Web Access indicates if the related person is allowed web access for customer self-service.\n* `ALWD` - Allowed,\n* `NALW` - Not allowed","example":"NALW"},"personAddressOverride":{"type":"array","items":{"type":"object","properties":{"address1":{"type":"string","maxLength":254,"description":"The first line of the address."},"address2":{"type":"string","maxLength":254,"description":"The second line of the address."},"address3":{"type":"string","maxLength":254,"description":"The third line of the address."},"address4":{"type":"string","maxLength":254,"description":"The fourth line of the address."},"city":{"type":"string","maxLength":90,"description":"The city of the address."},"streetNumber1":{"type":"string","maxLength":6,"description":"The first street number line of the address."},"streetNumber2":{"type":"string","maxLength":4,"description":"The second street number line of the address."},"county":{"type":"string","maxLength":90,"description":"The county of the address."},"postal":{"type":"string","maxLength":12,"description":"The postal code of the address."},"houseType":{"type":"string","enum":["AB  ","WW  "],"description":"House Type indicates the type of house.\n* `AB  ` - House Boat References,\n* `WW  ` - House Trailer Reference"},"taxVendorGeographicalCode":{"type":"string","maxLength":11,"description":"Geographic code used to apply proper taxation rules to the physical address location."},"isInCityLimit":{"type":"boolean","description":"In City Limit is defined as true if the address is considered within the physical city limits."},"state":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"state":{"type":"string","maxLength":6,"description":"State"}}},"country":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"country":{"type":"string","maxLength":3,"description":"Country"}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The version number is used for internal concurrency checks.","example":"2"}}}}}}}}}},"xml":{"name":"C1-CXAccount"}},"DELETEACCOUNT_request":{"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":"1589809032"}},"xml":{"name":"C1-DeleteAct"}},"CREATEACCOUNT_response":{"type":"object","properties":{"_self":{"type":"string","description":"_self"},"accountId":{"type":"string","maxLength":10,"description":"The Account ID is a system-assigned random number that stays with an account for life.","example":"1589809032"},"billCycle":{"type":"object","description":"Bill Cycle Code controls the schedule of when a bill should be generated for an account.","properties":{"_link":{"type":"string","description":"_link"},"billCycle":{"type":"string","maxLength":4,"description":"Bill Cycle Code controls the schedule of when a bill should be generated for an account.","example":"MO17"}}},"setUpDate":{"type":"string","format":"date","description":"Set Up Date is the date the account was initially created.","example":"2001-01-01"},"currency":{"type":"object","description":"Currency Code defines the currency in which the account's financial transactions are expressed.","properties":{"_link":{"type":"string","description":"_link"},"currency":{"type":"string","maxLength":3,"description":"Currency Code defines the currency in which the account's financial transactions are expressed.","example":"USD"}}},"accountManagementGroup":{"type":"object","description":"The Account Management Group controls the roles assigned to To Do entries associated with an account.","properties":{"_link":{"type":"string","description":"_link"},"accountManagementGroup":{"type":"string","maxLength":10,"description":"The Account Management Group controls the roles assigned to To Do entries associated with an account.","example":"LANDLORD"}}},"alertInformation":{"type":"string","maxLength":4000,"description":"Alerts highlight important information to any customer service representative who looks at the account."},"billAfterDate":{"type":"string","format":"date","description":"Bill After Date postpones billing until after a future date.","example":"2001-01-01"},"shouldProtectBillCycle":{"type":"boolean","description":"When defined as true, the system does not change the bill cycle when a service agreement is activated. By default, service agreement activation can modify the bill cycle.","example":"false"},"division":{"type":"object","description":"CIS Division defines the jurisdiction that governs this account.","properties":{"_link":{"type":"string","description":"_link"},"division":{"type":"string","maxLength":5,"description":"CIS Division defines the jurisdiction that governs this account.","example":"CA"}}},"mailingPremise":{"type":"object","description":"Mailing Premise ID defines the address on bills for persons who have their bill sent to the account's mailing premise. This field can be updated by the system when a service agreement is activated.","properties":{"_link":{"type":"string","description":"_link"},"mailingPremiseId":{"type":"string","maxLength":10,"description":"Mailing Premise ID defines the address on bills for persons who have their bill sent to the account's mailing premise. This field can be updated by the system when a service agreement is activated.","example":"3308038454"}}},"shouldProtectMailingPremise":{"type":"boolean","description":"When defined as true, the mailing premise is not modified when a service agreement is activated. If defined as false, the mailing address can be updated when a service agreement is activated.","example":"true"},"collectionClass":{"type":"object","description":"Collection Class controls how the account's debt is compared against collection criteria to determine if a collection process should be started.","properties":{"_link":{"type":"string","description":"_link"},"collectionClass":{"type":"string","maxLength":10,"description":"Collection Class controls how the account's debt is compared against collection criteria to determine if a collection process should be started.","example":"RESID"}}},"lastCreditReviewDate":{"type":"string","format":"date","description":"Last Credit Review Date is the date when the account's debt was last reviewed by the account debt monitor (ADM) background process.","example":"2016-10-26"},"postponeCreditReviewUntilDate":{"type":"string","format":"date","description":"Defining a future data prevents an account from being reviewed by credit and collections processes, such as the account debt monitor and the write-off monitor, until after the defined date."},"customerClass":{"type":"object","description":"Customer Class controls financial parameters related to billing and collections.","properties":{"_link":{"type":"string","description":"_link"},"customerClass":{"type":"string","maxLength":8,"description":"Customer Class controls financial parameters related to billing and collections.","example":"R"}}},"billPrintIntercept":{"type":"object","description":"Provide a user's ID to require review of the account's printed bills before they are sent to the customer.","properties":{"_link":{"type":"string","description":"_link"},"billPrintIntercept":{"type":"string","maxLength":8,"description":"Provide a user's ID to require review of the account's printed bills before they are sent to the customer.","example":"MBRAZIL\n(Brazil, Mark)"}}},"doNotReviewDeposit":{"type":"boolean","description":"When defined as true, the account is not considered by the Deposit Review background process or by the Deposit Refund background process.","example":"true"},"budgetPlan":{"type":"object","description":"Budget Plan controls how the account's debt is managed for budget-related purposes.","properties":{"_link":{"type":"string","description":"_link"},"budgetPlan":{"type":"string","maxLength":8,"description":"Budget Plan controls how the account's debt is managed for budget-related purposes.","example":"RES BUD"}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The version number is used for internal concurrency checks.","example":"2"},"shouldProtectDivision":{"type":"boolean","description":"When defined as true, assigned CIS divisions are not modified when a service agreement is activated. By default, service agreement activation can modify the CIS division.","example":"false"},"accessGroup":{"type":"object","description":"Access Group controls which users are allowed to view and update this account's information, including bills, service agreements, payments, and premises.","properties":{"_link":{"type":"string","description":"_link"},"accessGroup":{"type":"string","maxLength":12,"description":"Access Group controls which users are allowed to view and update this account's information, including bills, service agreements, payments, and premises.","example":"***"}}},"characteristics":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"effectiveDate":{"type":"string","format":"date","description":"Effective Date defines the date on which the characteristic becomes effective. The effective date defaults from the Installation Record.","example":"2001-01-01"},"characteristicType":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"characteristicType":{"type":"string","maxLength":8,"description":"Characteristic Type indicates the type of characteristic.","example":"NEWACCT"}}},"typeOfCharacteristicValue":{"type":"string","maxLength":4,"description":"Type of Char Value"},"characteristicValue":{"type":"object","properties":{"_link":{"type":"string","description":"(_link)"},"value":{"type":"string","description":"(value)"},"value2":{"type":"string","description":"(value2)"},"value3":{"type":"string","description":"(value3)"},"value4":{"type":"string","description":"(value4)"},"value5":{"type":"string","description":"(value5)"}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The version number is used for internal concurrency checks.","example":"2"}}}}}},"alerts":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"alertType":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"alertType":{"type":"string","maxLength":10,"description":"Alert Type indicates the type of alert to show for the account.","example":"PA BLOCK \n(Payment Arrangements are not allowed for this Account)"}}},"startDate":{"type":"string","format":"date","description":"Start Date indicates the date on which the alert starts showing for the account.","example":"2001-01-01"},"endDate":{"type":"string","format":"date","description":"End Date indicates the date on which the alert stops showing for the account.","example":"2001-01-01"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The version number is used for internal concurrency checks.","example":"2"}}}}}},"autoPay":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"accountAutoPay":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"accountAutoPayId":{"type":"string","maxLength":10,"description":"Auto Pay ID"}}},"startDate":{"type":"string","format":"date","description":"Start Date indicates the date on which the alert starts showing for the account.","example":"2001-01-01"},"endDate":{"type":"string","format":"date","description":"End Date indicates the date on which the alert stops showing for the account.","example":"2001-01-01"},"autoPaySource":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"autoPaySource":{"type":"string","maxLength":12,"description":"Auto Pay Source is used to define the source of the funds, such as a banking institution, used to satisfy the automatic payment request."}}},"externalAccountId":{"type":"string","maxLength":50,"description":"Use External Account ID to define the customer's bank account or credit card number.","example":"******789"},"expireDate":{"type":"string","format":"date","description":"Expires On date is used if the Auto Pay Source Code references a tender type that requires an expiration date.","example":"2001-01-01"},"entityName":{"type":"string","maxLength":254,"description":"Name of the customer as it appears in the financial institution's system.","example":"Brazil, Mark"},"comments":{"type":"string","maxLength":254,"description":"Comments can describe anything interesting or unusual about the automatic payment request."},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The version number is used for internal concurrency checks.","example":"2"},"autoPayMaxWithdrawalAmount":{"type":"number","description":"Maximum Withdrawal Amount limits the amount of money that is automatically debited from an account.","example":"$50.00"},"autoPayMethod":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"autoPayMethod":{"type":"string","enum":["C1DD","C1PA"],"description":"Auto Pay Method defines whether the system should process automatic payments as Direct Debit or Payment Advice."}}}}}}}},"messages":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"billMessage":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"billMessage":{"type":"string","maxLength":4,"description":"Bill Message is a message that appears on the customer's bill."}}},"billMessageExpanded":{"type":"string","maxLength":254,"description":"Message on Bill"},"billMessageType":{"type":"string","enum":["P   ","T   "],"description":"Bill Message Type indicates if the message should remain permanent or temporarily only be linked to the next bill produced for the account.\n* `P   ` - Permanent,\n* `T   ` - Temporary","example":"T"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The version number is used for internal concurrency checks.","example":"2"}}}}}},"creditRatingHistory":{"type":"object","description":"Account Credit Rating History collection contains one entry for each credit rating history record associated with the account.","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"creditRatingHistoryId":{"type":"string","maxLength":10,"description":"Credit Rating History ID"},"user":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"userId":{"type":"string","maxLength":8,"description":"User that created the record.","example":"CDX"}}},"collectionProcess":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"collectionProcessId":{"type":"string","maxLength":10,"description":"Collection Process ID is the unique system-generated identifier for this collection process.","example":"1589809419"}}},"startDate":{"type":"string","format":"date","description":"Start Date indicates the date on which the alert starts showing for the account.","example":"2001-01-01"},"severanceProcessId":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"severanceProcessId":{"type":"string","maxLength":10,"description":"Severance Process ID is the unique system-generated identifier for this severance process.","example":"1589809419"}}},"endDate":{"type":"string","format":"date","description":"End Date indicates the date on which the alert stops showing for the account.","example":"2001-01-01"},"affectCreditRatingBy":{"type":"number","maximum":99999,"minimum":-99999,"description":"Affect Credit Rating By is the effect of the credit rating transaction on the account's credit score.","example":"100"},"cashOnlyPoints":{"type":"number","maximum":99999,"minimum":-99999,"description":"Affect Cash-Only Score By is the effect of the credit rating transaction on the account's cash-only score.","example":"100"},"createDate":{"type":"string","format":"date","description":"Creation Date"},"creditRatingCreatedBy":{"type":"string","enum":["COLL","CUTP","MN  ","NSF ","ODP ","OT  ","PP  ","SEV ","WO  "],"description":"The credit rating transaction includes a Created By flag that is customizable using the Lookup table.\n* `COLL` - Collection Process,\n* `CUTP` - Cut Process,\n* `MN  ` - Manual,\n* `NSF ` - NSF Assessment,\n* `ODP ` - Overdue Process,\n* `OT  ` - Other,\n* `PP  ` - Pay Plan,\n* `SEV ` - Severance Process,\n* `WO  ` - Write Off","example":"PP"},"eventSequence":{"type":"number","maximum":999,"minimum":-999,"description":"A sequence is used to define the order of the credit rating event records.","example":"0"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The version number is used for internal concurrency checks.","example":"2"},"comments":{"type":"string","maxLength":254,"description":"Comments can describe anything interesting or unusual about the automatic payment request."},"payPlanId":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"payPlanId":{"type":"string","maxLength":10,"description":"Pay Plan ID"}}},"writeOffProcess":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"writeOffProcessId":{"type":"string","maxLength":10,"description":"Write Off Process ID"}}}}}}}},"nonCashDeposits":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"sequence":{"type":"number","maximum":99999,"minimum":-99999,"description":"A sequence is used to define the order of the records."},"nonCashDepositType":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"nonCashDepositType":{"type":"string","maxLength":8,"description":"Non-Cash Deposit Type"}}},"depositClass":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"depositClass":{"type":"string","maxLength":8,"description":"Deposit Class"}}},"startDate":{"type":"string","format":"date","description":"Start Date indicates the date on which the alert starts showing for the account.","example":"2001-01-01"},"endDate":{"type":"string","format":"date","description":"End Date indicates the date on which the alert stops showing for the account.","example":"2001-01-01"},"depositAmount":{"type":"string","maxLength":15,"description":"Amount of the non-cash deposit."},"documentNumber":{"type":"string","maxLength":20,"description":"Document Number associated with the non-cash deposit.For example, the letter of credit number, the surety bond number, and so on."},"thirdPartySa":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"thirdPartySaId":{"type":"string","maxLength":10,"description":"Deposit SA ID associated if a third-party has paid the cash deposit for the account.","example":"1589809502"}}},"comments":{"type":"string","maxLength":254,"description":"Comments can describe anything interesting or unusual about the automatic payment request."},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The version number is used for internal concurrency checks.","example":"2"}}}}}},"accountPersons":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"personId":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"personId":{"type":"string","maxLength":10,"description":"Person ID"}}},"accountRelationshipType":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"accountRelationshipType":{"type":"string","maxLength":8,"description":"Account Relationship Type"}}},"billAddressSource":{"type":"string","enum":["ACOV","PER ","PREM"],"description":"Address Source indicates the mailing address source if bills are routed using the postal service.","example":"PREM"},"isMainCustomer":{"type":"boolean","description":"Main Customer is defined as true if the person is the main customer on the account. Only one person on an account can be designated as the main customer.","example":"true"},"isFinanciallyResponsible":{"type":"boolean","description":"Financially Responsible is defined as true if the person is financially responsible for the account's debt.","example":"true"},"isThirdPartyGuarantor":{"type":"boolean","description":"Third Party Guarantor is defined as true if the person is a third-party guarantor of the account's debt.","example":"false"},"shouldReceiveCopyOfBill":{"type":"boolean","description":"Receives Copy of Bill is defined as true if the person receives a copy of the account's bills.","example":"true"},"billRouteType":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"billRouteType":{"type":"string","maxLength":8,"description":"Bill Route Type indicates how the bill is sent to the customer. This field's default value is retrieved from the Installation record."}}},"billFormat":{"type":"string","enum":["D   ","S   "],"description":"Bill Format indicates if the customer should receive a detailed or a summary bill.\n* `D   ` - Detailed,\n* `S   ` - Summary","example":"D"},"numberOfBillCopies":{"type":"number","maximum":99,"minimum":-99,"description":"Number of Bill Copies Indicates how many copies of the bill the person receives.","example":"1"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The version number is used for internal concurrency checks.","example":"2"},"customerPOId":{"type":"string","maxLength":20,"description":"Customer PO ID indicates if the customer wants a purchase order number printed on their copy of the bill."},"receivesNotification":{"type":"boolean","description":"Allow Communication Preference defined as true if the person's contacts can be used on communication preferences for this account.","example":"true"},"prefixSuffixName":{"type":"string","maxLength":50,"description":"Additional information to append to a customer's name when correspondence or bills are sent to this person."},"prefixOrSuffix":{"type":"string","enum":["PX  ","SX  "],"description":"The Prefix or Suffix flag indicates if the Prefix or Suffix Name is appended to the front or the back of the customer's name on correspondence.\n* `PX  ` - Prefix to Name,\n* `SX  ` - Suffix to Name","example":"PX"},"quoteRouteType":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"quoteRouteType":{"type":"string","maxLength":12,"description":"Quote Route Type"}}},"shouldReceiveCopyOfQuote":{"type":"boolean","description":"Receives Copy of Quote is defined as true if the person receives a copy of the account's quotes.","example":"false"},"webAccess":{"type":"string","enum":["ALWD","NALW"],"description":"Web Access indicates if the related person is allowed web access for customer self-service.\n* `ALWD` - Allowed,\n* `NALW` - Not allowed","example":"NALW"},"personAddressOverride":{"type":"array","items":{"type":"object","properties":{"address1":{"type":"string","maxLength":254,"description":"The first line of the address."},"address2":{"type":"string","maxLength":254,"description":"The second line of the address."},"address3":{"type":"string","maxLength":254,"description":"The third line of the address."},"address4":{"type":"string","maxLength":254,"description":"The fourth line of the address."},"city":{"type":"string","maxLength":90,"description":"The city of the address."},"streetNumber1":{"type":"string","maxLength":6,"description":"The first street number line of the address."},"streetNumber2":{"type":"string","maxLength":4,"description":"The second street number line of the address."},"county":{"type":"string","maxLength":90,"description":"The county of the address."},"postal":{"type":"string","maxLength":12,"description":"The postal code of the address."},"houseType":{"type":"string","enum":["AB  ","WW  "],"description":"House Type indicates the type of house.\n* `AB  ` - House Boat References,\n* `WW  ` - House Trailer Reference"},"taxVendorGeographicalCode":{"type":"string","maxLength":11,"description":"Geographic code used to apply proper taxation rules to the physical address location."},"isInCityLimit":{"type":"boolean","description":"In City Limit is defined as true if the address is considered within the physical city limits."},"state":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"state":{"type":"string","maxLength":6,"description":"State"}}},"country":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"country":{"type":"string","maxLength":3,"description":"Country"}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The version number is used for internal concurrency checks.","example":"2"}}}}}}}}}},"xml":{"name":"C1-CXAccount"}},"problemDetailDocument":{"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."}}}}},"DELETEACCOUNT_response":{"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":"1589809032"}},"xml":{"name":"C1-DeleteAct"}},"UPDATEACCOUNT_request":{"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":"1589809032"},"billCycle":{"type":"object","description":"Bill Cycle Code controls the schedule of when a bill should be generated for an account.","properties":{"billCycle":{"type":"string","maxLength":4,"description":"Bill Cycle Code controls the schedule of when a bill should be generated for an account.","example":"MO17"}}},"setUpDate":{"type":"string","format":"date","description":"Set Up Date is the date the account was initially created.","example":"2001-01-01"},"currency":{"type":"object","description":"Currency Code defines the currency in which the account's financial transactions are expressed.","properties":{"currency":{"type":"string","maxLength":3,"description":"Currency Code defines the currency in which the account's financial transactions are expressed.","example":"USD"}}},"accountManagementGroup":{"type":"object","description":"The Account Management Group controls the roles assigned to To Do entries associated with an account.","properties":{"accountManagementGroup":{"type":"string","maxLength":10,"description":"The Account Management Group controls the roles assigned to To Do entries associated with an account.","example":"LANDLORD"}}},"alertInformation":{"type":"string","maxLength":4000,"description":"Alerts highlight important information to any customer service representative who looks at the account."},"billAfterDate":{"type":"string","format":"date","description":"Bill After Date postpones billing until after a future date.","example":"2001-01-01"},"shouldProtectBillCycle":{"type":"boolean","description":"When defined as true, the system does not change the bill cycle when a service agreement is activated. By default, service agreement activation can modify the bill cycle.","example":"false"},"division":{"type":"object","description":"CIS Division defines the jurisdiction that governs this account.","properties":{"division":{"type":"string","maxLength":5,"description":"CIS Division defines the jurisdiction that governs this account.","example":"CA"}}},"mailingPremise":{"type":"object","description":"Mailing Premise ID defines the address on bills for persons who have their bill sent to the account's mailing premise. This field can be updated by the system when a service agreement is activated.","properties":{"mailingPremiseId":{"type":"string","maxLength":10,"description":"Mailing Premise ID defines the address on bills for persons who have their bill sent to the account's mailing premise. This field can be updated by the system when a service agreement is activated."}}},"shouldProtectMailingPremise":{"type":"boolean","description":"When defined as true, the mailing premise is not modified when a service agreement is activated. If defined as false, the mailing address can be updated when a service agreement is activated.","example":"true"},"collectionClass":{"type":"object","description":"Collection Class controls how the account's debt is compared against collection criteria to determine if a collection process should be started.","properties":{"collectionClass":{"type":"string","maxLength":10,"description":"Collection Class controls how the account's debt is compared against collection criteria to determine if a collection process should be started.","example":"RESID"}}},"lastCreditReviewDate":{"type":"string","format":"date","description":"Last Credit Review Date is the date when the account's debt was last reviewed by the account debt monitor (ADM) background process.","example":"2016-10-26"},"postponeCreditReviewUntilDate":{"type":"string","format":"date","description":"Defining a future data prevents an account from being reviewed by credit and collections processes, such as the account debt monitor and the write-off monitor, until after the defined date."},"customerClass":{"type":"object","description":"Customer Class controls financial parameters related to billing and collections.","properties":{"customerClass":{"type":"string","maxLength":8,"description":"Customer Class controls financial parameters related to billing and collections.","example":"R"}}},"billPrintIntercept":{"type":"object","description":"Provide a user's ID to require review of the account's printed bills before they are sent to the customer.","properties":{"billPrintIntercept":{"type":"string","maxLength":8,"description":"Provide a user's ID to require review of the account's printed bills before they are sent to the customer.","example":"MBRAZIL\n(Brazil, Mark)"}}},"doNotReviewDeposit":{"type":"boolean","description":"When defined as true, the account is not considered by the Deposit Review background process or by the Deposit Refund background process.","example":"true"},"budgetPlan":{"type":"object","description":"Budget Plan controls how the account's debt is managed for budget-related purposes.","properties":{"budgetPlan":{"type":"string","maxLength":8,"description":"Budget Plan controls how the account's debt is managed for budget-related purposes.","example":"RES BUD"}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The version number is used for internal concurrency checks.","example":"2"},"shouldProtectDivision":{"type":"boolean","description":"When defined as true, assigned CIS divisions are not modified when a service agreement is activated. By default, service agreement activation can modify the CIS division.","example":"false"},"accessGroup":{"type":"object","description":"Access Group controls which users are allowed to view and update this account's information, including bills, service agreements, payments, and premises.","properties":{"accessGroup":{"type":"string","maxLength":12,"description":"Access Group controls which users are allowed to view and update this account's information, including bills, service agreements, payments, and premises.","example":"***"}}},"characteristics":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"effectiveDate":{"type":"string","format":"date","description":"Effective Date defines the date on which the characteristic becomes effective. The effective date defaults from the Installation Record.","example":"2001-01-01"},"characteristicType":{"type":"object","properties":{"characteristicType":{"type":"string","maxLength":8,"description":"Characteristic Type"}}},"characteristicValue":{"type":"object","properties":{"_link":{"type":"string","description":"(_link)"},"value":{"type":"string","description":"(value)"},"value2":{"type":"string","description":"(value2)"},"value3":{"type":"string","description":"(value3)"},"value4":{"type":"string","description":"(value4)"},"value5":{"type":"string","description":"(value5)"}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The version number is used for internal concurrency checks.","example":"2"}}}}}},"alerts":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"alertType":{"type":"object","properties":{"alertType":{"type":"string","maxLength":10,"description":"Alert Type"}}},"startDate":{"type":"string","format":"date","description":"Start Date indicates the date on which the alert starts showing for the account.","example":"2001-01-01"},"endDate":{"type":"string","format":"date","description":"End Date indicates the date on which the alert stops showing for the account.","example":"2001-01-01"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The version number is used for internal concurrency checks.","example":"2"}}}}}},"autoPay":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"accountAutoPay":{"type":"object","properties":{"accountAutoPayId":{"type":"string","maxLength":10,"description":"Auto Pay ID"}}},"startDate":{"type":"string","format":"date","description":"Start Date indicates the date on which the alert starts showing for the account.","example":"2001-01-01"},"endDate":{"type":"string","format":"date","description":"End Date indicates the date on which the alert stops showing for the account.","example":"2001-01-01"},"autoPaySource":{"type":"object","properties":{"autoPaySource":{"type":"string","maxLength":12,"description":"Auto Pay Source is used to define the source of the funds, such as a banking institution, used to satisfy the automatic payment request."}}},"externalAccountId":{"type":"string","maxLength":50,"description":"Use External Account ID to define the customer's bank account or credit card number.","example":"******789"},"expireDate":{"type":"string","format":"date","description":"Expires On date is used if the Auto Pay Source Code references a tender type that requires an expiration date.","example":"2001-01-01"},"entityName":{"type":"string","maxLength":254,"description":"Name of the customer as it appears in the financial institution's system.","example":"Brazil, Mark"},"comments":{"type":"string","maxLength":254,"description":"Comments can describe anything interesting or unusual about the automatic payment request."},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The version number is used for internal concurrency checks.","example":"2"},"autoPayMaxWithdrawalAmount":{"type":"number","description":"Maximum Withdrawal Amount limits the amount of money that is automatically debited from an account."},"autoPayMethod":{"type":"object","properties":{"autoPayMethod":{"type":"string","enum":["C1DD","C1PA"],"description":"Auto Pay Method defines whether the system should process automatic payments as Direct Debit or Payment Advice."}}}}}}}},"messages":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"billMessage":{"type":"object","properties":{"billMessage":{"type":"string","maxLength":4,"description":"Bill Message is a message that appears on the customer's bill."}}},"billMessageType":{"type":"string","enum":["P   ","T   "],"description":"Bill Message Type indicates if the message should remain permanent or temporarily only be linked to the next bill produced for the account.\n* `P   ` - Permanent,\n* `T   ` - Temporary","example":"T"},"messageParameters":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"messageParameterValue":{"type":"string","maxLength":2000,"description":"Message Parameter Value"},"sequence":{"type":"number","maximum":999,"minimum":-999,"description":"Sequence"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The version number is used for internal concurrency checks.","example":"2"}}}}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The version number is used for internal concurrency checks.","example":"2"}}}}}},"creditRatingHistory":{"type":"object","description":"Account Credit Rating History collection contains one entry for each credit rating history record associated with the account.","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"creditRatingHistoryId":{"type":"string","maxLength":10,"description":"The Credit Rating History contains one entry for each credit rating history record associated with the account.","example":"1589809596"},"user":{"type":"object","properties":{"userId":{"type":"string","maxLength":8,"description":"User that created the record.","example":"CDX"}}},"collectionProcess":{"type":"object","properties":{"collectionProcessId":{"type":"string","maxLength":10,"description":"Collection Process ID is the unique system-generated identifier for this collection process.","example":"1589809419"}}},"startDate":{"type":"string","format":"date","description":"Start Date indicates the date on which the alert starts showing for the account.","example":"2001-01-01"},"severanceProcessId":{"type":"object","properties":{"severanceProcessId":{"type":"string","maxLength":10,"description":"Severance Process ID is the unique system-generated identifier for this severance process.","example":"1589809419"}}},"endDate":{"type":"string","format":"date","description":"End Date indicates the date on which the alert stops showing for the account.","example":"2001-01-01"},"affectCreditRatingBy":{"type":"number","maximum":99999,"minimum":-99999,"description":"Affect Credit Rating By is the effect of the credit rating transaction on the account's credit score.","example":"100"},"cashOnlyPoints":{"type":"number","maximum":99999,"minimum":-99999,"description":"Affect Cash-Only Score By is the effect of the credit rating transaction on the account's cash-only score.","example":"100"},"creditRatingCreatedBy":{"type":"string","enum":["COLL","CUTP","MN  ","NSF ","ODP ","OT  ","PP  ","SEV ","WO  "],"description":"The credit rating transaction includes a Created By flag that is customizable using the Lookup table.\n* `COLL` - Collection Process,\n* `CUTP` - Cut Process,\n* `MN  ` - Manual,\n* `NSF ` - NSF Assessment,\n* `ODP ` - Overdue Process,\n* `OT  ` - Other,\n* `PP  ` - Pay Plan,\n* `SEV ` - Severance Process,\n* `WO  ` - Write Off","example":"PP"},"eventSequence":{"type":"number","maximum":999,"minimum":-999,"description":"A sequence is used to define the order of the credit rating event records.","example":"0"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The version number is used for internal concurrency checks.","example":"2"},"comments":{"type":"string","maxLength":254,"description":"Comments can describe anything interesting or unusual about the automatic payment request."},"payPlanId":{"type":"object","properties":{"payPlanId":{"type":"string","maxLength":10,"description":"Pay Plan ID"}}},"writeOffProcess":{"type":"object","properties":{"writeOffProcessId":{"type":"string","maxLength":10,"description":"Write Off Process ID"}}}}}}}},"nonCashDeposits":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"sequence":{"type":"number","maximum":99999,"minimum":-99999,"description":"A sequence is used to define the order of the records."},"nonCashDepositType":{"type":"object","properties":{"nonCashDepositType":{"type":"string","maxLength":8,"description":"Non-Cash Deposit Type"}}},"depositClass":{"type":"object","properties":{"depositClass":{"type":"string","maxLength":8,"description":"Deposit Class"}}},"startDate":{"type":"string","format":"date","description":"Start Date indicates the date on which the alert starts showing for the account.","example":"2001-01-01"},"endDate":{"type":"string","format":"date","description":"End Date indicates the date on which the alert stops showing for the account.","example":"2001-01-01"},"depositAmount":{"type":"string","maxLength":15,"description":"Amount of the non-cash deposit."},"documentNumber":{"type":"string","maxLength":20,"description":"Document Number associated with the non-cash deposit.For example, the letter of credit number, the surety bond number, and so on."},"thirdPartySa":{"type":"object","properties":{"thirdPartySaId":{"type":"string","maxLength":10,"description":"Deposit SA ID associated if a third-party has paid the cash deposit for the account.","example":"1589809502"}}},"comments":{"type":"string","maxLength":254,"description":"Comments can describe anything interesting or unusual about the automatic payment request."},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The version number is used for internal concurrency checks.","example":"2"}}}}}},"accountPersons":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"personId":{"type":"object","properties":{"personId":{"type":"string","maxLength":10,"description":"Person ID"}}},"accountRelationshipType":{"type":"object","properties":{"accountRelationshipType":{"type":"string","maxLength":8,"description":"Account Relationship Type"}}},"billAddressSource":{"type":"string","enum":["ACOV","PER ","PREM"],"description":"Address Source indicates the mailing address source if bills are routed using the postal service.","example":"PREM"},"isMainCustomer":{"type":"boolean","description":"Main Customer is defined as true if the person is the main customer on the account. Only one person on an account can be designated as the main customer.","example":"true"},"isFinanciallyResponsible":{"type":"boolean","description":"Financially Responsible is defined as true if the person is financially responsible for the account's debt.","example":"true"},"isThirdPartyGuarantor":{"type":"boolean","description":"Third Party Guarantor is defined as true if the person is a third-party guarantor of the account's debt.","example":"false"},"shouldReceiveCopyOfBill":{"type":"boolean","description":"Receives Copy of Bill is defined as true if the person receives a copy of the account's bills.","example":"true"},"billRouteType":{"type":"object","properties":{"billRouteType":{"type":"string","maxLength":8,"description":"Bill Route Type indicates how the bill is sent to the customer. This field's default value is retrieved from the Installation record."}}},"billFormat":{"type":"string","enum":["D   ","S   "],"description":"Bill Format indicates if the customer should receive a detailed or a summary bill.\n* `D   ` - Detailed,\n* `S   ` - Summary","example":"D"},"numberOfBillCopies":{"type":"number","maximum":99,"minimum":-99,"description":"Number of Bill Copies Indicates how many copies of the bill the person receives.","example":"1"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The version number is used for internal concurrency checks.","example":"2"},"customerPOId":{"type":"string","maxLength":20,"description":"Customer PO ID indicates if the customer wants a purchase order number printed on their copy of the bill."},"receivesNotification":{"type":"boolean","description":"Allow Communication Preference defined as true if the person's contacts can be used on communication preferences for this account.","example":"true"},"prefixSuffixName":{"type":"string","maxLength":50,"description":"Additional information to append to a customer's name when correspondence or bills are sent to this person."},"prefixOrSuffix":{"type":"string","enum":["PX  ","SX  "],"description":"The Prefix or Suffix flag indicates if the Prefix or Suffix Name is appended to the front or the back of the customer's name on correspondence.\n* `PX  ` - Prefix to Name,\n* `SX  ` - Suffix to Name","example":"PX"},"quoteRouteType":{"type":"object","properties":{"quoteRouteType":{"type":"string","maxLength":12,"description":"Quote Route Type"}}},"shouldReceiveCopyOfQuote":{"type":"boolean","description":"Receives Copy of Quote is defined as true if the person receives a copy of the account's quotes.","example":"false"},"webAccess":{"type":"string","enum":["ALWD","NALW"],"description":"Web Access indicates if the related person is allowed web access for customer self-service.\n* `ALWD` - Allowed,\n* `NALW` - Not allowed","example":"NALW"},"personAddressOverride":{"type":"array","items":{"type":"object","properties":{"address1":{"type":"string","maxLength":254,"description":"The first line of the address."},"address2":{"type":"string","maxLength":254,"description":"The second line of the address."},"address3":{"type":"string","maxLength":254,"description":"The third line of the address."},"address4":{"type":"string","maxLength":254,"description":"The fourth line of the address."},"city":{"type":"string","maxLength":90,"description":"The city of the address."},"streetNumber1":{"type":"string","maxLength":6,"description":"The first street number line of the address."},"streetNumber2":{"type":"string","maxLength":4,"description":"The second street number line of the address."},"county":{"type":"string","maxLength":90,"description":"The county of the address."},"postal":{"type":"string","maxLength":12,"description":"The postal code of the address."},"houseType":{"type":"string","enum":["AB  ","WW  "],"description":"House Type indicates the type of house.\n* `AB  ` - House Boat References,\n* `WW  ` - House Trailer Reference"},"taxVendorGeographicalCode":{"type":"string","maxLength":11,"description":"Geographic code used to apply proper taxation rules to the physical address location."},"isInCityLimit":{"type":"boolean","description":"In City Limit is defined as true if the address is considered within the physical city limits."},"state":{"type":"object","properties":{"state":{"type":"string","maxLength":6,"description":"State"}}},"country":{"type":"object","properties":{"country":{"type":"string","maxLength":3,"description":"Country"}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The version number is used for internal concurrency checks.","example":"2"}}}}}}}}}},"xml":{"name":"C1-CXAccount"}},"UPDATEACCOUNT_response":{"type":"object","properties":{"_self":{"type":"string","description":"_self"},"accountId":{"type":"string","maxLength":10,"description":"The Account ID is a system-assigned random number that stays with an account for life.","example":"1589809032"},"billCycle":{"type":"object","description":"Bill Cycle Code controls the schedule of when a bill should be generated for an account.","properties":{"_link":{"type":"string","description":"_link"},"billCycle":{"type":"string","maxLength":4,"description":"Bill Cycle Code controls the schedule of when a bill should be generated for an account.","example":"MO17"}}},"setUpDate":{"type":"string","format":"date","description":"Set Up Date is the date the account was initially created.","example":"2001-01-01"},"currency":{"type":"object","description":"Currency Code defines the currency in which the account's financial transactions are expressed.","properties":{"_link":{"type":"string","description":"_link"},"currency":{"type":"string","maxLength":3,"description":"Currency Code defines the currency in which the account's financial transactions are expressed.","example":"USD"}}},"accountManagementGroup":{"type":"object","description":"The Account Management Group controls the roles assigned to To Do entries associated with an account.","properties":{"_link":{"type":"string","description":"_link"},"accountManagementGroup":{"type":"string","maxLength":10,"description":"The Account Management Group controls the roles assigned to To Do entries associated with an account.","example":"LANDLORD"}}},"alertInformation":{"type":"string","maxLength":4000,"description":"Alerts highlight important information to any customer service representative who looks at the account."},"billAfterDate":{"type":"string","format":"date","description":"Bill After Date postpones billing until after a future date.","example":"2001-01-01"},"shouldProtectBillCycle":{"type":"boolean","description":"When defined as true, the system does not change the bill cycle when a service agreement is activated. By default, service agreement activation can modify the bill cycle.","example":"false"},"division":{"type":"object","description":"CIS Division defines the jurisdiction that governs this account.","properties":{"_link":{"type":"string","description":"_link"},"division":{"type":"string","maxLength":5,"description":"CIS Division defines the jurisdiction that governs this account.","example":"CA"}}},"mailingPremise":{"type":"object","description":"Mailing Premise ID defines the address on bills for persons who have their bill sent to the account's mailing premise. This field can be updated by the system when a service agreement is activated.","properties":{"_link":{"type":"string","description":"_link"},"mailingPremiseId":{"type":"string","maxLength":10,"description":"Mailing Premise ID defines the address on bills for persons who have their bill sent to the account's mailing premise. This field can be updated by the system when a service agreement is activated."}}},"shouldProtectMailingPremise":{"type":"boolean","description":"When defined as true, the mailing premise is not modified when a service agreement is activated. If defined as false, the mailing address can be updated when a service agreement is activated.","example":"true"},"collectionClass":{"type":"object","description":"Collection Class controls how the account's debt is compared against collection criteria to determine if a collection process should be started.","properties":{"_link":{"type":"string","description":"_link"},"collectionClass":{"type":"string","maxLength":10,"description":"Collection Class controls how the account's debt is compared against collection criteria to determine if a collection process should be started.","example":"RESID"}}},"lastCreditReviewDate":{"type":"string","format":"date","description":"Last Credit Review Date is the date when the account's debt was last reviewed by the account debt monitor (ADM) background process.","example":"2016-10-26"},"postponeCreditReviewUntilDate":{"type":"string","format":"date","description":"Defining a future data prevents an account from being reviewed by credit and collections processes, such as the account debt monitor and the write-off monitor, until after the defined date."},"customerClass":{"type":"object","description":"Customer Class controls financial parameters related to billing and collections.","properties":{"_link":{"type":"string","description":"_link"},"customerClass":{"type":"string","maxLength":8,"description":"Customer Class controls financial parameters related to billing and collections.","example":"R"}}},"billPrintIntercept":{"type":"object","description":"Provide a user's ID to require review of the account's printed bills before they are sent to the customer.","properties":{"_link":{"type":"string","description":"_link"},"billPrintIntercept":{"type":"string","maxLength":8,"description":"Provide a user's ID to require review of the account's printed bills before they are sent to the customer.","example":"MBRAZIL\n(Brazil, Mark)"}}},"doNotReviewDeposit":{"type":"boolean","description":"When defined as true, the account is not considered by the Deposit Review background process or by the Deposit Refund background process.","example":"true"},"budgetPlan":{"type":"object","description":"Budget Plan controls how the account's debt is managed for budget-related purposes.","properties":{"_link":{"type":"string","description":"_link"},"budgetPlan":{"type":"string","maxLength":8,"description":"Budget Plan controls how the account's debt is managed for budget-related purposes.","example":"RES BUD"}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The version number is used for internal concurrency checks.","example":"2"},"shouldProtectDivision":{"type":"boolean","description":"When defined as true, assigned CIS divisions are not modified when a service agreement is activated. By default, service agreement activation can modify the CIS division.","example":"false"},"accessGroup":{"type":"object","description":"Access Group controls which users are allowed to view and update this account's information, including bills, service agreements, payments, and premises.","properties":{"_link":{"type":"string","description":"_link"},"accessGroup":{"type":"string","maxLength":12,"description":"Access Group controls which users are allowed to view and update this account's information, including bills, service agreements, payments, and premises.","example":"***"}}},"characteristics":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"effectiveDate":{"type":"string","format":"date","description":"Effective Date defines the date on which the characteristic becomes effective. The effective date defaults from the Installation Record.","example":"2001-01-01"},"characteristicType":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"characteristicType":{"type":"string","maxLength":8,"description":"Characteristic Type"}}},"typeOfCharacteristicValue":{"type":"string","maxLength":4,"description":"Type of Char Value"},"characteristicValue":{"type":"object","properties":{"_link":{"type":"string","description":"(_link)"},"value":{"type":"string","description":"(value)"},"value2":{"type":"string","description":"(value2)"},"value3":{"type":"string","description":"(value3)"},"value4":{"type":"string","description":"(value4)"},"value5":{"type":"string","description":"(value5)"}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The version number is used for internal concurrency checks.","example":"2"}}}}}},"alerts":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"alertType":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"alertType":{"type":"string","maxLength":10,"description":"Alert Type"}}},"startDate":{"type":"string","format":"date","description":"Start Date indicates the date on which the alert starts showing for the account.","example":"2001-01-01"},"endDate":{"type":"string","format":"date","description":"End Date indicates the date on which the alert stops showing for the account.","example":"2001-01-01"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The version number is used for internal concurrency checks.","example":"2"}}}}}},"autoPay":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"accountAutoPay":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"accountAutoPayId":{"type":"string","maxLength":10,"description":"Auto Pay ID"}}},"startDate":{"type":"string","format":"date","description":"Start Date indicates the date on which the alert starts showing for the account.","example":"2001-01-01"},"endDate":{"type":"string","format":"date","description":"End Date indicates the date on which the alert stops showing for the account.","example":"2001-01-01"},"autoPaySource":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"autoPaySource":{"type":"string","maxLength":12,"description":"Auto Pay Source is used to define the source of the funds, such as a banking institution, used to satisfy the automatic payment request."}}},"externalAccountId":{"type":"string","maxLength":50,"description":"Use External Account ID to define the customer's bank account or credit card number.","example":"******789"},"expireDate":{"type":"string","format":"date","description":"Expires On date is used if the Auto Pay Source Code references a tender type that requires an expiration date.","example":"2001-01-01"},"entityName":{"type":"string","maxLength":254,"description":"Name of the customer as it appears in the financial institution's system.","example":"Brazil, Mark"},"comments":{"type":"string","maxLength":254,"description":"Comments can describe anything interesting or unusual about the automatic payment request."},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The version number is used for internal concurrency checks.","example":"2"},"autoPayMaxWithdrawalAmount":{"type":"number","description":"Maximum Withdrawal Amount limits the amount of money that is automatically debited from an account."},"autoPayMethod":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"autoPayMethod":{"type":"string","enum":["C1DD","C1PA"],"description":"Auto Pay Method defines whether the system should process automatic payments as Direct Debit or Payment Advice."}}}}}}}},"messages":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"billMessage":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"billMessage":{"type":"string","maxLength":4,"description":"Bill Message is a message that appears on the customer's bill."}}},"billMessageExpanded":{"type":"string","maxLength":254,"description":"Message on Bill"},"billMessageType":{"type":"string","enum":["P   ","T   "],"description":"Bill Message Type indicates if the message should remain permanent or temporarily only be linked to the next bill produced for the account.\n* `P   ` - Permanent,\n* `T   ` - Temporary","example":"T"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The version number is used for internal concurrency checks.","example":"2"}}}}}},"creditRatingHistory":{"type":"object","description":"Account Credit Rating History collection contains one entry for each credit rating history record associated with the account.","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"creditRatingHistoryId":{"type":"string","maxLength":10,"description":"The Credit Rating History contains one entry for each credit rating history record associated with the account.","example":"1589809596"},"user":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"userId":{"type":"string","maxLength":8,"description":"User that created the record.","example":"CDX"}}},"collectionProcess":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"collectionProcessId":{"type":"string","maxLength":10,"description":"Collection Process ID is the unique system-generated identifier for this collection process.","example":"1589809419"}}},"startDate":{"type":"string","format":"date","description":"Start Date indicates the date on which the alert starts showing for the account.","example":"2001-01-01"},"severanceProcessId":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"severanceProcessId":{"type":"string","maxLength":10,"description":"Severance Process ID is the unique system-generated identifier for this severance process.","example":"1589809419"}}},"endDate":{"type":"string","format":"date","description":"End Date indicates the date on which the alert stops showing for the account.","example":"2001-01-01"},"affectCreditRatingBy":{"type":"number","maximum":99999,"minimum":-99999,"description":"Affect Credit Rating By is the effect of the credit rating transaction on the account's credit score.","example":"100"},"cashOnlyPoints":{"type":"number","maximum":99999,"minimum":-99999,"description":"Affect Cash-Only Score By is the effect of the credit rating transaction on the account's cash-only score.","example":"100"},"createDate":{"type":"string","format":"date","description":"Creation Date"},"creditRatingCreatedBy":{"type":"string","enum":["COLL","CUTP","MN  ","NSF ","ODP ","OT  ","PP  ","SEV ","WO  "],"description":"The credit rating transaction includes a Created By flag that is customizable using the Lookup table.\n* `COLL` - Collection Process,\n* `CUTP` - Cut Process,\n* `MN  ` - Manual,\n* `NSF ` - NSF Assessment,\n* `ODP ` - Overdue Process,\n* `OT  ` - Other,\n* `PP  ` - Pay Plan,\n* `SEV ` - Severance Process,\n* `WO  ` - Write Off","example":"PP"},"eventSequence":{"type":"number","maximum":999,"minimum":-999,"description":"A sequence is used to define the order of the credit rating event records.","example":"0"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The version number is used for internal concurrency checks.","example":"2"},"comments":{"type":"string","maxLength":254,"description":"Comments can describe anything interesting or unusual about the automatic payment request."},"payPlanId":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"payPlanId":{"type":"string","maxLength":10,"description":"Pay Plan ID"}}},"writeOffProcess":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"writeOffProcessId":{"type":"string","maxLength":10,"description":"Write Off Process ID"}}}}}}}},"nonCashDeposits":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"sequence":{"type":"number","maximum":99999,"minimum":-99999,"description":"A sequence is used to define the order of the records."},"nonCashDepositType":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"nonCashDepositType":{"type":"string","maxLength":8,"description":"Non-Cash Deposit Type"}}},"depositClass":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"depositClass":{"type":"string","maxLength":8,"description":"Deposit Class"}}},"startDate":{"type":"string","format":"date","description":"Start Date indicates the date on which the alert starts showing for the account.","example":"2001-01-01"},"endDate":{"type":"string","format":"date","description":"End Date indicates the date on which the alert stops showing for the account.","example":"2001-01-01"},"depositAmount":{"type":"string","maxLength":15,"description":"Amount of the non-cash deposit."},"documentNumber":{"type":"string","maxLength":20,"description":"Document Number associated with the non-cash deposit.For example, the letter of credit number, the surety bond number, and so on."},"thirdPartySa":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"thirdPartySaId":{"type":"string","maxLength":10,"description":"Deposit SA ID associated if a third-party has paid the cash deposit for the account.","example":"1589809502"}}},"comments":{"type":"string","maxLength":254,"description":"Comments can describe anything interesting or unusual about the automatic payment request."},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The version number is used for internal concurrency checks.","example":"2"}}}}}},"accountPersons":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"personId":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"personId":{"type":"string","maxLength":10,"description":"Person ID"}}},"accountRelationshipType":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"accountRelationshipType":{"type":"string","maxLength":8,"description":"Account Relationship Type"}}},"billAddressSource":{"type":"string","enum":["ACOV","PER ","PREM"],"description":"Address Source indicates the mailing address source if bills are routed using the postal service.","example":"PREM"},"isMainCustomer":{"type":"boolean","description":"Main Customer is defined as true if the person is the main customer on the account. Only one person on an account can be designated as the main customer.","example":"true"},"isFinanciallyResponsible":{"type":"boolean","description":"Financially Responsible is defined as true if the person is financially responsible for the account's debt.","example":"true"},"isThirdPartyGuarantor":{"type":"boolean","description":"Third Party Guarantor is defined as true if the person is a third-party guarantor of the account's debt.","example":"false"},"shouldReceiveCopyOfBill":{"type":"boolean","description":"Receives Copy of Bill is defined as true if the person receives a copy of the account's bills.","example":"true"},"billRouteType":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"billRouteType":{"type":"string","maxLength":8,"description":"Bill Route Type indicates how the bill is sent to the customer. This field's default value is retrieved from the Installation record."}}},"billFormat":{"type":"string","enum":["D   ","S   "],"description":"Bill Format indicates if the customer should receive a detailed or a summary bill.\n* `D   ` - Detailed,\n* `S   ` - Summary","example":"D"},"numberOfBillCopies":{"type":"number","maximum":99,"minimum":-99,"description":"Number of Bill Copies Indicates how many copies of the bill the person receives.","example":"1"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The version number is used for internal concurrency checks.","example":"2"},"customerPOId":{"type":"string","maxLength":20,"description":"Customer PO ID indicates if the customer wants a purchase order number printed on their copy of the bill."},"receivesNotification":{"type":"boolean","description":"Allow Communication Preference defined as true if the person's contacts can be used on communication preferences for this account.","example":"true"},"prefixSuffixName":{"type":"string","maxLength":50,"description":"Additional information to append to a customer's name when correspondence or bills are sent to this person."},"prefixOrSuffix":{"type":"string","enum":["PX  ","SX  "],"description":"The Prefix or Suffix flag indicates if the Prefix or Suffix Name is appended to the front or the back of the customer's name on correspondence.\n* `PX  ` - Prefix to Name,\n* `SX  ` - Suffix to Name","example":"PX"},"quoteRouteType":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"quoteRouteType":{"type":"string","maxLength":12,"description":"Quote Route Type"}}},"shouldReceiveCopyOfQuote":{"type":"boolean","description":"Receives Copy of Quote is defined as true if the person receives a copy of the account's quotes.","example":"false"},"webAccess":{"type":"string","enum":["ALWD","NALW"],"description":"Web Access indicates if the related person is allowed web access for customer self-service.\n* `ALWD` - Allowed,\n* `NALW` - Not allowed","example":"NALW"},"personAddressOverride":{"type":"array","items":{"type":"object","properties":{"address1":{"type":"string","maxLength":254,"description":"The first line of the address."},"address2":{"type":"string","maxLength":254,"description":"The second line of the address."},"address3":{"type":"string","maxLength":254,"description":"The third line of the address."},"address4":{"type":"string","maxLength":254,"description":"The fourth line of the address."},"city":{"type":"string","maxLength":90,"description":"The city of the address."},"streetNumber1":{"type":"string","maxLength":6,"description":"The first street number line of the address."},"streetNumber2":{"type":"string","maxLength":4,"description":"The second street number line of the address."},"county":{"type":"string","maxLength":90,"description":"The county of the address."},"postal":{"type":"string","maxLength":12,"description":"The postal code of the address."},"houseType":{"type":"string","enum":["AB  ","WW  "],"description":"House Type indicates the type of house.\n* `AB  ` - House Boat References,\n* `WW  ` - House Trailer Reference"},"taxVendorGeographicalCode":{"type":"string","maxLength":11,"description":"Geographic code used to apply proper taxation rules to the physical address location."},"isInCityLimit":{"type":"boolean","description":"In City Limit is defined as true if the address is considered within the physical city limits."},"state":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"state":{"type":"string","maxLength":6,"description":"State"}}},"country":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"country":{"type":"string","maxLength":3,"description":"Country"}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The version number is used for internal concurrency checks.","example":"2"}}}}}}}}}},"xml":{"name":"C1-CXAccount"}},"UPDATEPREMISE_response":{"type":"object","properties":{"_self":{"type":"string","description":"_self"},"premiseId":{"type":"string","maxLength":10,"description":"The Premise ID is a system assigned random number that stays with a premise for life.","example":"2242620736"},"premiseType":{"type":"object","description":"Premise Type indicates the type of premise.","properties":{"_link":{"type":"string","description":"_link"},"premiseType":{"type":"string","maxLength":8,"description":"Premise Type indicates the type of premise.","example":"HOME"}}},"division":{"type":"object","description":"CIS Division is used to define the jurisdiction in which the premise is located if the premise type allows CIS Division. This defaults based on the Country and the Postal Code, but can be overridden.","properties":{"_link":{"type":"string","description":"_link"},"division":{"type":"string","maxLength":5,"description":"CIS Division is used to define the jurisdiction in which the premise is located if the premise type allows CIS Division. This defaults based on the Country and the Postal Code, but can be overridden.","example":"CA"}}},"landlordAgreement":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"landlordAgreementId":{"type":"string","maxLength":10,"description":"Landlord Agreement ID"}}},"keyAtPremise":{"type":"boolean","description":"Turn on Key at Premise if the meter is secured in a locked area and your company has the key. If this field is turned on, you may also specify the Key ID.","example":"false"},"key":{"type":"string","maxLength":10,"description":"Key ID may also be specified if Key at premise field is turned on."},"isOKToEnter":{"type":"boolean","description":"OK to Enter is turned on if the meter is located in the interior of the premise and your company has permission to enter.","example":"false"},"meterReadInstruction":{"type":"object","description":"Indicate a MR Instruction if specific instructions should be downloaded to the person who reads the meter. Meter read instructions and warnings are downloaded as part of the meter read download.","properties":{"_link":{"type":"string","description":"_link"},"meterReadInstruction":{"type":"string","maxLength":4,"description":"Indicate a MR Instruction if specific instructions should be downloaded to the person who reads the meter. Meter read instructions and warnings are downloaded as part of the meter read download.","example":"CON"}}},"meterReadInstructionDetails":{"type":"string","maxLength":250,"description":"Use Instruction Details to provide more detailed instructions to the individual who reads meters at this premise.","example":"verify constant"},"meterReadWarning":{"type":"object","description":"Indicate a MR Warning if a specific warning should be downloaded to the person who reads the meter.","properties":{"_link":{"type":"string","description":"_link"},"meterReadWarning":{"type":"string","maxLength":4,"description":"Indicate a MR Warning if a specific warning should be downloaded to the person who reads the meter.","example":"DANG"}}},"trendArea":{"type":"object","description":"Populate Trend Area if the Postal is blank. The Postal and the Trend Area cannot both be blank as the Trend Area is a required field on the premise and its value is typically defaulted from postal defaults.","properties":{"_link":{"type":"string","description":"_link"},"trendArea":{"type":"string","maxLength":8,"description":"Populate Trend Area if the Postal is blank. The Postal and the Trend Area cannot both be blank as the Trend Area is a required field on the premise and its value is typically defaulted from postal defaults.","example":"SF"}}},"address":{"type":"object","properties":{"address1":{"type":"string","maxLength":254,"description":"The first line of the address."},"address2":{"type":"string","maxLength":254,"description":"The Second line of the address."},"address3":{"type":"string","maxLength":254,"description":"The Third line of the address."},"address4":{"type":"string","maxLength":254,"description":"The Fourth line of the address."},"city":{"type":"string","maxLength":90,"description":"The city of the address."},"number1":{"type":"string","maxLength":6,"description":"The first street number line of the address."},"number2":{"type":"string","maxLength":4,"description":"The Second street number line of the address."},"county":{"type":"object","description":"The county of the address.","properties":{"_link":{"type":"string","description":"_link"},"county":{"type":"string","maxLength":90,"description":"The county of the address."}}},"postal":{"type":"string","maxLength":12,"description":"The postal code of the address."},"state":{"type":"string","maxLength":6,"description":"The state of the address."},"country":{"type":"object","description":"The Country of the address.","properties":{"_link":{"type":"string","description":"_link"},"country":{"type":"string","maxLength":3,"description":"The Country of the address.","example":"USA"}}},"mailingAddress":{"type":"boolean","description":"Indicates whether the address is a valid Mailing Address that can be used for the Account mailing.","example":"true"},"houseType":{"type":"string","enum":["AB  ","WW  "],"description":"House Type indicates the type of house.\n* `AB  ` - House Boat References,\n* `WW  ` - House Trailer Reference"},"geographicCode":{"type":"string","maxLength":11,"description":"Geographic code used to apply proper taxation rules to the physical address location."},"inCityLimit":{"type":"boolean","description":"City Limit switch is on if the address is considered within the physical city limits.","example":"true"}}},"timeZone":{"type":"object","description":"Enter the Time Zone in which the premise is located. This value defaults from your postal defaults.","properties":{"_link":{"type":"string","description":"_link"},"timeZone":{"type":"string","maxLength":10,"description":"Enter the Time Zone in which the premise is located. This value defaults from your postal defaults.","example":"USPACIFIC"}}},"lifeSupportSensitiveLoad":{"type":"string","enum":["N   ","Y   "],"description":"Life Support / Sensitive Load indicates if the person has life support or sensitive load equipment. Valid values are: LS/SL (i.e., the person has life support / sensitive load equipment) or None. If the customer has LS/SL equipment, make a note of the type of equipment in the description.\n* `N   ` - None,\n* `Y   ` - LS/SL","example":"Y"},"lifeSupportSensitiveLoadDescription":{"type":"string","maxLength":1000,"description":"A premise can also have life support / sensitive load information. If the equipment is physically linked to the premise (e.g., a hospital has life support equipment), you should NOT specify the life support information on the person. Rather, specify life support information on the premise.","example":"sensitive load"},"parentPremiseId":{"type":"object","description":"Parent Premise is used to include this premise in a premise hierarchy.","properties":{"_link":{"type":"string","description":"_link"},"parentPremiseId":{"type":"string","maxLength":10,"description":"Parent Premise is used to include this premise in a premise hierarchy.","example":"5150218089"}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks.","example":"1"},"characteristics":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"effectiveDate":{"type":"string","format":"date","description":"Effective Date defines the date on which the characteristic becomes effective.","example":"2018-08-06"},"characteristicType":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"characteristicType":{"type":"string","maxLength":8,"description":"Characteristic Type"}}},"typeOfCharacteristicValue":{"type":"string","maxLength":4,"description":"Type of Characteristic Value indicates whether the characteristic type value is Adhoc, Predefined, Foreign Key, or a File/URL Location."},"characteristicValue":{"type":"object","properties":{"_link":{"type":"string","description":"(_link)"},"value":{"type":"string","description":"(value)"},"value2":{"type":"string","description":"(value2)"},"value3":{"type":"string","description":"(value3)"},"value4":{"type":"string","description":"(value4)"},"value5":{"type":"string","description":"(value5)"}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks.","example":"1"}}}}}},"geographicLocations":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"geographicType":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"geographicType":{"type":"string","maxLength":8,"description":"Geographic Type"}}},"geographicValue":{"type":"string","maxLength":50,"description":"Specifies the geographic value such as a coordinate.","example":"123"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks.","example":"1"}}}}}},"alternateAddresses":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"premiseAlternateAddressId":{"type":"string","maxLength":10,"description":"System assigned key if an alternate address record is entered.  This is only possible if alternate addresses are enabled on the installation record.","example":"6808137793"},"alternateAddress":{"type":"object","properties":{"address1":{"type":"string","maxLength":254,"description":"The first line of the address."},"address2":{"type":"string","maxLength":254,"description":"The Second line of the address."},"address3":{"type":"string","maxLength":254,"description":"The Third line of the address."},"address4":{"type":"string","maxLength":254,"description":"The Fourth line of the address."},"number1":{"type":"string","maxLength":6,"description":"Number 1"},"number2":{"type":"string","maxLength":4,"description":"Number 2"},"city":{"type":"string","maxLength":90,"description":"The city of the address."},"county":{"type":"string","maxLength":90,"description":"The county of the address."},"country":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"country":{"type":"string","maxLength":3,"description":"Country"}}},"postal":{"type":"string","maxLength":12,"description":"The postal code of the address."},"state":{"type":"string","maxLength":6,"description":"The state of the address."},"houseType":{"type":"string","enum":["AB  ","WW  "],"description":"House Type indicates the type of house.\n* `AB  ` - House Boat References,\n* `WW  ` - House Trailer Reference"},"inCityLimit":{"type":"boolean","description":"In City Limit"},"geographicCode":{"type":"string","maxLength":11,"description":"Geographical Code"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks.","example":"1"}}}}}}}}},"xml":{"name":"C1-Premise"}},"CREATEPREMISE_response":{"type":"object","properties":{"_self":{"type":"string","description":"_self"},"premiseId":{"type":"string","maxLength":10,"description":"The Premise ID is a system assigned random number that stays with a premise for life.","example":"2242620736"},"premiseType":{"type":"object","description":"Premise Type indicates the type of premise.","properties":{"_link":{"type":"string","description":"_link"},"premiseType":{"type":"string","maxLength":8,"description":"Premise Type indicates the type of premise.","example":"HOME"}}},"division":{"type":"object","description":"CIS Division is used to define the jurisdiction in which the premise is located if the premise type allows CIS Division. This defaults based on the Country and the Postal Code, but can be overridden.","properties":{"_link":{"type":"string","description":"_link"},"division":{"type":"string","maxLength":5,"description":"CIS Division is used to define the jurisdiction in which the premise is located if the premise type allows CIS Division. This defaults based on the Country and the Postal Code, but can be overridden.","example":"CA"}}},"landlordAgreement":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"landlordAgreementId":{"type":"string","maxLength":10,"description":"Landlord Agreement ID"}}},"keyAtPremise":{"type":"boolean","description":"Turn on Key at Premise if the meter is secured in a locked area and your company has the key. If this field is turned on, you may also specify the Key ID.","example":"false"},"key":{"type":"string","maxLength":10,"description":"Key ID may also be specified if Key at premise field is turned on."},"isOKToEnter":{"type":"boolean","description":"OK to Enter is turned on if the meter is located in the interior of the premise and your company has permission to enter.","example":"false"},"meterReadInstruction":{"type":"object","description":"Indicate a MR Instruction if specific instructions should be downloaded to the person who reads the meter. Meter read instructions and warnings are downloaded as part of the meter read download.","properties":{"_link":{"type":"string","description":"_link"},"meterReadInstruction":{"type":"string","maxLength":4,"description":"Indicate a MR Instruction if specific instructions should be downloaded to the person who reads the meter. Meter read instructions and warnings are downloaded as part of the meter read download.","example":"CON"}}},"meterReadInstructionDetails":{"type":"string","maxLength":250,"description":"Use Instruction Details to provide more detailed instructions to the individual who reads meters at this premise.","example":"verify constant"},"meterReadWarning":{"type":"object","description":"Indicate a MR Warning if a specific warning should be downloaded to the person who reads the meter.","properties":{"_link":{"type":"string","description":"_link"},"meterReadWarning":{"type":"string","maxLength":4,"description":"Indicate a MR Warning if a specific warning should be downloaded to the person who reads the meter.","example":"DANG"}}},"trendArea":{"type":"object","description":"Populate Trend Area if the Postal is blank. The Postal and the Trend Area cannot both be blank as the Trend Area is a required field on the premise and its value is typically defaulted from postal defaults.","properties":{"_link":{"type":"string","description":"_link"},"trendArea":{"type":"string","maxLength":8,"description":"Populate Trend Area if the Postal is blank. The Postal and the Trend Area cannot both be blank as the Trend Area is a required field on the premise and its value is typically defaulted from postal defaults.","example":"SF"}}},"address":{"type":"object","properties":{"address1":{"type":"string","maxLength":254,"description":"The first line of the address."},"address2":{"type":"string","maxLength":254,"description":"The Second line of the address."},"address3":{"type":"string","maxLength":254,"description":"The Third line of the address."},"address4":{"type":"string","maxLength":254,"description":"The Fourth line of the address."},"city":{"type":"string","maxLength":90,"description":"The city of the address."},"number1":{"type":"string","maxLength":6,"description":"The first street number line of the address."},"number2":{"type":"string","maxLength":4,"description":"The Second street number line of the address."},"county":{"type":"object","description":"The county of the address.","properties":{"_link":{"type":"string","description":"_link"},"county":{"type":"string","maxLength":90,"description":"The county of the address."}}},"postal":{"type":"string","maxLength":12,"description":"The postal code of the address."},"state":{"type":"string","maxLength":6,"description":"The state of the address."},"country":{"type":"object","description":"The Country of the address.","properties":{"_link":{"type":"string","description":"_link"},"country":{"type":"string","maxLength":3,"description":"The Country of the address.","example":"USA"}}},"mailingAddress":{"type":"boolean","description":"Indicates whether the address is a valid Mailing Address that can be used for the Account mailing.","example":"true"},"houseType":{"type":"string","enum":["AB  ","WW  "],"description":"House Type indicates the type of house.\n* `AB  ` - House Boat References,\n* `WW  ` - House Trailer Reference"},"geographicCode":{"type":"string","maxLength":11,"description":"Geographic code used to apply proper taxation rules to the physical address location."},"inCityLimit":{"type":"boolean","description":"City Limit switch is on if the address is considered within the physical city limits.","example":"true"}}},"timeZone":{"type":"object","description":"Enter the Time Zone in which the premise is located. This value defaults from your postal defaults.","properties":{"_link":{"type":"string","description":"_link"},"timeZone":{"type":"string","maxLength":10,"description":"Enter the Time Zone in which the premise is located. This value defaults from your postal defaults.","example":"USPACIFIC"}}},"lifeSupportSensitiveLoad":{"type":"string","enum":["N   ","Y   "],"description":"Life Support / Sensitive Load indicates if the person has life support or sensitive load equipment. Valid values are: LS/SL (i.e., the person has life support / sensitive load equipment) or None. If the customer has LS/SL equipment, make a note of the type of equipment in the description.\n* `N   ` - None,\n* `Y   ` - LS/SL","example":"Y"},"lifeSupportSensitiveLoadDescription":{"type":"string","maxLength":1000,"description":"A premise can also have life support / sensitive load information. If the equipment is physically linked to the premise (e.g., a hospital has life support equipment), you should NOT specify the life support information on the person. Rather, specify life support information on the premise.","example":"sensitive load"},"parentPremiseId":{"type":"object","description":"Parent Premise is used to include this premise in a premise hierarchy.","properties":{"_link":{"type":"string","description":"_link"},"parentPremiseId":{"type":"string","maxLength":10,"description":"Parent Premise is used to include this premise in a premise hierarchy.","example":"5150218089"}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks.","example":"1"},"characteristics":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"effectiveDate":{"type":"string","format":"date","description":"Effective Date defines the date on which the characteristic becomes effective.","example":"2018-08-06"},"characteristicType":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"characteristicType":{"type":"string","maxLength":8,"description":"Characteristic Type"}}},"typeOfCharacteristicValue":{"type":"string","maxLength":4,"description":"Type of Characteristic Value indicates whether the characteristic type value is Adhoc, Predefined, Foreign Key, or a File/URL Location."},"characteristicValue":{"type":"object","properties":{"_link":{"type":"string","description":"(_link)"},"value":{"type":"string","description":"(value)"},"value2":{"type":"string","description":"(value2)"},"value3":{"type":"string","description":"(value3)"},"value4":{"type":"string","description":"(value4)"},"value5":{"type":"string","description":"(value5)"}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks.","example":"1"}}}}}},"geographicLocations":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"geographicType":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"geographicType":{"type":"string","maxLength":8,"description":"Geographic Type"}}},"geographicValue":{"type":"string","maxLength":50,"description":"Specifies the geographic value such as a coordinate.","example":"123"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks.","example":"1"}}}}}},"alternateAddresses":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"premiseAlternateAddressId":{"type":"string","maxLength":10,"description":"System assigned key if an alternate address record is entered.  This is only possible if alternate addresses are enabled on the installation record.","example":"6808137793"},"alternateAddress":{"type":"object","properties":{"address1":{"type":"string","maxLength":254,"description":"The first line of the address."},"address2":{"type":"string","maxLength":254,"description":"The Second line of the address."},"address3":{"type":"string","maxLength":254,"description":"The Third line of the address."},"address4":{"type":"string","maxLength":254,"description":"The Fourth line of the address."},"number1":{"type":"string","maxLength":6,"description":"Number 1"},"number2":{"type":"string","maxLength":4,"description":"Number 2"},"city":{"type":"string","maxLength":90,"description":"The city of the address."},"county":{"type":"string","maxLength":90,"description":"The county of the address."},"country":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"country":{"type":"string","maxLength":3,"description":"Country"}}},"postal":{"type":"string","maxLength":12,"description":"The postal code of the address."},"state":{"type":"string","maxLength":6,"description":"The state of the address."},"houseType":{"type":"string","enum":["AB  ","WW  "],"description":"House Type indicates the type of house.\n* `AB  ` - House Boat References,\n* `WW  ` - House Trailer Reference"},"inCityLimit":{"type":"boolean","description":"In City Limit"},"geographicCode":{"type":"string","maxLength":11,"description":"Geographical Code"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks.","example":"1"}}}}}}}}},"xml":{"name":"C1-Premise"}},"DELETEPREMISE_response":{"type":"object","properties":{"premiseId":{"type":"string","maxLength":10,"description":"The Premise ID is a system assigned random number that stays with a premise for life.","example":"2242620736"}},"xml":{"name":"C1-DePremise"}},"CREATEPREMISE_request":{"type":"object","properties":{"premiseId":{"type":"string","maxLength":10,"description":"The Premise ID is a system assigned random number that stays with a premise for life.","example":"2242620736"},"premiseType":{"type":"object","description":"Premise Type indicates the type of premise.","properties":{"premiseType":{"type":"string","maxLength":8,"description":"Premise Type indicates the type of premise.","example":"HOME"}}},"division":{"type":"object","description":"CIS Division is used to define the jurisdiction in which the premise is located if the premise type allows CIS Division. This defaults based on the Country and the Postal Code, but can be overridden.","properties":{"division":{"type":"string","maxLength":5,"description":"CIS Division is used to define the jurisdiction in which the premise is located if the premise type allows CIS Division. This defaults based on the Country and the Postal Code, but can be overridden.","example":"CA"}}},"landlordAgreement":{"type":"object","properties":{"landlordAgreementId":{"type":"string","maxLength":10,"description":"Landlord Agreement ID"}}},"keyAtPremise":{"type":"boolean","description":"Turn on Key at Premise if the meter is secured in a locked area and your company has the key. If this field is turned on, you may also specify the Key ID.","example":"false"},"key":{"type":"string","maxLength":10,"description":"Key ID may also be specified if Key at premise field is turned on."},"isOKToEnter":{"type":"boolean","description":"OK to Enter is turned on if the meter is located in the interior of the premise and your company has permission to enter.","example":"false"},"meterReadInstruction":{"type":"object","description":"Indicate a MR Instruction if specific instructions should be downloaded to the person who reads the meter. Meter read instructions and warnings are downloaded as part of the meter read download.","properties":{"meterReadInstruction":{"type":"string","maxLength":4,"description":"Indicate a MR Instruction if specific instructions should be downloaded to the person who reads the meter. Meter read instructions and warnings are downloaded as part of the meter read download.","example":"CON"}}},"meterReadInstructionDetails":{"type":"string","maxLength":250,"description":"Use Instruction Details to provide more detailed instructions to the individual who reads meters at this premise.","example":"verify constant"},"meterReadWarning":{"type":"object","description":"Indicate a MR Warning if a specific warning should be downloaded to the person who reads the meter.","properties":{"meterReadWarning":{"type":"string","maxLength":4,"description":"Indicate a MR Warning if a specific warning should be downloaded to the person who reads the meter.","example":"DANG"}}},"trendArea":{"type":"object","description":"Populate Trend Area if the Postal is blank. The Postal and the Trend Area cannot both be blank as the Trend Area is a required field on the premise and its value is typically defaulted from postal defaults.","properties":{"trendArea":{"type":"string","maxLength":8,"description":"Populate Trend Area if the Postal is blank. The Postal and the Trend Area cannot both be blank as the Trend Area is a required field on the premise and its value is typically defaulted from postal defaults.","example":"SF"}}},"address":{"type":"object","properties":{"address1":{"type":"string","maxLength":254,"description":"The first line of the address."},"address2":{"type":"string","maxLength":254,"description":"The Second line of the address."},"address3":{"type":"string","maxLength":254,"description":"The Third line of the address."},"address4":{"type":"string","maxLength":254,"description":"The Fourth line of the address."},"city":{"type":"string","maxLength":90,"description":"The city of the address."},"number1":{"type":"string","maxLength":6,"description":"The first street number line of the address."},"number2":{"type":"string","maxLength":4,"description":"The Second street number line of the address."},"county":{"type":"object","description":"The county of the address.","properties":{"county":{"type":"string","maxLength":90,"description":"The county of the address."}}},"postal":{"type":"string","maxLength":12,"description":"The postal code of the address."},"state":{"type":"string","maxLength":6,"description":"The state of the address."},"country":{"type":"object","description":"The Country of the address.","properties":{"country":{"type":"string","maxLength":3,"description":"The Country of the address.","example":"USA"}}},"mailingAddress":{"type":"boolean","description":"Indicates whether the address is a valid Mailing Address that can be used for the Account mailing.","example":"true"},"houseType":{"type":"string","enum":["AB  ","WW  "],"description":"House Type indicates the type of house.\n* `AB  ` - House Boat References,\n* `WW  ` - House Trailer Reference"},"geographicCode":{"type":"string","maxLength":11,"description":"Geographic code used to apply proper taxation rules to the physical address location."},"inCityLimit":{"type":"boolean","description":"City Limit switch is on if the address is considered within the physical city limits.","example":"true"}}},"timeZone":{"type":"object","description":"Enter the Time Zone in which the premise is located. This value defaults from your postal defaults.","properties":{"timeZone":{"type":"string","maxLength":10,"description":"Enter the Time Zone in which the premise is located. This value defaults from your postal defaults.","example":"USPACIFIC"}}},"lifeSupportSensitiveLoad":{"type":"string","enum":["N   ","Y   "],"description":"Life Support / Sensitive Load indicates if the person has life support or sensitive load equipment. Valid values are: LS/SL (i.e., the person has life support / sensitive load equipment) or None. If the customer has LS/SL equipment, make a note of the type of equipment in the description.\n* `N   ` - None,\n* `Y   ` - LS/SL","example":"Y"},"lifeSupportSensitiveLoadDescription":{"type":"string","maxLength":1000,"description":"A premise can also have life support / sensitive load information. If the equipment is physically linked to the premise (e.g., a hospital has life support equipment), you should NOT specify the life support information on the person. Rather, specify life support information on the premise.","example":"sensitive load"},"parentPremiseId":{"type":"object","description":"Parent Premise is used to include this premise in a premise hierarchy.","properties":{"parentPremiseId":{"type":"string","maxLength":10,"description":"Parent Premise is used to include this premise in a premise hierarchy.","example":"5150218089"}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks.","example":"1"},"characteristics":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"effectiveDate":{"type":"string","format":"date","description":"Effective Date defines the date on which the characteristic becomes effective.","example":"2018-08-06"},"characteristicType":{"type":"object","properties":{"characteristicType":{"type":"string","maxLength":8,"description":"Characteristic Type"}}},"typeOfCharacteristicValue":{"type":"string","maxLength":4,"description":"Type of Characteristic Value indicates whether the characteristic type value is Adhoc, Predefined, Foreign Key, or a File/URL Location."},"characteristicValue":{"type":"object","properties":{"_link":{"type":"string","description":"(_link)"},"value":{"type":"string","description":"(value)"},"value2":{"type":"string","description":"(value2)"},"value3":{"type":"string","description":"(value3)"},"value4":{"type":"string","description":"(value4)"},"value5":{"type":"string","description":"(value5)"}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks.","example":"1"}}}}}},"geographicLocations":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"geographicType":{"type":"object","properties":{"geographicType":{"type":"string","maxLength":8,"description":"Geographic Type"}}},"geographicValue":{"type":"string","maxLength":50,"description":"Specifies the geographic value such as a coordinate.","example":"123"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks.","example":"1"}}}}}},"alternateAddresses":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"premiseAlternateAddressId":{"type":"string","maxLength":10,"description":"System assigned key if an alternate address record is entered.  This is only possible if alternate addresses are enabled on the installation record.","example":"6808137793"},"alternateAddress":{"type":"object","properties":{"address1":{"type":"string","maxLength":254,"description":"The first line of the address."},"address2":{"type":"string","maxLength":254,"description":"The Second line of the address."},"address3":{"type":"string","maxLength":254,"description":"The Third line of the address."},"address4":{"type":"string","maxLength":254,"description":"The Fourth line of the address."},"number1":{"type":"string","maxLength":6,"description":"Number 1"},"number2":{"type":"string","maxLength":4,"description":"Number 2"},"city":{"type":"string","maxLength":90,"description":"The city of the address."},"county":{"type":"string","maxLength":90,"description":"The county of the address."},"country":{"type":"object","properties":{"country":{"type":"string","maxLength":3,"description":"Country"}}},"postal":{"type":"string","maxLength":12,"description":"The postal code of the address."},"state":{"type":"string","maxLength":6,"description":"The state of the address."},"houseType":{"type":"string","enum":["AB  ","WW  "],"description":"House Type indicates the type of house.\n* `AB  ` - House Boat References,\n* `WW  ` - House Trailer Reference"},"inCityLimit":{"type":"boolean","description":"In City Limit"},"geographicCode":{"type":"string","maxLength":11,"description":"Geographical Code"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks.","example":"1"}}}}}}}}},"xml":{"name":"C1-Premise"}},"UPDATEPREMISE_request":{"type":"object","properties":{"premiseId":{"type":"string","maxLength":10,"description":"The Premise ID is a system assigned random number that stays with a premise for life.","example":"2242620736"},"premiseType":{"type":"object","description":"Premise Type indicates the type of premise.","properties":{"premiseType":{"type":"string","maxLength":8,"description":"Premise Type indicates the type of premise.","example":"HOME"}}},"division":{"type":"object","description":"CIS Division is used to define the jurisdiction in which the premise is located if the premise type allows CIS Division. This defaults based on the Country and the Postal Code, but can be overridden.","properties":{"division":{"type":"string","maxLength":5,"description":"CIS Division is used to define the jurisdiction in which the premise is located if the premise type allows CIS Division. This defaults based on the Country and the Postal Code, but can be overridden.","example":"CA"}}},"landlordAgreement":{"type":"object","properties":{"landlordAgreementId":{"type":"string","maxLength":10,"description":"Landlord Agreement ID"}}},"keyAtPremise":{"type":"boolean","description":"Turn on Key at Premise if the meter is secured in a locked area and your company has the key. If this field is turned on, you may also specify the Key ID.","example":"false"},"key":{"type":"string","maxLength":10,"description":"Key ID may also be specified if Key at premise field is turned on."},"isOKToEnter":{"type":"boolean","description":"OK to Enter is turned on if the meter is located in the interior of the premise and your company has permission to enter.","example":"false"},"meterReadInstruction":{"type":"object","description":"Indicate a MR Instruction if specific instructions should be downloaded to the person who reads the meter. Meter read instructions and warnings are downloaded as part of the meter read download.","properties":{"meterReadInstruction":{"type":"string","maxLength":4,"description":"Indicate a MR Instruction if specific instructions should be downloaded to the person who reads the meter. Meter read instructions and warnings are downloaded as part of the meter read download.","example":"CON"}}},"meterReadInstructionDetails":{"type":"string","maxLength":250,"description":"Use Instruction Details to provide more detailed instructions to the individual who reads meters at this premise.","example":"verify constant"},"meterReadWarning":{"type":"object","description":"Indicate a MR Warning if a specific warning should be downloaded to the person who reads the meter.","properties":{"meterReadWarning":{"type":"string","maxLength":4,"description":"Indicate a MR Warning if a specific warning should be downloaded to the person who reads the meter.","example":"DANG"}}},"trendArea":{"type":"object","description":"Populate Trend Area if the Postal is blank. The Postal and the Trend Area cannot both be blank as the Trend Area is a required field on the premise and its value is typically defaulted from postal defaults.","properties":{"trendArea":{"type":"string","maxLength":8,"description":"Populate Trend Area if the Postal is blank. The Postal and the Trend Area cannot both be blank as the Trend Area is a required field on the premise and its value is typically defaulted from postal defaults.","example":"SF"}}},"address":{"type":"object","properties":{"address1":{"type":"string","maxLength":254,"description":"The first line of the address."},"address2":{"type":"string","maxLength":254,"description":"The Second line of the address."},"address3":{"type":"string","maxLength":254,"description":"The Third line of the address."},"address4":{"type":"string","maxLength":254,"description":"The Fourth line of the address."},"city":{"type":"string","maxLength":90,"description":"The city of the address."},"number1":{"type":"string","maxLength":6,"description":"The first street number line of the address."},"number2":{"type":"string","maxLength":4,"description":"The Second street number line of the address."},"county":{"type":"object","description":"The county of the address.","properties":{"county":{"type":"string","maxLength":90,"description":"The county of the address."}}},"postal":{"type":"string","maxLength":12,"description":"The postal code of the address."},"state":{"type":"string","maxLength":6,"description":"The state of the address."},"country":{"type":"object","description":"The Country of the address.","properties":{"country":{"type":"string","maxLength":3,"description":"The Country of the address.","example":"USA"}}},"mailingAddress":{"type":"boolean","description":"Indicates whether the address is a valid Mailing Address that can be used for the Account mailing.","example":"true"},"houseType":{"type":"string","enum":["AB  ","WW  "],"description":"House Type indicates the type of house.\n* `AB  ` - House Boat References,\n* `WW  ` - House Trailer Reference"},"geographicCode":{"type":"string","maxLength":11,"description":"Geographic code used to apply proper taxation rules to the physical address location."},"inCityLimit":{"type":"boolean","description":"City Limit switch is on if the address is considered within the physical city limits.","example":"true"}}},"timeZone":{"type":"object","description":"Enter the Time Zone in which the premise is located. This value defaults from your postal defaults.","properties":{"timeZone":{"type":"string","maxLength":10,"description":"Enter the Time Zone in which the premise is located. This value defaults from your postal defaults.","example":"USPACIFIC"}}},"lifeSupportSensitiveLoad":{"type":"string","enum":["N   ","Y   "],"description":"Life Support / Sensitive Load indicates if the person has life support or sensitive load equipment. Valid values are: LS/SL (i.e., the person has life support / sensitive load equipment) or None. If the customer has LS/SL equipment, make a note of the type of equipment in the description.\n* `N   ` - None,\n* `Y   ` - LS/SL","example":"Y"},"lifeSupportSensitiveLoadDescription":{"type":"string","maxLength":1000,"description":"A premise can also have life support / sensitive load information. If the equipment is physically linked to the premise (e.g., a hospital has life support equipment), you should NOT specify the life support information on the person. Rather, specify life support information on the premise.","example":"sensitive load"},"parentPremiseId":{"type":"object","description":"Parent Premise is used to include this premise in a premise hierarchy.","properties":{"parentPremiseId":{"type":"string","maxLength":10,"description":"Parent Premise is used to include this premise in a premise hierarchy.","example":"5150218089"}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks.","example":"1"},"characteristics":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"effectiveDate":{"type":"string","format":"date","description":"Effective Date defines the date on which the characteristic becomes effective.","example":"2018-08-06"},"characteristicType":{"type":"object","properties":{"characteristicType":{"type":"string","maxLength":8,"description":"Characteristic Type"}}},"typeOfCharacteristicValue":{"type":"string","maxLength":4,"description":"Type of Characteristic Value indicates whether the characteristic type value is Adhoc, Predefined, Foreign Key, or a File/URL Location."},"characteristicValue":{"type":"object","properties":{"_link":{"type":"string","description":"(_link)"},"value":{"type":"string","description":"(value)"},"value2":{"type":"string","description":"(value2)"},"value3":{"type":"string","description":"(value3)"},"value4":{"type":"string","description":"(value4)"},"value5":{"type":"string","description":"(value5)"}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks.","example":"1"}}}}}},"geographicLocations":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"geographicType":{"type":"object","properties":{"geographicType":{"type":"string","maxLength":8,"description":"Geographic Type"}}},"geographicValue":{"type":"string","maxLength":50,"description":"Specifies the geographic value such as a coordinate.","example":"123"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks.","example":"1"}}}}}},"alternateAddresses":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"premiseAlternateAddressId":{"type":"string","maxLength":10,"description":"System assigned key if an alternate address record is entered.  This is only possible if alternate addresses are enabled on the installation record.","example":"6808137793"},"alternateAddress":{"type":"object","properties":{"address1":{"type":"string","maxLength":254,"description":"The first line of the address."},"address2":{"type":"string","maxLength":254,"description":"The Second line of the address."},"address3":{"type":"string","maxLength":254,"description":"The Third line of the address."},"address4":{"type":"string","maxLength":254,"description":"The Fourth line of the address."},"number1":{"type":"string","maxLength":6,"description":"Number 1"},"number2":{"type":"string","maxLength":4,"description":"Number 2"},"city":{"type":"string","maxLength":90,"description":"The city of the address."},"county":{"type":"string","maxLength":90,"description":"The county of the address."},"country":{"type":"object","properties":{"country":{"type":"string","maxLength":3,"description":"Country"}}},"postal":{"type":"string","maxLength":12,"description":"The postal code of the address."},"state":{"type":"string","maxLength":6,"description":"The state of the address."},"houseType":{"type":"string","enum":["AB  ","WW  "],"description":"House Type indicates the type of house.\n* `AB  ` - House Boat References,\n* `WW  ` - House Trailer Reference"},"inCityLimit":{"type":"boolean","description":"In City Limit"},"geographicCode":{"type":"string","maxLength":11,"description":"Geographical Code"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks.","example":"1"}}}}}}}}},"xml":{"name":"C1-Premise"}},"DELETEPREMISE_request":{"type":"object","properties":{"premiseId":{"type":"string","maxLength":10,"description":"The Premise ID is a system assigned random number that stays with a premise for life.","example":"2242620736"}},"xml":{"name":"C1-DePremise"}},"GETPREMISE_response":{"type":"object","properties":{"_self":{"type":"string","description":"_self"},"premiseId":{"type":"string","maxLength":10,"description":"The Premise ID is a system assigned random number that stays with a premise for life.","example":"2242620736"},"premiseType":{"type":"object","description":"Premise Type indicates the type of premise.","properties":{"_link":{"type":"string","description":"_link"},"premiseType":{"type":"string","maxLength":8,"description":"Premise Type indicates the type of premise.","example":"HOME"}}},"division":{"type":"object","description":"CIS Division is used to define the jurisdiction in which the premise is located if the premise type allows CIS Division. This defaults based on the Country and the Postal Code, but can be overridden.","properties":{"_link":{"type":"string","description":"_link"},"division":{"type":"string","maxLength":5,"description":"CIS Division is used to define the jurisdiction in which the premise is located if the premise type allows CIS Division. This defaults based on the Country and the Postal Code, but can be overridden.","example":"CA"}}},"landlordAgreement":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"landlordAgreementId":{"type":"string","maxLength":10,"description":"Landlord Agreement ID"}}},"keyAtPremise":{"type":"boolean","description":"Turn on Key at Premise if the meter is secured in a locked area and your company has the key. If this field is turned on, you may also specify the Key ID.","example":"false"},"key":{"type":"string","maxLength":10,"description":"Key ID may also be specified if Key at premise field is turned on."},"isOKToEnter":{"type":"boolean","description":"OK to Enter is turned on if the meter is located in the interior of the premise and your company has permission to enter.","example":"false"},"meterReadInstruction":{"type":"object","description":"Indicate a MR Instruction if specific instructions should be downloaded to the person who reads the meter. Meter read instructions and warnings are downloaded as part of the meter read download.","properties":{"_link":{"type":"string","description":"_link"},"meterReadInstruction":{"type":"string","maxLength":4,"description":"Indicate a MR Instruction if specific instructions should be downloaded to the person who reads the meter. Meter read instructions and warnings are downloaded as part of the meter read download.","example":"CON"}}},"meterReadInstructionDetails":{"type":"string","maxLength":250,"description":"Use Instruction Details to provide more detailed instructions to the individual who reads meters at this premise.","example":"verify constant"},"meterReadWarning":{"type":"object","description":"Indicate a MR Warning if a specific warning should be downloaded to the person who reads the meter.","properties":{"_link":{"type":"string","description":"_link"},"meterReadWarning":{"type":"string","maxLength":4,"description":"Indicate a MR Warning if a specific warning should be downloaded to the person who reads the meter.","example":"DANG"}}},"trendArea":{"type":"object","description":"Populate Trend Area if the Postal is blank. The Postal and the Trend Area cannot both be blank as the Trend Area is a required field on the premise and its value is typically defaulted from postal defaults.","properties":{"_link":{"type":"string","description":"_link"},"trendArea":{"type":"string","maxLength":8,"description":"Populate Trend Area if the Postal is blank. The Postal and the Trend Area cannot both be blank as the Trend Area is a required field on the premise and its value is typically defaulted from postal defaults.","example":"SF"}}},"address":{"type":"object","properties":{"address1":{"type":"string","maxLength":254,"description":"The first line of the address."},"address2":{"type":"string","maxLength":254,"description":"The Second line of the address."},"address3":{"type":"string","maxLength":254,"description":"The Third line of the address."},"address4":{"type":"string","maxLength":254,"description":"The Fourth line of the address."},"city":{"type":"string","maxLength":90,"description":"The city of the address."},"number1":{"type":"string","maxLength":6,"description":"The first street number line of the address."},"number2":{"type":"string","maxLength":4,"description":"The Second street number line of the address."},"county":{"type":"object","description":"The county of the address.","properties":{"_link":{"type":"string","description":"_link"},"county":{"type":"string","maxLength":90,"description":"The county of the address."}}},"postal":{"type":"string","maxLength":12,"description":"The postal code of the address."},"state":{"type":"string","maxLength":6,"description":"The state of the address."},"country":{"type":"object","description":"The Country of the address.","properties":{"_link":{"type":"string","description":"_link"},"country":{"type":"string","maxLength":3,"description":"The Country of the address.","example":"USA"}}},"mailingAddress":{"type":"boolean","description":"Indicates whether the address is a valid Mailing Address that can be used for the Account mailing.","example":"true"},"houseType":{"type":"string","enum":["AB  ","WW  "],"description":"House Type indicates the type of house.\n* `AB  ` - House Boat References,\n* `WW  ` - House Trailer Reference"},"geographicCode":{"type":"string","maxLength":11,"description":"Geographic code used to apply proper taxation rules to the physical address location."},"inCityLimit":{"type":"boolean","description":"City Limit switch is on if the address is considered within the physical city limits.","example":"true"}}},"timeZone":{"type":"object","description":"Enter the Time Zone in which the premise is located. This value defaults from your postal defaults.","properties":{"_link":{"type":"string","description":"_link"},"timeZone":{"type":"string","maxLength":10,"description":"Enter the Time Zone in which the premise is located. This value defaults from your postal defaults.","example":"USPACIFIC"}}},"lifeSupportSensitiveLoad":{"type":"string","enum":["N   ","Y   "],"description":"Life Support / Sensitive Load indicates if the person has life support or sensitive load equipment. Valid values are: LS/SL (i.e., the person has life support / sensitive load equipment) or None. If the customer has LS/SL equipment, make a note of the type of equipment in the description.\n* `N   ` - None,\n* `Y   ` - LS/SL","example":"Y"},"lifeSupportSensitiveLoadDescription":{"type":"string","maxLength":1000,"description":"A premise can also have life support / sensitive load information. If the equipment is physically linked to the premise (e.g., a hospital has life support equipment), you should NOT specify the life support information on the person. Rather, specify life support information on the premise.","example":"sensitive load"},"parentPremiseId":{"type":"object","description":"Parent Premise is used to include this premise in a premise hierarchy.","properties":{"_link":{"type":"string","description":"_link"},"parentPremiseId":{"type":"string","maxLength":10,"description":"Parent Premise is used to include this premise in a premise hierarchy.","example":"5150218089"}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks.","example":"1"},"characteristics":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"effectiveDate":{"type":"string","format":"date","description":"Effective Date defines the date on which the characteristic becomes effective.","example":"2018-08-06"},"characteristicType":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"characteristicType":{"type":"string","maxLength":8,"description":"Characteristic Type"}}},"typeOfCharacteristicValue":{"type":"string","maxLength":4,"description":"Type of Characteristic Value indicates whether the characteristic type value is Adhoc, Predefined, Foreign Key, or a File/URL Location."},"characteristicValue":{"type":"object","properties":{"_link":{"type":"string","description":"(_link)"},"value":{"type":"string","description":"(value)"},"value2":{"type":"string","description":"(value2)"},"value3":{"type":"string","description":"(value3)"},"value4":{"type":"string","description":"(value4)"},"value5":{"type":"string","description":"(value5)"}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks.","example":"1"}}}}}},"geographicLocations":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"geographicType":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"geographicType":{"type":"string","maxLength":8,"description":"Geographic Type"}}},"geographicValue":{"type":"string","maxLength":50,"description":"Specifies the geographic value such as a coordinate.","example":"123"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks.","example":"1"}}}}}},"alternateAddresses":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"premiseAlternateAddressId":{"type":"string","maxLength":10,"description":"System assigned key if an alternate address record is entered.  This is only possible if alternate addresses are enabled on the installation record.","example":"6808137793"},"alternateAddress":{"type":"object","properties":{"address1":{"type":"string","maxLength":254,"description":"The first line of the address."},"address2":{"type":"string","maxLength":254,"description":"The Second line of the address."},"address3":{"type":"string","maxLength":254,"description":"The Third line of the address."},"address4":{"type":"string","maxLength":254,"description":"The Fourth line of the address."},"number1":{"type":"string","maxLength":6,"description":"Number 1"},"number2":{"type":"string","maxLength":4,"description":"Number 2"},"city":{"type":"string","maxLength":90,"description":"The city of the address."},"county":{"type":"string","maxLength":90,"description":"The county of the address."},"country":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"country":{"type":"string","maxLength":3,"description":"Country"}}},"postal":{"type":"string","maxLength":12,"description":"The postal code of the address."},"state":{"type":"string","maxLength":6,"description":"The state of the address."},"houseType":{"type":"string","enum":["AB  ","WW  "],"description":"House Type indicates the type of house.\n* `AB  ` - House Boat References,\n* `WW  ` - House Trailer Reference"},"inCityLimit":{"type":"boolean","description":"In City Limit"},"geographicCode":{"type":"string","maxLength":11,"description":"Geographical Code"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks.","example":"1"}}}}}}}}},"xml":{"name":"C1-Premise"}},"CREATEPAYPLAN_request":{"type":"object","properties":{"payPlanId":{"type":"string","maxLength":10,"description":"Pay Plan ID is a system-assigned random number that stays with the pay plan for life.","example":"4444444444"},"account":{"type":"object","properties":{"accountId":{"type":"string","maxLength":10,"description":"Account ID"}}},"comments":{"type":"string","maxLength":254,"description":"Comments describe any special notes about the pay plan."},"creationDateTime":{"type":"string","format":"date-time","description":"Create Date/Time describes the date and time on which pay plan was created.","example":"2009-10-05T00:22:06-04:00"},"lastStatusDateTime":{"type":"string","format":"date-time","description":"Last Status Date/Time describes the date and time on which pay plan was changed.","example":"2009-10-07T01:47:04-04:00"},"lastUpdatedBy":{"type":"object","description":"Last Updated by displays the id of the user who last modified the pay plan","properties":{"userId":{"type":"string","maxLength":8,"description":"User"}}},"payorAccountId":{"type":"object","description":"Payor Account Id contains the account ID and name of the person responsible for making the pay plan's payments.","properties":{"payorAccountId":{"type":"string","maxLength":10,"description":"Payor Account Id contains the account ID and name of the person responsible for making the pay plan's payments.","example":"4000060000"}}},"payMethod":{"type":"object","properties":{"payMethod":{"type":"string","maxLength":10,"description":"Pay Method"}}},"cancelReasonFlag":{"type":"string","enum":["10  ","20  "],"description":"Cancel Reason describes how the pay plan was cancelled .\n* `10  ` - Canceled by System,\n* `20  ` - Canceled by User","example":"10"},"status":{"type":"string","enum":["20  ","30  ","40  ","50  "],"description":"The Status displays the status of the pay plan.\n* `20  ` - Active,\n* `30  ` - Canceled,\n* `40  ` - Broken,\n* `50  ` - Kept","example":"20"},"payPlanType":{"type":"object","properties":{"payPlanType":{"type":"string","maxLength":12,"description":"Pay Plan Type"}}},"startDate":{"type":"string","format":"date","description":"Start Date defines the first day on which the pay plan is tracked; it defaults to the current date.","example":"2009-08-20"},"currentBalance":{"type":"number","description":"The account's Current Balance for the debt class whose debt is insulated by the pay plan.","example":"-75.00"},"delinquentDebt":{"type":"number","description":"Delinquent Amount is the amount of the customer's debt that was due on / before the prior bill's due date.","example":"0.00"},"thirdPartyPayor":{"type":"object","description":"If a 3rd party is responsible for the pay plan's payment, Third Party Payor must be checked, and the associated 3rd party selected.","properties":{"thirdPartyPayor":{"type":"string","maxLength":12,"description":"Third Party Payor"}}},"isThirdPartyGuarantor":{"type":"boolean","description":"Turn on the Third Party Guarantor switch if the person is a third party guarantor of the account's debt. This switch is off  if the person is the Main Customer.","example":"true"},"totalAmount":{"type":"number","description":"The Total Amount of the pay plan's scheduled payments.","example":"100"},"createdBy":{"type":"object","properties":{"userId":{"type":"string","maxLength":8,"description":"User"}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks.","example":"2"},"scheduledPayments":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"payPlanId":{"type":"string","maxLength":10,"description":"Pay Plan ID"},"scheduledDate":{"type":"string","format":"date","description":"The Scheduled Date for pay plan's scheduled payments.","example":"2009-10-08"},"scheduledAmount":{"type":"number","description":"Scheduled Amount for pay plan's scheduled payments.","example":"75.00"},"autopayClearingId":{"type":"string","maxLength":12,"description":"Auto Pay Clearing"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"}}}}}}},"xml":{"name":"C1PayPlan"}},"UPDATEPAYPLAN_response":{"type":"object","properties":{"_self":{"type":"string","description":"_self"},"payPlanId":{"type":"string","maxLength":10,"description":"Pay Plan ID is a system-assigned random number that stays with the pay plan for life.","example":"4444444444"},"account":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"accountId":{"type":"string","maxLength":10,"description":"Account ID"}}},"comments":{"type":"string","maxLength":254,"description":"Comments describe any special notes about the pay plan."},"creationDateTime":{"type":"string","format":"date-time","description":"Create Date/Time describes the date and time on which pay plan was created.","example":"2009-10-05T00:22:06-04:00"},"lastStatusDateTime":{"type":"string","format":"date-time","description":"Last Status Date/Time describes the date and time on which pay plan was changed.","example":"2009-10-07T01:47:04-04:00"},"lastUpdatedBy":{"type":"object","description":"Last Updated by displays the id of the user who last modified the pay plan","properties":{"_link":{"type":"string","description":"_link"},"userId":{"type":"string","maxLength":8,"description":"User"}}},"payorAccountId":{"type":"object","description":"Payor Account Id contains the account ID and name of the person responsible for making the pay plan's payments.","properties":{"_link":{"type":"string","description":"_link"},"payorAccountId":{"type":"string","maxLength":10,"description":"Payor Account Id contains the account ID and name of the person responsible for making the pay plan's payments.","example":"4000060000"}}},"payMethod":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"payMethod":{"type":"string","maxLength":10,"description":"Pay Method"}}},"cancelReasonFlag":{"type":"string","enum":["10  ","20  "],"description":"Cancel Reason describes how the pay plan was cancelled .\n* `10  ` - Canceled by System,\n* `20  ` - Canceled by User","example":"10"},"status":{"type":"string","enum":["20  ","30  ","40  ","50  "],"description":"The Status displays the status of the pay plan.\n* `20  ` - Active,\n* `30  ` - Canceled,\n* `40  ` - Broken,\n* `50  ` - Kept","example":"20"},"payPlanType":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"payPlanType":{"type":"string","maxLength":12,"description":"Pay Plan Type"}}},"startDate":{"type":"string","format":"date","description":"Start Date defines the first day on which the pay plan is tracked; it defaults to the current date.","example":"2009-08-20"},"debtClassDescription":{"type":"string","maxLength":30,"description":"Description for the debt class.","example":"Payment arrangement"},"currentBalance":{"type":"number","description":"The account's Current Balance for the debt class whose debt is insulated by the pay plan.","example":"-75.00"},"delinquentDebt":{"type":"number","description":"Delinquent Amount is the amount of the customer's debt that was due on / before the prior bill's due date.","example":"0.00"},"thirdPartyPayor":{"type":"object","description":"If a 3rd party is responsible for the pay plan's payment, Third Party Payor must be checked, and the associated 3rd party selected.","properties":{"_link":{"type":"string","description":"_link"},"thirdPartyPayor":{"type":"string","maxLength":12,"description":"Third Party Payor"}}},"isThirdPartyGuarantor":{"type":"boolean","description":"Turn on the Third Party Guarantor switch if the person is a third party guarantor of the account's debt. This switch is off  if the person is the Main Customer.","example":"true"},"totalAmount":{"type":"number","description":"The Total Amount of the pay plan's scheduled payments.","example":"100"},"createdBy":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"userId":{"type":"string","maxLength":8,"description":"User"}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks.","example":"2"},"scheduledPayments":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"payPlanId":{"type":"string","maxLength":10,"description":"Pay Plan ID"},"scheduledDate":{"type":"string","format":"date","description":"The Scheduled Date for pay plan's scheduled payments.","example":"2009-10-08"},"scheduledAmount":{"type":"number","description":"Scheduled Amount for pay plan's scheduled payments.","example":"75.00"},"autopayClearingId":{"type":"string","maxLength":12,"description":"Auto Pay Clearing"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"}}}}}}},"xml":{"name":"C1PayPlan"}},"CREATEPAYPLAN_response":{"type":"object","properties":{"_self":{"type":"string","description":"_self"},"payPlanId":{"type":"string","maxLength":10,"description":"Pay Plan ID is a system-assigned random number that stays with the pay plan for life.","example":"4444444444"},"account":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"accountId":{"type":"string","maxLength":10,"description":"Account ID"}}},"comments":{"type":"string","maxLength":254,"description":"Comments describe any special notes about the pay plan."},"creationDateTime":{"type":"string","format":"date-time","description":"Create Date/Time describes the date and time on which pay plan was created.","example":"2009-10-05T00:22:06-04:00"},"lastStatusDateTime":{"type":"string","format":"date-time","description":"Last Status Date/Time describes the date and time on which pay plan was changed.","example":"2009-10-07T01:47:04-04:00"},"lastUpdatedBy":{"type":"object","description":"Last Updated by displays the id of the user who last modified the pay plan","properties":{"_link":{"type":"string","description":"_link"},"userId":{"type":"string","maxLength":8,"description":"User"}}},"payorAccountId":{"type":"object","description":"Payor Account Id contains the account ID and name of the person responsible for making the pay plan's payments.","properties":{"_link":{"type":"string","description":"_link"},"payorAccountId":{"type":"string","maxLength":10,"description":"Payor Account Id contains the account ID and name of the person responsible for making the pay plan's payments.","example":"4000060000"}}},"payMethod":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"payMethod":{"type":"string","maxLength":10,"description":"Pay Method"}}},"cancelReasonFlag":{"type":"string","enum":["10  ","20  "],"description":"Cancel Reason describes how the pay plan was cancelled .\n* `10  ` - Canceled by System,\n* `20  ` - Canceled by User","example":"10"},"status":{"type":"string","enum":["20  ","30  ","40  ","50  "],"description":"The Status displays the status of the pay plan.\n* `20  ` - Active,\n* `30  ` - Canceled,\n* `40  ` - Broken,\n* `50  ` - Kept","example":"20"},"payPlanType":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"payPlanType":{"type":"string","maxLength":12,"description":"Pay Plan Type"}}},"startDate":{"type":"string","format":"date","description":"Start Date defines the first day on which the pay plan is tracked; it defaults to the current date.","example":"2009-08-20"},"debtClassDescription":{"type":"string","maxLength":30,"description":"Description for the debt class.","example":"Payment arrangement"},"currentBalance":{"type":"number","description":"The account's Current Balance for the debt class whose debt is insulated by the pay plan.","example":"-75.00"},"delinquentDebt":{"type":"number","description":"Delinquent Amount is the amount of the customer's debt that was due on / before the prior bill's due date.","example":"0.00"},"thirdPartyPayor":{"type":"object","description":"If a 3rd party is responsible for the pay plan's payment, Third Party Payor must be checked, and the associated 3rd party selected.","properties":{"_link":{"type":"string","description":"_link"},"thirdPartyPayor":{"type":"string","maxLength":12,"description":"Third Party Payor"}}},"isThirdPartyGuarantor":{"type":"boolean","description":"Turn on the Third Party Guarantor switch if the person is a third party guarantor of the account's debt. This switch is off  if the person is the Main Customer.","example":"true"},"totalAmount":{"type":"number","description":"The Total Amount of the pay plan's scheduled payments.","example":"100"},"createdBy":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"userId":{"type":"string","maxLength":8,"description":"User"}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks.","example":"2"},"scheduledPayments":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"payPlanId":{"type":"string","maxLength":10,"description":"Pay Plan ID"},"scheduledDate":{"type":"string","format":"date","description":"The Scheduled Date for pay plan's scheduled payments.","example":"2009-10-08"},"scheduledAmount":{"type":"number","description":"Scheduled Amount for pay plan's scheduled payments.","example":"75.00"},"autopayClearingId":{"type":"string","maxLength":12,"description":"Auto Pay Clearing"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"}}}}}}},"xml":{"name":"C1PayPlan"}},"UPDATEPAYPLAN_request":{"type":"object","properties":{"payPlanId":{"type":"string","maxLength":10,"description":"Pay Plan ID is a system-assigned random number that stays with the pay plan for life.","example":"4444444444"},"account":{"type":"object","properties":{"accountId":{"type":"string","maxLength":10,"description":"Account ID"}}},"comments":{"type":"string","maxLength":254,"description":"Comments describe any special notes about the pay plan."},"creationDateTime":{"type":"string","format":"date-time","description":"Create Date/Time describes the date and time on which pay plan was created.","example":"2009-10-05T00:22:06-04:00"},"lastStatusDateTime":{"type":"string","format":"date-time","description":"Last Status Date/Time describes the date and time on which pay plan was changed.","example":"2009-10-07T01:47:04-04:00"},"lastUpdatedBy":{"type":"object","description":"Last Updated by displays the id of the user who last modified the pay plan","properties":{"userId":{"type":"string","maxLength":8,"description":"User"}}},"payorAccountId":{"type":"object","description":"Payor Account Id contains the account ID and name of the person responsible for making the pay plan's payments.","properties":{"payorAccountId":{"type":"string","maxLength":10,"description":"Payor Account Id contains the account ID and name of the person responsible for making the pay plan's payments.","example":"4000060000"}}},"payMethod":{"type":"object","properties":{"payMethod":{"type":"string","maxLength":10,"description":"Pay Method"}}},"cancelReasonFlag":{"type":"string","enum":["10  ","20  "],"description":"Cancel Reason describes how the pay plan was cancelled .\n* `10  ` - Canceled by System,\n* `20  ` - Canceled by User","example":"10"},"status":{"type":"string","enum":["20  ","30  ","40  ","50  "],"description":"The Status displays the status of the pay plan.\n* `20  ` - Active,\n* `30  ` - Canceled,\n* `40  ` - Broken,\n* `50  ` - Kept","example":"20"},"payPlanType":{"type":"object","properties":{"payPlanType":{"type":"string","maxLength":12,"description":"Pay Plan Type"}}},"startDate":{"type":"string","format":"date","description":"Start Date defines the first day on which the pay plan is tracked; it defaults to the current date.","example":"2009-08-20"},"currentBalance":{"type":"number","description":"The account's Current Balance for the debt class whose debt is insulated by the pay plan.","example":"-75.00"},"delinquentDebt":{"type":"number","description":"Delinquent Amount is the amount of the customer's debt that was due on / before the prior bill's due date.","example":"0.00"},"thirdPartyPayor":{"type":"object","description":"If a 3rd party is responsible for the pay plan's payment, Third Party Payor must be checked, and the associated 3rd party selected.","properties":{"thirdPartyPayor":{"type":"string","maxLength":12,"description":"Third Party Payor"}}},"isThirdPartyGuarantor":{"type":"boolean","description":"Turn on the Third Party Guarantor switch if the person is a third party guarantor of the account's debt. This switch is off  if the person is the Main Customer.","example":"true"},"totalAmount":{"type":"number","description":"The Total Amount of the pay plan's scheduled payments.","example":"100"},"createdBy":{"type":"object","properties":{"userId":{"type":"string","maxLength":8,"description":"User"}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks.","example":"2"},"scheduledPayments":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"payPlanId":{"type":"string","maxLength":10,"description":"Pay Plan ID"},"scheduledDate":{"type":"string","format":"date","description":"The Scheduled Date for pay plan's scheduled payments.","example":"2009-10-08"},"scheduledAmount":{"type":"number","description":"Scheduled Amount for pay plan's scheduled payments.","example":"75.00"},"autopayClearingId":{"type":"string","maxLength":12,"description":"Auto Pay Clearing"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"}}}}}}},"xml":{"name":"C1PayPlan"}},"GETPAYPLAN_response":{"type":"object","properties":{"_self":{"type":"string","description":"_self"},"payPlanId":{"type":"string","maxLength":10,"description":"Pay Plan ID is a system-assigned random number that stays with the pay plan for life.","example":"4444444444"},"account":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"accountId":{"type":"string","maxLength":10,"description":"Account ID"}}},"comments":{"type":"string","maxLength":254,"description":"Comments describe any special notes about the pay plan."},"creationDateTime":{"type":"string","format":"date-time","description":"Create Date/Time describes the date and time on which pay plan was created.","example":"2009-10-05T00:22:06-04:00"},"lastStatusDateTime":{"type":"string","format":"date-time","description":"Last Status Date/Time describes the date and time on which pay plan was changed.","example":"2009-10-07T01:47:04-04:00"},"lastUpdatedBy":{"type":"object","description":"Last Updated by displays the id of the user who last modified the pay plan","properties":{"_link":{"type":"string","description":"_link"},"userId":{"type":"string","maxLength":8,"description":"User"}}},"payorAccountId":{"type":"object","description":"Payor Account Id contains the account ID and name of the person responsible for making the pay plan's payments.","properties":{"_link":{"type":"string","description":"_link"},"payorAccountId":{"type":"string","maxLength":10,"description":"Payor Account Id contains the account ID and name of the person responsible for making the pay plan's payments.","example":"4000060000"}}},"payMethod":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"payMethod":{"type":"string","maxLength":10,"description":"Pay Method"}}},"cancelReasonFlag":{"type":"string","enum":["10  ","20  "],"description":"Cancel Reason describes how the pay plan was cancelled .\n* `10  ` - Canceled by System,\n* `20  ` - Canceled by User","example":"10"},"status":{"type":"string","enum":["20  ","30  ","40  ","50  "],"description":"The Status displays the status of the pay plan.\n* `20  ` - Active,\n* `30  ` - Canceled,\n* `40  ` - Broken,\n* `50  ` - Kept","example":"20"},"payPlanType":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"payPlanType":{"type":"string","maxLength":12,"description":"Pay Plan Type"}}},"startDate":{"type":"string","format":"date","description":"Start Date defines the first day on which the pay plan is tracked; it defaults to the current date.","example":"2009-08-20"},"debtClassDescription":{"type":"string","maxLength":30,"description":"Description for the debt class.","example":"Payment arrangement"},"currentBalance":{"type":"number","description":"The account's Current Balance for the debt class whose debt is insulated by the pay plan.","example":"-75.00"},"delinquentDebt":{"type":"number","description":"Delinquent Amount is the amount of the customer's debt that was due on / before the prior bill's due date.","example":"0.00"},"thirdPartyPayor":{"type":"object","description":"If a 3rd party is responsible for the pay plan's payment, Third Party Payor must be checked, and the associated 3rd party selected.","properties":{"_link":{"type":"string","description":"_link"},"thirdPartyPayor":{"type":"string","maxLength":12,"description":"Third Party Payor"}}},"isThirdPartyGuarantor":{"type":"boolean","description":"Turn on the Third Party Guarantor switch if the person is a third party guarantor of the account's debt. This switch is off  if the person is the Main Customer.","example":"true"},"totalAmount":{"type":"number","description":"The Total Amount of the pay plan's scheduled payments.","example":"100"},"createdBy":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"userId":{"type":"string","maxLength":8,"description":"User"}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks.","example":"2"},"scheduledPayments":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"payPlanId":{"type":"string","maxLength":10,"description":"Pay Plan ID"},"scheduledDate":{"type":"string","format":"date","description":"The Scheduled Date for pay plan's scheduled payments.","example":"2009-10-08"},"scheduledAmount":{"type":"number","description":"Scheduled Amount for pay plan's scheduled payments.","example":"75.00"},"autopayClearingId":{"type":"string","maxLength":12,"description":"Auto Pay Clearing"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"}}}}}}},"xml":{"name":"C1PayPlan"}},"GETACCOUNTFINANCIALHISTORY_response":{"type":"object","properties":{"_self":{"type":"string","description":"_self"},"account":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"accountId":{"type":"string","maxLength":10,"description":"The Account ID is a system-assigned random number that stays with an account for life.","example":"1589800000"}}},"searchBy":{"type":"string","maxLength":10,"description":"Search By"},"offset":{"type":"number","maximum":999999999.999999,"minimum":0,"description":"The offset element is an integer value that specifies the index of the first item to be returned. The \"offset\" index begins at 0 and cannot be negative.","example":"0"},"limit":{"type":"number","maximum":999999999.999999,"minimum":0,"description":"The Limit element is an integer value that specifies the paging size for number of records to return when serving a client request.","example":"100"},"totalResult":{"type":"number","maximum":0,"minimum":0,"description":"This element is an integer value that specifies the total number of the resource instances, including instances in the current response, as well as instances that have not been fetched.","example":"18"},"hasMore":{"type":"boolean","description":"The hasMore element is a Boolean value that indicates whether there are more items/result records to be retrieved.","example":"false"},"count":{"type":"number","maximum":0,"minimum":0,"description":"The count element is an integer value that specifies the actual number of items contained in the paging response.","example":"18"},"accountFinancialHistoryList":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"accountingDate":{"type":"string","format":"date","description":"Accounting Date is the date the system uses to determine the FT's accounting period in your general ledger.","example":"2021-01-06-00.00.00"},"arrearsDate":{"type":"string","format":"date","description":"Arrears Date is the date the FT starts aging.","example":"2021-01-06-00.00.00"},"glExtractDate":{"type":"string","format":"date","description":"GL Extract Date","example":"2014-01-13-00.00.00"},"financialTransactionType":{"type":"string","maxLength":2,"description":"Financial Transaction Type indicates the type of financial event: Bill Segment, Pay Segment, Bill Segment Cancellation, Pay Segment Cancellation, Adjustment, and Adjustment (Cancel).","example":"Bill Segment Cancellation"},"bill":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"billId":{"type":"string","maxLength":12,"description":"Bill Segment ID"}}},"payment":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"paymentId":{"type":"string","maxLength":12,"description":"Bill Segment ID"}}},"currentAmount":{"type":"string","maxLength":15,"description":"Current Amount shows the financial event's effect on the account's current balance.","example":"-20.23"},"currentBalance":{"type":"string","maxLength":15,"description":"Current Balance shows the account's current balance after the financial event.","example":"-128.42"},"payOffAmount":{"type":"string","maxLength":1,"description":"Payoff Amount shows the financial event's effect on the account's payoff balance.","example":"-20.23"},"payOffBalance":{"type":"string","maxLength":15,"description":"Payoff Balance  shows the account's payoff balance after the financial event.","example":"-128.42"}}}}}}},"xml":{"name":"C1-GtFAcFHis"}},"DELETEADJUSTMENT_response":{"type":"object","properties":{"adjustmentId":{"type":"string","maxLength":12,"description":"Adjustment ID is the system-assigned, unique identifier of the adjustment."}},"xml":{"name":"C1-DelAdjust"}},"UPDATEADJUSTMENT_request":{"type":"object","properties":{"adjustmentId":{"type":"string","maxLength":12,"description":"Adjustment ID is the system-assigned, unique identifier of the adjustment."},"account":{"type":"object","properties":{"accountId":{"type":"string","maxLength":10,"description":"Account ID is the account to which the adjustment is linked.","example":"1589800000"}}},"serviceAgreement":{"type":"object","description":"Service Agreement ID whose financial balance needs to be adjusted.","properties":{"serviceAgreementId":{"type":"string","maxLength":10,"description":"Service Agreement"}}},"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.","example":"4000000099"}}},"adjustmentType":{"type":"object","description":"Adjustment Type controls numerous aspects of the adjustment's impact on the customer's balance and general ledger.","properties":{"adjustmentType":{"type":"string","maxLength":8,"description":"Adjustment Type controls numerous aspects of the adjustment's impact on the customer's balance and general ledger.","example":"CUSTREL"}}},"adjustmentStatus":{"type":"string","enum":["05  ","10  ","20  ","30  ","50  ","60  "],"description":"Adjustment Status shows the status of the transfer to adjustment. If you need to change the adjustment's status, use the action links\n* `05  ` - New,\n* `10  ` - Incomplete,\n* `20  ` - Error,\n* `30  ` - Freezable,\n* `50  ` - Frozen,\n* `60  ` - Canceled","example":"30"},"creationDate":{"type":"string","format":"date","description":"The Creation Date defines the date on which the adjustment was created."},"comments":{"type":"string","maxLength":254,"description":"Use the Comments to describe anything unusual about the adjustment."},"baseAmount":{"type":"number","description":"Current Amount"},"amount":{"type":"number","description":"Current Amount"},"calculatedAmount":{"type":"number","description":"Calculated Amount is the calculated amount associated with the calculation line."},"onBehalfSAId":{"type":"string","maxLength":10,"description":"On Behalf SA ID is only populated on system-generated adjustments instigated by one customer, but attributed to another customer."},"cancelReason":{"type":"object","description":"If the status is canceled, the Cancel Reason is displayed.","properties":{"cancelReason":{"type":"string","maxLength":4,"description":"If the status is canceled, the Cancel Reason is displayed."}}},"currency":{"type":"object","properties":{"currency":{"type":"string","maxLength":3,"description":"Currency Code"}}},"accountingDate":{"type":"string","format":"date","description":"Accounting Date"},"calculationDate":{"type":"string","format":"date","description":"Calculation date is used for a calculated adjustment type by the generate adjustment algorithm for any calculations that are effective dated (e.g., rate version calculation group or bill factor value).","example":"2005-11-23"},"approvalRequest":{"type":"object","properties":{"approvalRequestId":{"type":"string","maxLength":12,"description":"Approval Request shows that the adjustment is subject to approval. Adjustments are required to be approved by one or more managers before they impact a customer's debt and the general ledger."}}},"generate":{"type":"boolean","description":"(canGenerate)"},"submitForApproval":{"type":"boolean","description":"(isSubmit)"},"cancel":{"type":"boolean","description":"(isCancel)"},"freeze":{"type":"boolean","description":"(isFrozen)"},"delete":{"type":"boolean","description":"(canDelete)"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"},"financialTransactions":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"financialTransaction":{"type":"object","properties":{"financialTransactionId":{"type":"string","maxLength":12,"description":"Financial Transaction ID"}}},"arrearsDate":{"type":"string","format":"date","description":"Arrears Date"},"accountingDate":{"type":"string","format":"date","description":"Accounting Date"},"currentAmount":{"type":"number","description":"Current Amount"},"payoffAmount":{"type":"number","description":"Payoff Amount"},"billId":{"type":"string","maxLength":12,"description":"Bill ID"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"}}}}}},"transferAdjustments":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"transferAccount":{"type":"object","properties":{"transferAccountId":{"type":"string","maxLength":30,"description":"Account ID 2"}}},"transferServiceAgreement":{"type":"object","properties":{"transferServiceAgreementId":{"type":"string","maxLength":30,"description":"Service Agreement ID 2"}}},"transferPremise":{"type":"object","properties":{"transferPremiseId":{"type":"string","maxLength":10,"description":"Transfer Premise ID"}}},"transferAdjustmentId":{"type":"string","maxLength":12,"description":"Transfer Adjustment ID is the system-assigned, unique identifier of the adjustment."},"transferAdjustmentType":{"type":"object","properties":{"transferAdjustmentType":{"type":"string","maxLength":8,"description":"Transfer Adjustment Type"}}},"creDt2":{"type":"string","format":"date","description":"Creation Date defines the date on which the adjustment was created."},"adjAmt2":{"type":"number","description":"Transfer Adjustment Amount","example":"0.00"},"transferCurrency":{"type":"object","properties":{"transferCurrency":{"type":"string","maxLength":30,"description":"Currency Code 2"}}},"adjStatusFlg2":{"type":"string","maxLength":10,"description":"Adjustment Status shows the status of the transfer to adjustment."},"comments2":{"type":"string","maxLength":100,"description":"Use the Comments to describe anything unusual about the adjustment."},"version":{"type":"number","maximum":0,"minimum":0,"description":"Version2"},"transferFinancialTransactions":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"financialTransaction":{"type":"object","properties":{"financialTransactionId":{"type":"string","maxLength":12,"description":"Financial Transaction ID"}}},"arrearsDate":{"type":"string","format":"date","description":"Arrears Date"},"currentAmount":{"type":"number","description":"Current Amount"},"payoffAmount":{"type":"number","description":"Payoff Amount"},"bill":{"type":"object","properties":{"billId":{"type":"string","maxLength":12,"description":"Bill ID"}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"}}}}}}}}}}},"accountsPayableRequests":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"autopayRequest":{"type":"object","properties":{"autopayRequestId":{"type":"string","maxLength":12,"description":"A/P Request ID"}}},"account":{"type":"object","properties":{"accountId":{"type":"string","maxLength":10,"description":"Account ID"}}},"paymentSelectionStatus":{"type":"string","enum":["C   ","D   ","H   ","N   ","P   ","R   ","V   ","X   "],"description":"Payment Selection Status is the status of the check request.\n* `C   ` - Closed,\n* `D   ` - Negative Voucher Sum,\n* `H   ` - Held,\n* `N   ` - Not Selected for Payment,\n* `P   ` - Paid,\n* `R   ` - Requested for Payment,\n* `V   ` - Convert Error,\n* `X   ` - Canceled","example":"N"},"paymentNumber":{"type":"string","maxLength":36,"description":"Payment Number is the system-assigned number of the payment in A/P (this number typically appears on the printed check). This field is only populated after A/P cuts the check."},"scheduledToPayDate":{"type":"string","format":"date","description":"Scheduled to Pay is the date on which the check is scheduled to be cut. This is equal to the adjustment date plus the Due Days on the adjustment type's A/P request type.","example":"2005-11-23"},"paymentDate":{"type":"string","format":"date","description":"Payment Date is the date on which the check was cut in A/P. This field is only populated after A/P cuts the check.","example":"2005-11-23"},"paidAmount":{"type":"number","description":"Paid Amount is the amount of the check. This field is only populated after A/P cuts the check.","example":"0.00"},"paymentCurrency":{"type":"object","properties":{"paymentCurrency":{"type":"string","maxLength":3,"description":"Currency Code"}}},"country":{"type":"object","properties":{"country":{"type":"string","maxLength":3,"description":"Country"}}},"postal":{"type":"string","maxLength":12,"description":"The postal code of the address.","example":"07960"},"address1":{"type":"string","maxLength":254,"description":"The first line of the address.","example":"1 Speedwell"},"address2":{"type":"string","maxLength":254,"description":"The second line of the address.","example":"Morristown"},"address3":{"type":"string","maxLength":254,"description":"The third line of the address."},"address4":{"type":"string","maxLength":254,"description":"The fourth line of the address."},"city":{"type":"string","maxLength":90,"description":"The city of the address.","example":"San Francisco"},"streetNumber1":{"type":"string","maxLength":6,"description":"The first street number line of the address."},"streetNumber2":{"type":"string","maxLength":4,"description":"The second street number line of the address."},"county":{"type":"string","maxLength":90,"description":"The county of the address.","example":"San Francisco"},"state":{"type":"string","maxLength":6,"description":"The state of the address.","example":"CA"},"taxVendorGeographicalCode":{"type":"string","maxLength":11,"description":"Geographic code used to apply proper taxation rules to the physical address location."},"isInCityLimit":{"type":"boolean","description":"In City Limit switch is on if the address is considered within the physical city limits.","example":"false"},"houseType":{"type":"string","enum":["AB  ","WW  "],"description":"House Type indicates the type of house if applicable for the address.\n* `AB  ` - House Boat References,\n* `WW  ` - House Trailer Reference"}}}}}},"calculationDetails":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"rateSchedule":{"type":"string","maxLength":8,"description":"Rate Schedule"},"effectiveDate":{"type":"string","format":"date","description":"Effective Date"},"_data":{"type":"array","items":{"type":"object","properties":{"sequence":{"type":"number","maximum":99999,"minimum":-99999,"description":"Sequence is the system-assigned unique identifier of the calculation detail row.","example":"1"},"descriptionOnBill":{"type":"string","maxLength":254,"description":"Description on Bill is the information about the calculation line that appears on the customer's bill.","example":"Base Adjustment Amount"},"auditCalculatedAmount":{"type":"number","maximum":10000000000000,"minimum":-10000000000000,"description":"Calculated Amount is the calculated amount associated with the calculation line.","example":"1.23000"},"shouldPrint":{"type":"boolean","description":"The Print switch controls whether information about this line will print on the customer's bill.","example":"true"},"shouldAppearInSummary":{"type":"boolean","description":"The Appears in Summary switch defines if this line's amount also appears on a summary line. This switch plays a part at bill print time - those lines that appear in a summary print in the left dollar column, those that don't appear in a summary print in the right dollar column.","example":"true"},"unitOfMeasure":{"type":"object","properties":{"unitOfMeasure":{"type":"string","maxLength":30,"description":"Unit of Measure"}}},"timeOfUse":{"type":"object","properties":{"timeOfUse":{"type":"string","maxLength":30,"description":"Time of Use"}}},"serviceQuantityIdentifier":{"type":"object","properties":{"serviceQuantityIdentifier":{"type":"string","maxLength":30,"description":"SQI"}}},"billableServiceQuantity":{"type":"number","maximum":1000000000000,"minimum":-1000000000000,"description":"Billable Service Quantity is the service quantity priced on the calculation line. This quantity differs from the measured consumption if there are pre-processing calculation groups in effect.","example":"1.230000"},"baseAmount":{"type":"number","description":"Base Amount"},"currency":{"type":"object","properties":{"currency":{"type":"string","maxLength":3,"description":"Currency Code"}}},"rateCompSequence":{"type":"number","maximum":9999,"minimum":-9999,"description":"Sequence"},"measuresPeakQuantity":{"type":"boolean","description":"Measures Peak Qty is checked if the UOM priced on the calculation line is used to measure a peak quantity.","example":"false"},"exemptAmount":{"type":"number","description":"Exempt Amount is the amount of the calculated charge that the customer doesn't have to pay because they are tax exempt.","example":"0.00"},"distributionCode":{"type":"object","properties":{"distributionCode":{"type":"string","maxLength":10,"description":"Distribution Code"}}},"description":{"type":"string","maxLength":100,"description":"Description describes the characteristic value that was used when the line's amount was calculated. This information is only displayed if the line was calculated using a bill factor (because only bill factors use characteristic values)."},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"},"characteristicType":{"type":"object","properties":{"characteristicType":{"type":"string","maxLength":8,"description":"Characteristic Type"}}},"characteristicValue":{"type":"string","maxLength":16,"description":"Characteristic Value Indicates the value of the characteristic."}}}}}}}}},"characteristics":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"sequence":{"type":"number","maximum":999,"minimum":-999,"description":"Sequence"},"characteristicType":{"type":"object","properties":{"characteristicType":{"type":"string","maxLength":8,"description":"Characteristic Type"}}},"typeOfCharacteristicValue":{"type":"string","maxLength":4,"description":"Characteristic Value indicates the value of the characteristic if the characteristic type is pre-defined or foreign key reference."},"characteristicValue":{"type":"object","properties":{"_link":{"type":"string","description":"(_link)"},"value":{"type":"string","description":"(value)"},"value2":{"type":"string","description":"(value2)"},"value3":{"type":"string","description":"(value3)"},"value4":{"type":"string","description":"(value4)"},"value5":{"type":"string","description":"(value5)"}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks.","example":"2"}}}}}},"nextActions":{"type":"object","properties":{"_link":{"type":"string","description":"(_link)"},"_data":{"type":"array","items":{"type":"object","properties":{"_link":{"type":"string","description":"(_link)"},"actionName":{"type":"string","description":"(actionName)"}}}}}}},"xml":{"name":"C1-Adjust"}},"GETADJUSTMENT_response":{"type":"object","properties":{"_self":{"type":"string","description":"_self"},"adjustmentId":{"type":"string","maxLength":12,"description":"Adjustment ID is the system-assigned, unique identifier of the adjustment."},"account":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"accountId":{"type":"string","maxLength":10,"description":"Account ID is the account to which the adjustment is linked.","example":"1589800000"}}},"serviceAgreement":{"type":"object","description":"Service Agreement ID whose financial balance needs to be adjusted.","properties":{"_link":{"type":"string","description":"_link"},"serviceAgreementId":{"type":"string","maxLength":10,"description":"Service Agreement"}}},"premise":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"premiseId":{"type":"string","maxLength":10,"description":"Premise ID is a system assigned, unique identifier that shows the primary premise associated with the service agreement.","example":"4000000099"}}},"adjustmentType":{"type":"object","description":"Adjustment Type controls numerous aspects of the adjustment's impact on the customer's balance and general ledger.","properties":{"_link":{"type":"string","description":"_link"},"adjustmentType":{"type":"string","maxLength":8,"description":"Adjustment Type controls numerous aspects of the adjustment's impact on the customer's balance and general ledger.","example":"CUSTREL"}}},"adjustmentStatus":{"type":"string","enum":["05  ","10  ","20  ","30  ","50  ","60  "],"description":"Adjustment Status shows the status of the transfer to adjustment. If you need to change the adjustment's status, use the action links\n* `05  ` - New,\n* `10  ` - Incomplete,\n* `20  ` - Error,\n* `30  ` - Freezable,\n* `50  ` - Frozen,\n* `60  ` - Canceled","example":"30"},"creationDate":{"type":"string","format":"date","description":"The Creation Date defines the date on which the adjustment was created."},"comments":{"type":"string","maxLength":254,"description":"Use the Comments to describe anything unusual about the adjustment."},"baseAmount":{"type":"number","description":"Current Amount"},"amount":{"type":"number","description":"Current Amount"},"calculatedAmount":{"type":"number","description":"Calculated Amount is the calculated amount associated with the calculation line."},"onBehalfSAId":{"type":"string","maxLength":10,"description":"On Behalf SA ID is only populated on system-generated adjustments instigated by one customer, but attributed to another customer."},"cancelReason":{"type":"object","description":"If the status is canceled, the Cancel Reason is displayed.","properties":{"_link":{"type":"string","description":"_link"},"cancelReason":{"type":"string","maxLength":4,"description":"If the status is canceled, the Cancel Reason is displayed."}}},"currency":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"currency":{"type":"string","maxLength":3,"description":"Currency Code"}}},"accountingDate":{"type":"string","format":"date","description":"Accounting Date"},"calculationDate":{"type":"string","format":"date","description":"Calculation date is used for a calculated adjustment type by the generate adjustment algorithm for any calculations that are effective dated (e.g., rate version calculation group or bill factor value).","example":"2005-11-23"},"approvalRequest":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"approvalRequestId":{"type":"string","maxLength":12,"description":"Approval Request shows that the adjustment is subject to approval. Adjustments are required to be approved by one or more managers before they impact a customer's debt and the general ledger."}}},"generate":{"type":"boolean","description":"(canGenerate)"},"submitForApproval":{"type":"boolean","description":"(isSubmit)"},"cancel":{"type":"boolean","description":"(isCancel)"},"freeze":{"type":"boolean","description":"(isFrozen)"},"delete":{"type":"boolean","description":"(canDelete)"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"},"financialTransactions":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"financialTransaction":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"financialTransactionId":{"type":"string","maxLength":12,"description":"Financial Transaction ID"}}},"arrearsDate":{"type":"string","format":"date","description":"Arrears Date"},"accountingDate":{"type":"string","format":"date","description":"Accounting Date"},"currentAmount":{"type":"number","description":"Current Amount"},"payoffAmount":{"type":"number","description":"Payoff Amount"},"billId":{"type":"string","maxLength":12,"description":"Bill ID"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"}}}}}},"transferAdjustments":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"transferAccount":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"transferAccountId":{"type":"string","maxLength":30,"description":"Account ID 2"}}},"transferServiceAgreement":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"transferServiceAgreementId":{"type":"string","maxLength":30,"description":"Service Agreement ID 2"}}},"transferPremise":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"transferPremiseId":{"type":"string","maxLength":10,"description":"Transfer Premise ID"}}},"transferAdjustmentId":{"type":"string","maxLength":12,"description":"Transfer Adjustment ID is the system-assigned, unique identifier of the adjustment."},"transferAdjustmentType":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"transferAdjustmentType":{"type":"string","maxLength":8,"description":"Transfer Adjustment Type"}}},"creDt2":{"type":"string","format":"date","description":"Creation Date defines the date on which the adjustment was created."},"adjAmt2":{"type":"number","description":"Transfer Adjustment Amount","example":"0.00"},"transferCurrency":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"transferCurrency":{"type":"string","maxLength":30,"description":"Currency Code 2"}}},"adjStatusFlg2":{"type":"string","maxLength":10,"description":"Adjustment Status shows the status of the transfer to adjustment."},"comments2":{"type":"string","maxLength":100,"description":"Use the Comments to describe anything unusual about the adjustment."},"version":{"type":"number","maximum":0,"minimum":0,"description":"Version2"},"transferFinancialTransactions":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"financialTransaction":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"financialTransactionId":{"type":"string","maxLength":12,"description":"Financial Transaction ID"}}},"arrearsDate":{"type":"string","format":"date","description":"Arrears Date"},"currentAmount":{"type":"number","description":"Current Amount"},"payoffAmount":{"type":"number","description":"Payoff Amount"},"bill":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"billId":{"type":"string","maxLength":12,"description":"Bill ID"}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"}}}}}}}}}}},"accountsPayableRequests":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"autopayRequest":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"autopayRequestId":{"type":"string","maxLength":12,"description":"A/P Request ID"}}},"account":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"accountId":{"type":"string","maxLength":10,"description":"Account ID"}}},"paymentSelectionStatus":{"type":"string","enum":["C   ","D   ","H   ","N   ","P   ","R   ","V   ","X   "],"description":"Payment Selection Status is the status of the check request.\n* `C   ` - Closed,\n* `D   ` - Negative Voucher Sum,\n* `H   ` - Held,\n* `N   ` - Not Selected for Payment,\n* `P   ` - Paid,\n* `R   ` - Requested for Payment,\n* `V   ` - Convert Error,\n* `X   ` - Canceled","example":"N"},"paymentNumber":{"type":"string","maxLength":36,"description":"Payment Number is the system-assigned number of the payment in A/P (this number typically appears on the printed check). This field is only populated after A/P cuts the check."},"scheduledToPayDate":{"type":"string","format":"date","description":"Scheduled to Pay is the date on which the check is scheduled to be cut. This is equal to the adjustment date plus the Due Days on the adjustment type's A/P request type.","example":"2005-11-23"},"paymentDate":{"type":"string","format":"date","description":"Payment Date is the date on which the check was cut in A/P. This field is only populated after A/P cuts the check.","example":"2005-11-23"},"paidAmount":{"type":"number","description":"Paid Amount is the amount of the check. This field is only populated after A/P cuts the check.","example":"0.00"},"paymentCurrency":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"paymentCurrency":{"type":"string","maxLength":3,"description":"Currency Code"}}},"country":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"country":{"type":"string","maxLength":3,"description":"Country"}}},"postal":{"type":"string","maxLength":12,"description":"The postal code of the address.","example":"07960"},"address1":{"type":"string","maxLength":254,"description":"The first line of the address.","example":"1 Speedwell"},"address2":{"type":"string","maxLength":254,"description":"The second line of the address.","example":"Morristown"},"address3":{"type":"string","maxLength":254,"description":"The third line of the address."},"address4":{"type":"string","maxLength":254,"description":"The fourth line of the address."},"city":{"type":"string","maxLength":90,"description":"The city of the address.","example":"San Francisco"},"streetNumber1":{"type":"string","maxLength":6,"description":"The first street number line of the address."},"streetNumber2":{"type":"string","maxLength":4,"description":"The second street number line of the address."},"county":{"type":"string","maxLength":90,"description":"The county of the address.","example":"San Francisco"},"state":{"type":"string","maxLength":6,"description":"The state of the address.","example":"CA"},"taxVendorGeographicalCode":{"type":"string","maxLength":11,"description":"Geographic code used to apply proper taxation rules to the physical address location."},"isInCityLimit":{"type":"boolean","description":"In City Limit switch is on if the address is considered within the physical city limits.","example":"false"},"houseType":{"type":"string","enum":["AB  ","WW  "],"description":"House Type indicates the type of house if applicable for the address.\n* `AB  ` - House Boat References,\n* `WW  ` - House Trailer Reference"}}}}}},"calculationDetails":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"rateSchedule":{"type":"string","maxLength":8,"description":"Rate Schedule"},"effectiveDate":{"type":"string","format":"date","description":"Effective Date"},"_data":{"type":"array","items":{"type":"object","properties":{"sequence":{"type":"number","maximum":99999,"minimum":-99999,"description":"Sequence is the system-assigned unique identifier of the calculation detail row.","example":"1"},"descriptionOnBill":{"type":"string","maxLength":254,"description":"Description on Bill is the information about the calculation line that appears on the customer's bill.","example":"Base Adjustment Amount"},"auditCalculatedAmount":{"type":"number","maximum":10000000000000,"minimum":-10000000000000,"description":"Calculated Amount is the calculated amount associated with the calculation line.","example":"1.23000"},"shouldPrint":{"type":"boolean","description":"The Print switch controls whether information about this line will print on the customer's bill.","example":"true"},"shouldAppearInSummary":{"type":"boolean","description":"The Appears in Summary switch defines if this line's amount also appears on a summary line. This switch plays a part at bill print time - those lines that appear in a summary print in the left dollar column, those that don't appear in a summary print in the right dollar column.","example":"true"},"unitOfMeasure":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"unitOfMeasure":{"type":"string","maxLength":30,"description":"Unit of Measure"}}},"timeOfUse":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"timeOfUse":{"type":"string","maxLength":30,"description":"Time of Use"}}},"serviceQuantityIdentifier":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"serviceQuantityIdentifier":{"type":"string","maxLength":30,"description":"SQI"}}},"billableServiceQuantity":{"type":"number","maximum":1000000000000,"minimum":-1000000000000,"description":"Billable Service Quantity is the service quantity priced on the calculation line. This quantity differs from the measured consumption if there are pre-processing calculation groups in effect.","example":"1.230000"},"baseAmount":{"type":"number","description":"Base Amount"},"currency":{"type":"string","maxLength":3,"description":"Currency Code"},"rateCompSequence":{"type":"number","maximum":9999,"minimum":-9999,"description":"Sequence"},"measuresPeakQuantity":{"type":"boolean","description":"Measures Peak Qty is checked if the UOM priced on the calculation line is used to measure a peak quantity.","example":"false"},"exemptAmount":{"type":"number","description":"Exempt Amount is the amount of the calculated charge that the customer doesn't have to pay because they are tax exempt.","example":"0.00"},"distributionCode":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"distributionCode":{"type":"string","maxLength":10,"description":"Distribution Code"}}},"description":{"type":"string","maxLength":100,"description":"Description describes the characteristic value that was used when the line's amount was calculated. This information is only displayed if the line was calculated using a bill factor (because only bill factors use characteristic values)."},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"},"characteristicType":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"characteristicType":{"type":"string","maxLength":8,"description":"Characteristic Type"}}},"characteristicValue":{"type":"string","maxLength":16,"description":"Characteristic Value Indicates the value of the characteristic."}}}}}}}}},"characteristics":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"sequence":{"type":"number","maximum":999,"minimum":-999,"description":"Sequence"},"characteristicType":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"characteristicType":{"type":"string","maxLength":8,"description":"Characteristic Type"}}},"typeOfCharacteristicValue":{"type":"string","maxLength":4,"description":"Characteristic Value indicates the value of the characteristic if the characteristic type is pre-defined or foreign key reference."},"characteristicValue":{"type":"object","properties":{"_link":{"type":"string","description":"(_link)"},"value":{"type":"string","description":"(value)"},"value2":{"type":"string","description":"(value2)"},"value3":{"type":"string","description":"(value3)"},"value4":{"type":"string","description":"(value4)"},"value5":{"type":"string","description":"(value5)"}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks.","example":"2"}}}}}},"nextActions":{"type":"object","properties":{"_link":{"type":"string","description":"(_link)"},"_data":{"type":"array","items":{"type":"object","properties":{"_link":{"type":"string","description":"(_link)"},"actionName":{"type":"string","description":"(actionName)"}}}}}}},"xml":{"name":"C1-Adjust"}},"CRAETEADJUSTMENT_request":{"type":"object","properties":{"adjustmentId":{"type":"string","maxLength":12,"description":"Adjustment ID is the system-assigned, unique identifier of the adjustment."},"account":{"type":"object","properties":{"accountId":{"type":"string","maxLength":10,"description":"Account ID is the account to which the adjustment is linked.","example":"1589800000"}}},"serviceAgreement":{"type":"object","description":"Service Agreement ID whose financial balance needs to be adjusted.","properties":{"serviceAgreementId":{"type":"string","maxLength":10,"description":"Service Agreement"}}},"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.","example":"4000000099"}}},"adjustmentType":{"type":"object","description":"Adjustment Type controls numerous aspects of the adjustment's impact on the customer's balance and general ledger.","properties":{"adjustmentType":{"type":"string","maxLength":8,"description":"Adjustment Type controls numerous aspects of the adjustment's impact on the customer's balance and general ledger.","example":"CUSTREL"}}},"adjustmentStatus":{"type":"string","enum":["05  ","10  ","20  ","30  ","50  ","60  "],"description":"Adjustment Status shows the status of the transfer to adjustment. If you need to change the adjustment's status, use the action links\n* `05  ` - New,\n* `10  ` - Incomplete,\n* `20  ` - Error,\n* `30  ` - Freezable,\n* `50  ` - Frozen,\n* `60  ` - Canceled","example":"30"},"creationDate":{"type":"string","format":"date","description":"The Creation Date defines the date on which the adjustment was created."},"comments":{"type":"string","maxLength":254,"description":"Use the Comments to describe anything unusual about the adjustment."},"baseAmount":{"type":"number","description":"Current Amount"},"amount":{"type":"number","description":"Current Amount"},"calculatedAmount":{"type":"number","description":"Calculated Amount is the calculated amount associated with the calculation line."},"onBehalfSAId":{"type":"string","maxLength":10,"description":"On Behalf SA ID is only populated on system-generated adjustments instigated by one customer, but attributed to another customer."},"cancelReason":{"type":"object","description":"If the status is canceled, the Cancel Reason is displayed.","properties":{"cancelReason":{"type":"string","maxLength":4,"description":"If the status is canceled, the Cancel Reason is displayed."}}},"currency":{"type":"object","properties":{"currency":{"type":"string","maxLength":3,"description":"Currency Code"}}},"accountingDate":{"type":"string","format":"date","description":"Accounting Date"},"calculationDate":{"type":"string","format":"date","description":"Calculation date is used for a calculated adjustment type by the generate adjustment algorithm for any calculations that are effective dated (e.g., rate version calculation group or bill factor value).","example":"2005-11-23"},"approvalRequest":{"type":"object","properties":{"approvalRequestId":{"type":"string","maxLength":12,"description":"Approval Request shows that the adjustment is subject to approval. Adjustments are required to be approved by one or more managers before they impact a customer's debt and the general ledger."}}},"generate":{"type":"boolean","description":"(canGenerate)"},"submitForApproval":{"type":"boolean","description":"(isSubmit)"},"cancel":{"type":"boolean","description":"(isCancel)"},"freeze":{"type":"boolean","description":"(isFrozen)"},"delete":{"type":"boolean","description":"(canDelete)"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"},"financialTransactions":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"financialTransaction":{"type":"object","properties":{"financialTransactionId":{"type":"string","maxLength":12,"description":"Financial Transaction ID"}}},"arrearsDate":{"type":"string","format":"date","description":"Arrears Date"},"accountingDate":{"type":"string","format":"date","description":"Accounting Date"},"currentAmount":{"type":"number","description":"Current Amount"},"payoffAmount":{"type":"number","description":"Payoff Amount"},"billId":{"type":"string","maxLength":12,"description":"Bill ID"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"}}}}}},"transferAdjustments":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"transferAccount":{"type":"object","properties":{"transferAccountId":{"type":"string","maxLength":30,"description":"Account ID 2"}}},"transferServiceAgreement":{"type":"object","properties":{"transferServiceAgreementId":{"type":"string","maxLength":30,"description":"Service Agreement ID 2"}}},"transferPremise":{"type":"object","properties":{"transferPremiseId":{"type":"string","maxLength":10,"description":"Transfer Premise ID"}}},"transferAdjustmentId":{"type":"string","maxLength":12,"description":"Transfer Adjustment ID is the system-assigned, unique identifier of the adjustment."},"transferAdjustmentType":{"type":"object","properties":{"transferAdjustmentType":{"type":"string","maxLength":8,"description":"Transfer Adjustment Type"}}},"creDt2":{"type":"string","format":"date","description":"Creation Date defines the date on which the adjustment was created."},"adjAmt2":{"type":"number","description":"Transfer Adjustment Amount","example":"0.00"},"transferCurrency":{"type":"object","properties":{"transferCurrency":{"type":"string","maxLength":30,"description":"Currency Code 2"}}},"adjStatusFlg2":{"type":"string","maxLength":10,"description":"Adjustment Status shows the status of the transfer to adjustment."},"comments2":{"type":"string","maxLength":100,"description":"Use the Comments to describe anything unusual about the adjustment."},"version":{"type":"number","maximum":0,"minimum":0,"description":"Version2"},"transferFinancialTransactions":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"financialTransaction":{"type":"object","properties":{"financialTransactionId":{"type":"string","maxLength":12,"description":"Financial Transaction ID"}}},"arrearsDate":{"type":"string","format":"date","description":"Arrears Date"},"currentAmount":{"type":"number","description":"Current Amount"},"payoffAmount":{"type":"number","description":"Payoff Amount"},"bill":{"type":"object","properties":{"billId":{"type":"string","maxLength":12,"description":"Bill ID"}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"}}}}}}}}}}},"accountsPayableRequests":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"autopayRequest":{"type":"object","properties":{"autopayRequestId":{"type":"string","maxLength":12,"description":"A/P Request ID"}}},"account":{"type":"object","properties":{"accountId":{"type":"string","maxLength":10,"description":"Account ID"}}},"paymentSelectionStatus":{"type":"string","enum":["C   ","D   ","H   ","N   ","P   ","R   ","V   ","X   "],"description":"Payment Selection Status is the status of the check request.\n* `C   ` - Closed,\n* `D   ` - Negative Voucher Sum,\n* `H   ` - Held,\n* `N   ` - Not Selected for Payment,\n* `P   ` - Paid,\n* `R   ` - Requested for Payment,\n* `V   ` - Convert Error,\n* `X   ` - Canceled","example":"N"},"paymentNumber":{"type":"string","maxLength":36,"description":"Payment Number is the system-assigned number of the payment in A/P (this number typically appears on the printed check). This field is only populated after A/P cuts the check."},"scheduledToPayDate":{"type":"string","format":"date","description":"Scheduled to Pay is the date on which the check is scheduled to be cut. This is equal to the adjustment date plus the Due Days on the adjustment type's A/P request type.","example":"2005-11-23"},"paymentDate":{"type":"string","format":"date","description":"Payment Date is the date on which the check was cut in A/P. This field is only populated after A/P cuts the check.","example":"2005-11-23"},"paidAmount":{"type":"number","description":"Paid Amount is the amount of the check. This field is only populated after A/P cuts the check.","example":"0.00"},"paymentCurrency":{"type":"object","properties":{"paymentCurrency":{"type":"string","maxLength":3,"description":"Currency Code"}}},"country":{"type":"object","properties":{"country":{"type":"string","maxLength":3,"description":"Country"}}},"postal":{"type":"string","maxLength":12,"description":"The postal code of the address.","example":"07960"},"address1":{"type":"string","maxLength":254,"description":"The first line of the address.","example":"1 Speedwell"},"address2":{"type":"string","maxLength":254,"description":"The second line of the address.","example":"Morristown"},"address3":{"type":"string","maxLength":254,"description":"The third line of the address."},"address4":{"type":"string","maxLength":254,"description":"The fourth line of the address."},"city":{"type":"string","maxLength":90,"description":"The city of the address.","example":"San Francisco"},"streetNumber1":{"type":"string","maxLength":6,"description":"The first street number line of the address."},"streetNumber2":{"type":"string","maxLength":4,"description":"The second street number line of the address."},"county":{"type":"string","maxLength":90,"description":"The county of the address.","example":"San Francisco"},"state":{"type":"string","maxLength":6,"description":"The state of the address.","example":"CA"},"taxVendorGeographicalCode":{"type":"string","maxLength":11,"description":"Geographic code used to apply proper taxation rules to the physical address location."},"isInCityLimit":{"type":"boolean","description":"In City Limit switch is on if the address is considered within the physical city limits.","example":"false"},"houseType":{"type":"string","enum":["AB  ","WW  "],"description":"House Type indicates the type of house if applicable for the address.\n* `AB  ` - House Boat References,\n* `WW  ` - House Trailer Reference"}}}}}},"calculationDetails":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"rateSchedule":{"type":"string","maxLength":8,"description":"Rate Schedule"},"effectiveDate":{"type":"string","format":"date","description":"Effective Date"},"_data":{"type":"array","items":{"type":"object","properties":{"sequence":{"type":"number","maximum":99999,"minimum":-99999,"description":"Sequence is the system-assigned unique identifier of the calculation detail row.","example":"1"},"descriptionOnBill":{"type":"string","maxLength":254,"description":"Description on Bill is the information about the calculation line that appears on the customer's bill.","example":"Base Adjustment Amount"},"auditCalculatedAmount":{"type":"number","maximum":10000000000000,"minimum":-10000000000000,"description":"Calculated Amount is the calculated amount associated with the calculation line.","example":"1.23000"},"shouldPrint":{"type":"boolean","description":"The Print switch controls whether information about this line will print on the customer's bill.","example":"true"},"shouldAppearInSummary":{"type":"boolean","description":"The Appears in Summary switch defines if this line's amount also appears on a summary line. This switch plays a part at bill print time - those lines that appear in a summary print in the left dollar column, those that don't appear in a summary print in the right dollar column.","example":"true"},"unitOfMeasure":{"type":"object","properties":{"unitOfMeasure":{"type":"string","maxLength":30,"description":"Unit of Measure"}}},"timeOfUse":{"type":"object","properties":{"timeOfUse":{"type":"string","maxLength":30,"description":"Time of Use"}}},"serviceQuantityIdentifier":{"type":"object","properties":{"serviceQuantityIdentifier":{"type":"string","maxLength":30,"description":"SQI"}}},"billableServiceQuantity":{"type":"number","maximum":1000000000000,"minimum":-1000000000000,"description":"Billable Service Quantity is the service quantity priced on the calculation line. This quantity differs from the measured consumption if there are pre-processing calculation groups in effect.","example":"1.230000"},"baseAmount":{"type":"number","description":"Base Amount"},"currency":{"type":"object","properties":{"currency":{"type":"string","maxLength":3,"description":"Currency Code"}}},"rateCompSequence":{"type":"number","maximum":9999,"minimum":-9999,"description":"Sequence"},"measuresPeakQuantity":{"type":"boolean","description":"Measures Peak Qty is checked if the UOM priced on the calculation line is used to measure a peak quantity.","example":"false"},"exemptAmount":{"type":"number","description":"Exempt Amount is the amount of the calculated charge that the customer doesn't have to pay because they are tax exempt.","example":"0.00"},"distributionCode":{"type":"object","properties":{"distributionCode":{"type":"string","maxLength":10,"description":"Distribution Code"}}},"description":{"type":"string","maxLength":100,"description":"Description describes the characteristic value that was used when the line's amount was calculated. This information is only displayed if the line was calculated using a bill factor (because only bill factors use characteristic values)."},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"},"characteristicType":{"type":"object","properties":{"characteristicType":{"type":"string","maxLength":8,"description":"Characteristic Type"}}},"characteristicValue":{"type":"string","maxLength":16,"description":"Characteristic Value Indicates the value of the characteristic."}}}}}}}}},"characteristics":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"sequence":{"type":"number","maximum":999,"minimum":-999,"description":"Sequence"},"characteristicType":{"type":"object","properties":{"characteristicType":{"type":"string","maxLength":8,"description":"Characteristic Type"}}},"typeOfCharacteristicValue":{"type":"string","maxLength":4,"description":"Characteristic Value indicates the value of the characteristic if the characteristic type is pre-defined or foreign key reference."},"characteristicValue":{"type":"object","properties":{"_link":{"type":"string","description":"(_link)"},"value":{"type":"string","description":"(value)"},"value2":{"type":"string","description":"(value2)"},"value3":{"type":"string","description":"(value3)"},"value4":{"type":"string","description":"(value4)"},"value5":{"type":"string","description":"(value5)"}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks.","example":"2"}}}}}},"nextActions":{"type":"object","properties":{"_link":{"type":"string","description":"(_link)"},"_data":{"type":"array","items":{"type":"object","properties":{"_link":{"type":"string","description":"(_link)"},"actionName":{"type":"string","description":"(actionName)"}}}}}}},"xml":{"name":"C1-Adjust"}},"CRAETEADJUSTMENT_response":{"type":"object","properties":{"_self":{"type":"string","description":"_self"},"adjustmentId":{"type":"string","maxLength":12,"description":"Adjustment ID is the system-assigned, unique identifier of the adjustment."},"account":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"accountId":{"type":"string","maxLength":10,"description":"Account ID is the account to which the adjustment is linked.","example":"1589800000"}}},"serviceAgreement":{"type":"object","description":"Service Agreement ID whose financial balance needs to be adjusted.","properties":{"_link":{"type":"string","description":"_link"},"serviceAgreementId":{"type":"string","maxLength":10,"description":"Service Agreement"}}},"premise":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"premiseId":{"type":"string","maxLength":10,"description":"Premise ID is a system assigned, unique identifier that shows the primary premise associated with the service agreement.","example":"4000000099"}}},"adjustmentType":{"type":"object","description":"Adjustment Type controls numerous aspects of the adjustment's impact on the customer's balance and general ledger.","properties":{"_link":{"type":"string","description":"_link"},"adjustmentType":{"type":"string","maxLength":8,"description":"Adjustment Type controls numerous aspects of the adjustment's impact on the customer's balance and general ledger.","example":"CUSTREL"}}},"adjustmentStatus":{"type":"string","enum":["05  ","10  ","20  ","30  ","50  ","60  "],"description":"Adjustment Status shows the status of the transfer to adjustment. If you need to change the adjustment's status, use the action links\n* `05  ` - New,\n* `10  ` - Incomplete,\n* `20  ` - Error,\n* `30  ` - Freezable,\n* `50  ` - Frozen,\n* `60  ` - Canceled","example":"30"},"creationDate":{"type":"string","format":"date","description":"The Creation Date defines the date on which the adjustment was created."},"comments":{"type":"string","maxLength":254,"description":"Use the Comments to describe anything unusual about the adjustment."},"baseAmount":{"type":"number","description":"Current Amount"},"amount":{"type":"number","description":"Current Amount"},"calculatedAmount":{"type":"number","description":"Calculated Amount is the calculated amount associated with the calculation line."},"onBehalfSAId":{"type":"string","maxLength":10,"description":"On Behalf SA ID is only populated on system-generated adjustments instigated by one customer, but attributed to another customer."},"cancelReason":{"type":"object","description":"If the status is canceled, the Cancel Reason is displayed.","properties":{"_link":{"type":"string","description":"_link"},"cancelReason":{"type":"string","maxLength":4,"description":"If the status is canceled, the Cancel Reason is displayed."}}},"currency":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"currency":{"type":"string","maxLength":3,"description":"Currency Code"}}},"accountingDate":{"type":"string","format":"date","description":"Accounting Date"},"calculationDate":{"type":"string","format":"date","description":"Calculation date is used for a calculated adjustment type by the generate adjustment algorithm for any calculations that are effective dated (e.g., rate version calculation group or bill factor value).","example":"2005-11-23"},"approvalRequest":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"approvalRequestId":{"type":"string","maxLength":12,"description":"Approval Request shows that the adjustment is subject to approval. Adjustments are required to be approved by one or more managers before they impact a customer's debt and the general ledger."}}},"generate":{"type":"boolean","description":"(canGenerate)"},"submitForApproval":{"type":"boolean","description":"(isSubmit)"},"cancel":{"type":"boolean","description":"(isCancel)"},"freeze":{"type":"boolean","description":"(isFrozen)"},"delete":{"type":"boolean","description":"(canDelete)"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"},"financialTransactions":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"financialTransaction":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"financialTransactionId":{"type":"string","maxLength":12,"description":"Financial Transaction ID"}}},"arrearsDate":{"type":"string","format":"date","description":"Arrears Date"},"accountingDate":{"type":"string","format":"date","description":"Accounting Date"},"currentAmount":{"type":"number","description":"Current Amount"},"payoffAmount":{"type":"number","description":"Payoff Amount"},"billId":{"type":"string","maxLength":12,"description":"Bill ID"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"}}}}}},"transferAdjustments":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"transferAccount":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"transferAccountId":{"type":"string","maxLength":30,"description":"Account ID 2"}}},"transferServiceAgreement":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"transferServiceAgreementId":{"type":"string","maxLength":30,"description":"Service Agreement ID 2"}}},"transferPremise":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"transferPremiseId":{"type":"string","maxLength":10,"description":"Transfer Premise ID"}}},"transferAdjustmentId":{"type":"string","maxLength":12,"description":"Transfer Adjustment ID is the system-assigned, unique identifier of the adjustment."},"transferAdjustmentType":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"transferAdjustmentType":{"type":"string","maxLength":8,"description":"Transfer Adjustment Type"}}},"creDt2":{"type":"string","format":"date","description":"Creation Date defines the date on which the adjustment was created."},"adjAmt2":{"type":"number","description":"Transfer Adjustment Amount","example":"0.00"},"transferCurrency":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"transferCurrency":{"type":"string","maxLength":30,"description":"Currency Code 2"}}},"adjStatusFlg2":{"type":"string","maxLength":10,"description":"Adjustment Status shows the status of the transfer to adjustment."},"comments2":{"type":"string","maxLength":100,"description":"Use the Comments to describe anything unusual about the adjustment."},"version":{"type":"number","maximum":0,"minimum":0,"description":"Version2"},"transferFinancialTransactions":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"financialTransaction":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"financialTransactionId":{"type":"string","maxLength":12,"description":"Financial Transaction ID"}}},"arrearsDate":{"type":"string","format":"date","description":"Arrears Date"},"currentAmount":{"type":"number","description":"Current Amount"},"payoffAmount":{"type":"number","description":"Payoff Amount"},"bill":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"billId":{"type":"string","maxLength":12,"description":"Bill ID"}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"}}}}}}}}}}},"accountsPayableRequests":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"autopayRequest":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"autopayRequestId":{"type":"string","maxLength":12,"description":"A/P Request ID"}}},"account":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"accountId":{"type":"string","maxLength":10,"description":"Account ID"}}},"paymentSelectionStatus":{"type":"string","enum":["C   ","D   ","H   ","N   ","P   ","R   ","V   ","X   "],"description":"Payment Selection Status is the status of the check request.\n* `C   ` - Closed,\n* `D   ` - Negative Voucher Sum,\n* `H   ` - Held,\n* `N   ` - Not Selected for Payment,\n* `P   ` - Paid,\n* `R   ` - Requested for Payment,\n* `V   ` - Convert Error,\n* `X   ` - Canceled","example":"N"},"paymentNumber":{"type":"string","maxLength":36,"description":"Payment Number is the system-assigned number of the payment in A/P (this number typically appears on the printed check). This field is only populated after A/P cuts the check."},"scheduledToPayDate":{"type":"string","format":"date","description":"Scheduled to Pay is the date on which the check is scheduled to be cut. This is equal to the adjustment date plus the Due Days on the adjustment type's A/P request type.","example":"2005-11-23"},"paymentDate":{"type":"string","format":"date","description":"Payment Date is the date on which the check was cut in A/P. This field is only populated after A/P cuts the check.","example":"2005-11-23"},"paidAmount":{"type":"number","description":"Paid Amount is the amount of the check. This field is only populated after A/P cuts the check.","example":"0.00"},"paymentCurrency":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"paymentCurrency":{"type":"string","maxLength":3,"description":"Currency Code"}}},"country":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"country":{"type":"string","maxLength":3,"description":"Country"}}},"postal":{"type":"string","maxLength":12,"description":"The postal code of the address.","example":"07960"},"address1":{"type":"string","maxLength":254,"description":"The first line of the address.","example":"1 Speedwell"},"address2":{"type":"string","maxLength":254,"description":"The second line of the address.","example":"Morristown"},"address3":{"type":"string","maxLength":254,"description":"The third line of the address."},"address4":{"type":"string","maxLength":254,"description":"The fourth line of the address."},"city":{"type":"string","maxLength":90,"description":"The city of the address.","example":"San Francisco"},"streetNumber1":{"type":"string","maxLength":6,"description":"The first street number line of the address."},"streetNumber2":{"type":"string","maxLength":4,"description":"The second street number line of the address."},"county":{"type":"string","maxLength":90,"description":"The county of the address.","example":"San Francisco"},"state":{"type":"string","maxLength":6,"description":"The state of the address.","example":"CA"},"taxVendorGeographicalCode":{"type":"string","maxLength":11,"description":"Geographic code used to apply proper taxation rules to the physical address location."},"isInCityLimit":{"type":"boolean","description":"In City Limit switch is on if the address is considered within the physical city limits.","example":"false"},"houseType":{"type":"string","enum":["AB  ","WW  "],"description":"House Type indicates the type of house if applicable for the address.\n* `AB  ` - House Boat References,\n* `WW  ` - House Trailer Reference"}}}}}},"calculationDetails":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"rateSchedule":{"type":"string","maxLength":8,"description":"Rate Schedule"},"effectiveDate":{"type":"string","format":"date","description":"Effective Date"},"_data":{"type":"array","items":{"type":"object","properties":{"sequence":{"type":"number","maximum":99999,"minimum":-99999,"description":"Sequence is the system-assigned unique identifier of the calculation detail row.","example":"1"},"descriptionOnBill":{"type":"string","maxLength":254,"description":"Description on Bill is the information about the calculation line that appears on the customer's bill.","example":"Base Adjustment Amount"},"auditCalculatedAmount":{"type":"number","maximum":10000000000000,"minimum":-10000000000000,"description":"Calculated Amount is the calculated amount associated with the calculation line.","example":"1.23000"},"shouldPrint":{"type":"boolean","description":"The Print switch controls whether information about this line will print on the customer's bill.","example":"true"},"shouldAppearInSummary":{"type":"boolean","description":"The Appears in Summary switch defines if this line's amount also appears on a summary line. This switch plays a part at bill print time - those lines that appear in a summary print in the left dollar column, those that don't appear in a summary print in the right dollar column.","example":"true"},"unitOfMeasure":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"unitOfMeasure":{"type":"string","maxLength":30,"description":"Unit of Measure"}}},"timeOfUse":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"timeOfUse":{"type":"string","maxLength":30,"description":"Time of Use"}}},"serviceQuantityIdentifier":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"serviceQuantityIdentifier":{"type":"string","maxLength":30,"description":"SQI"}}},"billableServiceQuantity":{"type":"number","maximum":1000000000000,"minimum":-1000000000000,"description":"Billable Service Quantity is the service quantity priced on the calculation line. This quantity differs from the measured consumption if there are pre-processing calculation groups in effect.","example":"1.230000"},"baseAmount":{"type":"number","description":"Base Amount"},"currency":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"currency":{"type":"string","maxLength":3,"description":"Currency Code"}}},"rateCompSequence":{"type":"number","maximum":9999,"minimum":-9999,"description":"Sequence"},"measuresPeakQuantity":{"type":"boolean","description":"Measures Peak Qty is checked if the UOM priced on the calculation line is used to measure a peak quantity.","example":"false"},"exemptAmount":{"type":"number","description":"Exempt Amount is the amount of the calculated charge that the customer doesn't have to pay because they are tax exempt.","example":"0.00"},"distributionCode":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"distributionCode":{"type":"string","maxLength":10,"description":"Distribution Code"}}},"description":{"type":"string","maxLength":100,"description":"Description describes the characteristic value that was used when the line's amount was calculated. This information is only displayed if the line was calculated using a bill factor (because only bill factors use characteristic values)."},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"},"characteristicType":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"characteristicType":{"type":"string","maxLength":8,"description":"Characteristic Type"}}},"characteristicValue":{"type":"string","maxLength":16,"description":"Characteristic Value Indicates the value of the characteristic."}}}}}}}}},"characteristics":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"sequence":{"type":"number","maximum":999,"minimum":-999,"description":"Sequence"},"characteristicType":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"characteristicType":{"type":"string","maxLength":8,"description":"Characteristic Type"}}},"typeOfCharacteristicValue":{"type":"string","maxLength":4,"description":"Characteristic Value indicates the value of the characteristic if the characteristic type is pre-defined or foreign key reference."},"characteristicValue":{"type":"object","properties":{"_link":{"type":"string","description":"(_link)"},"value":{"type":"string","description":"(value)"},"value2":{"type":"string","description":"(value2)"},"value3":{"type":"string","description":"(value3)"},"value4":{"type":"string","description":"(value4)"},"value5":{"type":"string","description":"(value5)"}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks.","example":"2"}}}}}},"nextActions":{"type":"object","properties":{"_link":{"type":"string","description":"(_link)"},"_data":{"type":"array","items":{"type":"object","properties":{"_link":{"type":"string","description":"(_link)"},"actionName":{"type":"string","description":"(actionName)"}}}}}}},"xml":{"name":"C1-Adjust"}},"DELETEADJUSTMENT_request":{"type":"object","properties":{"adjustmentId":{"type":"string","maxLength":12,"description":"Adjustment ID is the system-assigned, unique identifier of the adjustment."}},"xml":{"name":"C1-DelAdjust"}},"ACTIONADJUSTMENT_request":{"type":"object","properties":{"name":{"type":"string","description":"(name)"},"adjustmentId":{"type":"string","maxLength":12,"description":"Adjustment ID is the system-assigned, unique identifier of the adjustment."},"_self":{"type":"string","description":"(_self)"},"onBehalfSAId":{"type":"string","maxLength":10,"description":"On Behalf SA ID is only populated on system-generated adjustments instigated by one customer, but attributed to another customer."},"cancelReason":{"type":"object","properties":{"cancelReason":{"type":"string","maxLength":4,"description":"If the status is canceled, the Cancel Reason is displayed."},"_link":{"type":"string","description":"(_link)"}}},"nextActions":{"type":"object","properties":{"_link":{"type":"string","description":"(_link)"},"_data":{"type":"array","items":{"type":"object","properties":{"actionName":{"type":"string","description":"(actionName)"},"_link":{"type":"string","description":"(_link)"}}}}}}},"xml":{"name":"C1-ActAdjust"}},"UPDATEADJUSTMENT_response":{"type":"object","properties":{"_self":{"type":"string","description":"_self"},"adjustmentId":{"type":"string","maxLength":12,"description":"Adjustment ID is the system-assigned, unique identifier of the adjustment."},"account":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"accountId":{"type":"string","maxLength":10,"description":"Account ID is the account to which the adjustment is linked.","example":"1589800000"}}},"serviceAgreement":{"type":"object","description":"Service Agreement ID whose financial balance needs to be adjusted.","properties":{"_link":{"type":"string","description":"_link"},"serviceAgreementId":{"type":"string","maxLength":10,"description":"Service Agreement"}}},"premise":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"premiseId":{"type":"string","maxLength":10,"description":"Premise ID is a system assigned, unique identifier that shows the primary premise associated with the service agreement.","example":"4000000099"}}},"adjustmentType":{"type":"object","description":"Adjustment Type controls numerous aspects of the adjustment's impact on the customer's balance and general ledger.","properties":{"_link":{"type":"string","description":"_link"},"adjustmentType":{"type":"string","maxLength":8,"description":"Adjustment Type controls numerous aspects of the adjustment's impact on the customer's balance and general ledger.","example":"CUSTREL"}}},"adjustmentStatus":{"type":"string","enum":["05  ","10  ","20  ","30  ","50  ","60  "],"description":"Adjustment Status shows the status of the transfer to adjustment. If you need to change the adjustment's status, use the action links\n* `05  ` - New,\n* `10  ` - Incomplete,\n* `20  ` - Error,\n* `30  ` - Freezable,\n* `50  ` - Frozen,\n* `60  ` - Canceled","example":"30"},"creationDate":{"type":"string","format":"date","description":"The Creation Date defines the date on which the adjustment was created."},"comments":{"type":"string","maxLength":254,"description":"Use the Comments to describe anything unusual about the adjustment."},"baseAmount":{"type":"number","description":"Current Amount"},"amount":{"type":"number","description":"Current Amount"},"calculatedAmount":{"type":"number","description":"Calculated Amount is the calculated amount associated with the calculation line."},"onBehalfSAId":{"type":"string","maxLength":10,"description":"On Behalf SA ID is only populated on system-generated adjustments instigated by one customer, but attributed to another customer."},"cancelReason":{"type":"object","description":"If the status is canceled, the Cancel Reason is displayed.","properties":{"_link":{"type":"string","description":"_link"},"cancelReason":{"type":"string","maxLength":4,"description":"If the status is canceled, the Cancel Reason is displayed."}}},"currency":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"currency":{"type":"string","maxLength":3,"description":"Currency Code"}}},"accountingDate":{"type":"string","format":"date","description":"Accounting Date"},"calculationDate":{"type":"string","format":"date","description":"Calculation date is used for a calculated adjustment type by the generate adjustment algorithm for any calculations that are effective dated (e.g., rate version calculation group or bill factor value).","example":"2005-11-23"},"approvalRequest":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"approvalRequestId":{"type":"string","maxLength":12,"description":"Approval Request shows that the adjustment is subject to approval. Adjustments are required to be approved by one or more managers before they impact a customer's debt and the general ledger."}}},"generate":{"type":"boolean","description":"(canGenerate)"},"submitForApproval":{"type":"boolean","description":"(isSubmit)"},"cancel":{"type":"boolean","description":"(isCancel)"},"freeze":{"type":"boolean","description":"(isFrozen)"},"delete":{"type":"boolean","description":"(canDelete)"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"},"financialTransactions":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"financialTransaction":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"financialTransactionId":{"type":"string","maxLength":12,"description":"Financial Transaction ID"}}},"arrearsDate":{"type":"string","format":"date","description":"Arrears Date"},"accountingDate":{"type":"string","format":"date","description":"Accounting Date"},"currentAmount":{"type":"number","description":"Current Amount"},"payoffAmount":{"type":"number","description":"Payoff Amount"},"billId":{"type":"string","maxLength":12,"description":"Bill ID"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"}}}}}},"transferAdjustments":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"transferAccount":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"transferAccountId":{"type":"string","maxLength":30,"description":"Account ID 2"}}},"transferServiceAgreement":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"transferServiceAgreementId":{"type":"string","maxLength":30,"description":"Service Agreement ID 2"}}},"transferPremise":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"transferPremiseId":{"type":"string","maxLength":10,"description":"Transfer Premise ID"}}},"transferAdjustmentId":{"type":"string","maxLength":12,"description":"Transfer Adjustment ID is the system-assigned, unique identifier of the adjustment."},"transferAdjustmentType":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"transferAdjustmentType":{"type":"string","maxLength":8,"description":"Transfer Adjustment Type"}}},"creDt2":{"type":"string","format":"date","description":"Creation Date defines the date on which the adjustment was created."},"adjAmt2":{"type":"number","description":"Transfer Adjustment Amount","example":"0.00"},"transferCurrency":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"transferCurrency":{"type":"string","maxLength":30,"description":"Currency Code 2"}}},"adjStatusFlg2":{"type":"string","maxLength":10,"description":"Adjustment Status shows the status of the transfer to adjustment."},"comments2":{"type":"string","maxLength":100,"description":"Use the Comments to describe anything unusual about the adjustment."},"version":{"type":"number","maximum":0,"minimum":0,"description":"Version2"},"transferFinancialTransactions":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"financialTransaction":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"financialTransactionId":{"type":"string","maxLength":12,"description":"Financial Transaction ID"}}},"arrearsDate":{"type":"string","format":"date","description":"Arrears Date"},"currentAmount":{"type":"number","description":"Current Amount"},"payoffAmount":{"type":"number","description":"Payoff Amount"},"bill":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"billId":{"type":"string","maxLength":12,"description":"Bill ID"}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"}}}}}}}}}}},"accountsPayableRequests":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"autopayRequest":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"autopayRequestId":{"type":"string","maxLength":12,"description":"A/P Request ID"}}},"account":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"accountId":{"type":"string","maxLength":10,"description":"Account ID"}}},"paymentSelectionStatus":{"type":"string","enum":["C   ","D   ","H   ","N   ","P   ","R   ","V   ","X   "],"description":"Payment Selection Status is the status of the check request.\n* `C   ` - Closed,\n* `D   ` - Negative Voucher Sum,\n* `H   ` - Held,\n* `N   ` - Not Selected for Payment,\n* `P   ` - Paid,\n* `R   ` - Requested for Payment,\n* `V   ` - Convert Error,\n* `X   ` - Canceled","example":"N"},"paymentNumber":{"type":"string","maxLength":36,"description":"Payment Number is the system-assigned number of the payment in A/P (this number typically appears on the printed check). This field is only populated after A/P cuts the check."},"scheduledToPayDate":{"type":"string","format":"date","description":"Scheduled to Pay is the date on which the check is scheduled to be cut. This is equal to the adjustment date plus the Due Days on the adjustment type's A/P request type.","example":"2005-11-23"},"paymentDate":{"type":"string","format":"date","description":"Payment Date is the date on which the check was cut in A/P. This field is only populated after A/P cuts the check.","example":"2005-11-23"},"paidAmount":{"type":"number","description":"Paid Amount is the amount of the check. This field is only populated after A/P cuts the check.","example":"0.00"},"paymentCurrency":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"paymentCurrency":{"type":"string","maxLength":3,"description":"Currency Code"}}},"country":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"country":{"type":"string","maxLength":3,"description":"Country"}}},"postal":{"type":"string","maxLength":12,"description":"The postal code of the address.","example":"07960"},"address1":{"type":"string","maxLength":254,"description":"The first line of the address.","example":"1 Speedwell"},"address2":{"type":"string","maxLength":254,"description":"The second line of the address.","example":"Morristown"},"address3":{"type":"string","maxLength":254,"description":"The third line of the address."},"address4":{"type":"string","maxLength":254,"description":"The fourth line of the address."},"city":{"type":"string","maxLength":90,"description":"The city of the address.","example":"San Francisco"},"streetNumber1":{"type":"string","maxLength":6,"description":"The first street number line of the address."},"streetNumber2":{"type":"string","maxLength":4,"description":"The second street number line of the address."},"county":{"type":"string","maxLength":90,"description":"The county of the address.","example":"San Francisco"},"state":{"type":"string","maxLength":6,"description":"The state of the address.","example":"CA"},"taxVendorGeographicalCode":{"type":"string","maxLength":11,"description":"Geographic code used to apply proper taxation rules to the physical address location."},"isInCityLimit":{"type":"boolean","description":"In City Limit switch is on if the address is considered within the physical city limits.","example":"false"},"houseType":{"type":"string","enum":["AB  ","WW  "],"description":"House Type indicates the type of house if applicable for the address.\n* `AB  ` - House Boat References,\n* `WW  ` - House Trailer Reference"}}}}}},"calculationDetails":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"rateSchedule":{"type":"string","maxLength":8,"description":"Rate Schedule"},"effectiveDate":{"type":"string","format":"date","description":"Effective Date"},"_data":{"type":"array","items":{"type":"object","properties":{"sequence":{"type":"number","maximum":99999,"minimum":-99999,"description":"Sequence is the system-assigned unique identifier of the calculation detail row.","example":"1"},"descriptionOnBill":{"type":"string","maxLength":254,"description":"Description on Bill is the information about the calculation line that appears on the customer's bill.","example":"Base Adjustment Amount"},"auditCalculatedAmount":{"type":"number","maximum":10000000000000,"minimum":-10000000000000,"description":"Calculated Amount is the calculated amount associated with the calculation line.","example":"1.23000"},"shouldPrint":{"type":"boolean","description":"The Print switch controls whether information about this line will print on the customer's bill.","example":"true"},"shouldAppearInSummary":{"type":"boolean","description":"The Appears in Summary switch defines if this line's amount also appears on a summary line. This switch plays a part at bill print time - those lines that appear in a summary print in the left dollar column, those that don't appear in a summary print in the right dollar column.","example":"true"},"unitOfMeasure":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"unitOfMeasure":{"type":"string","maxLength":30,"description":"Unit of Measure"}}},"timeOfUse":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"timeOfUse":{"type":"string","maxLength":30,"description":"Time of Use"}}},"serviceQuantityIdentifier":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"serviceQuantityIdentifier":{"type":"string","maxLength":30,"description":"SQI"}}},"billableServiceQuantity":{"type":"number","maximum":1000000000000,"minimum":-1000000000000,"description":"Billable Service Quantity is the service quantity priced on the calculation line. This quantity differs from the measured consumption if there are pre-processing calculation groups in effect.","example":"1.230000"},"baseAmount":{"type":"number","description":"Base Amount"},"currency":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"currency":{"type":"string","maxLength":3,"description":"Currency Code"}}},"rateCompSequence":{"type":"number","maximum":9999,"minimum":-9999,"description":"Sequence"},"measuresPeakQuantity":{"type":"boolean","description":"Measures Peak Qty is checked if the UOM priced on the calculation line is used to measure a peak quantity.","example":"false"},"exemptAmount":{"type":"number","description":"Exempt Amount is the amount of the calculated charge that the customer doesn't have to pay because they are tax exempt.","example":"0.00"},"distributionCode":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"distributionCode":{"type":"string","maxLength":10,"description":"Distribution Code"}}},"description":{"type":"string","maxLength":100,"description":"Description describes the characteristic value that was used when the line's amount was calculated. This information is only displayed if the line was calculated using a bill factor (because only bill factors use characteristic values)."},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"},"characteristicType":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"characteristicType":{"type":"string","maxLength":8,"description":"Characteristic Type"}}},"characteristicValue":{"type":"string","maxLength":16,"description":"Characteristic Value Indicates the value of the characteristic."}}}}}}}}},"characteristics":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"sequence":{"type":"number","maximum":999,"minimum":-999,"description":"Sequence"},"characteristicType":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"characteristicType":{"type":"string","maxLength":8,"description":"Characteristic Type"}}},"typeOfCharacteristicValue":{"type":"string","maxLength":4,"description":"Characteristic Value indicates the value of the characteristic if the characteristic type is pre-defined or foreign key reference."},"characteristicValue":{"type":"object","properties":{"_link":{"type":"string","description":"(_link)"},"value":{"type":"string","description":"(value)"},"value2":{"type":"string","description":"(value2)"},"value3":{"type":"string","description":"(value3)"},"value4":{"type":"string","description":"(value4)"},"value5":{"type":"string","description":"(value5)"}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks.","example":"2"}}}}}},"nextActions":{"type":"object","properties":{"_link":{"type":"string","description":"(_link)"},"_data":{"type":"array","items":{"type":"object","properties":{"_link":{"type":"string","description":"(_link)"},"actionName":{"type":"string","description":"(actionName)"}}}}}}},"xml":{"name":"C1-Adjust"}},"ACTIONADJUSTMENT_response":{"type":"object","properties":{"name":{"type":"string","description":"(name)"},"adjustmentId":{"type":"string","maxLength":12,"description":"Adjustment ID is the system-assigned, unique identifier of the adjustment."},"_self":{"type":"string","description":"(_self)"},"onBehalfSAId":{"type":"string","maxLength":10,"description":"On Behalf SA ID is only populated on system-generated adjustments instigated by one customer, but attributed to another customer."},"cancelReason":{"type":"object","properties":{"cancelReason":{"type":"string","maxLength":4,"description":"If the status is canceled, the Cancel Reason is displayed."},"_link":{"type":"string","description":"(_link)"}}},"nextActions":{"type":"object","properties":{"_link":{"type":"string","description":"(_link)"},"_data":{"type":"array","items":{"type":"object","properties":{"actionName":{"type":"string","description":"(actionName)"},"_link":{"type":"string","description":"(_link)"}}}}}}},"xml":{"name":"C1-ActAdjust"}},"GETBUDGET_response":{"type":"object","properties":{"_self":{"type":"string","description":"_self"},"accountId":{"type":"string","maxLength":10,"description":"Account ID identifies the account of the customer for which the budget exists.","example":"1112345900"},"name":{"type":"string","description":"(name)"},"budgetPlan":{"type":"object","description":"Budget Plan controls how the account's debt is managed for budget-related purposes. Specifically, it controls how the recommended budget amount is calculated and how / when the customer's budget is periodically changed.","properties":{"_link":{"type":"string","description":"_link"},"budgetPlan":{"type":"string","maxLength":8,"description":"Budget Plan"}}},"budgetDate":{"type":"string","format":"date","description":"Use New Budget Date to define the effective date of any changes to the customer's budget amount (this date is the effective date on the respective service agreements' recurring charge history).","example":"2021-12-14"},"serviceAgreementsList":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"serviceAgreement":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"serviceAgreementId":{"type":"string","maxLength":10,"description":"Service Agreement"}}},"lastChangedDate":{"type":"string","format":"date","description":"Last Changed Date is the date when the service agreement's budget amount (i.e., recurring charge amount) was last changed.","example":"2021-12-15"},"budgetAmount":{"type":"number","description":"Budget Amount This is the existing budget amount (i.e., recurring charge amount) for the service agreement.","example":"232.00"},"newBudgetAmount":{"type":"number","description":"(newBudget)"}}}}}},"totalBudgetAmount":{"type":"number","description":"Total Budget Amount displays the sum of the service agreements' current budget amounts.","example":"252$"},"totalNewBudgetAmount":{"type":"number","description":"(totalNewBudget)"}},"xml":{"name":"C1BudgetDeta"}},"ACTIONBUDGET_response":{"type":"object","properties":{"_self":{"type":"string","description":"_self"},"accountId":{"type":"string","maxLength":10,"description":"Account ID identifies the account of the customer for which the budget exists.","example":"1112345900"},"name":{"type":"string","description":"(name)"},"budgetPlan":{"type":"object","description":"Budget Plan controls how the account's debt is managed for budget-related purposes. Specifically, it controls how the recommended budget amount is calculated and how / when the customer's budget is periodically changed.","properties":{"_link":{"type":"string","description":"_link"},"budgetPlan":{"type":"string","maxLength":8,"description":"Budget Plan"}}},"newBudgetDate":{"type":"string","format":"date","description":"Use New Budget Date to define the effective date of any changes to the customer's budget amount (this date is the effective date on the respective service agreements' recurring charge history).","example":"2021-12-14"},"serviceAgreementsList":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"serviceAgreement":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"serviceAgreementId":{"type":"string","maxLength":10,"description":"Service Agreement"}}},"lastChangedDate":{"type":"string","format":"date","description":"Last Changed Date is the date when the service agreement's budget amount (i.e., recurring charge amount) was last changed.","example":"2021-12-15"},"budgetAmount":{"type":"number","description":"Budget Amount This is the existing budget amount (i.e., recurring charge amount) for the service agreement.","example":"232.00"},"newBudgetAmount":{"type":"number","description":"(newBudget)"}}}}}},"totalBudgetAmount":{"type":"number","description":"Total Budget Amount displays the sum of the service agreements' current budget amounts.","example":"252$"},"totalNewBudgetAmount":{"type":"number","description":"(totalNewBudget)"}},"xml":{"name":"C1BudgetDeta"}},"ACTIONBUDGET_request":{"type":"object","properties":{"accountId":{"type":"string","maxLength":10,"description":"Account ID identifies the account of the customer for which the budget exists.","example":"1112345900"},"name":{"type":"string","description":"(name)"},"budgetPlan":{"type":"object","description":"Budget Plan controls how the account's debt is managed for budget-related purposes. Specifically, it controls how the recommended budget amount is calculated and how / when the customer's budget is periodically changed.","properties":{"budgetPlan":{"type":"string","maxLength":8,"description":"Budget Plan"}}},"newBudgetDate":{"type":"string","format":"date","description":"Use New Budget Date to define the effective date of any changes to the customer's budget amount (this date is the effective date on the respective service agreements' recurring charge history).","example":"2021-12-14"},"serviceAgreementsList":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"serviceAgreement":{"type":"object","properties":{"serviceAgreementId":{"type":"string","maxLength":10,"description":"Service Agreement"}}},"lastChangedDate":{"type":"string","format":"date","description":"Last Changed Date is the date when the service agreement's budget amount (i.e., recurring charge amount) was last changed.","example":"2021-12-15"},"budgetAmount":{"type":"number","description":"Budget Amount This is the existing budget amount (i.e., recurring charge amount) for the service agreement.","example":"232.00"},"newBudgetAmount":{"type":"number","description":"(newBudget)"}}}}}},"totalBudgetAmount":{"type":"number","description":"Total Budget Amount displays the sum of the service agreements' current budget amounts.","example":"252$"},"totalNewBudgetAmount":{"type":"number","description":"(totalNewBudget)"}},"xml":{"name":"C1BudgetDeta"}},"UPDATECASE_response":{"type":"object","properties":{"_self":{"type":"string","description":"_self"},"caseId":{"type":"string","maxLength":10,"description":"Case ID is the system-assigned unique identifier of the case.","example":"1118286467"},"caseType":{"type":"object","description":"Case Type defines the type of case.","properties":{"_link":{"type":"string","description":"_link"},"caseType":{"type":"string","maxLength":12,"description":"Case Type defines the type of case.","example":"BANKRUPT"}}},"status":{"type":"string","maxLength":12,"description":"Status shows the current state of the case.","example":"NEW"},"comments":{"type":"string","maxLength":2000,"description":"Comments can be used to describe anything interesting or unusual about the case.","example":"new Test"},"person":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"personId":{"type":"string","maxLength":10,"description":"Person ID references the person associated with this case.","example":"0003339882"}}},"account":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"accountId":{"type":"string","maxLength":10,"description":"Account ID references the account associated with this case.","example":"0777774590"}}},"premise":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"premiseId":{"type":"string","maxLength":10,"description":"Premise ID references the premise associated with this case.","example":"0005606666"}}},"responsibleUser":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"userId":{"type":"string","maxLength":8,"description":"User"}}},"caseCondition":{"type":"string","enum":["CLSD","OPEN"],"description":"Case Condition\n* `CLSD` - Closed,\n* `OPEN` - Open","example":"OPEN"},"contactInformation":{"type":"object","properties":{"contactPerson":{"type":"object","description":"Contact Person references the person who should be contacted.","properties":{"_link":{"type":"string","description":"_link"},"contactPersonId":{"type":"string","maxLength":10,"description":"Contact Person"}}},"preferredContactMethod":{"type":"string","enum":["C1PC","EM  ","FAX ","N/A ","PH  ","POST","SMS "],"description":"Preferred Contact Method indicates how the person prefers to be contacted.\n* `C1PC` - Person Contact,\n* `EM  ` - Email,\n* `FAX ` - Fax,\n* `N/A ` - Not Applicable,\n* `PH  ` - Phone,\n* `POST` - Postal,\n* `SMS ` - SMS","example":"FAX"},"contactInstructions":{"type":"string","maxLength":2000,"description":"Contact Instructions indicates any special instructions indicated for when or how to return a call.","example":"Only in Day"},"callBackPhoneType":{"type":"string","maxLength":12,"description":"Callback Phone Type indicate the actual phone type","example":"CAMP"},"callBackPhoneNumber":{"type":"string","maxLength":24,"description":"Callback Phone Number indicate the actual phone number","example":"(999) 432-2135"},"extension":{"type":"string","maxLength":6,"description":"1234"}}},"isEligibleForArchiving":{"type":"boolean","description":"ILM Archive Switch"},"contactDetail":{"type":"string","maxLength":10,"description":"System-assigned, unique identifier of the person contact record."},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks."},"characteristics":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"sequence":{"type":"number","maximum":999,"minimum":-999,"description":"Sequence Number","example":"10"},"characteristicType":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"characteristicType":{"type":"string","maxLength":8,"description":"Characteristic Type"}}},"typeOfCharacteristicValue":{"type":"string","maxLength":4,"description":"Type of Characteristic Value indicates whether the characteristic type value is Adhoc, Predefined, Foreign Key, or a File/URL Location.","example":"FKV"},"characteristicValue":{"type":"object","properties":{"_link":{"type":"string","description":"(_link)"},"value":{"type":"string","description":"(value)"},"value2":{"type":"string","description":"(value2)"},"value3":{"type":"string","description":"(value3)"},"value4":{"type":"string","description":"(value4)"},"value5":{"type":"string","description":"(value5)"}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks."}}}}}}},"xml":{"name":"C1-Case"}},"DELETECASE_response":{"type":"object","properties":{"caseId":{"type":"string","maxLength":10,"description":"Case ID is the system-assigned unique identifier of the case.","example":"1118286467"}},"xml":{"name":"C1-DelCase"}},"ACTIONCASE_response":{"type":"object","properties":{"caseId":{"type":"string","maxLength":10,"description":"Case ID is the system-assigned unique identifier of the case.","example":"1118286467"},"_self":{"type":"string","description":"(_self)"},"name":{"type":"string","description":"(name)"},"nextActions":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"actionName":{"type":"string","description":"(actionName)"},"_link":{"type":"string","description":"(_link)"}}}}}}},"xml":{"name":"C1-ActinCase"}},"UPDATECASE_request":{"type":"object","properties":{"caseId":{"type":"string","maxLength":10,"description":"Case ID is the system-assigned unique identifier of the case.","example":"1118286467"},"caseType":{"type":"object","description":"Case Type defines the type of case.","properties":{"caseType":{"type":"string","maxLength":12,"description":"Case Type defines the type of case.","example":"BANKRUPT"}}},"status":{"type":"string","maxLength":12,"description":"Status shows the current state of the case.","example":"NEW"},"comments":{"type":"string","maxLength":2000,"description":"Comments can be used to describe anything interesting or unusual about the case.","example":"new Test"},"person":{"type":"object","properties":{"personId":{"type":"string","maxLength":10,"description":"Person ID references the person associated with this case.","example":"0003339882"}}},"account":{"type":"object","properties":{"accountId":{"type":"string","maxLength":10,"description":"Account ID references the account associated with this case.","example":"0777774590"}}},"premise":{"type":"object","properties":{"premiseId":{"type":"string","maxLength":10,"description":"Premise ID references the premise associated with this case.","example":"0005606666"}}},"responsibleUser":{"type":"object","properties":{"userId":{"type":"string","maxLength":8,"description":"User"}}},"caseCondition":{"type":"string","enum":["CLSD","OPEN"],"description":"Case Condition\n* `CLSD` - Closed,\n* `OPEN` - Open","example":"OPEN"},"contactInformation":{"type":"object","properties":{"contactPerson":{"type":"object","description":"Contact Person references the person who should be contacted.","properties":{"contactPersonId":{"type":"string","maxLength":10,"description":"Contact Person"}}},"preferredContactMethod":{"type":"string","enum":["C1PC","EM  ","FAX ","N/A ","PH  ","POST","SMS "],"description":"Preferred Contact Method indicates how the person prefers to be contacted.\n* `C1PC` - Person Contact,\n* `EM  ` - Email,\n* `FAX ` - Fax,\n* `N/A ` - Not Applicable,\n* `PH  ` - Phone,\n* `POST` - Postal,\n* `SMS ` - SMS","example":"FAX"},"contactInstructions":{"type":"string","maxLength":2000,"description":"Contact Instructions indicates any special instructions indicated for when or how to return a call.","example":"Only in Day"},"callBackPhoneType":{"type":"string","maxLength":12,"description":"Callback Phone Type indicate the actual phone type","example":"CAMP"},"callBackPhoneNumber":{"type":"string","maxLength":24,"description":"Callback Phone Number indicate the actual phone number","example":"(999) 432-2135"},"extension":{"type":"string","maxLength":6,"description":"1234"}}},"isEligibleForArchiving":{"type":"boolean","description":"ILM Archive Switch"},"contactDetail":{"type":"string","maxLength":10,"description":"System-assigned, unique identifier of the person contact record."},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks."},"characteristics":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"sequence":{"type":"number","maximum":999,"minimum":-999,"description":"Sequence Number","example":"10"},"characteristicType":{"type":"object","properties":{"characteristicType":{"type":"string","maxLength":8,"description":"Characteristic Type"}}},"typeOfCharacteristicValue":{"type":"string","maxLength":4,"description":"Type of Characteristic Value indicates whether the characteristic type value is Adhoc, Predefined, Foreign Key, or a File/URL Location.","example":"FKV"},"characteristicValue":{"type":"object","properties":{"_link":{"type":"string","description":"(_link)"},"value":{"type":"string","description":"(value)"},"value2":{"type":"string","description":"(value2)"},"value3":{"type":"string","description":"(value3)"},"value4":{"type":"string","description":"(value4)"},"value5":{"type":"string","description":"(value5)"}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks."}}}}}}},"xml":{"name":"C1-Case"}},"SEARCHCASE_response":{"type":"object","properties":{"offset":{"type":"number","maximum":999999999.999999,"minimum":0,"description":"Offset"},"limit":{"type":"number","maximum":999999999.999999,"minimum":0,"description":"Limit"},"hasMore":{"type":"boolean","description":"Has More"},"totalNumberOfRecords":{"type":"number","maximum":99999,"minimum":0,"description":"Total Number Of Records"},"caseList":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"creationDate":{"type":"string","format":"date","description":"Creation Date"},"case":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"caseId":{"type":"string","maxLength":10,"description":"Case ID"}}},"name":{"type":"string","maxLength":254,"description":"Name"},"address":{"type":"string","maxLength":150,"description":"Address"},"caseType":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"caseType":{"type":"string","maxLength":12,"description":"Case Type"}}},"status":{"type":"string","maxLength":30,"description":"Status"},"caseCondition":{"type":"string","maxLength":4,"description":"Case Condition","example":"OPEN"},"account":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"accountId":{"type":"string","maxLength":10,"description":"Account ID"}}},"person":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"personId":{"type":"string","maxLength":10,"description":"Person ID"}}},"premise":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"premiseId":{"type":"string","maxLength":10,"description":"Premise ID"}}}}}}}}},"xml":{"name":"C1CaseSearch"}},"CREATECASE_request":{"type":"object","properties":{"caseType":{"type":"object","description":"Case Type defines the type of case.","properties":{"caseType":{"type":"string","maxLength":12,"description":"Case Type defines the type of case.","example":"BANKRUPT"}}},"status":{"type":"string","maxLength":12,"description":"Status shows the current state of the case.","example":"NEW"},"comments":{"type":"string","maxLength":2000,"description":"Comments can be used to describe anything interesting or unusual about the case.","example":"new Test"},"person":{"type":"object","properties":{"personId":{"type":"string","maxLength":10,"description":"Person ID references the person associated with this case.","example":"0003339882"}}},"account":{"type":"object","properties":{"accountId":{"type":"string","maxLength":10,"description":"Account ID references the account associated with this case.","example":"0777774590"}}},"premise":{"type":"object","properties":{"premiseId":{"type":"string","maxLength":10,"description":"Premise ID references the premise associated with this case.","example":"0005606666"}}},"responsibleUser":{"type":"object","properties":{"userId":{"type":"string","maxLength":8,"description":"User"}}},"caseCondition":{"type":"string","enum":["CLSD","OPEN"],"description":"Case Condition\n* `CLSD` - Closed,\n* `OPEN` - Open","example":"OPEN"},"contactInformation":{"type":"object","properties":{"contactPerson":{"type":"object","description":"Contact Person references the person who should be contacted.","properties":{"contactPersonId":{"type":"string","maxLength":10,"description":"Contact Person"}}},"preferredContactMethod":{"type":"string","enum":["C1PC","EM  ","FAX ","N/A ","PH  ","POST","SMS "],"description":"Preferred Contact Method indicates how the person prefers to be contacted.\n* `C1PC` - Person Contact,\n* `EM  ` - Email,\n* `FAX ` - Fax,\n* `N/A ` - Not Applicable,\n* `PH  ` - Phone,\n* `POST` - Postal,\n* `SMS ` - SMS","example":"FAX"},"contactInstructions":{"type":"string","maxLength":2000,"description":"Contact Instructions indicates any special instructions indicated for when or how to return a call.","example":"Only in Day"},"callBackPhoneType":{"type":"string","maxLength":12,"description":"Callback Phone Type indicate the actual phone type","example":"CAMP"},"callBackPhoneNumber":{"type":"string","maxLength":24,"description":"Callback Phone Number indicate the actual phone number","example":"(999) 432-2135"},"extension":{"type":"string","maxLength":6,"description":"1234"}}},"isEligibleForArchiving":{"type":"boolean","description":"ILM Archive Switch"},"contactDetail":{"type":"string","maxLength":10,"description":"System-assigned, unique identifier of the person contact record."},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks."},"characteristics":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"sequence":{"type":"number","maximum":999,"minimum":-999,"description":"Sequence Number","example":"10"},"characteristicType":{"type":"object","properties":{"characteristicType":{"type":"string","maxLength":8,"description":"Characteristic Type"}}},"typeOfCharacteristicValue":{"type":"string","maxLength":4,"description":"Type of Characteristic Value indicates whether the characteristic type value is Adhoc, Predefined, Foreign Key, or a File/URL Location.","example":"FKV"},"characteristicValue":{"type":"object","properties":{"_link":{"type":"string","description":"(_link)"},"value":{"type":"string","description":"(value)"},"value2":{"type":"string","description":"(value2)"},"value3":{"type":"string","description":"(value3)"},"value4":{"type":"string","description":"(value4)"},"value5":{"type":"string","description":"(value5)"}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks."}}}}}}},"xml":{"name":"C1-Case"}},"GETCASE_response":{"type":"object","properties":{"_self":{"type":"string","description":"_self"},"caseId":{"type":"string","maxLength":10,"description":"Case ID is the system-assigned unique identifier of the case.","example":"1118286467"},"caseType":{"type":"object","description":"Case Type defines the type of case.","properties":{"_link":{"type":"string","description":"_link"},"caseType":{"type":"string","maxLength":12,"description":"Case Type defines the type of case.","example":"BANKRUPT"}}},"status":{"type":"string","maxLength":12,"description":"Status shows the current state of the case.","example":"NEW"},"comments":{"type":"string","maxLength":2000,"description":"Comments can be used to describe anything interesting or unusual about the case.","example":"new Test"},"person":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"personId":{"type":"string","maxLength":10,"description":"Person ID references the person associated with this case.","example":"0003339882"}}},"account":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"accountId":{"type":"string","maxLength":10,"description":"Account ID references the account associated with this case.","example":"0777774590"}}},"premise":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"premiseId":{"type":"string","maxLength":10,"description":"Premise ID references the premise associated with this case.","example":"0005606666"}}},"responsibleUser":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"userId":{"type":"string","maxLength":8,"description":"User"}}},"caseCondition":{"type":"string","enum":["CLSD","OPEN"],"description":"Case Condition\n* `CLSD` - Closed,\n* `OPEN` - Open","example":"OPEN"},"contactInformation":{"type":"object","properties":{"contactPerson":{"type":"object","description":"Contact Person references the person who should be contacted.","properties":{"_link":{"type":"string","description":"_link"},"contactPersonId":{"type":"string","maxLength":10,"description":"Contact Person"}}},"preferredContactMethod":{"type":"string","enum":["C1PC","EM  ","FAX ","N/A ","PH  ","POST","SMS "],"description":"Preferred Contact Method indicates how the person prefers to be contacted.\n* `C1PC` - Person Contact,\n* `EM  ` - Email,\n* `FAX ` - Fax,\n* `N/A ` - Not Applicable,\n* `PH  ` - Phone,\n* `POST` - Postal,\n* `SMS ` - SMS","example":"FAX"},"contactInstructions":{"type":"string","maxLength":2000,"description":"Contact Instructions indicates any special instructions indicated for when or how to return a call.","example":"Only in Day"},"callBackPhoneType":{"type":"string","maxLength":12,"description":"Callback Phone Type indicate the actual phone type","example":"CAMP"},"callBackPhoneNumber":{"type":"string","maxLength":24,"description":"Callback Phone Number indicate the actual phone number","example":"(999) 432-2135"},"extension":{"type":"string","maxLength":6,"description":"1234"}}},"isEligibleForArchiving":{"type":"boolean","description":"ILM Archive Switch"},"contactDetail":{"type":"string","maxLength":10,"description":"System-assigned, unique identifier of the person contact record."},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks."},"characteristics":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"sequence":{"type":"number","maximum":999,"minimum":-999,"description":"Sequence Number","example":"10"},"characteristicType":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"characteristicType":{"type":"string","maxLength":8,"description":"Characteristic Type"}}},"typeOfCharacteristicValue":{"type":"string","maxLength":4,"description":"Type of Characteristic Value indicates whether the characteristic type value is Adhoc, Predefined, Foreign Key, or a File/URL Location.","example":"FKV"},"characteristicValue":{"type":"object","properties":{"_link":{"type":"string","description":"(_link)"},"value":{"type":"string","description":"(value)"},"value2":{"type":"string","description":"(value2)"},"value3":{"type":"string","description":"(value3)"},"value4":{"type":"string","description":"(value4)"},"value5":{"type":"string","description":"(value5)"}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks."}}}}}}},"xml":{"name":"C1-Case"}},"ACTIONCASE_request":{"type":"object","properties":{"caseId":{"type":"string","maxLength":10,"description":"Case ID is the system-assigned unique identifier of the case.","example":"1118286467"},"_self":{"type":"string","description":"(_self)"},"name":{"type":"string","description":"(name)"},"nextActions":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"actionName":{"type":"string","description":"(actionName)"},"_link":{"type":"string","description":"(_link)"}}}}}}},"xml":{"name":"C1-ActinCase"}},"CREATECASE_response":{"type":"object","properties":{"_self":{"type":"string","description":"_self"},"caseId":{"type":"string","maxLength":10,"description":"Case ID is the system-assigned unique identifier of the case.","example":"1118286467"},"caseType":{"type":"object","description":"Case Type defines the type of case.","properties":{"_link":{"type":"string","description":"_link"},"caseType":{"type":"string","maxLength":12,"description":"Case Type defines the type of case.","example":"BANKRUPT"}}},"status":{"type":"string","maxLength":12,"description":"Status shows the current state of the case.","example":"NEW"},"comments":{"type":"string","maxLength":2000,"description":"Comments can be used to describe anything interesting or unusual about the case.","example":"new Test"},"person":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"personId":{"type":"string","maxLength":10,"description":"Person ID references the person associated with this case.","example":"0003339882"}}},"account":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"accountId":{"type":"string","maxLength":10,"description":"Account ID references the account associated with this case.","example":"0777774590"}}},"premise":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"premiseId":{"type":"string","maxLength":10,"description":"Premise ID references the premise associated with this case.","example":"0005606666"}}},"responsibleUser":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"userId":{"type":"string","maxLength":8,"description":"User"}}},"caseCondition":{"type":"string","enum":["CLSD","OPEN"],"description":"Case Condition\n* `CLSD` - Closed,\n* `OPEN` - Open","example":"OPEN"},"contactInformation":{"type":"object","properties":{"contactPerson":{"type":"object","description":"Contact Person references the person who should be contacted.","properties":{"_link":{"type":"string","description":"_link"},"contactPersonId":{"type":"string","maxLength":10,"description":"Contact Person"}}},"preferredContactMethod":{"type":"string","enum":["C1PC","EM  ","FAX ","N/A ","PH  ","POST","SMS "],"description":"Preferred Contact Method indicates how the person prefers to be contacted.\n* `C1PC` - Person Contact,\n* `EM  ` - Email,\n* `FAX ` - Fax,\n* `N/A ` - Not Applicable,\n* `PH  ` - Phone,\n* `POST` - Postal,\n* `SMS ` - SMS","example":"FAX"},"contactInstructions":{"type":"string","maxLength":2000,"description":"Contact Instructions indicates any special instructions indicated for when or how to return a call.","example":"Only in Day"},"callBackPhoneType":{"type":"string","maxLength":12,"description":"Callback Phone Type indicate the actual phone type","example":"CAMP"},"callBackPhoneNumber":{"type":"string","maxLength":24,"description":"Callback Phone Number indicate the actual phone number","example":"(999) 432-2135"},"extension":{"type":"string","maxLength":6,"description":"1234"}}},"isEligibleForArchiving":{"type":"boolean","description":"ILM Archive Switch"},"contactDetail":{"type":"string","maxLength":10,"description":"System-assigned, unique identifier of the person contact record."},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks."},"characteristics":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"sequence":{"type":"number","maximum":999,"minimum":-999,"description":"Sequence Number","example":"10"},"characteristicType":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"characteristicType":{"type":"string","maxLength":8,"description":"Characteristic Type"}}},"typeOfCharacteristicValue":{"type":"string","maxLength":4,"description":"Type of Characteristic Value indicates whether the characteristic type value is Adhoc, Predefined, Foreign Key, or a File/URL Location.","example":"FKV"},"characteristicValue":{"type":"object","properties":{"_link":{"type":"string","description":"(_link)"},"value":{"type":"string","description":"(value)"},"value2":{"type":"string","description":"(value2)"},"value3":{"type":"string","description":"(value3)"},"value4":{"type":"string","description":"(value4)"},"value5":{"type":"string","description":"(value5)"}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks."}}}}}}},"xml":{"name":"C1-Case"}},"DELETECASE_request":{"type":"object","properties":{"caseId":{"type":"string","maxLength":10,"description":"Case ID is the system-assigned unique identifier of the case.","example":"1118286467"}},"xml":{"name":"C1-DelCase"}},"DELETESERVICEPOINT_response":{"type":"object","properties":{"servicePointId":{"type":"string","maxLength":12,"description":"Service Point ID is a system assigned random number that stays with a service point record."}},"xml":{"name":"D1-DeleteSP"}},"DELETESERVICEPOINT_request":{"type":"object","properties":{"servicePointId":{"type":"string","maxLength":12,"description":"Service Point ID is a system assigned random number that stays with a service point record."}},"xml":{"name":"D1-DeleteSP"}},"CREATESERVICEPOINT_request":{"type":"object","properties":{"servicePointId":{"type":"string","maxLength":12,"description":"Service Point ID"},"servicePointType":{"type":"object","properties":{"servicePointType":{"type":"string","maxLength":30,"description":"Service Point Type"}}},"division":{"type":"object","description":"Divisions are used to delineate between different operating companies within a large conglomerate of utilities.","properties":{"division":{"type":"string","maxLength":30,"description":"Divisions are used to delineate between different operating companies within a large conglomerate of utilities.","example":"CA"}}},"status":{"type":"string","maxLength":12,"description":"The current status of the service point.","example":"ACTIVE"},"timeZone":{"type":"object","description":"Enter the Time Zone in which the premise is located.","properties":{"timeZone":{"type":"string","maxLength":10,"description":"Enter the Time Zone in which the premise is located.","example":"USPACIFIC"}}},"market":{"type":"object","description":"Defines jurisdictions or regulatory environments in which a Service Point participates.","properties":{"market":{"type":"string","maxLength":30,"description":"Defines jurisdictions or regulatory environments in which a Service Point participates.","example":"ZZ_SMSR_MKT10111024"}}},"parentServicePoint":{"type":"object","properties":{"parentServicePointId":{"type":"string","maxLength":12,"description":"Related Service Point"}}},"sourceStatus":{"type":"string","enum":["D1CN","D1DC"],"description":"Service Point Source Status defines whether the service point is connected to the source of power. Valid values are: Connected and Disconnected.\n* `D1CN` - Connected,\n* `D1DC` - Disconnected","example":"D1CN"},"disconnectLocation":{"type":"string","enum":["D1DV","D1SR"],"description":"If the Service point source status is disconnected, use Disconnect Location to specify where service was severed.\n* `D1DV` - Device,\n* `D1SR` - Source","example":"D1SR"},"externalServicePointId":{"type":"string","maxLength":60,"description":"External Service Point ID defines External Systems with which Oracle Utilities Meter Data Management should be able to communicate.","example":"0979106595"},"externalPremiseId":{"type":"string","maxLength":60,"description":"External Premise ID","example":"0979106528"},"mainContact":{"type":"string","maxLength":12,"description":"The main contact for the service provider."},"primaryUsageSubscriptionId":{"type":"string","maxLength":12,"description":"Usage Subscription ID is a system assigned random number that stays with a usage subscription record."},"assetLocationId":{"type":"string","maxLength":120,"description":"Asset System SP ID"},"mdmExternalId":{"type":"string","maxLength":60,"description":"MDM External ID"},"distributionNetworkFacility":{"type":"string","maxLength":14,"description":"Distribution Network Facility"},"address":{"type":"object","properties":{"country":{"type":"object","description":"The country of the address.","properties":{"country":{"type":"string","maxLength":3,"description":"The country of the address.","example":"USA"}}},"postal":{"type":"string","maxLength":12,"description":"The postal of the address.","example":"44685"},"address1":{"type":"string","maxLength":254,"description":"The first line of the address.","example":"329 NEWBURY AVE NW"},"address2":{"type":"string","maxLength":254,"description":"The second line of the address."},"address3":{"type":"string","maxLength":254,"description":"The third line of the address."},"address4":{"type":"string","maxLength":254,"description":"The fourth line of the address."},"city":{"type":"string","maxLength":90,"description":"The city of the address.","example":"Uniontown"},"streetNumber1":{"type":"string","maxLength":6,"description":"The first street number line of the address."},"streetNumber2":{"type":"string","maxLength":4,"description":"The second street number line of the address."},"county":{"type":"string","maxLength":90,"description":"The county of the address."},"state":{"type":"string","maxLength":6,"description":"The state of the address.","example":"OH"}}},"estimationEligibility":{"type":"string","enum":["D1EL","D1NE"],"description":"Periodic estimation Eligibility determines if measuring component is eligible for estimation.\n* `D1EL` - Eligible,\n* `D1NE` - Not Eligible","example":"D1EL"},"accessGroup":{"type":"object","description":"Access Group","properties":{"accessGroup":{"type":"string","maxLength":12,"description":"Access Group"}}},"statusDateTime":{"type":"string","format":"date-time","description":"Status Date/Time","example":"2012-01-19T03:25:38-08:00"},"creationDateTime":{"type":"string","format":"date-time","description":"Create Date/Time","example":"2012-01-19T03:25:38-08:00"},"geographicLatitude":{"type":"number","maximum":999999999.999999,"minimum":-999999999.999999,"description":"Geographic Latitude displays the geographic latitude information that defines where the service point is located.","example":"40.779680"},"geographicLongitude":{"type":"number","maximum":999999999.999999,"minimum":-999999999.999999,"description":"Geographic Longitude displays the geographic longitude information that defines where the service point is located.","example":"-81.399990"},"lifeSupportSensitiveLoad":{"type":"string","enum":["ZZLS","ZZNC","ZZNL"],"description":"Indicates if the current service point supplies service to life support equipment (or if the load supplied to the service point is considered sensitive).\n* `ZZLS` - On life support,\n* `ZZNC` - None,\n* `ZZNL` - Not on life support","example":"ZZNL"},"lifeSupportSensitiveLoadDescription":{"type":"string","maxLength":4000,"description":"Life Support sensitive load description","example":"Not on life support"},"okToEnter":{"type":"string","enum":["ZZCIT1","false","true","ZZYES","ZZNO"],"description":"Turn on OK to Enter if the meter is located in the interior of the premise and your company has permission to enter.\n* `ZZCIT1` - Test CIT,\n* `false` - False,\n* `true` - True,\n* `ZZYES` - Yes,\n* `ZZNO` - No","example":"false"},"spWarning":{"type":"string","enum":["ZZ-BADDOG","ZZWARN","ZZCAT","ZZNEIG","ZZRS","ZZDIVE","ZZDANG","ZZSW"],"description":"Indicate a SP Warning if a specific warning should be downloaded to the person who reads the meter.\n* `ZZ-BADDOG` - BAD DOG,\n* `ZZWARN` - Test Warn,\n* `ZZCAT` - Mean cat at premise,\n* `ZZNEIG` - Suspicious neighbor,\n* `ZZRS` - ZZRS,\n* `ZZDIVE` - History of service diversion,\n* `ZZDANG` - Suspect dangerous occupants,\n* `ZZSW` - ZZSW","example":"ZZDANG"},"spInstruction":{"type":"string","enum":["ZZ-SPI","ZZLRC","ZZSPINSTR","ZZTEST14521","ZZCON","ZZCHKSEAL","ZZSER"],"description":"Indicate a SP Instruction if specific instructions should be downloaded to the person who reads the meter.\n* `ZZ-SPI` - ZZ-SPI,\n* `ZZLRC` - Leave read card with customer,\n* `ZZSPINSTR` - Test SPINSTR,\n* `ZZTEST14521` - test,\n* `ZZCON` - Verify constant,\n* `ZZCHKSEAL` - Check Seal,\n* `ZZSER` - Verify serial number","example":"ZZCHKSEAL"},"spInstructionDetails":{"type":"string","maxLength":250,"description":"SP Instruction Details provides more detailed instructions to the individual who reads meters at this premise.","example":"Suspect Dangerous occupants"},"key":{"type":"string","enum":["ZZKEY","ZZ-KEY2","false","true","ZZYES","ZZNO"],"description":"Key\n* `ZZKEY` - Test Key,\n* `ZZ-KEY2` - Test Key 2,\n* `false` - No,\n* `true` - Yes,\n* `ZZYES` - Yes,\n* `ZZNO` - No","example":"ZZNO"},"keyId":{"type":"string","maxLength":30,"description":"Specify the Key ID if the meter is secured in a locked area and your company has the key.","example":"No key at premise"},"deviceLocation":{"type":"string","enum":["ZZCIT","ZZGR","ZZBK","ZZSR","ZZRS","ZZLS"],"description":"Device Location is used to define where the service point is located on the premise.\n* `ZZCIT` - Test CIT,\n* `ZZGR` - Garage,\n* `ZZBK` - Backyard,\n* `ZZSR` - SR related location,\n* `ZZRS` - Right Side,\n* `ZZLS` - Left Side","example":"ZZBK"},"deviceLocationDetails":{"type":"string","maxLength":250,"description":"Location Details are used to clarify the location at the premise."},"measurementCycle":{"type":"object","description":"Measurement Cycle specifies the schedule used for when the service point is visited and the the device read.","properties":{"measurementCycle":{"type":"string","maxLength":30,"description":"Measurement Cycle specifies the schedule used for when the service point is visited and the the device read.","example":"MONTHLYDAY1"}}},"measurementCycleRoute":{"type":"string","maxLength":30,"description":"Route specifies the group of service points in a cycle that are visited by a meter reader.","example":"R1"},"measurementCycleRouteSequence":{"type":"number","maximum":999999999,"minimum":-999999999,"description":"Sequence"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks.","example":"5"},"equipment":{"type":"object","properties":{"equipmentList":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"equipment":{"type":"object","properties":{"equipmentId":{"type":"string","maxLength":12,"description":"Device ID"}}},"installDateTime":{"type":"string","format":"date-time","description":"Date of the installation of the service point connection at the premise.","example":"2007-06-1"},"removalDateTime":{"type":"string","format":"date-time","description":"Defines the date that the equipment was removed from the service point.","example":"2007-06-1"},"equipmentCount":{"type":"number","maximum":999999999.99,"minimum":0,"description":"Equipment Count This field should be 1 except when you are using an item to define a generic piece of equipment. If you use an item to define a generic piece of equipment, you can indicate the number of such generic pieces of equipment that are associated with this service point.","example":"1.00"},"comments":{"type":"string","maxLength":254,"description":"Use comments to explain anything unusual about the piece of equipment."},"crew":{"type":"string","maxLength":60,"description":"Crew"}}}}}}}},"multiItems":{"type":"object","properties":{"multiItemList":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"startDateTime":{"type":"string","format":"date-time","description":"The Start Date/time of the multi-item list."},"endDateTime":{"type":"string","format":"date-time","description":"The End Date/Time of the multi-item list."},"installationOverrideQuantity":{"type":"number","maximum":9999999999.999998,"minimum":-9999999999.999998,"description":"Installation Override Quantity"},"uom":{"type":"string","maxLength":30,"description":"A metric of how measurement data is measured (i.e. kWh, kVARh, CCF, etc.)"},"sqi":{"type":"string","maxLength":30,"description":"Used to further distinguish between measured quantities that have identical UOM/TOU combinations (i.e. Generated, Consumed, etc.)"},"multiItemCounts":{"type":"object","properties":{"multiItemCountList":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"itemType":{"type":"string","maxLength":30,"description":"Indicates the type of item","example":"CT BADGE"},"count":{"type":"number","maximum":999999999.99,"minimum":-999999999.99,"description":"Indicates how many of the given type of item exist at the service point.","example":"1.00"}}}}}}}}}}}}}}},"marketParticipants":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"serviceProvider":{"type":"object","properties":{"serviceProvider":{"type":"string","maxLength":30,"description":"Service Provider"}}},"marketRelationshipType":{"type":"string","enum":["ZZDE","ZZDS","ZZDT","ZZRT","ZZSE","ZZSU"],"description":"Markets define market relationships for valid service providers and their roles within a market (distributor, etc.).\n* `ZZDE` - Distributor Type,\n* `ZZDS` - Distributor,\n* `ZZDT` - Distributor Type2,\n* `ZZRT` - Retailer,\n* `ZZSE` - Scheduling Entity,\n* `ZZSU` - Supplier","example":"ZZDE"},"startDateTime":{"type":"string","format":"date-time","description":"The Start Date/time of the multi-item list."},"endDateTime":{"type":"string","format":"date-time","description":"The End Date/Time of the multi-item list."}}}}}}},"xml":{"name":"D1ServPoint"}},"UPDATESERVICEPOINT_response":{"type":"object","properties":{"_self":{"type":"string","description":"_self"},"servicePointId":{"type":"string","maxLength":12,"description":"Service Point ID"},"servicePointType":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"servicePointType":{"type":"string","maxLength":30,"description":"Service Point Type"}}},"division":{"type":"object","description":"Divisions are used to delineate between different operating companies within a large conglomerate of utilities.","properties":{"_link":{"type":"string","description":"_link"},"division":{"type":"string","maxLength":30,"description":"Divisions are used to delineate between different operating companies within a large conglomerate of utilities.","example":"CA"}}},"status":{"type":"string","maxLength":12,"description":"The current status of the service point.","example":"ACTIVE"},"timeZone":{"type":"object","description":"Enter the Time Zone in which the premise is located.","properties":{"_link":{"type":"string","description":"_link"},"timeZone":{"type":"string","maxLength":10,"description":"Enter the Time Zone in which the premise is located.","example":"USPACIFIC"}}},"market":{"type":"object","description":"Defines jurisdictions or regulatory environments in which a Service Point participates.","properties":{"_link":{"type":"string","description":"_link"},"market":{"type":"string","maxLength":30,"description":"Defines jurisdictions or regulatory environments in which a Service Point participates.","example":"ZZ_SMSR_MKT10111024"}}},"parentServicePoint":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"parentServicePointId":{"type":"string","maxLength":12,"description":"Related Service Point"}}},"sourceStatus":{"type":"string","enum":["D1CN","D1DC"],"description":"Service Point Source Status defines whether the service point is connected to the source of power. Valid values are: Connected and Disconnected.\n* `D1CN` - Connected,\n* `D1DC` - Disconnected","example":"D1CN"},"disconnectLocation":{"type":"string","enum":["D1DV","D1SR"],"description":"If the Service point source status is disconnected, use Disconnect Location to specify where service was severed.\n* `D1DV` - Device,\n* `D1SR` - Source","example":"D1SR"},"externalServicePointId":{"type":"string","maxLength":60,"description":"External Service Point ID defines External Systems with which Oracle Utilities Meter Data Management should be able to communicate.","example":"0979106595"},"externalPremiseId":{"type":"string","maxLength":60,"description":"External Premise ID","example":"0979106528"},"mainContact":{"type":"string","maxLength":12,"description":"The main contact for the service provider."},"primaryUsageSubscriptionId":{"type":"string","maxLength":12,"description":"Usage Subscription ID is a system assigned random number that stays with a usage subscription record."},"assetLocationId":{"type":"string","maxLength":120,"description":"Asset System SP ID"},"mdmExternalId":{"type":"string","maxLength":60,"description":"MDM External ID"},"distributionNetworkFacility":{"type":"string","maxLength":14,"description":"Distribution Network Facility"},"address":{"type":"object","properties":{"country":{"type":"object","description":"The country of the address.","properties":{"_link":{"type":"string","description":"_link"},"country":{"type":"string","maxLength":3,"description":"The country of the address.","example":"USA"}}},"postal":{"type":"string","maxLength":12,"description":"The postal of the address.","example":"44685"},"address1":{"type":"string","maxLength":254,"description":"The first line of the address.","example":"329 NEWBURY AVE NW"},"address2":{"type":"string","maxLength":254,"description":"The second line of the address."},"address3":{"type":"string","maxLength":254,"description":"The third line of the address."},"address4":{"type":"string","maxLength":254,"description":"The fourth line of the address."},"city":{"type":"string","maxLength":90,"description":"The city of the address.","example":"Uniontown"},"streetNumber1":{"type":"string","maxLength":6,"description":"The first street number line of the address."},"streetNumber2":{"type":"string","maxLength":4,"description":"The second street number line of the address."},"county":{"type":"string","maxLength":90,"description":"The county of the address."},"state":{"type":"string","maxLength":6,"description":"The state of the address.","example":"OH"}}},"estimationEligibility":{"type":"string","enum":["D1EL","D1NE"],"description":"Periodic estimation Eligibility determines if measuring component is eligible for estimation.\n* `D1EL` - Eligible,\n* `D1NE` - Not Eligible","example":"D1EL"},"accessGroup":{"type":"object","description":"Access Group","properties":{"_link":{"type":"string","description":"_link"},"accessGroup":{"type":"string","maxLength":12,"description":"Access Group"}}},"statusDateTime":{"type":"string","format":"date-time","description":"Status Date/Time","example":"2012-01-19T03:25:38-08:00"},"creationDateTime":{"type":"string","format":"date-time","description":"Create Date/Time","example":"2012-01-19T03:25:38-08:00"},"geographicLatitude":{"type":"number","maximum":999999999.999999,"minimum":-999999999.999999,"description":"Geographic Latitude displays the geographic latitude information that defines where the service point is located.","example":"40.779680"},"geographicLongitude":{"type":"number","maximum":999999999.999999,"minimum":-999999999.999999,"description":"Geographic Longitude displays the geographic longitude information that defines where the service point is located.","example":"-81.399990"},"lifeSupportSensitiveLoad":{"type":"string","enum":["ZZLS","ZZNC","ZZNL"],"description":"Indicates if the current service point supplies service to life support equipment (or if the load supplied to the service point is considered sensitive).\n* `ZZLS` - On life support,\n* `ZZNC` - None,\n* `ZZNL` - Not on life support","example":"ZZNL"},"lifeSupportSensitiveLoadDescription":{"type":"string","maxLength":4000,"description":"Life Support sensitive load description","example":"Not on life support"},"okToEnter":{"type":"string","enum":["ZZCIT1","false","true","ZZYES","ZZNO"],"description":"Turn on OK to Enter if the meter is located in the interior of the premise and your company has permission to enter.\n* `ZZCIT1` - Test CIT,\n* `false` - False,\n* `true` - True,\n* `ZZYES` - Yes,\n* `ZZNO` - No","example":"false"},"spWarning":{"type":"string","enum":["ZZ-BADDOG","ZZWARN","ZZCAT","ZZNEIG","ZZRS","ZZDIVE","ZZDANG","ZZSW"],"description":"Indicate a SP Warning if a specific warning should be downloaded to the person who reads the meter.\n* `ZZ-BADDOG` - BAD DOG,\n* `ZZWARN` - Test Warn,\n* `ZZCAT` - Mean cat at premise,\n* `ZZNEIG` - Suspicious neighbor,\n* `ZZRS` - ZZRS,\n* `ZZDIVE` - History of service diversion,\n* `ZZDANG` - Suspect dangerous occupants,\n* `ZZSW` - ZZSW","example":"ZZDANG"},"spInstruction":{"type":"string","enum":["ZZ-SPI","ZZLRC","ZZSPINSTR","ZZTEST14521","ZZCON","ZZCHKSEAL","ZZSER"],"description":"Indicate a SP Instruction if specific instructions should be downloaded to the person who reads the meter.\n* `ZZ-SPI` - ZZ-SPI,\n* `ZZLRC` - Leave read card with customer,\n* `ZZSPINSTR` - Test SPINSTR,\n* `ZZTEST14521` - test,\n* `ZZCON` - Verify constant,\n* `ZZCHKSEAL` - Check Seal,\n* `ZZSER` - Verify serial number","example":"ZZCHKSEAL"},"spInstructionDetails":{"type":"string","maxLength":250,"description":"SP Instruction Details provides more detailed instructions to the individual who reads meters at this premise.","example":"Suspect Dangerous occupants"},"key":{"type":"string","enum":["ZZKEY","ZZ-KEY2","false","true","ZZYES","ZZNO"],"description":"Key\n* `ZZKEY` - Test Key,\n* `ZZ-KEY2` - Test Key 2,\n* `false` - No,\n* `true` - Yes,\n* `ZZYES` - Yes,\n* `ZZNO` - No","example":"ZZNO"},"keyId":{"type":"string","maxLength":30,"description":"Specify the Key ID if the meter is secured in a locked area and your company has the key.","example":"No key at premise"},"deviceLocation":{"type":"string","enum":["ZZCIT","ZZGR","ZZBK","ZZSR","ZZRS","ZZLS"],"description":"Device Location is used to define where the service point is located on the premise.\n* `ZZCIT` - Test CIT,\n* `ZZGR` - Garage,\n* `ZZBK` - Backyard,\n* `ZZSR` - SR related location,\n* `ZZRS` - Right Side,\n* `ZZLS` - Left Side","example":"ZZBK"},"deviceLocationDetails":{"type":"string","maxLength":250,"description":"Location Details are used to clarify the location at the premise."},"measurementCycle":{"type":"object","description":"Measurement Cycle specifies the schedule used for when the service point is visited and the the device read.","properties":{"_link":{"type":"string","description":"_link"},"measurementCycle":{"type":"string","maxLength":30,"description":"Measurement Cycle specifies the schedule used for when the service point is visited and the the device read.","example":"MONTHLYDAY1"}}},"measurementCycleRoute":{"type":"string","maxLength":30,"description":"Route specifies the group of service points in a cycle that are visited by a meter reader.","example":"R1"},"measurementCycleRouteSequence":{"type":"number","maximum":999999999,"minimum":-999999999,"description":"Sequence"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks.","example":"5"},"equipment":{"type":"object","properties":{"equipmentList":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"equipment":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"equipmentId":{"type":"string","maxLength":12,"description":"Device ID"}}},"installDateTime":{"type":"string","format":"date-time","description":"Date of the installation of the service point connection at the premise.","example":"2007-06-1"},"removalDateTime":{"type":"string","format":"date-time","description":"Defines the date that the equipment was removed from the service point.","example":"2007-06-1"},"equipmentCount":{"type":"number","maximum":999999999.99,"minimum":0,"description":"Equipment Count This field should be 1 except when you are using an item to define a generic piece of equipment. If you use an item to define a generic piece of equipment, you can indicate the number of such generic pieces of equipment that are associated with this service point.","example":"1.00"},"comments":{"type":"string","maxLength":254,"description":"Use comments to explain anything unusual about the piece of equipment."},"crew":{"type":"string","maxLength":60,"description":"Crew"}}}}}}}},"multiItems":{"type":"object","properties":{"multiItemList":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"startDateTime":{"type":"string","format":"date-time","description":"The Start Date/time of the multi-item list."},"endDateTime":{"type":"string","format":"date-time","description":"The End Date/Time of the multi-item list."},"installationOverrideQuantity":{"type":"number","maximum":9999999999.999998,"minimum":-9999999999.999998,"description":"Installation Override Quantity"},"uom":{"type":"string","maxLength":30,"description":"A metric of how measurement data is measured (i.e. kWh, kVARh, CCF, etc.)"},"sqi":{"type":"string","maxLength":30,"description":"Used to further distinguish between measured quantities that have identical UOM/TOU combinations (i.e. Generated, Consumed, etc.)"},"multiItemCounts":{"type":"object","properties":{"multiItemCountList":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"itemType":{"type":"string","maxLength":30,"description":"Indicates the type of item","example":"CT BADGE"},"count":{"type":"number","maximum":999999999.99,"minimum":-999999999.99,"description":"Indicates how many of the given type of item exist at the service point.","example":"1.00"}}}}}}}}}}}}}}},"marketParticipants":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"serviceProvider":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"serviceProvider":{"type":"string","maxLength":30,"description":"Service Provider"}}},"marketRelationshipType":{"type":"string","enum":["ZZDE","ZZDS","ZZDT","ZZRT","ZZSE","ZZSU"],"description":"Markets define market relationships for valid service providers and their roles within a market (distributor, etc.).\n* `ZZDE` - Distributor Type,\n* `ZZDS` - Distributor,\n* `ZZDT` - Distributor Type2,\n* `ZZRT` - Retailer,\n* `ZZSE` - Scheduling Entity,\n* `ZZSU` - Supplier","example":"ZZDE"},"startDateTime":{"type":"string","format":"date-time","description":"The Start Date/time of the multi-item list."},"endDateTime":{"type":"string","format":"date-time","description":"The End Date/Time of the multi-item list."}}}}}}},"xml":{"name":"D1ServPoint"}},"UPDATESERVICEPOINT_request":{"type":"object","properties":{"servicePointId":{"type":"string","maxLength":12,"description":"Service Point ID"},"servicePointType":{"type":"object","properties":{"servicePointType":{"type":"string","maxLength":30,"description":"Service Point Type"}}},"division":{"type":"object","description":"Divisions are used to delineate between different operating companies within a large conglomerate of utilities.","properties":{"division":{"type":"string","maxLength":30,"description":"Divisions are used to delineate between different operating companies within a large conglomerate of utilities.","example":"CA"}}},"status":{"type":"string","maxLength":12,"description":"The current status of the service point.","example":"ACTIVE"},"timeZone":{"type":"object","description":"Enter the Time Zone in which the premise is located.","properties":{"timeZone":{"type":"string","maxLength":10,"description":"Enter the Time Zone in which the premise is located.","example":"USPACIFIC"}}},"market":{"type":"object","description":"Defines jurisdictions or regulatory environments in which a Service Point participates.","properties":{"market":{"type":"string","maxLength":30,"description":"Defines jurisdictions or regulatory environments in which a Service Point participates.","example":"ZZ_SMSR_MKT10111024"}}},"parentServicePoint":{"type":"object","properties":{"parentServicePointId":{"type":"string","maxLength":12,"description":"Related Service Point"}}},"sourceStatus":{"type":"string","enum":["D1CN","D1DC"],"description":"Service Point Source Status defines whether the service point is connected to the source of power. Valid values are: Connected and Disconnected.\n* `D1CN` - Connected,\n* `D1DC` - Disconnected","example":"D1CN"},"disconnectLocation":{"type":"string","enum":["D1DV","D1SR"],"description":"If the Service point source status is disconnected, use Disconnect Location to specify where service was severed.\n* `D1DV` - Device,\n* `D1SR` - Source","example":"D1SR"},"externalServicePointId":{"type":"string","maxLength":60,"description":"External Service Point ID defines External Systems with which Oracle Utilities Meter Data Management should be able to communicate.","example":"0979106595"},"externalPremiseId":{"type":"string","maxLength":60,"description":"External Premise ID","example":"0979106528"},"mainContact":{"type":"string","maxLength":12,"description":"The main contact for the service provider."},"primaryUsageSubscriptionId":{"type":"string","maxLength":12,"description":"Usage Subscription ID is a system assigned random number that stays with a usage subscription record."},"assetLocationId":{"type":"string","maxLength":120,"description":"Asset System SP ID"},"mdmExternalId":{"type":"string","maxLength":60,"description":"MDM External ID"},"distributionNetworkFacility":{"type":"string","maxLength":14,"description":"Distribution Network Facility"},"address":{"type":"object","properties":{"country":{"type":"object","description":"The country of the address.","properties":{"country":{"type":"string","maxLength":3,"description":"The country of the address.","example":"USA"}}},"postal":{"type":"string","maxLength":12,"description":"The postal of the address.","example":"44685"},"address1":{"type":"string","maxLength":254,"description":"The first line of the address.","example":"329 NEWBURY AVE NW"},"address2":{"type":"string","maxLength":254,"description":"The second line of the address."},"address3":{"type":"string","maxLength":254,"description":"The third line of the address."},"address4":{"type":"string","maxLength":254,"description":"The fourth line of the address."},"city":{"type":"string","maxLength":90,"description":"The city of the address.","example":"Uniontown"},"streetNumber1":{"type":"string","maxLength":6,"description":"The first street number line of the address."},"streetNumber2":{"type":"string","maxLength":4,"description":"The second street number line of the address."},"county":{"type":"string","maxLength":90,"description":"The county of the address."},"state":{"type":"string","maxLength":6,"description":"The state of the address.","example":"OH"}}},"estimationEligibility":{"type":"string","enum":["D1EL","D1NE"],"description":"Periodic estimation Eligibility determines if measuring component is eligible for estimation.\n* `D1EL` - Eligible,\n* `D1NE` - Not Eligible","example":"D1EL"},"accessGroup":{"type":"object","description":"Access Group","properties":{"accessGroup":{"type":"string","maxLength":12,"description":"Access Group"}}},"statusDateTime":{"type":"string","format":"date-time","description":"Status Date/Time","example":"2012-01-19T03:25:38-08:00"},"creationDateTime":{"type":"string","format":"date-time","description":"Create Date/Time","example":"2012-01-19T03:25:38-08:00"},"geographicLatitude":{"type":"number","maximum":999999999.999999,"minimum":-999999999.999999,"description":"Geographic Latitude displays the geographic latitude information that defines where the service point is located.","example":"40.779680"},"geographicLongitude":{"type":"number","maximum":999999999.999999,"minimum":-999999999.999999,"description":"Geographic Longitude displays the geographic longitude information that defines where the service point is located.","example":"-81.399990"},"lifeSupportSensitiveLoad":{"type":"string","enum":["ZZLS","ZZNC","ZZNL"],"description":"Indicates if the current service point supplies service to life support equipment (or if the load supplied to the service point is considered sensitive).\n* `ZZLS` - On life support,\n* `ZZNC` - None,\n* `ZZNL` - Not on life support","example":"ZZNL"},"lifeSupportSensitiveLoadDescription":{"type":"string","maxLength":4000,"description":"Life Support sensitive load description","example":"Not on life support"},"okToEnter":{"type":"string","enum":["ZZCIT1","false","true","ZZYES","ZZNO"],"description":"Turn on OK to Enter if the meter is located in the interior of the premise and your company has permission to enter.\n* `ZZCIT1` - Test CIT,\n* `false` - False,\n* `true` - True,\n* `ZZYES` - Yes,\n* `ZZNO` - No","example":"false"},"spWarning":{"type":"string","enum":["ZZ-BADDOG","ZZWARN","ZZCAT","ZZNEIG","ZZRS","ZZDIVE","ZZDANG","ZZSW"],"description":"Indicate a SP Warning if a specific warning should be downloaded to the person who reads the meter.\n* `ZZ-BADDOG` - BAD DOG,\n* `ZZWARN` - Test Warn,\n* `ZZCAT` - Mean cat at premise,\n* `ZZNEIG` - Suspicious neighbor,\n* `ZZRS` - ZZRS,\n* `ZZDIVE` - History of service diversion,\n* `ZZDANG` - Suspect dangerous occupants,\n* `ZZSW` - ZZSW","example":"ZZDANG"},"spInstruction":{"type":"string","enum":["ZZ-SPI","ZZLRC","ZZSPINSTR","ZZTEST14521","ZZCON","ZZCHKSEAL","ZZSER"],"description":"Indicate a SP Instruction if specific instructions should be downloaded to the person who reads the meter.\n* `ZZ-SPI` - ZZ-SPI,\n* `ZZLRC` - Leave read card with customer,\n* `ZZSPINSTR` - Test SPINSTR,\n* `ZZTEST14521` - test,\n* `ZZCON` - Verify constant,\n* `ZZCHKSEAL` - Check Seal,\n* `ZZSER` - Verify serial number","example":"ZZCHKSEAL"},"spInstructionDetails":{"type":"string","maxLength":250,"description":"SP Instruction Details provides more detailed instructions to the individual who reads meters at this premise.","example":"Suspect Dangerous occupants"},"key":{"type":"string","enum":["ZZKEY","ZZ-KEY2","false","true","ZZYES","ZZNO"],"description":"Key\n* `ZZKEY` - Test Key,\n* `ZZ-KEY2` - Test Key 2,\n* `false` - No,\n* `true` - Yes,\n* `ZZYES` - Yes,\n* `ZZNO` - No","example":"ZZNO"},"keyId":{"type":"string","maxLength":30,"description":"Specify the Key ID if the meter is secured in a locked area and your company has the key.","example":"No key at premise"},"deviceLocation":{"type":"string","enum":["ZZCIT","ZZGR","ZZBK","ZZSR","ZZRS","ZZLS"],"description":"Device Location is used to define where the service point is located on the premise.\n* `ZZCIT` - Test CIT,\n* `ZZGR` - Garage,\n* `ZZBK` - Backyard,\n* `ZZSR` - SR related location,\n* `ZZRS` - Right Side,\n* `ZZLS` - Left Side","example":"ZZBK"},"deviceLocationDetails":{"type":"string","maxLength":250,"description":"Location Details are used to clarify the location at the premise."},"measurementCycle":{"type":"object","description":"Measurement Cycle specifies the schedule used for when the service point is visited and the the device read.","properties":{"measurementCycle":{"type":"string","maxLength":30,"description":"Measurement Cycle specifies the schedule used for when the service point is visited and the the device read.","example":"MONTHLYDAY1"}}},"measurementCycleRoute":{"type":"string","maxLength":30,"description":"Route specifies the group of service points in a cycle that are visited by a meter reader.","example":"R1"},"measurementCycleRouteSequence":{"type":"number","maximum":999999999,"minimum":-999999999,"description":"Sequence"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks.","example":"5"},"equipment":{"type":"object","properties":{"equipmentList":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"equipment":{"type":"object","properties":{"equipmentId":{"type":"string","maxLength":12,"description":"Device ID"}}},"installDateTime":{"type":"string","format":"date-time","description":"Date of the installation of the service point connection at the premise.","example":"2007-06-1"},"removalDateTime":{"type":"string","format":"date-time","description":"Defines the date that the equipment was removed from the service point.","example":"2007-06-1"},"equipmentCount":{"type":"number","maximum":999999999.99,"minimum":0,"description":"Equipment Count This field should be 1 except when you are using an item to define a generic piece of equipment. If you use an item to define a generic piece of equipment, you can indicate the number of such generic pieces of equipment that are associated with this service point.","example":"1.00"},"comments":{"type":"string","maxLength":254,"description":"Use comments to explain anything unusual about the piece of equipment."},"crew":{"type":"string","maxLength":60,"description":"Crew"}}}}}}}},"multiItems":{"type":"object","properties":{"multiItemList":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"startDateTime":{"type":"string","format":"date-time","description":"The Start Date/time of the multi-item list."},"endDateTime":{"type":"string","format":"date-time","description":"The End Date/Time of the multi-item list."},"installationOverrideQuantity":{"type":"number","maximum":9999999999.999998,"minimum":-9999999999.999998,"description":"Installation Override Quantity"},"uom":{"type":"string","maxLength":30,"description":"A metric of how measurement data is measured (i.e. kWh, kVARh, CCF, etc.)"},"sqi":{"type":"string","maxLength":30,"description":"Used to further distinguish between measured quantities that have identical UOM/TOU combinations (i.e. Generated, Consumed, etc.)"},"multiItemCounts":{"type":"object","properties":{"multiItemCountList":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"itemType":{"type":"string","maxLength":30,"description":"Indicates the type of item","example":"CT BADGE"},"count":{"type":"number","maximum":999999999.99,"minimum":-999999999.99,"description":"Indicates how many of the given type of item exist at the service point.","example":"1.00"}}}}}}}}}}}}}}},"marketParticipants":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"serviceProvider":{"type":"object","properties":{"serviceProvider":{"type":"string","maxLength":30,"description":"Service Provider"}}},"marketRelationshipType":{"type":"string","enum":["ZZDE","ZZDS","ZZDT","ZZRT","ZZSE","ZZSU"],"description":"Markets define market relationships for valid service providers and their roles within a market (distributor, etc.).\n* `ZZDE` - Distributor Type,\n* `ZZDS` - Distributor,\n* `ZZDT` - Distributor Type2,\n* `ZZRT` - Retailer,\n* `ZZSE` - Scheduling Entity,\n* `ZZSU` - Supplier","example":"ZZDE"},"startDateTime":{"type":"string","format":"date-time","description":"The Start Date/time of the multi-item list."},"endDateTime":{"type":"string","format":"date-time","description":"The End Date/Time of the multi-item list."}}}}}}},"xml":{"name":"D1ServPoint"}},"GETSERVICEPOINT_response":{"type":"object","properties":{"_self":{"type":"string","description":"_self"},"servicePointId":{"type":"string","maxLength":12,"description":"Service Point ID"},"servicePointType":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"servicePointType":{"type":"string","maxLength":30,"description":"Service Point Type"}}},"division":{"type":"object","description":"Divisions are used to delineate between different operating companies within a large conglomerate of utilities.","properties":{"_link":{"type":"string","description":"_link"},"division":{"type":"string","maxLength":30,"description":"Divisions are used to delineate between different operating companies within a large conglomerate of utilities.","example":"CA"}}},"status":{"type":"string","maxLength":12,"description":"The current status of the service point.","example":"ACTIVE"},"timeZone":{"type":"object","description":"Enter the Time Zone in which the premise is located.","properties":{"_link":{"type":"string","description":"_link"},"timeZone":{"type":"string","maxLength":10,"description":"Enter the Time Zone in which the premise is located.","example":"USPACIFIC"}}},"market":{"type":"object","description":"Defines jurisdictions or regulatory environments in which a Service Point participates.","properties":{"_link":{"type":"string","description":"_link"},"market":{"type":"string","maxLength":30,"description":"Defines jurisdictions or regulatory environments in which a Service Point participates.","example":"ZZ_SMSR_MKT10111024"}}},"parentServicePoint":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"parentServicePointId":{"type":"string","maxLength":12,"description":"Related Service Point"}}},"sourceStatus":{"type":"string","enum":["D1CN","D1DC"],"description":"Service Point Source Status defines whether the service point is connected to the source of power. Valid values are: Connected and Disconnected.\n* `D1CN` - Connected,\n* `D1DC` - Disconnected","example":"D1CN"},"disconnectLocation":{"type":"string","enum":["D1DV","D1SR"],"description":"If the Service point source status is disconnected, use Disconnect Location to specify where service was severed.\n* `D1DV` - Device,\n* `D1SR` - Source","example":"D1SR"},"externalServicePointId":{"type":"string","maxLength":60,"description":"External Service Point ID defines External Systems with which Oracle Utilities Meter Data Management should be able to communicate.","example":"0979106595"},"externalPremiseId":{"type":"string","maxLength":60,"description":"External Premise ID","example":"0979106528"},"mainContact":{"type":"string","maxLength":12,"description":"The main contact for the service provider."},"primaryUsageSubscriptionId":{"type":"string","maxLength":12,"description":"Usage Subscription ID is a system assigned random number that stays with a usage subscription record."},"assetLocationId":{"type":"string","maxLength":120,"description":"Asset System SP ID"},"mdmExternalId":{"type":"string","maxLength":60,"description":"MDM External ID"},"distributionNetworkFacility":{"type":"string","maxLength":14,"description":"Distribution Network Facility"},"address":{"type":"object","properties":{"country":{"type":"object","description":"The country of the address.","properties":{"_link":{"type":"string","description":"_link"},"country":{"type":"string","maxLength":3,"description":"The country of the address.","example":"USA"}}},"postal":{"type":"string","maxLength":12,"description":"The postal of the address.","example":"44685"},"address1":{"type":"string","maxLength":254,"description":"The first line of the address.","example":"329 NEWBURY AVE NW"},"address2":{"type":"string","maxLength":254,"description":"The second line of the address."},"address3":{"type":"string","maxLength":254,"description":"The third line of the address."},"address4":{"type":"string","maxLength":254,"description":"The fourth line of the address."},"city":{"type":"string","maxLength":90,"description":"The city of the address.","example":"Uniontown"},"streetNumber1":{"type":"string","maxLength":6,"description":"The first street number line of the address."},"streetNumber2":{"type":"string","maxLength":4,"description":"The second street number line of the address."},"county":{"type":"string","maxLength":90,"description":"The county of the address."},"state":{"type":"string","maxLength":6,"description":"The state of the address.","example":"OH"}}},"estimationEligibility":{"type":"string","enum":["D1EL","D1NE"],"description":"Periodic estimation Eligibility determines if measuring component is eligible for estimation.\n* `D1EL` - Eligible,\n* `D1NE` - Not Eligible","example":"D1EL"},"accessGroup":{"type":"object","description":"Access Group","properties":{"_link":{"type":"string","description":"_link"},"accessGroup":{"type":"string","maxLength":12,"description":"Access Group"}}},"statusDateTime":{"type":"string","format":"date-time","description":"Status Date/Time","example":"2012-01-19T03:25:38-08:00"},"creationDateTime":{"type":"string","format":"date-time","description":"Create Date/Time","example":"2012-01-19T03:25:38-08:00"},"geographicLatitude":{"type":"number","maximum":999999999.999999,"minimum":-999999999.999999,"description":"Geographic Latitude displays the geographic latitude information that defines where the service point is located.","example":"40.779680"},"geographicLongitude":{"type":"number","maximum":999999999.999999,"minimum":-999999999.999999,"description":"Geographic Longitude displays the geographic longitude information that defines where the service point is located.","example":"-81.399990"},"lifeSupportSensitiveLoad":{"type":"string","enum":["ZZLS","ZZNC","ZZNL"],"description":"Indicates if the current service point supplies service to life support equipment (or if the load supplied to the service point is considered sensitive).\n* `ZZLS` - On life support,\n* `ZZNC` - None,\n* `ZZNL` - Not on life support","example":"ZZNL"},"lifeSupportSensitiveLoadDescription":{"type":"string","maxLength":4000,"description":"Life Support sensitive load description","example":"Not on life support"},"okToEnter":{"type":"string","enum":["ZZCIT1","false","true","ZZYES","ZZNO"],"description":"Turn on OK to Enter if the meter is located in the interior of the premise and your company has permission to enter.\n* `ZZCIT1` - Test CIT,\n* `false` - False,\n* `true` - True,\n* `ZZYES` - Yes,\n* `ZZNO` - No","example":"false"},"spWarning":{"type":"string","enum":["ZZ-BADDOG","ZZWARN","ZZCAT","ZZNEIG","ZZRS","ZZDIVE","ZZDANG","ZZSW"],"description":"Indicate a SP Warning if a specific warning should be downloaded to the person who reads the meter.\n* `ZZ-BADDOG` - BAD DOG,\n* `ZZWARN` - Test Warn,\n* `ZZCAT` - Mean cat at premise,\n* `ZZNEIG` - Suspicious neighbor,\n* `ZZRS` - ZZRS,\n* `ZZDIVE` - History of service diversion,\n* `ZZDANG` - Suspect dangerous occupants,\n* `ZZSW` - ZZSW","example":"ZZDANG"},"spInstruction":{"type":"string","enum":["ZZ-SPI","ZZLRC","ZZSPINSTR","ZZTEST14521","ZZCON","ZZCHKSEAL","ZZSER"],"description":"Indicate a SP Instruction if specific instructions should be downloaded to the person who reads the meter.\n* `ZZ-SPI` - ZZ-SPI,\n* `ZZLRC` - Leave read card with customer,\n* `ZZSPINSTR` - Test SPINSTR,\n* `ZZTEST14521` - test,\n* `ZZCON` - Verify constant,\n* `ZZCHKSEAL` - Check Seal,\n* `ZZSER` - Verify serial number","example":"ZZCHKSEAL"},"spInstructionDetails":{"type":"string","maxLength":250,"description":"SP Instruction Details provides more detailed instructions to the individual who reads meters at this premise.","example":"Suspect Dangerous occupants"},"key":{"type":"string","enum":["ZZKEY","ZZ-KEY2","false","true","ZZYES","ZZNO"],"description":"Key\n* `ZZKEY` - Test Key,\n* `ZZ-KEY2` - Test Key 2,\n* `false` - No,\n* `true` - Yes,\n* `ZZYES` - Yes,\n* `ZZNO` - No","example":"ZZNO"},"keyId":{"type":"string","maxLength":30,"description":"Specify the Key ID if the meter is secured in a locked area and your company has the key.","example":"No key at premise"},"deviceLocation":{"type":"string","enum":["ZZCIT","ZZGR","ZZBK","ZZSR","ZZRS","ZZLS"],"description":"Device Location is used to define where the service point is located on the premise.\n* `ZZCIT` - Test CIT,\n* `ZZGR` - Garage,\n* `ZZBK` - Backyard,\n* `ZZSR` - SR related location,\n* `ZZRS` - Right Side,\n* `ZZLS` - Left Side","example":"ZZBK"},"deviceLocationDetails":{"type":"string","maxLength":250,"description":"Location Details are used to clarify the location at the premise."},"measurementCycle":{"type":"object","description":"Measurement Cycle specifies the schedule used for when the service point is visited and the the device read.","properties":{"_link":{"type":"string","description":"_link"},"measurementCycle":{"type":"string","maxLength":30,"description":"Measurement Cycle specifies the schedule used for when the service point is visited and the the device read.","example":"MONTHLYDAY1"}}},"measurementCycleRoute":{"type":"string","maxLength":30,"description":"Route specifies the group of service points in a cycle that are visited by a meter reader.","example":"R1"},"measurementCycleRouteSequence":{"type":"number","maximum":999999999,"minimum":-999999999,"description":"Sequence"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks.","example":"5"},"equipment":{"type":"object","properties":{"equipmentList":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"equipment":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"equipmentId":{"type":"string","maxLength":12,"description":"Device ID"}}},"installDateTime":{"type":"string","format":"date-time","description":"Date of the installation of the service point connection at the premise.","example":"2007-06-1"},"removalDateTime":{"type":"string","format":"date-time","description":"Defines the date that the equipment was removed from the service point.","example":"2007-06-1"},"equipmentCount":{"type":"number","maximum":999999999.99,"minimum":0,"description":"Equipment Count This field should be 1 except when you are using an item to define a generic piece of equipment. If you use an item to define a generic piece of equipment, you can indicate the number of such generic pieces of equipment that are associated with this service point.","example":"1.00"},"comments":{"type":"string","maxLength":254,"description":"Use comments to explain anything unusual about the piece of equipment."},"crew":{"type":"string","maxLength":60,"description":"Crew"}}}}}}}},"multiItems":{"type":"object","properties":{"multiItemList":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"startDateTime":{"type":"string","format":"date-time","description":"The Start Date/time of the multi-item list."},"endDateTime":{"type":"string","format":"date-time","description":"The End Date/Time of the multi-item list."},"installationOverrideQuantity":{"type":"number","maximum":9999999999.999998,"minimum":-9999999999.999998,"description":"Installation Override Quantity"},"uom":{"type":"string","maxLength":30,"description":"A metric of how measurement data is measured (i.e. kWh, kVARh, CCF, etc.)"},"sqi":{"type":"string","maxLength":30,"description":"Used to further distinguish between measured quantities that have identical UOM/TOU combinations (i.e. Generated, Consumed, etc.)"},"multiItemCounts":{"type":"object","properties":{"multiItemCountList":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"itemType":{"type":"string","maxLength":30,"description":"Indicates the type of item","example":"CT BADGE"},"count":{"type":"number","maximum":999999999.99,"minimum":-999999999.99,"description":"Indicates how many of the given type of item exist at the service point.","example":"1.00"}}}}}}}}}}}}}}},"marketParticipants":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"serviceProvider":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"serviceProvider":{"type":"string","maxLength":30,"description":"Service Provider"}}},"marketRelationshipType":{"type":"string","enum":["ZZDE","ZZDS","ZZDT","ZZRT","ZZSE","ZZSU"],"description":"Markets define market relationships for valid service providers and their roles within a market (distributor, etc.).\n* `ZZDE` - Distributor Type,\n* `ZZDS` - Distributor,\n* `ZZDT` - Distributor Type2,\n* `ZZRT` - Retailer,\n* `ZZSE` - Scheduling Entity,\n* `ZZSU` - Supplier","example":"ZZDE"},"startDateTime":{"type":"string","format":"date-time","description":"The Start Date/time of the multi-item list."},"endDateTime":{"type":"string","format":"date-time","description":"The End Date/Time of the multi-item list."}}}}}}},"xml":{"name":"D1ServPoint"}},"CREATESERVICEPOINT_response":{"type":"object","properties":{"_self":{"type":"string","description":"_self"},"servicePointId":{"type":"string","maxLength":12,"description":"Service Point ID"},"servicePointType":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"servicePointType":{"type":"string","maxLength":30,"description":"Service Point Type"}}},"division":{"type":"object","description":"Divisions are used to delineate between different operating companies within a large conglomerate of utilities.","properties":{"_link":{"type":"string","description":"_link"},"division":{"type":"string","maxLength":30,"description":"Divisions are used to delineate between different operating companies within a large conglomerate of utilities.","example":"CA"}}},"status":{"type":"string","maxLength":12,"description":"The current status of the service point.","example":"ACTIVE"},"timeZone":{"type":"object","description":"Enter the Time Zone in which the premise is located.","properties":{"_link":{"type":"string","description":"_link"},"timeZone":{"type":"string","maxLength":10,"description":"Enter the Time Zone in which the premise is located.","example":"USPACIFIC"}}},"market":{"type":"object","description":"Defines jurisdictions or regulatory environments in which a Service Point participates.","properties":{"_link":{"type":"string","description":"_link"},"market":{"type":"string","maxLength":30,"description":"Defines jurisdictions or regulatory environments in which a Service Point participates.","example":"ZZ_SMSR_MKT10111024"}}},"parentServicePoint":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"parentServicePointId":{"type":"string","maxLength":12,"description":"Related Service Point"}}},"sourceStatus":{"type":"string","enum":["D1CN","D1DC"],"description":"Service Point Source Status defines whether the service point is connected to the source of power. Valid values are: Connected and Disconnected.\n* `D1CN` - Connected,\n* `D1DC` - Disconnected","example":"D1CN"},"disconnectLocation":{"type":"string","enum":["D1DV","D1SR"],"description":"If the Service point source status is disconnected, use Disconnect Location to specify where service was severed.\n* `D1DV` - Device,\n* `D1SR` - Source","example":"D1SR"},"externalServicePointId":{"type":"string","maxLength":60,"description":"External Service Point ID defines External Systems with which Oracle Utilities Meter Data Management should be able to communicate.","example":"0979106595"},"externalPremiseId":{"type":"string","maxLength":60,"description":"External Premise ID","example":"0979106528"},"mainContact":{"type":"string","maxLength":12,"description":"The main contact for the service provider."},"primaryUsageSubscriptionId":{"type":"string","maxLength":12,"description":"Usage Subscription ID is a system assigned random number that stays with a usage subscription record."},"assetLocationId":{"type":"string","maxLength":120,"description":"Asset System SP ID"},"mdmExternalId":{"type":"string","maxLength":60,"description":"MDM External ID"},"distributionNetworkFacility":{"type":"string","maxLength":14,"description":"Distribution Network Facility"},"address":{"type":"object","properties":{"country":{"type":"object","description":"The country of the address.","properties":{"_link":{"type":"string","description":"_link"},"country":{"type":"string","maxLength":3,"description":"The country of the address.","example":"USA"}}},"postal":{"type":"string","maxLength":12,"description":"The postal of the address.","example":"44685"},"address1":{"type":"string","maxLength":254,"description":"The first line of the address.","example":"329 NEWBURY AVE NW"},"address2":{"type":"string","maxLength":254,"description":"The second line of the address."},"address3":{"type":"string","maxLength":254,"description":"The third line of the address."},"address4":{"type":"string","maxLength":254,"description":"The fourth line of the address."},"city":{"type":"string","maxLength":90,"description":"The city of the address.","example":"Uniontown"},"streetNumber1":{"type":"string","maxLength":6,"description":"The first street number line of the address."},"streetNumber2":{"type":"string","maxLength":4,"description":"The second street number line of the address."},"county":{"type":"string","maxLength":90,"description":"The county of the address."},"state":{"type":"string","maxLength":6,"description":"The state of the address.","example":"OH"}}},"estimationEligibility":{"type":"string","enum":["D1EL","D1NE"],"description":"Periodic estimation Eligibility determines if measuring component is eligible for estimation.\n* `D1EL` - Eligible,\n* `D1NE` - Not Eligible","example":"D1EL"},"accessGroup":{"type":"object","description":"Access Group","properties":{"_link":{"type":"string","description":"_link"},"accessGroup":{"type":"string","maxLength":12,"description":"Access Group"}}},"statusDateTime":{"type":"string","format":"date-time","description":"Status Date/Time","example":"2012-01-19T03:25:38-08:00"},"creationDateTime":{"type":"string","format":"date-time","description":"Create Date/Time","example":"2012-01-19T03:25:38-08:00"},"geographicLatitude":{"type":"number","maximum":999999999.999999,"minimum":-999999999.999999,"description":"Geographic Latitude displays the geographic latitude information that defines where the service point is located.","example":"40.779680"},"geographicLongitude":{"type":"number","maximum":999999999.999999,"minimum":-999999999.999999,"description":"Geographic Longitude displays the geographic longitude information that defines where the service point is located.","example":"-81.399990"},"lifeSupportSensitiveLoad":{"type":"string","enum":["ZZLS","ZZNC","ZZNL"],"description":"Indicates if the current service point supplies service to life support equipment (or if the load supplied to the service point is considered sensitive).\n* `ZZLS` - On life support,\n* `ZZNC` - None,\n* `ZZNL` - Not on life support","example":"ZZNL"},"lifeSupportSensitiveLoadDescription":{"type":"string","maxLength":4000,"description":"Life Support sensitive load description","example":"Not on life support"},"okToEnter":{"type":"string","enum":["ZZCIT1","false","true","ZZYES","ZZNO"],"description":"Turn on OK to Enter if the meter is located in the interior of the premise and your company has permission to enter.\n* `ZZCIT1` - Test CIT,\n* `false` - False,\n* `true` - True,\n* `ZZYES` - Yes,\n* `ZZNO` - No","example":"false"},"spWarning":{"type":"string","enum":["ZZ-BADDOG","ZZWARN","ZZCAT","ZZNEIG","ZZRS","ZZDIVE","ZZDANG","ZZSW"],"description":"Indicate a SP Warning if a specific warning should be downloaded to the person who reads the meter.\n* `ZZ-BADDOG` - BAD DOG,\n* `ZZWARN` - Test Warn,\n* `ZZCAT` - Mean cat at premise,\n* `ZZNEIG` - Suspicious neighbor,\n* `ZZRS` - ZZRS,\n* `ZZDIVE` - History of service diversion,\n* `ZZDANG` - Suspect dangerous occupants,\n* `ZZSW` - ZZSW","example":"ZZDANG"},"spInstruction":{"type":"string","enum":["ZZ-SPI","ZZLRC","ZZSPINSTR","ZZTEST14521","ZZCON","ZZCHKSEAL","ZZSER"],"description":"Indicate a SP Instruction if specific instructions should be downloaded to the person who reads the meter.\n* `ZZ-SPI` - ZZ-SPI,\n* `ZZLRC` - Leave read card with customer,\n* `ZZSPINSTR` - Test SPINSTR,\n* `ZZTEST14521` - test,\n* `ZZCON` - Verify constant,\n* `ZZCHKSEAL` - Check Seal,\n* `ZZSER` - Verify serial number","example":"ZZCHKSEAL"},"spInstructionDetails":{"type":"string","maxLength":250,"description":"SP Instruction Details provides more detailed instructions to the individual who reads meters at this premise.","example":"Suspect Dangerous occupants"},"key":{"type":"string","enum":["ZZKEY","ZZ-KEY2","false","true","ZZYES","ZZNO"],"description":"Key\n* `ZZKEY` - Test Key,\n* `ZZ-KEY2` - Test Key 2,\n* `false` - No,\n* `true` - Yes,\n* `ZZYES` - Yes,\n* `ZZNO` - No","example":"ZZNO"},"keyId":{"type":"string","maxLength":30,"description":"Specify the Key ID if the meter is secured in a locked area and your company has the key.","example":"No key at premise"},"deviceLocation":{"type":"string","enum":["ZZCIT","ZZGR","ZZBK","ZZSR","ZZRS","ZZLS"],"description":"Device Location is used to define where the service point is located on the premise.\n* `ZZCIT` - Test CIT,\n* `ZZGR` - Garage,\n* `ZZBK` - Backyard,\n* `ZZSR` - SR related location,\n* `ZZRS` - Right Side,\n* `ZZLS` - Left Side","example":"ZZBK"},"deviceLocationDetails":{"type":"string","maxLength":250,"description":"Location Details are used to clarify the location at the premise."},"measurementCycle":{"type":"object","description":"Measurement Cycle specifies the schedule used for when the service point is visited and the the device read.","properties":{"_link":{"type":"string","description":"_link"},"measurementCycle":{"type":"string","maxLength":30,"description":"Measurement Cycle specifies the schedule used for when the service point is visited and the the device read.","example":"MONTHLYDAY1"}}},"measurementCycleRoute":{"type":"string","maxLength":30,"description":"Route specifies the group of service points in a cycle that are visited by a meter reader.","example":"R1"},"measurementCycleRouteSequence":{"type":"number","maximum":999999999,"minimum":-999999999,"description":"Sequence"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks.","example":"5"},"equipment":{"type":"object","properties":{"equipmentList":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"equipment":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"equipmentId":{"type":"string","maxLength":12,"description":"Device ID"}}},"installDateTime":{"type":"string","format":"date-time","description":"Date of the installation of the service point connection at the premise.","example":"2007-06-1"},"removalDateTime":{"type":"string","format":"date-time","description":"Defines the date that the equipment was removed from the service point.","example":"2007-06-1"},"equipmentCount":{"type":"number","maximum":999999999.99,"minimum":0,"description":"Equipment Count This field should be 1 except when you are using an item to define a generic piece of equipment. If you use an item to define a generic piece of equipment, you can indicate the number of such generic pieces of equipment that are associated with this service point.","example":"1.00"},"comments":{"type":"string","maxLength":254,"description":"Use comments to explain anything unusual about the piece of equipment."},"crew":{"type":"string","maxLength":60,"description":"Crew"}}}}}}}},"multiItems":{"type":"object","properties":{"multiItemList":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"startDateTime":{"type":"string","format":"date-time","description":"The Start Date/time of the multi-item list."},"endDateTime":{"type":"string","format":"date-time","description":"The End Date/Time of the multi-item list."},"installationOverrideQuantity":{"type":"number","maximum":9999999999.999998,"minimum":-9999999999.999998,"description":"Installation Override Quantity"},"uom":{"type":"string","maxLength":30,"description":"A metric of how measurement data is measured (i.e. kWh, kVARh, CCF, etc.)"},"sqi":{"type":"string","maxLength":30,"description":"Used to further distinguish between measured quantities that have identical UOM/TOU combinations (i.e. Generated, Consumed, etc.)"},"multiItemCounts":{"type":"object","properties":{"multiItemCountList":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"itemType":{"type":"string","maxLength":30,"description":"Indicates the type of item","example":"CT BADGE"},"count":{"type":"number","maximum":999999999.99,"minimum":-999999999.99,"description":"Indicates how many of the given type of item exist at the service point.","example":"1.00"}}}}}}}}}}}}}}},"marketParticipants":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"serviceProvider":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"serviceProvider":{"type":"string","maxLength":30,"description":"Service Provider"}}},"marketRelationshipType":{"type":"string","enum":["ZZDE","ZZDS","ZZDT","ZZRT","ZZSE","ZZSU"],"description":"Markets define market relationships for valid service providers and their roles within a market (distributor, etc.).\n* `ZZDE` - Distributor Type,\n* `ZZDS` - Distributor,\n* `ZZDT` - Distributor Type2,\n* `ZZRT` - Retailer,\n* `ZZSE` - Scheduling Entity,\n* `ZZSU` - Supplier","example":"ZZDE"},"startDateTime":{"type":"string","format":"date-time","description":"The Start Date/time of the multi-item list."},"endDateTime":{"type":"string","format":"date-time","description":"The End Date/Time of the multi-item list."}}}}}}},"xml":{"name":"D1ServPoint"}},"SYNCPERSON_response":{"type":"object","properties":{"personId":{"type":"string","maxLength":10,"description":"Person ID"},"contactDetails":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"contactPointId":{"type":"string","maxLength":10,"description":"Person Contact"},"personContactType":{"type":"string","maxLength":30,"description":"Person Contact Type"},"contactDetailValue":{"type":"string","maxLength":254,"description":"Contact Information"},"contactDetailValueExtension":{"type":"string","maxLength":6,"description":"Extension"},"contactDetailPrimary":{"type":"string","enum":["C1NO","C1YS"],"description":"(contactDetailPrimary):\n* `C1NO` - No,\n* `C1YS` - Yes"},"status":{"type":"string","enum":["C1AC","C1IN"],"description":"(contactDetailActiveInactive):\n* `C1AC` - Active,\n* `C1IN` - Inactive"},"contactExternalId":{"type":"string","maxLength":254,"description":"External ID"}}}}}},"updatedPersonId":{"type":"string","maxLength":10,"description":"Person ID"}},"xml":{"name":"C1CXPerSync"}},"SYNCPERSON_request":{"type":"object","properties":{"personId":{"type":"string","maxLength":10,"description":"Person ID"},"cxContactId":{"type":"string","description":"(cxContactId)"},"personOrBusiness":{"type":"string","enum":["B   ","P   "],"description":"Person/Business indicates if the entity is a person or a business. Valid values are: Person, Business . This value controls how the person's primary name is validated.\n* `B   ` - Business,\n* `P   ` - Person","example":"P"},"primaryName":{"type":"string","maxLength":254,"description":"A person's primary name is the addressee on the person's bill unless overridden by the Override Mailing Name.","example":"Reddy,John"},"firstName":{"type":"string","maxLength":254,"description":"Person's First Name.","example":"John"},"lastName":{"type":"string","maxLength":254,"description":"Person's Last Name.","example":"Reddy"},"contactDetails":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"contactPointId":{"type":"string","maxLength":10,"description":"Person Contact"},"personContactType":{"type":"string","maxLength":30,"description":"Person Contact Type"},"contactDetailValue":{"type":"string","maxLength":254,"description":"Contact Information"},"contactDetailValueExtension":{"type":"string","maxLength":6,"description":"Extension"},"contactDetailPrimary":{"type":"string","enum":["C1NO","C1YS"],"description":"(contactDetailPrimary):\n* `C1NO` - No,\n* `C1YS` - Yes"},"status":{"type":"string","enum":["C1AC","C1IN"],"description":"(contactDetailActiveInactive):\n* `C1AC` - Active,\n* `C1IN` - Inactive"},"contactExternalId":{"type":"string","maxLength":254,"description":"External ID"}}}}}},"characteristics":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"characteristicType":{"type":"string","maxLength":8,"description":"Characteristic Type"},"characteristicValue":{"type":"string","maxLength":254,"description":"Adhoc Characteristic Value"}}}}}}},"xml":{"name":"C1CXPerSync"}},"GETCUSTOMERACTIVITYHISTORY_response":{"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":"1589809888"},"fromDateTime":{"type":"string","format":"date-time","description":"From Date Time is a required input of date range for which the customer activity history is returned."},"toDateTime":{"type":"string","format":"date-time","description":"To Date Time is a required input of date range for which the customer activity history is returned."},"limit":{"type":"number","maximum":99999,"minimum":0,"description":"The limit element is an integer value that specifies the paging size for number of records to return when serving a client request.","example":"20"},"interactions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","maxLength":14,"description":"Unique identifier of the row.  This is a concatenation of the \"activity type\" and the entity PK 1-5.","example":"BL549134324111"},"interactionDateTime":{"type":"string","format":"date-time","description":"Account Activity Date Time","example":"2008-11-01T00:00:00-04:00"},"interactionType":{"type":"string","maxLength":2,"description":"Account Activity Type","example":"BL"},"primaryText":{"type":"string","maxLength":1000,"description":"Primary text","example":"Bill for $1002.43"},"secondaryText":{"type":"string","maxLength":1000,"description":"Secondary text","example":"Due 11-17-2008"},"tertiaryText":{"type":"string","maxLength":1000,"description":"Tertiary text","example":"1037 days in bill period"},"displayIconOracle":{"type":"string","maxLength":12,"description":"Icon Name from Redwood library for example \"ico-contacts.svg\", \"ico-check.svg\". This is the URL value from the display icon reference code definition.","example":"ico-financials.svg"},"navigationInfo":{"type":"object","properties":{"navigationType":{"type":"string","description":"(navigationType)"},"navigationContext":{"type":"string","description":"(navigationContext)"}}}}}},"interactionTypes":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","maxLength":12,"description":"List of Interaction Type Codes for the client to use upon rendering."},"description":{"type":"string","description":"(description)"},"displayIconOracle":{"type":"string","maxLength":12,"description":"Icon Name from Redwood library for example \"ico-contacts.svg\", \"ico-check.svg\". This is the URL value from the display icon reference code definition.","example":"ico-financials.svg"},"tags":{"type":"string","description":"(tags)"}}}}},"xml":{"name":"C1-GtCuAcHi"}},"GETWORKQUEUE_response":{"type":"object","properties":{"rowCount":{"type":"number","maximum":99999,"minimum":0,"description":"Row Count","example":"8"},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","maxLength":12,"description":"ID is the system-assigned unique identifier of the entry.","example":"32234000828888"},"title":{"type":"string","maxLength":60,"description":"Title contains a description of the To Do entry.","example":"$3,000.00 KC - Approval Test adjustment for Black,Jack requires approval."},"severity":{"type":"string","maxLength":6,"description":"A To Do entry is associated with a priority level representing its relative processing order compared to other entries.","example":"010"},"severityLabel":{"type":"string","maxLength":60,"description":"Priority level description for ToDo entry.","example":"Priority 10 -- Highest"},"status":{"type":"string","maxLength":12,"description":"Status"},"statusLabel":{"type":"string","maxLength":12,"description":"Status"},"itemType":{"type":"string","maxLength":30,"description":"Item Type displays a code of the To Do type for the To Do entry.","example":"C1-ADAPP"},"itemTypeLabel":{"type":"string","maxLength":60,"description":"Item Description contains a description of the To Do type for the To Do entry.","example":"Adjustments Requiring Approval"},"updateDateTime":{"type":"string","format":"date-time","description":"Create Date/Time contains the date and time the To Do entry was created by the system.","example":"2013-08-28-01.20.46"},"displayIconOracle":{"type":"string","maxLength":12,"description":"Icon Name from Redwood library for example \"ico-contacts.svg\", \"ico-check.svg\". This is the URL value from the display icon reference code definition.","example":"ico-financials.svg"},"navigationInfo":{"type":"object","properties":{"navigationType":{"type":"string","description":"(navigationType)"},"navigationContext":{"type":"string","description":"(navigationContext)"}}}}}}},"xml":{"name":"C1WorkQueue"}},"UPDATEMAILINGADDRESSES_response":{"type":"object","properties":{"seasonalAddresses":{"type":"array","items":{"type":"object","properties":{"sequence":{"type":"number","maximum":999,"minimum":-999,"description":"Sequence if the notification type is a subscription that allows for an option to be set.","example":"10"},"seasonStart":{"type":"string","maxLength":4,"description":"Season Start"},"seasonEnd":{"type":"string","maxLength":4,"description":"Season End"},"address":{"type":"object","properties":{}},"effectiveStatus":{"type":"string","enum":["A   ","I   "],"description":"Status:\n* `A   ` - Active,\n* `I   ` - Inactive"},"delete":{"type":"boolean","description":"To Delete"}}}},"mailingAddress":{"type":"object","properties":{"updateAction":{"type":"string","enum":["NEW ","PER ","PREM"],"description":"Address Source Flag for CX:\n* `NEW ` - New Address,\n* `PER ` - Person,\n* `PREM` - Mailing Premise on  Account"},"address":{"type":"object","properties":{}}}}},"xml":{"name":"C1MainMailAd"}},"PATCHCOMMUNICATIONSPREFERENCES_response":{"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":"0833559999"},"personId":{"type":"string","maxLength":10,"description":"Person ID is a system-assigned random number that stays with a person for the life of the system.","example":"3903069999"},"notificationTypeList":{"type":"array","items":{"type":"object","properties":{"notificationType":{"type":"string","maxLength":30,"description":"Notification Type displays code for the notification preferences for the customer in context.","example":"ZZBUG23605115"},"notificationTypeDescription":{"type":"string","maxLength":100,"description":"Notification Type displays description for the notification preferences for the customer in context.","example":"Test for Bug 23605115"},"isOptOutAllowed":{"type":"boolean","description":"(isOptOutAllowed)"},"isOptedOut":{"type":"boolean","description":"(isOptedOut)"},"optOutPreferenceId":{"type":"string","maxLength":14,"description":"Communication Preference Id"},"subscriptionOrPush":{"type":"string","enum":["C1PU","C1SU"],"description":"Subscription/Push flag displays if is it a push or a subscription type of notification.\n* `C1PU` - Push,\n* `C1SU` - Subscription","example":"C1PU"},"notificationOption":{"type":"array","description":"If the notification type is a subscription, an optional list of notification option extension fields to capture","items":{"type":"object","properties":{}}},"notificationPreferenceList":{"type":"array","description":"A list of eligible contact preferences. This list includes all valid contact details for the person that are valid for the notification type and delivery type. If a contact reference is valid for multiple delivery types then it appears as multiple types","items":{"type":"object","properties":{"deliveryType":{"type":"string","enum":["EMAI","FAX ","IVR ","SMS "],"description":"Delivery type\n* `EMAI` - Email,\n* `FAX ` - Fax,\n* `IVR ` - IVR,\n* `SMS ` - SMS","example":"SMS"},"deliveryTypeDescription":{"type":"string","maxLength":60,"description":"Delivery type description","example":"SMS"},"contactDetailId":{"type":"string","maxLength":10,"description":"Person contact details ID","example":"3904719666"},"contactDetailValue":{"type":"string","maxLength":254,"description":"Person contact details value","example":"1234567"},"nickname":{"type":"string","maxLength":100,"description":"Person contact details nickname"},"notificationPreferenceId":{"type":"string","maxLength":14,"description":"Communication Preference Id"},"keepPreference":{"type":"boolean","description":"(keepPreference)"}}}}}}},"httpMethod":{"type":"string","enum":["DELT","GET ","POST","PTCH","PUT "],"description":"HTTP Method:\n* `DELT` - Delete,\n* `GET ` - Get,\n* `POST` - Post,\n* `PTCH` - Patch,\n* `PUT ` - Put"}},"xml":{"name":"C1ComPrefer"}},"UPDATEMAILINGADDRESSES_request":{"type":"object","properties":{"seasonalAddresses":{"type":"array","items":{"type":"object","properties":{"sequence":{"type":"number","maximum":999,"minimum":-999,"description":"Sequence if the notification type is a subscription that allows for an option to be set.","example":"10"},"seasonStart":{"type":"string","maxLength":4,"description":"Season Start"},"seasonEnd":{"type":"string","maxLength":4,"description":"Season End"},"address":{"type":"object","properties":{}},"effectiveStatus":{"type":"string","enum":["A   ","I   "],"description":"Status:\n* `A   ` - Active,\n* `I   ` - Inactive"},"delete":{"type":"boolean","description":"To Delete"}}}},"mailingAddress":{"type":"object","properties":{"updateAction":{"type":"string","enum":["NEW ","PER ","PREM"],"description":"Address Source Flag for CX:\n* `NEW ` - New Address,\n* `PER ` - Person,\n* `PREM` - Mailing Premise on  Account"},"address":{"type":"object","properties":{}}}}},"xml":{"name":"C1MainMailAd"}},"GETMAILINGADDRESSES_response":{"type":"object","properties":{"addressSource":{"type":"string","enum":["ACOV","PER ","PREM"],"description":"Bill Address Source:\n* `ACOV` - Account Override,\n* `PER ` - Person,\n* `PREM` - Mailing Premise on  Account"},"premiseAddress":{"type":"object","properties":{}},"accountAddress":{"type":"object","properties":{}},"personAddress":{"type":"object","properties":{}},"personSeasonalAddress":{"type":"array","items":{"type":"object","properties":{"address":{"type":"object","properties":{}},"sequence":{"type":"number","maximum":999,"minimum":-999,"description":"Sequence if the notification type is a subscription that allows for an option to be set.","example":"10"},"seasonStartTime":{"type":"string","maxLength":4,"description":"Season Start"},"seasonEndTime":{"type":"string","maxLength":4,"description":"Season End"},"status":{"type":"string","enum":["A   ","I   "],"description":"Status:\n* `A   ` - Active,\n* `I   ` - Inactive"},"inEffect":{"type":"boolean","description":"In Effect"}}}},"currentMailingAddress":{"type":"object","properties":{}},"numberOfOtherAccounts":{"type":"number","maximum":99999,"minimum":0,"description":"Number of Accounts Linked"}},"xml":{"name":"C1GetMailAdd"}},"PATCHCOMMUNICATIONSPREFERENCES_request":{"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":"0833559999"},"personId":{"type":"string","maxLength":10,"description":"Person ID is a system-assigned random number that stays with a person for the life of the system.","example":"3903069999"},"notificationTypeList":{"type":"array","items":{"type":"object","properties":{"notificationType":{"type":"string","maxLength":30,"description":"Notification Type displays code for the notification preferences for the customer in context.","example":"ZZBUG23605115"},"notificationTypeDescription":{"type":"string","maxLength":100,"description":"Notification Type displays description for the notification preferences for the customer in context.","example":"Test for Bug 23605115"},"isOptOutAllowed":{"type":"boolean","description":"(isOptOutAllowed)"},"isOptedOut":{"type":"boolean","description":"(isOptedOut)"},"optOutPreferenceId":{"type":"string","maxLength":14,"description":"Communication Preference Id"},"subscriptionOrPush":{"type":"string","enum":["C1PU","C1SU"],"description":"Subscription/Push flag displays if is it a push or a subscription type of notification.\n* `C1PU` - Push,\n* `C1SU` - Subscription","example":"C1PU"},"notificationOption":{"type":"array","description":"If the notification type is a subscription, an optional list of notification option extension fields to capture","items":{"type":"object","properties":{}}},"notificationPreferenceList":{"type":"array","description":"A list of eligible contact preferences. This list includes all valid contact details for the person that are valid for the notification type and delivery type. If a contact reference is valid for multiple delivery types then it appears as multiple types","items":{"type":"object","properties":{"deliveryType":{"type":"string","enum":["EMAI","FAX ","IVR ","SMS "],"description":"Delivery type\n* `EMAI` - Email,\n* `FAX ` - Fax,\n* `IVR ` - IVR,\n* `SMS ` - SMS","example":"SMS"},"deliveryTypeDescription":{"type":"string","maxLength":60,"description":"Delivery type description","example":"SMS"},"contactDetailId":{"type":"string","maxLength":10,"description":"Person contact details ID","example":"3904719666"},"contactDetailValue":{"type":"string","maxLength":254,"description":"Person contact details value","example":"1234567"},"nickname":{"type":"string","maxLength":100,"description":"Person contact details nickname"},"notificationPreferenceId":{"type":"string","maxLength":14,"description":"Communication Preference Id"},"keepPreference":{"type":"boolean","description":"(keepPreference)"}}}}}}},"httpMethod":{"type":"string","enum":["DELT","GET ","POST","PTCH","PUT "],"description":"HTTP Method:\n* `DELT` - Delete,\n* `GET ` - Get,\n* `POST` - Post,\n* `PTCH` - Patch,\n* `PUT ` - Put"}},"xml":{"name":"C1ComPrefer"}},"GETCOMMUNICATIONSPREFERENCES_response":{"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":"0833559999"},"personId":{"type":"string","maxLength":10,"description":"Person ID is a system-assigned random number that stays with a person for the life of the system.","example":"3903069999"},"notificationTypeList":{"type":"array","items":{"type":"object","properties":{"notificationType":{"type":"string","maxLength":30,"description":"Notification Type displays code for the notification preferences for the customer in context.","example":"ZZBUG23605115"},"notificationTypeDescription":{"type":"string","maxLength":100,"description":"Notification Type displays description for the notification preferences for the customer in context.","example":"Test for Bug 23605115"},"isOptOutAllowed":{"type":"boolean","description":"(isOptOutAllowed)"},"isOptedOut":{"type":"boolean","description":"(isOptedOut)"},"optOutPreferenceId":{"type":"string","maxLength":14,"description":"Communication Preference Id"},"subscriptionOrPush":{"type":"string","enum":["C1PU","C1SU"],"description":"Subscription/Push flag displays if is it a push or a subscription type of notification.\n* `C1PU` - Push,\n* `C1SU` - Subscription","example":"C1PU"},"notificationOption":{"type":"array","description":"If the notification type is a subscription, an optional list of notification option extension fields to capture","items":{"type":"object","properties":{}}},"notificationPreferenceList":{"type":"array","description":"A list of eligible contact preferences. This list includes all valid contact details for the person that are valid for the notification type and delivery type. If a contact reference is valid for multiple delivery types then it appears as multiple types","items":{"type":"object","properties":{"deliveryType":{"type":"string","enum":["EMAI","FAX ","IVR ","SMS "],"description":"Delivery type\n* `EMAI` - Email,\n* `FAX ` - Fax,\n* `IVR ` - IVR,\n* `SMS ` - SMS","example":"SMS"},"deliveryTypeDescription":{"type":"string","maxLength":60,"description":"Delivery type description","example":"SMS"},"contactDetailId":{"type":"string","maxLength":10,"description":"Person contact details ID","example":"3904719666"},"contactDetailValue":{"type":"string","maxLength":254,"description":"Person contact details value","example":"1234567"},"nickname":{"type":"string","maxLength":100,"description":"Person contact details nickname"},"notificationPreferenceId":{"type":"string","maxLength":14,"description":"Communication Preference Id"},"keepPreference":{"type":"boolean","description":"(keepPreference)"}}}}}}},"httpMethod":{"type":"string","enum":["DELT","GET ","POST","PTCH","PUT "],"description":"HTTP Method:\n* `DELT` - Delete,\n* `GET ` - Get,\n* `POST` - Post,\n* `PTCH` - Patch,\n* `PUT ` - Put"}},"xml":{"name":"C1ComPrefer"}},"CREATEBILL_request":{"type":"object","properties":{"billId":{"type":"string","maxLength":12,"description":"Bill ID is the system-assigned unique identifier of the bill.","example":"549133128888"},"account":{"type":"object","properties":{"accountId":{"type":"string","maxLength":10,"description":"Account ID"}}},"billStatus":{"type":"string","enum":["C   ","P   "],"description":"Bill Status is the bill's status\n* `C   ` - Complete,\n* `P   ` - Pending","example":"C"},"billDate":{"type":"string","format":"date","description":"Bill Date is the business date that was used when the bill was completed.","example":"2001-05-01"},"dueDate":{"type":"string","format":"date","description":"Due Date is the date on which the bill is due.","example":"2001-05-01"},"creationDateTime":{"type":"string","format":"date-time","description":"Create Date/Time is the date and time on which the bill was originally created.","example":"2002-10-24T16:51:58-04:00"},"completedDatetime":{"type":"string","format":"date-time","description":"Completion Date/Time is the date and time on which the bill was completed.","example":"2002-10-24T16:51:56-04:00"},"isLatePaymentCharge":{"type":"boolean","description":"Eligible for Late Payment Charge can be checked if a charge should be levied for late payment.","example":"false"},"latePaymentChargeDate":{"type":"string","format":"date","description":"Late Payment Charge Date is the date on which the system will levy a late payment charge if payment is not received.","example":"2001-05-21"},"nextCreditReviewDate":{"type":"string","format":"date","description":"Next Credit Review Date is the next date on which the account's debt will be reviewed by the account debt monitor.","example":"2001-05-21"},"billSegmentStatus":{"type":"string","maxLength":30,"description":"Bill Segment Status is the bill segment's status."},"totalGeneratedCharge":{"type":"number","maximum":0,"minimum":0,"description":"Total Generated Charge represents the total amount of the bill segments.","example":"35"},"isLatestBill":{"type":"boolean","description":"Latest Bill","example":"false"},"processDate":{"type":"string","format":"date","description":"Process Date","example":"2021-10-05"},"totalAmount":{"type":"number","description":"The Total Amount contains the sum of the current amount of these bill segments","example":"0"},"cutOffDate":{"type":"string","format":"date","description":"Cutoff Date is the last possible day of each bill period for a bill segment.","example":"2021-10-05"},"accountingDate":{"type":"string","format":"date","description":"Accounting Date defines the financial period to which the canceled and new bill segments' financial transactions are booked.","example":"2021-10-05"},"areEstimatesAllowed":{"type":"boolean","description":"Check Allow Estimates if the system is allowed to estimate consumption if it can't find a meter read.","example":"false"},"hasBillingOption":{"type":"boolean","description":"Use the Billing Option to define how the system looks for meter reads.","example":"false"},"cancelReason":{"type":"string","maxLength":4,"description":"Cancel Reason defines why the bill segment(s) are being canceled."},"creditNoteDate":{"type":"string","format":"date","description":"Bill Date is the business date that was used when the bill was completed."},"numberOfBalancedItems":{"type":"number","maximum":999999,"minimum":0,"description":"Number of Balanced Item(s) contains the count of financial transactions linked to this bill that are linked to balanced match events.","example":"0"},"balancedAmount":{"type":"number","description":"Balanced Amount contains the total amount of financial transactions linked to this bill that are linked to balanced match events.","example":"0"},"numberOfUnbalancedItems":{"type":"number","maximum":999999,"minimum":0,"description":"Number of Unbalanced Item(s) contains the count of financial transactions linked to this bill that are linked to unbalanced match events.","example":"0"},"unbalancedAmount":{"type":"number","description":"Unbalanced Amount contains total amount of financial transactions linked to this bill that are linked to unbalanced match events.","example":"0"},"numberOfDisputedItems":{"type":"number","maximum":999999,"minimum":0,"description":"Number of Disputed Item(s) contains the count of financial transactions linked to this bill that are linked to disputed match events.","example":"0"},"disputedAmount":{"type":"number","description":"Disputed  Amount contains the total amount of financial transactions linked to this bill that are linked to disputed match events.","example":"0"},"numberOfUnmatchedItems":{"type":"number","maximum":999999,"minimum":0,"description":"Number of Unmatched Item(s) contains the count of financial transactions linked to this bill that are not linked to any match event.","example":"0"},"unmatchedAmount":{"type":"number","description":"Unmatched Amount contains the total amount of financial transactions linked to this bill that are not linked to any match event.","example":"0"},"openItemTotalAdjustments":{"type":"number","description":"Total Adjustments is the total amount of frozen or canceled adjustment financial transactions linked to this bill.","example":"0"},"openItemTotalCorrections":{"type":"number","description":"Total Bill Corrections is the total amount of canceled and / or rebilled bill segment financial transactions linked to this bill","example":"0"},"openItemCurrentCharges":{"type":"number","description":"Total Current Billing Charges is the total amount of frozen bill segment financial transactions linked to this bill.","example":"0"},"fieldNamesForBillTotals":{"type":"string","description":"(fieldNamesForBillTotals)"},"fieldValueForBillTotals":{"type":"number","description":"(fieldValueForBillTotals)"},"fieldNamesForBillTotals2":{"type":"string","description":"(fieldNamesForBillTotals2)"},"fieldValueForBillTotals2":{"type":"number","description":"(fieldValueForBillTotals2)"},"fieldNamesForBillTotals3":{"type":"string","description":"(fieldNamesForBillTotals3)"},"fieldValueForBillTotals3":{"type":"number","description":"(fieldValueForBillTotals3)"},"fieldNamesForBillTotals4":{"type":"string","description":"(fieldNamesForBillTotals4)"},"fieldValueForBillTotals4":{"type":"number","description":"(fieldValueForBillTotals4)"},"fieldNamesForBillTotals5":{"type":"string","description":"(fieldNamesForBillTotals5)"},"fieldValueForBillTotals5":{"type":"number","description":"(fieldValueForBillTotals5)"},"fieldNamesForBillTotals6":{"type":"string","description":"(fieldNamesForBillTotals6)"},"fieldValueForBillTotals6":{"type":"number","description":"(fieldValueForBillTotals6)"},"fieldNamesForBillTotals7":{"type":"string","description":"(fieldNamesForBillTotals7)"},"fieldValueForBillTotals7":{"type":"number","description":"(fieldValueForBillTotals7)"},"fieldNamesForBillTotals8":{"type":"string","description":"(fieldNamesForBillTotals8)"},"fieldValueForBillTotals8":{"type":"number","description":"(fieldValueForBillTotals8)"},"fieldNamesForBillTotals9":{"type":"string","description":"(fieldNamesForBillTotals9)"},"fieldValueForBillTotals9":{"type":"number","description":"(fieldValueForBillTotals9)"},"fieldNamesForBillTotals10":{"type":"string","description":"(fieldNamesForBillTotals10)"},"fieldValueForBillTotals10":{"type":"number","description":"(fieldValueForBillTotals10)"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks.","example":"1"},"hasMore":{"type":"boolean","description":"(hasMore)"},"totalRecordsCount":{"type":"string","description":"(totalRecordsCount)"},"segments":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"hasMore":{"type":"boolean","description":"(hasMore)"},"totalRecordsCount":{"type":"string","description":"(totalRecordsCount)"},"billSegment":{"type":"object","properties":{"billSegmentId":{"type":"string","maxLength":12,"description":"Bill Segment ID"}}},"serviceAgreement":{"type":"object","properties":{"serviceAgreementId":{"type":"string","maxLength":10,"description":"Service Agreement"}}},"premise":{"type":"object","properties":{"premiseId":{"type":"string","maxLength":10,"description":"Premise ID"}}},"description":{"type":"string","maxLength":60,"description":"Description on Bill is the information about the bill line that appears on the customer's bill."},"rebill":{"type":"string","maxLength":30,"description":"Sometimes the error on a bill segment is not detected by the system and therefore the system freezes the bill segment and routes the bill to the customer. To correct such a bill segment, you must cancel the offending segment and create a new segment (after correcting the cause of the problem). This process is referred as cancel / rebill."},"currentAmount":{"type":"number","description":"Current Amount is the bill segment's effect on the service agreement's current balance.","example":"100"},"transferDescription":{"type":"string","maxLength":30,"description":"Transfer Description"},"shouldRebillAfter":{"type":"boolean","description":"Rebill after completion appears if the bill segment is a rebill that was created after the bill was sent to the customer. The financial impact of this bill segment appears as a \"bill correction\" on the next bill produced for the customer."},"isCancelAfter":{"type":"boolean","description":"Canceled after completion appears if the bill segment was canceled after the bill was sent to the customer. The financial impact of this bill segment appears as a \"bill correction\" on the next bill produced for the customer."},"shouldProtectProcess":{"type":"boolean","description":"Protect Process"},"hasProcess":{"type":"boolean","description":"Process"},"startDate":{"type":"string","format":"date","description":"Start Date - End Date is the portion of the bill segment period that the calculation details apply."},"endDate":{"type":"string","format":"date","description":"Start Date - End Date is the portion of the bill segment period that the calculation details apply."},"messageInformation":{"type":"string","maxLength":150,"description":"Message Information"},"status":{"type":"string","enum":["10  ","20  ","30  ","40  ","50  ","60  ","70  "],"description":"Bill Segment Status:\n* `10  ` - Incomplete,\n* `20  ` - Error,\n* `30  ` - Freezable,\n* `40  ` - Pending Cancel,\n* `50  ` - Frozen,\n* `60  ` - Canceled,\n* `70  ` - OK"},"billingProcessSequence":{"type":"number","maximum":999999,"minimum":-999999,"description":"Billing Processing Sequence"},"isAccountingDate":{"type":"boolean","description":"Accounting Date  is the date the system uses to determine the financial transaction's accounting period in your general ledger."},"uom":{"type":"string","maxLength":30,"description":"Unit of Measure"},"unitOfMeasureDescription":{"type":"string","maxLength":30,"description":"Unit of Measure is the description for unit of measure of the service quantity.","example":"Gallon"},"serviceQuantity":{"type":"number","maximum":1000000000000,"minimum":-1000000000000,"description":"Billable Service Quantity"},"isSATypeRequiresBillDeterminants":{"type":"boolean","description":"If the SA Type has a special role of Bill Determinants Required, you must enter the Cutoff Time and Start Day Option that is used on a bill determinants usage request."}}}}}},"billRoutings":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"person":{"type":"object","properties":{"personId":{"type":"string","maxLength":10,"description":"Person ID"}}},"billRoutingParameters":{"type":"object","properties":{"billRouteType":{"type":"object","properties":{"billRouteType":{"type":"string","maxLength":8,"description":"Bill Route Type"}}},"billFormat":{"type":"string","enum":["D   ","S   "],"description":"Bill Format Indicates if the customer should receive a detailed or a summary bill.\n* `D   ` - Detailed,\n* `S   ` - Summary","example":"D"},"copies":{"type":"number","maximum":99,"minimum":-99,"description":"Number of Bill Copies"},"sequence":{"type":"number","maximum":99999,"minimum":-99999,"description":"Sequence is the system-assigned identifier assigned to this bill routing.","example":"2"},"isReprint":{"type":"boolean","description":"Reprint"},"customerPOId":{"type":"string","maxLength":20,"description":"PO ID is the purchase order Id the customer wants printed on their copy of the bill."},"batchControl":{"type":"object","properties":{"batchControl":{"type":"string","maxLength":8,"description":"Batch Control"}}},"batchNumber":{"type":"number","maximum":9999999999,"minimum":-9999999999,"description":"Batch Number is used to view information and statistics on the batch run's \"threads\".","example":"223"},"doNotExtract":{"type":"boolean","description":"Turn on Do Not Extract if the bill should not be routed to the individual for whatever reason.","example":"false"},"billPrintIntercept":{"type":"object","properties":{"billPrintIntercept":{"type":"string","maxLength":8,"description":"User"}}}}},"billRoutingMethod":{"type":"string","enum":["EM  ","FX  ","P   "],"description":"Bill Routing Method is the method used to transmit the bill to the customer.\n* `EM  ` - Email,\n* `FX  ` - Fax,\n* `P   ` - Postal","example":"EM"},"addressInformation":{"type":"object","properties":{"name1":{"type":"string","maxLength":254,"description":"Name 1"},"name2":{"type":"string","maxLength":254,"description":"Name 2"},"name3":{"type":"string","maxLength":254,"description":"Name 3"},"country":{"type":"object","properties":{"country":{"type":"string","maxLength":3,"description":"Country"}}},"postal":{"type":"string","maxLength":12,"description":"Postal"},"address1":{"type":"string","maxLength":254,"description":"Address"},"address2":{"type":"string","maxLength":254,"description":"The second line of the address."},"address3":{"type":"string","maxLength":254,"description":"The third line of the address."},"address4":{"type":"string","maxLength":254,"description":"The fourth line of the address."},"number1":{"type":"string","maxLength":6,"description":"Number 1"},"number2":{"type":"string","maxLength":4,"description":"Number 2"},"houseType":{"type":"string","enum":["AB  ","WW  "],"description":"House Type indicates the type of house.\n* `AB  ` - House Boat References,\n* `WW  ` - House Trailer Reference","example":"House Type indicates the type of house."},"inCityLimit":{"type":"boolean","description":"In City Limit"},"geographicCode":{"type":"string","maxLength":15,"description":"Geographic code used to apply proper taxation rules to the physical address location."},"city":{"type":"string","maxLength":90,"description":"City"},"county":{"type":"string","maxLength":90,"description":"The county of the address."},"state":{"type":"string","maxLength":6,"description":"The state of the address.","example":"CA"}}}}}}}},"messages":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"billMessageCode":{"type":"object","properties":{"billMessageCode":{"type":"string","maxLength":4,"description":"Bill Message"}}},"insert":{"type":"string","maxLength":8,"description":"Insert Code defines if the bill message causes an insert in the envelope."},"messagePriority":{"type":"string","enum":["10  ","20  ","30  ","40  ","50  ","60  ","70  ","80  ","90  "],"description":"Priority is the bill messages priority (on the printed bill).\n* `10  ` - Priority 10 -- Lowest,\n* `20  ` - Priority 20,\n* `30  ` - Priority 30,\n* `40  ` - Priority 40,\n* `50  ` - Priority 50,\n* `60  ` - Priority 60,\n* `70  ` - Priority 70,\n* `80  ` - Priority 80,\n* `90  ` - Priority 90 -- Highest","example":"10"},"messageOnBill":{"type":"string","maxLength":254,"description":"Message On Bill is the message associated with the code.","example":"Please call (123) 111-9111 if you have any questions about your rate"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks.","example":"1"}}}}}},"characteristics":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"sequence":{"type":"number","maximum":999,"minimum":-999,"description":"Sequence"},"characteristicType":{"type":"object","properties":{"characteristicType":{"type":"string","maxLength":8,"description":"Characteristic Type"}}},"typeOfCharacteristicValue":{"type":"string","maxLength":4,"description":"Type of Char Value"},"characteristicValue":{"type":"object","properties":{"_link":{"type":"string","description":"(_link)"},"value":{"type":"string","description":"(value)"},"value2":{"type":"string","description":"(value2)"},"value3":{"type":"string","description":"(value3)"},"value4":{"type":"string","description":"(value4)"},"value5":{"type":"string","description":"(value5)"}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks.","example":"1"}}}}}},"nextActions":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"_link":{"type":"string","description":"(_link)"},"actionName":{"type":"string","description":"(actionName)"}}}}}}},"xml":{"name":"CREATEBILL"}},"DELETEBILL_response":{"type":"object","properties":{"billId":{"type":"string","maxLength":12,"description":"Bill ID is the system-assigned unique identifier of the bill.","example":"549133128888"}},"xml":{"name":"DELETEBILL"}},"UPDATEBILL_response":{"type":"object","properties":{"_self":{"type":"string","description":"_self"},"billId":{"type":"string","maxLength":12,"description":"Bill ID is the system-assigned unique identifier of the bill.","example":"549133128888"},"account":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"accountId":{"type":"string","maxLength":10,"description":"Account ID"}}},"billStatus":{"type":"string","enum":["C   ","P   "],"description":"Bill Status is the bill's status\n* `C   ` - Complete,\n* `P   ` - Pending","example":"C"},"billDate":{"type":"string","format":"date","description":"Bill Date is the business date that was used when the bill was completed.","example":"2001-05-01"},"dueDate":{"type":"string","format":"date","description":"Due Date is the date on which the bill is due.","example":"2001-05-01"},"creationDateTime":{"type":"string","format":"date-time","description":"Create Date/Time is the date and time on which the bill was originally created.","example":"2002-10-24T16:51:58-04:00"},"completedDatetime":{"type":"string","format":"date-time","description":"Completion Date/Time is the date and time on which the bill was completed.","example":"2002-10-24T16:51:56-04:00"},"isLatePaymentCharge":{"type":"boolean","description":"Eligible for Late Payment Charge can be checked if a charge should be levied for late payment.","example":"false"},"latePaymentChargeDate":{"type":"string","format":"date","description":"Late Payment Charge Date is the date on which the system will levy a late payment charge if payment is not received.","example":"2001-05-21"},"nextCreditReviewDate":{"type":"string","format":"date","description":"Next Credit Review Date is the next date on which the account's debt will be reviewed by the account debt monitor.","example":"2001-05-21"},"billSegmentStatus":{"type":"string","maxLength":30,"description":"Bill Segment Status is the bill segment's status."},"totalGeneratedCharge":{"type":"number","maximum":0,"minimum":0,"description":"Total Generated Charge represents the total amount of the bill segments.","example":"35"},"isLatestBill":{"type":"boolean","description":"Latest Bill","example":"false"},"processDate":{"type":"string","format":"date","description":"Process Date","example":"2021-10-05"},"totalAmount":{"type":"number","description":"The Total Amount contains the sum of the current amount of these bill segments","example":"0"},"cutOffDate":{"type":"string","format":"date","description":"Cutoff Date is the last possible day of each bill period for a bill segment.","example":"2021-10-05"},"accountingDate":{"type":"string","format":"date","description":"Accounting Date defines the financial period to which the canceled and new bill segments' financial transactions are booked.","example":"2021-10-05"},"areEstimatesAllowed":{"type":"boolean","description":"Check Allow Estimates if the system is allowed to estimate consumption if it can't find a meter read.","example":"false"},"hasBillingOption":{"type":"boolean","description":"Use the Billing Option to define how the system looks for meter reads.","example":"false"},"cancelReason":{"type":"string","maxLength":4,"description":"Cancel Reason defines why the bill segment(s) are being canceled."},"creditNoteDate":{"type":"string","format":"date","description":"Bill Date is the business date that was used when the bill was completed."},"numberOfBalancedItems":{"type":"number","maximum":999999,"minimum":0,"description":"Number of Balanced Item(s) contains the count of financial transactions linked to this bill that are linked to balanced match events.","example":"0"},"balancedAmount":{"type":"number","description":"Balanced Amount contains the total amount of financial transactions linked to this bill that are linked to balanced match events.","example":"0"},"numberOfUnbalancedItems":{"type":"number","maximum":999999,"minimum":0,"description":"Number of Unbalanced Item(s) contains the count of financial transactions linked to this bill that are linked to unbalanced match events.","example":"0"},"unbalancedAmount":{"type":"number","description":"Unbalanced Amount contains total amount of financial transactions linked to this bill that are linked to unbalanced match events.","example":"0"},"numberOfDisputedItems":{"type":"number","maximum":999999,"minimum":0,"description":"Number of Disputed Item(s) contains the count of financial transactions linked to this bill that are linked to disputed match events.","example":"0"},"disputedAmount":{"type":"number","description":"Disputed  Amount contains the total amount of financial transactions linked to this bill that are linked to disputed match events.","example":"0"},"numberOfUnmatchedItems":{"type":"number","maximum":999999,"minimum":0,"description":"Number of Unmatched Item(s) contains the count of financial transactions linked to this bill that are not linked to any match event.","example":"0"},"unmatchedAmount":{"type":"number","description":"Unmatched Amount contains the total amount of financial transactions linked to this bill that are not linked to any match event.","example":"0"},"openItemTotalAdjustments":{"type":"number","description":"Total Adjustments is the total amount of frozen or canceled adjustment financial transactions linked to this bill.","example":"0"},"openItemTotalCorrections":{"type":"number","description":"Total Bill Corrections is the total amount of canceled and / or rebilled bill segment financial transactions linked to this bill","example":"0"},"openItemCurrentCharges":{"type":"number","description":"Total Current Billing Charges is the total amount of frozen bill segment financial transactions linked to this bill.","example":"0"},"fieldNamesForBillTotals":{"type":"string","description":"(fieldNamesForBillTotals)"},"fieldValueForBillTotals":{"type":"number","description":"(fieldValueForBillTotals)"},"fieldNamesForBillTotals2":{"type":"string","description":"(fieldNamesForBillTotals2)"},"fieldValueForBillTotals2":{"type":"number","description":"(fieldValueForBillTotals2)"},"fieldNamesForBillTotals3":{"type":"string","description":"(fieldNamesForBillTotals3)"},"fieldValueForBillTotals3":{"type":"number","description":"(fieldValueForBillTotals3)"},"fieldNamesForBillTotals4":{"type":"string","description":"(fieldNamesForBillTotals4)"},"fieldValueForBillTotals4":{"type":"number","description":"(fieldValueForBillTotals4)"},"fieldNamesForBillTotals5":{"type":"string","description":"(fieldNamesForBillTotals5)"},"fieldValueForBillTotals5":{"type":"number","description":"(fieldValueForBillTotals5)"},"fieldNamesForBillTotals6":{"type":"string","description":"(fieldNamesForBillTotals6)"},"fieldValueForBillTotals6":{"type":"number","description":"(fieldValueForBillTotals6)"},"fieldNamesForBillTotals7":{"type":"string","description":"(fieldNamesForBillTotals7)"},"fieldValueForBillTotals7":{"type":"number","description":"(fieldValueForBillTotals7)"},"fieldNamesForBillTotals8":{"type":"string","description":"(fieldNamesForBillTotals8)"},"fieldValueForBillTotals8":{"type":"number","description":"(fieldValueForBillTotals8)"},"fieldNamesForBillTotals9":{"type":"string","description":"(fieldNamesForBillTotals9)"},"fieldValueForBillTotals9":{"type":"number","description":"(fieldValueForBillTotals9)"},"fieldNamesForBillTotals10":{"type":"string","description":"(fieldNamesForBillTotals10)"},"fieldValueForBillTotals10":{"type":"number","description":"(fieldValueForBillTotals10)"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks.","example":"1"},"hasMore":{"type":"boolean","description":"(hasMore)"},"totalRecordsCount":{"type":"string","description":"(totalRecordsCount)"},"segments":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"hasMore":{"type":"boolean","description":"(hasMore)"},"totalRecordsCount":{"type":"string","description":"(totalRecordsCount)"},"billSegment":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"billSegmentId":{"type":"string","maxLength":12,"description":"Bill Segment ID"}}},"serviceAgreement":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"serviceAgreementId":{"type":"string","maxLength":10,"description":"Service Agreement"}}},"premise":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"premiseId":{"type":"string","maxLength":10,"description":"Premise ID"}}},"description":{"type":"string","maxLength":60,"description":"Description on Bill is the information about the bill line that appears on the customer's bill."},"rebill":{"type":"string","maxLength":30,"description":"Sometimes the error on a bill segment is not detected by the system and therefore the system freezes the bill segment and routes the bill to the customer. To correct such a bill segment, you must cancel the offending segment and create a new segment (after correcting the cause of the problem). This process is referred as cancel / rebill."},"currentAmount":{"type":"number","description":"Current Amount is the bill segment's effect on the service agreement's current balance.","example":"100"},"transferDescription":{"type":"string","maxLength":30,"description":"Transfer Description"},"shouldRebillAfter":{"type":"boolean","description":"Rebill after completion appears if the bill segment is a rebill that was created after the bill was sent to the customer. The financial impact of this bill segment appears as a \"bill correction\" on the next bill produced for the customer."},"isCancelAfter":{"type":"boolean","description":"Canceled after completion appears if the bill segment was canceled after the bill was sent to the customer. The financial impact of this bill segment appears as a \"bill correction\" on the next bill produced for the customer."},"shouldProtectProcess":{"type":"boolean","description":"Protect Process"},"hasProcess":{"type":"boolean","description":"Process"},"startDate":{"type":"string","format":"date","description":"Start Date - End Date is the portion of the bill segment period that the calculation details apply."},"endDate":{"type":"string","format":"date","description":"Start Date - End Date is the portion of the bill segment period that the calculation details apply."},"messageInformation":{"type":"string","maxLength":150,"description":"Message Information"},"status":{"type":"string","enum":["10  ","20  ","30  ","40  ","50  ","60  ","70  "],"description":"Bill Segment Status:\n* `10  ` - Incomplete,\n* `20  ` - Error,\n* `30  ` - Freezable,\n* `40  ` - Pending Cancel,\n* `50  ` - Frozen,\n* `60  ` - Canceled,\n* `70  ` - OK"},"billingProcessSequence":{"type":"number","maximum":999999,"minimum":-999999,"description":"Billing Processing Sequence"},"isAccountingDate":{"type":"boolean","description":"Accounting Date  is the date the system uses to determine the financial transaction's accounting period in your general ledger."},"uom":{"type":"string","maxLength":30,"description":"Unit of Measure"},"unitOfMeasureDescription":{"type":"string","maxLength":30,"description":"Unit of Measure is the description for unit of measure of the service quantity.","example":"Gallon"},"serviceQuantity":{"type":"number","maximum":1000000000000,"minimum":-1000000000000,"description":"Billable Service Quantity"},"isSATypeRequiresBillDeterminants":{"type":"boolean","description":"If the SA Type has a special role of Bill Determinants Required, you must enter the Cutoff Time and Start Day Option that is used on a bill determinants usage request."}}}}}},"billRoutings":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"person":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"personId":{"type":"string","maxLength":10,"description":"Person ID"}}},"billRoutingParameters":{"type":"object","properties":{"billRouteType":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"billRouteType":{"type":"string","maxLength":8,"description":"Bill Route Type"}}},"billFormat":{"type":"string","enum":["D   ","S   "],"description":"Bill Format Indicates if the customer should receive a detailed or a summary bill.\n* `D   ` - Detailed,\n* `S   ` - Summary","example":"D"},"copies":{"type":"number","maximum":99,"minimum":-99,"description":"Number of Bill Copies"},"sequence":{"type":"number","maximum":99999,"minimum":-99999,"description":"Sequence is the system-assigned identifier assigned to this bill routing.","example":"2"},"isReprint":{"type":"boolean","description":"Reprint"},"customerPOId":{"type":"string","maxLength":20,"description":"PO ID is the purchase order Id the customer wants printed on their copy of the bill."},"batchControl":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"batchControl":{"type":"string","maxLength":8,"description":"Batch Control"}}},"batchNumber":{"type":"number","maximum":9999999999,"minimum":-9999999999,"description":"Batch Number is used to view information and statistics on the batch run's \"threads\".","example":"223"},"doNotExtract":{"type":"boolean","description":"Turn on Do Not Extract if the bill should not be routed to the individual for whatever reason.","example":"false"},"billPrintIntercept":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"billPrintIntercept":{"type":"string","maxLength":8,"description":"User"}}}}},"billRoutingMethod":{"type":"string","enum":["EM  ","FX  ","P   "],"description":"Bill Routing Method is the method used to transmit the bill to the customer.\n* `EM  ` - Email,\n* `FX  ` - Fax,\n* `P   ` - Postal","example":"EM"},"addressInformation":{"type":"object","properties":{"name1":{"type":"string","maxLength":254,"description":"Name 1"},"name2":{"type":"string","maxLength":254,"description":"Name 2"},"name3":{"type":"string","maxLength":254,"description":"Name 3"},"country":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"country":{"type":"string","maxLength":3,"description":"Country"}}},"postal":{"type":"string","maxLength":12,"description":"Postal"},"address1":{"type":"string","maxLength":254,"description":"Address"},"address2":{"type":"string","maxLength":254,"description":"The second line of the address."},"address3":{"type":"string","maxLength":254,"description":"The third line of the address."},"address4":{"type":"string","maxLength":254,"description":"The fourth line of the address."},"number1":{"type":"string","maxLength":6,"description":"Number 1"},"number2":{"type":"string","maxLength":4,"description":"Number 2"},"houseType":{"type":"string","enum":["AB  ","WW  "],"description":"House Type indicates the type of house.\n* `AB  ` - House Boat References,\n* `WW  ` - House Trailer Reference","example":"House Type indicates the type of house."},"inCityLimit":{"type":"boolean","description":"In City Limit"},"geographicCode":{"type":"string","maxLength":15,"description":"Geographic code used to apply proper taxation rules to the physical address location."},"city":{"type":"string","maxLength":90,"description":"City"},"county":{"type":"string","maxLength":90,"description":"The county of the address."},"state":{"type":"string","maxLength":6,"description":"The state of the address.","example":"CA"}}}}}}}},"messages":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"billMessageCode":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"billMessageCode":{"type":"string","maxLength":4,"description":"Bill Message"}}},"insert":{"type":"string","maxLength":8,"description":"Insert Code defines if the bill message causes an insert in the envelope."},"messagePriority":{"type":"string","enum":["10  ","20  ","30  ","40  ","50  ","60  ","70  ","80  ","90  "],"description":"Priority is the bill messages priority (on the printed bill).\n* `10  ` - Priority 10 -- Lowest,\n* `20  ` - Priority 20,\n* `30  ` - Priority 30,\n* `40  ` - Priority 40,\n* `50  ` - Priority 50,\n* `60  ` - Priority 60,\n* `70  ` - Priority 70,\n* `80  ` - Priority 80,\n* `90  ` - Priority 90 -- Highest","example":"10"},"messageOnBill":{"type":"string","maxLength":254,"description":"Message On Bill is the message associated with the code.","example":"Please call (123) 111-9111 if you have any questions about your rate"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks.","example":"1"}}}}}},"characteristics":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"sequence":{"type":"number","maximum":999,"minimum":-999,"description":"Sequence"},"characteristicType":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"characteristicType":{"type":"string","maxLength":8,"description":"Characteristic Type"}}},"typeOfCharacteristicValue":{"type":"string","maxLength":4,"description":"Type of Char Value"},"characteristicValue":{"type":"object","properties":{"_link":{"type":"string","description":"(_link)"},"value":{"type":"string","description":"(value)"},"value2":{"type":"string","description":"(value2)"},"value3":{"type":"string","description":"(value3)"},"value4":{"type":"string","description":"(value4)"},"value5":{"type":"string","description":"(value5)"}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks.","example":"1"}}}}}},"nextActions":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"_link":{"type":"string","description":"(_link)"},"actionName":{"type":"string","description":"(actionName)"}}}}}}},"xml":{"name":"UPDATEBILL"}},"DELETEBILL_request":{"type":"object","properties":{"billId":{"type":"string","maxLength":12,"description":"Bill ID is the system-assigned unique identifier of the bill.","example":"549133128888"}},"xml":{"name":"DELETEBILL"}},"ACTIONBILL_request":{"type":"object","properties":{"billId":{"type":"string","maxLength":12,"description":"Bill ID is the system-assigned unique identifier of the bill.","example":"549133128888"},"name":{"type":"string","description":"(name)"},"accountingDate":{"type":"string","format":"date","description":"Accounting Date defines the financial period to which the canceled and new bill segments' financial transactions are booked.","example":"2021-10-05"},"cutOffDate":{"type":"string","format":"date","description":"Cutoff Date is the last possible day of each bill period for a bill segment.","example":"2021-10-05"},"areEstimatesAllowed":{"type":"boolean","description":"Check Allow Estimates if the system is allowed to estimate consumption if it can't find a meter read.","example":"false"},"hasBillingOption":{"type":"boolean","description":"Use the Billing Option to define how the system looks for meter reads.","example":"false"},"billDate2":{"type":"string","format":"date","description":"Bill Date is the business date that was used when the bill was completed."},"cancelReason":{"type":"string","maxLength":4,"description":"Cancel Reason defines why the bill segment(s) are being canceled."},"creditNoteDate":{"type":"string","format":"date","description":"ILM Date"},"nextActions":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"_link":{"type":"string","description":"(_link)"},"actionName":{"type":"string","description":"(actionName)"}}}}}}},"xml":{"name":"ACTIONBILL"}},"UPDATEBILL_request":{"type":"object","properties":{"billId":{"type":"string","maxLength":12,"description":"Bill ID is the system-assigned unique identifier of the bill.","example":"549133128888"},"account":{"type":"object","properties":{"accountId":{"type":"string","maxLength":10,"description":"Account ID"}}},"billStatus":{"type":"string","enum":["C   ","P   "],"description":"Bill Status is the bill's status\n* `C   ` - Complete,\n* `P   ` - Pending","example":"C"},"billDate":{"type":"string","format":"date","description":"Bill Date is the business date that was used when the bill was completed.","example":"2001-05-01"},"dueDate":{"type":"string","format":"date","description":"Due Date is the date on which the bill is due.","example":"2001-05-01"},"creationDateTime":{"type":"string","format":"date-time","description":"Create Date/Time is the date and time on which the bill was originally created.","example":"2002-10-24T16:51:58-04:00"},"completedDatetime":{"type":"string","format":"date-time","description":"Completion Date/Time is the date and time on which the bill was completed.","example":"2002-10-24T16:51:56-04:00"},"isLatePaymentCharge":{"type":"boolean","description":"Eligible for Late Payment Charge can be checked if a charge should be levied for late payment.","example":"false"},"latePaymentChargeDate":{"type":"string","format":"date","description":"Late Payment Charge Date is the date on which the system will levy a late payment charge if payment is not received.","example":"2001-05-21"},"nextCreditReviewDate":{"type":"string","format":"date","description":"Next Credit Review Date is the next date on which the account's debt will be reviewed by the account debt monitor.","example":"2001-05-21"},"billSegmentStatus":{"type":"string","maxLength":30,"description":"Bill Segment Status is the bill segment's status."},"totalGeneratedCharge":{"type":"number","maximum":0,"minimum":0,"description":"Total Generated Charge represents the total amount of the bill segments.","example":"35"},"isLatestBill":{"type":"boolean","description":"Latest Bill","example":"false"},"processDate":{"type":"string","format":"date","description":"Process Date","example":"2021-10-05"},"totalAmount":{"type":"number","description":"The Total Amount contains the sum of the current amount of these bill segments","example":"0"},"cutOffDate":{"type":"string","format":"date","description":"Cutoff Date is the last possible day of each bill period for a bill segment.","example":"2021-10-05"},"accountingDate":{"type":"string","format":"date","description":"Accounting Date defines the financial period to which the canceled and new bill segments' financial transactions are booked.","example":"2021-10-05"},"areEstimatesAllowed":{"type":"boolean","description":"Check Allow Estimates if the system is allowed to estimate consumption if it can't find a meter read.","example":"false"},"hasBillingOption":{"type":"boolean","description":"Use the Billing Option to define how the system looks for meter reads.","example":"false"},"cancelReason":{"type":"string","maxLength":4,"description":"Cancel Reason defines why the bill segment(s) are being canceled."},"creditNoteDate":{"type":"string","format":"date","description":"Bill Date is the business date that was used when the bill was completed."},"numberOfBalancedItems":{"type":"number","maximum":999999,"minimum":0,"description":"Number of Balanced Item(s) contains the count of financial transactions linked to this bill that are linked to balanced match events.","example":"0"},"balancedAmount":{"type":"number","description":"Balanced Amount contains the total amount of financial transactions linked to this bill that are linked to balanced match events.","example":"0"},"numberOfUnbalancedItems":{"type":"number","maximum":999999,"minimum":0,"description":"Number of Unbalanced Item(s) contains the count of financial transactions linked to this bill that are linked to unbalanced match events.","example":"0"},"unbalancedAmount":{"type":"number","description":"Unbalanced Amount contains total amount of financial transactions linked to this bill that are linked to unbalanced match events.","example":"0"},"numberOfDisputedItems":{"type":"number","maximum":999999,"minimum":0,"description":"Number of Disputed Item(s) contains the count of financial transactions linked to this bill that are linked to disputed match events.","example":"0"},"disputedAmount":{"type":"number","description":"Disputed  Amount contains the total amount of financial transactions linked to this bill that are linked to disputed match events.","example":"0"},"numberOfUnmatchedItems":{"type":"number","maximum":999999,"minimum":0,"description":"Number of Unmatched Item(s) contains the count of financial transactions linked to this bill that are not linked to any match event.","example":"0"},"unmatchedAmount":{"type":"number","description":"Unmatched Amount contains the total amount of financial transactions linked to this bill that are not linked to any match event.","example":"0"},"openItemTotalAdjustments":{"type":"number","description":"Total Adjustments is the total amount of frozen or canceled adjustment financial transactions linked to this bill.","example":"0"},"openItemTotalCorrections":{"type":"number","description":"Total Bill Corrections is the total amount of canceled and / or rebilled bill segment financial transactions linked to this bill","example":"0"},"openItemCurrentCharges":{"type":"number","description":"Total Current Billing Charges is the total amount of frozen bill segment financial transactions linked to this bill.","example":"0"},"fieldNamesForBillTotals":{"type":"string","description":"(fieldNamesForBillTotals)"},"fieldValueForBillTotals":{"type":"number","description":"(fieldValueForBillTotals)"},"fieldNamesForBillTotals2":{"type":"string","description":"(fieldNamesForBillTotals2)"},"fieldValueForBillTotals2":{"type":"number","description":"(fieldValueForBillTotals2)"},"fieldNamesForBillTotals3":{"type":"string","description":"(fieldNamesForBillTotals3)"},"fieldValueForBillTotals3":{"type":"number","description":"(fieldValueForBillTotals3)"},"fieldNamesForBillTotals4":{"type":"string","description":"(fieldNamesForBillTotals4)"},"fieldValueForBillTotals4":{"type":"number","description":"(fieldValueForBillTotals4)"},"fieldNamesForBillTotals5":{"type":"string","description":"(fieldNamesForBillTotals5)"},"fieldValueForBillTotals5":{"type":"number","description":"(fieldValueForBillTotals5)"},"fieldNamesForBillTotals6":{"type":"string","description":"(fieldNamesForBillTotals6)"},"fieldValueForBillTotals6":{"type":"number","description":"(fieldValueForBillTotals6)"},"fieldNamesForBillTotals7":{"type":"string","description":"(fieldNamesForBillTotals7)"},"fieldValueForBillTotals7":{"type":"number","description":"(fieldValueForBillTotals7)"},"fieldNamesForBillTotals8":{"type":"string","description":"(fieldNamesForBillTotals8)"},"fieldValueForBillTotals8":{"type":"number","description":"(fieldValueForBillTotals8)"},"fieldNamesForBillTotals9":{"type":"string","description":"(fieldNamesForBillTotals9)"},"fieldValueForBillTotals9":{"type":"number","description":"(fieldValueForBillTotals9)"},"fieldNamesForBillTotals10":{"type":"string","description":"(fieldNamesForBillTotals10)"},"fieldValueForBillTotals10":{"type":"number","description":"(fieldValueForBillTotals10)"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks.","example":"1"},"hasMore":{"type":"boolean","description":"(hasMore)"},"totalRecordsCount":{"type":"string","description":"(totalRecordsCount)"},"segments":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"hasMore":{"type":"boolean","description":"(hasMore)"},"totalRecordsCount":{"type":"string","description":"(totalRecordsCount)"},"billSegment":{"type":"object","properties":{"billSegmentId":{"type":"string","maxLength":12,"description":"Bill Segment ID"}}},"serviceAgreement":{"type":"object","properties":{"serviceAgreementId":{"type":"string","maxLength":10,"description":"Service Agreement"}}},"premise":{"type":"object","properties":{"premiseId":{"type":"string","maxLength":10,"description":"Premise ID"}}},"description":{"type":"string","maxLength":60,"description":"Description on Bill is the information about the bill line that appears on the customer's bill."},"rebill":{"type":"string","maxLength":30,"description":"Sometimes the error on a bill segment is not detected by the system and therefore the system freezes the bill segment and routes the bill to the customer. To correct such a bill segment, you must cancel the offending segment and create a new segment (after correcting the cause of the problem). This process is referred as cancel / rebill."},"currentAmount":{"type":"number","description":"Current Amount is the bill segment's effect on the service agreement's current balance.","example":"100"},"transferDescription":{"type":"string","maxLength":30,"description":"Transfer Description"},"shouldRebillAfter":{"type":"boolean","description":"Rebill after completion appears if the bill segment is a rebill that was created after the bill was sent to the customer. The financial impact of this bill segment appears as a \"bill correction\" on the next bill produced for the customer."},"isCancelAfter":{"type":"boolean","description":"Canceled after completion appears if the bill segment was canceled after the bill was sent to the customer. The financial impact of this bill segment appears as a \"bill correction\" on the next bill produced for the customer."},"shouldProtectProcess":{"type":"boolean","description":"Protect Process"},"hasProcess":{"type":"boolean","description":"Process"},"startDate":{"type":"string","format":"date","description":"Start Date - End Date is the portion of the bill segment period that the calculation details apply."},"endDate":{"type":"string","format":"date","description":"Start Date - End Date is the portion of the bill segment period that the calculation details apply."},"messageInformation":{"type":"string","maxLength":150,"description":"Message Information"},"status":{"type":"string","enum":["10  ","20  ","30  ","40  ","50  ","60  ","70  "],"description":"Bill Segment Status:\n* `10  ` - Incomplete,\n* `20  ` - Error,\n* `30  ` - Freezable,\n* `40  ` - Pending Cancel,\n* `50  ` - Frozen,\n* `60  ` - Canceled,\n* `70  ` - OK"},"billingProcessSequence":{"type":"number","maximum":999999,"minimum":-999999,"description":"Billing Processing Sequence"},"isAccountingDate":{"type":"boolean","description":"Accounting Date  is the date the system uses to determine the financial transaction's accounting period in your general ledger."},"uom":{"type":"string","maxLength":30,"description":"Unit of Measure"},"unitOfMeasureDescription":{"type":"string","maxLength":30,"description":"Unit of Measure is the description for unit of measure of the service quantity.","example":"Gallon"},"serviceQuantity":{"type":"number","maximum":1000000000000,"minimum":-1000000000000,"description":"Billable Service Quantity"},"isSATypeRequiresBillDeterminants":{"type":"boolean","description":"If the SA Type has a special role of Bill Determinants Required, you must enter the Cutoff Time and Start Day Option that is used on a bill determinants usage request."}}}}}},"billRoutings":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"person":{"type":"object","properties":{"personId":{"type":"string","maxLength":10,"description":"Person ID"}}},"billRoutingParameters":{"type":"object","properties":{"billRouteType":{"type":"object","properties":{"billRouteType":{"type":"string","maxLength":8,"description":"Bill Route Type"}}},"billFormat":{"type":"string","enum":["D   ","S   "],"description":"Bill Format Indicates if the customer should receive a detailed or a summary bill.\n* `D   ` - Detailed,\n* `S   ` - Summary","example":"D"},"copies":{"type":"number","maximum":99,"minimum":-99,"description":"Number of Bill Copies"},"sequence":{"type":"number","maximum":99999,"minimum":-99999,"description":"Sequence is the system-assigned identifier assigned to this bill routing.","example":"2"},"isReprint":{"type":"boolean","description":"Reprint"},"customerPOId":{"type":"string","maxLength":20,"description":"PO ID is the purchase order Id the customer wants printed on their copy of the bill."},"batchControl":{"type":"object","properties":{"batchControl":{"type":"string","maxLength":8,"description":"Batch Control"}}},"batchNumber":{"type":"number","maximum":9999999999,"minimum":-9999999999,"description":"Batch Number is used to view information and statistics on the batch run's \"threads\".","example":"223"},"doNotExtract":{"type":"boolean","description":"Turn on Do Not Extract if the bill should not be routed to the individual for whatever reason.","example":"false"},"billPrintIntercept":{"type":"object","properties":{"billPrintIntercept":{"type":"string","maxLength":8,"description":"User"}}}}},"billRoutingMethod":{"type":"string","enum":["EM  ","FX  ","P   "],"description":"Bill Routing Method is the method used to transmit the bill to the customer.\n* `EM  ` - Email,\n* `FX  ` - Fax,\n* `P   ` - Postal","example":"EM"},"addressInformation":{"type":"object","properties":{"name1":{"type":"string","maxLength":254,"description":"Name 1"},"name2":{"type":"string","maxLength":254,"description":"Name 2"},"name3":{"type":"string","maxLength":254,"description":"Name 3"},"country":{"type":"object","properties":{"country":{"type":"string","maxLength":3,"description":"Country"}}},"postal":{"type":"string","maxLength":12,"description":"Postal"},"address1":{"type":"string","maxLength":254,"description":"Address"},"address2":{"type":"string","maxLength":254,"description":"The second line of the address."},"address3":{"type":"string","maxLength":254,"description":"The third line of the address."},"address4":{"type":"string","maxLength":254,"description":"The fourth line of the address."},"number1":{"type":"string","maxLength":6,"description":"Number 1"},"number2":{"type":"string","maxLength":4,"description":"Number 2"},"houseType":{"type":"string","enum":["AB  ","WW  "],"description":"House Type indicates the type of house.\n* `AB  ` - House Boat References,\n* `WW  ` - House Trailer Reference","example":"House Type indicates the type of house."},"inCityLimit":{"type":"boolean","description":"In City Limit"},"geographicCode":{"type":"string","maxLength":15,"description":"Geographic code used to apply proper taxation rules to the physical address location."},"city":{"type":"string","maxLength":90,"description":"City"},"county":{"type":"string","maxLength":90,"description":"The county of the address."},"state":{"type":"string","maxLength":6,"description":"The state of the address.","example":"CA"}}}}}}}},"messages":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"billMessageCode":{"type":"object","properties":{"billMessageCode":{"type":"string","maxLength":4,"description":"Bill Message"}}},"insert":{"type":"string","maxLength":8,"description":"Insert Code defines if the bill message causes an insert in the envelope."},"messagePriority":{"type":"string","enum":["10  ","20  ","30  ","40  ","50  ","60  ","70  ","80  ","90  "],"description":"Priority is the bill messages priority (on the printed bill).\n* `10  ` - Priority 10 -- Lowest,\n* `20  ` - Priority 20,\n* `30  ` - Priority 30,\n* `40  ` - Priority 40,\n* `50  ` - Priority 50,\n* `60  ` - Priority 60,\n* `70  ` - Priority 70,\n* `80  ` - Priority 80,\n* `90  ` - Priority 90 -- Highest","example":"10"},"messageOnBill":{"type":"string","maxLength":254,"description":"Message On Bill is the message associated with the code.","example":"Please call (123) 111-9111 if you have any questions about your rate"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks.","example":"1"}}}}}},"characteristics":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"sequence":{"type":"number","maximum":999,"minimum":-999,"description":"Sequence"},"characteristicType":{"type":"object","properties":{"characteristicType":{"type":"string","maxLength":8,"description":"Characteristic Type"}}},"typeOfCharacteristicValue":{"type":"string","maxLength":4,"description":"Type of Char Value"},"characteristicValue":{"type":"object","properties":{"_link":{"type":"string","description":"(_link)"},"value":{"type":"string","description":"(value)"},"value2":{"type":"string","description":"(value2)"},"value3":{"type":"string","description":"(value3)"},"value4":{"type":"string","description":"(value4)"},"value5":{"type":"string","description":"(value5)"}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks.","example":"1"}}}}}},"nextActions":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"_link":{"type":"string","description":"(_link)"},"actionName":{"type":"string","description":"(actionName)"}}}}}}},"xml":{"name":"UPDATEBILL"}},"ACTIONBILL_response":{"type":"object","properties":{"_self":{"type":"string","description":"_self"},"billId":{"type":"string","maxLength":12,"description":"Bill ID is the system-assigned unique identifier of the bill.","example":"549133128888"},"name":{"type":"string","description":"(name)"},"accountingDate":{"type":"string","format":"date","description":"Accounting Date defines the financial period to which the canceled and new bill segments' financial transactions are booked.","example":"2021-10-05"},"cutOffDate":{"type":"string","format":"date","description":"Cutoff Date is the last possible day of each bill period for a bill segment.","example":"2021-10-05"},"areEstimatesAllowed":{"type":"boolean","description":"Check Allow Estimates if the system is allowed to estimate consumption if it can't find a meter read.","example":"false"},"hasBillingOption":{"type":"boolean","description":"Use the Billing Option to define how the system looks for meter reads.","example":"false"},"billDate2":{"type":"string","format":"date","description":"Bill Date is the business date that was used when the bill was completed."},"cancelReason":{"type":"string","maxLength":4,"description":"Cancel Reason defines why the bill segment(s) are being canceled."},"creditNoteDate":{"type":"string","format":"date","description":"ILM Date"},"nextActions":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"_link":{"type":"string","description":"(_link)"},"actionName":{"type":"string","description":"(actionName)"}}}}}}},"xml":{"name":"ACTIONBILL"}},"CREATEBILL_response":{"type":"object","properties":{"_self":{"type":"string","description":"_self"},"billId":{"type":"string","maxLength":12,"description":"Bill ID is the system-assigned unique identifier of the bill.","example":"549133128888"},"account":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"accountId":{"type":"string","maxLength":10,"description":"Account ID"}}},"billStatus":{"type":"string","enum":["C   ","P   "],"description":"Bill Status is the bill's status\n* `C   ` - Complete,\n* `P   ` - Pending","example":"C"},"billDate":{"type":"string","format":"date","description":"Bill Date is the business date that was used when the bill was completed.","example":"2001-05-01"},"dueDate":{"type":"string","format":"date","description":"Due Date is the date on which the bill is due.","example":"2001-05-01"},"creationDateTime":{"type":"string","format":"date-time","description":"Create Date/Time is the date and time on which the bill was originally created.","example":"2002-10-24T16:51:58-04:00"},"completedDatetime":{"type":"string","format":"date-time","description":"Completion Date/Time is the date and time on which the bill was completed.","example":"2002-10-24T16:51:56-04:00"},"isLatePaymentCharge":{"type":"boolean","description":"Eligible for Late Payment Charge can be checked if a charge should be levied for late payment.","example":"false"},"latePaymentChargeDate":{"type":"string","format":"date","description":"Late Payment Charge Date is the date on which the system will levy a late payment charge if payment is not received.","example":"2001-05-21"},"nextCreditReviewDate":{"type":"string","format":"date","description":"Next Credit Review Date is the next date on which the account's debt will be reviewed by the account debt monitor.","example":"2001-05-21"},"billSegmentStatus":{"type":"string","maxLength":30,"description":"Bill Segment Status is the bill segment's status."},"totalGeneratedCharge":{"type":"number","maximum":0,"minimum":0,"description":"Total Generated Charge represents the total amount of the bill segments.","example":"35"},"isLatestBill":{"type":"boolean","description":"Latest Bill","example":"false"},"processDate":{"type":"string","format":"date","description":"Process Date","example":"2021-10-05"},"totalAmount":{"type":"number","description":"The Total Amount contains the sum of the current amount of these bill segments","example":"0"},"cutOffDate":{"type":"string","format":"date","description":"Cutoff Date is the last possible day of each bill period for a bill segment.","example":"2021-10-05"},"accountingDate":{"type":"string","format":"date","description":"Accounting Date defines the financial period to which the canceled and new bill segments' financial transactions are booked.","example":"2021-10-05"},"areEstimatesAllowed":{"type":"boolean","description":"Check Allow Estimates if the system is allowed to estimate consumption if it can't find a meter read.","example":"false"},"hasBillingOption":{"type":"boolean","description":"Use the Billing Option to define how the system looks for meter reads.","example":"false"},"cancelReason":{"type":"string","maxLength":4,"description":"Cancel Reason defines why the bill segment(s) are being canceled."},"creditNoteDate":{"type":"string","format":"date","description":"Bill Date is the business date that was used when the bill was completed."},"numberOfBalancedItems":{"type":"number","maximum":999999,"minimum":0,"description":"Number of Balanced Item(s) contains the count of financial transactions linked to this bill that are linked to balanced match events.","example":"0"},"balancedAmount":{"type":"number","description":"Balanced Amount contains the total amount of financial transactions linked to this bill that are linked to balanced match events.","example":"0"},"numberOfUnbalancedItems":{"type":"number","maximum":999999,"minimum":0,"description":"Number of Unbalanced Item(s) contains the count of financial transactions linked to this bill that are linked to unbalanced match events.","example":"0"},"unbalancedAmount":{"type":"number","description":"Unbalanced Amount contains total amount of financial transactions linked to this bill that are linked to unbalanced match events.","example":"0"},"numberOfDisputedItems":{"type":"number","maximum":999999,"minimum":0,"description":"Number of Disputed Item(s) contains the count of financial transactions linked to this bill that are linked to disputed match events.","example":"0"},"disputedAmount":{"type":"number","description":"Disputed  Amount contains the total amount of financial transactions linked to this bill that are linked to disputed match events.","example":"0"},"numberOfUnmatchedItems":{"type":"number","maximum":999999,"minimum":0,"description":"Number of Unmatched Item(s) contains the count of financial transactions linked to this bill that are not linked to any match event.","example":"0"},"unmatchedAmount":{"type":"number","description":"Unmatched Amount contains the total amount of financial transactions linked to this bill that are not linked to any match event.","example":"0"},"openItemTotalAdjustments":{"type":"number","description":"Total Adjustments is the total amount of frozen or canceled adjustment financial transactions linked to this bill.","example":"0"},"openItemTotalCorrections":{"type":"number","description":"Total Bill Corrections is the total amount of canceled and / or rebilled bill segment financial transactions linked to this bill","example":"0"},"openItemCurrentCharges":{"type":"number","description":"Total Current Billing Charges is the total amount of frozen bill segment financial transactions linked to this bill.","example":"0"},"fieldNamesForBillTotals":{"type":"string","description":"(fieldNamesForBillTotals)"},"fieldValueForBillTotals":{"type":"number","description":"(fieldValueForBillTotals)"},"fieldNamesForBillTotals2":{"type":"string","description":"(fieldNamesForBillTotals2)"},"fieldValueForBillTotals2":{"type":"number","description":"(fieldValueForBillTotals2)"},"fieldNamesForBillTotals3":{"type":"string","description":"(fieldNamesForBillTotals3)"},"fieldValueForBillTotals3":{"type":"number","description":"(fieldValueForBillTotals3)"},"fieldNamesForBillTotals4":{"type":"string","description":"(fieldNamesForBillTotals4)"},"fieldValueForBillTotals4":{"type":"number","description":"(fieldValueForBillTotals4)"},"fieldNamesForBillTotals5":{"type":"string","description":"(fieldNamesForBillTotals5)"},"fieldValueForBillTotals5":{"type":"number","description":"(fieldValueForBillTotals5)"},"fieldNamesForBillTotals6":{"type":"string","description":"(fieldNamesForBillTotals6)"},"fieldValueForBillTotals6":{"type":"number","description":"(fieldValueForBillTotals6)"},"fieldNamesForBillTotals7":{"type":"string","description":"(fieldNamesForBillTotals7)"},"fieldValueForBillTotals7":{"type":"number","description":"(fieldValueForBillTotals7)"},"fieldNamesForBillTotals8":{"type":"string","description":"(fieldNamesForBillTotals8)"},"fieldValueForBillTotals8":{"type":"number","description":"(fieldValueForBillTotals8)"},"fieldNamesForBillTotals9":{"type":"string","description":"(fieldNamesForBillTotals9)"},"fieldValueForBillTotals9":{"type":"number","description":"(fieldValueForBillTotals9)"},"fieldNamesForBillTotals10":{"type":"string","description":"(fieldNamesForBillTotals10)"},"fieldValueForBillTotals10":{"type":"number","description":"(fieldValueForBillTotals10)"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks.","example":"1"},"hasMore":{"type":"boolean","description":"(hasMore)"},"totalRecordsCount":{"type":"string","description":"(totalRecordsCount)"},"segments":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"hasMore":{"type":"boolean","description":"(hasMore)"},"totalRecordsCount":{"type":"string","description":"(totalRecordsCount)"},"billSegment":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"billSegmentId":{"type":"string","maxLength":12,"description":"Bill Segment ID"}}},"serviceAgreement":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"serviceAgreementId":{"type":"string","maxLength":10,"description":"Service Agreement"}}},"premise":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"premiseId":{"type":"string","maxLength":10,"description":"Premise ID"}}},"description":{"type":"string","maxLength":60,"description":"Description on Bill is the information about the bill line that appears on the customer's bill."},"rebill":{"type":"string","maxLength":30,"description":"Sometimes the error on a bill segment is not detected by the system and therefore the system freezes the bill segment and routes the bill to the customer. To correct such a bill segment, you must cancel the offending segment and create a new segment (after correcting the cause of the problem). This process is referred as cancel / rebill."},"currentAmount":{"type":"number","description":"Current Amount is the bill segment's effect on the service agreement's current balance.","example":"100"},"transferDescription":{"type":"string","maxLength":30,"description":"Transfer Description"},"shouldRebillAfter":{"type":"boolean","description":"Rebill after completion appears if the bill segment is a rebill that was created after the bill was sent to the customer. The financial impact of this bill segment appears as a \"bill correction\" on the next bill produced for the customer."},"isCancelAfter":{"type":"boolean","description":"Canceled after completion appears if the bill segment was canceled after the bill was sent to the customer. The financial impact of this bill segment appears as a \"bill correction\" on the next bill produced for the customer."},"shouldProtectProcess":{"type":"boolean","description":"Protect Process"},"hasProcess":{"type":"boolean","description":"Process"},"startDate":{"type":"string","format":"date","description":"Start Date - End Date is the portion of the bill segment period that the calculation details apply."},"endDate":{"type":"string","format":"date","description":"Start Date - End Date is the portion of the bill segment period that the calculation details apply."},"messageInformation":{"type":"string","maxLength":150,"description":"Message Information"},"status":{"type":"string","enum":["10  ","20  ","30  ","40  ","50  ","60  ","70  "],"description":"Bill Segment Status:\n* `10  ` - Incomplete,\n* `20  ` - Error,\n* `30  ` - Freezable,\n* `40  ` - Pending Cancel,\n* `50  ` - Frozen,\n* `60  ` - Canceled,\n* `70  ` - OK"},"billingProcessSequence":{"type":"number","maximum":999999,"minimum":-999999,"description":"Billing Processing Sequence"},"isAccountingDate":{"type":"boolean","description":"Accounting Date  is the date the system uses to determine the financial transaction's accounting period in your general ledger."},"uom":{"type":"string","maxLength":30,"description":"Unit of Measure"},"unitOfMeasureDescription":{"type":"string","maxLength":30,"description":"Unit of Measure is the description for unit of measure of the service quantity.","example":"Gallon"},"serviceQuantity":{"type":"number","maximum":1000000000000,"minimum":-1000000000000,"description":"Billable Service Quantity"},"isSATypeRequiresBillDeterminants":{"type":"boolean","description":"If the SA Type has a special role of Bill Determinants Required, you must enter the Cutoff Time and Start Day Option that is used on a bill determinants usage request."}}}}}},"billRoutings":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"person":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"personId":{"type":"string","maxLength":10,"description":"Person ID"}}},"billRoutingParameters":{"type":"object","properties":{"billRouteType":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"billRouteType":{"type":"string","maxLength":8,"description":"Bill Route Type"}}},"billFormat":{"type":"string","enum":["D   ","S   "],"description":"Bill Format Indicates if the customer should receive a detailed or a summary bill.\n* `D   ` - Detailed,\n* `S   ` - Summary","example":"D"},"copies":{"type":"number","maximum":99,"minimum":-99,"description":"Number of Bill Copies"},"sequence":{"type":"number","maximum":99999,"minimum":-99999,"description":"Sequence is the system-assigned identifier assigned to this bill routing.","example":"2"},"isReprint":{"type":"boolean","description":"Reprint"},"customerPOId":{"type":"string","maxLength":20,"description":"PO ID is the purchase order Id the customer wants printed on their copy of the bill."},"batchControl":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"batchControl":{"type":"string","maxLength":8,"description":"Batch Control"}}},"batchNumber":{"type":"number","maximum":9999999999,"minimum":-9999999999,"description":"Batch Number is used to view information and statistics on the batch run's \"threads\".","example":"223"},"doNotExtract":{"type":"boolean","description":"Turn on Do Not Extract if the bill should not be routed to the individual for whatever reason.","example":"false"},"billPrintIntercept":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"billPrintIntercept":{"type":"string","maxLength":8,"description":"User"}}}}},"billRoutingMethod":{"type":"string","enum":["EM  ","FX  ","P   "],"description":"Bill Routing Method is the method used to transmit the bill to the customer.\n* `EM  ` - Email,\n* `FX  ` - Fax,\n* `P   ` - Postal","example":"EM"},"addressInformation":{"type":"object","properties":{"name1":{"type":"string","maxLength":254,"description":"Name 1"},"name2":{"type":"string","maxLength":254,"description":"Name 2"},"name3":{"type":"string","maxLength":254,"description":"Name 3"},"country":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"country":{"type":"string","maxLength":3,"description":"Country"}}},"postal":{"type":"string","maxLength":12,"description":"Postal"},"address1":{"type":"string","maxLength":254,"description":"Address"},"address2":{"type":"string","maxLength":254,"description":"The second line of the address."},"address3":{"type":"string","maxLength":254,"description":"The third line of the address."},"address4":{"type":"string","maxLength":254,"description":"The fourth line of the address."},"number1":{"type":"string","maxLength":6,"description":"Number 1"},"number2":{"type":"string","maxLength":4,"description":"Number 2"},"houseType":{"type":"string","enum":["AB  ","WW  "],"description":"House Type indicates the type of house.\n* `AB  ` - House Boat References,\n* `WW  ` - House Trailer Reference","example":"House Type indicates the type of house."},"inCityLimit":{"type":"boolean","description":"In City Limit"},"geographicCode":{"type":"string","maxLength":15,"description":"Geographic code used to apply proper taxation rules to the physical address location."},"city":{"type":"string","maxLength":90,"description":"City"},"county":{"type":"string","maxLength":90,"description":"The county of the address."},"state":{"type":"string","maxLength":6,"description":"The state of the address.","example":"CA"}}}}}}}},"messages":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"billMessageCode":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"billMessageCode":{"type":"string","maxLength":4,"description":"Bill Message"}}},"insert":{"type":"string","maxLength":8,"description":"Insert Code defines if the bill message causes an insert in the envelope."},"messagePriority":{"type":"string","enum":["10  ","20  ","30  ","40  ","50  ","60  ","70  ","80  ","90  "],"description":"Priority is the bill messages priority (on the printed bill).\n* `10  ` - Priority 10 -- Lowest,\n* `20  ` - Priority 20,\n* `30  ` - Priority 30,\n* `40  ` - Priority 40,\n* `50  ` - Priority 50,\n* `60  ` - Priority 60,\n* `70  ` - Priority 70,\n* `80  ` - Priority 80,\n* `90  ` - Priority 90 -- Highest","example":"10"},"messageOnBill":{"type":"string","maxLength":254,"description":"Message On Bill is the message associated with the code.","example":"Please call (123) 111-9111 if you have any questions about your rate"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks.","example":"1"}}}}}},"characteristics":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"sequence":{"type":"number","maximum":999,"minimum":-999,"description":"Sequence"},"characteristicType":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"characteristicType":{"type":"string","maxLength":8,"description":"Characteristic Type"}}},"typeOfCharacteristicValue":{"type":"string","maxLength":4,"description":"Type of Char Value"},"characteristicValue":{"type":"object","properties":{"_link":{"type":"string","description":"(_link)"},"value":{"type":"string","description":"(value)"},"value2":{"type":"string","description":"(value2)"},"value3":{"type":"string","description":"(value3)"},"value4":{"type":"string","description":"(value4)"},"value5":{"type":"string","description":"(value5)"}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks.","example":"1"}}}}}},"nextActions":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"_link":{"type":"string","description":"(_link)"},"actionName":{"type":"string","description":"(actionName)"}}}}}}},"xml":{"name":"CREATEBILL"}},"GETBILL_response":{"type":"object","properties":{"_self":{"type":"string","description":"_self"},"billId":{"type":"string","maxLength":12,"description":"Bill ID is the system-assigned unique identifier of the bill.","example":"549133128888"},"account":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"accountId":{"type":"string","maxLength":10,"description":"Account ID"}}},"billStatus":{"type":"string","enum":["C   ","P   "],"description":"Bill Status is the bill's status\n* `C   ` - Complete,\n* `P   ` - Pending","example":"C"},"billDate":{"type":"string","format":"date","description":"Bill Date is the business date that was used when the bill was completed.","example":"2001-05-01"},"dueDate":{"type":"string","format":"date","description":"Due Date is the date on which the bill is due.","example":"2001-05-01"},"creationDateTime":{"type":"string","format":"date-time","description":"Create Date/Time is the date and time on which the bill was originally created.","example":"2002-10-24T16:51:58-04:00"},"completedDatetime":{"type":"string","format":"date-time","description":"Completion Date/Time is the date and time on which the bill was completed.","example":"2002-10-24T16:51:56-04:00"},"isLatePaymentCharge":{"type":"boolean","description":"Eligible for Late Payment Charge can be checked if a charge should be levied for late payment.","example":"false"},"latePaymentChargeDate":{"type":"string","format":"date","description":"Late Payment Charge Date is the date on which the system will levy a late payment charge if payment is not received.","example":"2001-05-21"},"nextCreditReviewDate":{"type":"string","format":"date","description":"Next Credit Review Date is the next date on which the account's debt will be reviewed by the account debt monitor.","example":"2001-05-21"},"billSegmentStatus":{"type":"string","maxLength":30,"description":"Bill Segment Status is the bill segment's status."},"totalGeneratedCharge":{"type":"number","maximum":0,"minimum":0,"description":"Total Generated Charge represents the total amount of the bill segments.","example":"35"},"isLatestBill":{"type":"boolean","description":"Latest Bill","example":"false"},"processDate":{"type":"string","format":"date","description":"Process Date","example":"2021-10-05"},"totalAmount":{"type":"number","description":"The Total Amount contains the sum of the current amount of these bill segments","example":"0"},"cutOffDate":{"type":"string","format":"date","description":"Cutoff Date is the last possible day of each bill period for a bill segment.","example":"2021-10-05"},"accountingDate":{"type":"string","format":"date","description":"Accounting Date defines the financial period to which the canceled and new bill segments' financial transactions are booked.","example":"2021-10-05"},"areEstimatesAllowed":{"type":"boolean","description":"Check Allow Estimates if the system is allowed to estimate consumption if it can't find a meter read.","example":"false"},"hasBillingOption":{"type":"boolean","description":"Use the Billing Option to define how the system looks for meter reads.","example":"false"},"cancelReason":{"type":"string","maxLength":4,"description":"Cancel Reason defines why the bill segment(s) are being canceled."},"creditNoteDate":{"type":"string","format":"date","description":"Bill Date is the business date that was used when the bill was completed."},"numberOfBalancedItems":{"type":"number","maximum":999999,"minimum":0,"description":"Number of Balanced Item(s) contains the count of financial transactions linked to this bill that are linked to balanced match events.","example":"0"},"balancedAmount":{"type":"number","description":"Balanced Amount contains the total amount of financial transactions linked to this bill that are linked to balanced match events.","example":"0"},"numberOfUnbalancedItems":{"type":"number","maximum":999999,"minimum":0,"description":"Number of Unbalanced Item(s) contains the count of financial transactions linked to this bill that are linked to unbalanced match events.","example":"0"},"unbalancedAmount":{"type":"number","description":"Unbalanced Amount contains total amount of financial transactions linked to this bill that are linked to unbalanced match events.","example":"0"},"numberOfDisputedItems":{"type":"number","maximum":999999,"minimum":0,"description":"Number of Disputed Item(s) contains the count of financial transactions linked to this bill that are linked to disputed match events.","example":"0"},"disputedAmount":{"type":"number","description":"Disputed  Amount contains the total amount of financial transactions linked to this bill that are linked to disputed match events.","example":"0"},"numberOfUnmatchedItems":{"type":"number","maximum":999999,"minimum":0,"description":"Number of Unmatched Item(s) contains the count of financial transactions linked to this bill that are not linked to any match event.","example":"0"},"unmatchedAmount":{"type":"number","description":"Unmatched Amount contains the total amount of financial transactions linked to this bill that are not linked to any match event.","example":"0"},"openItemTotalAdjustments":{"type":"number","description":"Total Adjustments is the total amount of frozen or canceled adjustment financial transactions linked to this bill.","example":"0"},"openItemTotalCorrections":{"type":"number","description":"Total Bill Corrections is the total amount of canceled and / or rebilled bill segment financial transactions linked to this bill","example":"0"},"openItemCurrentCharges":{"type":"number","description":"Total Current Billing Charges is the total amount of frozen bill segment financial transactions linked to this bill.","example":"0"},"fieldNamesForBillTotals":{"type":"string","description":"(fieldNamesForBillTotals)"},"fieldValueForBillTotals":{"type":"number","description":"(fieldValueForBillTotals)"},"fieldNamesForBillTotals2":{"type":"string","description":"(fieldNamesForBillTotals2)"},"fieldValueForBillTotals2":{"type":"number","description":"(fieldValueForBillTotals2)"},"fieldNamesForBillTotals3":{"type":"string","description":"(fieldNamesForBillTotals3)"},"fieldValueForBillTotals3":{"type":"number","description":"(fieldValueForBillTotals3)"},"fieldNamesForBillTotals4":{"type":"string","description":"(fieldNamesForBillTotals4)"},"fieldValueForBillTotals4":{"type":"number","description":"(fieldValueForBillTotals4)"},"fieldNamesForBillTotals5":{"type":"string","description":"(fieldNamesForBillTotals5)"},"fieldValueForBillTotals5":{"type":"number","description":"(fieldValueForBillTotals5)"},"fieldNamesForBillTotals6":{"type":"string","description":"(fieldNamesForBillTotals6)"},"fieldValueForBillTotals6":{"type":"number","description":"(fieldValueForBillTotals6)"},"fieldNamesForBillTotals7":{"type":"string","description":"(fieldNamesForBillTotals7)"},"fieldValueForBillTotals7":{"type":"number","description":"(fieldValueForBillTotals7)"},"fieldNamesForBillTotals8":{"type":"string","description":"(fieldNamesForBillTotals8)"},"fieldValueForBillTotals8":{"type":"number","description":"(fieldValueForBillTotals8)"},"fieldNamesForBillTotals9":{"type":"string","description":"(fieldNamesForBillTotals9)"},"fieldValueForBillTotals9":{"type":"number","description":"(fieldValueForBillTotals9)"},"fieldNamesForBillTotals10":{"type":"string","description":"(fieldNamesForBillTotals10)"},"fieldValueForBillTotals10":{"type":"number","description":"(fieldValueForBillTotals10)"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks.","example":"1"},"hasMore":{"type":"boolean","description":"(hasMore)"},"totalRecordsCount":{"type":"string","description":"(totalRecordsCount)"},"segments":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"hasMore":{"type":"boolean","description":"(hasMore)"},"totalRecordsCount":{"type":"string","description":"(totalRecordsCount)"},"billSegment":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"billSegmentId":{"type":"string","maxLength":12,"description":"Bill Segment ID"}}},"serviceAgreement":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"serviceAgreementId":{"type":"string","maxLength":10,"description":"Service Agreement"}}},"premise":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"premiseId":{"type":"string","maxLength":10,"description":"Premise ID"}}},"description":{"type":"string","maxLength":60,"description":"Description on Bill is the information about the bill line that appears on the customer's bill."},"rebill":{"type":"string","maxLength":30,"description":"Sometimes the error on a bill segment is not detected by the system and therefore the system freezes the bill segment and routes the bill to the customer. To correct such a bill segment, you must cancel the offending segment and create a new segment (after correcting the cause of the problem). This process is referred as cancel / rebill."},"currentAmount":{"type":"number","description":"Current Amount is the bill segment's effect on the service agreement's current balance.","example":"100"},"transferDescription":{"type":"string","maxLength":30,"description":"Transfer Description"},"shouldRebillAfter":{"type":"boolean","description":"Rebill after completion appears if the bill segment is a rebill that was created after the bill was sent to the customer. The financial impact of this bill segment appears as a \"bill correction\" on the next bill produced for the customer."},"isCancelAfter":{"type":"boolean","description":"Canceled after completion appears if the bill segment was canceled after the bill was sent to the customer. The financial impact of this bill segment appears as a \"bill correction\" on the next bill produced for the customer."},"shouldProtectProcess":{"type":"boolean","description":"Protect Process"},"hasProcess":{"type":"boolean","description":"Process"},"startDate":{"type":"string","format":"date","description":"Start Date - End Date is the portion of the bill segment period that the calculation details apply."},"endDate":{"type":"string","format":"date","description":"Start Date - End Date is the portion of the bill segment period that the calculation details apply."},"messageInformation":{"type":"string","maxLength":150,"description":"Message Information"},"status":{"type":"string","enum":["10  ","20  ","30  ","40  ","50  ","60  ","70  "],"description":"Bill Segment Status:\n* `10  ` - Incomplete,\n* `20  ` - Error,\n* `30  ` - Freezable,\n* `40  ` - Pending Cancel,\n* `50  ` - Frozen,\n* `60  ` - Canceled,\n* `70  ` - OK"},"billingProcessSequence":{"type":"number","maximum":999999,"minimum":-999999,"description":"Billing Processing Sequence"},"isAccountingDate":{"type":"boolean","description":"Accounting Date  is the date the system uses to determine the financial transaction's accounting period in your general ledger."},"uom":{"type":"string","maxLength":30,"description":"Unit of Measure"},"unitOfMeasureDescription":{"type":"string","maxLength":30,"description":"Unit of Measure is the description for unit of measure of the service quantity.","example":"Gallon"},"serviceQuantity":{"type":"number","maximum":1000000000000,"minimum":-1000000000000,"description":"Billable Service Quantity"},"isSATypeRequiresBillDeterminants":{"type":"boolean","description":"If the SA Type has a special role of Bill Determinants Required, you must enter the Cutoff Time and Start Day Option that is used on a bill determinants usage request."}}}}}},"billRoutings":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"person":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"personId":{"type":"string","maxLength":10,"description":"Person ID"}}},"billRoutingParameters":{"type":"object","properties":{"billRouteType":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"billRouteType":{"type":"string","maxLength":8,"description":"Bill Route Type"}}},"billFormat":{"type":"string","enum":["D   ","S   "],"description":"Bill Format Indicates if the customer should receive a detailed or a summary bill.\n* `D   ` - Detailed,\n* `S   ` - Summary","example":"D"},"copies":{"type":"number","maximum":99,"minimum":-99,"description":"Number of Bill Copies"},"sequence":{"type":"number","maximum":99999,"minimum":-99999,"description":"Sequence is the system-assigned identifier assigned to this bill routing.","example":"2"},"isReprint":{"type":"boolean","description":"Reprint"},"customerPOId":{"type":"string","maxLength":20,"description":"PO ID is the purchase order Id the customer wants printed on their copy of the bill."},"batchControl":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"batchControl":{"type":"string","maxLength":8,"description":"Batch Control"}}},"batchNumber":{"type":"number","maximum":9999999999,"minimum":-9999999999,"description":"Batch Number is used to view information and statistics on the batch run's \"threads\".","example":"223"},"doNotExtract":{"type":"boolean","description":"Turn on Do Not Extract if the bill should not be routed to the individual for whatever reason.","example":"false"},"billPrintIntercept":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"billPrintIntercept":{"type":"string","maxLength":8,"description":"User"}}}}},"billRoutingMethod":{"type":"string","enum":["EM  ","FX  ","P   "],"description":"Bill Routing Method is the method used to transmit the bill to the customer.\n* `EM  ` - Email,\n* `FX  ` - Fax,\n* `P   ` - Postal","example":"EM"},"addressInformation":{"type":"object","properties":{"name1":{"type":"string","maxLength":254,"description":"Name 1"},"name2":{"type":"string","maxLength":254,"description":"Name 2"},"name3":{"type":"string","maxLength":254,"description":"Name 3"},"country":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"country":{"type":"string","maxLength":3,"description":"Country"}}},"postal":{"type":"string","maxLength":12,"description":"Postal"},"address1":{"type":"string","maxLength":254,"description":"Address"},"address2":{"type":"string","maxLength":254,"description":"The second line of the address."},"address3":{"type":"string","maxLength":254,"description":"The third line of the address."},"address4":{"type":"string","maxLength":254,"description":"The fourth line of the address."},"number1":{"type":"string","maxLength":6,"description":"Number 1"},"number2":{"type":"string","maxLength":4,"description":"Number 2"},"houseType":{"type":"string","enum":["AB  ","WW  "],"description":"House Type indicates the type of house.\n* `AB  ` - House Boat References,\n* `WW  ` - House Trailer Reference","example":"House Type indicates the type of house."},"inCityLimit":{"type":"boolean","description":"In City Limit"},"geographicCode":{"type":"string","maxLength":15,"description":"Geographic code used to apply proper taxation rules to the physical address location."},"city":{"type":"string","maxLength":90,"description":"City"},"county":{"type":"string","maxLength":90,"description":"The county of the address."},"state":{"type":"string","maxLength":6,"description":"The state of the address.","example":"CA"}}}}}}}},"messages":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"billMessageCode":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"billMessageCode":{"type":"string","maxLength":4,"description":"Bill Message"}}},"insert":{"type":"string","maxLength":8,"description":"Insert Code defines if the bill message causes an insert in the envelope."},"messagePriority":{"type":"string","enum":["10  ","20  ","30  ","40  ","50  ","60  ","70  ","80  ","90  "],"description":"Priority is the bill messages priority (on the printed bill).\n* `10  ` - Priority 10 -- Lowest,\n* `20  ` - Priority 20,\n* `30  ` - Priority 30,\n* `40  ` - Priority 40,\n* `50  ` - Priority 50,\n* `60  ` - Priority 60,\n* `70  ` - Priority 70,\n* `80  ` - Priority 80,\n* `90  ` - Priority 90 -- Highest","example":"10"},"messageOnBill":{"type":"string","maxLength":254,"description":"Message On Bill is the message associated with the code.","example":"Please call (123) 111-9111 if you have any questions about your rate"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks.","example":"1"}}}}}},"characteristics":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"sequence":{"type":"number","maximum":999,"minimum":-999,"description":"Sequence"},"characteristicType":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"characteristicType":{"type":"string","maxLength":8,"description":"Characteristic Type"}}},"typeOfCharacteristicValue":{"type":"string","maxLength":4,"description":"Type of Char Value"},"characteristicValue":{"type":"object","properties":{"_link":{"type":"string","description":"(_link)"},"value":{"type":"string","description":"(value)"},"value2":{"type":"string","description":"(value2)"},"value3":{"type":"string","description":"(value3)"},"value4":{"type":"string","description":"(value4)"},"value5":{"type":"string","description":"(value5)"}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks.","example":"1"}}}}}},"nextActions":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"_link":{"type":"string","description":"(_link)"},"actionName":{"type":"string","description":"(actionName)"}}}}}}},"xml":{"name":"GETBILL"}},"UPDATESERVICEAGREEMENT_request":{"type":"object","properties":{"serviceAgreementId":{"type":"string","maxLength":10,"description":"The Service Agreement ID is a system assigned random number that stays with a service agreement for life."},"status":{"type":"string","enum":["05  ","10  ","20  ","30  ","40  ","50  ","60  ","70  "],"description":"SA Status defines the state of the service agreement.\n* `05  ` - Incomplete,\n* `10  ` - Pending Start,\n* `20  ` - Active,\n* `30  ` - Pending Stop,\n* `40  ` - Stopped,\n* `50  ` - Reactivated,\n* `60  ` - Closed,\n* `70  ` - Canceled","example":"20"},"account":{"type":"object","properties":{"accountId":{"type":"string","maxLength":10,"description":"Account ID defines the account that is financially responsible for the service agreement. If you change a service agreement's Account ID, you are effectively transferring this service agreement, and its debt, to the new account.","example":"1589809012"}}},"division":{"type":"object","description":"The CIS division for service agreements is part of the service agreement's SA type. The SA type controls many business rules, and thus all business rules that are on the SA type are defined for a given jurisdiction and SA type combination.","properties":{"division":{"type":"string","maxLength":5,"description":"The CIS division for service agreements is part of the service agreement's SA type. The SA type controls many business rules, and thus all business rules that are on the SA type are defined for a given jurisdiction and SA type combination.","example":"Ohio"}}},"serviceAgreementType":{"type":"object","properties":{"serviceAgreementType":{"type":"string","maxLength":8,"description":"SA Type"}}},"startDate":{"type":"string","format":"date","description":"The Start Date defines when the financial relationship begins."},"endDate":{"type":"string","format":"date","description":"The End Date defines when the financial relationship terminates.","example":"2018-02-25"},"customerRead":{"type":"string","enum":["N   ","Y   "],"description":"Customer Read defines whether a customer read is from the customer's meter.","example":"Y"},"allowEstimates":{"type":"boolean","description":"Allow Estimates defines whether to allow the billing process to estimate this service agreement's consumption if a real meter read is missing at billing time. Disabling this support prohibits estimate meter reads."},"startOption":{"type":"string","maxLength":12,"description":"Start options define default values for a service agreement. For example, the rate schedule, recurring charge amount, contract riders, contract terms, characteristics, terms and conditions, and so on can all be defaulted onto a service agreement using a start option."},"premise":{"type":"object","properties":{"premiseId":{"type":"string","maxLength":10,"description":"If the service agreement's rate uses premise-based characteristics for taxation and other purposes, Characteristic Premise ID defines the premise that supplies these characteristics. This field also defines the premise under which the service agreement's bill segments are classified and is used to identify where the service agreement's service is located.","example":"8614900960"}}},"oldAccountId":{"type":"string","maxLength":36,"description":"Old Account ID refers to account ID for service agreements that were converted from a legacy CIS system. The payment upload process uses this field to locate the accounts for payments that reference a legacy account number.","example":"123456789"},"totalAmountToBill":{"type":"number","description":"If the service agreement requires a total amount to bill, the amount is displayed. This field is typically only used on loan or cash deposit service agreements."},"expireDate":{"type":"string","format":"date","description":"Expiration Date contains the date at which the service agreement is set to expire."},"renewalDate":{"type":"string","format":"date","description":"Renewal Date contains the date at which the service agreement is to be renewed. Renewal date is disabled if renewal is not allowed on the SA type."},"serviceAgreementRelationship":{"type":"object","properties":{"serviceAgreementRelationshipId":{"type":"string","maxLength":10,"description":"SA Relationship ID"}}},"sicCode":{"type":"object","description":"Select the SIC Code associated with the customer. This is typically only used for commercial and industrial customers.","properties":{"sicCode":{"type":"string","maxLength":8,"description":"Select the SIC Code associated with the customer. This is typically only used for commercial and industrial customers.","example":"4800 (Transportation)"}}},"currency":{"type":"object","description":"Currency Code defines the currency in which the rate's prices are expressed.","properties":{"currency":{"type":"string","maxLength":3,"description":"Currency Code defines the currency in which the rate's prices are expressed.","example":"USD"}}},"maxBillThreshold":{"type":"number","description":"Maximum Bill Threshold defines the maximum value for a bill segment that is produced in batch. If this value is exceeded, the system generates a bill error.","example":"2000"},"depositInterestCalculated":{"type":"string","format":"date","description":"Deposit Interest Calculated contains the last date the system applied interest. This field is only visible if the SA type has a special role of Cash Deposit.","example":"2018-02-25"},"reviewDate":{"type":"string","format":"date","description":"CIAC Review Date displays the last date that the Contributions In Aid of Construction (CIAC) review process ran for this service agreement. This field is only visible if the SA type indicates that it is a CIAC service agreement."},"startReason":{"type":"string","enum":["C   ","S   "],"description":"Start Reason defines if a customer or the system requested to start the service agreement.","example":"C"},"stopReason":{"type":"string","enum":["C   ","S   "],"description":"Stop Reason defines  if a customer or the system requested to stop the service agreement.","example":"C"},"startRequestedBy":{"type":"string","maxLength":50,"description":"Start Requested By can include notes entered in the Requested By field when the service agreement start is submitted. For example, Customer, Jane Smith."},"stopRequestedBy":{"type":"string","maxLength":50,"description":"Stop Requested By can capture notes entered in the Requested By field when this SA stop was submitted (e.g., Customer, Jane Smith )."},"businessActivityDescription":{"type":"string","maxLength":250,"description":"Business Activity further defines what types of activities are served by the contract.","example":"business"},"order":{"type":"object","properties":{"orderId":{"type":"string","maxLength":12,"description":"Order ID is the system-assigned unique identifier of the order."}}},"ibSACutoffTime":{"type":"string","description":"If the SA Type has a special role of Interval, you must enter the Cutoff Time. The Cutoff Time is entered in \"legal time\". This value defaults from either the start option or the installation record."},"specialUsage":{"type":"string","enum":["PROP"],"description":"The Special Usage Flag defines  proposal service agreements. Quote creation requires an account has at least one proposal service agreement. A proposal service agreement contains the pricing terms, legal terms, and template consumption used to generate the simulated bill segments that appear on a quote. It might be helpful to view a proposal service agreement as special type of service agreement that is ignored when a bill is produced for an account.","example":"PROP"},"numberOfPaymentPeriods":{"type":"number","maximum":999,"minimum":0,"description":"Number of Payment Periods only appears for loan SA types. It displays the number of periods specified when the loan was first activated.","example":"0"},"recommendationRule":{"type":"string","maxLength":8,"description":"The NBB Recommendation Rule displays the description of the non-billed budget recommendation rule used for this service agreement. This field is only applicable if the service agreement has a special role of Non-billed Budget."},"nonBillAutoPay":{"type":"string","enum":["EXCL","INCL"],"description":"The Scheduled Payment Autopay defines whether the non-billed budget scheduled payments are excluded from automatic payment or included by automatic payment. If the account is not set up for automatic payment for the period that covers the non-billed budget, this flag cannot be set. This field is only applicable if the service agreement has a special role of Non-billed Budget.","example":"INCL"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version","example":"2"},"consumerContractProducts":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"consumerContractProduct":{"type":"object","properties":{"consumerContractProductId":{"type":"string","maxLength":14,"description":"Consumer Contract Product"}}},"effectiveDate":{"type":"string","format":"date","description":"Effective Date","example":"2018-02-25"},"consumerContractRule":{"type":"object","properties":{"consumerContractRule":{"type":"string","maxLength":30,"description":"Consumer Contract Rule"}}},"consumerProductComponent":{"type":"object","properties":{"consumerProductComponent":{"type":"string","maxLength":30,"description":"Consumer Product Component"}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version","example":"2"}}}}}},"characteristics":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"effectiveDate":{"type":"string","format":"date","description":"Effective Date Indicate the effective date of the characteristic type and value. The service point's install date defaults.","example":"2018-02-25"},"characteristicType":{"type":"object","properties":{"characteristicType":{"type":"string","maxLength":8,"description":"Characteristic Type indicates the type of characteristic."}}},"typeOfCharacteristicValue":{"type":"string","maxLength":4,"description":"Type of Char Value"},"characteristicValue":{"type":"object","properties":{"_link":{"type":"string","description":"(_link)"},"value":{"type":"string","description":"(value)"},"value2":{"type":"string","description":"(value2)"},"value3":{"type":"string","description":"(value3)"},"value4":{"type":"string","description":"(value4)"},"value5":{"type":"string","description":"(value5)"}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version","example":"2"}}}}}},"contractTerms":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"contractTermType":{"type":"string","enum":["R   ","T   ","V   "],"description":"Billing uses Contract Term information when it calculates a bill segment for the service agreement. The Contract Rider type contains the contract riders that are in effect for the service agreement. The Contract Value type contains the contract values that are in effect for the service agreement. The Tax Exemptions type contains the taxes from which the service agreement is all or partially exempt.","example":"R"},"billFactor":{"type":"object","properties":{"billFactor":{"type":"string","maxLength":8,"description":"Bill Factor defines the type of contract rider."}}},"startDate":{"type":"string","format":"date","description":"Start Date defines the date on which the contract rider becomes effective. The service agreement's start date acts as the default value."},"endDate":{"type":"string","format":"date","description":"End Date defines the date on which the contract rider expires.","example":"2018-02-25"},"percentExempt":{"type":"number","maximum":999.9999,"minimum":-999.9999,"description":"Percent Exempt defines the customer tax exemption percent. For example, 90 means the customer is 90% exempt and will only pay 10% of the normal tax rate.","example":"0.0000"},"taxCertification":{"type":"string","maxLength":35,"description":"Tax Certification defines whether the customer has a tax exemption certificate."},"taxExemptType":{"type":"object","properties":{"taxExemptType":{"type":"string","maxLength":8,"description":"Tax Exempt Type defines the type of exemption."}}},"touGroup":{"type":"string","maxLength":30,"description":"Indicate the TOU Group that corresponds with the TOU group on the service agreement's TOU Map. Once entered, the collection of TOU codes linked to this TOU group will display."},"value":{"type":"number","maximum":100000000000,"minimum":-100000000000,"description":"Defines the time of use code value."},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version","example":"2"}}}}}},"contractQuantities":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"contractQuantityType":{"type":"object","properties":{"contractQuantityType":{"type":"string","maxLength":8,"description":"Contract Quantity Type defines the type of contract quantity."}}},"contractQuantity":{"type":"number","maximum":100000000000,"minimum":-100000000000,"description":"The contract quantity defines the contract quantity.","example":"10.000000"},"effectiveDate":{"type":"string","format":"date","description":"Effective Date defines the date the charge becomes effective. The service agreement's start date acts as the default value.","example":"2018-02-25"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version","example":"2"}}}}}},"contractOptions":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"saContractOptionId":{"type":"string","maxLength":12,"description":"The SA Contract Option ID is the unique identifier of the service agreement or contract option record.","example":"301631110794"},"contractOption":{"type":"object","properties":{"contractOptionId":{"type":"string","maxLength":12,"description":"Contract Option ID is a system assigned record key for the contract option linked to the Service Agreement."}}},"effectiveDateTime":{"type":"string","format":"date-time","description":"Effective Date/Time is the date and time that the contract option is in effect for the service agreement.","example":"2018-02-25"},"expirationDateTime":{"type":"string","format":"date-time","description":"Expiration Date/Time is the date and time that the contract option is no longer in effect for the service agreement.","example":"2006-07-01T00:00:00-04:00"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version","example":"2"}}}}}},"billMessages":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"billMessage":{"type":"object","properties":{"billMessage":{"type":"string","maxLength":4,"description":"Bill Message"}}},"billMessageType":{"type":"string","enum":["P   ","T   "],"description":"For Bill Message Type, use Temporary to indicate the message should only be linked to the next bill produced for the account. Use Permanent if the message should appear on every bill. Temporary is the default value.","example":"T"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version","example":"2"}}}}}},"recurringChargeHistory":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"effectiveDate":{"type":"string","format":"date","description":"Effective Date is the date the charge becomes effective. The service agreement's start date acts as the default value.","example":"2018-02-25"},"recurringChargeAmount":{"type":"number","description":"The Recurring Charge contains effective-dated information that defines the recurring charge amount used to calculate the service agreement's bill segments.","example":"5000"},"currency":{"type":"object","properties":{"currency":{"type":"string","maxLength":3,"description":"Currency Code defines the currency in which the rate's prices are expressed."}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version","example":"2"}}}}}},"rateScheduleHistory":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"effectiveDate":{"type":"string","format":"date","description":"Effective Date is the date the rate becomes effective. The service agreement's start date acts as the default value.","example":"2018-02-25"},"rateSchedule":{"type":"object","properties":{"rateSchedule":{"type":"string","maxLength":8,"description":"Rate Schedule defines the rate used to calculate the service agreement's bill segments. Note, you can only choose rates defined as permissible on the service agreement's SA type."}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version","example":"2"}}}}}},"servicePoints":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"servicePoint":{"type":"object","properties":{"servicePointId":{"type":"string","maxLength":10,"description":"Service Point ID is the identifier of the service point."}}},"saSPId":{"type":"string","maxLength":10,"description":"System assigned record key for the SA/SP relationship."},"startDateTime":{"type":"string","format":"date-time","description":"Start Date/Time The date and time the service point's consumption starts being billed under the service agreement."},"startMeterRead":{"type":"object","properties":{"startMeterReadId":{"type":"string","maxLength":12,"description":"ID of the meter reading record at the time the service point was started for the service agreement."}}},"stopDateTime":{"type":"string","format":"date-time","description":"The date and time the service point's consumption stops being billed under the service agreement."},"howToUseRead":{"type":"string","enum":["+   ","-   ","C   ","S   ","X   "],"description":"How to Use (SP) indicates how billing uses the consumption associated with the service point. This is not applicable for item-type service points.","example":"S"},"stopMeterRead":{"type":"object","properties":{"stopMeterReadId":{"type":"string","maxLength":12,"description":"Stop Meter Read is the meter read that records the register values as they appeared when the service point was unlinked from the service agreement."}}},"usePercent":{"type":"number","maximum":999,"minimum":-999,"description":"Use Percent indicates the percentage of this service point's consumption that is billed under the service agreement. This field is not applicable for item-type service points.","example":"100"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version","example":"2"}}}}}},"termsAndConditions":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"termsAndCondition":{"type":"object","properties":{"termsAndCondition":{"type":"string","maxLength":12,"description":"Terms and Conditions define the type of terms and conditions.","example":"NGSCC-01"}}},"startDate":{"type":"string","format":"date","description":"Start Date defines the date on which the terms and conditions become effective. The service agreement's start date acts as the default value."},"endDate":{"type":"string","format":"date","description":"End Date defines the date on which the terms and conditions expire. This field is only applicable if the terms and conditions expire on an explicit date.","example":"2018-02-25"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version","example":"2"}}}}}}},"xml":{"name":"C1-ServiceAg"}},"DELETESERVICEAGREEMENT_request":{"type":"object","properties":{"serviceAgreementId":{"type":"string","maxLength":10,"description":"The Service Agreement ID is a system assigned random number that stays with a service agreement for life."}},"xml":{"name":"C1-DeleteSA"}},"CREATESERVICEAGREEMENT_response":{"type":"object","properties":{"_self":{"type":"string","description":"_self"},"serviceAgreementId":{"type":"string","maxLength":10,"description":"The Service Agreement ID is a system assigned random number that stays with a service agreement for life."},"status":{"type":"string","enum":["05  ","10  ","20  ","30  ","40  ","50  ","60  ","70  "],"description":"SA Status defines the state of the service agreement.\n* `05  ` - Incomplete,\n* `10  ` - Pending Start,\n* `20  ` - Active,\n* `30  ` - Pending Stop,\n* `40  ` - Stopped,\n* `50  ` - Reactivated,\n* `60  ` - Closed,\n* `70  ` - Canceled","example":"20"},"account":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"accountId":{"type":"string","maxLength":10,"description":"Account ID defines the account that is financially responsible for the service agreement. If you change a service agreement's Account ID, you are effectively transferring this service agreement, and its debt, to the new account.","example":"1589809012"}}},"division":{"type":"object","description":"The CIS division for service agreements is part of the service agreement's SA type. The SA type controls many business rules, and thus all business rules that are on the SA type are defined for a given jurisdiction and SA type combination.","properties":{"_link":{"type":"string","description":"_link"},"division":{"type":"string","maxLength":5,"description":"The CIS division for service agreements is part of the service agreement's SA type. The SA type controls many business rules, and thus all business rules that are on the SA type are defined for a given jurisdiction and SA type combination.","example":"Ohio"}}},"serviceAgreementType":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"serviceAgreementType":{"type":"string","maxLength":8,"description":"SA Type"}}},"startDate":{"type":"string","format":"date","description":"The Start Date defines when the financial relationship begins."},"endDate":{"type":"string","format":"date","description":"The End Date defines when the financial relationship terminates.","example":"2018-02-25"},"customerRead":{"type":"string","enum":["N   ","Y   "],"description":"Customer Read defines whether a customer read is from the customer's meter.","example":"Y"},"allowEstimates":{"type":"boolean","description":"Allow Estimates defines whether to allow the billing process to estimate this service agreement's consumption if a real meter read is missing at billing time. Disabling this support prohibits estimate meter reads."},"startOption":{"type":"string","maxLength":12,"description":"Start options define default values for a service agreement. For example, the rate schedule, recurring charge amount, contract riders, contract terms, characteristics, terms and conditions, and so on can all be defaulted onto a service agreement using a start option."},"premise":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"premiseId":{"type":"string","maxLength":10,"description":"If the service agreement's rate uses premise-based characteristics for taxation and other purposes, Characteristic Premise ID defines the premise that supplies these characteristics. This field also defines the premise under which the service agreement's bill segments are classified and is used to identify where the service agreement's service is located.","example":"8614900960"}}},"oldAccountId":{"type":"string","maxLength":36,"description":"Old Account ID refers to account ID for service agreements that were converted from a legacy CIS system. The payment upload process uses this field to locate the accounts for payments that reference a legacy account number.","example":"123456789"},"totalAmountToBill":{"type":"number","description":"If the service agreement requires a total amount to bill, the amount is displayed. This field is typically only used on loan or cash deposit service agreements."},"expireDate":{"type":"string","format":"date","description":"Expiration Date contains the date at which the service agreement is set to expire."},"renewalDate":{"type":"string","format":"date","description":"Renewal Date contains the date at which the service agreement is to be renewed. Renewal date is disabled if renewal is not allowed on the SA type."},"serviceAgreementRelationship":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"serviceAgreementRelationshipId":{"type":"string","maxLength":10,"description":"SA Relationship ID"}}},"sicCode":{"type":"object","description":"Select the SIC Code associated with the customer. This is typically only used for commercial and industrial customers.","properties":{"_link":{"type":"string","description":"_link"},"sicCode":{"type":"string","maxLength":8,"description":"Select the SIC Code associated with the customer. This is typically only used for commercial and industrial customers.","example":"4800 (Transportation)"}}},"currency":{"type":"object","description":"Currency Code defines the currency in which the rate's prices are expressed.","properties":{"_link":{"type":"string","description":"_link"},"currency":{"type":"string","maxLength":3,"description":"Currency Code defines the currency in which the rate's prices are expressed.","example":"USD"}}},"maxBillThreshold":{"type":"number","description":"Maximum Bill Threshold defines the maximum value for a bill segment that is produced in batch. If this value is exceeded, the system generates a bill error.","example":"2000"},"depositInterestCalculated":{"type":"string","format":"date","description":"Deposit Interest Calculated contains the last date the system applied interest. This field is only visible if the SA type has a special role of Cash Deposit.","example":"2018-02-25"},"reviewDate":{"type":"string","format":"date","description":"CIAC Review Date displays the last date that the Contributions In Aid of Construction (CIAC) review process ran for this service agreement. This field is only visible if the SA type indicates this is a CIAC service agreement."},"startReason":{"type":"string","enum":["C   ","S   "],"description":"Start Reason defines if a customer or the system requested to start the service agreement.","example":"C"},"stopReason":{"type":"string","enum":["C   ","S   "],"description":"Stop Reason defines  if a customer or the system requested to stop the service agreement.","example":"C"},"startRequestedBy":{"type":"string","maxLength":50,"description":"Start Requested By can include notes entered in the Requested By field when the service agreement start is submitted. For example, Customer, Jane Smith."},"stopRequestedBy":{"type":"string","maxLength":50,"description":"Stop Requested By can capture notes entered in the Requested By field when this SA stop was submitted (e.g., Customer, Jane Smith )."},"businessActivityDescription":{"type":"string","maxLength":250,"description":"Business Activity further defines what types of activities are served by the contract.","example":"business"},"order":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"orderId":{"type":"string","maxLength":12,"description":"Order ID is the system-assigned unique identifier of the order."}}},"ibSACutoffTime":{"type":"string","description":"If the SA Type has a special role of Interval, you must enter the Cutoff Time. The Cutoff Time is entered in \"legal time\". This value defaults from either the start option or the installation record."},"specialUsage":{"type":"string","enum":["PROP"],"description":"The Special Usage Flag defines  proposal service agreements. Quote creation requires an account has at least one proposal service agreement. A proposal service agreement contains the pricing terms, legal terms, and template consumption used to generate the simulated bill segments that appear on a quote. It might be helpful to view a proposal service agreement as special type of service agreement that is ignored when a bill is produced for an account.","example":"PROP"},"numberOfPaymentPeriods":{"type":"number","maximum":999,"minimum":0,"description":"Number of Payment Periods only appears for loan SA types. It displays the number of periods specified when the loan was first activated.","example":"0"},"recommendationRule":{"type":"string","maxLength":8,"description":"The NBB Recommendation Rule displays the description of the non-billed budget recommendation rule used for this service agreement. This field is only applicable if the service agreement has a special role of Non-billed Budget."},"nonBillAutoPay":{"type":"string","enum":["EXCL","INCL"],"description":"The Scheduled Payment Autopay defines whether the non-billed budget scheduled payments are excluded from automatic payment or included by automatic payment. If the account is not set up for automatic payment for the period that covers the non-billed budget, this flag cannot be set. This field is only applicable if the service agreement has a special role of Non-billed Budget.","example":"INCL"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version","example":"2"},"consumerContractProducts":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"consumerContractProduct":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"consumerContractProductId":{"type":"string","maxLength":14,"description":"Consumer Contract Product"}}},"effectiveDate":{"type":"string","format":"date","description":"Effective Date","example":"2018-02-25"},"consumerContractRule":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"consumerContractRule":{"type":"string","maxLength":30,"description":"Consumer Contract Rule"}}},"consumerProductComponent":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"consumerProductComponent":{"type":"string","maxLength":30,"description":"Consumer Product Component"}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version","example":"2"}}}}}},"characteristics":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"effectiveDate":{"type":"string","format":"date","description":"Effective Date Indicate the effective date of the characteristic type and value. The service point's install date defaults.","example":"2018-02-25"},"characteristicType":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"characteristicType":{"type":"string","maxLength":8,"description":"Characteristic Type indicates the type of characteristic."}}},"typeOfCharacteristicValue":{"type":"string","maxLength":4,"description":"Type of Char Value"},"characteristicValue":{"type":"object","properties":{"_link":{"type":"string","description":"(_link)"},"value":{"type":"string","description":"(value)"},"value2":{"type":"string","description":"(value2)"},"value3":{"type":"string","description":"(value3)"},"value4":{"type":"string","description":"(value4)"},"value5":{"type":"string","description":"(value5)"}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version","example":"2"}}}}}},"contractTerms":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"contractTermType":{"type":"string","enum":["R   ","T   ","V   "],"description":"Billing uses Contract Term information when it calculates a bill segment for the service agreement. The Contract Rider type contains the contract riders that are in effect for the service agreement. The Contract Value type contains the contract values that are in effect for the service agreement. The Tax Exemptions type contains the taxes from which the service agreement is all or partially exempt.","example":"R"},"billFactor":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"billFactor":{"type":"string","maxLength":8,"description":"Bill Factor defines the type of contract rider."}}},"startDate":{"type":"string","format":"date","description":"Start Date defines the date on which the contract rider becomes effective. The service agreement's start date acts as the default value."},"endDate":{"type":"string","format":"date","description":"End Date defines the date on which the contract rider expires.","example":"2018-02-25"},"percentExempt":{"type":"number","maximum":999.9999,"minimum":-999.9999,"description":"Percent Exempt defines the customer tax exemption percent. For example, 90 means the customer is 90% exempt and will only pay 10% of the normal tax rate.","example":"0.0000"},"taxCertification":{"type":"string","maxLength":35,"description":"Tax Certification defines whether the customer has a tax exemption certificate."},"taxExemptType":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"taxExemptType":{"type":"string","maxLength":8,"description":"Tax Exempt Type defines the type of exemption."}}},"touGroup":{"type":"string","maxLength":30,"description":"Indicate the TOU Group that corresponds with the TOU group on the service agreement's TOU Map. Once entered, the collection of TOU codes linked to this TOU group will display."},"value":{"type":"number","maximum":100000000000,"minimum":-100000000000,"description":"Defines the time of use code value."},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version","example":"2"}}}}}},"contractQuantities":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"contractQuantityType":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"contractQuantityType":{"type":"string","maxLength":8,"description":"Contract Quantity Type defines the type of contract quantity."}}},"contractQuantity":{"type":"number","maximum":100000000000,"minimum":-100000000000,"description":"The contract quantity defines the contract quantity.","example":"10.000000"},"effectiveDate":{"type":"string","format":"date","description":"Effective Date defines the date the charge becomes effective. The service agreement's start date acts as the default value.","example":"2018-02-25"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version","example":"2"}}}}}},"contractOptions":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"saContractOptionId":{"type":"string","maxLength":12,"description":"The SA Contract Option ID is the unique identifier of the service agreement or contract option record.","example":"301631110794"},"contractOption":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"contractOptionId":{"type":"string","maxLength":12,"description":"Contract Option ID is a system assigned record key for the contract option linked to the Service Agreement."}}},"effectiveDateTime":{"type":"string","format":"date-time","description":"Effective Date/Time is the date and time that the contract option is in effect for the service agreement.","example":"2018-02-25"},"expirationDateTime":{"type":"string","format":"date-time","description":"Expiration Date/Time is the date and time that the contract option is no longer in effect for the service agreement.","example":"2006-07-01T00:00:00-04:00"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version","example":"2"}}}}}},"billMessages":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"billMessage":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"billMessage":{"type":"string","maxLength":4,"description":"Bill Message"}}},"billMessageType":{"type":"string","enum":["P   ","T   "],"description":"For Bill Message Type, use Temporary to indicate the message should only be linked to the next bill produced for the account. Use Permanent if the message should appear on every bill. Temporary is the default value.","example":"T"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version","example":"2"}}}}}},"recurringChargeHistory":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"effectiveDate":{"type":"string","format":"date","description":"Effective Date is the date the charge becomes effective. The service agreement's start date acts as the default value.","example":"2018-02-25"},"recurringChargeAmount":{"type":"number","description":"The Recurring Charge contains effective-dated information that defines the recurring charge amount used to calculate the service agreement's bill segments.","example":"5000"},"currency":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"currency":{"type":"string","maxLength":3,"description":"Currency Code defines the currency in which the rate's prices are expressed."}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version","example":"2"}}}}}},"rateScheduleHistory":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"effectiveDate":{"type":"string","format":"date","description":"Effective Date is the date the rate becomes effective. The service agreement's start date acts as the default value.","example":"2018-02-25"},"rateSchedule":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"rateSchedule":{"type":"string","maxLength":8,"description":"Rate Schedule defines the rate used to calculate the service agreement's bill segments. Note, you can only choose rates defined as permissible on the service agreement's SA type."}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version","example":"2"}}}}}},"servicePoints":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"servicePoint":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"servicePointId":{"type":"string","maxLength":10,"description":"Service Point ID is the identifier of the service point."}}},"saSPId":{"type":"string","maxLength":10,"description":"System assigned record key for the SA/SP relationship."},"startDateTime":{"type":"string","format":"date-time","description":"Start Date/Time The date and time the service point's consumption starts being billed under the service agreement."},"startMeterRead":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"startMeterReadId":{"type":"string","maxLength":12,"description":"ID of the meter reading record at the time the service point was started for the service agreement."}}},"stopDateTime":{"type":"string","format":"date-time","description":"The date and time the service point's consumption stops being billed under the service agreement."},"howToUseRead":{"type":"string","enum":["+   ","-   ","C   ","S   ","X   "],"description":"How to Use (SP) indicates how billing uses the consumption associated with the service point. This is not applicable for item-type service points.","example":"S"},"stopMeterRead":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"stopMeterReadId":{"type":"string","maxLength":12,"description":"Stop Meter Read is the meter read that records the register values as they appeared when the service point was unlinked from the service agreement."}}},"usePercent":{"type":"number","maximum":999,"minimum":-999,"description":"Use Percent indicates the percentage of this service point's consumption that is billed under the service agreement. This field is not applicable for item-type service points.","example":"100"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version","example":"2"}}}}}},"termsAndConditions":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"termsAndCondition":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"termsAndCondition":{"type":"string","maxLength":12,"description":"Terms and Conditions define the type of terms and conditions.","example":"NGSCC-01"}}},"startDate":{"type":"string","format":"date","description":"Start Date defines the date on which the terms and conditions become effective. The service agreement's start date acts as the default value."},"endDate":{"type":"string","format":"date","description":"End Date defines the date on which the terms and conditions expire. This field is only applicable if the terms and conditions expire on an explicit date.","example":"2018-02-25"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version","example":"2"}}}}}}},"xml":{"name":"C1-ServiceAg"}},"UPDATESERVICEAGREEMENT_response":{"type":"object","properties":{"_self":{"type":"string","description":"_self"},"serviceAgreementId":{"type":"string","maxLength":10,"description":"The Service Agreement ID is a system assigned random number that stays with a service agreement for life."},"status":{"type":"string","enum":["05  ","10  ","20  ","30  ","40  ","50  ","60  ","70  "],"description":"SA Status defines the state of the service agreement.\n* `05  ` - Incomplete,\n* `10  ` - Pending Start,\n* `20  ` - Active,\n* `30  ` - Pending Stop,\n* `40  ` - Stopped,\n* `50  ` - Reactivated,\n* `60  ` - Closed,\n* `70  ` - Canceled","example":"20"},"account":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"accountId":{"type":"string","maxLength":10,"description":"Account ID defines the account that is financially responsible for the service agreement. If you change a service agreement's Account ID, you are effectively transferring this service agreement, and its debt, to the new account.","example":"1589809012"}}},"division":{"type":"object","description":"The CIS division for service agreements is part of the service agreement's SA type. The SA type controls many business rules, and thus all business rules that are on the SA type are defined for a given jurisdiction and SA type combination.","properties":{"_link":{"type":"string","description":"_link"},"division":{"type":"string","maxLength":5,"description":"The CIS division for service agreements is part of the service agreement's SA type. The SA type controls many business rules, and thus all business rules that are on the SA type are defined for a given jurisdiction and SA type combination.","example":"Ohio"}}},"serviceAgreementType":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"serviceAgreementType":{"type":"string","maxLength":8,"description":"SA Type"}}},"startDate":{"type":"string","format":"date","description":"The Start Date defines when the financial relationship begins."},"endDate":{"type":"string","format":"date","description":"The End Date defines when the financial relationship terminates.","example":"2018-02-25"},"customerRead":{"type":"string","enum":["N   ","Y   "],"description":"Customer Read defines whether ae customer read is from the customer's meter.","example":"Y"},"allowEstimates":{"type":"boolean","description":"Allow Estimates defines whether to allow the billing process to estimate this service agreement's consumption if a real meter read is missing at billing time. Disabling this support prohibits estimate meter reads."},"startOption":{"type":"string","maxLength":12,"description":"Start options define default values for a service agreement. For example, the rate schedule, recurring charge amount, contract riders, contract terms, characteristics, terms and conditions, and so on can all be defaulted onto a service agreement using a start option."},"premise":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"premiseId":{"type":"string","maxLength":10,"description":"If the service agreement's rate uses premise-based characteristics for taxation and other purposes, Characteristic Premise ID defines the premise that supplies these characteristics. This field also defines the premise under which the service agreement's bill segments are classified and is used to identify where the service agreement's service is located.","example":"8614900960"}}},"oldAccountId":{"type":"string","maxLength":36,"description":"Old Account ID refers to account ID for service agreements that were converted from a legacy CIS system. The payment upload process uses this field to locate the accounts for payments that reference a legacy account number.","example":"123456789"},"totalAmountToBill":{"type":"number","description":"If the service agreement requires a total amount to bill, the amount is displayed. This field is typically only used on loan or cash deposit service agreements."},"expireDate":{"type":"string","format":"date","description":"Expiration Date contains the date at which the service agreement is set to expire."},"renewalDate":{"type":"string","format":"date","description":"Renewal Date contains the date at which the service agreement is to be renewed. Renewal date is disabled if renewal is not allowed on the SA type."},"serviceAgreementRelationship":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"serviceAgreementRelationshipId":{"type":"string","maxLength":10,"description":"SA Relationship ID"}}},"sicCode":{"type":"object","description":"Select the SIC Code associated with the customer. This is typically only used for commercial and industrial customers.","properties":{"_link":{"type":"string","description":"_link"},"sicCode":{"type":"string","maxLength":8,"description":"Select the SIC Code associated with the customer. This is typically only used for commercial and industrial customers.","example":"4800 (Transportation)"}}},"currency":{"type":"object","description":"Currency Code defines the currency in which the rate's prices are expressed.","properties":{"_link":{"type":"string","description":"_link"},"currency":{"type":"string","maxLength":3,"description":"Currency Code defines the currency in which the rate's prices are expressed.","example":"USD"}}},"maxBillThreshold":{"type":"number","description":"Maximum Bill Threshold defines the maximum value for a bill segment that is produced in batch. If this value is exceeded, the system generates a bill error.","example":"2000"},"depositInterestCalculated":{"type":"string","format":"date","description":"Deposit Interest Calculated contains the last date the system applied interest. This field is only visible if the SA type has a special role of Cash Deposit.","example":"2018-02-25"},"reviewDate":{"type":"string","format":"date","description":"CIAC Review Date displays the last date that the Contributions In Aid of Construction (CIAC) review process ran for this service agreement. This field is only visible if the SA type indicates that it is a CIAC service agreement."},"startReason":{"type":"string","enum":["C   ","S   "],"description":"Start Reason defines if a customer or the system requested to start the service agreement.","example":"C"},"stopReason":{"type":"string","enum":["C   ","S   "],"description":"Stop Reason defines  if a customer or the system requested to stop the service agreement.","example":"C"},"startRequestedBy":{"type":"string","maxLength":50,"description":"Start Requested By can include notes entered in the Requested By field when the service agreement start is submitted. For example, Customer, Jane Smith."},"stopRequestedBy":{"type":"string","maxLength":50,"description":"Stop Requested By can capture notes entered in the Requested By field when this SA stop was submitted (e.g., Customer, Jane Smith )."},"businessActivityDescription":{"type":"string","maxLength":250,"description":"Business Activity further defines what types of activities are served by the contract.","example":"business"},"order":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"orderId":{"type":"string","maxLength":12,"description":"Order ID is the system-assigned unique identifier of the order."}}},"ibSACutoffTime":{"type":"string","description":"If the SA Type has a special role of Interval, you must enter the Cutoff Time. The Cutoff Time is entered in \"legal time\". This value defaults from either the start option or the installation record."},"specialUsage":{"type":"string","enum":["PROP"],"description":"The Special Usage Flag defines  proposal service agreements. Quote creation requires an account has at least one proposal service agreement. A proposal service agreement contains the pricing terms, legal terms, and template consumption used to generate the simulated bill segments that appear on a quote. It might be helpful to view a proposal service agreement as special type of service agreement that is ignored when a bill is produced for an account.","example":"PROP"},"numberOfPaymentPeriods":{"type":"number","maximum":999,"minimum":0,"description":"Number of Payment Periods only appears for loan SA types. It displays the number of periods specified when the loan was first activated.","example":"0"},"recommendationRule":{"type":"string","maxLength":8,"description":"The NBB Recommendation Rule displays the description of the non-billed budget recommendation rule used for this service agreement. This field is only applicable if the service agreement has a special role of Non-billed Budget."},"nonBillAutoPay":{"type":"string","enum":["EXCL","INCL"],"description":"The Scheduled Payment Autopay defines whether the non-billed budget scheduled payments are excluded from automatic payment or included by automatic payment. If the account is not set up for automatic payment for the period that covers the non-billed budget, this flag cannot be set. This field is only applicable if the service agreement has a special role of Non-billed Budget.","example":"INCL"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version","example":"2"},"consumerContractProducts":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"consumerContractProduct":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"consumerContractProductId":{"type":"string","maxLength":14,"description":"Consumer Contract Product"}}},"effectiveDate":{"type":"string","format":"date","description":"Effective Date","example":"2018-02-25"},"consumerContractRule":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"consumerContractRule":{"type":"string","maxLength":30,"description":"Consumer Contract Rule"}}},"consumerProductComponent":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"consumerProductComponent":{"type":"string","maxLength":30,"description":"Consumer Product Component"}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version","example":"2"}}}}}},"characteristics":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"effectiveDate":{"type":"string","format":"date","description":"Effective Date Indicate the effective date of the characteristic type and value. The service point's install date defaults.","example":"2018-02-25"},"characteristicType":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"characteristicType":{"type":"string","maxLength":8,"description":"Characteristic Type indicates the type of characteristic."}}},"typeOfCharacteristicValue":{"type":"string","maxLength":4,"description":"Type of Char Value"},"characteristicValue":{"type":"object","properties":{"_link":{"type":"string","description":"(_link)"},"value":{"type":"string","description":"(value)"},"value2":{"type":"string","description":"(value2)"},"value3":{"type":"string","description":"(value3)"},"value4":{"type":"string","description":"(value4)"},"value5":{"type":"string","description":"(value5)"}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version","example":"2"}}}}}},"contractTerms":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"contractTermType":{"type":"string","enum":["R   ","T   ","V   "],"description":"Billing uses Contract Term information when it calculates a bill segment for the service agreement. The Contract Rider type contains the contract riders that are in effect for the service agreement. The Contract Value type contains the contract values that are in effect for the service agreement. The Tax Exemptions type contains the taxes from which the service agreement is all or partially exempt.","example":"R"},"billFactor":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"billFactor":{"type":"string","maxLength":8,"description":"Bill Factor defines the type of contract rider."}}},"startDate":{"type":"string","format":"date","description":"Start Date defines the date on which the contract rider becomes effective. The service agreement's start date acts as the default value."},"endDate":{"type":"string","format":"date","description":"End Date defines the date on which the contract rider expires.","example":"2018-02-25"},"percentExempt":{"type":"number","maximum":999.9999,"minimum":-999.9999,"description":"Percent Exempt defines the customer tax exemption percent. For example, 90 means the customer is 90% exempt and will only pay 10% of the normal tax rate.","example":"0.0000"},"taxCertification":{"type":"string","maxLength":35,"description":"Tax Certification defines whether the customer has a tax exemption certificate."},"taxExemptType":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"taxExemptType":{"type":"string","maxLength":8,"description":"Tax Exempt Type defines the type of exemption."}}},"touGroup":{"type":"string","maxLength":30,"description":"Indicate the TOU Group that corresponds with the TOU group on the service agreement's TOU Map. Once entered, the collection of TOU codes linked to this TOU group will display."},"value":{"type":"number","maximum":100000000000,"minimum":-100000000000,"description":"Defines the time of use code value."},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version","example":"2"}}}}}},"contractQuantities":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"contractQuantityType":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"contractQuantityType":{"type":"string","maxLength":8,"description":"Contract Quantity Type defines the type of contract quantity."}}},"contractQuantity":{"type":"number","maximum":100000000000,"minimum":-100000000000,"description":"The contract quantity defines the contract quantity.","example":"10.000000"},"effectiveDate":{"type":"string","format":"date","description":"Effective Date defines the date the charge becomes effective. The service agreement's start date acts as the default value.","example":"2018-02-25"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version","example":"2"}}}}}},"contractOptions":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"saContractOptionId":{"type":"string","maxLength":12,"description":"The SA Contract Option ID is the unique identifier of the service agreement or contract option record.","example":"301631110794"},"contractOption":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"contractOptionId":{"type":"string","maxLength":12,"description":"Contract Option ID is a system assigned record key for the contract option linked to the Service Agreement."}}},"effectiveDateTime":{"type":"string","format":"date-time","description":"Effective Date/Time is the date and time that the contract option is in effect for the service agreement.","example":"2018-02-25"},"expirationDateTime":{"type":"string","format":"date-time","description":"Expiration Date/Time is the date and time that the contract option is no longer in effect for the service agreement.","example":"2006-07-01T00:00:00-04:00"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version","example":"2"}}}}}},"billMessages":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"billMessage":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"billMessage":{"type":"string","maxLength":4,"description":"Bill Message"}}},"billMessageType":{"type":"string","enum":["P   ","T   "],"description":"For Bill Message Type, use Temporary to indicate the message should only be linked to the next bill produced for the account. Use Permanent if the message should appear on every bill. Temporary is the default value.","example":"T"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version","example":"2"}}}}}},"recurringChargeHistory":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"effectiveDate":{"type":"string","format":"date","description":"Effective Date is the date the charge becomes effective. The service agreement's start date acts as the default value.","example":"2018-02-25"},"recurringChargeAmount":{"type":"number","description":"The Recurring Charge contains effective-dated information that defines the recurring charge amount used to calculate the service agreement's bill segments.","example":"5000"},"currency":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"currency":{"type":"string","maxLength":3,"description":"Currency Code defines the currency in which the rate's prices are expressed."}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version","example":"2"}}}}}},"rateScheduleHistory":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"effectiveDate":{"type":"string","format":"date","description":"Effective Date is the date the rate becomes effective. The service agreement's start date acts as the default value.","example":"2018-02-25"},"rateSchedule":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"rateSchedule":{"type":"string","maxLength":8,"description":"Rate Schedule defines the rate used to calculate the service agreement's bill segments. Note, you can only choose rates defined as permissible on the service agreement's SA type."}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version","example":"2"}}}}}},"servicePoints":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"servicePoint":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"servicePointId":{"type":"string","maxLength":10,"description":"Service Point ID is the identifier of the service point."}}},"saSPId":{"type":"string","maxLength":10,"description":"System assigned record key for the SA/SP relationship."},"startDateTime":{"type":"string","format":"date-time","description":"Start Date/Time The date and time the service point's consumption starts being billed under the service agreement."},"startMeterRead":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"startMeterReadId":{"type":"string","maxLength":12,"description":"ID of the meter reading record at the time the service point was started for the service agreement."}}},"stopDateTime":{"type":"string","format":"date-time","description":"The date and time the service point's consumption stops being billed under the service agreement."},"howToUseRead":{"type":"string","enum":["+   ","-   ","C   ","S   ","X   "],"description":"How to Use (SP) indicates how billing uses the consumption associated with the service point. This is not applicable for item-type service points.","example":"S"},"stopMeterRead":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"stopMeterReadId":{"type":"string","maxLength":12,"description":"Stop Meter Read is the meter read that records the register values as they appeared when the service point was unlinked from the service agreement."}}},"usePercent":{"type":"number","maximum":999,"minimum":-999,"description":"Use Percent indicates the percentage of this service point's consumption that is billed under the service agreement. This field is not applicable for item-type service points.","example":"100"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version","example":"2"}}}}}},"termsAndConditions":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"termsAndCondition":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"termsAndCondition":{"type":"string","maxLength":12,"description":"Terms and Conditions define the type of terms and conditions.","example":"NGSCC-01"}}},"startDate":{"type":"string","format":"date","description":"Start Date defines the date on which the terms and conditions become effective. The service agreement's start date acts as the default value."},"endDate":{"type":"string","format":"date","description":"End Date defines the date on which the terms and conditions expire. This field is only applicable if the terms and conditions expire on an explicit date.","example":"2018-02-25"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version","example":"2"}}}}}}},"xml":{"name":"C1-ServiceAg"}},"CREATESERVICEAGREEMENT_request":{"type":"object","properties":{"serviceAgreementId":{"type":"string","maxLength":10,"description":"The Service Agreement ID is a system assigned random number that stays with a service agreement for life."},"status":{"type":"string","enum":["05  ","10  ","20  ","30  ","40  ","50  ","60  ","70  "],"description":"SA Status defines the state of the service agreement.\n* `05  ` - Incomplete,\n* `10  ` - Pending Start,\n* `20  ` - Active,\n* `30  ` - Pending Stop,\n* `40  ` - Stopped,\n* `50  ` - Reactivated,\n* `60  ` - Closed,\n* `70  ` - Canceled","example":"20"},"account":{"type":"object","properties":{"accountId":{"type":"string","maxLength":10,"description":"Account ID defines the account that is financially responsible for the service agreement. If you change a service agreement's Account ID, you are effectively transferring this service agreement, and its debt, to the new account.","example":"1589809012"}}},"division":{"type":"object","description":"The CIS division for service agreements is part of the service agreement's SA type. The SA type controls many business rules, and thus all business rules that are on the SA type are defined for a given jurisdiction and SA type combination.","properties":{"division":{"type":"string","maxLength":5,"description":"The CIS division for service agreements is part of the service agreement's SA type. The SA type controls many business rules, and thus all business rules that are on the SA type are defined for a given jurisdiction and SA type combination.","example":"Ohio"}}},"serviceAgreementType":{"type":"object","properties":{"serviceAgreementType":{"type":"string","maxLength":8,"description":"SA Type"}}},"startDate":{"type":"string","format":"date","description":"The Start Date defines when the financial relationship begins."},"endDate":{"type":"string","format":"date","description":"The End Date defines when the financial relationship terminates.","example":"2018-02-25"},"customerRead":{"type":"string","enum":["N   ","Y   "],"description":"Customer Read defines whether a customer read is from the customer's meter.","example":"Y"},"allowEstimates":{"type":"boolean","description":"Allow Estimates defines whether to allow the billing process to estimate this service agreement's consumption if a real meter read is missing at billing time. Disabling this support prohibits estimate meter reads."},"startOption":{"type":"string","maxLength":12,"description":"Start options define default values for a service agreement. For example, the rate schedule, recurring charge amount, contract riders, contract terms, characteristics, terms and conditions, and so on can all be defaulted onto a service agreement using a start option."},"premise":{"type":"object","properties":{"premiseId":{"type":"string","maxLength":10,"description":"If the service agreement's rate uses premise-based characteristics for taxation and other purposes, Characteristic Premise ID defines the premise that supplies these characteristics. This field also defines the premise under which the service agreement's bill segments are classified and is used to identify where the service agreement's service is located.","example":"8614900960"}}},"oldAccountId":{"type":"string","maxLength":36,"description":"Old Account ID refers to account ID for service agreements that were converted from a legacy CIS system. The payment upload process uses this field to locate the accounts for payments that reference a legacy account number.","example":"123456789"},"totalAmountToBill":{"type":"number","description":"If the service agreement requires a total amount to bill, the amount is displayed. This field is typically only used on loan or cash deposit service agreements."},"expireDate":{"type":"string","format":"date","description":"Expiration Date contains the date at which the service agreement is set to expire."},"renewalDate":{"type":"string","format":"date","description":"Renewal Date contains the date at which the service agreement is to be renewed. Renewal date is disabled if renewal is not allowed on the SA type."},"serviceAgreementRelationship":{"type":"object","properties":{"serviceAgreementRelationshipId":{"type":"string","maxLength":10,"description":"SA Relationship ID"}}},"sicCode":{"type":"object","description":"Select the SIC Code associated with the customer. This is typically only used for commercial and industrial customers.","properties":{"sicCode":{"type":"string","maxLength":8,"description":"Select the SIC Code associated with the customer. This is typically only used for commercial and industrial customers.","example":"4800 (Transportation)"}}},"currency":{"type":"object","description":"Currency Code defines the currency in which the rate's prices are expressed.","properties":{"currency":{"type":"string","maxLength":3,"description":"Currency Code defines the currency in which the rate's prices are expressed.","example":"USD"}}},"maxBillThreshold":{"type":"number","description":"Maximum Bill Threshold defines the maximum value for a bill segment that is produced in batch. If this value is exceeded, the system generates a bill error.","example":"2000"},"depositInterestCalculated":{"type":"string","format":"date","description":"Deposit Interest Calculated contains the last date the system applied interest. This field is only visible if the SA type has a special role of Cash Deposit.","example":"2018-02-25"},"reviewDate":{"type":"string","format":"date","description":"CIAC Review Date displays the last date that the Contributions In Aid of Construction (CIAC) review process ran for this service agreement. This field is only visible if the SA type indicates that it is a CIAC service agreement."},"startReason":{"type":"string","enum":["C   ","S   "],"description":"Start Reason defines if a customer or the system requested to start the service agreement.","example":"C"},"stopReason":{"type":"string","enum":["C   ","S   "],"description":"Stop Reason defines  if a customer or the system requested to stop the service agreement.","example":"C"},"startRequestedBy":{"type":"string","maxLength":50,"description":"Start Requested By can include notes entered in the Requested By field when the service agreement start is submitted. For example, Customer, Jane Smith."},"stopRequestedBy":{"type":"string","maxLength":50,"description":"Stop Requested By can capture notes entered in the Requested By field when this SA stop was submitted (e.g., Customer, Jane Smith )."},"businessActivityDescription":{"type":"string","maxLength":250,"description":"Business Activity further defines what types of activities are served by the contract.","example":"business"},"order":{"type":"object","properties":{"orderId":{"type":"string","maxLength":12,"description":"Order ID is the system-assigned unique identifier of the order."}}},"ibSACutoffTime":{"type":"string","description":"If the SA Type has a special role of Interval, you must enter the Cutoff Time. The Cutoff Time is entered in \"legal time\". This value defaults from either the start option or the installation record."},"specialUsage":{"type":"string","enum":["PROP"],"description":"The Special Usage Flag defines  proposal service agreements. Quote creation requires an account has at least one proposal service agreement. A proposal service agreement contains the pricing terms, legal terms, and template consumption used to generate the simulated bill segments that appear on a quote. It might be helpful to view a proposal service agreement as special type of service agreement that is ignored when a bill is produced for an account.","example":"PROP"},"numberOfPaymentPeriods":{"type":"number","maximum":999,"minimum":0,"description":"Number of Payment Periods only appears for loan SA types. It displays the number of periods specified when the loan was first activated.","example":"0"},"recommendationRule":{"type":"string","maxLength":8,"description":"The NBB Recommendation Rule displays the description of the non-billed budget recommendation rule used for this service agreement. This field is only applicable if the service agreement has a special role of Non-billed Budget."},"nonBillAutoPay":{"type":"string","enum":["EXCL","INCL"],"description":"The Scheduled Payment Autopay defines whether the non-billed budget scheduled payments are excluded from automatic payment or included by automatic payment. If the account is not set up for automatic payment for the period that covers the non-billed budget, this flag cannot be set. This field is only applicable if the service agreement has a special role of Non-billed Budget.","example":"INCL"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version","example":"2"},"consumerContractProducts":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"consumerContractProduct":{"type":"object","properties":{"consumerContractProductId":{"type":"string","maxLength":14,"description":"Consumer Contract Product"}}},"effectiveDate":{"type":"string","format":"date","description":"Effective Date","example":"2018-02-25"},"consumerContractRule":{"type":"object","properties":{"consumerContractRule":{"type":"string","maxLength":30,"description":"Consumer Contract Rule"}}},"consumerProductComponent":{"type":"object","properties":{"consumerProductComponent":{"type":"string","maxLength":30,"description":"Consumer Product Component"}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version","example":"2"}}}}}},"characteristics":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"effectiveDate":{"type":"string","format":"date","description":"Effective Date Indicate the effective date of the characteristic type and value. The service point's install date defaults.","example":"2018-02-25"},"characteristicType":{"type":"object","properties":{"characteristicType":{"type":"string","maxLength":8,"description":"Characteristic Type indicates the type of characteristic."}}},"typeOfCharacteristicValue":{"type":"string","maxLength":4,"description":"Type of Char Value"},"characteristicValue":{"type":"object","properties":{"_link":{"type":"string","description":"(_link)"},"value":{"type":"string","description":"(value)"},"value2":{"type":"string","description":"(value2)"},"value3":{"type":"string","description":"(value3)"},"value4":{"type":"string","description":"(value4)"},"value5":{"type":"string","description":"(value5)"}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version","example":"2"}}}}}},"contractTerms":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"contractTermType":{"type":"string","enum":["R   ","T   ","V   "],"description":"Billing uses Contract Term information when it calculates a bill segment for the service agreement. The Contract Rider type contains the contract riders that are in effect for the service agreement. The Contract Value type contains the contract values that are in effect for the service agreement. The Tax Exemptions type contains the taxes from which the service agreement is all or partially exempt.","example":"R"},"billFactor":{"type":"object","properties":{"billFactor":{"type":"string","maxLength":8,"description":"Bill Factor defines the type of contract rider."}}},"startDate":{"type":"string","format":"date","description":"Start Date defines the date on which the contract rider becomes effective. The service agreement's start date acts as the default value."},"endDate":{"type":"string","format":"date","description":"End Date defines the date on which the contract rider expires.","example":"2018-02-25"},"percentExempt":{"type":"number","maximum":999.9999,"minimum":-999.9999,"description":"Percent Exempt defines the customer tax exemption percent. For example, 90 means the customer is 90% exempt and will only pay 10% of the normal tax rate.","example":"0.0000"},"taxCertification":{"type":"string","maxLength":35,"description":"Tax Certification defines whether the customer has a tax exemption certificate."},"taxExemptType":{"type":"object","properties":{"taxExemptType":{"type":"string","maxLength":8,"description":"Tax Exempt Type defines the type of exemption."}}},"touGroup":{"type":"string","maxLength":30,"description":"Indicate the TOU Group that corresponds with the TOU group on the service agreement's TOU Map. Once entered, the collection of TOU codes linked to this TOU group will display."},"value":{"type":"number","maximum":100000000000,"minimum":-100000000000,"description":"Defines the time of use code value."},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version","example":"2"}}}}}},"contractQuantities":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"contractQuantityType":{"type":"object","properties":{"contractQuantityType":{"type":"string","maxLength":8,"description":"Contract Quantity Type defines the type of contract quantity."}}},"contractQuantity":{"type":"number","maximum":100000000000,"minimum":-100000000000,"description":"The contract quantity defines the contract quantity.","example":"10.000000"},"effectiveDate":{"type":"string","format":"date","description":"Effective Date defines the date the charge becomes effective. The service agreement's start date acts as the default value.","example":"2018-02-25"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version","example":"2"}}}}}},"contractOptions":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"saContractOptionId":{"type":"string","maxLength":12,"description":"The SA Contract Option ID is the unique identifier of the service agreement or contract option record.","example":"301631110794"},"contractOption":{"type":"object","properties":{"contractOptionId":{"type":"string","maxLength":12,"description":"Contract Option ID is a system assigned record key for the contract option linked to the Service Agreement."}}},"effectiveDateTime":{"type":"string","format":"date-time","description":"Effective Date/Time is the date and time that the contract option is in effect for the service agreement.","example":"2018-02-25"},"expirationDateTime":{"type":"string","format":"date-time","description":"Expiration Date/Time is the date and time that the contract option is no longer in effect for the service agreement.","example":"2006-07-01T00:00:00-04:00"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version","example":"2"}}}}}},"billMessages":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"billMessage":{"type":"object","properties":{"billMessage":{"type":"string","maxLength":4,"description":"Bill Message"}}},"billMessageType":{"type":"string","enum":["P   ","T   "],"description":"For Bill Message Type, use Temporary to indicate the message should only be linked to the next bill produced for the account. Use Permanent if the message should appear on every bill. Temporary is the default value.","example":"T"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version","example":"2"}}}}}},"recurringChargeHistory":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"effectiveDate":{"type":"string","format":"date","description":"Effective Date is the date the charge becomes effective. The service agreement's start date acts as the default value.","example":"2018-02-25"},"recurringChargeAmount":{"type":"number","description":"The Recurring Charge contains effective-dated information that defines the recurring charge amount used to calculate the service agreement's bill segments.","example":"5000"},"currency":{"type":"object","properties":{"currency":{"type":"string","maxLength":3,"description":"Currency Code defines the currency in which the rate's prices are expressed."}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version","example":"2"}}}}}},"rateScheduleHistory":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"effectiveDate":{"type":"string","format":"date","description":"Effective Date is the date the rate becomes effective. The service agreement's start date acts as the default value.","example":"2018-02-25"},"rateSchedule":{"type":"object","properties":{"rateSchedule":{"type":"string","maxLength":8,"description":"Rate Schedule defines the rate used to calculate the service agreement's bill segments. Note, you can only choose rates defined as permissible on the service agreement's SA type."}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version","example":"2"}}}}}},"servicePoints":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"servicePoint":{"type":"object","properties":{"servicePointId":{"type":"string","maxLength":10,"description":"Service Point ID is the identifier of the service point."}}},"saSPId":{"type":"string","maxLength":10,"description":"System assigned record key for the SA/SP relationship."},"startDateTime":{"type":"string","format":"date-time","description":"Start Date/Time The date and time the service point's consumption starts being billed under the service agreement."},"startMeterRead":{"type":"object","properties":{"startMeterReadId":{"type":"string","maxLength":12,"description":"ID of the meter reading record at the time the service point was started for the service agreement."}}},"stopDateTime":{"type":"string","format":"date-time","description":"The date and time the service point's consumption stops being billed under the service agreement."},"howToUseRead":{"type":"string","enum":["+   ","-   ","C   ","S   ","X   "],"description":"How to Use (SP) indicates how billing uses the consumption associated with the service point. This is not applicable for item-type service points.","example":"S"},"stopMeterRead":{"type":"object","properties":{"stopMeterReadId":{"type":"string","maxLength":12,"description":"Stop Meter Read is the meter read that records the register values as they appeared when the service point was unlinked from the service agreement."}}},"usePercent":{"type":"number","maximum":999,"minimum":-999,"description":"Use Percent indicates the percentage of this service point's consumption that is billed under the service agreement. This field is not applicable for item-type service points.","example":"100"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version","example":"2"}}}}}},"termsAndConditions":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"termsAndCondition":{"type":"object","properties":{"termsAndCondition":{"type":"string","maxLength":12,"description":"Terms and Conditions define the type of terms and conditions.","example":"NGSCC-01"}}},"startDate":{"type":"string","format":"date","description":"Start Date defines the date on which the terms and conditions become effective. The service agreement's start date acts as the default value."},"endDate":{"type":"string","format":"date","description":"End Date defines the date on which the terms and conditions expire. This field is only applicable if the terms and conditions expire on an explicit date.","example":"2018-02-25"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version","example":"2"}}}}}}},"xml":{"name":"C1-ServiceAg"}},"GETSERVICEAGREEMENT_response":{"type":"object","properties":{"_self":{"type":"string","description":"_self"},"serviceAgreementId":{"type":"string","maxLength":10,"description":"The Service Agreement ID is a system assigned random number that stays with a service agreement for life."},"status":{"type":"string","enum":["05  ","10  ","20  ","30  ","40  ","50  ","60  ","70  "],"description":"SA Status defines the state of the service agreement.\n* `05  ` - Incomplete,\n* `10  ` - Pending Start,\n* `20  ` - Active,\n* `30  ` - Pending Stop,\n* `40  ` - Stopped,\n* `50  ` - Reactivated,\n* `60  ` - Closed,\n* `70  ` - Canceled","example":"20"},"account":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"accountId":{"type":"string","maxLength":10,"description":"Account ID defines the account that is financially responsible for the service agreement. If you change a service agreement's Account ID, you are effectively transferring this service agreement, and its debt, to the new account.","example":"1589809012"}}},"division":{"type":"object","description":"The CIS division for service agreements is part of the service agreement's SA type. The SA type controls many business rules, and thus all business rules that are on the SA type are defined for a given jurisdiction and SA type combination.","properties":{"_link":{"type":"string","description":"_link"},"division":{"type":"string","maxLength":5,"description":"The CIS division for service agreements is part of the service agreement's SA type. The SA type controls many business rules, and thus all business rules that are on the SA type are defined for a given jurisdiction and SA type combination.","example":"Ohio"}}},"serviceAgreementType":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"serviceAgreementType":{"type":"string","maxLength":8,"description":"SA Type"}}},"startDate":{"type":"string","format":"date","description":"The Start Date defines when the financial relationship begins."},"endDate":{"type":"string","format":"date","description":"The End Date defines when the financial relationship terminates.","example":"2018-02-25"},"customerRead":{"type":"string","enum":["N   ","Y   "],"description":"Customer Read defines whether a customer read is from the customer's meter.","example":"Y"},"allowEstimates":{"type":"boolean","description":"Allow Estimates defines whether to allow the billing process to estimate this service agreement's consumption if a real meter read is missing at billing time. Disabling this support prohibits estimate meter reads."},"startOption":{"type":"string","maxLength":12,"description":"Start options define default values for a service agreement. For example, the rate schedule, recurring charge amount, contract riders, contract terms, characteristics, terms and conditions, and so on can all be defaulted onto a service agreement using a start option."},"premise":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"premiseId":{"type":"string","maxLength":10,"description":"If the service agreement's rate uses premise-based characteristics for taxation and other purposes, Characteristic Premise ID defines the premise that supplies these characteristics. This field also defines the premise under which the service agreement's bill segments are classified and is used to identify where the service agreement's service is located.","example":"8614900960"}}},"oldAccountId":{"type":"string","maxLength":36,"description":"Old Account ID refers to account ID for service agreements that were converted from a legacy CIS system. The payment upload process uses this field to locate the accounts for payments that reference a legacy account number.","example":"123456789"},"totalAmountToBill":{"type":"number","description":"If the service agreement requires a total amount to bill, the amount is displayed. This field is typically only used on loan or cash deposit service agreements."},"expireDate":{"type":"string","format":"date","description":"Expiration Date contains the date at which the service agreement is set to expire."},"renewalDate":{"type":"string","format":"date","description":"Renewal Date contains the date at which the service agreement is to be renewed. Renewal date is disabled if renewal is not allowed on the SA type."},"serviceAgreementRelationship":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"serviceAgreementRelationshipId":{"type":"string","maxLength":10,"description":"SA Relationship ID"}}},"sicCode":{"type":"object","description":"Select the SIC Code associated with the customer. This is typically only used for commercial and industrial customers.","properties":{"_link":{"type":"string","description":"_link"},"sicCode":{"type":"string","maxLength":8,"description":"Select the SIC Code associated with the customer. This is typically only used for commercial and industrial customers.","example":"4800 (Transportation)"}}},"currency":{"type":"object","description":"Currency Code defines the currency in which the rate's prices are expressed.","properties":{"_link":{"type":"string","description":"_link"},"currency":{"type":"string","maxLength":3,"description":"Currency Code defines the currency in which the rate's prices are expressed.","example":"USD"}}},"maxBillThreshold":{"type":"number","description":"Maximum Bill Threshold defines the maximum value for a bill segment that is produced in batch. If this value is exceeded, the system generates a bill error.","example":"2000"},"depositInterestCalculated":{"type":"string","format":"date","description":"Deposit Interest Calculated contains the last date the system applied interest. This field is only visible if the SA type has a special role of Cash Deposit.","example":"2018-02-25"},"reviewDate":{"type":"string","format":"date","description":"CIAC Review Date displays the last date that the Contributions In Aid of Construction (CIAC) review process ran for this service agreement. This field is only visible if the SA type indicates that it is a CIAC service agreement."},"startReason":{"type":"string","enum":["C   ","S   "],"description":"Start Reason defines if a customer or the system requested to start the service agreement.","example":"C"},"stopReason":{"type":"string","enum":["C   ","S   "],"description":"Stop Reason defines  if a customer or the system requested to stop the service agreement.","example":"C"},"startRequestedBy":{"type":"string","maxLength":50,"description":"Start Requested By can include notes entered in the Requested By field when the service agreement start is submitted. For example, Customer, Jane Smith."},"stopRequestedBy":{"type":"string","maxLength":50,"description":"Stop Requested By can capture notes entered in the Requested By field when this SA stop was submitted (e.g., Customer, Jane Smith )."},"businessActivityDescription":{"type":"string","maxLength":250,"description":"Business Activity further defines what types of activities are served by the contract.","example":"business"},"order":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"orderId":{"type":"string","maxLength":12,"description":"Order ID is the system-assigned unique identifier of the order."}}},"ibSACutoffTime":{"type":"string","description":"If the SA Type has a special role of Interval, you must enter the Cutoff Time. The Cutoff Time is entered in \"legal time\". This value defaults from either the start option or the installation record."},"specialUsage":{"type":"string","enum":["PROP"],"description":"The Special Usage Flag defines  proposal service agreements. Quote creation requires an account has at least one proposal service agreement. A proposal service agreement contains the pricing terms, legal terms, and template consumption used to generate the simulated bill segments that appear on a quote. It might be helpful to view a proposal service agreement as special type of service agreement that is ignored when a bill is produced for an account.","example":"PROP"},"numberOfPaymentPeriods":{"type":"number","maximum":999,"minimum":0,"description":"Number of Payment Periods only appears for loan SA types. It displays the number of periods specified when the loan was first activated.","example":"0"},"recommendationRule":{"type":"string","maxLength":8,"description":"The NBB Recommendation Rule displays the description of the non-billed budget recommendation rule used for this service agreement. This field is only applicable if the service agreement has a special role of Non-billed Budget."},"nonBillAutoPay":{"type":"string","enum":["EXCL","INCL"],"description":"The Scheduled Payment Autopay defines whether the non-billed budget scheduled payments are excluded from automatic payment or included by automatic payment. If the account is not set up for automatic payment for the period that covers the non-billed budget, this flag cannot be set. This field is only applicable if the service agreement has a special role of Non-billed Budget.","example":"INCL"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version","example":"2"},"consumerContractProducts":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"consumerContractProduct":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"consumerContractProductId":{"type":"string","maxLength":14,"description":"Consumer Contract Product"}}},"effectiveDate":{"type":"string","format":"date","description":"Effective Date indicates the effective date of the characteristic type and value. The service point's install date is the default value.","example":"2018-02-25"},"consumerContractRule":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"consumerContractRule":{"type":"string","maxLength":30,"description":"Consumer Contract Rule"}}},"consumerProductComponent":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"consumerProductComponent":{"type":"string","maxLength":30,"description":"Consumer Product Component"}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version","example":"2"}}}}}},"characteristics":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"effectiveDate":{"type":"string","format":"date","description":"Effective Date Indicate the effective date of the characteristic type and value. The service point's install date defaults.","example":"2018-02-25"},"characteristicType":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"characteristicType":{"type":"string","maxLength":8,"description":"Characteristic Type indicates the type of characteristic."}}},"typeOfCharacteristicValue":{"type":"string","maxLength":4,"description":"Type of Char Value"},"characteristicValue":{"type":"object","properties":{"_link":{"type":"string","description":"(_link)"},"value":{"type":"string","description":"(value)"},"value2":{"type":"string","description":"(value2)"},"value3":{"type":"string","description":"(value3)"},"value4":{"type":"string","description":"(value4)"},"value5":{"type":"string","description":"(value5)"}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version","example":"2"}}}}}},"contractTerms":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"contractTermType":{"type":"string","enum":["R   ","T   ","V   "],"description":"Billing uses Contract Term information when it calculates a bill segment for the service agreement. The Contract Rider type contains the contract riders that are in effect for the service agreement. The Contract Value type contains the contract values that are in effect for the service agreement. The Tax Exemptions type contains the taxes from which the service agreement is all or partially exempt.","example":"R"},"billFactor":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"billFactor":{"type":"string","maxLength":8,"description":"Bill Factor defines the type of contract rider."}}},"startDate":{"type":"string","format":"date","description":"Start Date defines the date on which the contract rider becomes effective. The service agreement's start date acts as the default value."},"endDate":{"type":"string","format":"date","description":"End Date defines the date on which the contract rider expires.","example":"2018-02-25"},"percentExempt":{"type":"number","maximum":999.9999,"minimum":-999.9999,"description":"Percent Exempt defines the customer tax exemption percent. For example, 90 means the customer is 90% exempt and will only pay 10% of the normal tax rate.","example":"0.0000"},"taxCertification":{"type":"string","maxLength":35,"description":"Tax Certification defines whether the customer has a tax exemption certificate."},"taxExemptType":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"taxExemptType":{"type":"string","maxLength":8,"description":"Tax Exempt Type defines the type of exemption."}}},"touGroup":{"type":"string","maxLength":30,"description":"Indicate the TOU Group that corresponds with the TOU group on the service agreement's TOU Map. Once entered, the collection of TOU codes linked to this TOU group will display."},"value":{"type":"number","maximum":100000000000,"minimum":-100000000000,"description":"Defines the time of use code value."},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version","example":"2"}}}}}},"contractQuantities":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"contractQuantityType":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"contractQuantityType":{"type":"string","maxLength":8,"description":"Contract Quantity Type defines the type of contract quantity."}}},"contractQuantity":{"type":"number","maximum":100000000000,"minimum":-100000000000,"description":"The contract quantity defines the contract quantity.","example":"10.000000"},"effectiveDate":{"type":"string","format":"date","description":"Effective Date defines the date the charge becomes effective. The service agreement's start date acts as the default value.","example":"2018-02-25"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version","example":"2"}}}}}},"contractOptions":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"saContractOptionId":{"type":"string","maxLength":12,"description":"The SA Contract Option ID is the unique identifier of the service agreement or contract option record.","example":"301631110794"},"contractOption":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"contractOptionId":{"type":"string","maxLength":12,"description":"Contract Option ID is a system assigned record key for the contract option linked to the Service Agreement."}}},"effectiveDateTime":{"type":"string","format":"date-time","description":"Effective Date/Time is the date and time that the contract option is in effect for the service agreement.","example":"2018-02-25"},"expirationDateTime":{"type":"string","format":"date-time","description":"Expiration Date/Time is the date and time that the contract option is no longer in effect for the service agreement.","example":"2006-07-01T00:00:00-04:00"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version","example":"2"}}}}}},"billMessages":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"billMessage":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"billMessage":{"type":"string","maxLength":4,"description":"Bill Message"}}},"billMessageType":{"type":"string","enum":["P   ","T   "],"description":"For Bill Message Type, use Temporary to indicate the message should only be linked to the next bill produced for the account. Use Permanent if the message should appear on every bill. Temporary is the default value.","example":"T"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version","example":"2"}}}}}},"recurringChargeHistory":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"effectiveDate":{"type":"string","format":"date","description":"Effective Date is the date the charge becomes effective. The service agreement's start date acts as the default value.","example":"2018-02-25"},"recurringChargeAmount":{"type":"number","description":"The Recurring Charge contains effective-dated information that defines the recurring charge amount used to calculate the service agreement's bill segments.","example":"5000"},"currency":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"currency":{"type":"string","maxLength":3,"description":"Currency Code defines the currency in which the rate's prices are expressed."}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version","example":"2"}}}}}},"rateScheduleHistory":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"effectiveDate":{"type":"string","format":"date","description":"Effective Date is the date the rate becomes effective. The service agreement's start date acts as the default value.","example":"2018-02-25"},"rateSchedule":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"rateSchedule":{"type":"string","maxLength":8,"description":"Rate Schedule defines the rate used to calculate the service agreement's bill segments. Note, you can only choose rates defined as permissible on the service agreement's SA type."}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version","example":"2"}}}}}},"servicePoints":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"servicePoint":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"servicePointId":{"type":"string","maxLength":10,"description":"Service Point ID is the identifier of the service point."}}},"saSPId":{"type":"string","maxLength":10,"description":"System assigned record key for the SA/SP relationship."},"startDateTime":{"type":"string","format":"date-time","description":"Start Date/Time The date and time the service point's consumption starts being billed under the service agreement."},"startMeterRead":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"startMeterReadId":{"type":"string","maxLength":12,"description":"ID of the meter reading record at the time the service point was started for the service agreement."}}},"stopDateTime":{"type":"string","format":"date-time","description":"The date and time the service point's consumption stops being billed under the service agreement."},"howToUseRead":{"type":"string","enum":["+   ","-   ","C   ","S   ","X   "],"description":"How to Use (SP) indicates how billing uses the consumption associated with the service point. This is not applicable for item-type service points.","example":"S"},"stopMeterRead":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"stopMeterReadId":{"type":"string","maxLength":12,"description":"Stop Meter Read is the meter read that records the register values as they appeared when the service point was unlinked from the service agreement."}}},"usePercent":{"type":"number","maximum":999,"minimum":-999,"description":"Use Percent indicates the percentage of this service point's consumption that is billed under the service agreement. This field is not applicable for item-type service points.","example":"100"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version","example":"2"}}}}}},"termsAndConditions":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"termsAndCondition":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"termsAndCondition":{"type":"string","maxLength":12,"description":"Terms and Conditions define the type of terms and conditions.","example":"NGSCC-01"}}},"startDate":{"type":"string","format":"date","description":"Start Date defines the date on which the terms and conditions become effective. The service agreement's start date acts as the default value."},"endDate":{"type":"string","format":"date","description":"End Date defines the date on which the terms and conditions expire. This field is only applicable if the terms and conditions expire on an explicit date.","example":"2018-02-25"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version","example":"2"}}}}}}},"xml":{"name":"C1-ServiceAg"}},"DELETESERVICEAGREEMENT_response":{"type":"object","properties":{"serviceAgreementId":{"type":"string","maxLength":10,"description":"The Service Agreement ID is a system assigned random number that stays with a service agreement for life."}},"xml":{"name":"C1-DeleteSA"}},"CREATEITEM_request":{"type":"object","properties":{"itemId":{"type":"string","maxLength":12,"description":"The Device or meter identifier in the source system.","example":"881940890969"},"itemType":{"type":"object","properties":{"itemType":{"type":"string","maxLength":30,"description":"Device Type"}}},"boStatus":{"type":"string","maxLength":12,"description":"Status of the item device","example":"ACTIVE"},"serialNumber":{"type":"string","maxLength":120,"description":"The device identifier for the Serial Number.","example":"SV100-60012"},"badgeNumber":{"type":"string","maxLength":120,"description":"The device identifier for the Badge Number.","example":"32505964"},"internalNumber":{"type":"string","maxLength":120,"description":"The device identifier value for the internal number.","example":"I-20140306001"},"assetId":{"type":"string","maxLength":120,"description":"The device identifier for the Asset ID.","example":"LP3211"},"externalId":{"type":"string","maxLength":60,"description":"External identifier for the item device.","example":"29256350"},"mdmExternalId":{"type":"string","maxLength":60,"description":"MDM External ID for the item device.","example":"32505964"},"specification":{"type":"string","maxLength":120,"description":"Specifications are used to define the manufacturer, model, and other information about the template device.","example":"BIT_01"},"configuration":{"type":"string","maxLength":120,"description":"Configuration is the type of configuration","example":"Badged Item KW"},"manufacturer":{"type":"object","description":"The Manufacturer of the device.","properties":{"manufacturer":{"type":"string","maxLength":30,"description":"The Manufacturer of the device.","example":"GE"}}},"model":{"type":"string","maxLength":30,"description":"The specific model number of the device provided by the manufacturer.","example":"ELECTRIC 4"},"retirementDateTime":{"type":"string","format":"date-time","description":"Retirement Date/Time","example":"2020-10-13T00:00:00-07:00"},"statusDateTime":{"type":"string","format":"date-time","description":"Status Date/Time","example":"2020-10-13T02:16:42-07:00"},"creationDateTime":{"type":"string","format":"date-time","description":"Create Date/Time","example":"2020-10-12T22:35:28-07:00"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks.","example":"5"}},"xml":{"name":"D1-Item"}},"CREATEITEM_response":{"type":"object","properties":{"_self":{"type":"string","description":"_self"},"itemId":{"type":"string","maxLength":12,"description":"The Device or meter identifier in the source system.","example":"881940890969"},"itemType":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"itemType":{"type":"string","maxLength":30,"description":"Device Type"}}},"boStatus":{"type":"string","maxLength":12,"description":"Status of the item device","example":"ACTIVE"},"serialNumber":{"type":"string","maxLength":120,"description":"The device identifier for the Serial Number.","example":"SV100-60012"},"badgeNumber":{"type":"string","maxLength":120,"description":"The device identifier for the Badge Number.","example":"32505964"},"internalNumber":{"type":"string","maxLength":120,"description":"The device identifier value for the internal number.","example":"I-20140306001"},"assetId":{"type":"string","maxLength":120,"description":"The device identifier for the Asset ID.","example":"LP3211"},"externalId":{"type":"string","maxLength":60,"description":"External identifier for the item device.","example":"29256350"},"mdmExternalId":{"type":"string","maxLength":60,"description":"MDM External ID for the item device.","example":"32505964"},"specification":{"type":"string","maxLength":120,"description":"Specifications are used to define the manufacturer, model, and other information about the template device.","example":"BIT_01"},"configuration":{"type":"string","maxLength":120,"description":"Configuration is the type of configuration","example":"Badged Item KW"},"manufacturer":{"type":"object","description":"The Manufacturer of the device.","properties":{"_link":{"type":"string","description":"_link"},"manufacturer":{"type":"string","maxLength":30,"description":"The Manufacturer of the device.","example":"GE"}}},"model":{"type":"string","maxLength":30,"description":"The specific model number of the device provided by the manufacturer.","example":"ELECTRIC 4"},"retirementDateTime":{"type":"string","format":"date-time","description":"Retirement Date/Time","example":"2020-10-13T00:00:00-07:00"},"statusDateTime":{"type":"string","format":"date-time","description":"Status Date/Time","example":"2020-10-13T02:16:42-07:00"},"creationDateTime":{"type":"string","format":"date-time","description":"Create Date/Time","example":"2020-10-12T22:35:28-07:00"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks.","example":"5"}},"xml":{"name":"D1-Item"}},"DELETEITEM_request":{"type":"object","properties":{"itemId":{"type":"string","maxLength":12,"description":"The Device or meter identifier in the source system.","example":"881940890969"}},"xml":{"name":"D1-DelItem"}},"GETITEM_response":{"type":"object","properties":{"_self":{"type":"string","description":"_self"},"itemId":{"type":"string","maxLength":12,"description":"The Device or meter identifier in the source system.","example":"881940890969"},"itemType":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"itemType":{"type":"string","maxLength":30,"description":"Device Type"}}},"boStatus":{"type":"string","maxLength":12,"description":"Status of the item device","example":"ACTIVE"},"serialNumber":{"type":"string","maxLength":120,"description":"The device identifier for the Serial Number.","example":"SV100-60012"},"badgeNumber":{"type":"string","maxLength":120,"description":"The device identifier for the Badge Number.","example":"32505964"},"internalNumber":{"type":"string","maxLength":120,"description":"The device identifier value for the internal number.","example":"I-20140306001"},"assetId":{"type":"string","maxLength":120,"description":"The device identifier for the Asset ID.","example":"LP3211"},"externalId":{"type":"string","maxLength":60,"description":"External identifier for the item device.","example":"29256350"},"mdmExternalId":{"type":"string","maxLength":60,"description":"MDM External ID for the item device.","example":"32505964"},"specification":{"type":"string","maxLength":120,"description":"Specifications are used to define the manufacturer, model, and other information about the template device.","example":"BIT_01"},"configuration":{"type":"string","maxLength":120,"description":"Configuration is the type of configuration","example":"Badged Item KW"},"manufacturer":{"type":"object","description":"The Manufacturer of the device.","properties":{"_link":{"type":"string","description":"_link"},"manufacturer":{"type":"string","maxLength":30,"description":"The Manufacturer of the device.","example":"GE"}}},"model":{"type":"string","maxLength":30,"description":"The specific model number of the device provided by the manufacturer.","example":"ELECTRIC 4"},"retirementDateTime":{"type":"string","format":"date-time","description":"Retirement Date/Time","example":"2020-10-13T00:00:00-07:00"},"statusDateTime":{"type":"string","format":"date-time","description":"Status Date/Time","example":"2020-10-13T02:16:42-07:00"},"creationDateTime":{"type":"string","format":"date-time","description":"Create Date/Time","example":"2020-10-12T22:35:28-07:00"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks.","example":"5"}},"xml":{"name":"D1-Item"}},"UPDATEITEM_response":{"type":"object","properties":{"_self":{"type":"string","description":"_self"},"itemId":{"type":"string","maxLength":12,"description":"The Device or meter identifier in the source system.","example":"881940890969"},"itemType":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"itemType":{"type":"string","maxLength":30,"description":"Device Type"}}},"boStatus":{"type":"string","maxLength":12,"description":"Status of the item device","example":"ACTIVE"},"serialNumber":{"type":"string","maxLength":120,"description":"The device identifier for the Serial Number.","example":"SV100-60012"},"badgeNumber":{"type":"string","maxLength":120,"description":"The device identifier for the Badge Number.","example":"32505964"},"internalNumber":{"type":"string","maxLength":120,"description":"The device identifier value for the internal number.","example":"I-20140306001"},"assetId":{"type":"string","maxLength":120,"description":"The device identifier for the Asset ID.","example":"LP3211"},"externalId":{"type":"string","maxLength":60,"description":"External identifier for the item device.","example":"29256350"},"mdmExternalId":{"type":"string","maxLength":60,"description":"MDM External ID for the item device.","example":"32505964"},"specification":{"type":"string","maxLength":120,"description":"Specifications are used to define the manufacturer, model, and other information about the template device.","example":"BIT_01"},"configuration":{"type":"string","maxLength":120,"description":"Configuration is the type of configuration","example":"Badged Item KW"},"manufacturer":{"type":"object","description":"The Manufacturer of the device.","properties":{"_link":{"type":"string","description":"_link"},"manufacturer":{"type":"string","maxLength":30,"description":"The Manufacturer of the device.","example":"GE"}}},"model":{"type":"string","maxLength":30,"description":"The specific model number of the device provided by the manufacturer.","example":"ELECTRIC 4"},"retirementDateTime":{"type":"string","format":"date-time","description":"Retirement Date/Time","example":"2020-10-13T00:00:00-07:00"},"statusDateTime":{"type":"string","format":"date-time","description":"Status Date/Time","example":"2020-10-13T02:16:42-07:00"},"creationDateTime":{"type":"string","format":"date-time","description":"Create Date/Time","example":"2020-10-12T22:35:28-07:00"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks.","example":"5"}},"xml":{"name":"D1-Item"}},"UPDATEITEM_request":{"type":"object","properties":{"itemId":{"type":"string","maxLength":12,"description":"The Device or meter identifier in the source system.","example":"881940890969"},"itemType":{"type":"object","properties":{"itemType":{"type":"string","maxLength":30,"description":"Device Type"}}},"boStatus":{"type":"string","maxLength":12,"description":"Status of the item device","example":"ACTIVE"},"serialNumber":{"type":"string","maxLength":120,"description":"The device identifier for the Serial Number.","example":"SV100-60012"},"badgeNumber":{"type":"string","maxLength":120,"description":"The device identifier for the Badge Number.","example":"32505964"},"internalNumber":{"type":"string","maxLength":120,"description":"The device identifier value for the internal number.","example":"I-20140306001"},"assetId":{"type":"string","maxLength":120,"description":"The device identifier for the Asset ID.","example":"LP3211"},"externalId":{"type":"string","maxLength":60,"description":"External identifier for the item device.","example":"29256350"},"mdmExternalId":{"type":"string","maxLength":60,"description":"MDM External ID for the item device.","example":"32505964"},"specification":{"type":"string","maxLength":120,"description":"Specifications are used to define the manufacturer, model, and other information about the template device.","example":"BIT_01"},"configuration":{"type":"string","maxLength":120,"description":"Configuration is the type of configuration","example":"Badged Item KW"},"manufacturer":{"type":"object","description":"The Manufacturer of the device.","properties":{"manufacturer":{"type":"string","maxLength":30,"description":"The Manufacturer of the device.","example":"GE"}}},"model":{"type":"string","maxLength":30,"description":"The specific model number of the device provided by the manufacturer.","example":"ELECTRIC 4"},"retirementDateTime":{"type":"string","format":"date-time","description":"Retirement Date/Time","example":"2020-10-13T00:00:00-07:00"},"statusDateTime":{"type":"string","format":"date-time","description":"Status Date/Time","example":"2020-10-13T02:16:42-07:00"},"creationDateTime":{"type":"string","format":"date-time","description":"Create Date/Time","example":"2020-10-12T22:35:28-07:00"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks.","example":"5"}},"xml":{"name":"D1-Item"}},"DELETEITEM_response":{"type":"object","properties":{"itemId":{"type":"string","maxLength":12,"description":"The Device or meter identifier in the source system.","example":"881940890969"}},"xml":{"name":"D1-DelItem"}},"CREATEMETER_response":{"type":"object","properties":{"_self":{"type":"string","description":"_self"},"meterId":{"type":"string","maxLength":12,"description":"Meter ID is a system-assigned random number that stays with a meter for life."},"deviceType":{"type":"object","description":"Device Type provides information about the selected Device Type.","properties":{"_link":{"type":"string","description":"_link"},"deviceType":{"type":"string","maxLength":30,"description":"Device Type provides information about the selected Device Type."}}},"status":{"type":"string","maxLength":12,"description":"Status of the meter device.","example":"ACTIVE"},"statusDateTime":{"type":"string","format":"date-time","description":"Status Date/Time","example":"2020-06-03T00:01:34-07:00"},"creationDateTime":{"type":"string","format":"date-time","description":"Create Date/Time","example":"2020-06-03T00:01:34-07:00"},"manufacturer":{"type":"object","description":"Manufacturer is the meter device manufacturer.","properties":{"_link":{"type":"string","description":"_link"},"manufacturer":{"type":"string","maxLength":30,"description":"Manufacturer is the meter device manufacturer.","example":"ITRON"}}},"model":{"type":"string","maxLength":30,"description":"Model"},"incomingDataShift":{"type":"string","enum":["D1NS","D1SH"],"description":"Incoming Data Shift:\n\n    D1NS - Always in Standard Time,\n    D1SH - Always in Local Time\n* `D1NS` - Always in Standard Time,\n* `D1SH` - Always in Local Time"},"armingRequired":{"type":"string","enum":["D1AN","D1AR"],"description":"The Arming Required Flag indicates if the device requires arming or not.\n\nDevices that require arming (those with an Arming required flag set to Arming Required) must be armed before they can be connected.\n* `D1AN` - Arming Not Required,\n* `D1AR` - Arming Required","example":"D1AN"},"serviceProvider":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"serviceProvider":{"type":"string","maxLength":30,"description":"Service Provider"}}},"serialNumber":{"type":"string","maxLength":120,"description":"Identifier Value"},"badgeNumber":{"type":"string","maxLength":120,"description":"Identifier Value"},"internalMeterNumber":{"type":"string","maxLength":120,"description":"Identifier Value"},"palletNumber":{"type":"string","maxLength":120,"description":"Identifier Value"},"externalId":{"type":"string","maxLength":120,"description":"Identifier Value"},"mdmExternalId":{"type":"string","maxLength":120,"description":"Identifier Value"},"nicId":{"type":"string","maxLength":120,"description":"Identifier Value"},"assetId":{"type":"string","maxLength":120,"description":"Identifier Value"},"retirementDateTime":{"type":"string","format":"date-time","description":"Retirement Date Time is is when the meter device was disposed.","example":"2021-10-13T00:00:00-07:00"},"specification":{"type":"string","maxLength":120,"description":"Identifier Value"},"configuration":{"type":"string","maxLength":120,"description":"Identifier Value"},"headendElements":{"type":"object","properties":{"automatedTopologyManagementMode":{"type":"string","enum":["D4AC","D4MN"],"description":"Automated Topology Management mode:\n\n    D4AC - Automatic,\n    D4MN - Manual\n* `D4AC` - Automatic,\n* `D4MN` - Manual","example":"D4AC"},"neuronId":{"type":"string","maxLength":120,"description":"Identifier Value"},"objectID":{"type":"string","maxLength":100,"description":"Object ID"},"firmwareVersion":{"type":"string","maxLength":18,"description":"Version of firmware operating on the device for smart meters."},"utilDeviceID":{"type":"string","maxLength":120,"description":"Identifier Value"},"NICSerialNumber":{"type":"string","maxLength":120,"description":"Identifier Value"}}},"headendRegistrationStatus":{"type":"string","enum":["D1DR","D1NR","D1RE"],"description":"A flag that indicates the registration status of the meter in the head-end system. This is used by smart meter commands and other processes to determine if the meter is currently registered in the head-end system.\n* `D1DR` - Deregistered,\n* `D1NR` - Not Registered,\n* `D1RE` - Registered","example":"D1DR"},"commandSet":{"type":"string","maxLength":30,"description":"Command  Set"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks.","example":"1"},"equipment":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"equipment":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"equipmentId":{"type":"string","maxLength":12,"description":"Equipment ID"}}},"attachDateTime":{"type":"string","format":"date-time","description":"Installation Date/Time"},"measuringComponent":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"measuringComponentId":{"type":"string","maxLength":12,"description":"Measuring Component ID"}}},"comments":{"type":"string","maxLength":254,"description":"Comments"},"detachDateTime":{"type":"string","format":"date-time","description":"Removal Date/Time"},"crew":{"type":"string","maxLength":1073741824,"description":"Crew that performed the installation."},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks.","example":"1"}}}}}}},"xml":{"name":"D1-Meter"}},"UPDATEMETER_request":{"type":"object","properties":{"meterId":{"type":"string","maxLength":12,"description":"Meter ID is a system-assigned random number that stays with a meter for life."},"deviceType":{"type":"object","description":"Device Type provides information about the selected Device Type.","properties":{"deviceType":{"type":"string","maxLength":30,"description":"Device Type provides information about the selected Device Type."}}},"status":{"type":"string","maxLength":12,"description":"Status of the meter device.","example":"ACTIVE"},"manufacturer":{"type":"object","description":"Manufacturer is the meter device manufacturer.","properties":{"manufacturer":{"type":"string","maxLength":30,"description":"Manufacturer is the meter device manufacturer.","example":"ITRON"}}},"model":{"type":"string","maxLength":30,"description":"Model"},"incomingDataShift":{"type":"string","enum":["D1NS","D1SH"],"description":"Incoming Data Shift:\n\n    D1NS - Always in Standard Time,\n    D1SH - Always in Local Time\n* `D1NS` - Always in Standard Time,\n* `D1SH` - Always in Local Time"},"armingRequired":{"type":"string","enum":["D1AN","D1AR"],"description":"The Arming Required Flag indicates if the device requires arming or not.\n\nDevices that require arming (those with an Arming required flag set to Arming Required) must be armed before they can be connected.\n* `D1AN` - Arming Not Required,\n* `D1AR` - Arming Required","example":"D1AN"},"serviceProvider":{"type":"object","properties":{"serviceProvider":{"type":"string","maxLength":30,"description":"Service Provider"}}},"serialNumber":{"type":"string","maxLength":120,"description":"Identifier Value"},"badgeNumber":{"type":"string","maxLength":120,"description":"Identifier Value"},"internalMeterNumber":{"type":"string","maxLength":120,"description":"Identifier Value"},"palletNumber":{"type":"string","maxLength":120,"description":"Identifier Value"},"externalId":{"type":"string","maxLength":120,"description":"Identifier Value"},"mdmExternalId":{"type":"string","maxLength":120,"description":"Identifier Value"},"nicId":{"type":"string","maxLength":120,"description":"Identifier Value"},"assetId":{"type":"string","maxLength":120,"description":"Identifier Value"},"retirementDateTime":{"type":"string","format":"date-time","description":"Retirement Date Time is is when the meter device was disposed.","example":"2021-10-13T00:00:00-07:00"},"specification":{"type":"string","maxLength":120,"description":"Identifier Value"},"configuration":{"type":"string","maxLength":120,"description":"Identifier Value"},"headendElements":{"type":"object","properties":{"automatedTopologyManagementMode":{"type":"string","enum":["D4AC","D4MN"],"description":"Automated Topology Management mode:\n\n    D4AC - Automatic,\n    D4MN - Manual\n* `D4AC` - Automatic,\n* `D4MN` - Manual","example":"D4AC"},"neuronId":{"type":"string","maxLength":120,"description":"Identifier Value"},"objectID":{"type":"string","maxLength":100,"description":"Object ID"},"firmwareVersion":{"type":"string","maxLength":18,"description":"Version of firmware operating on the device for smart meters."},"utilDeviceID":{"type":"string","maxLength":120,"description":"Identifier Value"},"NICSerialNumber":{"type":"string","maxLength":120,"description":"Identifier Value"}}},"headendRegistrationStatus":{"type":"string","enum":["D1DR","D1NR","D1RE"],"description":"A flag that indicates the registration status of the meter in the head-end system. This is used by smart meter commands and other processes to determine if the meter is currently registered in the head-end system.\n* `D1DR` - Deregistered,\n* `D1NR` - Not Registered,\n* `D1RE` - Registered","example":"D1DR"},"commandSet":{"type":"string","maxLength":30,"description":"Command  Set"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks.","example":"1"},"equipment":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"equipment":{"type":"object","properties":{"equipmentId":{"type":"string","maxLength":12,"description":"Equipment ID"}}},"attachDateTime":{"type":"string","format":"date-time","description":"Installation Date/Time"},"measuringComponent":{"type":"object","properties":{"measuringComponentId":{"type":"string","maxLength":12,"description":"Measuring Component ID"}}},"comments":{"type":"string","maxLength":254,"description":"Comments"},"detachDateTime":{"type":"string","format":"date-time","description":"Removal Date/Time"},"crew":{"type":"string","maxLength":1073741824,"description":"Crew that performed the installation."},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks.","example":"1"}}}}}}},"xml":{"name":"D1-Meter"}},"CREATEMETER_request":{"type":"object","properties":{"deviceType":{"type":"object","description":"Device Type provides information about the selected Device Type.","properties":{"deviceType":{"type":"string","maxLength":30,"description":"Device Type provides information about the selected Device Type."}}},"status":{"type":"string","maxLength":12,"description":"Status of the meter device.","example":"ACTIVE"},"manufacturer":{"type":"object","description":"Manufacturer is the meter device manufacturer.","properties":{"manufacturer":{"type":"string","maxLength":30,"description":"Manufacturer is the meter device manufacturer.","example":"ITRON"}}},"model":{"type":"string","maxLength":30,"description":"Model"},"incomingDataShift":{"type":"string","enum":["D1NS","D1SH"],"description":"Incoming Data Shift:\n\n    D1NS - Always in Standard Time,\n    D1SH - Always in Local Time\n* `D1NS` - Always in Standard Time,\n* `D1SH` - Always in Local Time"},"armingRequired":{"type":"string","enum":["D1AN","D1AR"],"description":"The Arming Required Flag indicates if the device requires arming or not.\n\nDevices that require arming (those with an Arming required flag set to Arming Required) must be armed before they can be connected.\n* `D1AN` - Arming Not Required,\n* `D1AR` - Arming Required","example":"D1AN"},"serviceProvider":{"type":"object","properties":{"serviceProvider":{"type":"string","maxLength":30,"description":"Service Provider"}}},"serialNumber":{"type":"string","maxLength":120,"description":"Identifier Value"},"badgeNumber":{"type":"string","maxLength":120,"description":"Identifier Value"},"internalMeterNumber":{"type":"string","maxLength":120,"description":"Identifier Value"},"palletNumber":{"type":"string","maxLength":120,"description":"Identifier Value"},"externalId":{"type":"string","maxLength":120,"description":"Identifier Value"},"mdmExternalId":{"type":"string","maxLength":120,"description":"Identifier Value"},"nicId":{"type":"string","maxLength":120,"description":"Identifier Value"},"assetId":{"type":"string","maxLength":120,"description":"Identifier Value"},"retirementDateTime":{"type":"string","format":"date-time","description":"Retirement Date Time is is when the meter device was disposed.","example":"2021-10-13T00:00:00-07:00"},"specification":{"type":"string","maxLength":120,"description":"Identifier Value"},"configuration":{"type":"string","maxLength":120,"description":"Identifier Value"},"headendElements":{"type":"object","properties":{"automatedTopologyManagementMode":{"type":"string","enum":["D4AC","D4MN"],"description":"Automated Topology Management mode:\n\n    D4AC - Automatic,\n    D4MN - Manual\n* `D4AC` - Automatic,\n* `D4MN` - Manual","example":"D4AC"},"neuronId":{"type":"string","maxLength":120,"description":"Identifier Value"},"objectID":{"type":"string","maxLength":100,"description":"Object ID"},"firmwareVersion":{"type":"string","maxLength":18,"description":"Version of firmware operating on the device for smart meters."},"utilDeviceID":{"type":"string","maxLength":120,"description":"Identifier Value"},"NICSerialNumber":{"type":"string","maxLength":120,"description":"Identifier Value"}}},"headendRegistrationStatus":{"type":"string","enum":["D1DR","D1NR","D1RE"],"description":"A flag that indicates the registration status of the meter in the head-end system. This is used by smart meter commands and other processes to determine if the meter is currently registered in the head-end system.\n* `D1DR` - Deregistered,\n* `D1NR` - Not Registered,\n* `D1RE` - Registered","example":"D1DR"},"commandSet":{"type":"string","maxLength":30,"description":"Command  Set"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks.","example":"1"},"equipment":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"equipment":{"type":"object","properties":{"equipmentId":{"type":"string","maxLength":12,"description":"Equipment ID"}}},"attachDateTime":{"type":"string","format":"date-time","description":"Installation Date/Time"},"measuringComponent":{"type":"object","properties":{"measuringComponentId":{"type":"string","maxLength":12,"description":"Measuring Component ID"}}},"comments":{"type":"string","maxLength":254,"description":"Comments"},"detachDateTime":{"type":"string","format":"date-time","description":"Removal Date/Time"},"crew":{"type":"string","maxLength":1073741824,"description":"Crew that performed the installation."},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks.","example":"1"}}}}}}},"xml":{"name":"D1-Meter"}},"DELETEMETER_response":{"type":"object","properties":{"meterId":{"type":"string","maxLength":12,"description":"Meter ID is a system-assigned random number that stays with a meter for life."}},"xml":{"name":"D1-DeleteMtr"}},"GETMETER_response":{"type":"object","properties":{"_self":{"type":"string","description":"_self"},"meterId":{"type":"string","maxLength":12,"description":"Meter ID is a system-assigned random number that stays with a meter for life."},"deviceType":{"type":"object","description":"Device Type provides information about the selected Device Type.","properties":{"_link":{"type":"string","description":"_link"},"deviceType":{"type":"string","maxLength":30,"description":"Device Type provides information about the selected Device Type."}}},"status":{"type":"string","maxLength":12,"description":"Status of the meter device.","example":"ACTIVE"},"statusDateTime":{"type":"string","format":"date-time","description":"Status Date/Time","example":"2020-06-03T00:01:34-07:00"},"creationDateTime":{"type":"string","format":"date-time","description":"Create Date/Time","example":"2020-06-03T00:01:34-07:00"},"manufacturer":{"type":"object","description":"Manufacturer is the meter device manufacturer.","properties":{"_link":{"type":"string","description":"_link"},"manufacturer":{"type":"string","maxLength":30,"description":"Manufacturer is the meter device manufacturer.","example":"ITRON"}}},"model":{"type":"string","maxLength":30,"description":"Model"},"incomingDataShift":{"type":"string","enum":["D1NS","D1SH"],"description":"Incoming Data Shift:\n\n    D1NS - Always in Standard Time,\n    D1SH - Always in Local Time\n* `D1NS` - Always in Standard Time,\n* `D1SH` - Always in Local Time"},"armingRequired":{"type":"string","enum":["D1AN","D1AR"],"description":"The Arming Required Flag indicates if the device requires arming or not.\n\nDevices that require arming (those with an Arming required flag set to Arming Required) must be armed before they can be connected.\n* `D1AN` - Arming Not Required,\n* `D1AR` - Arming Required","example":"D1AN"},"serviceProvider":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"serviceProvider":{"type":"string","maxLength":30,"description":"Service Provider"}}},"serialNumber":{"type":"string","maxLength":120,"description":"Identifier Value"},"badgeNumber":{"type":"string","maxLength":120,"description":"Identifier Value"},"internalMeterNumber":{"type":"string","maxLength":120,"description":"Identifier Value"},"palletNumber":{"type":"string","maxLength":120,"description":"Identifier Value"},"externalId":{"type":"string","maxLength":120,"description":"Identifier Value"},"mdmExternalId":{"type":"string","maxLength":120,"description":"Identifier Value"},"nicId":{"type":"string","maxLength":120,"description":"Identifier Value"},"assetId":{"type":"string","maxLength":120,"description":"Identifier Value"},"retirementDateTime":{"type":"string","format":"date-time","description":"Retirement Date Time is is when the meter device was disposed.","example":"2021-10-13T00:00:00-07:00"},"specification":{"type":"string","maxLength":120,"description":"Identifier Value"},"configuration":{"type":"string","maxLength":120,"description":"Identifier Value"},"headendElements":{"type":"object","properties":{"automatedTopologyManagementMode":{"type":"string","enum":["D4AC","D4MN"],"description":"Automated Topology Management mode:\n\n    D4AC - Automatic,\n    D4MN - Manual\n* `D4AC` - Automatic,\n* `D4MN` - Manual","example":"D4AC"},"neuronId":{"type":"string","maxLength":120,"description":"Identifier Value"},"objectID":{"type":"string","maxLength":100,"description":"Object ID"},"firmwareVersion":{"type":"string","maxLength":18,"description":"Version of firmware operating on the device for smart meters."},"utilDeviceID":{"type":"string","maxLength":120,"description":"Identifier Value"},"NICSerialNumber":{"type":"string","maxLength":120,"description":"Identifier Value"}}},"headendRegistrationStatus":{"type":"string","enum":["D1DR","D1NR","D1RE"],"description":"A flag that indicates the registration status of the meter in the head-end system. This is used by smart meter commands and other processes to determine if the meter is currently registered in the head-end system.\n* `D1DR` - Deregistered,\n* `D1NR` - Not Registered,\n* `D1RE` - Registered","example":"D1DR"},"commandSet":{"type":"string","maxLength":30,"description":"Command  Set"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks.","example":"1"},"equipment":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"equipment":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"equipmentId":{"type":"string","maxLength":12,"description":"Equipment ID"}}},"attachDateTime":{"type":"string","format":"date-time","description":"Installation Date/Time"},"measuringComponent":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"measuringComponentId":{"type":"string","maxLength":12,"description":"Measuring Component ID"}}},"comments":{"type":"string","maxLength":254,"description":"Comments"},"detachDateTime":{"type":"string","format":"date-time","description":"Removal Date/Time"},"crew":{"type":"string","maxLength":1073741824,"description":"Crew that performed the installation."},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks.","example":"1"}}}}}}},"xml":{"name":"D1-Meter"}},"UPDATEMETER_response":{"type":"object","properties":{"_self":{"type":"string","description":"_self"},"meterId":{"type":"string","maxLength":12,"description":"Meter ID is a system-assigned random number that stays with a meter for life."},"deviceType":{"type":"object","description":"Device Type provides information about the selected Device Type.","properties":{"_link":{"type":"string","description":"_link"},"deviceType":{"type":"string","maxLength":30,"description":"Device Type provides information about the selected Device Type."}}},"status":{"type":"string","maxLength":12,"description":"Status of the meter device.","example":"ACTIVE"},"statusDateTime":{"type":"string","format":"date-time","description":"Status Date/Time","example":"2020-06-03T00:01:34-07:00"},"creationDateTime":{"type":"string","format":"date-time","description":"Create Date/Time","example":"2020-06-03T00:01:34-07:00"},"manufacturer":{"type":"object","description":"Manufacturer is the meter device manufacturer.","properties":{"_link":{"type":"string","description":"_link"},"manufacturer":{"type":"string","maxLength":30,"description":"Manufacturer is the meter device manufacturer.","example":"ITRON"}}},"model":{"type":"string","maxLength":30,"description":"Model"},"incomingDataShift":{"type":"string","enum":["D1NS","D1SH"],"description":"Incoming Data Shift:\n\n    D1NS - Always in Standard Time,\n    D1SH - Always in Local Time\n* `D1NS` - Always in Standard Time,\n* `D1SH` - Always in Local Time"},"armingRequired":{"type":"string","enum":["D1AN","D1AR"],"description":"The Arming Required Flag indicates if the device requires arming or not.\n\nDevices that require arming (those with an Arming required flag set to Arming Required) must be armed before they can be connected.\n* `D1AN` - Arming Not Required,\n* `D1AR` - Arming Required","example":"D1AN"},"serviceProvider":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"serviceProvider":{"type":"string","maxLength":30,"description":"Service Provider"}}},"serialNumber":{"type":"string","maxLength":120,"description":"Identifier Value"},"badgeNumber":{"type":"string","maxLength":120,"description":"Identifier Value"},"internalMeterNumber":{"type":"string","maxLength":120,"description":"Identifier Value"},"palletNumber":{"type":"string","maxLength":120,"description":"Identifier Value"},"externalId":{"type":"string","maxLength":120,"description":"Identifier Value"},"mdmExternalId":{"type":"string","maxLength":120,"description":"Identifier Value"},"nicId":{"type":"string","maxLength":120,"description":"Identifier Value"},"assetId":{"type":"string","maxLength":120,"description":"Identifier Value"},"retirementDateTime":{"type":"string","format":"date-time","description":"Retirement Date Time is is when the meter device was disposed.","example":"2021-10-13T00:00:00-07:00"},"specification":{"type":"string","maxLength":120,"description":"Identifier Value"},"configuration":{"type":"string","maxLength":120,"description":"Identifier Value"},"headendElements":{"type":"object","properties":{"automatedTopologyManagementMode":{"type":"string","enum":["D4AC","D4MN"],"description":"Automated Topology Management mode:\n\n    D4AC - Automatic,\n    D4MN - Manual\n* `D4AC` - Automatic,\n* `D4MN` - Manual","example":"D4AC"},"neuronId":{"type":"string","maxLength":120,"description":"Identifier Value"},"objectID":{"type":"string","maxLength":100,"description":"Object ID"},"firmwareVersion":{"type":"string","maxLength":18,"description":"Version of firmware operating on the device for smart meters."},"utilDeviceID":{"type":"string","maxLength":120,"description":"Identifier Value"},"NICSerialNumber":{"type":"string","maxLength":120,"description":"Identifier Value"}}},"headendRegistrationStatus":{"type":"string","enum":["D1DR","D1NR","D1RE"],"description":"A flag that indicates the registration status of the meter in the head-end system. This is used by smart meter commands and other processes to determine if the meter is currently registered in the head-end system.\n* `D1DR` - Deregistered,\n* `D1NR` - Not Registered,\n* `D1RE` - Registered","example":"D1DR"},"commandSet":{"type":"string","maxLength":30,"description":"Command  Set"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks.","example":"1"},"equipment":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"equipment":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"equipmentId":{"type":"string","maxLength":12,"description":"Equipment ID"}}},"attachDateTime":{"type":"string","format":"date-time","description":"Installation Date/Time"},"measuringComponent":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"measuringComponentId":{"type":"string","maxLength":12,"description":"Measuring Component ID"}}},"comments":{"type":"string","maxLength":254,"description":"Comments"},"detachDateTime":{"type":"string","format":"date-time","description":"Removal Date/Time"},"crew":{"type":"string","maxLength":1073741824,"description":"Crew that performed the installation."},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks.","example":"1"}}}}}}},"xml":{"name":"D1-Meter"}},"DELETEMETER_request":{"type":"object","properties":{"meterId":{"type":"string","maxLength":12,"description":"Meter ID is a system-assigned random number that stays with a meter for life."}},"xml":{"name":"D1-DeleteMtr"}},"ACTIONBILLSEGMENT_request":{"type":"object","properties":{"billSegmentId":{"type":"string","maxLength":12,"description":"Bill Segment ID is the system-assigned unique identifier of the bill segment.","example":"211366855400"},"name":{"type":"string","description":"(name)"},"_self":{"type":"string","description":"(_self)"},"cancelReason":{"type":"string","maxLength":4,"description":"Cancel Reason defines why the bill segment(s) are being canceled.","example":"Wrong read"},"cancelReasonDescription":{"type":"string","description":"(cancelReasonDescription)"},"cutOffDate":{"type":"string","format":"date","description":"Cutoff Date is the last day of the new bill segment.","example":"2021-10-05"},"accountingDate":{"type":"string","format":"date","description":"Accounting Date"},"areEstimatesAllowed":{"type":"boolean","description":"Check Allow Estimates if the system is allowed to estimate consumption if it can't find a meter read.","example":"false"},"hasBillingOption":{"type":"boolean","description":"If the service agreements use meter reads, use the Billing Option to control how the system retrieves meter reads that appear on the bill. \n\nSelect Use Schedule if the system should select reads based on the SA's SP's service cycle schedule. Select Use Cut off Date if the system should only select reads from the end date of the existing bill segment.","example":"true"},"canUseOldReadsItemsServiceQuantity":{"type":"boolean","description":"Check Use Old Read/Item/SQ if the system is configured to use the consumption details used on the original bill segments.","example":"false"},"creditDate":{"type":"string","format":"date","description":"Bill Date is the business date that was used when the bill was completed.","example":"06-05-2013"},"nextActions":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"actionName":{"type":"string","description":"(actionName)"},"_link":{"type":"string","description":"(_link)"}}}}}}},"xml":{"name":"C1-ActionBSe"}},"CREATEBILLSEGMENT_response":{"type":"object","properties":{"_self":{"type":"string","description":"_self"},"httpMethod":{"type":"string","enum":["DELT","GET ","POST","PTCH","PUT "],"description":"HTTP Method\n* `DELT` - Delete,\n* `GET ` - Get,\n* `POST` - Post,\n* `PTCH` - Patch,\n* `PUT ` - Put","example":"GET"},"billSegmentId":{"type":"string","maxLength":12,"description":"Bill Segment ID is the system-assigned unique identifier of the bill segment.","example":"211366855400"},"account":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"accountId":{"type":"string","maxLength":10,"description":"Account ID identifies the customer who is responsible for the bill.","example":"1112345900"}}},"currentAmount":{"type":"number","description":"Current Amount is the bill segment's effect on the service agreement's current balance.","example":"$405.52"},"payoffAmount":{"type":"number","maximum":9999999999999.99,"minimum":0,"description":"Payoff Amount is only shown if it differs from current amount.","example":"$33.20"},"bill":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"billId":{"type":"string","maxLength":12,"description":"Bill ID is the system-assigned unique identifier of the bill on which the bill segment appears. A concatenation of its bill date, status, due date and amount is displayed.","example":"211122345678"}}},"serviceAgreement":{"type":"object","description":"SA ID contains information about the bill segment's service agreement.","properties":{"_link":{"type":"string","description":"_link"},"serviceAgreementId":{"type":"string","maxLength":10,"description":"Service Agreement"}}},"periodStartDate":{"type":"string","format":"date","description":"Start Date"},"periodEndDate":{"type":"string","format":"date","description":"End Date"},"usageStartDateTime":{"type":"string","format":"date-time","description":"Usage start date is the first day for bill segment used by meter data management system.","example":"03-04-2013"},"usageEndDateTime":{"type":"string","format":"date-time","description":"Usage end date is the last date for bill segment used by meter data management system.","example":"03-04-2013"},"billSegmentPeriod":{"type":"string","maxLength":30,"description":"Bill Segment Period is the start and end dates of the bill segment.","example":"11-04-2013 12-03-2013"},"usagePeriod":{"type":"string","maxLength":1,"description":"Usage Period is the period used by the meter data management system to determine the correct interval data to process for the bill segment.","example":"11-04-2013 12-03-2013"},"billCycle":{"type":"object","description":"Bill Cycle displays the bill cycle and window start date of the bill segment's bill.","properties":{"_link":{"type":"string","description":"_link"},"billCycle":{"type":"string","maxLength":4,"description":"Bill Cycle displays the bill cycle and window start date of the bill segment's bill.","example":"M-D2 (Monthly bill cycle - day 2)"}}},"billStatus":{"type":"string","enum":["C   ","P   "],"description":"Bill Status is the bill's status.\n* `C   ` - Complete,\n* `P   ` - Pending","example":"C"},"isEstimate":{"type":"boolean","description":"If the Estimate switch is on, consumption on this bill segment has been estimated by the system.","example":"true"},"isClosingBillSegment":{"type":"boolean","description":"If the Closing switch is on, this is the final bill segment for the service agreement (i.e., the service agreement has been stopped and this is the final bill segment).","example":"true"},"hasServiceQuantityOverride":{"type":"boolean","description":"If the SQ Override switch is on, a user has overridden the service quantities (i.e., the amount of consumption for which the customer is charged is not consistent with the customer's meter reads).","example":"true"},"isItemOverride":{"type":"boolean","description":"If the Item Override switch is on, a user has overridden the type and/or number of items (i.e., the type/number of items for which the customer is charged is not consistent with the customer's service point information).","example":"true"},"premise":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"premiseId":{"type":"string","maxLength":10,"description":"Premise ID defines the address on bills for persons who have their bill sent to the account's mailing premise."}}},"creationDateTime":{"type":"string","format":"date-time","description":"Create Date/Time is the date and time on which the bill was originally created.","example":"2001-05-16"},"saRelationshipId":{"type":"string","maxLength":10,"description":"SA Relationship ID shows the unique identifier of the record that defines the relationship between the sub service agreement and the master service agreement (this record shows the service provider associated with the bill segment)."},"billSegmentStatus":{"type":"string","enum":["10  ","20  ","30  ","40  ","50  ","60  ","70  "],"description":"Bill Segment Status:\n* `10  ` - Incomplete,\n* `20  ` - Error,\n* `30  ` - Freezable,\n* `40  ` - Pending Cancel,\n* `50  ` - Frozen,\n* `60  ` - Canceled,\n* `70  ` - OK"},"billSegmentStatusDescription":{"type":"string","maxLength":150,"description":"Description for bill segment's status.","example":"Freezable"},"statusChangeDateTime":{"type":"string","format":"date-time","description":"Bill Segment's status change date/time","example":"06-05-2013 04:28PM"},"cancelReasonDescription":{"type":"string","maxLength":100,"description":"Cancel Reason Description defines the reason why the bill segment(s) are being canceled.","example":"Canceled prior to completion."},"quote":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"quoteId":{"type":"string","maxLength":12,"description":"Quote ID is the system-assigned unique identifier of the quote."}}},"cutOffDate":{"type":"string","format":"date","description":"Cutoff Date is the last day of the new bill segment.","example":"2021-10-05"},"accountingDate":{"type":"string","format":"date","description":"Accounting Date"},"cancelReason":{"type":"object","description":"Cancel Reason defines why the bill segment(s) are being canceled.","properties":{"_link":{"type":"string","description":"_link"},"cancelReason":{"type":"string","maxLength":4,"description":"Cancel Reason defines why the bill segment(s) are being canceled.","example":"Wrong read"}}},"areEstimatesAllowed":{"type":"boolean","description":"Check Allow Estimates if the system is allowed to estimate consumption if it can't find a meter read.","example":"false"},"hasBillingOption":{"type":"boolean","description":"If the service agreements use meter reads, use the Billing Option to control how the system retrieves meter reads that appear on the bill. \n\nSelect Use Schedule if the system should select reads based on the SA's SP's service cycle schedule. Select Use Cut off Date if the system should only select reads from the end date of the existing bill segment.","example":"true"},"canUseOldReadsItemsServiceQuantity":{"type":"boolean","description":"Check Use Old Read/Item/SQ if the system is configured to use the consumption details used on the original bill segments.","example":"false"},"creditDate":{"type":"string","format":"date","description":"Bill Date is the business date that was used when the bill was completed.","example":"06-05-2013"},"creditNote":{"type":"string","maxLength":12,"description":"The Credit Note is used to cancel selected bill segments and create a new bill that contains the cancellation details. We refer to this \"negative bill\" as a credit note."},"correctionNote":{"type":"string","maxLength":150,"description":"The Correction Note is used to cancel and rebill bill segments and create a new bill that contains the cancellation and rebill details."},"canShowAccountingDate":{"type":"boolean","description":"Accounting Date  is the date the system uses to determine the financial transaction's accounting period in your general ledger.","example":"06-05-2013"},"processDate":{"type":"string","format":"date","description":"Process Date"},"specialUsage":{"type":"string","enum":["PROP"],"description":"Special Usage flag shows if it's a proposal SA.\n* `PROP` - Proposal SA","example":"PROP"},"currency":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"currency":{"type":"string","maxLength":3,"description":"Currency Code"}}},"windowStartDate":{"type":"string","format":"date","description":"Window Start Date","example":"12-03-2013"},"cancelBillSegmentId":{"type":"string","maxLength":12,"description":"If the bill segment was canceled and rebilled by another segment, a reference to the new bill segment is displayed. Cancel Bill Segment ID refers to the new bill segment id that superseded the canceled segment.","example":"661660087111"},"masterBillSegmentId":{"type":"string","maxLength":12,"description":"Master Bseg ID shows the unique identifier of the master bill segment whose bill triggered the creation of this sub service agreement.","example":"661660087111"},"quoteDetailId":{"type":"string","maxLength":12,"description":"Quote Detail ID is the system-assigned unique identifier of the quote detail."},"billScenarioId":{"type":"string","maxLength":12,"description":"Billing Scenario ID allows you to go to the proposal SA's billing scenario where you can tinker with consumption and the bill segment period used to generate this bill segment."},"canCancel":{"type":"boolean","description":"The Cancel is used to cancel a Pending Cancel bill segment to become Canceled.","example":"true"},"canDelete":{"type":"boolean","description":"The Delete is used to delete one or more bill segments.","example":"false"},"canFreeze":{"type":"boolean","description":"The Freeze is used to freeze one or more bill segments."},"canGenerate":{"type":"boolean","description":"The Generate is used to delete and recreate one or more bill segments.","example":"false"},"canInitCancel":{"type":"boolean","description":"Initialize  Cancel causes the first step of the bill segment cancellation process to be executed. You'd click this button if a frozen bill segment should never have been created (i.e., you want to remove the financial impact of a bill segment from a customer's balance).\n\nThis button is enabled when you display a Frozen bill segment AND the bill segment's bill is not written off.","example":"false"},"shouldRebill":{"type":"boolean","description":"The Rebill causes an existing bill segment to be canceled, and a new bill segment to be created.","example":"true"},"canActionRegenerate":{"type":"boolean","description":"Regenerate action regenerated the bill segment after correcting the cause of the problem for errored bill segment.","example":"false"},"canUndo":{"type":"boolean","description":"Undo returns a Pending Cancel bill segment to the Frozen state.","example":"false"},"isCreditNote":{"type":"boolean","description":"Credit Note is used to cancel ALL bill segments and create a new bill that contains the cancellation details.","example":"false"},"isCorrectionNote":{"type":"boolean","description":"The Correction Note is used to cancel and rebill bill segments and create a new bill that contains the cancellation and rebill details.","example":"false"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"},"exception":{"type":"object","properties":{"messageCategory":{"type":"number","maximum":99999,"minimum":-99999,"description":"Message category within Oracle Utilities Application Framework.","example":"0"},"messageNumber":{"type":"number","maximum":99999,"minimum":-99999,"description":"Message number within Oracle Utilities Application Framework.","example":"0"},"expandedMessage":{"type":"string","maxLength":254,"description":"Expanded Message exception"}}},"readDetails":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"finalUnitOfMeasure":{"type":"string","maxLength":30,"description":"Final Unit of Measure is the final unit of measure of the calculation / audit read.","example":"CF"},"finalTimeOfUse":{"type":"string","maxLength":30,"description":"Final Time of Use is the final time-of-use code of the calculation / audit read.","example":"ON"},"finalServiceQuantityId":{"type":"string","maxLength":30,"description":"Final SQI is the final service quantity identifier of the calculation / audit read.","example":"DAMT"},"registerQuantity":{"type":"number","maximum":1000000000000,"minimum":-1000000000000,"description":"Quantity is the quantity of the calculation / audit read. This would typically contain the amount that was billed during the Start Date/Time through the End Date/Time for the Final Unit of Measure, Final Time of Use and Final SQI.","example":"200.000000"},"servicePointId":{"type":"string","maxLength":10,"description":"Service Point ID"},"meterConfigurationId":{"type":"string","maxLength":10,"description":"Meter Configuration ID"},"sequence":{"type":"number","maximum":99999,"minimum":-99999,"description":"Sequence"},"unitOfMeasure":{"type":"string","maxLength":30,"description":"Unit of Measure"},"timeOfUse":{"type":"string","maxLength":30,"description":"Time of Use"},"serviceQuantityIdentifier":{"type":"string","maxLength":30,"description":"SQI"},"startRegisterReading":{"type":"number","maximum":999999999.999999,"minimum":-999999999.999999,"description":"Start Register Reading is the start register reading.","example":"7201.000000"},"endRegisterReading":{"type":"number","maximum":999999999.999999,"minimum":-999999999.999999,"description":"End Register Reading is the end register reading.","example":"11578.000000"},"measuredQuantity":{"type":"number","maximum":1000000000000,"minimum":-1000000000000,"description":"Measured Quantity is the resulting measured quantity (if any). This value would typically only be displayed if the calculation / audit read is subtractive","example":"4377.000000"},"registerConstant":{"type":"number","maximum":999999.999999,"minimum":-999999.999999,"description":"Constant is the constant of the measuring device that was multiplied by the Measured Quantity to derive the calculation / audit read's Quantity.","example":"1.000000"},"howToUse":{"type":"string","enum":["+   ","-   ","C   ","P   "],"description":"How To Use is a code that indicates if the \"calculation / audit\" read was is considered to be additive, subtractive, peak or check.\n* `+   ` - Additive,\n* `-   ` - Subtractive,\n* `C   ` - Check,\n* `P   ` - Peak","example":"+"},"howToUseRead":{"type":"string","enum":["+   ","-   ","C   ","S   ","X   "],"description":"How To Use (SP) is the SA/SP's how to use code.\n* `+   ` - Add,\n* `-   ` - Subtract,\n* `C   ` - Check,\n* `S   ` - Service Quantity,\n* `X   ` - Calculation/Audit","example":"+"},"usePercent":{"type":"number","maximum":999,"minimum":-999,"description":"Use Percent is the percentage of the total consumption that was billed.","example":"100"},"measuresPeakQuantity":{"type":"boolean","description":"Measures Peak Qty"},"startReadDateTime":{"type":"string","format":"date-time","description":"Start Read Date/Time is the date and time of the start meter read.","example":"1998-06-30T00:00:00-04:00"},"endReadDateTime":{"type":"string","format":"date-time","description":"End Read Date/Time is the date and time of the end meter read.","example":"998-09-30T00:00:00-04:00"},"startRegisterReadId":{"type":"string","maxLength":12,"description":"Start Register Read ID is the unique identifier of the start register read.","example":"444074862768"},"endRegisterReadingId":{"type":"string","maxLength":12,"description":"End Register Read ID is the unique identifier of the end register read.","example":"444074849655"},"startRegisterReadTypeDescription":{"type":"string","maxLength":150,"description":"Start Register Read Type Description"},"endRegisterReadTypeDescription":{"type":"string","maxLength":150,"description":"End Register Read Type Description"},"multiplier":{"type":"number","maximum":1000000000000,"minimum":-1000000000000,"description":"Multiplier is the composite multiplier that converts the measured quantity to the registered quantity.","example":"1.000000"},"consumptionType":{"type":"string","enum":["C   ","S   "],"description":"Consumptive/Subtractive flag shows if the register is consumptive or subtractive.\n* `C   ` - Consumptive,\n* `S   ` - Subtractive","example":"S"},"notAvailableConsumptionDescription":{"type":"string","maxLength":150,"description":"Not Available Consumption Description"},"startMeterRead":{"type":"string","maxLength":12,"description":"Start meter read ID","example":"444074813104"},"endMeterRead":{"type":"string","maxLength":12,"description":"End meter read ID","example":"44074866808"},"meterReadId":{"type":"string","maxLength":12,"description":"Meter Read ID","example":"8833057699"},"unitOfMeasure2":{"type":"string","maxLength":30,"description":"Unit of Measure  is the description for unit of measure of the service quantity.","example":"Cubic feet of water"},"serviceQuantityIdentifier2":{"type":"string","maxLength":30,"description":"SQI is the service quantity identifier description of the service quantity.","example":"Daily Amount"},"timeOfUse2":{"type":"string","maxLength":30,"description":"Time of Use is the register's time-of-use description.","example":"off-peak"},"finalUomDescription":{"type":"string","maxLength":150,"description":"Final Uom Description"},"finalSqiDescription":{"type":"string","maxLength":150,"description":"Final SQI Description"},"finalTouDescription":{"type":"string","maxLength":150,"description":"Final TOU Description"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"}}}}}},"items":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"sequence":{"type":"number","maximum":99999,"minimum":-99999,"description":"Sequence"},"itemType":{"type":"string","maxLength":30,"description":"Item Type is the type of item.","example":"Generic Current Transformer"},"item":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"itemId":{"type":"string","maxLength":10,"description":"Item ID"}}},"startDate":{"type":"string","format":"date","description":"Start Date"},"endDate":{"type":"string","format":"date","description":"End Date"},"itemCount":{"type":"number","maximum":999999999.99,"minimum":-999999999.99,"description":"Item Count is the number of items of this type that were linked to the service agreement's service points during the bill segment's bill period.","example":"1.00"},"unitOfMeasure":{"type":"string","maxLength":30,"description":"Unit of Measure"},"dailyServiceQuantity":{"type":"number","maximum":1000000000000,"minimum":-1000000000000,"description":"Daily Service Quantity is the item's estimated amount of daily consumption.","example":"470.762600"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"}}}}}},"serviceQuantities":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"unitOfMeasure":{"type":"string","maxLength":30,"description":"Unit of Measure"},"timeOfUse":{"type":"string","maxLength":30,"description":"Time of Use"},"serviceQuantityIdentifier":{"type":"string","maxLength":30,"description":"SQI"},"initialServiceQuantity":{"type":"number","maximum":1000000000000,"minimum":-1000000000000,"description":"Initial Service Quantity is the initial quantity amassed by the system before application of the rate's pre-processing calculation group(s), if any exists.","example":"470.762600"},"billableServiceQuantity":{"type":"number","maximum":1000000000000,"minimum":-1000000000000,"description":"Billable Service Quantity"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"}}}}}},"calcLines":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"headerSequence":{"type":"number","maximum":999,"minimum":-999,"description":"Header Sequence"},"startDate":{"type":"string","format":"date","description":"Start Date"},"endDate":{"type":"string","format":"date","description":"End Date"},"currency":{"type":"string","maxLength":3,"description":"Currency Code"},"calculatedAmount":{"type":"number","description":"Calculated Amount"},"rateSchedule":{"type":"string","maxLength":8,"description":"Rate Schedule"},"effectiveDate":{"type":"string","format":"date","description":"Effective Date"},"billableCharge":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"billableChargeId":{"type":"string","maxLength":12,"description":"Billable Charge ID"}}},"descriptionOnBill":{"type":"string","maxLength":254,"description":"Description on Bill"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"},"calculationLines":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"headerSequence":{"type":"number","maximum":999,"minimum":-999,"description":"Header Sequence"},"sequence":{"type":"number","maximum":99999,"minimum":-99999,"description":"Sequence"},"characteristicType":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"characteristicType":{"type":"string","maxLength":8,"description":"Characteristic Type"}}},"currency":{"type":"string","maxLength":3,"description":"Currency Code"},"characteristicValue":{"type":"string","maxLength":16,"description":"Characteristic Value"},"distributionCode":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"distributionCode":{"type":"string","maxLength":10,"description":"Distribution Code"}}},"unitOfMeasure":{"type":"string","maxLength":30,"description":"Unit of Measure"},"timeOfUse":{"type":"string","maxLength":30,"description":"Time of Use"},"rcSequence":{"type":"number","maximum":9999,"minimum":-9999,"description":"Rate Component Sequence refers to the sequence number of the rate component on the applicable rate version calculation group that was used to calculate the line. This is only populated if the original rate engine calculated the charges.","example":"10"},"shouldPrint":{"type":"boolean","description":"The Print switch controls whether information about this line will print on the customer's bill.","example":"true"},"shouldAppearInSummary":{"type":"boolean","description":"The Appears in Summary switch defines if this line's amount also appears on a summary line.","example":"true"},"calculatedAmount":{"type":"number","description":"Calculated Amount"},"exemptAmount":{"type":"number","description":"Exempt Amount is the amount of the calculated charge that the customer doesn't have to pay because they are tax exempt.","example":"$0.00"},"baseAmount":{"type":"number","description":"Base Amount is used by calculation lines (e.g. taxes) that are cross-referenced to other calculation lines and whose value(s), therefore, depend on the amounts calculated by those other lines. The Base Amount shows the total amount derived from the cross-referenced line(s) that the current line then used to calculate its billed amount.","example":"$102.71"},"serviceQuantityIdentifier":{"type":"string","maxLength":30,"description":"SQI"},"billableServiceQuantity":{"type":"number","maximum":1000000000000,"minimum":-1000000000000,"description":"Billable Service Quantity"},"measuresPeakQuantity":{"type":"boolean","description":"Measures Peak Qty"},"descriptionOnBill":{"type":"string","maxLength":254,"description":"Description on Bill"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"},"distributionDescription":{"type":"string","maxLength":30,"description":"Distribution Code Description"},"isCharacteristicExist":{"type":"boolean","description":"Characteristic exists","example":"false"}}}}}}}}}}},"financialDetails":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"financialTransactionId":{"type":"string","maxLength":12,"description":"FT ID is the system-assigned unique identifier of the financial transaction (FT).","example":"211166656266"},"financialTransactionType":{"type":"string","enum":["AD  ","AX  ","BS  ","BX  ","PS  ","PX  "],"description":"Financial Transaction Type:\n\n    AD - Adjustment,\n    AX - Adjustment Cancellation,\n    BS - Bill Segment,\n    BX - Bill Segment Cancellation,\n    PS - Pay Segment,\n    PX - Pay Segment Cancellation\n* `AD  ` - Adjustment,\n* `AX  ` - Adjustment Cancellation,\n* `BS  ` - Bill Segment,\n* `BX  ` - Bill Segment Cancellation,\n* `PS  ` - Pay Segment,\n* `PX  ` - Pay Segment Cancellation","example":"BS"},"financialTransactionTypeDescription":{"type":"string","maxLength":150,"description":"FT Type Description"},"currentAmount":{"type":"number","description":"Current Amount"},"accountingDate":{"type":"string","format":"date","description":"Accounting Date"},"arrearsDate":{"type":"string","format":"date","description":"Arrears Date is the date the FT starts aging.","example":"03-04-2013"},"shouldShowOnBill":{"type":"boolean","description":"Show on bill indicates if information about the FT appears on the customer's bill.","example":"true"},"_data":{"type":"array","items":{"type":"object","properties":{"sequence":{"type":"number","maximum":999,"minimum":-999,"description":"Sequence"},"distributionCode":{"type":"string","maxLength":10,"description":"Distribution Code"},"characteristicType":{"type":"string","maxLength":8,"description":"Characteristic Type"},"characteristicValue":{"type":"string","maxLength":16,"description":"Characteristic Value"},"amount":{"type":"number","description":"Amount defines the journal line's amount.","example":"$33.00"},"statistics":{"type":"string","maxLength":8,"description":"Statistics Code is only specified when a statistical quantity is associated with the distribution line.","example":"CF"},"statisticAmount":{"type":"number","maximum":10000000000000,"minimum":-10000000000000,"description":"Statistic Amount defines the statistical amount that will be posted to the GL. This value is only populated on distribution lines created for calculation rules designated as affecting GL statistical quantity.","example":"0.000"},"isTotalAmount":{"type":"boolean","description":"Total Amount defines if the journal line contains the total of the other journal lines.","example":"true"},"distributionDescription":{"type":"string","maxLength":30,"description":"Distribution Code Description"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"}}}}}}}}},"subBillSegments":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"currentAmount":{"type":"number","description":"Current Amount"},"billSegmentStatus":{"type":"string","enum":["10  ","20  ","30  ","40  ","50  ","60  ","70  "],"description":"Bill Segment Status:\n* `10  ` - Incomplete,\n* `20  ` - Error,\n* `30  ` - Freezable,\n* `40  ` - Pending Cancel,\n* `50  ` - Frozen,\n* `60  ` - Canceled,\n* `70  ` - OK"}}}}}},"messages":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"billMessageCode":{"type":"string","maxLength":4,"description":"Bill Message"},"insert":{"type":"string","maxLength":8,"description":"Insert Code defines if the bill message causes an insert in the envelope."},"messagePriority":{"type":"string","enum":["10  ","20  ","30  ","40  ","50  ","60  ","70  ","80  ","90  "],"description":"Priority is the bill messages priority (on the printed bill).\n* `10  ` - Priority 10 -- Lowest,\n* `20  ` - Priority 20,\n* `30  ` - Priority 30,\n* `40  ` - Priority 40,\n* `50  ` - Priority 50,\n* `60  ` - Priority 60,\n* `70  ` - Priority 70,\n* `80  ` - Priority 80,\n* `90  ` - Priority 90 -- Highest","example":"20"},"messageOnBill":{"type":"string","maxLength":254,"description":"Message On Bill is the message associated with the code.","example":"Electric service not billed"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"}}}}}},"nextActions":{"type":"object","properties":{"_link":{"type":"string","description":"(_link)"},"_data":{"type":"array","items":{"type":"object","properties":{"_link":{"type":"string","description":"(_link)"},"actionName":{"type":"string","description":"(actionName)"}}}}}}},"xml":{"name":"C1-BillSegm"}},"UPDATEBILLSEGMENT_response":{"type":"object","properties":{"_self":{"type":"string","description":"_self"},"httpMethod":{"type":"string","enum":["DELT","GET ","POST","PTCH","PUT "],"description":"HTTP Method\n* `DELT` - Delete,\n* `GET ` - Get,\n* `POST` - Post,\n* `PTCH` - Patch,\n* `PUT ` - Put","example":"GET"},"billSegmentId":{"type":"string","maxLength":12,"description":"Bill Segment ID is the system-assigned unique identifier of the bill segment.","example":"211366855400"},"account":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"accountId":{"type":"string","maxLength":10,"description":"Account ID identifies the customer who is responsible for the bill.","example":"1112345900"}}},"currentAmount":{"type":"number","description":"Current Amount is the bill segment's effect on the service agreement's current balance.","example":"$405.52"},"payoffAmount":{"type":"number","maximum":9999999999999.99,"minimum":0,"description":"Payoff Amount is only shown if it differs from current amount.","example":"$33.20"},"bill":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"billId":{"type":"string","maxLength":12,"description":"Bill ID is the system-assigned unique identifier of the bill on which the bill segment appears. A concatenation of its bill date, status, due date and amount is displayed.","example":"211122345678"}}},"serviceAgreement":{"type":"object","description":"SA ID contains information about the bill segment's service agreement.","properties":{"_link":{"type":"string","description":"_link"},"serviceAgreementId":{"type":"string","maxLength":10,"description":"Service Agreement"}}},"periodStartDate":{"type":"string","format":"date","description":"Start Date"},"periodEndDate":{"type":"string","format":"date","description":"End Date"},"usageStartDateTime":{"type":"string","format":"date-time","description":"Usage start date is the first day for bill segment used by meter data management system.","example":"03-04-2013"},"usageEndDateTime":{"type":"string","format":"date-time","description":"Usage end date is the last date for bill segment used by meter data management system.","example":"03-04-2013"},"billSegmentPeriod":{"type":"string","maxLength":30,"description":"Bill Segment Period is the start and end dates of the bill segment.","example":"11-04-2013 12-03-2013"},"usagePeriod":{"type":"string","maxLength":1,"description":"Usage Period is the period used by the meter data management system to determine the correct interval data to process for the bill segment.","example":"11-04-2013 12-03-2013"},"billCycle":{"type":"object","description":"Bill Cycle displays the bill cycle and window start date of the bill segment's bill.","properties":{"_link":{"type":"string","description":"_link"},"billCycle":{"type":"string","maxLength":4,"description":"Bill Cycle displays the bill cycle and window start date of the bill segment's bill.","example":"M-D2 (Monthly bill cycle - day 2)"}}},"billStatus":{"type":"string","enum":["C   ","P   "],"description":"Bill Status is the bill's status.\n* `C   ` - Complete,\n* `P   ` - Pending","example":"C"},"isEstimate":{"type":"boolean","description":"If the Estimate switch is on, consumption on this bill segment has been estimated by the system.","example":"true"},"isClosingBillSegment":{"type":"boolean","description":"If the Closing switch is on, this is the final bill segment for the service agreement (i.e., the service agreement has been stopped and this is the final bill segment).","example":"true"},"hasServiceQuantityOverride":{"type":"boolean","description":"If the SQ Override switch is on, a user has overridden the service quantities (i.e., the amount of consumption for which the customer is charged is not consistent with the customer's meter reads).","example":"true"},"isItemOverride":{"type":"boolean","description":"If the Item Override switch is on, a user has overridden the type and/or number of items (i.e., the type/number of items for which the customer is charged is not consistent with the customer's service point information).","example":"true"},"premise":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"premiseId":{"type":"string","maxLength":10,"description":"Premise ID defines the address on bills for persons who have their bill sent to the account's mailing premise."}}},"creationDateTime":{"type":"string","format":"date-time","description":"Create Date/Time is the date and time on which the bill was originally created.","example":"2001-05-16"},"saRelationshipId":{"type":"string","maxLength":10,"description":"SA Relationship ID shows the unique identifier of the record that defines the relationship between the sub service agreement and the master service agreement (this record shows the service provider associated with the bill segment)."},"billSegmentStatus":{"type":"string","enum":["10  ","20  ","30  ","40  ","50  ","60  ","70  "],"description":"Bill Segment Status:\n* `10  ` - Incomplete,\n* `20  ` - Error,\n* `30  ` - Freezable,\n* `40  ` - Pending Cancel,\n* `50  ` - Frozen,\n* `60  ` - Canceled,\n* `70  ` - OK"},"billSegmentStatusDescription":{"type":"string","maxLength":150,"description":"Description for bill segment's status.","example":"Freezable"},"statusChangeDateTime":{"type":"string","format":"date-time","description":"Bill Segment's status change date/time","example":"06-05-2013 04:28PM"},"cancelReasonDescription":{"type":"string","maxLength":100,"description":"Cancel Reason Description defines the reason why the bill segment(s) are being canceled.","example":"Canceled prior to completion."},"quote":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"quoteId":{"type":"string","maxLength":12,"description":"Quote ID is the system-assigned unique identifier of the quote."}}},"cutOffDate":{"type":"string","format":"date","description":"Cutoff Date is the last day of the new bill segment.","example":"2021-10-05"},"accountingDate":{"type":"string","format":"date","description":"Accounting Date"},"cancelReason":{"type":"object","description":"Cancel Reason defines why the bill segment(s) are being canceled.","properties":{"_link":{"type":"string","description":"_link"},"cancelReason":{"type":"string","maxLength":4,"description":"Cancel Reason defines why the bill segment(s) are being canceled.","example":"Wrong read"}}},"areEstimatesAllowed":{"type":"boolean","description":"Check Allow Estimates if the system is allowed to estimate consumption if it can't find a meter read.","example":"false"},"hasBillingOption":{"type":"boolean","description":"If the service agreements use meter reads, use the Billing Option to control how the system retrieves meter reads that appear on the bill. \n\nSelect Use Schedule if the system should select reads based on the SA's SP's service cycle schedule. Select Use Cut off Date if the system should only select reads from the end date of the existing bill segment.","example":"true"},"canUseOldReadsItemsServiceQuantity":{"type":"boolean","description":"Check Use Old Read/Item/SQ if the system is configured to use the consumption details used on the original bill segments.","example":"false"},"creditDate":{"type":"string","format":"date","description":"Bill Date is the business date that was used when the bill was completed.","example":"06-05-2013"},"creditNote":{"type":"string","maxLength":12,"description":"The Credit Note is used to cancel selected bill segments and create a new bill that contains the cancellation details. We refer to this \"negative bill\" as a credit note."},"correctionNote":{"type":"string","maxLength":150,"description":"The Correction Note is used to cancel and rebill bill segments and create a new bill that contains the cancellation and rebill details."},"canShowAccountingDate":{"type":"boolean","description":"Accounting Date  is the date the system uses to determine the financial transaction's accounting period in your general ledger.","example":"06-05-2013"},"processDate":{"type":"string","format":"date","description":"Process Date"},"specialUsage":{"type":"string","enum":["PROP"],"description":"Special Usage flag shows if it's a proposal SA.\n* `PROP` - Proposal SA","example":"PROP"},"currency":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"currency":{"type":"string","maxLength":3,"description":"Currency Code"}}},"windowStartDate":{"type":"string","format":"date","description":"Window Start Date","example":"12-03-2013"},"cancelBillSegmentId":{"type":"string","maxLength":12,"description":"If the bill segment was canceled and rebilled by another segment, a reference to the new bill segment is displayed. Cancel Bill Segment ID refers to the new bill segment id that superseded the canceled segment.","example":"661660087111"},"masterBillSegmentId":{"type":"string","maxLength":12,"description":"Master Bseg ID shows the unique identifier of the master bill segment whose bill triggered the creation of this sub service agreement.","example":"661660087111"},"quoteDetailId":{"type":"string","maxLength":12,"description":"Quote Detail ID is the system-assigned unique identifier of the quote detail."},"billScenarioId":{"type":"string","maxLength":12,"description":"Billing Scenario ID allows you to go to the proposal SA's billing scenario where you can tinker with consumption and the bill segment period used to generate this bill segment."},"canCancel":{"type":"boolean","description":"The Cancel is used to cancel a Pending Cancel bill segment to become Canceled.","example":"true"},"canDelete":{"type":"boolean","description":"The Delete is used to delete one or more bill segments.","example":"false"},"canFreeze":{"type":"boolean","description":"The Freeze is used to freeze one or more bill segments."},"canGenerate":{"type":"boolean","description":"The Generate is used to delete and recreate one or more bill segments.","example":"false"},"canInitCancel":{"type":"boolean","description":"Initialize  Cancel causes the first step of the bill segment cancellation process to be executed. You'd click this button if a frozen bill segment should never have been created (i.e., you want to remove the financial impact of a bill segment from a customer's balance).\n\nThis button is enabled when you display a Frozen bill segment AND the bill segment's bill is not written off.","example":"false"},"shouldRebill":{"type":"boolean","description":"The Rebill causes an existing bill segment to be canceled, and a new bill segment to be created.","example":"true"},"canActionRegenerate":{"type":"boolean","description":"Regenerate action regenerated the bill segment after correcting the cause of the problem for errored bill segment.","example":"false"},"canUndo":{"type":"boolean","description":"Undo returns a Pending Cancel bill segment to the Frozen state.","example":"false"},"isCreditNote":{"type":"boolean","description":"Credit Note is used to cancel ALL bill segments and create a new bill that contains the cancellation details.","example":"false"},"isCorrectionNote":{"type":"boolean","description":"The Correction Note is used to cancel and rebill bill segments and create a new bill that contains the cancellation and rebill details.","example":"false"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"},"exception":{"type":"object","properties":{"messageCategory":{"type":"number","maximum":99999,"minimum":-99999,"description":"Message category within Oracle Utilities Application Framework.","example":"0"},"messageNumber":{"type":"number","maximum":99999,"minimum":-99999,"description":"Message number within Oracle Utilities Application Framework.","example":"0"},"expandedMessage":{"type":"string","maxLength":254,"description":"Expanded Message exception"}}},"readDetails":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"finalUnitOfMeasure":{"type":"string","maxLength":30,"description":"Final Unit of Measure is the final unit of measure of the calculation / audit read.","example":"CF"},"finalTimeOfUse":{"type":"string","maxLength":30,"description":"Final Time of Use is the final time-of-use code of the calculation / audit read.","example":"ON"},"finalServiceQuantityId":{"type":"string","maxLength":30,"description":"Final SQI is the final service quantity identifier of the calculation / audit read.","example":"DAMT"},"registerQuantity":{"type":"number","maximum":1000000000000,"minimum":-1000000000000,"description":"Quantity is the quantity of the calculation / audit read. This would typically contain the amount that was billed during the Start Date/Time through the End Date/Time for the Final Unit of Measure, Final Time of Use and Final SQI.","example":"200.000000"},"servicePointId":{"type":"string","maxLength":10,"description":"Service Point ID"},"meterConfigurationId":{"type":"string","maxLength":10,"description":"Meter Configuration ID"},"sequence":{"type":"number","maximum":99999,"minimum":-99999,"description":"Sequence"},"unitOfMeasure":{"type":"string","maxLength":30,"description":"Unit of Measure"},"timeOfUse":{"type":"string","maxLength":30,"description":"Time of Use"},"serviceQuantityIdentifier":{"type":"string","maxLength":30,"description":"SQI"},"startRegisterReading":{"type":"number","maximum":999999999.999999,"minimum":-999999999.999999,"description":"Start Register Reading is the start register reading.","example":"7201.000000"},"endRegisterReading":{"type":"number","maximum":999999999.999999,"minimum":-999999999.999999,"description":"End Register Reading is the end register reading.","example":"11578.000000"},"measuredQuantity":{"type":"number","maximum":1000000000000,"minimum":-1000000000000,"description":"Measured Quantity is the resulting measured quantity (if any). This value would typically only be displayed if the calculation / audit read is subtractive","example":"4377.000000"},"registerConstant":{"type":"number","maximum":999999.999999,"minimum":-999999.999999,"description":"Constant is the constant of the measuring device that was multiplied by the Measured Quantity to derive the calculation / audit read's Quantity.","example":"1.000000"},"howToUse":{"type":"string","enum":["+   ","-   ","C   ","P   "],"description":"How To Use is a code that indicates if the \"calculation / audit\" read was is considered to be additive, subtractive, peak or check.\n* `+   ` - Additive,\n* `-   ` - Subtractive,\n* `C   ` - Check,\n* `P   ` - Peak","example":"+"},"howToUseRead":{"type":"string","enum":["+   ","-   ","C   ","S   ","X   "],"description":"How To Use (SP) is the SA/SP's how to use code.\n* `+   ` - Add,\n* `-   ` - Subtract,\n* `C   ` - Check,\n* `S   ` - Service Quantity,\n* `X   ` - Calculation/Audit","example":"+"},"usePercent":{"type":"number","maximum":999,"minimum":-999,"description":"Use Percent is the percentage of the total consumption that was billed.","example":"100"},"measuresPeakQuantity":{"type":"boolean","description":"Measures Peak Qty"},"startReadDateTime":{"type":"string","format":"date-time","description":"Start Read Date/Time is the date and time of the start meter read.","example":"1998-06-30T00:00:00-04:00"},"endReadDateTime":{"type":"string","format":"date-time","description":"End Read Date/Time is the date and time of the end meter read.","example":"998-09-30T00:00:00-04:00"},"startRegisterReadId":{"type":"string","maxLength":12,"description":"Start Register Read ID is the unique identifier of the start register read.","example":"444074862768"},"endRegisterReadingId":{"type":"string","maxLength":12,"description":"End Register Read ID is the unique identifier of the end register read.","example":"444074849655"},"startRegisterReadTypeDescription":{"type":"string","maxLength":150,"description":"Start Register Read Type Description"},"endRegisterReadTypeDescription":{"type":"string","maxLength":150,"description":"End Register Read Type Description"},"multiplier":{"type":"number","maximum":1000000000000,"minimum":-1000000000000,"description":"Multiplier is the composite multiplier that converts the measured quantity to the registered quantity.","example":"1.000000"},"consumptionType":{"type":"string","enum":["C   ","S   "],"description":"Consumptive/Subtractive flag shows if the register is consumptive or subtractive.\n* `C   ` - Consumptive,\n* `S   ` - Subtractive","example":"S"},"notAvailableConsumptionDescription":{"type":"string","maxLength":150,"description":"Not Available Consumption Description"},"startMeterRead":{"type":"string","maxLength":12,"description":"Start meter read ID","example":"444074813104"},"endMeterRead":{"type":"string","maxLength":12,"description":"End meter read ID","example":"44074866808"},"meterReadId":{"type":"string","maxLength":12,"description":"Meter Read ID","example":"8833057699"},"unitOfMeasure2":{"type":"string","maxLength":30,"description":"Unit of Measure  is the description for unit of measure of the service quantity.","example":"Cubic feet of water"},"serviceQuantityIdentifier2":{"type":"string","maxLength":30,"description":"SQI is the service quantity identifier description of the service quantity.","example":"Daily Amount"},"timeOfUse2":{"type":"string","maxLength":30,"description":"Time of Use is the register's time-of-use description.","example":"off-peak"},"finalUomDescription":{"type":"string","maxLength":150,"description":"Final Uom Description"},"finalSqiDescription":{"type":"string","maxLength":150,"description":"Final SQI Description"},"finalTouDescription":{"type":"string","maxLength":150,"description":"Final TOU Description"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"}}}}}},"items":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"sequence":{"type":"number","maximum":99999,"minimum":-99999,"description":"Sequence"},"itemType":{"type":"string","maxLength":30,"description":"Item Type is the type of item.","example":"Generic Current Transformer"},"item":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"itemId":{"type":"string","maxLength":10,"description":"Item ID"}}},"startDate":{"type":"string","format":"date","description":"Start Date"},"endDate":{"type":"string","format":"date","description":"End Date"},"itemCount":{"type":"number","maximum":999999999.99,"minimum":-999999999.99,"description":"Item Count is the number of items of this type that were linked to the service agreement's service points during the bill segment's bill period.","example":"1.00"},"unitOfMeasure":{"type":"string","maxLength":30,"description":"Unit of Measure"},"dailyServiceQuantity":{"type":"number","maximum":1000000000000,"minimum":-1000000000000,"description":"Daily Service Quantity is the item's estimated amount of daily consumption.","example":"470.762600"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"}}}}}},"serviceQuantities":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"unitOfMeasure":{"type":"string","maxLength":30,"description":"Unit of Measure"},"timeOfUse":{"type":"string","maxLength":30,"description":"Time of Use"},"serviceQuantityIdentifier":{"type":"string","maxLength":30,"description":"SQI"},"initialServiceQuantity":{"type":"number","maximum":1000000000000,"minimum":-1000000000000,"description":"Initial Service Quantity is the initial quantity amassed by the system before application of the rate's pre-processing calculation group(s), if any exists.","example":"470.762600"},"billableServiceQuantity":{"type":"number","maximum":1000000000000,"minimum":-1000000000000,"description":"Billable Service Quantity"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"}}}}}},"calcLines":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"headerSequence":{"type":"number","maximum":999,"minimum":-999,"description":"Header Sequence"},"startDate":{"type":"string","format":"date","description":"Start Date"},"endDate":{"type":"string","format":"date","description":"End Date"},"currency":{"type":"string","maxLength":3,"description":"Currency Code"},"calculatedAmount":{"type":"number","description":"Calculated Amount"},"rateSchedule":{"type":"string","maxLength":8,"description":"Rate Schedule"},"effectiveDate":{"type":"string","format":"date","description":"Effective Date"},"billableCharge":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"billableChargeId":{"type":"string","maxLength":12,"description":"Billable Charge ID"}}},"descriptionOnBill":{"type":"string","maxLength":254,"description":"Description on Bill"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"},"calculationLines":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"headerSequence":{"type":"number","maximum":999,"minimum":-999,"description":"Header Sequence"},"sequence":{"type":"number","maximum":99999,"minimum":-99999,"description":"Sequence"},"characteristicType":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"characteristicType":{"type":"string","maxLength":8,"description":"Characteristic Type"}}},"currency":{"type":"string","maxLength":3,"description":"Currency Code"},"characteristicValue":{"type":"string","maxLength":16,"description":"Characteristic Value"},"distributionCode":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"distributionCode":{"type":"string","maxLength":10,"description":"Distribution Code"}}},"unitOfMeasure":{"type":"string","maxLength":30,"description":"Unit of Measure"},"timeOfUse":{"type":"string","maxLength":30,"description":"Time of Use"},"rcSequence":{"type":"number","maximum":9999,"minimum":-9999,"description":"Rate Component Sequence refers to the sequence number of the rate component on the applicable rate version calculation group that was used to calculate the line. This is only populated if the original rate engine calculated the charges.","example":"10"},"shouldPrint":{"type":"boolean","description":"The Print switch controls whether information about this line will print on the customer's bill.","example":"true"},"shouldAppearInSummary":{"type":"boolean","description":"The Appears in Summary switch defines if this line's amount also appears on a summary line.","example":"true"},"calculatedAmount":{"type":"number","description":"Calculated Amount"},"exemptAmount":{"type":"number","description":"Exempt Amount is the amount of the calculated charge that the customer doesn't have to pay because they are tax exempt.","example":"$0.00"},"baseAmount":{"type":"number","description":"Base Amount is used by calculation lines (e.g. taxes) that are cross-referenced to other calculation lines and whose value(s), therefore, depend on the amounts calculated by those other lines. The Base Amount shows the total amount derived from the cross-referenced line(s) that the current line then used to calculate its billed amount.","example":"$102.71"},"serviceQuantityIdentifier":{"type":"string","maxLength":30,"description":"SQI"},"billableServiceQuantity":{"type":"number","maximum":1000000000000,"minimum":-1000000000000,"description":"Billable Service Quantity"},"measuresPeakQuantity":{"type":"boolean","description":"Measures Peak Qty"},"descriptionOnBill":{"type":"string","maxLength":254,"description":"Description on Bill"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"},"distributionDescription":{"type":"string","maxLength":30,"description":"Distribution Code Description"},"isCharacteristicExist":{"type":"boolean","description":"Characteristic exists","example":"false"}}}}}}}}}}},"financialDetails":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"financialTransactionId":{"type":"string","maxLength":12,"description":"FT ID is the system-assigned unique identifier of the financial transaction (FT).","example":"211166656266"},"financialTransactionType":{"type":"string","enum":["AD  ","AX  ","BS  ","BX  ","PS  ","PX  "],"description":"Financial Transaction Type:\n\n    AD - Adjustment,\n    AX - Adjustment Cancellation,\n    BS - Bill Segment,\n    BX - Bill Segment Cancellation,\n    PS - Pay Segment,\n    PX - Pay Segment Cancellation\n* `AD  ` - Adjustment,\n* `AX  ` - Adjustment Cancellation,\n* `BS  ` - Bill Segment,\n* `BX  ` - Bill Segment Cancellation,\n* `PS  ` - Pay Segment,\n* `PX  ` - Pay Segment Cancellation","example":"BS"},"financialTransactionTypeDescription":{"type":"string","maxLength":150,"description":"FT Type Description"},"currentAmount":{"type":"number","description":"Current Amount"},"accountingDate":{"type":"string","format":"date","description":"Accounting Date"},"arrearsDate":{"type":"string","format":"date","description":"Arrears Date is the date the FT starts aging.","example":"03-04-2013"},"shouldShowOnBill":{"type":"boolean","description":"Show on bill indicates if information about the FT appears on the customer's bill.","example":"true"},"_data":{"type":"array","items":{"type":"object","properties":{"sequence":{"type":"number","maximum":999,"minimum":-999,"description":"Sequence"},"distributionCode":{"type":"string","maxLength":10,"description":"Distribution Code"},"characteristicType":{"type":"string","maxLength":8,"description":"Characteristic Type"},"characteristicValue":{"type":"string","maxLength":16,"description":"Characteristic Value"},"amount":{"type":"number","description":"Amount defines the journal line's amount.","example":"$33.00"},"statistics":{"type":"string","maxLength":8,"description":"Statistics Code is only specified when a statistical quantity is associated with the distribution line.","example":"CF"},"statisticAmount":{"type":"number","maximum":10000000000000,"minimum":-10000000000000,"description":"Statistic Amount defines the statistical amount that will be posted to the GL. This value is only populated on distribution lines created for calculation rules designated as affecting GL statistical quantity.","example":"0.000"},"isTotalAmount":{"type":"boolean","description":"Total Amount defines if the journal line contains the total of the other journal lines.","example":"true"},"distributionDescription":{"type":"string","maxLength":30,"description":"Distribution Code Description"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"}}}}}}}}},"subBillSegments":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"currentAmount":{"type":"number","description":"Current Amount"},"billSegmentStatus":{"type":"string","enum":["10  ","20  ","30  ","40  ","50  ","60  ","70  "],"description":"Bill Segment Status:\n* `10  ` - Incomplete,\n* `20  ` - Error,\n* `30  ` - Freezable,\n* `40  ` - Pending Cancel,\n* `50  ` - Frozen,\n* `60  ` - Canceled,\n* `70  ` - OK"}}}}}},"messages":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"billMessageCode":{"type":"string","maxLength":4,"description":"Bill Message"},"insert":{"type":"string","maxLength":8,"description":"Insert Code defines if the bill message causes an insert in the envelope."},"messagePriority":{"type":"string","enum":["10  ","20  ","30  ","40  ","50  ","60  ","70  ","80  ","90  "],"description":"Priority is the bill messages priority (on the printed bill).\n* `10  ` - Priority 10 -- Lowest,\n* `20  ` - Priority 20,\n* `30  ` - Priority 30,\n* `40  ` - Priority 40,\n* `50  ` - Priority 50,\n* `60  ` - Priority 60,\n* `70  ` - Priority 70,\n* `80  ` - Priority 80,\n* `90  ` - Priority 90 -- Highest","example":"20"},"messageOnBill":{"type":"string","maxLength":254,"description":"Message On Bill is the message associated with the code.","example":"Electric service not billed"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"}}}}}},"nextActions":{"type":"object","properties":{"_link":{"type":"string","description":"(_link)"},"_data":{"type":"array","items":{"type":"object","properties":{"_link":{"type":"string","description":"(_link)"},"actionName":{"type":"string","description":"(actionName)"}}}}}}},"xml":{"name":"C1-BillSegm"}},"CREATEBILLSEGMENT_request":{"type":"object","properties":{"httpMethod":{"type":"string","enum":["DELT","GET ","POST","PTCH","PUT "],"description":"HTTP Method\n* `DELT` - Delete,\n* `GET ` - Get,\n* `POST` - Post,\n* `PTCH` - Patch,\n* `PUT ` - Put","example":"GET"},"billSegmentId":{"type":"string","maxLength":12,"description":"Bill Segment ID is the system-assigned unique identifier of the bill segment.","example":"211366855400"},"account":{"type":"object","properties":{"accountId":{"type":"string","maxLength":10,"description":"Account ID identifies the customer who is responsible for the bill.","example":"1112345900"}}},"currentAmount":{"type":"number","description":"Current Amount is the bill segment's effect on the service agreement's current balance.","example":"$405.52"},"payoffAmount":{"type":"number","maximum":9999999999999.99,"minimum":0,"description":"Payoff Amount is only shown if it differs from current amount.","example":"$33.20"},"bill":{"type":"object","properties":{"billId":{"type":"string","maxLength":12,"description":"Bill ID is the system-assigned unique identifier of the bill on which the bill segment appears. A concatenation of its bill date, status, due date and amount is displayed.","example":"211122345678"}}},"serviceAgreement":{"type":"object","description":"SA ID contains information about the bill segment's service agreement.","properties":{"serviceAgreementId":{"type":"string","maxLength":10,"description":"Service Agreement"}}},"periodStartDate":{"type":"string","format":"date","description":"Start Date"},"periodEndDate":{"type":"string","format":"date","description":"End Date"},"usageStartDateTime":{"type":"string","format":"date-time","description":"Usage start date is the first day for bill segment used by meter data management system.","example":"03-04-2013"},"usageEndDateTime":{"type":"string","format":"date-time","description":"Usage end date is the last date for bill segment used by meter data management system.","example":"03-04-2013"},"billSegmentPeriod":{"type":"string","maxLength":30,"description":"Bill Segment Period is the start and end dates of the bill segment.","example":"11-04-2013 12-03-2013"},"usagePeriod":{"type":"string","maxLength":1,"description":"Usage Period is the period used by the meter data management system to determine the correct interval data to process for the bill segment.","example":"11-04-2013 12-03-2013"},"billCycle":{"type":"object","description":"Bill Cycle displays the bill cycle and window start date of the bill segment's bill.","properties":{"billCycle":{"type":"string","maxLength":4,"description":"Bill Cycle displays the bill cycle and window start date of the bill segment's bill.","example":"M-D2 (Monthly bill cycle - day 2)"}}},"billStatus":{"type":"string","enum":["C   ","P   "],"description":"Bill Status is the bill's status.\n* `C   ` - Complete,\n* `P   ` - Pending","example":"C"},"isEstimate":{"type":"boolean","description":"If the Estimate switch is on, consumption on this bill segment has been estimated by the system.","example":"true"},"isClosingBillSegment":{"type":"boolean","description":"If the Closing switch is on, this is the final bill segment for the service agreement (i.e., the service agreement has been stopped and this is the final bill segment).","example":"true"},"hasServiceQuantityOverride":{"type":"boolean","description":"If the SQ Override switch is on, a user has overridden the service quantities (i.e., the amount of consumption for which the customer is charged is not consistent with the customer's meter reads).","example":"true"},"isItemOverride":{"type":"boolean","description":"If the Item Override switch is on, a user has overridden the type and/or number of items (i.e., the type/number of items for which the customer is charged is not consistent with the customer's service point information).","example":"true"},"premise":{"type":"object","properties":{"premiseId":{"type":"string","maxLength":10,"description":"Premise ID defines the address on bills for persons who have their bill sent to the account's mailing premise."}}},"creationDateTime":{"type":"string","format":"date-time","description":"Create Date/Time is the date and time on which the bill was originally created.","example":"2001-05-16"},"saRelationshipId":{"type":"string","maxLength":10,"description":"SA Relationship ID shows the unique identifier of the record that defines the relationship between the sub service agreement and the master service agreement (this record shows the service provider associated with the bill segment)."},"billSegmentStatus":{"type":"string","enum":["10  ","20  ","30  ","40  ","50  ","60  ","70  "],"description":"Bill Segment Status:\n* `10  ` - Incomplete,\n* `20  ` - Error,\n* `30  ` - Freezable,\n* `40  ` - Pending Cancel,\n* `50  ` - Frozen,\n* `60  ` - Canceled,\n* `70  ` - OK"},"billSegmentStatusDescription":{"type":"string","maxLength":150,"description":"Description for bill segment's status.","example":"Freezable"},"statusChangeDateTime":{"type":"string","format":"date-time","description":"Bill Segment's status change date/time","example":"06-05-2013 04:28PM"},"cancelReasonDescription":{"type":"string","maxLength":100,"description":"Cancel Reason Description defines the reason why the bill segment(s) are being canceled.","example":"Canceled prior to completion."},"quote":{"type":"object","properties":{"quoteId":{"type":"string","maxLength":12,"description":"Quote ID is the system-assigned unique identifier of the quote."}}},"cutOffDate":{"type":"string","format":"date","description":"Cutoff Date is the last day of the new bill segment.","example":"2021-10-05"},"accountingDate":{"type":"string","format":"date","description":"Accounting Date"},"cancelReason":{"type":"object","description":"Cancel Reason defines why the bill segment(s) are being canceled.","properties":{"cancelReason":{"type":"string","maxLength":4,"description":"Cancel Reason defines why the bill segment(s) are being canceled.","example":"Wrong read"}}},"areEstimatesAllowed":{"type":"boolean","description":"Check Allow Estimates if the system is allowed to estimate consumption if it can't find a meter read.","example":"false"},"hasBillingOption":{"type":"boolean","description":"If the service agreements use meter reads, use the Billing Option to control how the system retrieves meter reads that appear on the bill. \n\nSelect Use Schedule if the system should select reads based on the SA's SP's service cycle schedule. Select Use Cut off Date if the system should only select reads from the end date of the existing bill segment.","example":"true"},"canUseOldReadsItemsServiceQuantity":{"type":"boolean","description":"Check Use Old Read/Item/SQ if the system is configured to use the consumption details used on the original bill segments.","example":"false"},"creditDate":{"type":"string","format":"date","description":"Bill Date is the business date that was used when the bill was completed.","example":"06-05-2013"},"creditNote":{"type":"string","maxLength":12,"description":"The Credit Note is used to cancel selected bill segments and create a new bill that contains the cancellation details. We refer to this \"negative bill\" as a credit note."},"correctionNote":{"type":"string","maxLength":150,"description":"The Correction Note is used to cancel and rebill bill segments and create a new bill that contains the cancellation and rebill details."},"canShowAccountingDate":{"type":"boolean","description":"Accounting Date  is the date the system uses to determine the financial transaction's accounting period in your general ledger.","example":"06-05-2013"},"processDate":{"type":"string","format":"date","description":"Process Date"},"specialUsage":{"type":"string","enum":["PROP"],"description":"Special Usage flag shows if it's a proposal SA.\n* `PROP` - Proposal SA","example":"PROP"},"currency":{"type":"object","properties":{"currency":{"type":"string","maxLength":3,"description":"Currency Code"}}},"windowStartDate":{"type":"string","format":"date","description":"Window Start Date","example":"12-03-2013"},"cancelBillSegmentId":{"type":"string","maxLength":12,"description":"If the bill segment was canceled and rebilled by another segment, a reference to the new bill segment is displayed. Cancel Bill Segment ID refers to the new bill segment id that superseded the canceled segment.","example":"661660087111"},"masterBillSegmentId":{"type":"string","maxLength":12,"description":"Master Bseg ID shows the unique identifier of the master bill segment whose bill triggered the creation of this sub service agreement.","example":"661660087111"},"quoteDetailId":{"type":"string","maxLength":12,"description":"Quote Detail ID is the system-assigned unique identifier of the quote detail."},"billScenarioId":{"type":"string","maxLength":12,"description":"Billing Scenario ID allows you to go to the proposal SA's billing scenario where you can tinker with consumption and the bill segment period used to generate this bill segment."},"canCancel":{"type":"boolean","description":"The Cancel is used to cancel a Pending Cancel bill segment to become Canceled.","example":"true"},"canDelete":{"type":"boolean","description":"The Delete is used to delete one or more bill segments.","example":"false"},"canFreeze":{"type":"boolean","description":"The Freeze is used to freeze one or more bill segments."},"canGenerate":{"type":"boolean","description":"The Generate is used to delete and recreate one or more bill segments.","example":"false"},"canInitCancel":{"type":"boolean","description":"Initialize  Cancel causes the first step of the bill segment cancellation process to be executed. You'd click this button if a frozen bill segment should never have been created (i.e., you want to remove the financial impact of a bill segment from a customer's balance).\n\nThis button is enabled when you display a Frozen bill segment AND the bill segment's bill is not written off.","example":"false"},"shouldRebill":{"type":"boolean","description":"The Rebill causes an existing bill segment to be canceled, and a new bill segment to be created.","example":"true"},"canActionRegenerate":{"type":"boolean","description":"Regenerate action regenerated the bill segment after correcting the cause of the problem for errored bill segment.","example":"false"},"canUndo":{"type":"boolean","description":"Undo returns a Pending Cancel bill segment to the Frozen state.","example":"false"},"isCreditNote":{"type":"boolean","description":"Credit Note is used to cancel ALL bill segments and create a new bill that contains the cancellation details.","example":"false"},"isCorrectionNote":{"type":"boolean","description":"The Correction Note is used to cancel and rebill bill segments and create a new bill that contains the cancellation and rebill details.","example":"false"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"},"exception":{"type":"object","properties":{"messageCategory":{"type":"number","maximum":99999,"minimum":-99999,"description":"Message category within Oracle Utilities Application Framework.","example":"0"},"messageNumber":{"type":"number","maximum":99999,"minimum":-99999,"description":"Message number within Oracle Utilities Application Framework.","example":"0"},"expandedMessage":{"type":"string","maxLength":254,"description":"Expanded Message exception"}}},"readDetails":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"finalUnitOfMeasure":{"type":"string","maxLength":30,"description":"Final Unit of Measure is the final unit of measure of the calculation / audit read.","example":"CF"},"finalTimeOfUse":{"type":"string","maxLength":30,"description":"Final Time of Use is the final time-of-use code of the calculation / audit read.","example":"ON"},"finalServiceQuantityId":{"type":"string","maxLength":30,"description":"Final SQI is the final service quantity identifier of the calculation / audit read.","example":"DAMT"},"registerQuantity":{"type":"number","maximum":1000000000000,"minimum":-1000000000000,"description":"Quantity is the quantity of the calculation / audit read. This would typically contain the amount that was billed during the Start Date/Time through the End Date/Time for the Final Unit of Measure, Final Time of Use and Final SQI.","example":"200.000000"},"servicePointId":{"type":"string","maxLength":10,"description":"Service Point ID"},"meterConfigurationId":{"type":"string","maxLength":10,"description":"Meter Configuration ID"},"sequence":{"type":"number","maximum":99999,"minimum":-99999,"description":"Sequence"},"unitOfMeasure":{"type":"string","maxLength":30,"description":"Unit of Measure"},"timeOfUse":{"type":"string","maxLength":30,"description":"Time of Use"},"serviceQuantityIdentifier":{"type":"string","maxLength":30,"description":"SQI"},"startRegisterReading":{"type":"number","maximum":999999999.999999,"minimum":-999999999.999999,"description":"Start Register Reading is the start register reading.","example":"7201.000000"},"endRegisterReading":{"type":"number","maximum":999999999.999999,"minimum":-999999999.999999,"description":"End Register Reading is the end register reading.","example":"11578.000000"},"measuredQuantity":{"type":"number","maximum":1000000000000,"minimum":-1000000000000,"description":"Measured Quantity is the resulting measured quantity (if any). This value would typically only be displayed if the calculation / audit read is subtractive","example":"4377.000000"},"registerConstant":{"type":"number","maximum":999999.999999,"minimum":-999999.999999,"description":"Constant is the constant of the measuring device that was multiplied by the Measured Quantity to derive the calculation / audit read's Quantity.","example":"1.000000"},"howToUse":{"type":"string","enum":["+   ","-   ","C   ","P   "],"description":"How To Use is a code that indicates if the \"calculation / audit\" read was is considered to be additive, subtractive, peak or check.\n* `+   ` - Additive,\n* `-   ` - Subtractive,\n* `C   ` - Check,\n* `P   ` - Peak","example":"+"},"howToUseRead":{"type":"string","enum":["+   ","-   ","C   ","S   ","X   "],"description":"How To Use (SP) is the SA/SP's how to use code.\n* `+   ` - Add,\n* `-   ` - Subtract,\n* `C   ` - Check,\n* `S   ` - Service Quantity,\n* `X   ` - Calculation/Audit","example":"+"},"usePercent":{"type":"number","maximum":999,"minimum":-999,"description":"Use Percent is the percentage of the total consumption that was billed.","example":"100"},"measuresPeakQuantity":{"type":"boolean","description":"Measures Peak Qty"},"startReadDateTime":{"type":"string","format":"date-time","description":"Start Read Date/Time is the date and time of the start meter read.","example":"1998-06-30T00:00:00-04:00"},"endReadDateTime":{"type":"string","format":"date-time","description":"End Read Date/Time is the date and time of the end meter read.","example":"998-09-30T00:00:00-04:00"},"startRegisterReadId":{"type":"string","maxLength":12,"description":"Start Register Read ID is the unique identifier of the start register read.","example":"444074862768"},"endRegisterReadingId":{"type":"string","maxLength":12,"description":"End Register Read ID is the unique identifier of the end register read.","example":"444074849655"},"startRegisterReadTypeDescription":{"type":"string","maxLength":150,"description":"Start Register Read Type Description"},"endRegisterReadTypeDescription":{"type":"string","maxLength":150,"description":"End Register Read Type Description"},"multiplier":{"type":"number","maximum":1000000000000,"minimum":-1000000000000,"description":"Multiplier is the composite multiplier that converts the measured quantity to the registered quantity.","example":"1.000000"},"consumptionType":{"type":"string","enum":["C   ","S   "],"description":"Consumptive/Subtractive flag shows if the register is consumptive or subtractive.\n* `C   ` - Consumptive,\n* `S   ` - Subtractive","example":"S"},"notAvailableConsumptionDescription":{"type":"string","maxLength":150,"description":"Not Available Consumption Description"},"startMeterRead":{"type":"string","maxLength":12,"description":"Start meter read ID","example":"444074813104"},"endMeterRead":{"type":"string","maxLength":12,"description":"End meter read ID","example":"44074866808"},"meterReadId":{"type":"string","maxLength":12,"description":"Meter Read ID","example":"8833057699"},"unitOfMeasure2":{"type":"string","maxLength":30,"description":"Unit of Measure  is the description for unit of measure of the service quantity.","example":"Cubic feet of water"},"serviceQuantityIdentifier2":{"type":"string","maxLength":30,"description":"SQI is the service quantity identifier description of the service quantity.","example":"Daily Amount"},"timeOfUse2":{"type":"string","maxLength":30,"description":"Time of Use is the register's time-of-use description.","example":"off-peak"},"finalUomDescription":{"type":"string","maxLength":150,"description":"Final Uom Description"},"finalSqiDescription":{"type":"string","maxLength":150,"description":"Final SQI Description"},"finalTouDescription":{"type":"string","maxLength":150,"description":"Final TOU Description"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"}}}}}},"items":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"sequence":{"type":"number","maximum":99999,"minimum":-99999,"description":"Sequence"},"itemType":{"type":"string","maxLength":30,"description":"Item Type is the type of item.","example":"Generic Current Transformer"},"item":{"type":"object","properties":{"itemId":{"type":"string","maxLength":10,"description":"Item ID"}}},"startDate":{"type":"string","format":"date","description":"Start Date"},"endDate":{"type":"string","format":"date","description":"End Date"},"itemCount":{"type":"number","maximum":999999999.99,"minimum":-999999999.99,"description":"Item Count is the number of items of this type that were linked to the service agreement's service points during the bill segment's bill period.","example":"1.00"},"unitOfMeasure":{"type":"string","maxLength":30,"description":"Unit of Measure"},"dailyServiceQuantity":{"type":"number","maximum":1000000000000,"minimum":-1000000000000,"description":"Daily Service Quantity is the item's estimated amount of daily consumption.","example":"470.762600"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"}}}}}},"serviceQuantities":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"unitOfMeasure":{"type":"string","maxLength":30,"description":"Unit of Measure"},"timeOfUse":{"type":"string","maxLength":30,"description":"Time of Use"},"serviceQuantityIdentifier":{"type":"string","maxLength":30,"description":"SQI"},"initialServiceQuantity":{"type":"number","maximum":1000000000000,"minimum":-1000000000000,"description":"Initial Service Quantity is the initial quantity amassed by the system before application of the rate's pre-processing calculation group(s), if any exists.","example":"470.762600"},"billableServiceQuantity":{"type":"number","maximum":1000000000000,"minimum":-1000000000000,"description":"Billable Service Quantity"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"}}}}}},"calcLines":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"headerSequence":{"type":"number","maximum":999,"minimum":-999,"description":"Header Sequence"},"startDate":{"type":"string","format":"date","description":"Start Date"},"endDate":{"type":"string","format":"date","description":"End Date"},"currency":{"type":"string","maxLength":3,"description":"Currency Code"},"calculatedAmount":{"type":"number","description":"Calculated Amount"},"rateSchedule":{"type":"string","maxLength":8,"description":"Rate Schedule"},"effectiveDate":{"type":"string","format":"date","description":"Effective Date"},"billableCharge":{"type":"object","properties":{"billableChargeId":{"type":"string","maxLength":12,"description":"Billable Charge ID"}}},"descriptionOnBill":{"type":"string","maxLength":254,"description":"Description on Bill"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"},"calculationLines":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"headerSequence":{"type":"number","maximum":999,"minimum":-999,"description":"Header Sequence"},"sequence":{"type":"number","maximum":99999,"minimum":-99999,"description":"Sequence"},"characteristicType":{"type":"object","properties":{"characteristicType":{"type":"string","maxLength":8,"description":"Characteristic Type"}}},"currency":{"type":"string","maxLength":3,"description":"Currency Code"},"characteristicValue":{"type":"string","maxLength":16,"description":"Characteristic Value"},"distributionCode":{"type":"object","properties":{"distributionCode":{"type":"string","maxLength":10,"description":"Distribution Code"}}},"unitOfMeasure":{"type":"string","maxLength":30,"description":"Unit of Measure"},"timeOfUse":{"type":"string","maxLength":30,"description":"Time of Use"},"rcSequence":{"type":"number","maximum":9999,"minimum":-9999,"description":"Rate Component Sequence refers to the sequence number of the rate component on the applicable rate version calculation group that was used to calculate the line. This is only populated if the original rate engine calculated the charges.","example":"10"},"shouldPrint":{"type":"boolean","description":"The Print switch controls whether information about this line will print on the customer's bill.","example":"true"},"shouldAppearInSummary":{"type":"boolean","description":"The Appears in Summary switch defines if this line's amount also appears on a summary line.","example":"true"},"calculatedAmount":{"type":"number","description":"Calculated Amount"},"exemptAmount":{"type":"number","description":"Exempt Amount is the amount of the calculated charge that the customer doesn't have to pay because they are tax exempt.","example":"$0.00"},"baseAmount":{"type":"number","description":"Base Amount is used by calculation lines (e.g. taxes) that are cross-referenced to other calculation lines and whose value(s), therefore, depend on the amounts calculated by those other lines. The Base Amount shows the total amount derived from the cross-referenced line(s) that the current line then used to calculate its billed amount.","example":"$102.71"},"serviceQuantityIdentifier":{"type":"string","maxLength":30,"description":"SQI"},"billableServiceQuantity":{"type":"number","maximum":1000000000000,"minimum":-1000000000000,"description":"Billable Service Quantity"},"measuresPeakQuantity":{"type":"boolean","description":"Measures Peak Qty"},"descriptionOnBill":{"type":"string","maxLength":254,"description":"Description on Bill"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"},"distributionDescription":{"type":"string","maxLength":30,"description":"Distribution Code Description"},"isCharacteristicExist":{"type":"boolean","description":"Characteristic exists","example":"false"}}}}}}}}}}},"financialDetails":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"financialTransactionId":{"type":"string","maxLength":12,"description":"FT ID is the system-assigned unique identifier of the financial transaction (FT).","example":"211166656266"},"financialTransactionType":{"type":"string","enum":["AD  ","AX  ","BS  ","BX  ","PS  ","PX  "],"description":"Financial Transaction Type:\n\n    AD - Adjustment,\n    AX - Adjustment Cancellation,\n    BS - Bill Segment,\n    BX - Bill Segment Cancellation,\n    PS - Pay Segment,\n    PX - Pay Segment Cancellation\n* `AD  ` - Adjustment,\n* `AX  ` - Adjustment Cancellation,\n* `BS  ` - Bill Segment,\n* `BX  ` - Bill Segment Cancellation,\n* `PS  ` - Pay Segment,\n* `PX  ` - Pay Segment Cancellation","example":"BS"},"financialTransactionTypeDescription":{"type":"string","maxLength":150,"description":"FT Type Description"},"currentAmount":{"type":"number","description":"Current Amount"},"accountingDate":{"type":"string","format":"date","description":"Accounting Date"},"arrearsDate":{"type":"string","format":"date","description":"Arrears Date is the date the FT starts aging.","example":"03-04-2013"},"shouldShowOnBill":{"type":"boolean","description":"Show on bill indicates if information about the FT appears on the customer's bill.","example":"true"},"_data":{"type":"array","items":{"type":"object","properties":{"sequence":{"type":"number","maximum":999,"minimum":-999,"description":"Sequence"},"distributionCode":{"type":"string","maxLength":10,"description":"Distribution Code"},"characteristicType":{"type":"string","maxLength":8,"description":"Characteristic Type"},"characteristicValue":{"type":"string","maxLength":16,"description":"Characteristic Value"},"amount":{"type":"number","description":"Amount defines the journal line's amount.","example":"$33.00"},"statistics":{"type":"string","maxLength":8,"description":"Statistics Code is only specified when a statistical quantity is associated with the distribution line.","example":"CF"},"statisticAmount":{"type":"number","maximum":10000000000000,"minimum":-10000000000000,"description":"Statistic Amount defines the statistical amount that will be posted to the GL. This value is only populated on distribution lines created for calculation rules designated as affecting GL statistical quantity.","example":"0.000"},"isTotalAmount":{"type":"boolean","description":"Total Amount defines if the journal line contains the total of the other journal lines.","example":"true"},"distributionDescription":{"type":"string","maxLength":30,"description":"Distribution Code Description"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"}}}}}}}}},"subBillSegments":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"currentAmount":{"type":"number","description":"Current Amount"},"billSegmentStatus":{"type":"string","enum":["10  ","20  ","30  ","40  ","50  ","60  ","70  "],"description":"Bill Segment Status:\n* `10  ` - Incomplete,\n* `20  ` - Error,\n* `30  ` - Freezable,\n* `40  ` - Pending Cancel,\n* `50  ` - Frozen,\n* `60  ` - Canceled,\n* `70  ` - OK"}}}}}},"messages":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"billMessageCode":{"type":"string","maxLength":4,"description":"Bill Message"},"insert":{"type":"string","maxLength":8,"description":"Insert Code defines if the bill message causes an insert in the envelope."},"messagePriority":{"type":"string","enum":["10  ","20  ","30  ","40  ","50  ","60  ","70  ","80  ","90  "],"description":"Priority is the bill messages priority (on the printed bill).\n* `10  ` - Priority 10 -- Lowest,\n* `20  ` - Priority 20,\n* `30  ` - Priority 30,\n* `40  ` - Priority 40,\n* `50  ` - Priority 50,\n* `60  ` - Priority 60,\n* `70  ` - Priority 70,\n* `80  ` - Priority 80,\n* `90  ` - Priority 90 -- Highest","example":"20"},"messageOnBill":{"type":"string","maxLength":254,"description":"Message On Bill is the message associated with the code.","example":"Electric service not billed"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"}}}}}},"nextActions":{"type":"object","properties":{"_link":{"type":"string","description":"(_link)"},"_data":{"type":"array","items":{"type":"object","properties":{"_link":{"type":"string","description":"(_link)"},"actionName":{"type":"string","description":"(actionName)"}}}}}}},"xml":{"name":"C1-BillSegm"}},"UPDATEBILLSEGMENT_request":{"type":"object","properties":{"httpMethod":{"type":"string","enum":["DELT","GET ","POST","PTCH","PUT "],"description":"HTTP Method\n* `DELT` - Delete,\n* `GET ` - Get,\n* `POST` - Post,\n* `PTCH` - Patch,\n* `PUT ` - Put","example":"GET"},"billSegmentId":{"type":"string","maxLength":12,"description":"Bill Segment ID is the system-assigned unique identifier of the bill segment.","example":"211366855400"},"account":{"type":"object","properties":{"accountId":{"type":"string","maxLength":10,"description":"Account ID identifies the customer who is responsible for the bill.","example":"1112345900"}}},"currentAmount":{"type":"number","description":"Current Amount is the bill segment's effect on the service agreement's current balance.","example":"$405.52"},"payoffAmount":{"type":"number","maximum":9999999999999.99,"minimum":0,"description":"Payoff Amount is only shown if it differs from current amount.","example":"$33.20"},"bill":{"type":"object","properties":{"billId":{"type":"string","maxLength":12,"description":"Bill ID is the system-assigned unique identifier of the bill on which the bill segment appears. A concatenation of its bill date, status, due date and amount is displayed.","example":"211122345678"}}},"serviceAgreement":{"type":"object","description":"SA ID contains information about the bill segment's service agreement.","properties":{"serviceAgreementId":{"type":"string","maxLength":10,"description":"Service Agreement"}}},"periodStartDate":{"type":"string","format":"date","description":"Start Date"},"periodEndDate":{"type":"string","format":"date","description":"End Date"},"usageStartDateTime":{"type":"string","format":"date-time","description":"Usage start date is the first day for bill segment used by meter data management system.","example":"03-04-2013"},"usageEndDateTime":{"type":"string","format":"date-time","description":"Usage end date is the last date for bill segment used by meter data management system.","example":"03-04-2013"},"billSegmentPeriod":{"type":"string","maxLength":30,"description":"Bill Segment Period is the start and end dates of the bill segment.","example":"11-04-2013 12-03-2013"},"usagePeriod":{"type":"string","maxLength":1,"description":"Usage Period is the period used by the meter data management system to determine the correct interval data to process for the bill segment.","example":"11-04-2013 12-03-2013"},"billCycle":{"type":"object","description":"Bill Cycle displays the bill cycle and window start date of the bill segment's bill.","properties":{"billCycle":{"type":"string","maxLength":4,"description":"Bill Cycle displays the bill cycle and window start date of the bill segment's bill.","example":"M-D2 (Monthly bill cycle - day 2)"}}},"billStatus":{"type":"string","enum":["C   ","P   "],"description":"Bill Status is the bill's status.\n* `C   ` - Complete,\n* `P   ` - Pending","example":"C"},"isEstimate":{"type":"boolean","description":"If the Estimate switch is on, consumption on this bill segment has been estimated by the system.","example":"true"},"isClosingBillSegment":{"type":"boolean","description":"If the Closing switch is on, this is the final bill segment for the service agreement (i.e., the service agreement has been stopped and this is the final bill segment).","example":"true"},"hasServiceQuantityOverride":{"type":"boolean","description":"If the SQ Override switch is on, a user has overridden the service quantities (i.e., the amount of consumption for which the customer is charged is not consistent with the customer's meter reads).","example":"true"},"isItemOverride":{"type":"boolean","description":"If the Item Override switch is on, a user has overridden the type and/or number of items (i.e., the type/number of items for which the customer is charged is not consistent with the customer's service point information).","example":"true"},"premise":{"type":"object","properties":{"premiseId":{"type":"string","maxLength":10,"description":"Premise ID defines the address on bills for persons who have their bill sent to the account's mailing premise."}}},"creationDateTime":{"type":"string","format":"date-time","description":"Create Date/Time is the date and time on which the bill was originally created.","example":"2001-05-16"},"saRelationshipId":{"type":"string","maxLength":10,"description":"SA Relationship ID shows the unique identifier of the record that defines the relationship between the sub service agreement and the master service agreement (this record shows the service provider associated with the bill segment)."},"billSegmentStatus":{"type":"string","enum":["10  ","20  ","30  ","40  ","50  ","60  ","70  "],"description":"Bill Segment Status:\n* `10  ` - Incomplete,\n* `20  ` - Error,\n* `30  ` - Freezable,\n* `40  ` - Pending Cancel,\n* `50  ` - Frozen,\n* `60  ` - Canceled,\n* `70  ` - OK"},"billSegmentStatusDescription":{"type":"string","maxLength":150,"description":"Description for bill segment's status.","example":"Freezable"},"statusChangeDateTime":{"type":"string","format":"date-time","description":"Bill Segment's status change date/time","example":"06-05-2013 04:28PM"},"cancelReasonDescription":{"type":"string","maxLength":100,"description":"Cancel Reason Description defines the reason why the bill segment(s) are being canceled.","example":"Canceled prior to completion."},"quote":{"type":"object","properties":{"quoteId":{"type":"string","maxLength":12,"description":"Quote ID is the system-assigned unique identifier of the quote."}}},"cutOffDate":{"type":"string","format":"date","description":"Cutoff Date is the last day of the new bill segment.","example":"2021-10-05"},"accountingDate":{"type":"string","format":"date","description":"Accounting Date"},"cancelReason":{"type":"object","description":"Cancel Reason defines why the bill segment(s) are being canceled.","properties":{"cancelReason":{"type":"string","maxLength":4,"description":"Cancel Reason defines why the bill segment(s) are being canceled.","example":"Wrong read"}}},"areEstimatesAllowed":{"type":"boolean","description":"Check Allow Estimates if the system is allowed to estimate consumption if it can't find a meter read.","example":"false"},"hasBillingOption":{"type":"boolean","description":"If the service agreements use meter reads, use the Billing Option to control how the system retrieves meter reads that appear on the bill. \n\nSelect Use Schedule if the system should select reads based on the SA's SP's service cycle schedule. Select Use Cut off Date if the system should only select reads from the end date of the existing bill segment.","example":"true"},"canUseOldReadsItemsServiceQuantity":{"type":"boolean","description":"Check Use Old Read/Item/SQ if the system is configured to use the consumption details used on the original bill segments.","example":"false"},"creditDate":{"type":"string","format":"date","description":"Bill Date is the business date that was used when the bill was completed.","example":"06-05-2013"},"creditNote":{"type":"string","maxLength":12,"description":"The Credit Note is used to cancel selected bill segments and create a new bill that contains the cancellation details. We refer to this \"negative bill\" as a credit note."},"correctionNote":{"type":"string","maxLength":150,"description":"The Correction Note is used to cancel and rebill bill segments and create a new bill that contains the cancellation and rebill details."},"canShowAccountingDate":{"type":"boolean","description":"Accounting Date  is the date the system uses to determine the financial transaction's accounting period in your general ledger.","example":"06-05-2013"},"processDate":{"type":"string","format":"date","description":"Process Date"},"specialUsage":{"type":"string","enum":["PROP"],"description":"Special Usage flag shows if it's a proposal SA.\n* `PROP` - Proposal SA","example":"PROP"},"currency":{"type":"object","properties":{"currency":{"type":"string","maxLength":3,"description":"Currency Code"}}},"windowStartDate":{"type":"string","format":"date","description":"Window Start Date","example":"12-03-2013"},"cancelBillSegmentId":{"type":"string","maxLength":12,"description":"If the bill segment was canceled and rebilled by another segment, a reference to the new bill segment is displayed. Cancel Bill Segment ID refers to the new bill segment id that superseded the canceled segment.","example":"661660087111"},"masterBillSegmentId":{"type":"string","maxLength":12,"description":"Master Bseg ID shows the unique identifier of the master bill segment whose bill triggered the creation of this sub service agreement.","example":"661660087111"},"quoteDetailId":{"type":"string","maxLength":12,"description":"Quote Detail ID is the system-assigned unique identifier of the quote detail."},"billScenarioId":{"type":"string","maxLength":12,"description":"Billing Scenario ID allows you to go to the proposal SA's billing scenario where you can tinker with consumption and the bill segment period used to generate this bill segment."},"canCancel":{"type":"boolean","description":"The Cancel is used to cancel a Pending Cancel bill segment to become Canceled.","example":"true"},"canDelete":{"type":"boolean","description":"The Delete is used to delete one or more bill segments.","example":"false"},"canFreeze":{"type":"boolean","description":"The Freeze is used to freeze one or more bill segments."},"canGenerate":{"type":"boolean","description":"The Generate is used to delete and recreate one or more bill segments.","example":"false"},"canInitCancel":{"type":"boolean","description":"Initialize  Cancel causes the first step of the bill segment cancellation process to be executed. You'd click this button if a frozen bill segment should never have been created (i.e., you want to remove the financial impact of a bill segment from a customer's balance).\n\nThis button is enabled when you display a Frozen bill segment AND the bill segment's bill is not written off.","example":"false"},"shouldRebill":{"type":"boolean","description":"The Rebill causes an existing bill segment to be canceled, and a new bill segment to be created.","example":"true"},"canActionRegenerate":{"type":"boolean","description":"Regenerate action regenerated the bill segment after correcting the cause of the problem for errored bill segment.","example":"false"},"canUndo":{"type":"boolean","description":"Undo returns a Pending Cancel bill segment to the Frozen state.","example":"false"},"isCreditNote":{"type":"boolean","description":"Credit Note is used to cancel ALL bill segments and create a new bill that contains the cancellation details.","example":"false"},"isCorrectionNote":{"type":"boolean","description":"The Correction Note is used to cancel and rebill bill segments and create a new bill that contains the cancellation and rebill details.","example":"false"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"},"exception":{"type":"object","properties":{"messageCategory":{"type":"number","maximum":99999,"minimum":-99999,"description":"Message category within Oracle Utilities Application Framework.","example":"0"},"messageNumber":{"type":"number","maximum":99999,"minimum":-99999,"description":"Message number within Oracle Utilities Application Framework.","example":"0"},"expandedMessage":{"type":"string","maxLength":254,"description":"Expanded Message exception"}}},"readDetails":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"finalUnitOfMeasure":{"type":"string","maxLength":30,"description":"Final Unit of Measure is the final unit of measure of the calculation / audit read.","example":"CF"},"finalTimeOfUse":{"type":"string","maxLength":30,"description":"Final Time of Use is the final time-of-use code of the calculation / audit read.","example":"ON"},"finalServiceQuantityId":{"type":"string","maxLength":30,"description":"Final SQI is the final service quantity identifier of the calculation / audit read.","example":"DAMT"},"registerQuantity":{"type":"number","maximum":1000000000000,"minimum":-1000000000000,"description":"Quantity is the quantity of the calculation / audit read. This would typically contain the amount that was billed during the Start Date/Time through the End Date/Time for the Final Unit of Measure, Final Time of Use and Final SQI.","example":"200.000000"},"servicePointId":{"type":"string","maxLength":10,"description":"Service Point ID"},"meterConfigurationId":{"type":"string","maxLength":10,"description":"Meter Configuration ID"},"sequence":{"type":"number","maximum":99999,"minimum":-99999,"description":"Sequence"},"unitOfMeasure":{"type":"string","maxLength":30,"description":"Unit of Measure"},"timeOfUse":{"type":"string","maxLength":30,"description":"Time of Use"},"serviceQuantityIdentifier":{"type":"string","maxLength":30,"description":"SQI"},"startRegisterReading":{"type":"number","maximum":999999999.999999,"minimum":-999999999.999999,"description":"Start Register Reading is the start register reading.","example":"7201.000000"},"endRegisterReading":{"type":"number","maximum":999999999.999999,"minimum":-999999999.999999,"description":"End Register Reading is the end register reading.","example":"11578.000000"},"measuredQuantity":{"type":"number","maximum":1000000000000,"minimum":-1000000000000,"description":"Measured Quantity is the resulting measured quantity (if any). This value would typically only be displayed if the calculation / audit read is subtractive","example":"4377.000000"},"registerConstant":{"type":"number","maximum":999999.999999,"minimum":-999999.999999,"description":"Constant is the constant of the measuring device that was multiplied by the Measured Quantity to derive the calculation / audit read's Quantity.","example":"1.000000"},"howToUse":{"type":"string","enum":["+   ","-   ","C   ","P   "],"description":"How To Use is a code that indicates if the \"calculation / audit\" read was is considered to be additive, subtractive, peak or check.\n* `+   ` - Additive,\n* `-   ` - Subtractive,\n* `C   ` - Check,\n* `P   ` - Peak","example":"+"},"howToUseRead":{"type":"string","enum":["+   ","-   ","C   ","S   ","X   "],"description":"How To Use (SP) is the SA/SP's how to use code.\n* `+   ` - Add,\n* `-   ` - Subtract,\n* `C   ` - Check,\n* `S   ` - Service Quantity,\n* `X   ` - Calculation/Audit","example":"+"},"usePercent":{"type":"number","maximum":999,"minimum":-999,"description":"Use Percent is the percentage of the total consumption that was billed.","example":"100"},"measuresPeakQuantity":{"type":"boolean","description":"Measures Peak Qty"},"startReadDateTime":{"type":"string","format":"date-time","description":"Start Read Date/Time is the date and time of the start meter read.","example":"1998-06-30T00:00:00-04:00"},"endReadDateTime":{"type":"string","format":"date-time","description":"End Read Date/Time is the date and time of the end meter read.","example":"998-09-30T00:00:00-04:00"},"startRegisterReadId":{"type":"string","maxLength":12,"description":"Start Register Read ID is the unique identifier of the start register read.","example":"444074862768"},"endRegisterReadingId":{"type":"string","maxLength":12,"description":"End Register Read ID is the unique identifier of the end register read.","example":"444074849655"},"startRegisterReadTypeDescription":{"type":"string","maxLength":150,"description":"Start Register Read Type Description"},"endRegisterReadTypeDescription":{"type":"string","maxLength":150,"description":"End Register Read Type Description"},"multiplier":{"type":"number","maximum":1000000000000,"minimum":-1000000000000,"description":"Multiplier is the composite multiplier that converts the measured quantity to the registered quantity.","example":"1.000000"},"consumptionType":{"type":"string","enum":["C   ","S   "],"description":"Consumptive/Subtractive flag shows if the register is consumptive or subtractive.\n* `C   ` - Consumptive,\n* `S   ` - Subtractive","example":"S"},"notAvailableConsumptionDescription":{"type":"string","maxLength":150,"description":"Not Available Consumption Description"},"startMeterRead":{"type":"string","maxLength":12,"description":"Start meter read ID","example":"444074813104"},"endMeterRead":{"type":"string","maxLength":12,"description":"End meter read ID","example":"44074866808"},"meterReadId":{"type":"string","maxLength":12,"description":"Meter Read ID","example":"8833057699"},"unitOfMeasure2":{"type":"string","maxLength":30,"description":"Unit of Measure  is the description for unit of measure of the service quantity.","example":"Cubic feet of water"},"serviceQuantityIdentifier2":{"type":"string","maxLength":30,"description":"SQI is the service quantity identifier description of the service quantity.","example":"Daily Amount"},"timeOfUse2":{"type":"string","maxLength":30,"description":"Time of Use is the register's time-of-use description.","example":"off-peak"},"finalUomDescription":{"type":"string","maxLength":150,"description":"Final Uom Description"},"finalSqiDescription":{"type":"string","maxLength":150,"description":"Final SQI Description"},"finalTouDescription":{"type":"string","maxLength":150,"description":"Final TOU Description"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"}}}}}},"items":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"sequence":{"type":"number","maximum":99999,"minimum":-99999,"description":"Sequence"},"itemType":{"type":"string","maxLength":30,"description":"Item Type is the type of item.","example":"Generic Current Transformer"},"item":{"type":"object","properties":{"itemId":{"type":"string","maxLength":10,"description":"Item ID"}}},"startDate":{"type":"string","format":"date","description":"Start Date"},"endDate":{"type":"string","format":"date","description":"End Date"},"itemCount":{"type":"number","maximum":999999999.99,"minimum":-999999999.99,"description":"Item Count is the number of items of this type that were linked to the service agreement's service points during the bill segment's bill period.","example":"1.00"},"unitOfMeasure":{"type":"string","maxLength":30,"description":"Unit of Measure"},"dailyServiceQuantity":{"type":"number","maximum":1000000000000,"minimum":-1000000000000,"description":"Daily Service Quantity is the item's estimated amount of daily consumption.","example":"470.762600"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"}}}}}},"serviceQuantities":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"unitOfMeasure":{"type":"string","maxLength":30,"description":"Unit of Measure"},"timeOfUse":{"type":"string","maxLength":30,"description":"Time of Use"},"serviceQuantityIdentifier":{"type":"string","maxLength":30,"description":"SQI"},"initialServiceQuantity":{"type":"number","maximum":1000000000000,"minimum":-1000000000000,"description":"Initial Service Quantity is the initial quantity amassed by the system before application of the rate's pre-processing calculation group(s), if any exists.","example":"470.762600"},"billableServiceQuantity":{"type":"number","maximum":1000000000000,"minimum":-1000000000000,"description":"Billable Service Quantity"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"}}}}}},"calcLines":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"headerSequence":{"type":"number","maximum":999,"minimum":-999,"description":"Header Sequence"},"startDate":{"type":"string","format":"date","description":"Start Date"},"endDate":{"type":"string","format":"date","description":"End Date"},"currency":{"type":"string","maxLength":3,"description":"Currency Code"},"calculatedAmount":{"type":"number","description":"Calculated Amount"},"rateSchedule":{"type":"string","maxLength":8,"description":"Rate Schedule"},"effectiveDate":{"type":"string","format":"date","description":"Effective Date"},"billableCharge":{"type":"object","properties":{"billableChargeId":{"type":"string","maxLength":12,"description":"Billable Charge ID"}}},"descriptionOnBill":{"type":"string","maxLength":254,"description":"Description on Bill"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"},"calculationLines":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"headerSequence":{"type":"number","maximum":999,"minimum":-999,"description":"Header Sequence"},"sequence":{"type":"number","maximum":99999,"minimum":-99999,"description":"Sequence"},"characteristicType":{"type":"object","properties":{"characteristicType":{"type":"string","maxLength":8,"description":"Characteristic Type"}}},"currency":{"type":"string","maxLength":3,"description":"Currency Code"},"characteristicValue":{"type":"string","maxLength":16,"description":"Characteristic Value"},"distributionCode":{"type":"object","properties":{"distributionCode":{"type":"string","maxLength":10,"description":"Distribution Code"}}},"unitOfMeasure":{"type":"string","maxLength":30,"description":"Unit of Measure"},"timeOfUse":{"type":"string","maxLength":30,"description":"Time of Use"},"rcSequence":{"type":"number","maximum":9999,"minimum":-9999,"description":"Rate Component Sequence refers to the sequence number of the rate component on the applicable rate version calculation group that was used to calculate the line. This is only populated if the original rate engine calculated the charges.","example":"10"},"shouldPrint":{"type":"boolean","description":"The Print switch controls whether information about this line will print on the customer's bill.","example":"true"},"shouldAppearInSummary":{"type":"boolean","description":"The Appears in Summary switch defines if this line's amount also appears on a summary line.","example":"true"},"calculatedAmount":{"type":"number","description":"Calculated Amount"},"exemptAmount":{"type":"number","description":"Exempt Amount is the amount of the calculated charge that the customer doesn't have to pay because they are tax exempt.","example":"$0.00"},"baseAmount":{"type":"number","description":"Base Amount is used by calculation lines (e.g. taxes) that are cross-referenced to other calculation lines and whose value(s), therefore, depend on the amounts calculated by those other lines. The Base Amount shows the total amount derived from the cross-referenced line(s) that the current line then used to calculate its billed amount.","example":"$102.71"},"serviceQuantityIdentifier":{"type":"string","maxLength":30,"description":"SQI"},"billableServiceQuantity":{"type":"number","maximum":1000000000000,"minimum":-1000000000000,"description":"Billable Service Quantity"},"measuresPeakQuantity":{"type":"boolean","description":"Measures Peak Qty"},"descriptionOnBill":{"type":"string","maxLength":254,"description":"Description on Bill"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"},"distributionDescription":{"type":"string","maxLength":30,"description":"Distribution Code Description"},"isCharacteristicExist":{"type":"boolean","description":"Characteristic exists","example":"false"}}}}}}}}}}},"financialDetails":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"financialTransactionId":{"type":"string","maxLength":12,"description":"FT ID is the system-assigned unique identifier of the financial transaction (FT).","example":"211166656266"},"financialTransactionType":{"type":"string","enum":["AD  ","AX  ","BS  ","BX  ","PS  ","PX  "],"description":"Financial Transaction Type:\n\n    AD - Adjustment,\n    AX - Adjustment Cancellation,\n    BS - Bill Segment,\n    BX - Bill Segment Cancellation,\n    PS - Pay Segment,\n    PX - Pay Segment Cancellation\n* `AD  ` - Adjustment,\n* `AX  ` - Adjustment Cancellation,\n* `BS  ` - Bill Segment,\n* `BX  ` - Bill Segment Cancellation,\n* `PS  ` - Pay Segment,\n* `PX  ` - Pay Segment Cancellation","example":"BS"},"financialTransactionTypeDescription":{"type":"string","maxLength":150,"description":"FT Type Description"},"currentAmount":{"type":"number","description":"Current Amount"},"accountingDate":{"type":"string","format":"date","description":"Accounting Date"},"arrearsDate":{"type":"string","format":"date","description":"Arrears Date is the date the FT starts aging.","example":"03-04-2013"},"shouldShowOnBill":{"type":"boolean","description":"Show on bill indicates if information about the FT appears on the customer's bill.","example":"true"},"_data":{"type":"array","items":{"type":"object","properties":{"sequence":{"type":"number","maximum":999,"minimum":-999,"description":"Sequence"},"distributionCode":{"type":"string","maxLength":10,"description":"Distribution Code"},"characteristicType":{"type":"string","maxLength":8,"description":"Characteristic Type"},"characteristicValue":{"type":"string","maxLength":16,"description":"Characteristic Value"},"amount":{"type":"number","description":"Amount defines the journal line's amount.","example":"$33.00"},"statistics":{"type":"string","maxLength":8,"description":"Statistics Code is only specified when a statistical quantity is associated with the distribution line.","example":"CF"},"statisticAmount":{"type":"number","maximum":10000000000000,"minimum":-10000000000000,"description":"Statistic Amount defines the statistical amount that will be posted to the GL. This value is only populated on distribution lines created for calculation rules designated as affecting GL statistical quantity.","example":"0.000"},"isTotalAmount":{"type":"boolean","description":"Total Amount defines if the journal line contains the total of the other journal lines.","example":"true"},"distributionDescription":{"type":"string","maxLength":30,"description":"Distribution Code Description"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"}}}}}}}}},"subBillSegments":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"currentAmount":{"type":"number","description":"Current Amount"},"billSegmentStatus":{"type":"string","enum":["10  ","20  ","30  ","40  ","50  ","60  ","70  "],"description":"Bill Segment Status:\n* `10  ` - Incomplete,\n* `20  ` - Error,\n* `30  ` - Freezable,\n* `40  ` - Pending Cancel,\n* `50  ` - Frozen,\n* `60  ` - Canceled,\n* `70  ` - OK"}}}}}},"messages":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"billMessageCode":{"type":"string","maxLength":4,"description":"Bill Message"},"insert":{"type":"string","maxLength":8,"description":"Insert Code defines if the bill message causes an insert in the envelope."},"messagePriority":{"type":"string","enum":["10  ","20  ","30  ","40  ","50  ","60  ","70  ","80  ","90  "],"description":"Priority is the bill messages priority (on the printed bill).\n* `10  ` - Priority 10 -- Lowest,\n* `20  ` - Priority 20,\n* `30  ` - Priority 30,\n* `40  ` - Priority 40,\n* `50  ` - Priority 50,\n* `60  ` - Priority 60,\n* `70  ` - Priority 70,\n* `80  ` - Priority 80,\n* `90  ` - Priority 90 -- Highest","example":"20"},"messageOnBill":{"type":"string","maxLength":254,"description":"Message On Bill is the message associated with the code.","example":"Electric service not billed"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"}}}}}},"nextActions":{"type":"object","properties":{"_link":{"type":"string","description":"(_link)"},"_data":{"type":"array","items":{"type":"object","properties":{"_link":{"type":"string","description":"(_link)"},"actionName":{"type":"string","description":"(actionName)"}}}}}}},"xml":{"name":"C1-BillSegm"}},"DELETEBILLSEGMENT_request":{"type":"object","properties":{"billSegmentId":{"type":"string","maxLength":12,"description":"Bill Segment ID is the system-assigned unique identifier of the bill segment.","example":"211366855400"}},"xml":{"name":"C1DelBillseg"}},"ACTIONBILLSEGMENT_response":{"type":"object","properties":{"billSegmentId":{"type":"string","maxLength":12,"description":"Bill Segment ID is the system-assigned unique identifier of the bill segment.","example":"211366855400"},"name":{"type":"string","description":"(name)"},"_self":{"type":"string","description":"(_self)"},"cancelReason":{"type":"string","maxLength":4,"description":"Cancel Reason defines why the bill segment(s) are being canceled.","example":"Wrong read"},"cancelReasonDescription":{"type":"string","description":"(cancelReasonDescription)"},"cutOffDate":{"type":"string","format":"date","description":"Cutoff Date is the last day of the new bill segment.","example":"2021-10-05"},"accountingDate":{"type":"string","format":"date","description":"Accounting Date"},"areEstimatesAllowed":{"type":"boolean","description":"Check Allow Estimates if the system is allowed to estimate consumption if it can't find a meter read.","example":"false"},"hasBillingOption":{"type":"boolean","description":"If the service agreements use meter reads, use the Billing Option to control how the system retrieves meter reads that appear on the bill. \n\nSelect Use Schedule if the system should select reads based on the SA's SP's service cycle schedule. Select Use Cut off Date if the system should only select reads from the end date of the existing bill segment.","example":"true"},"canUseOldReadsItemsServiceQuantity":{"type":"boolean","description":"Check Use Old Read/Item/SQ if the system is configured to use the consumption details used on the original bill segments.","example":"false"},"creditDate":{"type":"string","format":"date","description":"Bill Date is the business date that was used when the bill was completed.","example":"06-05-2013"},"nextActions":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"actionName":{"type":"string","description":"(actionName)"},"_link":{"type":"string","description":"(_link)"}}}}}}},"xml":{"name":"C1-ActionBSe"}},"GETBILLSEGMENT_response":{"type":"object","properties":{"_self":{"type":"string","description":"_self"},"httpMethod":{"type":"string","enum":["DELT","GET ","POST","PTCH","PUT "],"description":"HTTP Method\n* `DELT` - Delete,\n* `GET ` - Get,\n* `POST` - Post,\n* `PTCH` - Patch,\n* `PUT ` - Put","example":"GET"},"billSegmentId":{"type":"string","maxLength":12,"description":"Bill Segment ID is the system-assigned unique identifier of the bill segment.","example":"211366855400"},"account":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"accountId":{"type":"string","maxLength":10,"description":"Account ID identifies the customer who is responsible for the bill.","example":"1112345900"}}},"currentAmount":{"type":"number","description":"Current Amount is the bill segment's effect on the service agreement's current balance.","example":"$405.52"},"payoffAmount":{"type":"number","maximum":9999999999999.99,"minimum":0,"description":"Payoff Amount is only shown if it differs from current amount.","example":"$33.20"},"bill":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"billId":{"type":"string","maxLength":12,"description":"Bill ID is the system-assigned unique identifier of the bill on which the bill segment appears. A concatenation of its bill date, status, due date and amount is displayed.","example":"211122345678"}}},"serviceAgreement":{"type":"object","description":"SA ID contains information about the bill segment's service agreement.","properties":{"_link":{"type":"string","description":"_link"},"serviceAgreementId":{"type":"string","maxLength":10,"description":"Service Agreement"}}},"periodStartDate":{"type":"string","format":"date","description":"Start Date"},"periodEndDate":{"type":"string","format":"date","description":"End Date"},"usageStartDateTime":{"type":"string","format":"date-time","description":"Usage start date is the first day for bill segment used by meter data management system.","example":"03-04-2013"},"usageEndDateTime":{"type":"string","format":"date-time","description":"Usage end date is the last date for bill segment used by meter data management system.","example":"03-04-2013"},"billSegmentPeriod":{"type":"string","maxLength":30,"description":"Bill Segment Period is the start and end dates of the bill segment.","example":"11-04-2013 12-03-2013"},"usagePeriod":{"type":"string","maxLength":1,"description":"Usage Period is the period used by the meter data management system to determine the correct interval data to process for the bill segment.","example":"11-04-2013 12-03-2013"},"billCycle":{"type":"object","description":"Bill Cycle displays the bill cycle and window start date of the bill segment's bill.","properties":{"_link":{"type":"string","description":"_link"},"billCycle":{"type":"string","maxLength":4,"description":"Bill Cycle displays the bill cycle and window start date of the bill segment's bill.","example":"M-D2 (Monthly bill cycle - day 2)"}}},"billStatus":{"type":"string","enum":["C   ","P   "],"description":"Bill Status is the bill's status.\n* `C   ` - Complete,\n* `P   ` - Pending","example":"C"},"isEstimate":{"type":"boolean","description":"If the Estimate switch is on, consumption on this bill segment has been estimated by the system.","example":"true"},"isClosingBillSegment":{"type":"boolean","description":"If the Closing switch is on, this is the final bill segment for the service agreement (i.e., the service agreement has been stopped and this is the final bill segment).","example":"true"},"hasServiceQuantityOverride":{"type":"boolean","description":"If the SQ Override switch is on, a user has overridden the service quantities (i.e., the amount of consumption for which the customer is charged is not consistent with the customer's meter reads).","example":"true"},"isItemOverride":{"type":"boolean","description":"If the Item Override switch is on, a user has overridden the type and/or number of items (i.e., the type/number of items for which the customer is charged is not consistent with the customer's service point information).","example":"true"},"premise":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"premiseId":{"type":"string","maxLength":10,"description":"Premise ID defines the address on bills for persons who have their bill sent to the account's mailing premise."}}},"creationDateTime":{"type":"string","format":"date-time","description":"Create Date/Time is the date and time on which the bill was originally created.","example":"2001-05-16"},"saRelationshipId":{"type":"string","maxLength":10,"description":"SA Relationship ID shows the unique identifier of the record that defines the relationship between the sub service agreement and the master service agreement (this record shows the service provider associated with the bill segment)."},"billSegmentStatus":{"type":"string","enum":["10  ","20  ","30  ","40  ","50  ","60  ","70  "],"description":"Bill Segment Status:\n* `10  ` - Incomplete,\n* `20  ` - Error,\n* `30  ` - Freezable,\n* `40  ` - Pending Cancel,\n* `50  ` - Frozen,\n* `60  ` - Canceled,\n* `70  ` - OK"},"billSegmentStatusDescription":{"type":"string","maxLength":150,"description":"Description for bill segment's status.","example":"Freezable"},"statusChangeDateTime":{"type":"string","format":"date-time","description":"Bill Segment's status change date/time","example":"06-05-2013 04:28PM"},"cancelReasonDescription":{"type":"string","maxLength":100,"description":"Cancel Reason Description defines the reason why the bill segment(s) are being canceled.","example":"Canceled prior to completion."},"quote":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"quoteId":{"type":"string","maxLength":12,"description":"Quote ID is the system-assigned unique identifier of the quote."}}},"cutOffDate":{"type":"string","format":"date","description":"Cutoff Date is the last day of the new bill segment.","example":"2021-10-05"},"accountingDate":{"type":"string","format":"date","description":"Accounting Date"},"cancelReason":{"type":"object","description":"Cancel Reason defines why the bill segment(s) are being canceled.","properties":{"_link":{"type":"string","description":"_link"},"cancelReason":{"type":"string","maxLength":4,"description":"Cancel Reason defines why the bill segment(s) are being canceled.","example":"Wrong read"}}},"areEstimatesAllowed":{"type":"boolean","description":"Check Allow Estimates if the system is allowed to estimate consumption if it can't find a meter read.","example":"false"},"hasBillingOption":{"type":"boolean","description":"If the service agreements use meter reads, use the Billing Option to control how the system retrieves meter reads that appear on the bill. \n\nSelect Use Schedule if the system should select reads based on the SA's SP's service cycle schedule. Select Use Cut off Date if the system should only select reads from the end date of the existing bill segment.","example":"true"},"canUseOldReadsItemsServiceQuantity":{"type":"boolean","description":"Check Use Old Read/Item/SQ if the system is configured to use the consumption details used on the original bill segments.","example":"false"},"creditDate":{"type":"string","format":"date","description":"Bill Date is the business date that was used when the bill was completed.","example":"06-05-2013"},"creditNote":{"type":"string","maxLength":12,"description":"The Credit Note is used to cancel selected bill segments and create a new bill that contains the cancellation details. We refer to this \"negative bill\" as a credit note."},"correctionNote":{"type":"string","maxLength":150,"description":"The Correction Note is used to cancel and rebill bill segments and create a new bill that contains the cancellation and rebill details."},"canShowAccountingDate":{"type":"boolean","description":"Accounting Date  is the date the system uses to determine the financial transaction's accounting period in your general ledger.","example":"06-05-2013"},"processDate":{"type":"string","format":"date","description":"Process Date"},"specialUsage":{"type":"string","enum":["PROP"],"description":"Special Usage flag shows if it's a proposal SA.\n* `PROP` - Proposal SA","example":"PROP"},"currency":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"currency":{"type":"string","maxLength":3,"description":"Currency Code"}}},"windowStartDate":{"type":"string","format":"date","description":"Window Start Date","example":"12-03-2013"},"cancelBillSegmentId":{"type":"string","maxLength":12,"description":"If the bill segment was canceled and rebilled by another segment, a reference to the new bill segment is displayed. Cancel Bill Segment ID refers to the new bill segment id that superseded the canceled segment.","example":"661660087111"},"masterBillSegmentId":{"type":"string","maxLength":12,"description":"Master Bseg ID shows the unique identifier of the master bill segment whose bill triggered the creation of this sub service agreement.","example":"661660087111"},"quoteDetailId":{"type":"string","maxLength":12,"description":"Quote Detail ID is the system-assigned unique identifier of the quote detail."},"billScenarioId":{"type":"string","maxLength":12,"description":"Billing Scenario ID allows you to go to the proposal SA's billing scenario where you can tinker with consumption and the bill segment period used to generate this bill segment."},"canCancel":{"type":"boolean","description":"The Cancel is used to cancel a Pending Cancel bill segment to become Canceled.","example":"true"},"canDelete":{"type":"boolean","description":"The Delete is used to delete one or more bill segments.","example":"false"},"canFreeze":{"type":"boolean","description":"The Freeze is used to freeze one or more bill segments."},"canGenerate":{"type":"boolean","description":"The Generate is used to delete and recreate one or more bill segments.","example":"false"},"canInitCancel":{"type":"boolean","description":"Initialize  Cancel causes the first step of the bill segment cancellation process to be executed. You'd click this button if a frozen bill segment should never have been created (i.e., you want to remove the financial impact of a bill segment from a customer's balance).\n\nThis button is enabled when you display a Frozen bill segment AND the bill segment's bill is not written off.","example":"false"},"shouldRebill":{"type":"boolean","description":"The Rebill causes an existing bill segment to be canceled, and a new bill segment to be created.","example":"true"},"canActionRegenerate":{"type":"boolean","description":"Regenerate action regenerated the bill segment after correcting the cause of the problem for errored bill segment.","example":"false"},"canUndo":{"type":"boolean","description":"Undo returns a Pending Cancel bill segment to the Frozen state.","example":"false"},"isCreditNote":{"type":"boolean","description":"Credit Note is used to cancel ALL bill segments and create a new bill that contains the cancellation details.","example":"false"},"isCorrectionNote":{"type":"boolean","description":"The Correction Note is used to cancel and rebill bill segments and create a new bill that contains the cancellation and rebill details.","example":"false"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"},"exception":{"type":"object","properties":{"messageCategory":{"type":"number","maximum":99999,"minimum":-99999,"description":"Message category within Oracle Utilities Application Framework.","example":"0"},"messageNumber":{"type":"number","maximum":99999,"minimum":-99999,"description":"Message number within Oracle Utilities Application Framework.","example":"0"},"expandedMessage":{"type":"string","maxLength":254,"description":"Expanded Message exception"}}},"readDetails":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"finalUnitOfMeasure":{"type":"string","maxLength":30,"description":"Final Unit of Measure is the final unit of measure of the calculation / audit read.","example":"CF"},"finalTimeOfUse":{"type":"string","maxLength":30,"description":"Final Time of Use is the final time-of-use code of the calculation / audit read.","example":"ON"},"finalServiceQuantityId":{"type":"string","maxLength":30,"description":"Final SQI is the final service quantity identifier of the calculation / audit read.","example":"DAMT"},"registerQuantity":{"type":"number","maximum":1000000000000,"minimum":-1000000000000,"description":"Quantity is the quantity of the calculation / audit read. This would typically contain the amount that was billed during the Start Date/Time through the End Date/Time for the Final Unit of Measure, Final Time of Use and Final SQI.","example":"200.000000"},"servicePointId":{"type":"string","maxLength":10,"description":"Service Point ID"},"meterConfigurationId":{"type":"string","maxLength":10,"description":"Meter Configuration ID"},"sequence":{"type":"number","maximum":99999,"minimum":-99999,"description":"Sequence"},"unitOfMeasure":{"type":"string","maxLength":30,"description":"Unit of Measure"},"timeOfUse":{"type":"string","maxLength":30,"description":"Time of Use"},"serviceQuantityIdentifier":{"type":"string","maxLength":30,"description":"SQI"},"startRegisterReading":{"type":"number","maximum":999999999.999999,"minimum":-999999999.999999,"description":"Start Register Reading is the start register reading.","example":"7201.000000"},"endRegisterReading":{"type":"number","maximum":999999999.999999,"minimum":-999999999.999999,"description":"End Register Reading is the end register reading.","example":"11578.000000"},"measuredQuantity":{"type":"number","maximum":1000000000000,"minimum":-1000000000000,"description":"Measured Quantity is the resulting measured quantity (if any). This value would typically only be displayed if the calculation / audit read is subtractive","example":"4377.000000"},"registerConstant":{"type":"number","maximum":999999.999999,"minimum":-999999.999999,"description":"Constant is the constant of the measuring device that was multiplied by the Measured Quantity to derive the calculation / audit read's Quantity.","example":"1.000000"},"howToUse":{"type":"string","enum":["+   ","-   ","C   ","P   "],"description":"How To Use is a code that indicates if the \"calculation / audit\" read was is considered to be additive, subtractive, peak or check.\n* `+   ` - Additive,\n* `-   ` - Subtractive,\n* `C   ` - Check,\n* `P   ` - Peak","example":"+"},"howToUseRead":{"type":"string","enum":["+   ","-   ","C   ","S   ","X   "],"description":"How To Use (SP) is the SA/SP's how to use code.\n* `+   ` - Add,\n* `-   ` - Subtract,\n* `C   ` - Check,\n* `S   ` - Service Quantity,\n* `X   ` - Calculation/Audit","example":"+"},"usePercent":{"type":"number","maximum":999,"minimum":-999,"description":"Use Percent is the percentage of the total consumption that was billed.","example":"100"},"measuresPeakQuantity":{"type":"boolean","description":"Measures Peak Qty"},"startReadDateTime":{"type":"string","format":"date-time","description":"Start Read Date/Time is the date and time of the start meter read.","example":"1998-06-30T00:00:00-04:00"},"endReadDateTime":{"type":"string","format":"date-time","description":"End Read Date/Time is the date and time of the end meter read.","example":"998-09-30T00:00:00-04:00"},"startRegisterReadId":{"type":"string","maxLength":12,"description":"Start Register Read ID is the unique identifier of the start register read.","example":"444074862768"},"endRegisterReadingId":{"type":"string","maxLength":12,"description":"End Register Read ID is the unique identifier of the end register read.","example":"444074849655"},"startRegisterReadTypeDescription":{"type":"string","maxLength":150,"description":"Start Register Read Type Description"},"endRegisterReadTypeDescription":{"type":"string","maxLength":150,"description":"End Register Read Type Description"},"multiplier":{"type":"number","maximum":1000000000000,"minimum":-1000000000000,"description":"Multiplier is the composite multiplier that converts the measured quantity to the registered quantity.","example":"1.000000"},"consumptionType":{"type":"string","enum":["C   ","S   "],"description":"Consumptive/Subtractive flag shows if the register is consumptive or subtractive.\n* `C   ` - Consumptive,\n* `S   ` - Subtractive","example":"S"},"notAvailableConsumptionDescription":{"type":"string","maxLength":150,"description":"Not Available Consumption Description"},"startMeterRead":{"type":"string","maxLength":12,"description":"Start meter read ID","example":"444074813104"},"endMeterRead":{"type":"string","maxLength":12,"description":"End meter read ID","example":"44074866808"},"meterReadId":{"type":"string","maxLength":12,"description":"Meter Read ID","example":"8833057699"},"unitOfMeasure2":{"type":"string","maxLength":30,"description":"Unit of Measure  is the description for unit of measure of the service quantity.","example":"Cubic feet of water"},"serviceQuantityIdentifier2":{"type":"string","maxLength":30,"description":"SQI is the service quantity identifier description of the service quantity.","example":"Daily Amount"},"timeOfUse2":{"type":"string","maxLength":30,"description":"Time of Use is the register's time-of-use description.","example":"off-peak"},"finalUomDescription":{"type":"string","maxLength":150,"description":"Final Uom Description"},"finalSqiDescription":{"type":"string","maxLength":150,"description":"Final SQI Description"},"finalTouDescription":{"type":"string","maxLength":150,"description":"Final TOU Description"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"}}}}}},"items":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"sequence":{"type":"number","maximum":99999,"minimum":-99999,"description":"Sequence"},"itemType":{"type":"string","maxLength":30,"description":"Item Type is the type of item.","example":"Generic Current Transformer"},"item":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"itemId":{"type":"string","maxLength":10,"description":"Item ID"}}},"startDate":{"type":"string","format":"date","description":"Start Date"},"endDate":{"type":"string","format":"date","description":"End Date"},"itemCount":{"type":"number","maximum":999999999.99,"minimum":-999999999.99,"description":"Item Count is the number of items of this type that were linked to the service agreement's service points during the bill segment's bill period.","example":"1.00"},"unitOfMeasure":{"type":"string","maxLength":30,"description":"Unit of Measure"},"dailyServiceQuantity":{"type":"number","maximum":1000000000000,"minimum":-1000000000000,"description":"Daily Service Quantity is the item's estimated amount of daily consumption.","example":"470.762600"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"}}}}}},"serviceQuantities":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"unitOfMeasure":{"type":"string","maxLength":30,"description":"Unit of Measure"},"timeOfUse":{"type":"string","maxLength":30,"description":"Time of Use"},"serviceQuantityIdentifier":{"type":"string","maxLength":30,"description":"SQI"},"initialServiceQuantity":{"type":"number","maximum":1000000000000,"minimum":-1000000000000,"description":"Initial Service Quantity is the initial quantity amassed by the system before application of the rate's pre-processing calculation group(s), if any exists.","example":"470.762600"},"billableServiceQuantity":{"type":"number","maximum":1000000000000,"minimum":-1000000000000,"description":"Billable Service Quantity"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"}}}}}},"calcLines":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"headerSequence":{"type":"number","maximum":999,"minimum":-999,"description":"Header Sequence"},"startDate":{"type":"string","format":"date","description":"Start Date"},"endDate":{"type":"string","format":"date","description":"End Date"},"currency":{"type":"string","maxLength":3,"description":"Currency Code"},"calculatedAmount":{"type":"number","description":"Calculated Amount"},"rateSchedule":{"type":"string","maxLength":8,"description":"Rate Schedule"},"effectiveDate":{"type":"string","format":"date","description":"Effective Date"},"billableCharge":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"billableChargeId":{"type":"string","maxLength":12,"description":"Billable Charge ID"}}},"descriptionOnBill":{"type":"string","maxLength":254,"description":"Description on Bill"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"},"calculationLines":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"headerSequence":{"type":"number","maximum":999,"minimum":-999,"description":"Header Sequence"},"sequence":{"type":"number","maximum":99999,"minimum":-99999,"description":"Sequence"},"characteristicType":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"characteristicType":{"type":"string","maxLength":8,"description":"Characteristic Type"}}},"currency":{"type":"string","maxLength":3,"description":"Currency Code"},"characteristicValue":{"type":"string","maxLength":16,"description":"Characteristic Value"},"distributionCode":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"distributionCode":{"type":"string","maxLength":10,"description":"Distribution Code"}}},"unitOfMeasure":{"type":"string","maxLength":30,"description":"Unit of Measure"},"timeOfUse":{"type":"string","maxLength":30,"description":"Time of Use"},"rcSequence":{"type":"number","maximum":9999,"minimum":-9999,"description":"Rate Component Sequence refers to the sequence number of the rate component on the applicable rate version calculation group that was used to calculate the line. This is only populated if the original rate engine calculated the charges.","example":"10"},"shouldPrint":{"type":"boolean","description":"The Print switch controls whether information about this line will print on the customer's bill.","example":"true"},"shouldAppearInSummary":{"type":"boolean","description":"The Appears in Summary switch defines if this line's amount also appears on a summary line.","example":"true"},"calculatedAmount":{"type":"number","description":"Calculated Amount"},"exemptAmount":{"type":"number","description":"Exempt Amount is the amount of the calculated charge that the customer doesn't have to pay because they are tax exempt.","example":"$0.00"},"baseAmount":{"type":"number","description":"Base Amount is used by calculation lines (e.g. taxes) that are cross-referenced to other calculation lines and whose value(s), therefore, depend on the amounts calculated by those other lines. The Base Amount shows the total amount derived from the cross-referenced line(s) that the current line then used to calculate its billed amount.","example":"$102.71"},"serviceQuantityIdentifier":{"type":"string","maxLength":30,"description":"SQI"},"billableServiceQuantity":{"type":"number","maximum":1000000000000,"minimum":-1000000000000,"description":"Billable Service Quantity"},"measuresPeakQuantity":{"type":"boolean","description":"Measures Peak Qty"},"descriptionOnBill":{"type":"string","maxLength":254,"description":"Description on Bill"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"},"distributionDescription":{"type":"string","maxLength":30,"description":"Distribution Code Description"},"isCharacteristicExist":{"type":"boolean","description":"Characteristic exists","example":"false"}}}}}}}}}}},"financialDetails":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"financialTransactionId":{"type":"string","maxLength":12,"description":"FT ID is the system-assigned unique identifier of the financial transaction (FT).","example":"211166656266"},"financialTransactionType":{"type":"string","enum":["AD  ","AX  ","BS  ","BX  ","PS  ","PX  "],"description":"Financial Transaction Type:\n\n    AD - Adjustment,\n    AX - Adjustment Cancellation,\n    BS - Bill Segment,\n    BX - Bill Segment Cancellation,\n    PS - Pay Segment,\n    PX - Pay Segment Cancellation\n* `AD  ` - Adjustment,\n* `AX  ` - Adjustment Cancellation,\n* `BS  ` - Bill Segment,\n* `BX  ` - Bill Segment Cancellation,\n* `PS  ` - Pay Segment,\n* `PX  ` - Pay Segment Cancellation","example":"BS"},"financialTransactionTypeDescription":{"type":"string","maxLength":150,"description":"FT Type Description"},"currentAmount":{"type":"number","description":"Current Amount"},"accountingDate":{"type":"string","format":"date","description":"Accounting Date"},"arrearsDate":{"type":"string","format":"date","description":"Arrears Date is the date the FT starts aging.","example":"03-04-2013"},"shouldShowOnBill":{"type":"boolean","description":"Show on bill indicates if information about the FT appears on the customer's bill.","example":"true"},"_data":{"type":"array","items":{"type":"object","properties":{"sequence":{"type":"number","maximum":999,"minimum":-999,"description":"Sequence"},"distributionCode":{"type":"string","maxLength":10,"description":"Distribution Code"},"characteristicType":{"type":"string","maxLength":8,"description":"Characteristic Type"},"characteristicValue":{"type":"string","maxLength":16,"description":"Characteristic Value"},"amount":{"type":"number","description":"Amount defines the journal line's amount.","example":"$33.00"},"statistics":{"type":"string","maxLength":8,"description":"Statistics Code is only specified when a statistical quantity is associated with the distribution line.","example":"CF"},"statisticAmount":{"type":"number","maximum":10000000000000,"minimum":-10000000000000,"description":"Statistic Amount defines the statistical amount that will be posted to the GL. This value is only populated on distribution lines created for calculation rules designated as affecting GL statistical quantity.","example":"0.000"},"isTotalAmount":{"type":"boolean","description":"Total Amount defines if the journal line contains the total of the other journal lines.","example":"true"},"distributionDescription":{"type":"string","maxLength":30,"description":"Distribution Code Description"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"}}}}}}}}},"subBillSegments":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"currentAmount":{"type":"number","description":"Current Amount"},"billSegmentStatus":{"type":"string","enum":["10  ","20  ","30  ","40  ","50  ","60  ","70  "],"description":"Bill Segment Status:\n* `10  ` - Incomplete,\n* `20  ` - Error,\n* `30  ` - Freezable,\n* `40  ` - Pending Cancel,\n* `50  ` - Frozen,\n* `60  ` - Canceled,\n* `70  ` - OK"}}}}}},"messages":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"billMessageCode":{"type":"string","maxLength":4,"description":"Bill Message"},"insert":{"type":"string","maxLength":8,"description":"Insert Code defines if the bill message causes an insert in the envelope."},"messagePriority":{"type":"string","enum":["10  ","20  ","30  ","40  ","50  ","60  ","70  ","80  ","90  "],"description":"Priority is the bill messages priority (on the printed bill).\n* `10  ` - Priority 10 -- Lowest,\n* `20  ` - Priority 20,\n* `30  ` - Priority 30,\n* `40  ` - Priority 40,\n* `50  ` - Priority 50,\n* `60  ` - Priority 60,\n* `70  ` - Priority 70,\n* `80  ` - Priority 80,\n* `90  ` - Priority 90 -- Highest","example":"20"},"messageOnBill":{"type":"string","maxLength":254,"description":"Message On Bill is the message associated with the code.","example":"Electric service not billed"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"}}}}}},"nextActions":{"type":"object","properties":{"_link":{"type":"string","description":"(_link)"},"_data":{"type":"array","items":{"type":"object","properties":{"_link":{"type":"string","description":"(_link)"},"actionName":{"type":"string","description":"(actionName)"}}}}}}},"xml":{"name":"C1-BillSegm"}},"DELETEBILLSEGMENT_response":{"type":"object","properties":{"billSegmentId":{"type":"string","maxLength":12,"description":"Bill Segment ID is the system-assigned unique identifier of the bill segment.","example":"211366855400"}},"xml":{"name":"C1DelBillseg"}},"GETPERSONCONTEXT_response":{"type":"object","properties":{"person":{"type":"object","properties":{"personId":{"type":"string","maxLength":10,"description":"Person ID is a system-assigned random number that stays with a person for the life of the system.","example":"4429925678"},"primaryName":{"type":"string","maxLength":254,"description":"A person's primary name is the addressee on the person's bill unless overridden by the Override Mailing Name.","example":"Brazil,Mary"}}},"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","description":"Customer Class controls financial parameters related to billing and collections and is required on an account.","example":"R"},"description":{"type":"string","description":"(description)"}}},"division":{"type":"object","properties":{"division":{"type":"string","maxLength":5,"description":"CIS Division"},"description":{"type":"string","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","description":"(primaryText)"},"secondaryText":{"type":"string","description":"(secondaryText)"},"tertiaryText":{"type":"string","description":"(tertiaryText)"}}},"premiseInformation":{"type":"object","properties":{"info":{"type":"string","maxLength":254,"description":"Premise Info"},"primaryText":{"type":"string","description":"(primaryText)"},"secondaryText":{"type":"string","description":"(secondaryText)"},"tertiaryText":{"type":"string","description":"(tertiaryText)"}}},"premiseCount":{"type":"string","maxLength":5,"description":"Count"},"accountPersons":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"person":{"type":"object","properties":{"personId":{"type":"string","maxLength":10,"description":"Person ID is a system-assigned random number that stays with a person for the life of the system.","example":"4429925678"}}},"personInformation":{"type":"object","properties":{"info":{"type":"string","maxLength":254,"description":"Person Info"},"primaryText":{"type":"string","description":"(primaryText)"},"secondaryText":{"type":"string","description":"(secondaryText)"},"tertiaryText":{"type":"string","description":"(tertiaryText)"}}},"primaryName":{"type":"string","maxLength":254,"description":"A person's primary name is the addressee on the person's bill unless overridden by the Override Mailing Name.","example":"Brazil,Mary"},"accountRelationshipType":{"type":"object","properties":{"accountRelationshipType":{"type":"string","maxLength":8,"description":"Account Relationship Type"},"description":{"type":"string","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":"C1-GetPerCtx"}},"GETDEVICECONFIGURATION_response":{"type":"object","properties":{"_self":{"type":"string","description":"_self"},"httpMethod":{"type":"string","enum":["DELT","GET ","POST","PTCH","PUT "],"description":"HTTP Method\n* `DELT` - Delete,\n* `GET ` - Get,\n* `POST` - Post,\n* `PTCH` - Patch,\n* `PUT ` - Put","example":"GET"},"deviceConfigurationType":{"type":"object","description":"Type of device configuration","properties":{"_link":{"type":"string","description":"_link"},"deviceConfigurationType":{"type":"string","maxLength":30,"description":"Type of device configuration","example":"ZZ-STMT-CFGZ13"}}},"device":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"deviceId":{"type":"string","maxLength":12,"description":"Device ID"}}},"itemId":{"type":"string","maxLength":12,"description":"Device ID"},"meterId":{"type":"string","maxLength":12,"description":"Device ID"},"effectiveDateTime":{"type":"string","format":"date-time","description":"Effective Date/Time","example":"2021-08-07T00:11:59-07:00"},"timeZone":{"type":"object","description":"Enter the Time Zone in which the premise is located.","properties":{"_link":{"type":"string","description":"_link"},"timeZone":{"type":"string","maxLength":10,"description":"Enter the Time Zone in which the premise is located.","example":"USPACIFIC"}}},"externalId":{"type":"string","maxLength":254,"description":"Adhoc Characteristic Value"},"mdmExternalId":{"type":"string","maxLength":254,"description":"Adhoc Characteristic Value"},"status":{"type":"string","maxLength":12,"description":"The current status of the device configuration.","example":"Active"},"statusDateTime":{"type":"string","format":"date-time","description":"Status Date/Time","example":"2021-07-23T08:44:51-07:00"},"statusReason":{"type":"object","description":"Status Reason indicates the reason for status change of the device configuration.","properties":{"_link":{"type":"string","description":"_link"},"statusReason":{"type":"string","maxLength":30,"description":"Status Reason indicates the reason for status change of the device configuration."}}},"creationDateTime":{"type":"string","format":"date-time","description":"Create Date/Time","example":"2021-07-23T08:44:51-07:00"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks.","example":"14"}},"xml":{"name":"D1-DevConf"}},"UPDATEDEVICECONFIGURATION_response":{"type":"object","properties":{"_self":{"type":"string","description":"_self"},"httpMethod":{"type":"string","enum":["DELT","GET ","POST","PTCH","PUT "],"description":"HTTP Method\n* `DELT` - Delete,\n* `GET ` - Get,\n* `POST` - Post,\n* `PTCH` - Patch,\n* `PUT ` - Put","example":"GET"},"deviceConfigurationType":{"type":"object","description":"Type of device configuration","properties":{"_link":{"type":"string","description":"_link"},"deviceConfigurationType":{"type":"string","maxLength":30,"description":"Type of device configuration","example":"ZZ-STMT-CFGZ13"}}},"device":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"deviceId":{"type":"string","maxLength":12,"description":"Device ID"}}},"itemId":{"type":"string","maxLength":12,"description":"Device ID"},"meterId":{"type":"string","maxLength":12,"description":"Device ID"},"effectiveDateTime":{"type":"string","format":"date-time","description":"Effective Date/Time","example":"2021-08-07T00:11:59-07:00"},"timeZone":{"type":"object","description":"Enter the Time Zone in which the premise is located.","properties":{"_link":{"type":"string","description":"_link"},"timeZone":{"type":"string","maxLength":10,"description":"Enter the Time Zone in which the premise is located.","example":"USPACIFIC"}}},"externalId":{"type":"string","maxLength":254,"description":"Adhoc Characteristic Value"},"mdmExternalId":{"type":"string","maxLength":254,"description":"Adhoc Characteristic Value"},"status":{"type":"string","maxLength":12,"description":"The current status of the device configuration.","example":"Active"},"statusDateTime":{"type":"string","format":"date-time","description":"Status Date/Time","example":"2021-07-23T08:44:51-07:00"},"statusReason":{"type":"object","description":"Status Reason indicates the reason for status change of the device configuration.","properties":{"_link":{"type":"string","description":"_link"},"statusReason":{"type":"string","maxLength":30,"description":"Status Reason indicates the reason for status change of the device configuration."}}},"creationDateTime":{"type":"string","format":"date-time","description":"Create Date/Time","example":"2021-07-23T08:44:51-07:00"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks.","example":"14"}},"xml":{"name":"D1-DevConf"}},"UPDATEDEVICECONFIGURATION_request":{"type":"object","properties":{"httpMethod":{"type":"string","enum":["DELT","GET ","POST","PTCH","PUT "],"description":"HTTP Method\n* `DELT` - Delete,\n* `GET ` - Get,\n* `POST` - Post,\n* `PTCH` - Patch,\n* `PUT ` - Put","example":"GET"},"deviceConfigurationId":{"type":"string","maxLength":12,"description":"Device Configuration ID is a system assigned random number that stays with a device configuration record.","example":"099948278222"},"deviceConfigurationType":{"type":"object","description":"Type of device configuration","properties":{"deviceConfigurationType":{"type":"string","maxLength":30,"description":"Type of device configuration","example":"ZZ-STMT-CFGZ13"}}},"device":{"type":"object","properties":{"deviceId":{"type":"string","maxLength":12,"description":"Device ID"}}},"itemId":{"type":"string","maxLength":12,"description":"Device ID"},"meterId":{"type":"string","maxLength":12,"description":"Device ID"},"effectiveDateTime":{"type":"string","format":"date-time","description":"Effective Date/Time","example":"2021-08-07T00:11:59-07:00"},"timeZone":{"type":"object","description":"Enter the Time Zone in which the premise is located.","properties":{"timeZone":{"type":"string","maxLength":10,"description":"Enter the Time Zone in which the premise is located.","example":"USPACIFIC"}}},"externalId":{"type":"string","maxLength":254,"description":"Adhoc Characteristic Value"},"mdmExternalId":{"type":"string","maxLength":254,"description":"Adhoc Characteristic Value"},"status":{"type":"string","maxLength":12,"description":"The current status of the device configuration.","example":"Active"},"statusDateTime":{"type":"string","format":"date-time","description":"Status Date/Time","example":"2021-07-23T08:44:51-07:00"},"statusReason":{"type":"object","description":"Status Reason indicates the reason for status change of the device configuration.","properties":{"statusReason":{"type":"string","maxLength":30,"description":"Status Reason indicates the reason for status change of the device configuration."}}},"creationDateTime":{"type":"string","format":"date-time","description":"Create Date/Time","example":"2021-07-23T08:44:51-07:00"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks.","example":"14"}},"xml":{"name":"D1-DevConf"}},"CREATEDEVICECONFIGURATION_response":{"type":"object","properties":{"_self":{"type":"string","description":"_self"},"httpMethod":{"type":"string","enum":["DELT","GET ","POST","PTCH","PUT "],"description":"HTTP Method\n* `DELT` - Delete,\n* `GET ` - Get,\n* `POST` - Post,\n* `PTCH` - Patch,\n* `PUT ` - Put","example":"GET"},"deviceConfigurationId":{"type":"string","maxLength":12,"description":"Device Configuration ID is a system assigned random number that stays with a device configuration record.","example":"099948278222"},"deviceConfigurationType":{"type":"object","description":"Type of device configuration","properties":{"_link":{"type":"string","description":"_link"},"deviceConfigurationType":{"type":"string","maxLength":30,"description":"Type of device configuration","example":"ZZ-STMT-CFGZ13"}}},"device":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"deviceId":{"type":"string","maxLength":12,"description":"Device ID"}}},"itemId":{"type":"string","maxLength":12,"description":"Device ID"},"meterId":{"type":"string","maxLength":12,"description":"Device ID"},"effectiveDateTime":{"type":"string","format":"date-time","description":"Effective Date/Time","example":"2021-08-07T00:11:59-07:00"},"timeZone":{"type":"object","description":"Enter the Time Zone in which the premise is located.","properties":{"_link":{"type":"string","description":"_link"},"timeZone":{"type":"string","maxLength":10,"description":"Enter the Time Zone in which the premise is located.","example":"USPACIFIC"}}},"externalId":{"type":"string","maxLength":254,"description":"Adhoc Characteristic Value"},"mdmExternalId":{"type":"string","maxLength":254,"description":"Adhoc Characteristic Value"},"status":{"type":"string","maxLength":12,"description":"The current status of the device configuration.","example":"Active"},"statusDateTime":{"type":"string","format":"date-time","description":"Status Date/Time","example":"2021-07-23T08:44:51-07:00"},"statusReason":{"type":"object","description":"Status Reason indicates the reason for status change of the device configuration.","properties":{"_link":{"type":"string","description":"_link"},"statusReason":{"type":"string","maxLength":30,"description":"Status Reason indicates the reason for status change of the device configuration."}}},"creationDateTime":{"type":"string","format":"date-time","description":"Create Date/Time","example":"2021-07-23T08:44:51-07:00"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks.","example":"14"}},"xml":{"name":"D1-DevConf"}},"DELETEDEVICECONFIGURATION_response":{"type":"object","properties":{"deviceConfigurationId":{"type":"string","maxLength":12,"description":"Device Configuration ID is a system assigned random number that stays with a device configuration record.","example":"099948278222"}},"xml":{"name":"D1-DelDevCon"}},"CREATEDEVICECONFIGURATION_request":{"type":"object","properties":{"httpMethod":{"type":"string","enum":["DELT","GET ","POST","PTCH","PUT "],"description":"HTTP Method\n* `DELT` - Delete,\n* `GET ` - Get,\n* `POST` - Post,\n* `PTCH` - Patch,\n* `PUT ` - Put","example":"GET"},"deviceConfigurationType":{"type":"object","description":"Type of device configuration","properties":{"deviceConfigurationType":{"type":"string","maxLength":30,"description":"Type of device configuration","example":"ZZ-STMT-CFGZ13"}}},"device":{"type":"object","properties":{"deviceId":{"type":"string","maxLength":12,"description":"Device ID"}}},"itemId":{"type":"string","maxLength":12,"description":"Device ID"},"meterId":{"type":"string","maxLength":12,"description":"Device ID"},"effectiveDateTime":{"type":"string","format":"date-time","description":"Effective Date/Time","example":"2021-08-07T00:11:59-07:00"},"timeZone":{"type":"object","description":"Enter the Time Zone in which the premise is located.","properties":{"timeZone":{"type":"string","maxLength":10,"description":"Enter the Time Zone in which the premise is located.","example":"USPACIFIC"}}},"externalId":{"type":"string","maxLength":254,"description":"Adhoc Characteristic Value"},"mdmExternalId":{"type":"string","maxLength":254,"description":"Adhoc Characteristic Value"},"status":{"type":"string","maxLength":12,"description":"The current status of the device configuration.","example":"Active"},"statusDateTime":{"type":"string","format":"date-time","description":"Status Date/Time","example":"2021-07-23T08:44:51-07:00"},"statusReason":{"type":"object","description":"Status Reason indicates the reason for status change of the device configuration.","properties":{"statusReason":{"type":"string","maxLength":30,"description":"Status Reason indicates the reason for status change of the device configuration."}}},"creationDateTime":{"type":"string","format":"date-time","description":"Create Date/Time","example":"2021-07-23T08:44:51-07:00"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks.","example":"14"}},"xml":{"name":"D1-DevConf"}},"DELETEDEVICECONFIGURATION_request":{"type":"object","properties":{"deviceConfigurationId":{"type":"string","maxLength":12,"description":"Device Configuration ID is a system assigned random number that stays with a device configuration record.","example":"099948278222"}},"xml":{"name":"D1-DelDevCon"}},"CREATEINSTALLEVENT_request":{"type":"object","properties":{"httpMethod":{"type":"string","enum":["DELT","GET ","POST","PTCH","PUT "],"description":"HTTP Method\n* `DELT` - Delete,\n* `GET ` - Get,\n* `POST` - Post,\n* `PTCH` - Patch,\n* `PUT ` - Put","example":"DELT"},"installEventId":{"type":"string","maxLength":12,"description":"Install Event ID is a system assigned random number that stays with install event record.","example":"850626819111"},"deviceConfiguration":{"type":"object","properties":{"deviceConfigurationId":{"type":"string","maxLength":12,"description":"Device Configuration"}}},"servicePoint":{"type":"object","properties":{"servicePointId":{"type":"string","maxLength":12,"description":"Service Point ID"}}},"status":{"type":"string","maxLength":12,"description":"The current status of the install event.","example":"DISCONN-COMM"},"installDateTime":{"type":"string","format":"date-time","description":"Installation Date/Time is the date/time when the device was installed at service point.","example":"2010-01-01T00:00:00-08:00"},"installationConstant":{"type":"number","maximum":999999.999999,"minimum":-999999.999999,"description":"A value (other than 1) used to indicate that when calculating consumption, the installation requires that measurement data be multiplied by this value to get accurate results.","example":"1.000000"},"externalId":{"type":"string","maxLength":60,"description":"External ID is used by external system to identify the install event.","example":"12345"},"mdmExternalId":{"type":"string","maxLength":60,"description":"MDM External ID","example":"56789"},"eventDateTime":{"type":"string","format":"date-time","description":"Use Event Date / Time to define when the status changed.","example":"2021-10-22T00:00:00-11:00"},"removalType":{"type":"string","enum":["D1OE","D1PR"],"description":"A flag that indicates the removal type.\n* `D1OE` - Office Exchange,\n* `D1PR` - Physical Removal","example":"D1PR"},"crew":{"type":"string","maxLength":60,"description":"Crew"},"armingStatus":{"type":"string","enum":["D1AM","D1NA"],"description":"A flag that indicates if the device has been armed or not.\n* `D1AM` - Armed,\n* `D1NA` - Not Armed","example":"D1AM"},"statusDateTime":{"type":"string","format":"date-time","description":"Status Date/Time","example":"2012-08-24T03:49:39-07:00"},"creationDateTime":{"type":"string","format":"date-time","description":"Create Date/Time","example":"2012-08-24T02:36:22-07:00"},"removalDateTime":{"type":"string","format":"date-time","description":"Enter the Removal Date/Time showing when the device is removed from the service point."},"statusReason":{"type":"object","description":"Status Reason indicates the reason for status change of the install event.","properties":{"statusReason":{"type":"string","maxLength":30,"description":"Status Reason indicates the reason for status change of the install event."}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks.","example":"1"},"onOffHistory":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"sequence":{"type":"number","maximum":99999,"minimum":-99999,"description":"A unique Sequence number is given to each entry after the information is saved.","example":"1"},"eventDateTime":{"type":"string","format":"date-time","description":"Use Event Date / Time to define when the status changed.","example":"2021-10-22T00:00:00-11:00"},"deviceOnOffStatus":{"type":"string","enum":["D1OF","D1ON"],"description":"Device On/Off Status:\n* `D1OF` - Off,\n* `D1ON` - On"},"activityId":{"type":"string","maxLength":14,"description":"Activity ID"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks.","example":"1"}}}}}}},"xml":{"name":"D1InstallEve"}},"GETINSTALLEVENT_response":{"type":"object","properties":{"_self":{"type":"string","description":"_self"},"httpMethod":{"type":"string","enum":["DELT","GET ","POST","PTCH","PUT "],"description":"HTTP Method\n* `DELT` - Delete,\n* `GET ` - Get,\n* `POST` - Post,\n* `PTCH` - Patch,\n* `PUT ` - Put","example":"DELT"},"installEventId":{"type":"string","maxLength":12,"description":"Install Event ID is a system assigned random number that stays with install event record.","example":"850626819111"},"deviceConfiguration":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"deviceConfigurationId":{"type":"string","maxLength":12,"description":"Device Configuration"}}},"servicePoint":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"servicePointId":{"type":"string","maxLength":12,"description":"Service Point ID"}}},"status":{"type":"string","maxLength":12,"description":"The current status of the install event.","example":"DISCONN-COMM"},"installDateTime":{"type":"string","format":"date-time","description":"Installation Date/Time is the date/time when the device was installed at service point.","example":"2010-01-01T00:00:00-08:00"},"installationConstant":{"type":"number","maximum":999999.999999,"minimum":-999999.999999,"description":"A value (other than 1) used to indicate that when calculating consumption, the installation requires that measurement data be multiplied by this value to get accurate results.","example":"1.000000"},"externalId":{"type":"string","maxLength":60,"description":"External ID is used by external system to identify the install event.","example":"12345"},"mdmExternalId":{"type":"string","maxLength":60,"description":"MDM External ID","example":"56789"},"eventDateTime":{"type":"string","format":"date-time","description":"Use Event Date / Time to define when the status changed.","example":"2021-10-22T00:00:00-11:00"},"removalType":{"type":"string","enum":["D1OE","D1PR"],"description":"A flag that indicates the removal type.\n* `D1OE` - Office Exchange,\n* `D1PR` - Physical Removal","example":"D1PR"},"crew":{"type":"string","maxLength":60,"description":"Crew"},"armingStatus":{"type":"string","enum":["D1AM","D1NA"],"description":"A flag that indicates if the device has been armed or not.\n* `D1AM` - Armed,\n* `D1NA` - Not Armed","example":"D1AM"},"statusDateTime":{"type":"string","format":"date-time","description":"Status Date/Time","example":"2012-08-24T03:49:39-07:00"},"creationDateTime":{"type":"string","format":"date-time","description":"Create Date/Time","example":"2012-08-24T02:36:22-07:00"},"removalDateTime":{"type":"string","format":"date-time","description":"Enter the Removal Date/Time showing when the device is removed from the service point."},"statusReason":{"type":"object","description":"Status Reason indicates the reason for status change of the install event.","properties":{"_link":{"type":"string","description":"_link"},"statusReason":{"type":"string","maxLength":30,"description":"Status Reason indicates the reason for status change of the install event."}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks.","example":"1"},"onOffHistory":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"sequence":{"type":"number","maximum":99999,"minimum":-99999,"description":"A unique Sequence number is given to each entry after the information is saved.","example":"1"},"eventDateTime":{"type":"string","format":"date-time","description":"Use Event Date / Time to define when the status changed.","example":"2021-10-22T00:00:00-11:00"},"deviceOnOffStatus":{"type":"string","enum":["D1OF","D1ON"],"description":"Device On/Off Status:\n* `D1OF` - Off,\n* `D1ON` - On"},"activityId":{"type":"string","maxLength":14,"description":"Activity ID"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks.","example":"1"}}}}}}},"xml":{"name":"D1InstallEve"}},"UPDATEINSTALLEVENT_response":{"type":"object","properties":{"_self":{"type":"string","description":"_self"},"httpMethod":{"type":"string","enum":["DELT","GET ","POST","PTCH","PUT "],"description":"HTTP Method\n* `DELT` - Delete,\n* `GET ` - Get,\n* `POST` - Post,\n* `PTCH` - Patch,\n* `PUT ` - Put","example":"DELT"},"installEventId":{"type":"string","maxLength":12,"description":"Install Event ID is a system assigned random number that stays with install event record.","example":"850626819111"},"deviceConfiguration":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"deviceConfigurationId":{"type":"string","maxLength":12,"description":"Device Configuration"}}},"servicePoint":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"servicePointId":{"type":"string","maxLength":12,"description":"Service Point ID"}}},"status":{"type":"string","maxLength":12,"description":"The current status of the install event.","example":"DISCONN-COMM"},"installDateTime":{"type":"string","format":"date-time","description":"Installation Date/Time is the date/time when the device was installed at service point.","example":"2010-01-01T00:00:00-08:00"},"installationConstant":{"type":"number","maximum":999999.999999,"minimum":-999999.999999,"description":"A value (other than 1) used to indicate that when calculating consumption, the installation requires that measurement data be multiplied by this value to get accurate results.","example":"1.000000"},"externalId":{"type":"string","maxLength":60,"description":"External ID is used by external system to identify the install event.","example":"12345"},"mdmExternalId":{"type":"string","maxLength":60,"description":"MDM External ID","example":"56789"},"eventDateTime":{"type":"string","format":"date-time","description":"Use Event Date / Time to define when the status changed.","example":"2021-10-22T00:00:00-11:00"},"removalType":{"type":"string","enum":["D1OE","D1PR"],"description":"A flag that indicates the removal type.\n* `D1OE` - Office Exchange,\n* `D1PR` - Physical Removal","example":"D1PR"},"crew":{"type":"string","maxLength":60,"description":"Crew"},"armingStatus":{"type":"string","enum":["D1AM","D1NA"],"description":"A flag that indicates if the device has been armed or not.\n* `D1AM` - Armed,\n* `D1NA` - Not Armed","example":"D1AM"},"statusDateTime":{"type":"string","format":"date-time","description":"Status Date/Time","example":"2012-08-24T03:49:39-07:00"},"creationDateTime":{"type":"string","format":"date-time","description":"Create Date/Time","example":"2012-08-24T02:36:22-07:00"},"removalDateTime":{"type":"string","format":"date-time","description":"Enter the Removal Date/Time showing when the device is removed from the service point."},"statusReason":{"type":"object","description":"Status Reason indicates the reason for status change of the install event.","properties":{"_link":{"type":"string","description":"_link"},"statusReason":{"type":"string","maxLength":30,"description":"Status Reason indicates the reason for status change of the install event."}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks.","example":"1"},"onOffHistory":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"sequence":{"type":"number","maximum":99999,"minimum":-99999,"description":"A unique Sequence number is given to each entry after the information is saved.","example":"1"},"eventDateTime":{"type":"string","format":"date-time","description":"Use Event Date / Time to define when the status changed.","example":"2021-10-22T00:00:00-11:00"},"deviceOnOffStatus":{"type":"string","enum":["D1OF","D1ON"],"description":"Device On/Off Status:\n* `D1OF` - Off,\n* `D1ON` - On"},"activityId":{"type":"string","maxLength":14,"description":"Activity ID"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks.","example":"1"}}}}}}},"xml":{"name":"D1InstallEve"}},"DELETEINSTALLEVENT_request":{"type":"object","properties":{"installEventId":{"type":"string","maxLength":12,"description":"Install Event ID is a system assigned random number that stays with install event record.","example":"850626819111"}},"xml":{"name":"D1-DelInsEve"}},"DELETEINSTALLEVENT_response":{"type":"object","properties":{"installEventId":{"type":"string","maxLength":12,"description":"Install Event ID is a system assigned random number that stays with install event record.","example":"850626819111"}},"xml":{"name":"D1-DelInsEve"}},"UPDATEINSTALLEVENT_request":{"type":"object","properties":{"httpMethod":{"type":"string","enum":["DELT","GET ","POST","PTCH","PUT "],"description":"HTTP Method\n* `DELT` - Delete,\n* `GET ` - Get,\n* `POST` - Post,\n* `PTCH` - Patch,\n* `PUT ` - Put","example":"DELT"},"installEventId":{"type":"string","maxLength":12,"description":"Install Event ID is a system assigned random number that stays with install event record.","example":"850626819111"},"deviceConfiguration":{"type":"object","properties":{"deviceConfigurationId":{"type":"string","maxLength":12,"description":"Device Configuration"}}},"servicePoint":{"type":"object","properties":{"servicePointId":{"type":"string","maxLength":12,"description":"Service Point ID"}}},"status":{"type":"string","maxLength":12,"description":"The current status of the install event.","example":"DISCONN-COMM"},"installDateTime":{"type":"string","format":"date-time","description":"Installation Date/Time is the date/time when the device was installed at service point.","example":"2010-01-01T00:00:00-08:00"},"installationConstant":{"type":"number","maximum":999999.999999,"minimum":-999999.999999,"description":"A value (other than 1) used to indicate that when calculating consumption, the installation requires that measurement data be multiplied by this value to get accurate results.","example":"1.000000"},"externalId":{"type":"string","maxLength":60,"description":"External ID is used by external system to identify the install event.","example":"12345"},"mdmExternalId":{"type":"string","maxLength":60,"description":"MDM External ID","example":"56789"},"eventDateTime":{"type":"string","format":"date-time","description":"Use Event Date / Time to define when the status changed.","example":"2021-10-22T00:00:00-11:00"},"removalType":{"type":"string","enum":["D1OE","D1PR"],"description":"A flag that indicates the removal type.\n* `D1OE` - Office Exchange,\n* `D1PR` - Physical Removal","example":"D1PR"},"crew":{"type":"string","maxLength":60,"description":"Crew"},"armingStatus":{"type":"string","enum":["D1AM","D1NA"],"description":"A flag that indicates if the device has been armed or not.\n* `D1AM` - Armed,\n* `D1NA` - Not Armed","example":"D1AM"},"statusDateTime":{"type":"string","format":"date-time","description":"Status Date/Time","example":"2012-08-24T03:49:39-07:00"},"creationDateTime":{"type":"string","format":"date-time","description":"Create Date/Time","example":"2012-08-24T02:36:22-07:00"},"removalDateTime":{"type":"string","format":"date-time","description":"Enter the Removal Date/Time showing when the device is removed from the service point."},"statusReason":{"type":"object","description":"Status Reason indicates the reason for status change of the install event.","properties":{"statusReason":{"type":"string","maxLength":30,"description":"Status Reason indicates the reason for status change of the install event."}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks.","example":"1"},"onOffHistory":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"sequence":{"type":"number","maximum":99999,"minimum":-99999,"description":"A unique Sequence number is given to each entry after the information is saved.","example":"1"},"eventDateTime":{"type":"string","format":"date-time","description":"Use Event Date / Time to define when the status changed.","example":"2021-10-22T00:00:00-11:00"},"deviceOnOffStatus":{"type":"string","enum":["D1OF","D1ON"],"description":"Device On/Off Status:\n* `D1OF` - Off,\n* `D1ON` - On"},"activityId":{"type":"string","maxLength":14,"description":"Activity ID"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks.","example":"1"}}}}}}},"xml":{"name":"D1InstallEve"}},"CREATEINSTALLEVENT_response":{"type":"object","properties":{"_self":{"type":"string","description":"_self"},"httpMethod":{"type":"string","enum":["DELT","GET ","POST","PTCH","PUT "],"description":"HTTP Method\n* `DELT` - Delete,\n* `GET ` - Get,\n* `POST` - Post,\n* `PTCH` - Patch,\n* `PUT ` - Put","example":"DELT"},"installEventId":{"type":"string","maxLength":12,"description":"Install Event ID is a system assigned random number that stays with install event record.","example":"850626819111"},"deviceConfiguration":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"deviceConfigurationId":{"type":"string","maxLength":12,"description":"Device Configuration"}}},"servicePoint":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"servicePointId":{"type":"string","maxLength":12,"description":"Service Point ID"}}},"status":{"type":"string","maxLength":12,"description":"The current status of the install event.","example":"DISCONN-COMM"},"installDateTime":{"type":"string","format":"date-time","description":"Installation Date/Time is the date/time when the device was installed at service point.","example":"2010-01-01T00:00:00-08:00"},"installationConstant":{"type":"number","maximum":999999.999999,"minimum":-999999.999999,"description":"A value (other than 1) used to indicate that when calculating consumption, the installation requires that measurement data be multiplied by this value to get accurate results.","example":"1.000000"},"externalId":{"type":"string","maxLength":60,"description":"External ID is used by external system to identify the install event.","example":"12345"},"mdmExternalId":{"type":"string","maxLength":60,"description":"MDM External ID","example":"56789"},"eventDateTime":{"type":"string","format":"date-time","description":"Use Event Date / Time to define when the status changed.","example":"2021-10-22T00:00:00-11:00"},"removalType":{"type":"string","enum":["D1OE","D1PR"],"description":"A flag that indicates the removal type.\n* `D1OE` - Office Exchange,\n* `D1PR` - Physical Removal","example":"D1PR"},"crew":{"type":"string","maxLength":60,"description":"Crew"},"armingStatus":{"type":"string","enum":["D1AM","D1NA"],"description":"A flag that indicates if the device has been armed or not.\n* `D1AM` - Armed,\n* `D1NA` - Not Armed","example":"D1AM"},"statusDateTime":{"type":"string","format":"date-time","description":"Status Date/Time","example":"2012-08-24T03:49:39-07:00"},"creationDateTime":{"type":"string","format":"date-time","description":"Create Date/Time","example":"2012-08-24T02:36:22-07:00"},"removalDateTime":{"type":"string","format":"date-time","description":"Enter the Removal Date/Time showing when the device is removed from the service point."},"statusReason":{"type":"object","description":"Status Reason indicates the reason for status change of the install event.","properties":{"_link":{"type":"string","description":"_link"},"statusReason":{"type":"string","maxLength":30,"description":"Status Reason indicates the reason for status change of the install event."}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks.","example":"1"},"onOffHistory":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"sequence":{"type":"number","maximum":99999,"minimum":-99999,"description":"A unique Sequence number is given to each entry after the information is saved.","example":"1"},"eventDateTime":{"type":"string","format":"date-time","description":"Use Event Date / Time to define when the status changed.","example":"2021-10-22T00:00:00-11:00"},"deviceOnOffStatus":{"type":"string","enum":["D1OF","D1ON"],"description":"Device On/Off Status:\n* `D1OF` - Off,\n* `D1ON` - On"},"activityId":{"type":"string","maxLength":14,"description":"Activity ID"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks.","example":"1"}}}}}}},"xml":{"name":"D1InstallEve"}},"GETVMODELRELATIONSHIPS_response":{"type":"object","properties":{"_self":{"type":"string","description":"_self"},"httpMethod":{"type":"string","enum":["DELT","GET ","POST","PTCH","PUT "],"description":"HTTP Method\n* `DELT` - Delete,\n* `GET ` - Get,\n* `POST` - Post,\n* `PTCH` - Patch,\n* `PUT ` - Put","example":"GET"},"account":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"accountId":{"type":"string","maxLength":10,"description":"Account ID is a system-assigned random number that stays with an account for life.","example":"9973918199"}}},"customerClass":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"customerClass":{"type":"string","description":"(customerClass)"}}},"accessGroup":{"type":"object","description":"Access Group controls which users are allowed to view and update this account's information (including bills, service agreements, payments, and premises).","properties":{"_link":{"type":"string","description":"_link"},"accessGroup":{"type":"string","maxLength":12,"description":"Access Group controls which users are allowed to view and update this account's information (including bills, service agreements, payments, and premises).","example":"***"}}},"currency":{"type":"object","description":"Currency Code defines the currency in which the account's financial transactions are expressed","properties":{"_link":{"type":"string","description":"_link"},"currencyId":{"type":"string","maxLength":3,"description":"Currency Code"}}},"serviceAgreements":{"type":"object","properties":{"serviceAgreementsList":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"serviceAgreement":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"serviceAgreementId":{"type":"string","maxLength":10,"description":"Service Agreement"}}},"premises":{"type":"object","properties":{"premisesList":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"premise":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"premiseId":{"type":"string","maxLength":10,"description":"Premise ID"},"address":{"type":"object","properties":{"address1":{"type":"string","maxLength":254,"description":"The first line of the premise address.","example":"1 Daily Show"},"address2":{"type":"string","maxLength":254,"description":"The second line of the premise address.","example":"ZZRSALDO C2M"},"address3":{"type":"string","maxLength":254,"description":"The third line of the premise address."},"address4":{"type":"string","maxLength":254,"description":"The fourth line of the premise address.","example":"Uniontown"},"city":{"type":"string","maxLength":90,"description":"The city of the premise address."},"streetNumber1":{"type":"string","maxLength":6,"description":"The first street number line of the premise address."},"streetNumber2":{"type":"string","maxLength":4,"description":"The second street number line of the premise address."},"county":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"county":{"type":"string","maxLength":90,"description":"County"}}},"postal":{"type":"string","maxLength":12,"description":"The postal code of the premise address.","example":"44002"},"state":{"type":"string","maxLength":6,"description":"The state of the premise address.","example":"OH"},"country":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"country":{"type":"string","maxLength":3,"description":"Country"}}}}},"servicePoints":{"type":"object","properties":{"servicePointsList":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"servicePoint":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"servicePointId":{"type":"string","maxLength":10,"description":"Service Point ID"}}},"installEvents":{"type":"object","properties":{"installEventsList":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"installEvent":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"installEventId":{"type":"string","maxLength":12,"description":"Install Event ID"}}},"deviceType":{"type":"string","maxLength":30,"description":"Device Type describes type of device. Typically, devices are categorized into smart meters, manual meters, items, or communications components.","example":"E-SMART-MTR"},"meter":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"meterId":{"type":"string","maxLength":12,"description":"Device ID"}}},"item":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"itemId":{"type":"string","maxLength":12,"description":"Device ID"}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}},"xml":{"name":"X1GetVModel"}},"BUSINESSESSUMMARY_request":{"type":"object","properties":{"personSummary":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"person":{"type":"object","properties":{"personId":{"type":"string","maxLength":10,"description":"Person ID"}}},"externalId":{"type":"string","maxLength":60,"description":"External Party ID in a CX/CRM application","example":"CDRM_952287"},"annualRevenue":{"type":"number","description":"Annual Revenue","example":"187741.99"},"yearToDateRevenue":{"type":"number","description":"Year To Date Revenue","example":"52641.14"},"currentBalance":{"type":"number","description":"Current Balance","example":"7874.02"},"totalBalance":{"type":"number","description":"Total Balance","example":"7874.02"},"disputedBalance":{"type":"number","description":"Disputed Balance","example":"0.0"},"numberOfAccounts":{"type":"number","maximum":9999999999,"minimum":0,"description":"Number Of Accounts","example":"5"},"numberOfSAs":{"type":"number","maximum":9999999999,"minimum":0,"description":"Number Of Service Agreements","example":"81"},"numberOfPremises":{"type":"number","maximum":9999999999,"minimum":0,"description":"Number Of Premises","example":"77"},"numberOfSPs":{"type":"number","maximum":9999999999,"minimum":0,"description":"Number Of Service Points","example":"154"},"numberOfOpenServiceOrders":{"type":"number","maximum":9999999999,"minimum":0,"description":"Number Of Open Service Orders","example":"3"}}}}}}},"xml":{"name":"X1PersonSumm"}},"BUSINESSESSUMMARY_response":{"type":"object","properties":{"personSummary":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"person":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"personId":{"type":"string","maxLength":10,"description":"Person ID"}}},"externalId":{"type":"string","maxLength":60,"description":"External Party ID in a CX/CRM application","example":"CDRM_952287"},"annualRevenue":{"type":"number","description":"Annual Revenue","example":"187741.99"},"yearToDateRevenue":{"type":"number","description":"Year To Date Revenue","example":"52641.14"},"currentBalance":{"type":"number","description":"Current Balance","example":"7874.02"},"totalBalance":{"type":"number","description":"Total Balance","example":"7874.02"},"disputedBalance":{"type":"number","description":"Disputed Balance","example":"0.0"},"numberOfAccounts":{"type":"number","maximum":9999999999,"minimum":0,"description":"Number Of Accounts","example":"5"},"numberOfSAs":{"type":"number","maximum":9999999999,"minimum":0,"description":"Number Of Service Agreements","example":"81"},"numberOfPremises":{"type":"number","maximum":9999999999,"minimum":0,"description":"Number Of Premises","example":"77"},"numberOfSPs":{"type":"number","maximum":9999999999,"minimum":0,"description":"Number Of Service Points","example":"154"},"numberOfOpenServiceOrders":{"type":"number","maximum":9999999999,"minimum":0,"description":"Number Of Open Service Orders","example":"3"}}}}}}},"xml":{"name":"X1PersonSumm"}},"BUSINESSPERSONSEARCH_request":{"type":"object","properties":{"filter":{"type":"object","properties":{"accountId":{"type":"string","maxLength":10,"description":"Account ID"},"premiseAddress":{"type":"string","maxLength":150,"description":"Address"},"restrictToPersons":{"type":"array","items":{"type":"object","properties":{"externalId":{"type":"string","maxLength":60,"description":"External Party ID in a CX/CRM application","example":"CDRM_952287"},"personId":{"type":"string","maxLength":10,"description":"Person ID is a system-assigned random number that stays with a person for the life of the system.","example":"7713248626"}}}}}},"persons":{"type":"array","items":{"type":"object","properties":{"personId":{"type":"string","maxLength":10,"description":"Person ID is a system-assigned random number that stays with a person for the life of the system.","example":"7713248626"},"externalId":{"type":"string","maxLength":60,"description":"External Party ID in a CX/CRM application","example":"CDRM_952287"}}}}},"xml":{"name":"X1BUSPERSRCH"}},"BUSINESSPERSONSEARCH_response":{"type":"object","properties":{"filter":{"type":"object","properties":{"accountId":{"type":"string","maxLength":10,"description":"Account ID"},"premiseAddress":{"type":"string","maxLength":150,"description":"Address"},"restrictToPersons":{"type":"array","items":{"type":"object","properties":{"externalId":{"type":"string","maxLength":60,"description":"External Party ID in a CX/CRM application","example":"CDRM_952287"},"personId":{"type":"string","maxLength":10,"description":"Person ID is a system-assigned random number that stays with a person for the life of the system.","example":"7713248626"}}}}}},"persons":{"type":"array","items":{"type":"object","properties":{"personId":{"type":"string","maxLength":10,"description":"Person ID is a system-assigned random number that stays with a person for the life of the system.","example":"7713248626"},"externalId":{"type":"string","maxLength":60,"description":"External Party ID in a CX/CRM application","example":"CDRM_952287"}}}}},"xml":{"name":"X1BUSPERSRCH"}},"DELETEUSAGESUBSCRIPTION_response":{"type":"object","properties":{"usageSubscriptionId":{"type":"string","maxLength":12,"description":"Usage Subscription ID is a system assigned random number that stays with a usage subscription record.","example":"543722442966"}},"xml":{"name":"D1-DeleteUS"}},"GETUSAGESUBSCRIPTION_response":{"type":"object","properties":{"_self":{"type":"string","description":"_self"},"usageSubscriptionId":{"type":"string","maxLength":12,"description":"Usage Subscription ID is a system assigned random number that stays with a usage subscription record.","example":"543722442966"},"usageSubscriptionType":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"usageSubscriptionType":{"type":"string","maxLength":30,"description":"Usage Subscription Type"}}},"status":{"type":"string","maxLength":12,"description":"The current status of usage subscription.","example":"Active"},"masterUsageSubscription":{"type":"string","maxLength":12,"description":"\"Master\" and \"sub\" usage subscriptions allow for hierarchical relationships between usage subscription to represent situations where a subscription is a subordinate to another usage subscription (such as when a utility is issuing a bill for a third-party service)."},"creationDateTime":{"type":"string","format":"date-time","description":"Create Date/Time","example":"2015-12-18T16:08:26-08:00"},"statusDateTime":{"type":"string","format":"date-time","description":"Status Date/Time","example":"2015-12-18T16:08:26-08:00"},"startDateTime":{"type":"string","format":"date-time","description":"The start and end times that define the time period during which the usage subscription is active.","example":"2014-01-01T00:00:00-08:00"},"endDateTime":{"type":"string","format":"date-time","description":"The start and end times that define the time period during which the usage subscription is active."},"division":{"type":"string","maxLength":30,"description":"Divisions are used to delineate between different operating companies within a large conglomerate of utilities.","example":"CA"},"accessGroup":{"type":"string","maxLength":12,"description":"Access Group"},"mostRecentUsageTransactionDateTime":{"type":"string","format":"date-time","description":"Most Recent Transaction Date/Time"},"usageRecipient":{"type":"string","maxLength":30,"description":"The service provider is used as the identity of the subscribing system."},"usageApprovalRequired":{"type":"string","enum":["D1NR","D1RQ"],"description":"A flag that indicates if usage must be approved before being sent to the recipient.\n* `D1NR` - Not Required,\n* `D1RQ` - Required","example":"D1NR"},"externalId":{"type":"string","maxLength":60,"description":"ID used in an external application identify the usage subscription.","example":"22132634-01-KMUS"},"externalAccountId":{"type":"string","maxLength":30,"description":"ID used in an external application identify the usage subscription.","example":"22132634-15-KMUS"},"mainContact":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"mainContactId":{"type":"string","maxLength":12,"description":"Contact ID"}}},"timeZone":{"type":"string","maxLength":10,"description":"The time zone in which the usage subscription is active.","example":"USPACIFIC"},"usageSubscriptionMarketParticipant":{"type":"string","maxLength":12,"description":"Defines the Usage Subscription Market Participant associated with the child Usage Subscription."},"comments":{"type":"string","maxLength":254,"description":"Comments"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks","example":"5"},"servicePoints":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"servicePoint":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"servicePointId":{"type":"string","maxLength":12,"description":"Service Point ID"}}},"startDateTime":{"type":"string","format":"date-time","description":"The start and end times that define the time period during which the usage subscription is active.","example":"2014-01-01T00:00:00-08:00"},"overrideStartDateTime":{"type":"string","format":"date-time","description":"An override date and time used to specify the start date and time when identifying measurements used to calculate usage for the usage subscription. If not specified, the Start Date/Time is used."},"stopDateTime":{"type":"string","format":"date-time","description":"The stop date and time of the relationship between the usage subscription and the service point. All measurements used calculate usage for the usage subscription should have a stop date/time before than this date and time."},"overrideStopDateTime":{"type":"string","format":"date-time","description":"An override date and time used to specify the stop date time when identifying measurements used to calculate usage for the usage subscription. If not specified, the Stop Date/Time is used."},"usage":{"type":"string","enum":["D1AD","D1CK","D1ST"],"description":"A flag that indicates how the consumption from this service point is used when calculating usage for the usage subscription.\n* `D1AD` - Add,\n* `D1CK` - Exclude,\n* `D1ST` - Subtract","example":"D1AD"},"usePercent":{"type":"number","maximum":999,"minimum":-999,"description":"The percentage of consumption from this service point that should be used when calculating usage for the usage subscription.","example":"100"}}}}}},"factorOverrides":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"factor":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"factor":{"type":"string","maxLength":30,"description":"Factor"}}},"startDateTime":{"type":"string","format":"date-time","description":"The start and end times that define the time period during which the usage subscription is active.","example":"2014-01-01T00:00:00-08:00"},"endDateTime":{"type":"string","format":"date-time","description":"The start and end times that define the time period during which the usage subscription is active."},"value":{"type":"number","maximum":100000000000,"minimum":-100000000000,"description":"If the factor has a value defined on the usage subscription, this value is used instead of the value from the factor tables.","example":"20"}}}}}},"usageCalculationGroups":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"calculationGroup":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"calculationGroup":{"type":"string","maxLength":30,"description":"Calculation Group"}}},"effectiveDateTime":{"type":"string","format":"date-time","description":"Effective Date/Time for calculation groups.","example":"2014-01-01T00:00:00-08:00"},"expirationDateTime":{"type":"string","format":"date-time","description":"Expiration date and time for calculation groups.","example":"2011-02-10T00:00:00-08:00"}}}}}},"fallbackUsageCalculationGroups":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"effectiveDate":{"type":"string","format":"date","description":"Effective Date"},"calculationGroup":{"type":"string","maxLength":30,"description":"Calculation Group"}}}}}},"rateHistory":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"effectiveDate":{"type":"string","format":"date","description":"Effective Date"},"rate":{"type":"string","maxLength":30,"description":"Rate"}}}}}},"measuringComponents":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"relationshipType":{"type":"string","enum":["D2CA","D2SR","ZZAA","ZZBR","ZZM1","ZZM2","ZZM3","ZZM4","ZZM5","ZZS1","ZZS2","ZZSE","ZZSI","ZZSM","ZZZL"],"description":"The type of relationship between the usage subscription and the measuring component.\n* `D2CA` - Consumption Aggregator,\n* `D2SR` - Standalone Data Request,\n* `ZZAA` - Consumption Verification,\n* `ZZBR` - Component Relationship Type,\n* `ZZM1` - MC Relationship Type 1,\n* `ZZM2` - MC Relationship Type 2,\n* `ZZM3` - MC Relationship Type 3,\n* `ZZM4` - MC Relationship Type 4,\n* `ZZM5` - MC Relationship Type 5,\n* `ZZS1` - Standalone 1,\n* `ZZS2` - Standalone 2,\n* `ZZSE` - Self Scheduler External,\n* `ZZSI` - Self Scheduler Interval,\n* `ZZSM` - Self Scheduler Market,\n* `ZZZL` - Market Zonal Load","example":"D2CA"},"measuringComponent":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"measuringComponentId":{"type":"string","maxLength":12,"description":"Measuring Component ID"}}}}}}}},"dynamicOptions":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"dynamicOption":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"dynamicOptionId":{"type":"string","maxLength":12,"description":"Dynamic Option ID"}}},"effectiveDateTime":{"type":"string","format":"date-time","description":"Effective Date/Time for calculation groups.","example":"2014-01-01T00:00:00-08:00"},"expirationDateTime":{"type":"string","format":"date-time","description":"Expiration date and time for calculation groups.","example":"2011-02-10T00:00:00-08:00"},"dynamicOptionOverrides":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"dynamicOptionEvent":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"dynamicOptionEventId":{"type":"string","maxLength":14,"description":"Dynamic Option Event ID"}}},"overrideDateTime":{"type":"string","format":"date-time","description":"Override Date/Time for dynamic option overrides.","example":"2014-01-01T00:00:00-08:00"},"status":{"type":"string","enum":["D1AC","D1IN"],"description":"Dynamic option overrides with an override status set to \"Active\" that needs to be excluded from the calculation.\n* `D1AC` - Active,\n* `D1IN` - Inactive","example":"D1AC"}}}}}}}}}}},"characteristics":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"effectiveDate":{"type":"string","format":"date","description":"Effective Date Indicate the effective date of the characteristic type and value. The service point's install date defaults.","example":"2017-10-02"},"characteristicType":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"characteristicType":{"type":"string","maxLength":8,"description":"Characteristic Type"}}},"typeOfCharacteristicValue":{"type":"string","maxLength":4,"description":"Type of Characteristic Value indicates whether the characteristic type value is Adhoc, Predefined, Foreign Key, or a File/URL Location.","example":"111"},"characteristicValue":{"type":"object","properties":{"_link":{"type":"string","description":"(_link)"},"value":{"type":"string","description":"(value)"},"value2":{"type":"string","description":"(value2)"},"value3":{"type":"string","description":"(value3)"},"value4":{"type":"string","description":"(value4)"},"value5":{"type":"string","description":"(value5)"}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks","example":"5"}}}}}}},"xml":{"name":"D1-UsageSubs"}},"CREATEUSAGESUBSCRIPTION_request":{"type":"object","properties":{"usageSubscriptionId":{"type":"string","maxLength":12,"description":"Usage Subscription ID is a system assigned random number that stays with a usage subscription record.","example":"543722442966"},"usageSubscriptionType":{"type":"object","properties":{"usageSubscriptionType":{"type":"string","maxLength":30,"description":"Usage Subscription Type"}}},"status":{"type":"string","maxLength":12,"description":"The current status of usage subscription.","example":"Active"},"masterUsageSubscription":{"type":"string","maxLength":12,"description":"\"Master\" and \"sub\" usage subscriptions allow for hierarchical relationships between usage subscription to represent situations where a subscription is a subordinate to another usage subscription (such as when a utility is issuing a bill for a third-party service)."},"creationDateTime":{"type":"string","format":"date-time","description":"Create Date/Time","example":"2015-12-18T16:08:26-08:00"},"statusDateTime":{"type":"string","format":"date-time","description":"Status Date/Time","example":"2015-12-18T16:08:26-08:00"},"startDateTime":{"type":"string","format":"date-time","description":"The start and end times that define the time period during which the usage subscription is active.","example":"2014-01-01T00:00:00-08:00"},"endDateTime":{"type":"string","format":"date-time","description":"The start and end times that define the time period during which the usage subscription is active."},"division":{"type":"string","maxLength":30,"description":"Divisions are used to delineate between different operating companies within a large conglomerate of utilities.","example":"CA"},"accessGroup":{"type":"string","maxLength":12,"description":"Access Group"},"mostRecentUsageTransactionDateTime":{"type":"string","format":"date-time","description":"Most Recent Transaction Date/Time"},"usageRecipient":{"type":"string","maxLength":30,"description":"The service provider is used as the identity of the subscribing system."},"usageApprovalRequired":{"type":"string","enum":["D1NR","D1RQ"],"description":"A flag that indicates if usage must be approved before being sent to the recipient.\n* `D1NR` - Not Required,\n* `D1RQ` - Required","example":"D1NR"},"externalId":{"type":"string","maxLength":60,"description":"ID used in an external application identify the usage subscription.","example":"22132634-01-KMUS"},"externalAccountId":{"type":"string","maxLength":30,"description":"ID used in an external application identify the usage subscription.","example":"22132634-15-KMUS"},"mainContact":{"type":"object","properties":{"mainContactId":{"type":"string","maxLength":12,"description":"Contact ID"}}},"timeZone":{"type":"string","maxLength":10,"description":"The time zone in which the usage subscription is active.","example":"USPACIFIC"},"usageSubscriptionMarketParticipant":{"type":"string","maxLength":12,"description":"Defines the Usage Subscription Market Participant associated with the child Usage Subscription."},"comments":{"type":"string","maxLength":254,"description":"Comments"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks","example":"5"},"servicePoints":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"servicePoint":{"type":"object","properties":{"servicePointId":{"type":"string","maxLength":12,"description":"Service Point ID"}}},"startDateTime":{"type":"string","format":"date-time","description":"The start and end times that define the time period during which the usage subscription is active.","example":"2014-01-01T00:00:00-08:00"},"overrideStartDateTime":{"type":"string","format":"date-time","description":"An override date and time used to specify the start date and time when identifying measurements used to calculate usage for the usage subscription. If not specified, the Start Date/Time is used."},"stopDateTime":{"type":"string","format":"date-time","description":"The stop date and time of the relationship between the usage subscription and the service point. All measurements used calculate usage for the usage subscription should have a stop date/time before than this date and time."},"overrideStopDateTime":{"type":"string","format":"date-time","description":"An override date and time used to specify the stop date time when identifying measurements used to calculate usage for the usage subscription. If not specified, the Stop Date/Time is used."},"usage":{"type":"string","enum":["D1AD","D1CK","D1ST"],"description":"A flag that indicates how the consumption from this service point is used when calculating usage for the usage subscription.\n* `D1AD` - Add,\n* `D1CK` - Exclude,\n* `D1ST` - Subtract","example":"D1AD"},"usePercent":{"type":"number","maximum":999,"minimum":-999,"description":"The percentage of consumption from this service point that should be used when calculating usage for the usage subscription.","example":"100"}}}}}},"factorOverrides":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"factor":{"type":"object","properties":{"factor":{"type":"string","maxLength":30,"description":"Factor"}}},"startDateTime":{"type":"string","format":"date-time","description":"The start and end times that define the time period during which the usage subscription is active.","example":"2014-01-01T00:00:00-08:00"},"endDateTime":{"type":"string","format":"date-time","description":"The start and end times that define the time period during which the usage subscription is active."},"value":{"type":"number","maximum":100000000000,"minimum":-100000000000,"description":"If the factor has a value defined on the usage subscription, this value is used instead of the value from the factor tables.","example":"20"}}}}}},"usageCalculationGroups":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"calculationGroup":{"type":"object","properties":{"calculationGroup":{"type":"string","maxLength":30,"description":"Calculation Group"}}},"effectiveDateTime":{"type":"string","format":"date-time","description":"Effective Date/Time for calculation groups.","example":"2014-01-01T00:00:00-08:00"},"expirationDateTime":{"type":"string","format":"date-time","description":"Expiration date and time for calculation groups.","example":"2011-02-10T00:00:00-08:00"}}}}}},"fallbackUsageCalculationGroups":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"effectiveDate":{"type":"string","format":"date","description":"Effective Date"},"calculationGroup":{"type":"string","maxLength":30,"description":"Calculation Group"}}}}}},"rateHistory":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"effectiveDate":{"type":"string","format":"date","description":"Effective Date"},"rate":{"type":"string","maxLength":30,"description":"Rate"}}}}}},"measuringComponents":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"relationshipType":{"type":"string","enum":["D2CA","D2SR","ZZAA","ZZBR","ZZM1","ZZM2","ZZM3","ZZM4","ZZM5","ZZS1","ZZS2","ZZSE","ZZSI","ZZSM","ZZZL"],"description":"The type of relationship between the usage subscription and the measuring component.\n* `D2CA` - Consumption Aggregator,\n* `D2SR` - Standalone Data Request,\n* `ZZAA` - Consumption Verification,\n* `ZZBR` - Component Relationship Type,\n* `ZZM1` - MC Relationship Type 1,\n* `ZZM2` - MC Relationship Type 2,\n* `ZZM3` - MC Relationship Type 3,\n* `ZZM4` - MC Relationship Type 4,\n* `ZZM5` - MC Relationship Type 5,\n* `ZZS1` - Standalone 1,\n* `ZZS2` - Standalone 2,\n* `ZZSE` - Self Scheduler External,\n* `ZZSI` - Self Scheduler Interval,\n* `ZZSM` - Self Scheduler Market,\n* `ZZZL` - Market Zonal Load","example":"D2CA"},"measuringComponent":{"type":"object","properties":{"measuringComponentId":{"type":"string","maxLength":12,"description":"Measuring Component ID"}}}}}}}},"dynamicOptions":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"dynamicOption":{"type":"object","properties":{"dynamicOptionId":{"type":"string","maxLength":12,"description":"Dynamic Option ID"}}},"effectiveDateTime":{"type":"string","format":"date-time","description":"Effective Date/Time for calculation groups.","example":"2014-01-01T00:00:00-08:00"},"expirationDateTime":{"type":"string","format":"date-time","description":"Expiration date and time for calculation groups.","example":"2011-02-10T00:00:00-08:00"},"dynamicOptionOverrides":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"dynamicOptionEvent":{"type":"object","properties":{"dynamicOptionEventId":{"type":"string","maxLength":14,"description":"Dynamic Option Event ID"}}},"overrideDateTime":{"type":"string","format":"date-time","description":"Override Date/Time for dynamic option overrides.","example":"2014-01-01T00:00:00-08:00"},"status":{"type":"string","enum":["D1AC","D1IN"],"description":"Dynamic option overrides with an override status set to \"Active\" that needs to be excluded from the calculation.\n* `D1AC` - Active,\n* `D1IN` - Inactive","example":"D1AC"}}}}}}}}}}}},"xml":{"name":"D1-UsageSubs"}},"CREATEUSAGESUBSCRIPTION_response":{"type":"object","properties":{"_self":{"type":"string","description":"_self"},"usageSubscriptionId":{"type":"string","maxLength":12,"description":"Usage Subscription ID is a system assigned random number that stays with a usage subscription record.","example":"543722442966"},"usageSubscriptionType":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"usageSubscriptionType":{"type":"string","maxLength":30,"description":"Usage Subscription Type"}}},"status":{"type":"string","maxLength":12,"description":"The current status of usage subscription.","example":"Active"},"masterUsageSubscription":{"type":"string","maxLength":12,"description":"\"Master\" and \"sub\" usage subscriptions allow for hierarchical relationships between usage subscription to represent situations where a subscription is a subordinate to another usage subscription (such as when a utility is issuing a bill for a third-party service)."},"creationDateTime":{"type":"string","format":"date-time","description":"Create Date/Time","example":"2015-12-18T16:08:26-08:00"},"statusDateTime":{"type":"string","format":"date-time","description":"Status Date/Time","example":"2015-12-18T16:08:26-08:00"},"startDateTime":{"type":"string","format":"date-time","description":"The start and end times that define the time period during which the usage subscription is active.","example":"2014-01-01T00:00:00-08:00"},"endDateTime":{"type":"string","format":"date-time","description":"The start and end times that define the time period during which the usage subscription is active."},"division":{"type":"string","maxLength":30,"description":"Divisions are used to delineate between different operating companies within a large conglomerate of utilities.","example":"CA"},"accessGroup":{"type":"string","maxLength":12,"description":"Access Group"},"mostRecentUsageTransactionDateTime":{"type":"string","format":"date-time","description":"Most Recent Transaction Date/Time"},"usageRecipient":{"type":"string","maxLength":30,"description":"The service provider is used as the identity of the subscribing system."},"usageApprovalRequired":{"type":"string","enum":["D1NR","D1RQ"],"description":"A flag that indicates if usage must be approved before being sent to the recipient.\n* `D1NR` - Not Required,\n* `D1RQ` - Required","example":"D1NR"},"externalId":{"type":"string","maxLength":60,"description":"ID used in an external application identify the usage subscription.","example":"22132634-01-KMUS"},"externalAccountId":{"type":"string","maxLength":30,"description":"ID used in an external application identify the usage subscription.","example":"22132634-15-KMUS"},"mainContact":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"mainContactId":{"type":"string","maxLength":12,"description":"Contact ID"}}},"timeZone":{"type":"string","maxLength":10,"description":"The time zone in which the usage subscription is active.","example":"USPACIFIC"},"usageSubscriptionMarketParticipant":{"type":"string","maxLength":12,"description":"Defines the Usage Subscription Market Participant associated with the child Usage Subscription."},"comments":{"type":"string","maxLength":254,"description":"Comments"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks","example":"5"},"servicePoints":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"servicePoint":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"servicePointId":{"type":"string","maxLength":12,"description":"Service Point ID"}}},"startDateTime":{"type":"string","format":"date-time","description":"The start and end times that define the time period during which the usage subscription is active.","example":"2014-01-01T00:00:00-08:00"},"overrideStartDateTime":{"type":"string","format":"date-time","description":"An override date and time used to specify the start date and time when identifying measurements used to calculate usage for the usage subscription. If not specified, the Start Date/Time is used."},"stopDateTime":{"type":"string","format":"date-time","description":"The stop date and time of the relationship between the usage subscription and the service point. All measurements used calculate usage for the usage subscription should have a stop date/time before than this date and time."},"overrideStopDateTime":{"type":"string","format":"date-time","description":"An override date and time used to specify the stop date time when identifying measurements used to calculate usage for the usage subscription. If not specified, the Stop Date/Time is used."},"usage":{"type":"string","enum":["D1AD","D1CK","D1ST"],"description":"A flag that indicates how the consumption from this service point is used when calculating usage for the usage subscription.\n* `D1AD` - Add,\n* `D1CK` - Exclude,\n* `D1ST` - Subtract","example":"D1AD"},"usePercent":{"type":"number","maximum":999,"minimum":-999,"description":"The percentage of consumption from this service point that should be used when calculating usage for the usage subscription.","example":"100"}}}}}},"factorOverrides":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"factor":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"factor":{"type":"string","maxLength":30,"description":"Factor"}}},"startDateTime":{"type":"string","format":"date-time","description":"The start and end times that define the time period during which the usage subscription is active.","example":"2014-01-01T00:00:00-08:00"},"endDateTime":{"type":"string","format":"date-time","description":"The start and end times that define the time period during which the usage subscription is active."},"value":{"type":"number","maximum":100000000000,"minimum":-100000000000,"description":"If the factor has a value defined on the usage subscription, this value is used instead of the value from the factor tables.","example":"20"}}}}}},"usageCalculationGroups":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"calculationGroup":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"calculationGroup":{"type":"string","maxLength":30,"description":"Calculation Group"}}},"effectiveDateTime":{"type":"string","format":"date-time","description":"Effective Date/Time for calculation groups.","example":"2014-01-01T00:00:00-08:00"},"expirationDateTime":{"type":"string","format":"date-time","description":"Expiration date and time for calculation groups.","example":"2011-02-10T00:00:00-08:00"}}}}}},"fallbackUsageCalculationGroups":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"effectiveDate":{"type":"string","format":"date","description":"Effective Date"},"calculationGroup":{"type":"string","maxLength":30,"description":"Calculation Group"}}}}}},"rateHistory":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"effectiveDate":{"type":"string","format":"date","description":"Effective Date"},"rate":{"type":"string","maxLength":30,"description":"Rate"}}}}}},"measuringComponents":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"relationshipType":{"type":"string","enum":["D2CA","D2SR","ZZAA","ZZBR","ZZM1","ZZM2","ZZM3","ZZM4","ZZM5","ZZS1","ZZS2","ZZSE","ZZSI","ZZSM","ZZZL"],"description":"The type of relationship between the usage subscription and the measuring component.\n* `D2CA` - Consumption Aggregator,\n* `D2SR` - Standalone Data Request,\n* `ZZAA` - Consumption Verification,\n* `ZZBR` - Component Relationship Type,\n* `ZZM1` - MC Relationship Type 1,\n* `ZZM2` - MC Relationship Type 2,\n* `ZZM3` - MC Relationship Type 3,\n* `ZZM4` - MC Relationship Type 4,\n* `ZZM5` - MC Relationship Type 5,\n* `ZZS1` - Standalone 1,\n* `ZZS2` - Standalone 2,\n* `ZZSE` - Self Scheduler External,\n* `ZZSI` - Self Scheduler Interval,\n* `ZZSM` - Self Scheduler Market,\n* `ZZZL` - Market Zonal Load","example":"D2CA"},"measuringComponent":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"measuringComponentId":{"type":"string","maxLength":12,"description":"Measuring Component ID"}}}}}}}},"dynamicOptions":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"dynamicOption":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"dynamicOptionId":{"type":"string","maxLength":12,"description":"Dynamic Option ID"}}},"effectiveDateTime":{"type":"string","format":"date-time","description":"Effective Date/Time for calculation groups.","example":"2014-01-01T00:00:00-08:00"},"expirationDateTime":{"type":"string","format":"date-time","description":"Expiration date and time for calculation groups.","example":"2011-02-10T00:00:00-08:00"},"dynamicOptionOverrides":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"dynamicOptionEvent":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"dynamicOptionEventId":{"type":"string","maxLength":14,"description":"Dynamic Option Event ID"}}},"overrideDateTime":{"type":"string","format":"date-time","description":"Override Date/Time for dynamic option overrides.","example":"2014-01-01T00:00:00-08:00"},"status":{"type":"string","enum":["D1AC","D1IN"],"description":"Dynamic option overrides with an override status set to \"Active\" that needs to be excluded from the calculation.\n* `D1AC` - Active,\n* `D1IN` - Inactive","example":"D1AC"}}}}}}}}}}}},"xml":{"name":"D1-UsageSubs"}},"DELETEUSAGESUBSCRIPTION_request":{"type":"object","properties":{"usageSubscriptionId":{"type":"string","maxLength":12,"description":"Usage Subscription ID is a system assigned random number that stays with a usage subscription record.","example":"543722442966"}},"xml":{"name":"D1-DeleteUS"}},"UPDATEUSAGESUBSCRIPTION_response":{"type":"object","properties":{"_self":{"type":"string","description":"_self"},"usageSubscriptionId":{"type":"string","maxLength":12,"description":"Usage Subscription ID is a system assigned random number that stays with a usage subscription record.","example":"543722442966"},"usageSubscriptionType":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"usageSubscriptionType":{"type":"string","maxLength":30,"description":"Usage Subscription Type"}}},"status":{"type":"string","maxLength":12,"description":"The current status of usage subscription.","example":"Active"},"masterUsageSubscription":{"type":"string","maxLength":12,"description":"\"Master\" and \"sub\" usage subscriptions allow for hierarchical relationships between usage subscription to represent situations where a subscription is a subordinate to another usage subscription (such as when a utility is issuing a bill for a third-party service)."},"creationDateTime":{"type":"string","format":"date-time","description":"Create Date/Time","example":"2015-12-18T16:08:26-08:00"},"statusDateTime":{"type":"string","format":"date-time","description":"Status Date/Time","example":"2015-12-18T16:08:26-08:00"},"startDateTime":{"type":"string","format":"date-time","description":"The start and end times that define the time period during which the usage subscription is active.","example":"2014-01-01T00:00:00-08:00"},"endDateTime":{"type":"string","format":"date-time","description":"The start and end times that define the time period during which the usage subscription is active."},"division":{"type":"string","maxLength":30,"description":"Divisions are used to delineate between different operating companies within a large conglomerate of utilities.","example":"CA"},"accessGroup":{"type":"string","maxLength":12,"description":"Access Group"},"mostRecentUsageTransactionDateTime":{"type":"string","format":"date-time","description":"Most Recent Transaction Date/Time"},"usageRecipient":{"type":"string","maxLength":30,"description":"The service provider is used as the identity of the subscribing system."},"usageApprovalRequired":{"type":"string","enum":["D1NR","D1RQ"],"description":"A flag that indicates if usage must be approved before being sent to the recipient.\n* `D1NR` - Not Required,\n* `D1RQ` - Required","example":"D1NR"},"externalId":{"type":"string","maxLength":60,"description":"ID used in an external application identify the usage subscription.","example":"22132634-01-KMUS"},"externalAccountId":{"type":"string","maxLength":30,"description":"ID used in an external application identify the usage subscription.","example":"22132634-15-KMUS"},"mainContact":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"mainContactId":{"type":"string","maxLength":12,"description":"Contact ID"}}},"timeZone":{"type":"string","maxLength":10,"description":"The time zone in which the usage subscription is active.","example":"USPACIFIC"},"usageSubscriptionMarketParticipant":{"type":"string","maxLength":12,"description":"Defines the Usage Subscription Market Participant associated with the child Usage Subscription."},"comments":{"type":"string","maxLength":254,"description":"Comments"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks","example":"5"},"servicePoints":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"servicePoint":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"servicePointId":{"type":"string","maxLength":12,"description":"Service Point ID"}}},"startDateTime":{"type":"string","format":"date-time","description":"The start and end times that define the time period during which the usage subscription is active.","example":"2014-01-01T00:00:00-08:00"},"overrideStartDateTime":{"type":"string","format":"date-time","description":"An override date and time used to specify the start date and time when identifying measurements used to calculate usage for the usage subscription. If not specified, the Start Date/Time is used."},"stopDateTime":{"type":"string","format":"date-time","description":"The stop date and time of the relationship between the usage subscription and the service point. All measurements used calculate usage for the usage subscription should have a stop date/time before than this date and time."},"overrideStopDateTime":{"type":"string","format":"date-time","description":"An override date and time used to specify the stop date time when identifying measurements used to calculate usage for the usage subscription. If not specified, the Stop Date/Time is used."},"usage":{"type":"string","enum":["D1AD","D1CK","D1ST"],"description":"A flag that indicates how the consumption from this service point is used when calculating usage for the usage subscription.\n* `D1AD` - Add,\n* `D1CK` - Exclude,\n* `D1ST` - Subtract","example":"D1AD"},"usePercent":{"type":"number","maximum":999,"minimum":-999,"description":"The percentage of consumption from this service point that should be used when calculating usage for the usage subscription.","example":"100"}}}}}},"factorOverrides":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"factor":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"factor":{"type":"string","maxLength":30,"description":"Factor"}}},"startDateTime":{"type":"string","format":"date-time","description":"The start and end times that define the time period during which the usage subscription is active.","example":"2014-01-01T00:00:00-08:00"},"endDateTime":{"type":"string","format":"date-time","description":"The start and end times that define the time period during which the usage subscription is active."},"value":{"type":"number","maximum":100000000000,"minimum":-100000000000,"description":"If the factor has a value defined on the usage subscription, this value is used instead of the value from the factor tables.","example":"20"}}}}}},"usageCalculationGroups":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"calculationGroup":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"calculationGroup":{"type":"string","maxLength":30,"description":"Calculation Group"}}},"effectiveDateTime":{"type":"string","format":"date-time","description":"Effective Date/Time for calculation groups.","example":"2014-01-01T00:00:00-08:00"},"expirationDateTime":{"type":"string","format":"date-time","description":"Expiration date and time for calculation groups.","example":"2011-02-10T00:00:00-08:00"}}}}}},"fallbackUsageCalculationGroups":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"effectiveDate":{"type":"string","format":"date","description":"Effective Date"},"calculationGroup":{"type":"string","maxLength":30,"description":"Calculation Group"}}}}}},"rateHistory":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"effectiveDate":{"type":"string","format":"date","description":"Effective Date"},"rate":{"type":"string","maxLength":30,"description":"Rate"}}}}}},"measuringComponents":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"relationshipType":{"type":"string","enum":["D2CA","D2SR","ZZAA","ZZBR","ZZM1","ZZM2","ZZM3","ZZM4","ZZM5","ZZS1","ZZS2","ZZSE","ZZSI","ZZSM","ZZZL"],"description":"The type of relationship between the usage subscription and the measuring component.\n* `D2CA` - Consumption Aggregator,\n* `D2SR` - Standalone Data Request,\n* `ZZAA` - Consumption Verification,\n* `ZZBR` - Component Relationship Type,\n* `ZZM1` - MC Relationship Type 1,\n* `ZZM2` - MC Relationship Type 2,\n* `ZZM3` - MC Relationship Type 3,\n* `ZZM4` - MC Relationship Type 4,\n* `ZZM5` - MC Relationship Type 5,\n* `ZZS1` - Standalone 1,\n* `ZZS2` - Standalone 2,\n* `ZZSE` - Self Scheduler External,\n* `ZZSI` - Self Scheduler Interval,\n* `ZZSM` - Self Scheduler Market,\n* `ZZZL` - Market Zonal Load","example":"D2CA"},"measuringComponent":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"measuringComponentId":{"type":"string","maxLength":12,"description":"Measuring Component ID"}}}}}}}},"dynamicOptions":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"dynamicOption":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"dynamicOptionId":{"type":"string","maxLength":12,"description":"Dynamic Option ID"}}},"effectiveDateTime":{"type":"string","format":"date-time","description":"Effective Date/Time for calculation groups.","example":"2014-01-01T00:00:00-08:00"},"expirationDateTime":{"type":"string","format":"date-time","description":"Expiration date and time for calculation groups.","example":"2011-02-10T00:00:00-08:00"},"dynamicOptionOverrides":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"dynamicOptionEvent":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"dynamicOptionEventId":{"type":"string","maxLength":14,"description":"Dynamic Option Event ID"}}},"overrideDateTime":{"type":"string","format":"date-time","description":"Override Date/Time for dynamic option overrides.","example":"2014-01-01T00:00:00-08:00"},"status":{"type":"string","enum":["D1AC","D1IN"],"description":"Dynamic option overrides with an override status set to \"Active\" that needs to be excluded from the calculation.\n* `D1AC` - Active,\n* `D1IN` - Inactive","example":"D1AC"}}}}}}}}}}}},"xml":{"name":"D1-UsageSubs"}},"UPDATEUSAGESUBSCRIPTION_request":{"type":"object","properties":{"usageSubscriptionId":{"type":"string","maxLength":12,"description":"Usage Subscription ID is a system assigned random number that stays with a usage subscription record.","example":"543722442966"},"usageSubscriptionType":{"type":"object","properties":{"usageSubscriptionType":{"type":"string","maxLength":30,"description":"Usage Subscription Type"}}},"status":{"type":"string","maxLength":12,"description":"The current status of usage subscription.","example":"Active"},"masterUsageSubscription":{"type":"string","maxLength":12,"description":"\"Master\" and \"sub\" usage subscriptions allow for hierarchical relationships between usage subscription to represent situations where a subscription is a subordinate to another usage subscription (such as when a utility is issuing a bill for a third-party service)."},"creationDateTime":{"type":"string","format":"date-time","description":"Create Date/Time","example":"2015-12-18T16:08:26-08:00"},"statusDateTime":{"type":"string","format":"date-time","description":"Status Date/Time","example":"2015-12-18T16:08:26-08:00"},"startDateTime":{"type":"string","format":"date-time","description":"The start and end times that define the time period during which the usage subscription is active.","example":"2014-01-01T00:00:00-08:00"},"endDateTime":{"type":"string","format":"date-time","description":"The start and end times that define the time period during which the usage subscription is active."},"division":{"type":"string","maxLength":30,"description":"Divisions are used to delineate between different operating companies within a large conglomerate of utilities.","example":"CA"},"accessGroup":{"type":"string","maxLength":12,"description":"Access Group"},"mostRecentUsageTransactionDateTime":{"type":"string","format":"date-time","description":"Most Recent Transaction Date/Time"},"usageRecipient":{"type":"string","maxLength":30,"description":"The service provider is used as the identity of the subscribing system."},"usageApprovalRequired":{"type":"string","enum":["D1NR","D1RQ"],"description":"A flag that indicates if usage must be approved before being sent to the recipient.\n* `D1NR` - Not Required,\n* `D1RQ` - Required","example":"D1NR"},"externalId":{"type":"string","maxLength":60,"description":"ID used in an external application identify the usage subscription.","example":"22132634-01-KMUS"},"externalAccountId":{"type":"string","maxLength":30,"description":"ID used in an external application identify the usage subscription.","example":"22132634-15-KMUS"},"mainContact":{"type":"object","properties":{"mainContactId":{"type":"string","maxLength":12,"description":"Contact ID"}}},"timeZone":{"type":"string","maxLength":10,"description":"The time zone in which the usage subscription is active.","example":"USPACIFIC"},"usageSubscriptionMarketParticipant":{"type":"string","maxLength":12,"description":"Defines the Usage Subscription Market Participant associated with the child Usage Subscription."},"comments":{"type":"string","maxLength":254,"description":"Comments"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks","example":"5"},"servicePoints":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"servicePoint":{"type":"object","properties":{"servicePointId":{"type":"string","maxLength":12,"description":"Service Point ID"}}},"startDateTime":{"type":"string","format":"date-time","description":"The start and end times that define the time period during which the usage subscription is active.","example":"2014-01-01T00:00:00-08:00"},"overrideStartDateTime":{"type":"string","format":"date-time","description":"An override date and time used to specify the start date and time when identifying measurements used to calculate usage for the usage subscription. If not specified, the Start Date/Time is used."},"stopDateTime":{"type":"string","format":"date-time","description":"The stop date and time of the relationship between the usage subscription and the service point. All measurements used calculate usage for the usage subscription should have a stop date/time before than this date and time."},"overrideStopDateTime":{"type":"string","format":"date-time","description":"An override date and time used to specify the stop date time when identifying measurements used to calculate usage for the usage subscription. If not specified, the Stop Date/Time is used."},"usage":{"type":"string","enum":["D1AD","D1CK","D1ST"],"description":"A flag that indicates how the consumption from this service point is used when calculating usage for the usage subscription.\n* `D1AD` - Add,\n* `D1CK` - Exclude,\n* `D1ST` - Subtract","example":"D1AD"},"usePercent":{"type":"number","maximum":999,"minimum":-999,"description":"The percentage of consumption from this service point that should be used when calculating usage for the usage subscription.","example":"100"}}}}}},"factorOverrides":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"factor":{"type":"object","properties":{"factor":{"type":"string","maxLength":30,"description":"Factor"}}},"startDateTime":{"type":"string","format":"date-time","description":"The start and end times that define the time period during which the usage subscription is active.","example":"2014-01-01T00:00:00-08:00"},"endDateTime":{"type":"string","format":"date-time","description":"The start and end times that define the time period during which the usage subscription is active."},"value":{"type":"number","maximum":100000000000,"minimum":-100000000000,"description":"If the factor has a value defined on the usage subscription, this value is used instead of the value from the factor tables.","example":"20"}}}}}},"usageCalculationGroups":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"calculationGroup":{"type":"object","properties":{"calculationGroup":{"type":"string","maxLength":30,"description":"Calculation Group"}}},"effectiveDateTime":{"type":"string","format":"date-time","description":"Effective Date/Time for calculation groups.","example":"2014-01-01T00:00:00-08:00"},"expirationDateTime":{"type":"string","format":"date-time","description":"Expiration date and time for calculation groups.","example":"2011-02-10T00:00:00-08:00"}}}}}},"fallbackUsageCalculationGroups":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"effectiveDate":{"type":"string","format":"date","description":"Effective Date"},"calculationGroup":{"type":"string","maxLength":30,"description":"Calculation Group"}}}}}},"rateHistory":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"effectiveDate":{"type":"string","format":"date","description":"Effective Date"},"rate":{"type":"string","maxLength":30,"description":"Rate"}}}}}},"measuringComponents":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"relationshipType":{"type":"string","enum":["D2CA","D2SR","ZZAA","ZZBR","ZZM1","ZZM2","ZZM3","ZZM4","ZZM5","ZZS1","ZZS2","ZZSE","ZZSI","ZZSM","ZZZL"],"description":"The type of relationship between the usage subscription and the measuring component.\n* `D2CA` - Consumption Aggregator,\n* `D2SR` - Standalone Data Request,\n* `ZZAA` - Consumption Verification,\n* `ZZBR` - Component Relationship Type,\n* `ZZM1` - MC Relationship Type 1,\n* `ZZM2` - MC Relationship Type 2,\n* `ZZM3` - MC Relationship Type 3,\n* `ZZM4` - MC Relationship Type 4,\n* `ZZM5` - MC Relationship Type 5,\n* `ZZS1` - Standalone 1,\n* `ZZS2` - Standalone 2,\n* `ZZSE` - Self Scheduler External,\n* `ZZSI` - Self Scheduler Interval,\n* `ZZSM` - Self Scheduler Market,\n* `ZZZL` - Market Zonal Load","example":"D2CA"},"measuringComponent":{"type":"object","properties":{"measuringComponentId":{"type":"string","maxLength":12,"description":"Measuring Component ID"}}}}}}}},"dynamicOptions":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"dynamicOption":{"type":"object","properties":{"dynamicOptionId":{"type":"string","maxLength":12,"description":"Dynamic Option ID"}}},"effectiveDateTime":{"type":"string","format":"date-time","description":"Effective Date/Time for calculation groups.","example":"2014-01-01T00:00:00-08:00"},"expirationDateTime":{"type":"string","format":"date-time","description":"Expiration date and time for calculation groups.","example":"2011-02-10T00:00:00-08:00"},"dynamicOptionOverrides":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"dynamicOptionEvent":{"type":"object","properties":{"dynamicOptionEventId":{"type":"string","maxLength":14,"description":"Dynamic Option Event ID"}}},"overrideDateTime":{"type":"string","format":"date-time","description":"Override Date/Time for dynamic option overrides.","example":"2014-01-01T00:00:00-08:00"},"status":{"type":"string","enum":["D1AC","D1IN"],"description":"Dynamic option overrides with an override status set to \"Active\" that needs to be excluded from the calculation.\n* `D1AC` - Active,\n* `D1IN` - Inactive","example":"D1AC"}}}}}}}}}}}},"xml":{"name":"D1-UsageSubs"}},"UPDATEMEASURINGCOMPONENT_response":{"type":"object","properties":{"_self":{"type":"string","description":"_self"},"measuringComponentId":{"type":"string","maxLength":12,"description":"Measuring Component ID is a system assigned random number that stays with measuring component record.","example":"061924013788"},"measuringComponentType":{"type":"object","description":"Type of Measuring Component","properties":{"_link":{"type":"string","description":"_link"},"measuringComponentType":{"type":"string","maxLength":30,"description":"Type of Measuring Component","example":"MKA SMART KWH"}}},"deviceConfiguration":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"deviceConfigurationId":{"type":"string","maxLength":12,"description":"Device Configuration ID is a system assigned random number that stays with a device configuration record.","example":"959682277977"}}},"consumptionReferenceMC":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"consumptionReferenceMCId":{"type":"string","maxLength":12,"description":"Related scalar measuring component. Used when adjusting interval measurement data to an existing scalar measurement."}}},"businessObject":{"type":"string","maxLength":30,"description":"Business Object","example":"D1-IntervalChannel"},"howToUse":{"type":"string","enum":["+   ","-   ","C   ","P   "],"description":"How to Use indicates how the channel is used (additive, subtractive, peak, or check) when calculating usage.\n* `+   ` - Additive,\n* `-   ` - Subtractive,\n* `C   ` - Check,\n* `P   ` - Peak"},"numberOfDigitsLeft":{"type":"number","maximum":99999,"minimum":-99999,"description":"Number of digits left is the number of digits to the left of the decimal point that the reading can contain.","example":"3"},"numberOfDigitsRight":{"type":"number","maximum":99999,"minimum":-99999,"description":"Number of digits right is the number of digits to the right of the decimal point that the reading can contain.","example":"2"},"measuringComponentMultiplier":{"type":"number","maximum":999999.999999,"minimum":-999999.999999,"description":"The meter multiplier for the channel.","example":"1"},"readSequence":{"type":"number","maximum":99999,"minimum":-99999,"description":"Read Sequence","example":"0"},"creationDateTime":{"type":"string","format":"date-time","description":"Create Date/Time","example":"2011-04-20T09:03:54-07:00"},"mostRecentMeasurementDateTime":{"type":"string","format":"date-time","description":"This date/time corresponds to the final measurement with the latest measurement date/time that has been processed for this measuring component regardless of the final condition (i.e. quality)."},"fullScale":{"type":"number","maximum":100000000000,"minimum":-100000000000,"description":"Full Scale","example":"0E-7"},"mostRecentNonEstimatedMeasurementDateTime":{"type":"string","format":"date-time","description":"This date/time corresponds to the final measurement with the latest measurement date/time that has a final condition that is non-estimated."},"adjustLatestMeasurementDateTime":{"type":"string","format":"date-time","description":"Adjust Latest Measurement Date/Time"},"latestMeasurementDateTime":{"type":"string","format":"date-time","description":"Latest Measurement Date/Time"},"mostRecentMeasurementReadingCondition":{"type":"string","maxLength":6,"description":"Most Recent Measurement Reading Condition"},"mostRecentMeasurementReadingValue":{"type":"number","maximum":9999999999.999998,"minimum":0,"description":"Most Recent Measurement Reading Value","example":"0"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks.","example":"1"},"veeGroups":{"type":"object","properties":{"initialLoad":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"initialLoad":{"type":"string","maxLength":30,"description":"VEE Group"}}},"streamingInitialLoad":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"streamingInitialLoad":{"type":"string","maxLength":30,"description":"VEE Group"}}},"estimation":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"estimation":{"type":"string","maxLength":30,"description":"VEE Group"}}},"manualOverride":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"manualOverride":{"type":"string","maxLength":30,"description":"VEE Group"}}},"projection":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"projection":{"type":"string","maxLength":30,"description":"VEE Group"}}}}},"fallBackVeeGroups":{"type":"object","properties":{"initialLoad":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"initialLoad":{"type":"string","maxLength":30,"description":"VEE Group"}}},"streamingInitialLoad":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"streamingInitialLoad":{"type":"string","maxLength":30,"description":"VEE Group"}}},"estimation":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"estimation":{"type":"string","maxLength":30,"description":"VEE Group"}}},"manualOverride":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"manualOverride":{"type":"string","maxLength":30,"description":"VEE Group"}}},"projection":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"projection":{"type":"string","maxLength":30,"description":"VEE Group"}}}}}},"xml":{"name":"D1MeasuComp"}},"DELETEMEASURINGCOMPONENT_request":{"type":"object","properties":{"measuringComponentId":{"type":"string","maxLength":12,"description":"Measuring Component ID is a system assigned random number that stays with measuring component record.","example":"061924013788"}},"xml":{"name":"D1-DeleteMC"}},"GETMEASURINGCOMPONENT_response":{"type":"object","properties":{"_self":{"type":"string","description":"_self"},"measuringComponentId":{"type":"string","maxLength":12,"description":"Measuring Component ID is a system assigned random number that stays with measuring component record.","example":"061924013788"},"measuringComponentType":{"type":"object","description":"Type of Measuring Component","properties":{"_link":{"type":"string","description":"_link"},"measuringComponentType":{"type":"string","maxLength":30,"description":"Type of Measuring Component","example":"MKA SMART KWH"}}},"deviceConfiguration":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"deviceConfigurationId":{"type":"string","maxLength":12,"description":"Device Configuration ID is a system assigned random number that stays with a device configuration record.","example":"959682277977"}}},"consumptionReferenceMC":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"consumptionReferenceMCId":{"type":"string","maxLength":12,"description":"Related scalar measuring component. Used when adjusting interval measurement data to an existing scalar measurement."}}},"businessObject":{"type":"string","maxLength":30,"description":"Business Object","example":"D1-IntervalChannel"},"howToUse":{"type":"string","enum":["+   ","-   ","C   ","P   "],"description":"How to Use indicates how the channel is used (additive, subtractive, peak, or check) when calculating usage.\n* `+   ` - Additive,\n* `-   ` - Subtractive,\n* `C   ` - Check,\n* `P   ` - Peak"},"numberOfDigitsLeft":{"type":"number","maximum":99999,"minimum":-99999,"description":"Number of digits left is the number of digits to the left of the decimal point that the reading can contain.","example":"3"},"numberOfDigitsRight":{"type":"number","maximum":99999,"minimum":-99999,"description":"Number of digits right is the number of digits to the right of the decimal point that the reading can contain.","example":"2"},"measuringComponentMultiplier":{"type":"number","maximum":999999.999999,"minimum":-999999.999999,"description":"The meter multiplier for the channel.","example":"1"},"readSequence":{"type":"number","maximum":99999,"minimum":-99999,"description":"Read Sequence","example":"0"},"creationDateTime":{"type":"string","format":"date-time","description":"Create Date/Time","example":"2011-04-20T09:03:54-07:00"},"mostRecentMeasurementDateTime":{"type":"string","format":"date-time","description":"This date/time corresponds to the final measurement with the latest measurement date/time that has been processed for this measuring component regardless of the final condition (i.e. quality)."},"fullScale":{"type":"number","maximum":100000000000,"minimum":-100000000000,"description":"Full Scale","example":"0E-7"},"mostRecentNonEstimatedMeasurementDateTime":{"type":"string","format":"date-time","description":"This date/time corresponds to the final measurement with the latest measurement date/time that has a final condition that is non-estimated."},"adjustLatestMeasurementDateTime":{"type":"string","format":"date-time","description":"Adjust Latest Measurement Date/Time"},"latestMeasurementDateTime":{"type":"string","format":"date-time","description":"Latest Measurement Date/Time"},"mostRecentMeasurementReadingCondition":{"type":"string","maxLength":6,"description":"Most Recent Measurement Reading Condition"},"mostRecentMeasurementReadingValue":{"type":"number","maximum":9999999999.999998,"minimum":0,"description":"Most Recent Measurement Reading Value","example":"0"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks.","example":"1"},"veeGroups":{"type":"object","properties":{"initialLoad":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"initialLoad":{"type":"string","maxLength":30,"description":"VEE Group"}}},"streamingInitialLoad":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"streamingInitialLoad":{"type":"string","maxLength":30,"description":"VEE Group"}}},"estimation":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"estimation":{"type":"string","maxLength":30,"description":"VEE Group"}}},"manualOverride":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"manualOverride":{"type":"string","maxLength":30,"description":"VEE Group"}}},"projection":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"projection":{"type":"string","maxLength":30,"description":"VEE Group"}}}}},"fallBackVeeGroups":{"type":"object","properties":{"initialLoad":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"initialLoad":{"type":"string","maxLength":30,"description":"VEE Group"}}},"streamingInitialLoad":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"streamingInitialLoad":{"type":"string","maxLength":30,"description":"VEE Group"}}},"estimation":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"estimation":{"type":"string","maxLength":30,"description":"VEE Group"}}},"manualOverride":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"manualOverride":{"type":"string","maxLength":30,"description":"VEE Group"}}},"projection":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"projection":{"type":"string","maxLength":30,"description":"VEE Group"}}}}},"characteristics":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"effectiveDate":{"type":"string","format":"date","description":"Effective Date Indicate the effective date of the characteristic type and value. The service point's install date defaults.","example":"2021-01-01"},"characteristicType":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"characteristicType":{"type":"string","maxLength":8,"description":"Characteristic Type"}}},"typeOfCharacteristicValue":{"type":"string","maxLength":4,"description":"Type of Characteristic Value indicates whether the characteristic type value is Adhoc, Predefined, Foreign Key, or a File/URL Location.","example":"FKV"},"characteristicValue":{"type":"object","properties":{"_link":{"type":"string","description":"(_link)"},"value":{"type":"string","description":"(value)"},"value2":{"type":"string","description":"(value2)"},"value3":{"type":"string","description":"(value3)"},"value4":{"type":"string","description":"(value4)"},"value5":{"type":"string","description":"(value5)"}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks.","example":"1"}}}}}}},"xml":{"name":"D1MeasuComp"}},"UPDATEMEASURINGCOMPONENT_request":{"type":"object","properties":{"measuringComponentId":{"type":"string","maxLength":12,"description":"Measuring Component ID is a system assigned random number that stays with measuring component record.","example":"061924013788"},"measuringComponentType":{"type":"object","description":"Type of Measuring Component","properties":{"measuringComponentType":{"type":"string","maxLength":30,"description":"Type of Measuring Component","example":"MKA SMART KWH"}}},"deviceConfigurationId":{"type":"string","maxLength":12,"description":"Device Configuration ID is a system assigned random number that stays with a device configuration record.","example":"959682277977"},"consumptionReferenceMC":{"type":"object","properties":{"consumptionReferenceMCId":{"type":"string","maxLength":12,"description":"Related scalar measuring component. Used when adjusting interval measurement data to an existing scalar measurement."}}},"businessObject":{"type":"string","maxLength":30,"description":"Business Object","example":"D1-IntervalChannel"},"howToUse":{"type":"string","enum":["+   ","-   ","C   ","P   "],"description":"How to Use indicates how the channel is used (additive, subtractive, peak, or check) when calculating usage.\n* `+   ` - Additive,\n* `-   ` - Subtractive,\n* `C   ` - Check,\n* `P   ` - Peak"},"numberOfDigitsLeft":{"type":"number","maximum":99999,"minimum":-99999,"description":"Number of digits left is the number of digits to the left of the decimal point that the reading can contain.","example":"3"},"numberOfDigitsRight":{"type":"number","maximum":99999,"minimum":-99999,"description":"Number of digits right is the number of digits to the right of the decimal point that the reading can contain.","example":"2"},"measuringComponentMultiplier":{"type":"number","maximum":999999.999999,"minimum":-999999.999999,"description":"The meter multiplier for the channel.","example":"1"},"readSequence":{"type":"number","maximum":99999,"minimum":-99999,"description":"Read Sequence","example":"0"},"creationDateTime":{"type":"string","format":"date-time","description":"Create Date/Time","example":"2011-04-20T09:03:54-07:00"},"fullScale":{"type":"number","maximum":100000000000,"minimum":-100000000000,"description":"Full Scale","example":"0E-7"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks.","example":"1"},"veeGroups":{"type":"object","properties":{"initialLoad":{"type":"object","properties":{"initialLoad":{"type":"string","maxLength":30,"description":"VEE Group"}}},"streamingInitialLoad":{"type":"object","properties":{"streamingInitialLoad":{"type":"string","maxLength":30,"description":"VEE Group"}}},"estimation":{"type":"object","properties":{"estimation":{"type":"string","maxLength":30,"description":"VEE Group"}}},"manualOverride":{"type":"object","properties":{"manualOverride":{"type":"string","maxLength":30,"description":"VEE Group"}}},"projection":{"type":"object","properties":{"projection":{"type":"string","maxLength":30,"description":"VEE Group"}}}}},"fallBackVeeGroups":{"type":"object","properties":{"initialLoad":{"type":"object","properties":{"initialLoad":{"type":"string","maxLength":30,"description":"VEE Group"}}},"streamingInitialLoad":{"type":"object","properties":{"streamingInitialLoad":{"type":"string","maxLength":30,"description":"VEE Group"}}},"estimation":{"type":"object","properties":{"estimation":{"type":"string","maxLength":30,"description":"VEE Group"}}},"manualOverride":{"type":"object","properties":{"manualOverride":{"type":"string","maxLength":30,"description":"VEE Group"}}},"projection":{"type":"object","properties":{"projection":{"type":"string","maxLength":30,"description":"VEE Group"}}}}}},"xml":{"name":"D1MeasuComp"}},"DELETEMEASURINGCOMPONENT_response":{"type":"object","properties":{"measuringComponentId":{"type":"string","maxLength":12,"description":"Measuring Component ID is a system assigned random number that stays with measuring component record.","example":"061924013788"}},"xml":{"name":"D1-DeleteMC"}},"CREATEMEASURINGCOMPONENT_response":{"type":"object","properties":{"_self":{"type":"string","description":"_self"},"measuringComponentId":{"type":"string","maxLength":12,"description":"Measuring Component ID is a system assigned random number that stays with measuring component record.","example":"061924013788"},"measuringComponentType":{"type":"object","description":"Type of Measuring Component","properties":{"_link":{"type":"string","description":"_link"},"measuringComponentType":{"type":"string","maxLength":30,"description":"Type of Measuring Component","example":"MKA SMART KWH"}}},"deviceConfiguration":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"deviceConfigurationId":{"type":"string","maxLength":12,"description":"Device Configuration ID is a system assigned random number that stays with a device configuration record.","example":"959682277977"}}},"consumptionReferenceMC":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"consumptionReferenceMCId":{"type":"string","maxLength":12,"description":"Related scalar measuring component. Used when adjusting interval measurement data to an existing scalar measurement."}}},"businessObject":{"type":"string","maxLength":30,"description":"Business Object","example":"D1-IntervalChannel"},"howToUse":{"type":"string","enum":["+   ","-   ","C   ","P   "],"description":"How to Use indicates how the channel is used (additive, subtractive, peak, or check) when calculating usage.\n* `+   ` - Additive,\n* `-   ` - Subtractive,\n* `C   ` - Check,\n* `P   ` - Peak"},"numberOfDigitsLeft":{"type":"number","maximum":99999,"minimum":-99999,"description":"Number of digits left is the number of digits to the left of the decimal point that the reading can contain.","example":"3"},"numberOfDigitsRight":{"type":"number","maximum":99999,"minimum":-99999,"description":"Number of digits right is the number of digits to the right of the decimal point that the reading can contain.","example":"2"},"measuringComponentMultiplier":{"type":"number","maximum":999999.999999,"minimum":-999999.999999,"description":"The meter multiplier for the channel.","example":"1"},"readSequence":{"type":"number","maximum":99999,"minimum":-99999,"description":"Read Sequence","example":"0"},"creationDateTime":{"type":"string","format":"date-time","description":"Create Date/Time","example":"2011-04-20T09:03:54-07:00"},"mostRecentMeasurementDateTime":{"type":"string","format":"date-time","description":"This date/time corresponds to the final measurement with the latest measurement date/time that has been processed for this measuring component regardless of the final condition (i.e. quality)."},"fullScale":{"type":"number","maximum":100000000000,"minimum":-100000000000,"description":"Full Scale","example":"0E-7"},"mostRecentNonEstimatedMeasurementDateTime":{"type":"string","format":"date-time","description":"This date/time corresponds to the final measurement with the latest measurement date/time that has a final condition that is non-estimated."},"adjustLatestMeasurementDateTime":{"type":"string","format":"date-time","description":"Adjust Latest Measurement Date/Time"},"latestMeasurementDateTime":{"type":"string","format":"date-time","description":"Latest Measurement Date/Time"},"mostRecentMeasurementReadingCondition":{"type":"string","maxLength":6,"description":"Most Recent Measurement Reading Condition"},"mostRecentMeasurementReadingValue":{"type":"number","maximum":9999999999.999998,"minimum":0,"description":"Most Recent Measurement Reading Value","example":"0"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks.","example":"1"},"veeGroups":{"type":"object","properties":{"initialLoad":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"initialLoad":{"type":"string","maxLength":30,"description":"VEE Group"}}},"streamingInitialLoad":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"streamingInitialLoad":{"type":"string","maxLength":30,"description":"VEE Group"}}},"estimation":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"estimation":{"type":"string","maxLength":30,"description":"VEE Group"}}},"manualOverride":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"manualOverride":{"type":"string","maxLength":30,"description":"VEE Group"}}},"projection":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"projection":{"type":"string","maxLength":30,"description":"VEE Group"}}}}},"fallBackVeeGroups":{"type":"object","properties":{"initialLoad":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"initialLoad":{"type":"string","maxLength":30,"description":"VEE Group"}}},"streamingInitialLoad":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"streamingInitialLoad":{"type":"string","maxLength":30,"description":"VEE Group"}}},"estimation":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"estimation":{"type":"string","maxLength":30,"description":"VEE Group"}}},"manualOverride":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"manualOverride":{"type":"string","maxLength":30,"description":"VEE Group"}}},"projection":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"projection":{"type":"string","maxLength":30,"description":"VEE Group"}}}}}},"xml":{"name":"D1MeasuComp"}},"CREATEMEASURINGCOMPONENT_request":{"type":"object","properties":{"measuringComponentId":{"type":"string","maxLength":12,"description":"Measuring Component ID is a system assigned random number that stays with measuring component record.","example":"061924013788"},"measuringComponentType":{"type":"object","description":"Type of Measuring Component","properties":{"measuringComponentType":{"type":"string","maxLength":30,"description":"Type of Measuring Component","example":"MKA SMART KWH"}}},"deviceConfigurationId":{"type":"string","maxLength":12,"description":"Device Configuration ID is a system assigned random number that stays with a device configuration record.","example":"959682277977"},"consumptionReferenceMC":{"type":"object","properties":{"consumptionReferenceMCId":{"type":"string","maxLength":12,"description":"Related scalar measuring component. Used when adjusting interval measurement data to an existing scalar measurement."}}},"businessObject":{"type":"string","maxLength":30,"description":"Business Object","example":"D1-IntervalChannel"},"howToUse":{"type":"string","enum":["+   ","-   ","C   ","P   "],"description":"How to Use indicates how the channel is used (additive, subtractive, peak, or check) when calculating usage.\n* `+   ` - Additive,\n* `-   ` - Subtractive,\n* `C   ` - Check,\n* `P   ` - Peak"},"numberOfDigitsLeft":{"type":"number","maximum":99999,"minimum":-99999,"description":"Number of digits left is the number of digits to the left of the decimal point that the reading can contain.","example":"3"},"numberOfDigitsRight":{"type":"number","maximum":99999,"minimum":-99999,"description":"Number of digits right is the number of digits to the right of the decimal point that the reading can contain.","example":"2"},"measuringComponentMultiplier":{"type":"number","maximum":999999.999999,"minimum":-999999.999999,"description":"The meter multiplier for the channel.","example":"1"},"readSequence":{"type":"number","maximum":99999,"minimum":-99999,"description":"Read Sequence","example":"0"},"creationDateTime":{"type":"string","format":"date-time","description":"Create Date/Time","example":"2011-04-20T09:03:54-07:00"},"fullScale":{"type":"number","maximum":100000000000,"minimum":-100000000000,"description":"Full Scale","example":"0E-7"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks.","example":"1"},"veeGroups":{"type":"object","properties":{"initialLoad":{"type":"object","properties":{"initialLoad":{"type":"string","maxLength":30,"description":"VEE Group"}}},"streamingInitialLoad":{"type":"object","properties":{"streamingInitialLoad":{"type":"string","maxLength":30,"description":"VEE Group"}}},"estimation":{"type":"object","properties":{"estimation":{"type":"string","maxLength":30,"description":"VEE Group"}}},"manualOverride":{"type":"object","properties":{"manualOverride":{"type":"string","maxLength":30,"description":"VEE Group"}}},"projection":{"type":"object","properties":{"projection":{"type":"string","maxLength":30,"description":"VEE Group"}}}}},"fallBackVeeGroups":{"type":"object","properties":{"initialLoad":{"type":"object","properties":{"initialLoad":{"type":"string","maxLength":30,"description":"VEE Group"}}},"streamingInitialLoad":{"type":"object","properties":{"streamingInitialLoad":{"type":"string","maxLength":30,"description":"VEE Group"}}},"estimation":{"type":"object","properties":{"estimation":{"type":"string","maxLength":30,"description":"VEE Group"}}},"manualOverride":{"type":"object","properties":{"manualOverride":{"type":"string","maxLength":30,"description":"VEE Group"}}},"projection":{"type":"object","properties":{"projection":{"type":"string","maxLength":30,"description":"VEE Group"}}}}}},"xml":{"name":"D1MeasuComp"}},"CREATEOVERDUEPROCESS_response":{"type":"object","properties":{"_self":{"type":"string","description":"_self"},"name":{"type":"string","description":"(name)"},"overdueProcessId":{"type":"string","maxLength":12,"description":"Overdue Process ID is the system-assigned unique identifier of the process.c","example":"460352888888"},"account":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"accountId":{"type":"string","maxLength":10,"description":"Account ID"}}},"status":{"type":"string","enum":["10  ","20  "],"description":"Overdue Process Status defines the state of the overdue process.\n* `10  ` - Active,\n* `20  ` - Inactive","example":"20"},"overdueProcessTemplate":{"type":"object","description":"Overdue Process Template defines the template that was used to create the overdue process's events.","properties":{"_link":{"type":"string","description":"_link"},"overdueProcessTemplate":{"type":"string","maxLength":12,"description":"Overdue Process Template defines the template that was used to create the overdue process's events.","example":"RISKY"}}},"startDateTime":{"type":"string","format":"date-time","description":"Create Date/Time defines the creation date/time of the cut process.","example":"2005-04-18T07:50:51-04:00"},"longComments":{"type":"string","maxLength":2000,"description":"Enter any Comments about the overdue process. This field is protected when the overdue process is Inactive."},"baseDate":{"type":"string","format":"date","description":"Base Date is reserved for future releases. This field is protected when the overdue process is Inactive.","example":"2004-03-01"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"},"events":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"eventSequence":{"type":"number","maximum":999,"minimum":-999,"description":"Event Sequence is the unique identifier of the event.","example":"10"},"status":{"type":"string","enum":["10  ","20  ","30  ","40  "],"description":"Event Status:\n* `10  ` - Pending,\n* `20  ` - Waiting,\n* `30  ` - Completed,\n* `40  ` - Canceled"},"overdueEventTypeCode":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"overdueEventTypeCode":{"type":"string","maxLength":12,"description":"Overdue Event Type"}}},"dependOnOtherEvents":{"type":"boolean","description":"If Dependent on Other Events is turned on, the event can only be triggered after the events specified in the Event Dependencies are all Complete or Canceled.","example":"false"},"triggerDate":{"type":"string","format":"date","description":"If Dependent on Other Events is turned off, enter the desired activation date in the Trigger Date field.","example":"2005-04-19"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"},"eventDependencies":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"sequence":{"type":"number","maximum":999,"minimum":-999,"description":"Sequence Number","example":"10"},"dependentOnSequence":{"type":"number","maximum":999,"minimum":-999,"description":"When Dependent on Other Events is turned on, the Dependent on Sequence field  defines the event sequence number on which this event depends.","example":"10"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"}}}}}}}}}}},"collectingOn":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"originalAmount":{"type":"number","description":"Original Amount"},"unpaidAmt":{"type":"number","description":"Unpaid Amount"},"overdueBillId":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"overdueBillIdFkChar":{"type":"string","description":"(overdueBillIdFkChar)"}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"}}}}}}},"xml":{"name":"C1OverduePro"}},"ACTIONOVERDUEPROCESS_response":{"type":"object","properties":{"_self":{"type":"string","description":"_self"},"name":{"type":"string","description":"(name)"},"overdueProcessId":{"type":"string","maxLength":12,"description":"Overdue Process ID is the system-assigned unique identifier of the process.c","example":"460352888888"},"account":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"accountId":{"type":"string","maxLength":10,"description":"Account ID"}}},"status":{"type":"string","enum":["10  ","20  "],"description":"Overdue Process Status defines the state of the overdue process.\n* `10  ` - Active,\n* `20  ` - Inactive","example":"20"},"overdueProcessTemplate":{"type":"object","description":"Overdue Process Template defines the template that was used to create the overdue process's events.","properties":{"_link":{"type":"string","description":"_link"},"overdueProcessTemplate":{"type":"string","maxLength":12,"description":"Overdue Process Template defines the template that was used to create the overdue process's events.","example":"RISKY"}}},"startDateTime":{"type":"string","format":"date-time","description":"Create Date/Time defines the creation date/time of the cut process.","example":"2005-04-18T07:50:51-04:00"},"longComments":{"type":"string","maxLength":2000,"description":"Enter any Comments about the overdue process. This field is protected when the overdue process is Inactive."},"baseDate":{"type":"string","format":"date","description":"Base Date is reserved for future releases. This field is protected when the overdue process is Inactive.","example":"2004-03-01"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"},"events":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"eventSequence":{"type":"number","maximum":999,"minimum":-999,"description":"Event Sequence is the unique identifier of the event.","example":"10"},"status":{"type":"string","enum":["10  ","20  ","30  ","40  "],"description":"Event Status:\n* `10  ` - Pending,\n* `20  ` - Waiting,\n* `30  ` - Completed,\n* `40  ` - Canceled"},"overdueEventTypeCode":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"overdueEventTypeCode":{"type":"string","maxLength":12,"description":"Overdue Event Type"}}},"dependOnOtherEvents":{"type":"boolean","description":"If Dependent on Other Events is turned on, the event can only be triggered after the events specified in the Event Dependencies are all Complete or Canceled.","example":"false"},"triggerDate":{"type":"string","format":"date","description":"If Dependent on Other Events is turned off, enter the desired activation date in the Trigger Date field.","example":"2005-04-19"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"},"eventDependencies":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"sequence":{"type":"number","maximum":999,"minimum":-999,"description":"Sequence Number","example":"10"},"dependentOnSequence":{"type":"number","maximum":999,"minimum":-999,"description":"When Dependent on Other Events is turned on, the Dependent on Sequence field  defines the event sequence number on which this event depends.","example":"10"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"}}}}}}}}}}},"collectingOn":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"originalAmount":{"type":"number","description":"Original Amount"},"unpaidAmt":{"type":"number","description":"Unpaid Amount"},"overdueBillId":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"overdueBillIdFkChar":{"type":"string","description":"(overdueBillIdFkChar)"}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"}}}}}}},"xml":{"name":"C1OverduePro"}},"UPDATEOVERDUEPROCESS_request":{"type":"object","properties":{"name":{"type":"string","description":"(name)"},"overdueProcessId":{"type":"string","maxLength":12,"description":"Overdue Process ID is the system-assigned unique identifier of the process.c","example":"460352888888"},"account":{"type":"object","properties":{"accountId":{"type":"string","maxLength":10,"description":"Account ID"}}},"status":{"type":"string","enum":["10  ","20  "],"description":"Overdue Process Status defines the state of the overdue process.\n* `10  ` - Active,\n* `20  ` - Inactive","example":"20"},"overdueProcessTemplate":{"type":"object","description":"Overdue Process Template defines the template that was used to create the overdue process's events.","properties":{"overdueProcessTemplate":{"type":"string","maxLength":12,"description":"Overdue Process Template defines the template that was used to create the overdue process's events.","example":"RISKY"}}},"startDateTime":{"type":"string","format":"date-time","description":"Create Date/Time defines the creation date/time of the cut process.","example":"2005-04-18T07:50:51-04:00"},"longComments":{"type":"string","maxLength":2000,"description":"Enter any Comments about the overdue process. This field is protected when the overdue process is Inactive."},"baseDate":{"type":"string","format":"date","description":"Base Date is reserved for future releases. This field is protected when the overdue process is Inactive.","example":"2004-03-01"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"},"events":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"eventSequence":{"type":"number","maximum":999,"minimum":-999,"description":"Event Sequence is the unique identifier of the event.","example":"10"},"status":{"type":"string","enum":["10  ","20  ","30  ","40  "],"description":"Event Status:\n* `10  ` - Pending,\n* `20  ` - Waiting,\n* `30  ` - Completed,\n* `40  ` - Canceled"},"overdueEventTypeCode":{"type":"object","properties":{"overdueEventTypeCode":{"type":"string","maxLength":12,"description":"Overdue Event Type"}}},"dependOnOtherEvents":{"type":"boolean","description":"If Dependent on Other Events is turned on, the event can only be triggered after the events specified in the Event Dependencies are all Complete or Canceled.","example":"false"},"triggerDate":{"type":"string","format":"date","description":"If Dependent on Other Events is turned off, enter the desired activation date in the Trigger Date field.","example":"2005-04-19"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"},"eventDependencies":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"sequence":{"type":"number","maximum":999,"minimum":-999,"description":"Sequence Number","example":"10"},"dependentOnSequence":{"type":"number","maximum":999,"minimum":-999,"description":"When Dependent on Other Events is turned on, the Dependent on Sequence field  defines the event sequence number on which this event depends.","example":"10"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"}}}}}}}}}}},"collectingOn":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"originalAmount":{"type":"number","description":"Original Amount"},"unpaidAmt":{"type":"number","description":"Unpaid Amount"},"overdueBillId":{"type":"object","properties":{"overdueBillIdFkChar":{"type":"string","description":"(overdueBillIdFkChar)"}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"}}}}}}},"xml":{"name":"C1OverduePro"}},"CREATEOVERDUEPROCESS_request":{"type":"object","properties":{"name":{"type":"string","description":"(name)"},"overdueProcessId":{"type":"string","maxLength":12,"description":"Overdue Process ID is the system-assigned unique identifier of the process.c","example":"460352888888"},"account":{"type":"object","properties":{"accountId":{"type":"string","maxLength":10,"description":"Account ID"}}},"status":{"type":"string","enum":["10  ","20  "],"description":"Overdue Process Status defines the state of the overdue process.\n* `10  ` - Active,\n* `20  ` - Inactive","example":"20"},"overdueProcessTemplate":{"type":"object","description":"Overdue Process Template defines the template that was used to create the overdue process's events.","properties":{"overdueProcessTemplate":{"type":"string","maxLength":12,"description":"Overdue Process Template defines the template that was used to create the overdue process's events.","example":"RISKY"}}},"startDateTime":{"type":"string","format":"date-time","description":"Create Date/Time defines the creation date/time of the cut process.","example":"2005-04-18T07:50:51-04:00"},"longComments":{"type":"string","maxLength":2000,"description":"Enter any Comments about the overdue process. This field is protected when the overdue process is Inactive."},"baseDate":{"type":"string","format":"date","description":"Base Date is reserved for future releases. This field is protected when the overdue process is Inactive.","example":"2004-03-01"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"},"events":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"eventSequence":{"type":"number","maximum":999,"minimum":-999,"description":"Event Sequence is the unique identifier of the event.","example":"10"},"status":{"type":"string","enum":["10  ","20  ","30  ","40  "],"description":"Event Status:\n* `10  ` - Pending,\n* `20  ` - Waiting,\n* `30  ` - Completed,\n* `40  ` - Canceled"},"overdueEventTypeCode":{"type":"object","properties":{"overdueEventTypeCode":{"type":"string","maxLength":12,"description":"Overdue Event Type"}}},"dependOnOtherEvents":{"type":"boolean","description":"If Dependent on Other Events is turned on, the event can only be triggered after the events specified in the Event Dependencies are all Complete or Canceled.","example":"false"},"triggerDate":{"type":"string","format":"date","description":"If Dependent on Other Events is turned off, enter the desired activation date in the Trigger Date field.","example":"2005-04-19"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"},"eventDependencies":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"sequence":{"type":"number","maximum":999,"minimum":-999,"description":"Sequence Number","example":"10"},"dependentOnSequence":{"type":"number","maximum":999,"minimum":-999,"description":"When Dependent on Other Events is turned on, the Dependent on Sequence field  defines the event sequence number on which this event depends.","example":"10"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"}}}}}}}}}}},"collectingOn":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"originalAmount":{"type":"number","description":"Original Amount"},"unpaidAmt":{"type":"number","description":"Unpaid Amount"},"overdueBillId":{"type":"object","properties":{"overdueBillIdFkChar":{"type":"string","description":"(overdueBillIdFkChar)"}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"}}}}}}},"xml":{"name":"C1OverduePro"}},"UPDATEOVERDUEPROCESS_response":{"type":"object","properties":{"_self":{"type":"string","description":"_self"},"name":{"type":"string","description":"(name)"},"overdueProcessId":{"type":"string","maxLength":12,"description":"Overdue Process ID is the system-assigned unique identifier of the process.c","example":"460352888888"},"account":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"accountId":{"type":"string","maxLength":10,"description":"Account ID"}}},"status":{"type":"string","enum":["10  ","20  "],"description":"Overdue Process Status defines the state of the overdue process.\n* `10  ` - Active,\n* `20  ` - Inactive","example":"20"},"overdueProcessTemplate":{"type":"object","description":"Overdue Process Template defines the template that was used to create the overdue process's events.","properties":{"_link":{"type":"string","description":"_link"},"overdueProcessTemplate":{"type":"string","maxLength":12,"description":"Overdue Process Template defines the template that was used to create the overdue process's events.","example":"RISKY"}}},"startDateTime":{"type":"string","format":"date-time","description":"Create Date/Time defines the creation date/time of the cut process.","example":"2005-04-18T07:50:51-04:00"},"longComments":{"type":"string","maxLength":2000,"description":"Enter any Comments about the overdue process. This field is protected when the overdue process is Inactive."},"baseDate":{"type":"string","format":"date","description":"Base Date is reserved for future releases. This field is protected when the overdue process is Inactive.","example":"2004-03-01"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"},"events":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"eventSequence":{"type":"number","maximum":999,"minimum":-999,"description":"Event Sequence is the unique identifier of the event.","example":"10"},"status":{"type":"string","enum":["10  ","20  ","30  ","40  "],"description":"Event Status:\n* `10  ` - Pending,\n* `20  ` - Waiting,\n* `30  ` - Completed,\n* `40  ` - Canceled"},"overdueEventTypeCode":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"overdueEventTypeCode":{"type":"string","maxLength":12,"description":"Overdue Event Type"}}},"dependOnOtherEvents":{"type":"boolean","description":"If Dependent on Other Events is turned on, the event can only be triggered after the events specified in the Event Dependencies are all Complete or Canceled.","example":"false"},"triggerDate":{"type":"string","format":"date","description":"If Dependent on Other Events is turned off, enter the desired activation date in the Trigger Date field.","example":"2005-04-19"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"},"eventDependencies":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"sequence":{"type":"number","maximum":999,"minimum":-999,"description":"Sequence Number","example":"10"},"dependentOnSequence":{"type":"number","maximum":999,"minimum":-999,"description":"When Dependent on Other Events is turned on, the Dependent on Sequence field  defines the event sequence number on which this event depends.","example":"10"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"}}}}}}}}}}},"collectingOn":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"originalAmount":{"type":"number","description":"Original Amount"},"unpaidAmt":{"type":"number","description":"Unpaid Amount"},"overdueBillId":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"overdueBillIdFkChar":{"type":"string","description":"(overdueBillIdFkChar)"}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"}}}}}}},"xml":{"name":"C1OverduePro"}},"ACTIONOVERDUEPROCESS_request":{"type":"object","properties":{"name":{"type":"string","description":"(name)"},"overdueProcessId":{"type":"string","maxLength":12,"description":"Overdue Process ID is the system-assigned unique identifier of the process.c","example":"460352888888"},"account":{"type":"object","properties":{"accountId":{"type":"string","maxLength":10,"description":"Account ID"}}},"status":{"type":"string","enum":["10  ","20  "],"description":"Overdue Process Status defines the state of the overdue process.\n* `10  ` - Active,\n* `20  ` - Inactive","example":"20"},"overdueProcessTemplate":{"type":"object","description":"Overdue Process Template defines the template that was used to create the overdue process's events.","properties":{"overdueProcessTemplate":{"type":"string","maxLength":12,"description":"Overdue Process Template defines the template that was used to create the overdue process's events.","example":"RISKY"}}},"startDateTime":{"type":"string","format":"date-time","description":"Create Date/Time defines the creation date/time of the cut process.","example":"2005-04-18T07:50:51-04:00"},"longComments":{"type":"string","maxLength":2000,"description":"Enter any Comments about the overdue process. This field is protected when the overdue process is Inactive."},"baseDate":{"type":"string","format":"date","description":"Base Date is reserved for future releases. This field is protected when the overdue process is Inactive.","example":"2004-03-01"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"},"events":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"eventSequence":{"type":"number","maximum":999,"minimum":-999,"description":"Event Sequence is the unique identifier of the event.","example":"10"},"status":{"type":"string","enum":["10  ","20  ","30  ","40  "],"description":"Event Status:\n* `10  ` - Pending,\n* `20  ` - Waiting,\n* `30  ` - Completed,\n* `40  ` - Canceled"},"overdueEventTypeCode":{"type":"object","properties":{"overdueEventTypeCode":{"type":"string","maxLength":12,"description":"Overdue Event Type"}}},"dependOnOtherEvents":{"type":"boolean","description":"If Dependent on Other Events is turned on, the event can only be triggered after the events specified in the Event Dependencies are all Complete or Canceled.","example":"false"},"triggerDate":{"type":"string","format":"date","description":"If Dependent on Other Events is turned off, enter the desired activation date in the Trigger Date field.","example":"2005-04-19"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"},"eventDependencies":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"sequence":{"type":"number","maximum":999,"minimum":-999,"description":"Sequence Number","example":"10"},"dependentOnSequence":{"type":"number","maximum":999,"minimum":-999,"description":"When Dependent on Other Events is turned on, the Dependent on Sequence field  defines the event sequence number on which this event depends.","example":"10"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"}}}}}}}}}}},"collectingOn":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"originalAmount":{"type":"number","description":"Original Amount"},"unpaidAmt":{"type":"number","description":"Unpaid Amount"},"overdueBillId":{"type":"object","properties":{"overdueBillIdFkChar":{"type":"string","description":"(overdueBillIdFkChar)"}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"}}}}}}},"xml":{"name":"C1OverduePro"}},"GETOVERDUEPROCESS_response":{"type":"object","properties":{"_self":{"type":"string","description":"_self"},"name":{"type":"string","description":"(name)"},"overdueProcessId":{"type":"string","maxLength":12,"description":"Overdue Process ID is the system-assigned unique identifier of the process.c","example":"460352888888"},"account":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"accountId":{"type":"string","maxLength":10,"description":"Account ID"}}},"status":{"type":"string","enum":["10  ","20  "],"description":"Overdue Process Status defines the state of the overdue process.\n* `10  ` - Active,\n* `20  ` - Inactive","example":"20"},"overdueProcessTemplate":{"type":"object","description":"Overdue Process Template defines the template that was used to create the overdue process's events.","properties":{"_link":{"type":"string","description":"_link"},"overdueProcessTemplate":{"type":"string","maxLength":12,"description":"Overdue Process Template defines the template that was used to create the overdue process's events.","example":"RISKY"}}},"startDateTime":{"type":"string","format":"date-time","description":"Create Date/Time defines the creation date/time of the cut process.","example":"2005-04-18T07:50:51-04:00"},"longComments":{"type":"string","maxLength":2000,"description":"Enter any Comments about the overdue process. This field is protected when the overdue process is Inactive."},"baseDate":{"type":"string","format":"date","description":"Base Date is reserved for future releases. This field is protected when the overdue process is Inactive.","example":"2004-03-01"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"},"events":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"eventSequence":{"type":"number","maximum":999,"minimum":-999,"description":"Event Sequence is the unique identifier of the event.","example":"10"},"status":{"type":"string","enum":["10  ","20  ","30  ","40  "],"description":"Event Status:\n* `10  ` - Pending,\n* `20  ` - Waiting,\n* `30  ` - Completed,\n* `40  ` - Canceled"},"overdueEventTypeCode":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"overdueEventTypeCode":{"type":"string","maxLength":12,"description":"Overdue Event Type"}}},"dependOnOtherEvents":{"type":"boolean","description":"If Dependent on Other Events is turned on, the event can only be triggered after the events specified in the Event Dependencies are all Complete or Canceled.","example":"false"},"triggerDate":{"type":"string","format":"date","description":"If Dependent on Other Events is turned off, enter the desired activation date in the Trigger Date field.","example":"2005-04-19"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"},"eventDependencies":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"sequence":{"type":"number","maximum":999,"minimum":-999,"description":"Sequence Number","example":"10"},"dependentOnSequence":{"type":"number","maximum":999,"minimum":-999,"description":"When Dependent on Other Events is turned on, the Dependent on Sequence field  defines the event sequence number on which this event depends.","example":"10"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"}}}}}}}}}}},"collectingOn":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"originalAmount":{"type":"number","description":"Original Amount"},"unpaidAmt":{"type":"number","description":"Unpaid Amount"},"overdueBillId":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"overdueBillIdFkChar":{"type":"string","description":"(overdueBillIdFkChar)"}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"}}}}}}},"xml":{"name":"C1OverduePro"}},"UPDATEWRITEOFFPROCESS_request":{"type":"object","properties":{"writeOffProcessId":{"type":"string","maxLength":10,"description":"Write Off Process ID is the unique system-generated identifier for this write-off process."},"account":{"type":"object","properties":{"accountId":{"type":"string","maxLength":10,"description":"Account ID"}}},"writeOffProcessTemplate":{"type":"object","description":"Write Off Process Template defines the write-off events in the process.","properties":{"writeOffProcessTemplate":{"type":"string","maxLength":12,"description":"Write Off Process Template"}}},"writeOffStatus":{"type":"string","enum":["10  ","20  "],"description":"Write-off Status defines the state of the write-off process.\n* `10  ` - Active,\n* `20  ` - Inactive","example":"20"},"writeOffControl":{"type":"object","description":"Write Off Control defines the write-off debt class (i.e., the type of debt) associated with the write-off process.","properties":{"writeOffControl":{"type":"string","maxLength":20,"description":"Write Off Control defines the write-off debt class (i.e., the type of debt) associated with the write-off process.","example":"RES-REGU"}}},"writeOffStatusReason":{"type":"string","enum":["10  ","20  ","30  ","40  "],"description":"Reason defines how a write-off process became Inactive or why a write-off process is Active.\n* `10  ` - Events Pending,\n* `20  ` - Completed,\n* `30  ` - Canceled by System,\n* `40  ` - Canceled by User","example":"20"},"creationDateTime":{"type":"string","format":"date-time","description":"Create Date/Time defines the start date/time of the write-off process.","example":"2005-04-18T07:50:51-04:00"},"comments":{"type":"string","maxLength":254,"description":"Enter any Comments about the write-off process.","example":"TESTQA"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"},"SAs":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"serviceAgreement":{"type":"object","properties":{"serviceAgreementId":{"type":"string","maxLength":10,"description":"Service Agreement"}}},"writeOffSAStatus":{"type":"string","enum":["10  ","20  "],"description":"Write Off SA Status defines the state of the service agreement in respect of the write-off process.\n* `10  ` - Active,\n* `20  ` - Inactive","example":"10"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"}}}}}},"events":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"eventSequence":{"type":"number","maximum":999,"minimum":-999,"description":"Event Sequence is the unique identifier of the event.","example":"10"},"writeOffEventStatus":{"type":"string","enum":["10  ","30  ","40  "],"description":"Write Off Event Status defines the state of the event.\n* `10  ` - Pending,\n* `30  ` - Completed,\n* `40  ` - Canceled","example":"10"},"writeOffEventType":{"type":"object","properties":{"writeOffEventType":{"type":"string","maxLength":12,"description":"Write Off Event Type"}}},"triggerDate":{"type":"string","format":"date","description":"The Trigger Date defines the date when the system completes (i.e., executes) the event.","example":"2009-03-13"},"completionDate":{"type":"string","format":"date","description":"If the status of the event is complete, the Completion Date is displayed with the date on which the system completed the event.","example":"2009-12-13"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"},"eventCustomerContact":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"customerContact":{"type":"object","properties":{"customerContactId":{"type":"string","maxLength":10,"description":"Customer Contact ID"}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"}}}}}}}}}}}},"xml":{"name":"C1WriteOffPr"}},"UPDATEWRITEOFFPROCESS_response":{"type":"object","properties":{"_self":{"type":"string","description":"_self"},"writeOffProcessId":{"type":"string","maxLength":10,"description":"Write Off Process ID is the unique system-generated identifier for this write-off process."},"account":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"accountId":{"type":"string","maxLength":10,"description":"Account ID"}}},"writeOffProcessTemplate":{"type":"object","description":"Write Off Process Template defines the write-off events in the process.","properties":{"_link":{"type":"string","description":"_link"},"writeOffProcessTemplate":{"type":"string","maxLength":12,"description":"Write Off Process Template"}}},"writeOffStatus":{"type":"string","enum":["10  ","20  "],"description":"Write-off Status defines the state of the write-off process.\n* `10  ` - Active,\n* `20  ` - Inactive","example":"20"},"writeOffControl":{"type":"object","description":"Write Off Control defines the write-off debt class (i.e., the type of debt) associated with the write-off process.","properties":{"_link":{"type":"string","description":"_link"},"writeOffControl":{"type":"string","maxLength":20,"description":"Write Off Control defines the write-off debt class (i.e., the type of debt) associated with the write-off process.","example":"RES-REGU"}}},"writeOffStatusReason":{"type":"string","enum":["10  ","20  ","30  ","40  "],"description":"Reason defines how a write-off process became Inactive or why a write-off process is Active.\n* `10  ` - Events Pending,\n* `20  ` - Completed,\n* `30  ` - Canceled by System,\n* `40  ` - Canceled by User","example":"20"},"creationDateTime":{"type":"string","format":"date-time","description":"Create Date/Time defines the start date/time of the write-off process.","example":"2005-04-18T07:50:51-04:00"},"comments":{"type":"string","maxLength":254,"description":"Enter any Comments about the write-off process.","example":"TESTQA"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"},"SAs":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"serviceAgreement":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"serviceAgreementId":{"type":"string","maxLength":10,"description":"Service Agreement"}}},"writeOffSAStatus":{"type":"string","enum":["10  ","20  "],"description":"Write Off SA Status defines the state of the service agreement in respect of the write-off process.\n* `10  ` - Active,\n* `20  ` - Inactive","example":"10"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"}}}}}},"events":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"eventSequence":{"type":"number","maximum":999,"minimum":-999,"description":"Event Sequence is the unique identifier of the event.","example":"10"},"writeOffEventStatus":{"type":"string","enum":["10  ","30  ","40  "],"description":"Write Off Event Status defines the state of the event.\n* `10  ` - Pending,\n* `30  ` - Completed,\n* `40  ` - Canceled","example":"10"},"writeOffEventType":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"writeOffEventType":{"type":"string","maxLength":12,"description":"Write Off Event Type"}}},"triggerDate":{"type":"string","format":"date","description":"The Trigger Date defines the date when the system completes (i.e., executes) the event.","example":"2009-03-13"},"completionDate":{"type":"string","format":"date","description":"If the status of the event is complete, the Completion Date is displayed with the date on which the system completed the event.","example":"2009-12-13"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"},"eventCustomerContact":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"customerContact":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"customerContactId":{"type":"string","maxLength":10,"description":"Customer Contact ID"}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"}}}}}}}}}}}},"xml":{"name":"C1WriteOffPr"}},"GETWRITEOFFPROCESS_response":{"type":"object","properties":{"_self":{"type":"string","description":"_self"},"writeOffProcessId":{"type":"string","maxLength":10,"description":"Write Off Process ID is the unique system-generated identifier for this write-off process."},"account":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"accountId":{"type":"string","maxLength":10,"description":"Account ID"}}},"writeOffProcessTemplate":{"type":"object","description":"Write Off Process Template defines the write-off events in the process.","properties":{"_link":{"type":"string","description":"_link"},"writeOffProcessTemplate":{"type":"string","maxLength":12,"description":"Write Off Process Template"}}},"writeOffStatus":{"type":"string","enum":["10  ","20  "],"description":"Write-off Status defines the state of the write-off process.\n* `10  ` - Active,\n* `20  ` - Inactive","example":"20"},"writeOffControl":{"type":"object","description":"Write Off Control defines the write-off debt class (i.e., the type of debt) associated with the write-off process.","properties":{"_link":{"type":"string","description":"_link"},"writeOffControl":{"type":"string","maxLength":20,"description":"Write Off Control defines the write-off debt class (i.e., the type of debt) associated with the write-off process.","example":"RES-REGU"}}},"writeOffStatusReason":{"type":"string","enum":["10  ","20  ","30  ","40  "],"description":"Reason defines how a write-off process became Inactive or why a write-off process is Active.\n* `10  ` - Events Pending,\n* `20  ` - Completed,\n* `30  ` - Canceled by System,\n* `40  ` - Canceled by User","example":"20"},"creationDateTime":{"type":"string","format":"date-time","description":"Create Date/Time defines the start date/time of the write-off process.","example":"2005-04-18T07:50:51-04:00"},"comments":{"type":"string","maxLength":254,"description":"Enter any Comments about the write-off process.","example":"TESTQA"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"},"SAs":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"serviceAgreement":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"serviceAgreementId":{"type":"string","maxLength":10,"description":"Service Agreement"}}},"writeOffSAStatus":{"type":"string","enum":["10  ","20  "],"description":"Write Off SA Status defines the state of the service agreement in respect of the write-off process.\n* `10  ` - Active,\n* `20  ` - Inactive","example":"10"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"}}}}}},"events":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"eventSequence":{"type":"number","maximum":999,"minimum":-999,"description":"Event Sequence is the unique identifier of the event.","example":"10"},"writeOffEventStatus":{"type":"string","enum":["10  ","30  ","40  "],"description":"Write Off Event Status defines the state of the event.\n* `10  ` - Pending,\n* `30  ` - Completed,\n* `40  ` - Canceled","example":"10"},"writeOffEventType":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"writeOffEventType":{"type":"string","maxLength":12,"description":"Write Off Event Type"}}},"triggerDate":{"type":"string","format":"date","description":"The Trigger Date defines the date when the system completes (i.e., executes) the event.","example":"2009-03-13"},"completionDate":{"type":"string","format":"date","description":"If the status of the event is complete, the Completion Date is displayed with the date on which the system completed the event.","example":"2009-12-13"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"},"eventCustomerContact":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"customerContact":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"customerContactId":{"type":"string","maxLength":10,"description":"Customer Contact ID"}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"}}}}}}}}}}}},"xml":{"name":"C1WriteOffPr"}},"CREATEWRITEOFFPROCESS_request":{"type":"object","properties":{"writeOffProcessId":{"type":"string","maxLength":10,"description":"Write Off Process ID is the unique system-generated identifier for this write-off process."},"account":{"type":"object","properties":{"accountId":{"type":"string","maxLength":10,"description":"Account ID"}}},"writeOffProcessTemplate":{"type":"object","description":"Write Off Process Template defines the write-off events in the process.","properties":{"writeOffProcessTemplate":{"type":"string","maxLength":12,"description":"Write Off Process Template"}}},"writeOffStatus":{"type":"string","enum":["10  ","20  "],"description":"Write-off Status defines the state of the write-off process.\n* `10  ` - Active,\n* `20  ` - Inactive","example":"20"},"writeOffControl":{"type":"object","description":"Write Off Control defines the write-off debt class (i.e., the type of debt) associated with the write-off process.","properties":{"writeOffControl":{"type":"string","maxLength":20,"description":"Write Off Control defines the write-off debt class (i.e., the type of debt) associated with the write-off process.","example":"RES-REGU"}}},"writeOffStatusReason":{"type":"string","enum":["10  ","20  ","30  ","40  "],"description":"Reason defines how a write-off process became Inactive or why a write-off process is Active.\n* `10  ` - Events Pending,\n* `20  ` - Completed,\n* `30  ` - Canceled by System,\n* `40  ` - Canceled by User","example":"20"},"creationDateTime":{"type":"string","format":"date-time","description":"Create Date/Time defines the start date/time of the write-off process.","example":"2005-04-18T07:50:51-04:00"},"comments":{"type":"string","maxLength":254,"description":"Enter any Comments about the write-off process.","example":"TESTQA"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"},"SAs":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"serviceAgreement":{"type":"object","properties":{"serviceAgreementId":{"type":"string","maxLength":10,"description":"Service Agreement"}}},"writeOffSAStatus":{"type":"string","enum":["10  ","20  "],"description":"Write Off SA Status defines the state of the service agreement in respect of the write-off process.\n* `10  ` - Active,\n* `20  ` - Inactive","example":"10"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"}}}}}},"events":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"eventSequence":{"type":"number","maximum":999,"minimum":-999,"description":"Event Sequence is the unique identifier of the event.","example":"10"},"writeOffEventStatus":{"type":"string","enum":["10  ","30  ","40  "],"description":"Write Off Event Status defines the state of the event.\n* `10  ` - Pending,\n* `30  ` - Completed,\n* `40  ` - Canceled","example":"10"},"writeOffEventType":{"type":"object","properties":{"writeOffEventType":{"type":"string","maxLength":12,"description":"Write Off Event Type"}}},"triggerDate":{"type":"string","format":"date","description":"The Trigger Date defines the date when the system completes (i.e., executes) the event.","example":"2009-03-13"},"completionDate":{"type":"string","format":"date","description":"If the status of the event is complete, the Completion Date is displayed with the date on which the system completed the event.","example":"2009-12-13"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"},"eventCustomerContact":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"customerContact":{"type":"object","properties":{"customerContactId":{"type":"string","maxLength":10,"description":"Customer Contact ID"}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"}}}}}}}}}}}},"xml":{"name":"C1WriteOffPr"}},"CREATEWRITEOFFPROCESS_response":{"type":"object","properties":{"_self":{"type":"string","description":"_self"},"writeOffProcessId":{"type":"string","maxLength":10,"description":"Write Off Process ID is the unique system-generated identifier for this write-off process."},"account":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"accountId":{"type":"string","maxLength":10,"description":"Account ID"}}},"writeOffProcessTemplate":{"type":"object","description":"Write Off Process Template defines the write-off events in the process.","properties":{"_link":{"type":"string","description":"_link"},"writeOffProcessTemplate":{"type":"string","maxLength":12,"description":"Write Off Process Template"}}},"writeOffStatus":{"type":"string","enum":["10  ","20  "],"description":"Write-off Status defines the state of the write-off process.\n* `10  ` - Active,\n* `20  ` - Inactive","example":"20"},"writeOffControl":{"type":"object","description":"Write Off Control defines the write-off debt class (i.e., the type of debt) associated with the write-off process.","properties":{"_link":{"type":"string","description":"_link"},"writeOffControl":{"type":"string","maxLength":20,"description":"Write Off Control defines the write-off debt class (i.e., the type of debt) associated with the write-off process.","example":"RES-REGU"}}},"writeOffStatusReason":{"type":"string","enum":["10  ","20  ","30  ","40  "],"description":"Reason defines how a write-off process became Inactive or why a write-off process is Active.\n* `10  ` - Events Pending,\n* `20  ` - Completed,\n* `30  ` - Canceled by System,\n* `40  ` - Canceled by User","example":"20"},"creationDateTime":{"type":"string","format":"date-time","description":"Create Date/Time defines the start date/time of the write-off process.","example":"2005-04-18T07:50:51-04:00"},"comments":{"type":"string","maxLength":254,"description":"Enter any Comments about the write-off process.","example":"TESTQA"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"},"SAs":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"serviceAgreement":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"serviceAgreementId":{"type":"string","maxLength":10,"description":"Service Agreement"}}},"writeOffSAStatus":{"type":"string","enum":["10  ","20  "],"description":"Write Off SA Status defines the state of the service agreement in respect of the write-off process.\n* `10  ` - Active,\n* `20  ` - Inactive","example":"10"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"}}}}}},"events":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"eventSequence":{"type":"number","maximum":999,"minimum":-999,"description":"Event Sequence is the unique identifier of the event.","example":"10"},"writeOffEventStatus":{"type":"string","enum":["10  ","30  ","40  "],"description":"Write Off Event Status defines the state of the event.\n* `10  ` - Pending,\n* `30  ` - Completed,\n* `40  ` - Canceled","example":"10"},"writeOffEventType":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"writeOffEventType":{"type":"string","maxLength":12,"description":"Write Off Event Type"}}},"triggerDate":{"type":"string","format":"date","description":"The Trigger Date defines the date when the system completes (i.e., executes) the event.","example":"2009-03-13"},"completionDate":{"type":"string","format":"date","description":"If the status of the event is complete, the Completion Date is displayed with the date on which the system completed the event.","example":"2009-12-13"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"},"eventCustomerContact":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"customerContact":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"customerContactId":{"type":"string","maxLength":10,"description":"Customer Contact ID"}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"}}}}}}}}}}}},"xml":{"name":"C1WriteOffPr"}},"CREATECOLLECTIONPROCESS_request":{"type":"object","properties":{"collectionProcessId":{"type":"string","maxLength":10,"description":"Collection Process ID is the unique system-generated identifier for this collection process.","example":"6799999999"},"collectionProcessTemplate":{"type":"object","description":"Collection Process Template defines the collection events in the process.","properties":{"collectionProcessTemplate":{"type":"string","maxLength":12,"description":"Collection Process Template defines the collection events in the process.","example":"NORMAL REGUL"}}},"collectionClassControl":{"type":"object","description":"Collection Class Control defines the debt class (i.e., the type of debt) associated with the collection process.","properties":{"collectionClassControl":{"type":"string","maxLength":20,"description":"Collection Class Control defines the debt class (i.e., the type of debt) associated with the collection process.","example":"RES - REGULATED"}}},"account":{"type":"object","properties":{"accountId":{"type":"string","maxLength":10,"description":"Account ID"}}},"currency":{"type":"object","properties":{"currency":{"type":"string","maxLength":3,"description":"Currency Code"}}},"collectionStatus":{"type":"string","enum":["10  ","20  "],"description":"Collection Status defines the state of the collection process.\n* `10  ` - Active,\n* `20  ` - Inactive","example":"10"},"reason":{"type":"string","enum":["10  ","20  ","30  ","40  "],"description":"Collection Status Reason defines how a collection process became Inactive or why a collection process is Active.\n* `10  ` - Events Pending,\n* `20  ` - Completed,\n* `30  ` - Canceled by System,\n* `40  ` - Canceled by User","example":"20"},"collectionConditionPriority":{"type":"string","enum":["10  ","20  ","30  ","40  ","50  ","60  ","70  ","80  ","90  "],"description":"Collection Condition Priority\n* `10  ` - Priority 10 - Highest,\n* `20  ` - Priority 20,\n* `30  ` - Priority 30,\n* `40  ` - Priority 40,\n* `50  ` - Priority 50,\n* `60  ` - Priority 60,\n* `70  ` - Priority 70,\n* `80  ` - Priority 80,\n* `90  ` - Priority 90 - Lowest","example":"10"},"priority":{"type":"string","enum":["10  ","20  ","30  ","40  ","50  ","60  ","70  ","80  ","85  ","90  "],"description":"priority\n* `10  ` - Priority 10 -- Highest,\n* `20  ` - Priority 20,\n* `30  ` - Priority 30,\n* `40  ` - Priority 40,\n* `50  ` - Priority 50,\n* `60  ` - Priority 60,\n* `70  ` - Priority 70,\n* `80  ` - Priority 80,\n* `85  ` - Priority 85,\n* `90  ` - Priority 90 -- Lowest","example":"10"},"creationDateTime":{"type":"string","format":"date-time","description":"Creation Date/Time defines the start date/time of the collection process.","example":"2021-12-02T03:07:47-05:00"},"collectionAmountBaseDate":{"type":"string","format":"date","description":"Arrears Date is the date the event starts aging."},"comments":{"type":"string","maxLength":254,"description":"Enter any Comments about the collection process."},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"},"SAs":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"serviceAgreement":{"type":"object","properties":{"serviceAgreementId":{"type":"string","maxLength":10,"description":"Service Agreement"}}},"status":{"type":"string","enum":["10  ","20  "],"description":"Status:\n* `10  ` - Active,\n* `20  ` - Inactive"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"},"collectionAmount":{"type":"number","maximum":999999.9999,"minimum":-999999.9999,"description":"Customer Contact Information"}}}}}},"events":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"eventSequence":{"type":"number","maximum":999,"minimum":-999,"description":"Event Sequence"},"collectionEventStatus":{"type":"string","enum":["10  ","30  ","40  "],"description":"Collection Event Status defines the state of the event.\n* `10  ` - Pending,\n* `30  ` - Completed,\n* `40  ` - Canceled","example":"40"},"collectionEventType":{"type":"object","properties":{"collectionEventType":{"type":"string","maxLength":12,"description":"Collection Event Type"}}},"triggerDate":{"type":"string","format":"date","description":"The Trigger Date defines the date when the system completes (i.e., executes) the event.","example":"2022-01-01"},"completionDate":{"type":"string","format":"date","description":"If the status of the event is complete, the Completion Date is displayed with the date on which the system completed the event.","example":"2021-12-02"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"},"eventCustomerContact":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"eventSequence":{"type":"number","maximum":999,"minimum":-999,"description":"Event Sequence"},"customerContact":{"type":"object","properties":{"customerContactId":{"type":"string","maxLength":10,"description":"Customer Contact ID"}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"},"customerContactInformation":{"type":"string","maxLength":200,"description":"Customer Contact Information"}}}}}}}}}}},"calculationDateUsingDaysInArrears":{"type":"number","maximum":999,"minimum":-999,"description":"You can have the system calculate Severance Amount Base Date for you by entering the age of the arrears in the field embedded in Calculate Date Using  Days In Arrears."}},"xml":{"name":"C1CollProces"}},"UPDATECOLLECTIONPROCESS_response":{"type":"object","properties":{"_self":{"type":"string","description":"_self"},"collectionProcessId":{"type":"string","maxLength":10,"description":"Collection Process ID is the unique system-generated identifier for this collection process.","example":"6799999999"},"collectionProcessTemplate":{"type":"object","description":"Collection Process Template defines the collection events in the process.","properties":{"_link":{"type":"string","description":"_link"},"collectionProcessTemplate":{"type":"string","maxLength":12,"description":"Collection Process Template defines the collection events in the process.","example":"NORMAL REGUL"}}},"collectionClassControl":{"type":"object","description":"Collection Class Control defines the debt class (i.e., the type of debt) associated with the collection process.","properties":{"_link":{"type":"string","description":"_link"},"collectionClassControl":{"type":"string","maxLength":20,"description":"Collection Class Control defines the debt class (i.e., the type of debt) associated with the collection process.","example":"RES - REGULATED"}}},"account":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"accountId":{"type":"string","maxLength":10,"description":"Account ID"}}},"currency":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"currency":{"type":"string","maxLength":3,"description":"Currency Code"}}},"collectionStatus":{"type":"string","enum":["10  ","20  "],"description":"Collection Status defines the state of the collection process.\n* `10  ` - Active,\n* `20  ` - Inactive","example":"10"},"reason":{"type":"string","enum":["10  ","20  ","30  ","40  "],"description":"Collection Status Reason defines how a collection process became Inactive or why a collection process is Active.\n* `10  ` - Events Pending,\n* `20  ` - Completed,\n* `30  ` - Canceled by System,\n* `40  ` - Canceled by User","example":"20"},"collectionConditionPriority":{"type":"string","enum":["10  ","20  ","30  ","40  ","50  ","60  ","70  ","80  ","90  "],"description":"Collection Condition Priority\n* `10  ` - Priority 10 - Highest,\n* `20  ` - Priority 20,\n* `30  ` - Priority 30,\n* `40  ` - Priority 40,\n* `50  ` - Priority 50,\n* `60  ` - Priority 60,\n* `70  ` - Priority 70,\n* `80  ` - Priority 80,\n* `90  ` - Priority 90 - Lowest","example":"10"},"priority":{"type":"string","enum":["10  ","20  ","30  ","40  ","50  ","60  ","70  ","80  ","85  ","90  "],"description":"priority\n* `10  ` - Priority 10 -- Highest,\n* `20  ` - Priority 20,\n* `30  ` - Priority 30,\n* `40  ` - Priority 40,\n* `50  ` - Priority 50,\n* `60  ` - Priority 60,\n* `70  ` - Priority 70,\n* `80  ` - Priority 80,\n* `85  ` - Priority 85,\n* `90  ` - Priority 90 -- Lowest","example":"10"},"creationDateTime":{"type":"string","format":"date-time","description":"Creation Date/Time defines the start date/time of the collection process.","example":"2021-12-02T03:07:47-05:00"},"collectionAmountBaseDate":{"type":"string","format":"date","description":"Arrears Date is the date the event starts aging."},"comments":{"type":"string","maxLength":254,"description":"Enter any Comments about the collection process."},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"},"SAs":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"serviceAgreement":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"serviceAgreementId":{"type":"string","maxLength":10,"description":"Service Agreement"}}},"status":{"type":"string","enum":["10  ","20  "],"description":"Status:\n* `10  ` - Active,\n* `20  ` - Inactive"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"},"collectionAmount":{"type":"number","maximum":999999.9999,"minimum":-999999.9999,"description":"Customer Contact Information"}}}}}},"events":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"eventSequence":{"type":"number","maximum":999,"minimum":-999,"description":"Event Sequence"},"collectionEventStatus":{"type":"string","enum":["10  ","30  ","40  "],"description":"Collection Event Status defines the state of the event.\n* `10  ` - Pending,\n* `30  ` - Completed,\n* `40  ` - Canceled","example":"40"},"collectionEventType":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"collectionEventType":{"type":"string","maxLength":12,"description":"Collection Event Type"}}},"triggerDate":{"type":"string","format":"date","description":"The Trigger Date defines the date when the system completes (i.e., executes) the event.","example":"2022-01-01"},"completionDate":{"type":"string","format":"date","description":"If the status of the event is complete, the Completion Date is displayed with the date on which the system completed the event.","example":"2021-12-02"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"},"eventCustomerContact":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"eventSequence":{"type":"number","maximum":999,"minimum":-999,"description":"Event Sequence"},"customerContact":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"customerContactId":{"type":"string","maxLength":10,"description":"Customer Contact ID"}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"},"customerContactInformation":{"type":"string","maxLength":200,"description":"Customer Contact Information"}}}}}}}}}}},"calculationDateUsingDaysInArrears":{"type":"number","maximum":999,"minimum":-999,"description":"You can have the system calculate Severance Amount Base Date for you by entering the age of the arrears in the field embedded in Calculate Date Using  Days In Arrears."}},"xml":{"name":"C1CollProces"}},"UPDATECOLLECTIONPROCESS_request":{"type":"object","properties":{"collectionProcessId":{"type":"string","maxLength":10,"description":"Collection Process ID is the unique system-generated identifier for this collection process.","example":"6799999999"},"collectionProcessTemplate":{"type":"object","description":"Collection Process Template defines the collection events in the process.","properties":{"collectionProcessTemplate":{"type":"string","maxLength":12,"description":"Collection Process Template defines the collection events in the process.","example":"NORMAL REGUL"}}},"collectionClassControl":{"type":"object","description":"Collection Class Control defines the debt class (i.e., the type of debt) associated with the collection process.","properties":{"collectionClassControl":{"type":"string","maxLength":20,"description":"Collection Class Control defines the debt class (i.e., the type of debt) associated with the collection process.","example":"RES - REGULATED"}}},"account":{"type":"object","properties":{"accountId":{"type":"string","maxLength":10,"description":"Account ID"}}},"currency":{"type":"object","properties":{"currency":{"type":"string","maxLength":3,"description":"Currency Code"}}},"collectionStatus":{"type":"string","enum":["10  ","20  "],"description":"Collection Status defines the state of the collection process.\n* `10  ` - Active,\n* `20  ` - Inactive","example":"10"},"reason":{"type":"string","enum":["10  ","20  ","30  ","40  "],"description":"Collection Status Reason defines how a collection process became Inactive or why a collection process is Active.\n* `10  ` - Events Pending,\n* `20  ` - Completed,\n* `30  ` - Canceled by System,\n* `40  ` - Canceled by User","example":"20"},"collectionConditionPriority":{"type":"string","enum":["10  ","20  ","30  ","40  ","50  ","60  ","70  ","80  ","90  "],"description":"Collection Condition Priority\n* `10  ` - Priority 10 - Highest,\n* `20  ` - Priority 20,\n* `30  ` - Priority 30,\n* `40  ` - Priority 40,\n* `50  ` - Priority 50,\n* `60  ` - Priority 60,\n* `70  ` - Priority 70,\n* `80  ` - Priority 80,\n* `90  ` - Priority 90 - Lowest","example":"10"},"priority":{"type":"string","enum":["10  ","20  ","30  ","40  ","50  ","60  ","70  ","80  ","85  ","90  "],"description":"priority\n* `10  ` - Priority 10 -- Highest,\n* `20  ` - Priority 20,\n* `30  ` - Priority 30,\n* `40  ` - Priority 40,\n* `50  ` - Priority 50,\n* `60  ` - Priority 60,\n* `70  ` - Priority 70,\n* `80  ` - Priority 80,\n* `85  ` - Priority 85,\n* `90  ` - Priority 90 -- Lowest","example":"10"},"creationDateTime":{"type":"string","format":"date-time","description":"Creation Date/Time defines the start date/time of the collection process.","example":"2021-12-02T03:07:47-05:00"},"collectionAmountBaseDate":{"type":"string","format":"date","description":"Arrears Date is the date the event starts aging."},"comments":{"type":"string","maxLength":254,"description":"Enter any Comments about the collection process."},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"},"SAs":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"serviceAgreement":{"type":"object","properties":{"serviceAgreementId":{"type":"string","maxLength":10,"description":"Service Agreement"}}},"status":{"type":"string","enum":["10  ","20  "],"description":"Status:\n* `10  ` - Active,\n* `20  ` - Inactive"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"},"collectionAmount":{"type":"number","maximum":999999.9999,"minimum":-999999.9999,"description":"Customer Contact Information"}}}}}},"events":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"eventSequence":{"type":"number","maximum":999,"minimum":-999,"description":"Event Sequence"},"collectionEventStatus":{"type":"string","enum":["10  ","30  ","40  "],"description":"Collection Event Status defines the state of the event.\n* `10  ` - Pending,\n* `30  ` - Completed,\n* `40  ` - Canceled","example":"40"},"collectionEventType":{"type":"object","properties":{"collectionEventType":{"type":"string","maxLength":12,"description":"Collection Event Type"}}},"triggerDate":{"type":"string","format":"date","description":"The Trigger Date defines the date when the system completes (i.e., executes) the event.","example":"2022-01-01"},"completionDate":{"type":"string","format":"date","description":"If the status of the event is complete, the Completion Date is displayed with the date on which the system completed the event.","example":"2021-12-02"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"},"eventCustomerContact":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"eventSequence":{"type":"number","maximum":999,"minimum":-999,"description":"Event Sequence"},"customerContact":{"type":"object","properties":{"customerContactId":{"type":"string","maxLength":10,"description":"Customer Contact ID"}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"},"customerContactInformation":{"type":"string","maxLength":200,"description":"Customer Contact Information"}}}}}}}}}}},"calculationDateUsingDaysInArrears":{"type":"number","maximum":999,"minimum":-999,"description":"You can have the system calculate Severance Amount Base Date for you by entering the age of the arrears in the field embedded in Calculate Date Using  Days In Arrears."}},"xml":{"name":"C1CollProces"}},"CREATECOLLECTIONPROCESS_response":{"type":"object","properties":{"_self":{"type":"string","description":"_self"},"collectionProcessId":{"type":"string","maxLength":10,"description":"Collection Process ID is the unique system-generated identifier for this collection process.","example":"6799999999"},"collectionProcessTemplate":{"type":"object","description":"Collection Process Template defines the collection events in the process.","properties":{"_link":{"type":"string","description":"_link"},"collectionProcessTemplate":{"type":"string","maxLength":12,"description":"Collection Process Template defines the collection events in the process.","example":"NORMAL REGUL"}}},"collectionClassControl":{"type":"object","description":"Collection Class Control defines the debt class (i.e., the type of debt) associated with the collection process.","properties":{"_link":{"type":"string","description":"_link"},"collectionClassControl":{"type":"string","maxLength":20,"description":"Collection Class Control defines the debt class (i.e., the type of debt) associated with the collection process.","example":"RES - REGULATED"}}},"account":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"accountId":{"type":"string","maxLength":10,"description":"Account ID"}}},"currency":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"currency":{"type":"string","maxLength":3,"description":"Currency Code"}}},"collectionStatus":{"type":"string","enum":["10  ","20  "],"description":"Collection Status defines the state of the collection process.\n* `10  ` - Active,\n* `20  ` - Inactive","example":"10"},"reason":{"type":"string","enum":["10  ","20  ","30  ","40  "],"description":"Collection Status Reason defines how a collection process became Inactive or why a collection process is Active.\n* `10  ` - Events Pending,\n* `20  ` - Completed,\n* `30  ` - Canceled by System,\n* `40  ` - Canceled by User","example":"20"},"collectionConditionPriority":{"type":"string","enum":["10  ","20  ","30  ","40  ","50  ","60  ","70  ","80  ","90  "],"description":"Collection Condition Priority\n* `10  ` - Priority 10 - Highest,\n* `20  ` - Priority 20,\n* `30  ` - Priority 30,\n* `40  ` - Priority 40,\n* `50  ` - Priority 50,\n* `60  ` - Priority 60,\n* `70  ` - Priority 70,\n* `80  ` - Priority 80,\n* `90  ` - Priority 90 - Lowest","example":"10"},"priority":{"type":"string","enum":["10  ","20  ","30  ","40  ","50  ","60  ","70  ","80  ","85  ","90  "],"description":"priority\n* `10  ` - Priority 10 -- Highest,\n* `20  ` - Priority 20,\n* `30  ` - Priority 30,\n* `40  ` - Priority 40,\n* `50  ` - Priority 50,\n* `60  ` - Priority 60,\n* `70  ` - Priority 70,\n* `80  ` - Priority 80,\n* `85  ` - Priority 85,\n* `90  ` - Priority 90 -- Lowest","example":"10"},"creationDateTime":{"type":"string","format":"date-time","description":"Creation Date/Time defines the start date/time of the collection process.","example":"2021-12-02T03:07:47-05:00"},"collectionAmountBaseDate":{"type":"string","format":"date","description":"Arrears Date is the date the event starts aging."},"comments":{"type":"string","maxLength":254,"description":"Enter any Comments about the collection process."},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"},"SAs":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"serviceAgreement":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"serviceAgreementId":{"type":"string","maxLength":10,"description":"Service Agreement"}}},"status":{"type":"string","enum":["10  ","20  "],"description":"Status:\n* `10  ` - Active,\n* `20  ` - Inactive"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"},"collectionAmount":{"type":"number","maximum":999999.9999,"minimum":-999999.9999,"description":"Customer Contact Information"}}}}}},"events":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"eventSequence":{"type":"number","maximum":999,"minimum":-999,"description":"Event Sequence"},"collectionEventStatus":{"type":"string","enum":["10  ","30  ","40  "],"description":"Collection Event Status defines the state of the event.\n* `10  ` - Pending,\n* `30  ` - Completed,\n* `40  ` - Canceled","example":"40"},"collectionEventType":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"collectionEventType":{"type":"string","maxLength":12,"description":"Collection Event Type"}}},"triggerDate":{"type":"string","format":"date","description":"The Trigger Date defines the date when the system completes (i.e., executes) the event.","example":"2022-01-01"},"completionDate":{"type":"string","format":"date","description":"If the status of the event is complete, the Completion Date is displayed with the date on which the system completed the event.","example":"2021-12-02"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"},"eventCustomerContact":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"eventSequence":{"type":"number","maximum":999,"minimum":-999,"description":"Event Sequence"},"customerContact":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"customerContactId":{"type":"string","maxLength":10,"description":"Customer Contact ID"}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"},"customerContactInformation":{"type":"string","maxLength":200,"description":"Customer Contact Information"}}}}}}}}}}},"calculationDateUsingDaysInArrears":{"type":"number","maximum":999,"minimum":-999,"description":"You can have the system calculate Severance Amount Base Date for you by entering the age of the arrears in the field embedded in Calculate Date Using  Days In Arrears."}},"xml":{"name":"C1CollProces"}},"GETCOLLECTIONPROCESS_response":{"type":"object","properties":{"_self":{"type":"string","description":"_self"},"collectionProcessId":{"type":"string","maxLength":10,"description":"Collection Process ID is the unique system-generated identifier for this collection process.","example":"6799999999"},"collectionProcessTemplate":{"type":"object","description":"Collection Process Template defines the collection events in the process.","properties":{"_link":{"type":"string","description":"_link"},"collectionProcessTemplate":{"type":"string","maxLength":12,"description":"Collection Process Template defines the collection events in the process.","example":"NORMAL REGUL"}}},"collectionClassControl":{"type":"object","description":"Collection Class Control defines the debt class (i.e., the type of debt) associated with the collection process.","properties":{"_link":{"type":"string","description":"_link"},"collectionClassControl":{"type":"string","maxLength":20,"description":"Collection Class Control defines the debt class (i.e., the type of debt) associated with the collection process.","example":"RES - REGULATED"}}},"account":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"accountId":{"type":"string","maxLength":10,"description":"Account ID"}}},"currency":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"currency":{"type":"string","maxLength":3,"description":"Currency Code"}}},"collectionStatus":{"type":"string","enum":["10  ","20  "],"description":"Collection Status defines the state of the collection process.\n* `10  ` - Active,\n* `20  ` - Inactive","example":"10"},"reason":{"type":"string","enum":["10  ","20  ","30  ","40  "],"description":"Collection Status Reason defines how a collection process became Inactive or why a collection process is Active.\n* `10  ` - Events Pending,\n* `20  ` - Completed,\n* `30  ` - Canceled by System,\n* `40  ` - Canceled by User","example":"20"},"collectionConditionPriority":{"type":"string","enum":["10  ","20  ","30  ","40  ","50  ","60  ","70  ","80  ","90  "],"description":"Collection Condition Priority\n* `10  ` - Priority 10 - Highest,\n* `20  ` - Priority 20,\n* `30  ` - Priority 30,\n* `40  ` - Priority 40,\n* `50  ` - Priority 50,\n* `60  ` - Priority 60,\n* `70  ` - Priority 70,\n* `80  ` - Priority 80,\n* `90  ` - Priority 90 - Lowest","example":"10"},"priority":{"type":"string","enum":["10  ","20  ","30  ","40  ","50  ","60  ","70  ","80  ","85  ","90  "],"description":"priority\n* `10  ` - Priority 10 -- Highest,\n* `20  ` - Priority 20,\n* `30  ` - Priority 30,\n* `40  ` - Priority 40,\n* `50  ` - Priority 50,\n* `60  ` - Priority 60,\n* `70  ` - Priority 70,\n* `80  ` - Priority 80,\n* `85  ` - Priority 85,\n* `90  ` - Priority 90 -- Lowest","example":"10"},"creationDateTime":{"type":"string","format":"date-time","description":"Creation Date/Time defines the start date/time of the collection process.","example":"2021-12-02T03:07:47-05:00"},"collectionAmountBaseDate":{"type":"string","format":"date","description":"Arrears Date is the date the event starts aging."},"comments":{"type":"string","maxLength":254,"description":"Enter any Comments about the collection process."},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"},"SAs":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"serviceAgreement":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"serviceAgreementId":{"type":"string","maxLength":10,"description":"Service Agreement"}}},"status":{"type":"string","enum":["10  ","20  "],"description":"Status:\n* `10  ` - Active,\n* `20  ` - Inactive"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"},"collectionAmount":{"type":"number","maximum":999999.9999,"minimum":-999999.9999,"description":"Customer Contact Information"}}}}}},"events":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"eventSequence":{"type":"number","maximum":999,"minimum":-999,"description":"Event Sequence"},"collectionEventStatus":{"type":"string","enum":["10  ","30  ","40  "],"description":"Collection Event Status defines the state of the event.\n* `10  ` - Pending,\n* `30  ` - Completed,\n* `40  ` - Canceled","example":"40"},"collectionEventType":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"collectionEventType":{"type":"string","maxLength":12,"description":"Collection Event Type"}}},"triggerDate":{"type":"string","format":"date","description":"The Trigger Date defines the date when the system completes (i.e., executes) the event.","example":"2022-01-01"},"completionDate":{"type":"string","format":"date","description":"If the status of the event is complete, the Completion Date is displayed with the date on which the system completed the event.","example":"2021-12-02"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"},"eventCustomerContact":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"eventSequence":{"type":"number","maximum":999,"minimum":-999,"description":"Event Sequence"},"customerContact":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"customerContactId":{"type":"string","maxLength":10,"description":"Customer Contact ID"}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"},"customerContactInformation":{"type":"string","maxLength":200,"description":"Customer Contact Information"}}}}}}}}}}},"calculationDateUsingDaysInArrears":{"type":"number","maximum":999,"minimum":-999,"description":"You can have the system calculate Severance Amount Base Date for you by entering the age of the arrears in the field embedded in Calculate Date Using  Days In Arrears."}},"xml":{"name":"C1CollProces"}},"GETSEVERANCEPROCESS_response":{"type":"object","properties":{"_self":{"type":"string","description":"_self"},"severanceProcessId":{"type":"string","maxLength":10,"description":"Severance Process ID is the unique system-generated identifier for this severance process.","example":"1033333333"},"severanceStatus":{"type":"string","enum":["10  ","20  "],"description":"Severance Status defines the state of the severance process.\n* `10  ` - Active,\n* `20  ` - Inactive","example":"20"},"eventSequence":{"type":"number","maximum":999,"minimum":-999,"description":"Event Sequence"},"severanceStatusReason":{"type":"string","enum":["10  ","20  ","30  ","40  "],"description":"Reason defines how a severance process became Inactive or why a severance process is Active.\n* `10  ` - Events Pending,\n* `20  ` - Completed,\n* `30  ` - Canceled by System,\n* `40  ` - Canceled by User","example":"10"},"serviceAgreement":{"type":"object","description":"Service Agreement ID is the system-generated identifier of the service agreement to which the severance process is linked.","properties":{"_link":{"type":"string","description":"_link"},"serviceAgreementId":{"type":"string","maxLength":10,"description":"Service Agreement"}}},"severanceProcessTemplate":{"type":"object","description":"Severance Process Template defines the severance events in the process.","properties":{"_link":{"type":"string","description":"_link"},"severanceProcessTemplate":{"type":"string","maxLength":12,"description":"Severance Process Template defines the severance events in the process.","example":"NORMAL UTIL"}}},"creationDateTime":{"type":"string","format":"date-time","description":"Create Date/Time defines the start date/time of the severance process.","example":"2007-07-02T07:40:37-04:00"},"severanceAmountBaseDate":{"type":"string","format":"date","description":"Arrears Date This is the date the event starts aging."},"collectionAmount":{"type":"number","description":"Arrears Amount"},"comments":{"type":"string","maxLength":254,"description":"Enter any Comments about the severance process."},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"},"events":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"eventSequence":{"type":"number","maximum":999,"minimum":-999,"description":"Event Sequence"},"severanceEventStatus":{"type":"string","enum":["10  ","20  ","30  ","40  "],"description":"Severance Event Status defines the state of the event.\n* `10  ` - Pending,\n* `20  ` - Awaiting Field Activity,\n* `30  ` - Completed,\n* `40  ` - Canceled","example":"20"},"severanceEventType":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"severanceEventType":{"type":"string","maxLength":12,"description":"Severance Event Type"}}},"dependOnOtherEvents":{"type":"boolean","description":"If Dependent on Other Events is turned on, then the event's trigger date is only determined after the event(s) on which it depends are completed.","example":"false"},"triggerDate":{"type":"string","format":"date","description":"The Trigger Date defines the date when the system completes (i.e., executes) the event.","example":"2007-07-02"},"daysAfterPreviousResponse":{"type":"number","maximum":999,"minimum":-999,"description":"Days After Prev Response defines how a dependent event's trigger date is calculated. The trigger date is set equal to X days after the last dependent event is completed, where X is the number in this field.","example":"0"},"completionDate":{"type":"string","format":"date","description":"If the status of the event is complete, the Completion Date is displayed with the date on which the system completes the event."},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"},"severanceEvent":{"type":"string","maxLength":150,"description":"The Severance Events contains the severance events that comprise the severance process.","example":"The Severance Events contains the severance events that comprise the severance process."},"eventDependencies":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"eventSequence":{"type":"number","maximum":999,"minimum":-999,"description":"Event Sequence"},"sequence":{"type":"number","maximum":999,"minimum":-999,"description":"Sequence Number"},"dependentOnSequence":{"type":"number","maximum":999,"minimum":-999,"description":"When Dependent on Other Events is turned on, a grid appears at the bottom of the page which displays the Dependent on Sequence field where you define the event sequence number on which this event depends.","example":"20"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"}}}}}},"eventFieldActivities":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"sequence":{"type":"number","maximum":999,"minimum":-999,"description":"Event Sequence"},"fieldActivity":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"fieldActivityId":{"type":"string","maxLength":10,"description":"Field Activity ID"},"fieldActivityInformation":{"type":"string","maxLength":254,"description":"Field Activity Information"}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"},"servicePoint":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"spInformation":{"type":"string","maxLength":254,"description":"SP Info"},"servicePointId":{"type":"string","maxLength":10,"description":"Service Point ID"}}}}}}}},"eventCustomerContacts":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"sequence":{"type":"number","maximum":999,"minimum":-999,"description":"Event Sequence"},"customerContact":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"customerContactId":{"type":"string","maxLength":10,"description":"Customer Contact ID"}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"},"ccInfo":{"type":"string","description":"(ccInfo)"}}}}}}}}}}},"premise":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"premiseId":{"type":"string","maxLength":10,"description":"The Premise ID is a system assigned random number that stays with a premise for life."}}},"amountStillOwing":{"type":"string","description":"(amtStillOwing2)"},"daysInArrears":{"type":"number","maximum":999,"minimum":-999,"description":"You can have the system calculate Severance Amount Base Date for you by providing the age of the arrears in the number of days."},"createdBy":{"type":"object","properties":{"collectionProcess":{"type":"object","description":"Collection Process ID is the unique system-generated identifier for the collection process.","properties":{"_link":{"type":"string","description":"_link"},"collectionProcessId":{"type":"string","maxLength":10,"description":"Collection Process ID"}}},"eventSequence":{"type":"string","description":"(eventSequence)"},"severanceCriteriaSequence":{"type":"string","description":"(severanceCriteriaSequence)"}}}},"xml":{"name":"C1SeveraProc"}},"UPDATESEVERANCEPROCESS_request":{"type":"object","properties":{"severanceProcessId":{"type":"string","maxLength":10,"description":"Severance Process ID is the unique system-generated identifier for this severance process.","example":"1033333333"},"severanceStatus":{"type":"string","enum":["10  ","20  "],"description":"Severance Status defines the state of the severance process.\n* `10  ` - Active,\n* `20  ` - Inactive","example":"20"},"eventSequence":{"type":"number","maximum":999,"minimum":-999,"description":"Event Sequence"},"severanceStatusReason":{"type":"string","enum":["10  ","20  ","30  ","40  "],"description":"Reason defines how a severance process became Inactive or why a severance process is Active.\n* `10  ` - Events Pending,\n* `20  ` - Completed,\n* `30  ` - Canceled by System,\n* `40  ` - Canceled by User","example":"10"},"serviceAgreement":{"type":"object","description":"Service Agreement ID is the system-generated identifier of the service agreement to which the severance process is linked.","properties":{"serviceAgreementId":{"type":"string","maxLength":10,"description":"Service Agreement"}}},"severanceProcessTemplate":{"type":"object","description":"Severance Process Template defines the severance events in the process.","properties":{"severanceProcessTemplate":{"type":"string","maxLength":12,"description":"Severance Process Template defines the severance events in the process.","example":"NORMAL UTIL"}}},"creationDateTime":{"type":"string","format":"date-time","description":"Create Date/Time defines the start date/time of the severance process.","example":"2007-07-02T07:40:37-04:00"},"severanceAmountBaseDate":{"type":"string","format":"date","description":"Arrears Date This is the date the event starts aging."},"collectionAmount":{"type":"number","description":"Arrears Amount"},"comments":{"type":"string","maxLength":254,"description":"Enter any Comments about the severance process."},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"},"events":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"eventSequence":{"type":"number","maximum":999,"minimum":-999,"description":"Event Sequence"},"severanceEventStatus":{"type":"string","enum":["10  ","20  ","30  ","40  "],"description":"Severance Event Status defines the state of the event.\n* `10  ` - Pending,\n* `20  ` - Awaiting Field Activity,\n* `30  ` - Completed,\n* `40  ` - Canceled","example":"20"},"severanceEventType":{"type":"object","properties":{"severanceEventType":{"type":"string","maxLength":12,"description":"Severance Event Type"}}},"dependOnOtherEvents":{"type":"boolean","description":"If Dependent on Other Events is turned on, then the event's trigger date is only determined after the event(s) on which it depends are completed.","example":"false"},"triggerDate":{"type":"string","format":"date","description":"The Trigger Date defines the date when the system completes (i.e., executes) the event.","example":"2007-07-02"},"daysAfterPreviousResponse":{"type":"number","maximum":999,"minimum":-999,"description":"Days After Prev Response defines how a dependent event's trigger date is calculated. The trigger date is set equal to X days after the last dependent event is completed, where X is the number in this field.","example":"0"},"completionDate":{"type":"string","format":"date","description":"If the status of the event is complete, the Completion Date is displayed with the date on which the system completes the event."},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"},"severanceEvent":{"type":"string","maxLength":150,"description":"The Severance Events contains the severance events that comprise the severance process.","example":"The Severance Events contains the severance events that comprise the severance process."},"eventDependencies":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"eventSequence":{"type":"number","maximum":999,"minimum":-999,"description":"Event Sequence"},"sequence":{"type":"number","maximum":999,"minimum":-999,"description":"Sequence Number"},"dependentOnSequence":{"type":"number","maximum":999,"minimum":-999,"description":"When Dependent on Other Events is turned on, a grid appears at the bottom of the page which displays the Dependent on Sequence field where you define the event sequence number on which this event depends.","example":"20"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"}}}}}},"eventFieldActivities":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"sequence":{"type":"number","maximum":999,"minimum":-999,"description":"Event Sequence"},"fieldActivity":{"type":"object","properties":{"fieldActivityId":{"type":"string","maxLength":10,"description":"Field Activity ID"},"fieldActivityInformation":{"type":"string","maxLength":254,"description":"Field Activity Information"}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"},"servicePoint":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"spInformation":{"type":"string","maxLength":254,"description":"SP Info"},"servicePointId":{"type":"string","maxLength":10,"description":"Service Point ID"}}}}}}}},"eventCustomerContacts":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"sequence":{"type":"number","maximum":999,"minimum":-999,"description":"Event Sequence"},"customerContact":{"type":"object","properties":{"customerContactId":{"type":"string","maxLength":10,"description":"Customer Contact ID"}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"},"ccInfo":{"type":"string","description":"(ccInfo)"}}}}}}}}}}},"premise":{"type":"object","properties":{"premiseId":{"type":"string","maxLength":10,"description":"The Premise ID is a system assigned random number that stays with a premise for life."}}},"amountStillOwing":{"type":"string","description":"(amtStillOwing2)"},"daysInArrears":{"type":"number","maximum":999,"minimum":-999,"description":"You can have the system calculate Severance Amount Base Date for you by providing the age of the arrears in the number of days."},"isCancel":{"type":"boolean","description":"Cancel button is used to cancel the severance process.","example":"false"},"createdBy":{"type":"object","properties":{"collectionProcess":{"type":"object","description":"Collection Process ID is the unique system-generated identifier for the collection process.","properties":{"collectionProcessId":{"type":"string","maxLength":10,"description":"Collection Process ID"}}},"eventSequence":{"type":"string","description":"(eventSequence)"},"severanceCriteriaSequence":{"type":"string","description":"(severanceCriteriaSequence)"}}}},"xml":{"name":"C1SeveraProc"}},"UPDATESEVERANCEPROCESS_response":{"type":"object","properties":{"_self":{"type":"string","description":"_self"},"severanceProcessId":{"type":"string","maxLength":10,"description":"Severance Process ID is the unique system-generated identifier for this severance process.","example":"1033333333"},"severanceStatus":{"type":"string","enum":["10  ","20  "],"description":"Severance Status defines the state of the severance process.\n* `10  ` - Active,\n* `20  ` - Inactive","example":"20"},"eventSequence":{"type":"number","maximum":999,"minimum":-999,"description":"Event Sequence"},"severanceStatusReason":{"type":"string","enum":["10  ","20  ","30  ","40  "],"description":"Reason defines how a severance process became Inactive or why a severance process is Active.\n* `10  ` - Events Pending,\n* `20  ` - Completed,\n* `30  ` - Canceled by System,\n* `40  ` - Canceled by User","example":"10"},"serviceAgreement":{"type":"object","description":"Service Agreement ID is the system-generated identifier of the service agreement to which the severance process is linked.","properties":{"_link":{"type":"string","description":"_link"},"serviceAgreementId":{"type":"string","maxLength":10,"description":"Service Agreement"}}},"severanceProcessTemplate":{"type":"object","description":"Severance Process Template defines the severance events in the process.","properties":{"_link":{"type":"string","description":"_link"},"severanceProcessTemplate":{"type":"string","maxLength":12,"description":"Severance Process Template defines the severance events in the process.","example":"NORMAL UTIL"}}},"creationDateTime":{"type":"string","format":"date-time","description":"Create Date/Time defines the start date/time of the severance process.","example":"2007-07-02T07:40:37-04:00"},"severanceAmountBaseDate":{"type":"string","format":"date","description":"Arrears Date This is the date the event starts aging."},"collectionAmount":{"type":"number","description":"Arrears Amount"},"comments":{"type":"string","maxLength":254,"description":"Enter any Comments about the severance process."},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"},"events":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"eventSequence":{"type":"number","maximum":999,"minimum":-999,"description":"Event Sequence"},"severanceEventStatus":{"type":"string","enum":["10  ","20  ","30  ","40  "],"description":"Severance Event Status defines the state of the event.\n* `10  ` - Pending,\n* `20  ` - Awaiting Field Activity,\n* `30  ` - Completed,\n* `40  ` - Canceled","example":"20"},"severanceEventType":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"severanceEventType":{"type":"string","maxLength":12,"description":"Severance Event Type"}}},"dependOnOtherEvents":{"type":"boolean","description":"If Dependent on Other Events is turned on, then the event's trigger date is only determined after the event(s) on which it depends are completed.","example":"false"},"triggerDate":{"type":"string","format":"date","description":"The Trigger Date defines the date when the system completes (i.e., executes) the event.","example":"2007-07-02"},"daysAfterPreviousResponse":{"type":"number","maximum":999,"minimum":-999,"description":"Days After Prev Response defines how a dependent event's trigger date is calculated. The trigger date is set equal to X days after the last dependent event is completed, where X is the number in this field.","example":"0"},"completionDate":{"type":"string","format":"date","description":"If the status of the event is complete, the Completion Date is displayed with the date on which the system completes the event."},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"},"severanceEvent":{"type":"string","maxLength":150,"description":"The Severance Events contains the severance events that comprise the severance process.","example":"The Severance Events contains the severance events that comprise the severance process."},"eventDependencies":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"eventSequence":{"type":"number","maximum":999,"minimum":-999,"description":"Event Sequence"},"sequence":{"type":"number","maximum":999,"minimum":-999,"description":"Sequence Number"},"dependentOnSequence":{"type":"number","maximum":999,"minimum":-999,"description":"When Dependent on Other Events is turned on, a grid appears at the bottom of the page which displays the Dependent on Sequence field where you define the event sequence number on which this event depends.","example":"20"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"}}}}}},"eventFieldActivities":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"sequence":{"type":"number","maximum":999,"minimum":-999,"description":"Event Sequence"},"fieldActivity":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"fieldActivityId":{"type":"string","maxLength":10,"description":"Field Activity ID"},"fieldActivityInformation":{"type":"string","maxLength":254,"description":"Field Activity Information"}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"},"servicePoint":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"spInformation":{"type":"string","maxLength":254,"description":"SP Info"},"servicePointId":{"type":"string","maxLength":10,"description":"Service Point ID"}}}}}}}},"eventCustomerContacts":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"sequence":{"type":"number","maximum":999,"minimum":-999,"description":"Event Sequence"},"customerContact":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"customerContactId":{"type":"string","maxLength":10,"description":"Customer Contact ID"}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"},"ccInfo":{"type":"string","description":"(ccInfo)"}}}}}}}}}}},"premise":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"premiseId":{"type":"string","maxLength":10,"description":"The Premise ID is a system assigned random number that stays with a premise for life."}}},"amountStillOwing":{"type":"string","description":"(amtStillOwing2)"},"daysInArrears":{"type":"number","maximum":999,"minimum":-999,"description":"You can have the system calculate Severance Amount Base Date for you by providing the age of the arrears in the number of days."},"createdBy":{"type":"object","properties":{"collectionProcess":{"type":"object","description":"Collection Process ID is the unique system-generated identifier for the collection process.","properties":{"_link":{"type":"string","description":"_link"},"collectionProcessId":{"type":"string","maxLength":10,"description":"Collection Process ID"}}},"eventSequence":{"type":"string","description":"(eventSequence)"},"severanceCriteriaSequence":{"type":"string","description":"(severanceCriteriaSequence)"}}}},"xml":{"name":"C1SeveraProc"}},"CREATESEVERANCEPROCESS_request":{"type":"object","properties":{"severanceProcessId":{"type":"string","maxLength":10,"description":"Severance Process ID is the unique system-generated identifier for this severance process.","example":"1033333333"},"severanceStatus":{"type":"string","enum":["10  ","20  "],"description":"Severance Status defines the state of the severance process.\n* `10  ` - Active,\n* `20  ` - Inactive","example":"20"},"eventSequence":{"type":"number","maximum":999,"minimum":-999,"description":"Event Sequence"},"severanceStatusReason":{"type":"string","enum":["10  ","20  ","30  ","40  "],"description":"Reason defines how a severance process became Inactive or why a severance process is Active.\n* `10  ` - Events Pending,\n* `20  ` - Completed,\n* `30  ` - Canceled by System,\n* `40  ` - Canceled by User","example":"10"},"serviceAgreement":{"type":"object","description":"Service Agreement ID is the system-generated identifier of the service agreement to which the severance process is linked.","properties":{"serviceAgreementId":{"type":"string","maxLength":10,"description":"Service Agreement"}}},"severanceProcessTemplate":{"type":"object","description":"Severance Process Template defines the severance events in the process.","properties":{"severanceProcessTemplate":{"type":"string","maxLength":12,"description":"Severance Process Template defines the severance events in the process.","example":"NORMAL UTIL"}}},"creationDateTime":{"type":"string","format":"date-time","description":"Create Date/Time defines the start date/time of the severance process.","example":"2007-07-02T07:40:37-04:00"},"severanceAmountBaseDate":{"type":"string","format":"date","description":"Arrears Date This is the date the event starts aging."},"collectionAmount":{"type":"number","description":"Arrears Amount"},"comments":{"type":"string","maxLength":254,"description":"Enter any Comments about the severance process."},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"},"events":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"eventSequence":{"type":"number","maximum":999,"minimum":-999,"description":"Event Sequence"},"severanceEventStatus":{"type":"string","enum":["10  ","20  ","30  ","40  "],"description":"Severance Event Status defines the state of the event.\n* `10  ` - Pending,\n* `20  ` - Awaiting Field Activity,\n* `30  ` - Completed,\n* `40  ` - Canceled","example":"20"},"severanceEventType":{"type":"object","properties":{"severanceEventType":{"type":"string","maxLength":12,"description":"Severance Event Type"}}},"dependOnOtherEvents":{"type":"boolean","description":"If Dependent on Other Events is turned on, then the event's trigger date is only determined after the event(s) on which it depends are completed.","example":"false"},"triggerDate":{"type":"string","format":"date","description":"The Trigger Date defines the date when the system completes (i.e., executes) the event.","example":"2007-07-02"},"daysAfterPreviousResponse":{"type":"number","maximum":999,"minimum":-999,"description":"Days After Prev Response defines how a dependent event's trigger date is calculated. The trigger date is set equal to X days after the last dependent event is completed, where X is the number in this field.","example":"0"},"completionDate":{"type":"string","format":"date","description":"If the status of the event is complete, the Completion Date is displayed with the date on which the system completes the event."},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"},"severanceEvent":{"type":"string","maxLength":150,"description":"The Severance Events contains the severance events that comprise the severance process.","example":"The Severance Events contains the severance events that comprise the severance process."},"eventDependencies":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"eventSequence":{"type":"number","maximum":999,"minimum":-999,"description":"Event Sequence"},"sequence":{"type":"number","maximum":999,"minimum":-999,"description":"Sequence Number"},"dependentOnSequence":{"type":"number","maximum":999,"minimum":-999,"description":"When Dependent on Other Events is turned on, a grid appears at the bottom of the page which displays the Dependent on Sequence field where you define the event sequence number on which this event depends.","example":"20"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"}}}}}},"eventFieldActivities":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"sequence":{"type":"number","maximum":999,"minimum":-999,"description":"Event Sequence"},"fieldActivity":{"type":"object","properties":{"fieldActivityId":{"type":"string","maxLength":10,"description":"Field Activity ID"},"fieldActivityInformation":{"type":"string","maxLength":254,"description":"Field Activity Information"}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"},"servicePoint":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"spInformation":{"type":"string","maxLength":254,"description":"SP Info"},"servicePointId":{"type":"string","maxLength":10,"description":"Service Point ID"}}}}}}}},"eventCustomerContacts":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"sequence":{"type":"number","maximum":999,"minimum":-999,"description":"Event Sequence"},"customerContact":{"type":"object","properties":{"customerContactId":{"type":"string","maxLength":10,"description":"Customer Contact ID"}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"},"ccInfo":{"type":"string","description":"(ccInfo)"}}}}}}}}}}},"premise":{"type":"object","properties":{"premiseId":{"type":"string","maxLength":10,"description":"The Premise ID is a system assigned random number that stays with a premise for life."}}},"amountStillOwing":{"type":"string","description":"(amtStillOwing2)"},"daysInArrears":{"type":"number","maximum":999,"minimum":-999,"description":"You can have the system calculate Severance Amount Base Date for you by providing the age of the arrears in the number of days."},"isCancel":{"type":"boolean","description":"Cancel button is used to cancel the severance process.","example":"false"},"createdBy":{"type":"object","properties":{"collectionProcess":{"type":"object","description":"Collection Process ID is the unique system-generated identifier for the collection process.","properties":{"collectionProcessId":{"type":"string","maxLength":10,"description":"Collection Process ID"}}},"eventSequence":{"type":"string","description":"(eventSequence)"},"severanceCriteriaSequence":{"type":"string","description":"(severanceCriteriaSequence)"}}}},"xml":{"name":"C1SeveraProc"}},"CREATESEVERANCEPROCESS_response":{"type":"object","properties":{"_self":{"type":"string","description":"_self"},"severanceProcessId":{"type":"string","maxLength":10,"description":"Severance Process ID is the unique system-generated identifier for this severance process.","example":"1033333333"},"severanceStatus":{"type":"string","enum":["10  ","20  "],"description":"Severance Status defines the state of the severance process.\n* `10  ` - Active,\n* `20  ` - Inactive","example":"20"},"eventSequence":{"type":"number","maximum":999,"minimum":-999,"description":"Event Sequence"},"severanceStatusReason":{"type":"string","enum":["10  ","20  ","30  ","40  "],"description":"Reason defines how a severance process became Inactive or why a severance process is Active.\n* `10  ` - Events Pending,\n* `20  ` - Completed,\n* `30  ` - Canceled by System,\n* `40  ` - Canceled by User","example":"10"},"serviceAgreement":{"type":"object","description":"Service Agreement ID is the system-generated identifier of the service agreement to which the severance process is linked.","properties":{"_link":{"type":"string","description":"_link"},"serviceAgreementId":{"type":"string","maxLength":10,"description":"Service Agreement"}}},"severanceProcessTemplate":{"type":"object","description":"Severance Process Template defines the severance events in the process.","properties":{"_link":{"type":"string","description":"_link"},"severanceProcessTemplate":{"type":"string","maxLength":12,"description":"Severance Process Template defines the severance events in the process.","example":"NORMAL UTIL"}}},"creationDateTime":{"type":"string","format":"date-time","description":"Create Date/Time defines the start date/time of the severance process.","example":"2007-07-02T07:40:37-04:00"},"severanceAmountBaseDate":{"type":"string","format":"date","description":"Arrears Date This is the date the event starts aging."},"collectionAmount":{"type":"number","description":"Arrears Amount"},"comments":{"type":"string","maxLength":254,"description":"Enter any Comments about the severance process."},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"},"events":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"eventSequence":{"type":"number","maximum":999,"minimum":-999,"description":"Event Sequence"},"severanceEventStatus":{"type":"string","enum":["10  ","20  ","30  ","40  "],"description":"Severance Event Status defines the state of the event.\n* `10  ` - Pending,\n* `20  ` - Awaiting Field Activity,\n* `30  ` - Completed,\n* `40  ` - Canceled","example":"20"},"severanceEventType":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"severanceEventType":{"type":"string","maxLength":12,"description":"Severance Event Type"}}},"dependOnOtherEvents":{"type":"boolean","description":"If Dependent on Other Events is turned on, then the event's trigger date is only determined after the event(s) on which it depends are completed.","example":"false"},"triggerDate":{"type":"string","format":"date","description":"The Trigger Date defines the date when the system completes (i.e., executes) the event.","example":"2007-07-02"},"daysAfterPreviousResponse":{"type":"number","maximum":999,"minimum":-999,"description":"Days After Prev Response defines how a dependent event's trigger date is calculated. The trigger date is set equal to X days after the last dependent event is completed, where X is the number in this field.","example":"0"},"completionDate":{"type":"string","format":"date","description":"If the status of the event is complete, the Completion Date is displayed with the date on which the system completes the event."},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"},"severanceEvent":{"type":"string","maxLength":150,"description":"The Severance Events contains the severance events that comprise the severance process.","example":"The Severance Events contains the severance events that comprise the severance process."},"eventDependencies":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"eventSequence":{"type":"number","maximum":999,"minimum":-999,"description":"Event Sequence"},"sequence":{"type":"number","maximum":999,"minimum":-999,"description":"Sequence Number"},"dependentOnSequence":{"type":"number","maximum":999,"minimum":-999,"description":"When Dependent on Other Events is turned on, a grid appears at the bottom of the page which displays the Dependent on Sequence field where you define the event sequence number on which this event depends.","example":"20"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"}}}}}},"eventFieldActivities":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"sequence":{"type":"number","maximum":999,"minimum":-999,"description":"Event Sequence"},"fieldActivity":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"fieldActivityId":{"type":"string","maxLength":10,"description":"Field Activity ID"},"fieldActivityInformation":{"type":"string","maxLength":254,"description":"Field Activity Information"}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"},"servicePoint":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"spInformation":{"type":"string","maxLength":254,"description":"SP Info"},"servicePointId":{"type":"string","maxLength":10,"description":"Service Point ID"}}}}}}}},"eventCustomerContacts":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"sequence":{"type":"number","maximum":999,"minimum":-999,"description":"Event Sequence"},"customerContact":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"customerContactId":{"type":"string","maxLength":10,"description":"Customer Contact ID"}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"},"ccInfo":{"type":"string","description":"(ccInfo)"}}}}}}}}}}},"premise":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"premiseId":{"type":"string","maxLength":10,"description":"The Premise ID is a system assigned random number that stays with a premise for life."}}},"amountStillOwing":{"type":"string","description":"(amtStillOwing2)"},"daysInArrears":{"type":"number","maximum":999,"minimum":-999,"description":"You can have the system calculate Severance Amount Base Date for you by providing the age of the arrears in the number of days."},"createdBy":{"type":"object","properties":{"collectionProcess":{"type":"object","description":"Collection Process ID is the unique system-generated identifier for the collection process.","properties":{"_link":{"type":"string","description":"_link"},"collectionProcessId":{"type":"string","maxLength":10,"description":"Collection Process ID"}}},"eventSequence":{"type":"string","description":"(eventSequence)"},"severanceCriteriaSequence":{"type":"string","description":"(severanceCriteriaSequence)"}}}},"xml":{"name":"C1SeveraProc"}},"DELETELANDLORDAGREEMENT_response":{"type":"object","properties":{"landLord":{"type":"string","maxLength":10,"description":"Landlord ID is a system-assigned random number that stays with the landlord agreement for life.","example":"9999999999"}},"xml":{"name":"C1DelLandlAg"}},"GETLANDLORDAGREEMENT_response":{"type":"object","properties":{"_self":{"type":"string","description":"_self"},"account":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"accountId":{"type":"string","maxLength":10,"description":"Account ID"}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks.","example":"1"},"description":{"type":"string","maxLength":60,"description":"Enter a Description of the landlord agreement.","example":"Bowers Property Mgts"},"landlordAgreementDetail":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"serviceType":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"serviceType":{"type":"string","maxLength":30,"description":"Service Type"}}},"isSeasonal":{"type":"boolean","description":"Turn on Seasonal if the service should only revert to the landlords account during a specific season of the year.","example":"false"},"startMonthDay":{"type":"string","maxLength":4,"description":"When Seasonal is turned on, the Start Month/Day and the End Month/Day is defined for the effective season.","example":"0101"},"endMonthDay":{"type":"string","maxLength":4,"description":"When Seasonal is turned on, the Start Month/Day and the End Month/Day is defined for the effective season.","example":"0610"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks.","example":"1"}}}}}}},"xml":{"name":"C1LandlordAg"}},"DELETELANDLORDAGREEMENT_request":{"type":"object","properties":{"landLord":{"type":"string","maxLength":10,"description":"Landlord ID is a system-assigned random number that stays with the landlord agreement for life.","example":"9999999999"}},"xml":{"name":"C1DelLandlAg"}},"CREATELANDLORDAGREEMENT_request":{"type":"object","properties":{"account":{"type":"object","properties":{"accountId":{"type":"string","maxLength":10,"description":"Account ID"}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks.","example":"1"},"description":{"type":"string","maxLength":60,"description":"Enter a Description of the landlord agreement.","example":"Bowers Property Mgts"},"landlordAgreementDetail":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"landLord":{"type":"string","maxLength":10,"description":"Landlord Agreement ID"},"serviceType":{"type":"object","properties":{"serviceType":{"type":"string","maxLength":30,"description":"Service Type"}}},"isSeasonal":{"type":"boolean","description":"Turn on Seasonal if the service should only revert to the landlords account during a specific season of the year.","example":"false"},"startMonthDay":{"type":"string","maxLength":4,"description":"When Seasonal is turned on, the Start Month/Day and the End Month/Day is defined for the effective season.","example":"0101"},"endMonthDay":{"type":"string","maxLength":4,"description":"When Seasonal is turned on, the Start Month/Day and the End Month/Day is defined for the effective season.","example":"0610"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks.","example":"1"}}}}}}},"xml":{"name":"C1LandlordAg"}},"UPDATELANDLORDAGREEMENT_response":{"type":"object","properties":{"_self":{"type":"string","description":"_self"},"account":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"accountId":{"type":"string","maxLength":10,"description":"Account ID"}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks.","example":"1"},"description":{"type":"string","maxLength":60,"description":"Enter a Description of the landlord agreement.","example":"Bowers Property Mgts"},"landlordAgreementDetail":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"serviceType":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"serviceType":{"type":"string","maxLength":30,"description":"Service Type"}}},"isSeasonal":{"type":"boolean","description":"Turn on Seasonal if the service should only revert to the landlords account during a specific season of the year.","example":"false"},"startMonthDay":{"type":"string","maxLength":4,"description":"When Seasonal is turned on, the Start Month/Day and the End Month/Day is defined for the effective season.","example":"0101"},"endMonthDay":{"type":"string","maxLength":4,"description":"When Seasonal is turned on, the Start Month/Day and the End Month/Day is defined for the effective season.","example":"0610"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks.","example":"1"}}}}}}},"xml":{"name":"C1LandlordAg"}},"CREATELANDLORDAGREEMENT_response":{"type":"object","properties":{"_self":{"type":"string","description":"_self"},"landLord":{"type":"string","maxLength":10,"description":"Landlord ID is a system-assigned random number that stays with the landlord agreement for life.","example":"9999999999"},"account":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"accountId":{"type":"string","maxLength":10,"description":"Account ID"}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks.","example":"1"},"description":{"type":"string","maxLength":60,"description":"Enter a Description of the landlord agreement.","example":"Bowers Property Mgts"},"landlordAgreementDetail":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"serviceType":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"serviceType":{"type":"string","maxLength":30,"description":"Service Type"}}},"isSeasonal":{"type":"boolean","description":"Turn on Seasonal if the service should only revert to the landlords account during a specific season of the year.","example":"false"},"startMonthDay":{"type":"string","maxLength":4,"description":"When Seasonal is turned on, the Start Month/Day and the End Month/Day is defined for the effective season.","example":"0101"},"endMonthDay":{"type":"string","maxLength":4,"description":"When Seasonal is turned on, the Start Month/Day and the End Month/Day is defined for the effective season.","example":"0610"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks.","example":"1"}}}}}}},"xml":{"name":"C1LandlordAg"}},"UPDATELANDLORDAGREEMENT_request":{"type":"object","properties":{"landLord":{"type":"string","maxLength":10,"description":"Landlord ID is a system-assigned random number that stays with the landlord agreement for life.","example":"9999999999"},"account":{"type":"object","properties":{"accountId":{"type":"string","maxLength":10,"description":"Account ID"}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks.","example":"1"},"description":{"type":"string","maxLength":60,"description":"Enter a Description of the landlord agreement.","example":"Bowers Property Mgts"},"landlordAgreementDetail":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"landLord":{"type":"string","maxLength":10,"description":"Landlord Agreement ID"},"serviceType":{"type":"object","properties":{"serviceType":{"type":"string","maxLength":30,"description":"Service Type"}}},"isSeasonal":{"type":"boolean","description":"Turn on Seasonal if the service should only revert to the landlords account during a specific season of the year.","example":"false"},"startMonthDay":{"type":"string","maxLength":4,"description":"When Seasonal is turned on, the Start Month/Day and the End Month/Day is defined for the effective season.","example":"0101"},"endMonthDay":{"type":"string","maxLength":4,"description":"When Seasonal is turned on, the Start Month/Day and the End Month/Day is defined for the effective season.","example":"0610"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks.","example":"1"}}}}}}},"xml":{"name":"C1LandlordAg"}},"GETPROGRAMCONTEXTS_response":{"type":"object","properties":{"_self":{"type":"string","description":"_self"},"context":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"property":{"type":"string","enum":["PPB","CustCls","SvcType","EBill","CashOnly","Budget","PayExt","PayArr","AutoPay","Charity"],"description":"(property):\n* `PPB` - PPB Indicator,\n* `CustCls` - Customer class,\n* `SvcType` - Service type,\n* `EBill` - Paperless Billing Indicator,\n* `CashOnly` - Cash-Only indicator,\n* `Budget` - Budget billing indicator,\n* `PayExt` - Payment Extension Enrollment Indicator,\n* `PayArr` - Payment Arrangement Indicator,\n* `AutoPay` - Active autopay indicator,\n* `Charity` - Charity enrollment indicator"},"value":{"type":"string","description":"(value)"}}}}}}},"xml":{"name":"X1-GtProgCtx"}},"CREATEWEBUSER_request":{"type":"object","properties":{"httpMethod":{"type":"string","enum":["DELT","GET ","POST","PTCH","PUT "],"description":"HTTP Method\n* `DELT` - Delete,\n* `GET ` - Get,\n* `POST` - Post,\n* `PTCH` - Patch,\n* `PUT ` - Put","example":"POST"},"webUserName":{"type":"string","maxLength":254,"description":"Web User Name","example":"testUser31"},"clientWebUserId":{"type":"string","maxLength":254,"description":"Client Web User ID","example":"ClientUser31"},"status":{"type":"string","maxLength":12,"description":"status"},"webUserActiveInactive":{"type":"string","enum":["C1AC","C1IN"],"description":"Web User Status\n* `C1AC` - Active,\n* `C1IN` - Inactive","example":"C1AC"},"webUserRole":{"type":"string","maxLength":254,"description":"Web User Role","example":"WSSAdminGroup"},"person":{"type":"object","properties":{"personId":{"type":"string","maxLength":10,"description":"Person ID"}}},"contact":{"type":"object","properties":{"contactId":{"type":"string","maxLength":10,"description":"Person Contact"}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"version","example":"1"}},"xml":{"name":"C1-WebUser"}},"DELETEWEBUSER_response":{"type":"object","properties":{"webUserId":{"type":"string","maxLength":10,"description":"Web User ID","example":"0022528877"}},"xml":{"name":"C1-DelWebUsr"}},"UPDATEWEBUSER_response":{"type":"object","properties":{"_self":{"type":"string","description":"_self"},"httpMethod":{"type":"string","enum":["DELT","GET ","POST","PTCH","PUT "],"description":"HTTP Method\n* `DELT` - Delete,\n* `GET ` - Get,\n* `POST` - Post,\n* `PTCH` - Patch,\n* `PUT ` - Put","example":"POST"},"webUserName":{"type":"string","maxLength":254,"description":"Web User Name","example":"testUser31"},"clientWebUserId":{"type":"string","maxLength":254,"description":"Client Web User ID","example":"ClientUser31"},"status":{"type":"string","maxLength":12,"description":"status"},"webUserActiveInactive":{"type":"string","enum":["C1AC","C1IN"],"description":"Web User Status\n* `C1AC` - Active,\n* `C1IN` - Inactive","example":"C1AC"},"webUserRole":{"type":"string","maxLength":254,"description":"Web User Role","example":"WSSAdminGroup"},"person":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"personId":{"type":"string","maxLength":10,"description":"Person ID"}}},"contact":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"contactId":{"type":"string","maxLength":10,"description":"Person Contact"}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"version","example":"1"}},"xml":{"name":"C1-WebUser"}},"GETWEBUSER_response":{"type":"object","properties":{"_self":{"type":"string","description":"_self"},"httpMethod":{"type":"string","enum":["DELT","GET ","POST","PTCH","PUT "],"description":"HTTP Method\n* `DELT` - Delete,\n* `GET ` - Get,\n* `POST` - Post,\n* `PTCH` - Patch,\n* `PUT ` - Put","example":"POST"},"webUserName":{"type":"string","maxLength":254,"description":"Web User Name","example":"testUser31"},"clientWebUserId":{"type":"string","maxLength":254,"description":"Client Web User ID","example":"ClientUser31"},"status":{"type":"string","maxLength":12,"description":"status"},"webUserActiveInactive":{"type":"string","enum":["C1AC","C1IN"],"description":"Web User Status\n* `C1AC` - Active,\n* `C1IN` - Inactive","example":"C1AC"},"webUserRole":{"type":"string","maxLength":254,"description":"Web User Role","example":"WSSAdminGroup"},"person":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"personId":{"type":"string","maxLength":10,"description":"Person ID"}}},"contact":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"contactId":{"type":"string","maxLength":10,"description":"Person Contact"}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"version","example":"1"}},"xml":{"name":"C1-WebUser"}},"DELETEWEBUSER_request":{"type":"object","properties":{"webUserId":{"type":"string","maxLength":10,"description":"Web User ID","example":"0022528877"}},"xml":{"name":"C1-DelWebUsr"}},"CREATEWEBUSER_response":{"type":"object","properties":{"_self":{"type":"string","description":"_self"},"httpMethod":{"type":"string","enum":["DELT","GET ","POST","PTCH","PUT "],"description":"HTTP Method\n* `DELT` - Delete,\n* `GET ` - Get,\n* `POST` - Post,\n* `PTCH` - Patch,\n* `PUT ` - Put","example":"POST"},"webUserId":{"type":"string","maxLength":10,"description":"Web User ID","example":"0022528877"},"webUserName":{"type":"string","maxLength":254,"description":"Web User Name","example":"testUser31"},"clientWebUserId":{"type":"string","maxLength":254,"description":"Client Web User ID","example":"ClientUser31"},"status":{"type":"string","maxLength":12,"description":"status"},"webUserActiveInactive":{"type":"string","enum":["C1AC","C1IN"],"description":"Web User Status\n* `C1AC` - Active,\n* `C1IN` - Inactive","example":"C1AC"},"webUserRole":{"type":"string","maxLength":254,"description":"Web User Role","example":"WSSAdminGroup"},"person":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"personId":{"type":"string","maxLength":10,"description":"Person ID"}}},"contact":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"contactId":{"type":"string","maxLength":10,"description":"Person Contact"}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"version","example":"1"}},"xml":{"name":"C1-WebUser"}},"UPDATEWEBUSER_request":{"type":"object","properties":{"httpMethod":{"type":"string","enum":["DELT","GET ","POST","PTCH","PUT "],"description":"HTTP Method\n* `DELT` - Delete,\n* `GET ` - Get,\n* `POST` - Post,\n* `PTCH` - Patch,\n* `PUT ` - Put","example":"POST"},"webUserId":{"type":"string","maxLength":10,"description":"Web User ID","example":"0022528877"},"webUserName":{"type":"string","maxLength":254,"description":"Web User Name","example":"testUser31"},"clientWebUserId":{"type":"string","maxLength":254,"description":"Client Web User ID","example":"ClientUser31"},"status":{"type":"string","maxLength":12,"description":"status"},"webUserActiveInactive":{"type":"string","enum":["C1AC","C1IN"],"description":"Web User Status\n* `C1AC` - Active,\n* `C1IN` - Inactive","example":"C1AC"},"webUserRole":{"type":"string","maxLength":254,"description":"Web User Role","example":"WSSAdminGroup"},"person":{"type":"object","properties":{"personId":{"type":"string","maxLength":10,"description":"Person ID"}}},"contact":{"type":"object","properties":{"contactId":{"type":"string","maxLength":10,"description":"Person Contact"}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"version","example":"1"}},"xml":{"name":"C1-WebUser"}},"DELETEWEBUSERACCOUNT_response":{"type":"object","properties":{"accountId":{"type":"string","maxLength":10,"description":"Account ID","example":"2241606344"},"webUserId":{"type":"string","maxLength":10,"description":"Web User Id","example":"1213348966"}},"xml":{"name":"C1-DelWbUsAt"}},"UPDATEWEBUSERACCOUNT_response":{"type":"object","properties":{"_self":{"type":"string","description":"_self"},"accountId":{"type":"string","maxLength":10,"description":"Account ID","example":"2241606344"},"webUserId":{"type":"string","maxLength":10,"description":"Web User Id","example":"1213348966"},"status":{"type":"string","maxLength":12,"description":"status"},"webUserAccountRole":{"type":"string","maxLength":254,"description":"Web User Account Role","example":"CXAH"},"person":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"personId":{"type":"string","maxLength":10,"description":"Person ID","example":"1343682500"}}},"webUserAccountNickname":{"type":"string","maxLength":254,"description":"Web User Account Nickname","example":"Main Account Test"},"webUserAccountStatus":{"type":"string","enum":["C1AC","C1IN"],"description":"Web User Account Status\n* `C1AC` - Active,\n* `C1IN` - inactive","example":"C1IN"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"version","example":"1"},"businessLine":{"type":"string","maxLength":30,"description":"Line of Business","example":"RESIDENTIAL"},"errorInformation":{"type":"object","properties":{"isInError":{"type":"boolean","description":"Error"},"errorReference":{"type":"object","properties":{"category":{"type":"number","maximum":99999,"minimum":-99999,"description":"Message Category"},"number":{"type":"number","maximum":99999,"minimum":-99999,"description":"Message Number"}}},"errorMessage":{"type":"string","maxLength":254,"description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."}}}},"xml":{"name":"C1-CxWbUsrAt"}},"GETWEBUSERACCOUNT_response":{"type":"object","properties":{"_self":{"type":"string","description":"_self"},"accountId":{"type":"string","maxLength":10,"description":"Account ID","example":"2241606344"},"webUserId":{"type":"string","maxLength":10,"description":"Web User Id","example":"1213348966"},"status":{"type":"string","maxLength":12,"description":"status"},"webUserAccountRole":{"type":"string","maxLength":254,"description":"Web User Account Role","example":"CXAH"},"person":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"personId":{"type":"string","maxLength":10,"description":"Person ID","example":"1343682500"}}},"webUserAccountNickname":{"type":"string","maxLength":254,"description":"Web User Account Nickname","example":"Main Account Test"},"webUserAccountStatus":{"type":"string","enum":["C1AC","C1IN"],"description":"Web User Account Status\n* `C1AC` - Active,\n* `C1IN` - inactive","example":"C1IN"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"version","example":"1"},"businessLine":{"type":"string","maxLength":30,"description":"Line of Business","example":"RESIDENTIAL"},"accountVerification":{"type":"object","properties":{"group":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","maxLength":30,"description":"Group Name","example":"IDENTIFIERS"},"fields":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","maxLength":254,"description":"value","example":"123-45-6789"},"fieldType":{"type":"string","enum":["C1AP","C1PC","WXAP","WXID","WXPH","ZZBN","ZZMA","ZZPC"],"description":"Field Type\n* `C1AP` - Match Any Person Contact Phone,\n* `C1PC` - Match Person Contact Type,\n* `WXAP` - Match Any Phone,\n* `WXID` - Match Identifier,\n* `WXPH` - Match Phone Type,\n* `ZZBN` - Match Meter Number (zz),\n* `ZZMA` - Match Street Address (zz),\n* `ZZPC` - Match Postal Code (zz)","example":"WXID"},"identifierType":{"type":"string","description":"(identifierType)"}}}}}}},"isVerified":{"type":"boolean","description":"Is Verified","example":"false"}}},"errorInformation":{"type":"object","properties":{"isInError":{"type":"boolean","description":"Error"},"errorReference":{"type":"object","properties":{"category":{"type":"number","maximum":99999,"minimum":-99999,"description":"Message Category"},"number":{"type":"number","maximum":99999,"minimum":-99999,"description":"Message Number"}}},"errorMessage":{"type":"string","maxLength":254,"description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."}}}},"xml":{"name":"C1-CxWbUsrAt"}},"UPDATEWEBUSERACCOUNT_request":{"type":"object","properties":{"accountId":{"type":"string","maxLength":10,"description":"Account ID","example":"2241606344"},"webUserId":{"type":"string","maxLength":10,"description":"Web User Id","example":"1213348966"},"status":{"type":"string","maxLength":12,"description":"status"},"webUserAccountRole":{"type":"string","maxLength":254,"description":"Web User Account Role","example":"CXAH"},"person":{"type":"object","properties":{"personId":{"type":"string","maxLength":10,"description":"Person ID","example":"1343682500"}}},"webUserAccountNickname":{"type":"string","maxLength":254,"description":"Web User Account Nickname","example":"Main Account Test"},"webUserAccountStatus":{"type":"string","enum":["C1AC","C1IN"],"description":"Web User Account Status\n* `C1AC` - Active,\n* `C1IN` - inactive","example":"C1IN"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"version","example":"1"},"businessLine":{"type":"string","maxLength":30,"description":"Line of Business","example":"RESIDENTIAL"}},"xml":{"name":"C1-CxWbUsrAt"}},"CREATEWEBUSERACCOUNT_response":{"type":"object","properties":{"_self":{"type":"string","description":"_self"},"accountId":{"type":"string","maxLength":10,"description":"Account ID","example":"2241606344"},"webUserId":{"type":"string","maxLength":10,"description":"Web User Id","example":"1213348966"},"status":{"type":"string","maxLength":12,"description":"status"},"webUserAccountRole":{"type":"string","maxLength":254,"description":"Web User Account Role","example":"CXAH"},"person":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"personId":{"type":"string","maxLength":10,"description":"Person ID","example":"1343682500"}}},"webUserAccountNickname":{"type":"string","maxLength":254,"description":"Web User Account Nickname","example":"Main Account Test"},"webUserAccountStatus":{"type":"string","enum":["C1AC","C1IN"],"description":"Web User Account Status\n* `C1AC` - Active,\n* `C1IN` - inactive","example":"C1IN"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"version","example":"1"},"businessLine":{"type":"string","maxLength":30,"description":"Line of Business","example":"RESIDENTIAL"},"errorInformation":{"type":"object","properties":{"isInError":{"type":"boolean","description":"Error"},"errorReference":{"type":"object","properties":{"category":{"type":"number","maximum":99999,"minimum":-99999,"description":"Message Category"},"number":{"type":"number","maximum":99999,"minimum":-99999,"description":"Message Number"}}},"errorMessage":{"type":"string","maxLength":254,"description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."}}}},"xml":{"name":"C1-CxWbUsrAt"}},"CREATEWEBUSERACCOUNT_request":{"type":"object","properties":{"accountId":{"type":"string","maxLength":10,"description":"Account ID","example":"2241606344"},"webUserId":{"type":"string","maxLength":10,"description":"Web User Id","example":"1213348966"},"status":{"type":"string","maxLength":12,"description":"status"},"webUserAccountRole":{"type":"string","maxLength":254,"description":"Web User Account Role","example":"CXAH"},"person":{"type":"object","properties":{"personId":{"type":"string","maxLength":10,"description":"Person ID","example":"1343682500"}}},"webUserAccountNickname":{"type":"string","maxLength":254,"description":"Web User Account Nickname","example":"Main Account Test"},"webUserAccountStatus":{"type":"string","enum":["C1AC","C1IN"],"description":"Web User Account Status\n* `C1AC` - Active,\n* `C1IN` - inactive","example":"C1IN"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"version","example":"1"},"businessLine":{"type":"string","maxLength":30,"description":"Line of Business","example":"RESIDENTIAL"},"accountVerification":{"type":"object","properties":{"group":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","maxLength":30,"description":"Group Name","example":"IDENTIFIERS"},"fields":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","maxLength":254,"description":"value","example":"123-45-6789"},"fieldType":{"type":"string","enum":["C1AP","C1PC","WXAP","WXID","WXPH","ZZBN","ZZMA","ZZPC"],"description":"Field Type\n* `C1AP` - Match Any Person Contact Phone,\n* `C1PC` - Match Person Contact Type,\n* `WXAP` - Match Any Phone,\n* `WXID` - Match Identifier,\n* `WXPH` - Match Phone Type,\n* `ZZBN` - Match Meter Number (zz),\n* `ZZMA` - Match Street Address (zz),\n* `ZZPC` - Match Postal Code (zz)","example":"WXID"},"identifierType":{"type":"string","description":"(identifierType)"}}}}}}},"isVerified":{"type":"boolean","description":"Is Verified","example":"false"}}}},"xml":{"name":"C1-CxWbUsrAt"}},"DELETEWEBUSERACCOUNT_request":{"type":"object","properties":{"accountId":{"type":"string","maxLength":10,"description":"Account ID","example":"2241606344"},"webUserId":{"type":"string","maxLength":10,"description":"Web User Id","example":"1213348966"}},"xml":{"name":"C1-DelWbUsAt"}},"GETACCOUNTVERIFICATIONINFO_response":{"type":"object","properties":{"_self":{"type":"string","description":"_self"},"accountId":{"type":"string","maxLength":10,"description":"Account ID","example":"2241606344"},"businessLine":{"type":"string","maxLength":30,"description":"Line of Business","example":"RESIDENTIAL"},"accountVerification":{"type":"object","properties":{"group":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","maxLength":30,"description":"Group Name","example":"IDENTIFIERS"},"fields":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","maxLength":254,"description":"value","example":"123-45-6789"},"fieldType":{"type":"string","enum":["C1AP","C1PC","WXAP","WXID","WXPH","ZZBN","ZZMA","ZZPC"],"description":"Field Type\n* `C1AP` - Match Any Person Contact Phone,\n* `C1PC` - Match Person Contact Type,\n* `WXAP` - Match Any Phone,\n* `WXID` - Match Identifier,\n* `WXPH` - Match Phone Type,\n* `ZZBN` - Match Meter Number (zz),\n* `ZZMA` - Match Street Address (zz),\n* `ZZPC` - Match Postal Code (zz)","example":"WXID"},"identifierType":{"type":"string","description":"(identifierType)"},"description":{"type":"string","description":"(description)"},"format":{"type":"string","description":"(format)"}}}}}}},"isVerified":{"type":"boolean","description":"Is Verified","example":"false"}}},"errorInformation":{"type":"object","properties":{"isInError":{"type":"boolean","description":"Error"},"errorReference":{"type":"object","properties":{"category":{"type":"number","maximum":99999,"minimum":-99999,"description":"Message Category"},"number":{"type":"number","maximum":99999,"minimum":-99999,"description":"Message Number"}}},"errorMessage":{"type":"string","maxLength":254,"description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."}}}},"xml":{"name":"C1-VerAcct"}},"SEARCHWEBUSERACCOUNT_response":{"type":"object","properties":{"webUserId":{"type":"string","maxLength":10,"description":"Web User Id","example":"1213348966"},"addressLine":{"type":"string","maxLength":254,"description":"Address"},"city":{"type":"string","maxLength":90,"description":"City"},"state":{"type":"string","maxLength":6,"description":"State"},"postal":{"type":"string","maxLength":12,"description":"Postal"},"nickname":{"type":"string","maxLength":254,"description":"Web User Account Nickname","example":"Main Account Test"},"accountId":{"type":"string","maxLength":10,"description":"Account ID","example":"2241606344"},"offset":{"type":"number","maximum":99999999999999,"minimum":-99999999999999,"description":"Number"},"limit":{"type":"number","maximum":99999999999999,"minimum":-99999999999999,"description":"Number"},"totalRecords":{"type":"number","maximum":99999999999999,"minimum":-99999999999999,"description":"Number"},"connectedAccounts":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"account":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"accountId":{"type":"string","maxLength":10,"description":"Account ID"}}},"webUserAccountRole":{"type":"string","maxLength":254,"description":"Web User Account Role"},"person":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"personId":{"type":"string","maxLength":10,"description":"Person ID"}}},"webUserAccountNickname":{"type":"string","maxLength":254,"description":"Web User Account Nickname"},"multiplePremiseExist":{"type":"boolean","description":"(multiplePremiseExist)"},"mainCustomerName":{"type":"string","maxLength":254,"description":"Name"},"premise":{"type":"array","items":{"type":"object","properties":{"premise":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"premiseId":{"type":"string","maxLength":10,"description":"Premise ID"}}},"country":{"type":"string","maxLength":3,"description":"Country"},"addressLine1":{"type":"string","maxLength":254,"description":"Address"},"addressLine2":{"type":"string","maxLength":254,"description":"Address 2"},"addressLine3":{"type":"string","maxLength":254,"description":"Address 3"},"addressLine4":{"type":"string","maxLength":254,"description":"Address 4"},"houseType":{"type":"string","enum":["AB  ","WW  "],"description":"House Type:\n* `AB  ` - House Boat References,\n* `WW  ` - House Trailer Reference"},"number1":{"type":"string","maxLength":6,"description":"Number 1"},"number2":{"type":"string","maxLength":4,"description":"Number 2"},"inCityLimit":{"type":"boolean","description":"In City Limit"},"city":{"type":"string","maxLength":90,"description":"City"},"geographic":{"type":"string","maxLength":11,"description":"Geographical Code"},"county":{"type":"string","maxLength":90,"description":"County"},"state":{"type":"string","maxLength":6,"description":"State"},"postal":{"type":"string","maxLength":12,"description":"Postal"}}}}}}}}},"errorInformation":{"type":"object","properties":{"isInError":{"type":"boolean","description":"Error"},"errorReference":{"type":"object","properties":{"category":{"type":"number","maximum":99999,"minimum":-99999,"description":"Message Category"},"number":{"type":"number","maximum":99999,"minimum":-99999,"description":"Message Number"}}},"errorMessage":{"type":"string","maxLength":254,"description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."}}}},"xml":{"name":"C1-SrWbUsrAt"}},"CREATECUSTOMERCONTACT_request":{"type":"object","properties":{"contactDateTime":{"type":"string","format":"date-time","description":"Contact Date/Time displays the date and time that the contact was saved into the system..","example":"2017-04-05T14:25:43-04:00"},"shouldPrintLetter":{"type":"boolean","description":"Adding a customer contact may cause a letter to be generated. You can set up a customer contact type to generate a form letter whenever a customer contact of this type is added.  If the letter is going to be printed in the next batch run, the Print Letter switch is on. Turning the switch off removes the letter from being printed in the next batch run. This applies to letters that have never been printed and those that have been set to reprint.","example":"false"},"letterPrintDateTime":{"type":"string","format":"date-time","description":"The letter extract batch process will update the date and time that the letter was produced for sending."},"letterTemplate":{"type":"object","description":"If the customer contact references a customer contact type that, in turn, references a letter template, the template controls the type of information that is merged into the 'form letter' and how the letter is physically produced.","properties":{"letterTemplate":{"type":"string","maxLength":12,"description":"If the customer contact references a customer contact type that, in turn, references a letter template, the template controls the type of information that is merged into the 'form letter' and how the letter is physically produced."}}},"customerContactType":{"type":"object","properties":{"contactClass":{"type":"string","maxLength":4,"description":"Contact Class categorizes customer contacts into larger groupings for reporting purposes.","example":"CSS"},"contactType":{"type":"string","maxLength":12,"description":"Every customer contact has a Contact Type that classifies the record for reporting purposes. Every contact type, in turn, references a Contact Class.  The customer contact type controls the relationship validation among person, account, and premise. You can set up a customer contact type to generate a form letter whenever a customer contact of this type is added. In fact, this is the only way to generate a letter in the system.","example":"ACCESS"}}},"customerContactStatus":{"type":"string","enum":["10  "],"description":"Open designates that the event or issue associated to the contact has not been resolved. For example, if a customer calls with a high bill complaint that can't be resolved immediately, you would turn on the Open switch and enter an appropriate entry in the Log.\n* `10  ` - Open"},"preferredContactMethod":{"type":"string","enum":["C1PC","EM  ","FAX ","N/A ","PH  ","POST","SMS "],"description":"Preferred Contact Method indicates how the person prefers to be contacted.\n* `C1PC` - Person Contact,\n* `EM  ` - Email,\n* `FAX ` - Fax,\n* `N/A ` - Not Applicable,\n* `PH  ` - Phone,\n* `POST` - Postal,\n* `SMS ` - SMS","example":"N/A"},"contactDetail":{"type":"object","description":"Contact Detail ID is a system-assigned, unique identifier of the person contact associated with the customers preferred contact method.","properties":{"contactDetailId":{"type":"string","maxLength":10,"description":"Person Contact"}}},"user":{"type":"object","description":"User ID of the user who created the contact.","properties":{"userId":{"type":"string","maxLength":8,"description":"User"}}},"person":{"type":"object","properties":{"personId":{"type":"string","maxLength":10,"description":"Person ID displays the associated person's unique, system-generated ID. If the customer contact is Person-based the Person ID cannot be changed. There should be no value if the Customer Contact Type indicates that a person is not allowed on customer contacts of this type.","example":"5775933103"}}},"premise":{"type":"object","properties":{"premiseId":{"type":"string","maxLength":10,"description":"Premise ID field displays the associated premise's unique, system-generated ID. If the customer contact is Premise-based the Premise ID cannot be changed.  There should be no value if the Customer Contact Type indicates that a premise is not allowed on customer contacts of this type."}}},"account":{"type":"object","properties":{"accountId":{"type":"string","maxLength":10,"description":"Account ID displays the account's unique, system-generated ID. The account must be associated to the person when the contact is created or updated.  There should be no value if the Customer Contact Type indicates that an account is not allowed on customer contacts of this type.","example":"5922116763"}}},"customerContactEntity":{"type":"string","enum":["PER ","PREM"],"description":"Indicates if customer contact is related to the customer as person-based or to a service location as premise-based.\n* `PER ` - Person,\n* `PREM` - Premise","example":"PER"},"longDescription":{"type":"string","maxLength":4000,"description":"Stores comments that can provide initial information about why the record was created and any other relevant text for historical reference purposes."},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version number is used for internal concurrency checks.","example":"1"},"characteristics":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"characteristicType":{"type":"object","properties":{"characteristicType":{"type":"string","maxLength":8,"description":"Characteristic Type"}}},"characteristicValue":{"type":"object","properties":{"_link":{"type":"string","description":"(_link)"},"value":{"type":"string","description":"(value)"},"value2":{"type":"string","description":"(value2)"},"value3":{"type":"string","description":"(value3)"},"value4":{"type":"string","description":"(value4)"},"value5":{"type":"string","description":"(value5)"}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version number is used for internal concurrency checks.","example":"1"}}}}}},"logs":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"triggerDate":{"type":"string","format":"date","description":"Trigger Date is only used if you want the system to remind a user about this customer contact on a future date. The system will create a To Do entry to remind the user about the customer contact.   This value defines the latest date on which the To Do entry should be created because the background process that's responsible for creating these To Do entries has a parameter called Lead Time that is used to define the number of days before the Trigger Date that the To Do entry should be created."},"toDoRole":{"type":"object","properties":{"toDoRoleId":{"type":"string","maxLength":10,"description":"To Do Role"}}},"assignedToUser":{"type":"object","properties":{"assignedToUserId":{"type":"string","maxLength":8,"description":"User"}}},"user":{"type":"object","properties":{"userId":{"type":"string","maxLength":8,"description":"User"}}},"logEntry":{"type":"string","maxLength":2000,"description":"Log Entry can be used to describe the reason for the log entry."},"triggerBusinessProcess":{"type":"boolean","description":"Trigger Business Process is a true or false value for reminders."},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version number is used for internal concurrency checks.","example":"1"}}}}}}},"xml":{"name":"C1-CustCntct"}},"UPDATECUSTOMERCONTACT_request":{"type":"object","properties":{"customerContactId":{"type":"string","maxLength":10,"description":"System-assigned, unique identifier of the customer contact record","example":"5774836290"},"contactDateTime":{"type":"string","format":"date-time","description":"Contact Date/Time displays the date and time that the contact was saved into the system..","example":"2017-04-05T14:25:43-04:00"},"shouldPrintLetter":{"type":"boolean","description":"Adding a customer contact may cause a letter to be generated. You can set up a customer contact type to generate a form letter whenever a customer contact of this type is added.  If the letter is going to be printed in the next batch run, the Print Letter switch is on. Turning the switch off removes the letter from being printed in the next batch run. This applies to letters that have never been printed and those that have been set to reprint.","example":"false"},"letterPrintDateTime":{"type":"string","format":"date-time","description":"The letter extract batch process will update the date and time that the letter was produced for sending."},"letterTemplate":{"type":"object","description":"If the customer contact references a customer contact type that, in turn, references a letter template, the template controls the type of information that is merged into the 'form letter' and how the letter is physically produced.","properties":{"letterTemplate":{"type":"string","maxLength":12,"description":"If the customer contact references a customer contact type that, in turn, references a letter template, the template controls the type of information that is merged into the 'form letter' and how the letter is physically produced."}}},"customerContactType":{"type":"object","properties":{"contactClass":{"type":"string","maxLength":4,"description":"Contact Class categorizes customer contacts into larger groupings for reporting purposes.","example":"CSS"},"contactType":{"type":"string","maxLength":12,"description":"Every customer contact has a Contact Type that classifies the record for reporting purposes. Every contact type, in turn, references a Contact Class.  The customer contact type controls the relationship validation among person, account, and premise. You can set up a customer contact type to generate a form letter whenever a customer contact of this type is added. In fact, this is the only way to generate a letter in the system.","example":"ACCESS"}}},"customerContactStatus":{"type":"string","enum":["10  "],"description":"Open designates that the event or issue associated to the contact has not been resolved. For example, if a customer calls with a high bill complaint that can't be resolved immediately, you would turn on the Open switch and enter an appropriate entry in the Log.\n* `10  ` - Open"},"preferredContactMethod":{"type":"string","enum":["C1PC","EM  ","FAX ","N/A ","PH  ","POST","SMS "],"description":"Preferred Contact Method indicates how the person prefers to be contacted.\n* `C1PC` - Person Contact,\n* `EM  ` - Email,\n* `FAX ` - Fax,\n* `N/A ` - Not Applicable,\n* `PH  ` - Phone,\n* `POST` - Postal,\n* `SMS ` - SMS","example":"N/A"},"contactDetail":{"type":"object","description":"Contact Detail ID is a system-assigned, unique identifier of the person contact associated with the customers preferred contact method.","properties":{"contactDetailId":{"type":"string","maxLength":10,"description":"Person Contact"}}},"user":{"type":"object","description":"User ID of the user who created the contact.","properties":{"userId":{"type":"string","maxLength":8,"description":"User"}}},"person":{"type":"object","properties":{"personId":{"type":"string","maxLength":10,"description":"Person ID displays the associated person's unique, system-generated ID. If the customer contact is Person-based the Person ID cannot be changed. There should be no value if the Customer Contact Type indicates that a person is not allowed on customer contacts of this type.","example":"5775933103"}}},"premise":{"type":"object","properties":{"premiseId":{"type":"string","maxLength":10,"description":"Premise ID field displays the associated premise's unique, system-generated ID. If the customer contact is Premise-based the Premise ID cannot be changed.  There should be no value if the Customer Contact Type indicates that a premise is not allowed on customer contacts of this type."}}},"account":{"type":"object","properties":{"accountId":{"type":"string","maxLength":10,"description":"Account ID displays the account's unique, system-generated ID. The account must be associated to the person when the contact is created or updated.  There should be no value if the Customer Contact Type indicates that an account is not allowed on customer contacts of this type.","example":"5922116763"}}},"customerContactEntity":{"type":"string","enum":["PER ","PREM"],"description":"Indicates if customer contact is related to the customer as person-based or to a service location as premise-based.\n* `PER ` - Person,\n* `PREM` - Premise","example":"PER"},"longDescription":{"type":"string","maxLength":4000,"description":"Stores comments that can provide initial information about why the record was created and any other relevant text for historical reference purposes."},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version number is used for internal concurrency checks.","example":"1"},"characteristics":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"characteristicType":{"type":"object","properties":{"characteristicType":{"type":"string","maxLength":8,"description":"Characteristic Type"}}},"characteristicValue":{"type":"object","properties":{"_link":{"type":"string","description":"(_link)"},"value":{"type":"string","description":"(value)"},"value2":{"type":"string","description":"(value2)"},"value3":{"type":"string","description":"(value3)"},"value4":{"type":"string","description":"(value4)"},"value5":{"type":"string","description":"(value5)"}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version number is used for internal concurrency checks.","example":"1"}}}}}},"logs":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"triggerDate":{"type":"string","format":"date","description":"Trigger Date is only used if you want the system to remind a user about this customer contact on a future date. The system will create a To Do entry to remind the user about the customer contact.   This value defines the latest date on which the To Do entry should be created because the background process that's responsible for creating these To Do entries has a parameter called Lead Time that is used to define the number of days before the Trigger Date that the To Do entry should be created."},"toDoRole":{"type":"object","properties":{"toDoRoleId":{"type":"string","maxLength":10,"description":"To Do Role"}}},"assignedToUser":{"type":"object","properties":{"assignedToUserId":{"type":"string","maxLength":8,"description":"User"}}},"user":{"type":"object","properties":{"userId":{"type":"string","maxLength":8,"description":"User"}}},"logEntry":{"type":"string","maxLength":2000,"description":"Log Entry can be used to describe the reason for the log entry."},"triggerBusinessProcess":{"type":"boolean","description":"Trigger Business Process is a true or false value for reminders."},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version number is used for internal concurrency checks.","example":"1"}}}}}}},"xml":{"name":"C1-CustCntct"}},"CREATECUSTOMERCONTACT_response":{"type":"object","properties":{"_self":{"type":"string","description":"_self"},"customerContactId":{"type":"string","maxLength":10,"description":"System-assigned, unique identifier of the customer contact record","example":"5774836290"},"contactDateTime":{"type":"string","format":"date-time","description":"Contact Date/Time displays the date and time that the contact was saved into the system..","example":"2017-04-05T14:25:43-04:00"},"shouldPrintLetter":{"type":"boolean","description":"Adding a customer contact may cause a letter to be generated. You can set up a customer contact type to generate a form letter whenever a customer contact of this type is added.  If the letter is going to be printed in the next batch run, the Print Letter switch is on. Turning the switch off removes the letter from being printed in the next batch run. This applies to letters that have never been printed and those that have been set to reprint.","example":"false"},"letterPrintDateTime":{"type":"string","format":"date-time","description":"The letter extract batch process will update the date and time that the letter was produced for sending."},"letterTemplate":{"type":"object","description":"If the customer contact references a customer contact type that, in turn, references a letter template, the template controls the type of information that is merged into the 'form letter' and how the letter is physically produced.","properties":{"_link":{"type":"string","description":"_link"},"letterTemplate":{"type":"string","maxLength":12,"description":"If the customer contact references a customer contact type that, in turn, references a letter template, the template controls the type of information that is merged into the 'form letter' and how the letter is physically produced."}}},"customerContactType":{"type":"object","properties":{"contactClass":{"type":"string","maxLength":4,"description":"Contact Class categorizes customer contacts into larger groupings for reporting purposes.","example":"CSS"},"contactType":{"type":"string","maxLength":12,"description":"Every customer contact has a Contact Type that classifies the record for reporting purposes. Every contact type, in turn, references a Contact Class.  The customer contact type controls the relationship validation among person, account, and premise. You can set up a customer contact type to generate a form letter whenever a customer contact of this type is added. In fact, this is the only way to generate a letter in the system.","example":"ACCESS"}}},"customerContactStatus":{"type":"string","enum":["10  "],"description":"Open designates that the event or issue associated to the contact has not been resolved. For example, if a customer calls with a high bill complaint that can't be resolved immediately, you would turn on the Open switch and enter an appropriate entry in the Log.\n* `10  ` - Open"},"preferredContactMethod":{"type":"string","enum":["C1PC","EM  ","FAX ","N/A ","PH  ","POST","SMS "],"description":"Preferred Contact Method indicates how the person prefers to be contacted.\n* `C1PC` - Person Contact,\n* `EM  ` - Email,\n* `FAX ` - Fax,\n* `N/A ` - Not Applicable,\n* `PH  ` - Phone,\n* `POST` - Postal,\n* `SMS ` - SMS","example":"N/A"},"contactDetail":{"type":"object","description":"Contact Detail ID is a system-assigned, unique identifier of the person contact associated with the customers preferred contact method.","properties":{"_link":{"type":"string","description":"_link"},"contactDetailId":{"type":"string","maxLength":10,"description":"Person Contact"}}},"user":{"type":"object","description":"User ID of the user who created the contact.","properties":{"_link":{"type":"string","description":"_link"},"userId":{"type":"string","maxLength":8,"description":"User"}}},"person":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"personId":{"type":"string","maxLength":10,"description":"Person ID displays the associated person's unique, system-generated ID. If the customer contact is Person-based the Person ID cannot be changed. There should be no value if the Customer Contact Type indicates that a person is not allowed on customer contacts of this type.","example":"5775933103"}}},"premise":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"premiseId":{"type":"string","maxLength":10,"description":"Premise ID field displays the associated premise's unique, system-generated ID. If the customer contact is Premise-based the Premise ID cannot be changed.  There should be no value if the Customer Contact Type indicates that a premise is not allowed on customer contacts of this type."}}},"account":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"accountId":{"type":"string","maxLength":10,"description":"Account ID displays the account's unique, system-generated ID. The account must be associated to the person when the contact is created or updated.  There should be no value if the Customer Contact Type indicates that an account is not allowed on customer contacts of this type.","example":"5922116763"}}},"customerContactEntity":{"type":"string","enum":["PER ","PREM"],"description":"Indicates if customer contact is related to the customer as person-based or to a service location as premise-based.\n* `PER ` - Person,\n* `PREM` - Premise","example":"PER"},"longDescription":{"type":"string","maxLength":4000,"description":"Stores comments that can provide initial information about why the record was created and any other relevant text for historical reference purposes."},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version number is used for internal concurrency checks.","example":"1"},"characteristics":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"characteristicType":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"characteristicType":{"type":"string","maxLength":8,"description":"Characteristic Type"}}},"typeOfCharacteristicValue":{"type":"string","maxLength":4,"description":"Type of Char Value"},"characteristicValue":{"type":"object","properties":{"_link":{"type":"string","description":"(_link)"},"value":{"type":"string","description":"(value)"},"value2":{"type":"string","description":"(value2)"},"value3":{"type":"string","description":"(value3)"},"value4":{"type":"string","description":"(value4)"},"value5":{"type":"string","description":"(value5)"}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version number is used for internal concurrency checks.","example":"1"}}}}}},"logs":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"customerContactLogId":{"type":"string","maxLength":12,"description":"Customer Contact Log ID"},"triggerDate":{"type":"string","format":"date","description":"Trigger Date is only used if you want the system to remind a user about this customer contact on a future date. The system will create a To Do entry to remind the user about the customer contact.   This value defines the latest date on which the To Do entry should be created because the background process that's responsible for creating these To Do entries has a parameter called Lead Time that is used to define the number of days before the Trigger Date that the To Do entry should be created."},"toDoRole":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"toDoRoleId":{"type":"string","maxLength":10,"description":"To Do Role"}}},"assignedToUser":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"assignedToUserId":{"type":"string","maxLength":8,"description":"User"}}},"user":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"userId":{"type":"string","maxLength":8,"description":"User"}}},"creationDateTime":{"type":"string","format":"date-time","description":"Create Date/Time"},"logEntry":{"type":"string","maxLength":2000,"description":"Log Entry can be used to describe the reason for the log entry."},"triggerBusinessProcess":{"type":"boolean","description":"Trigger Business Process is a true or false value for reminders."},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version number is used for internal concurrency checks.","example":"1"}}}}}}},"xml":{"name":"C1-CustCntct"}},"GETCUSTOMERCONTACT_response":{"type":"object","properties":{"_self":{"type":"string","description":"_self"},"contactDateTime":{"type":"string","format":"date-time","description":"Contact Date/Time displays the date and time that the contact was saved into the system..","example":"2017-04-05T14:25:43-04:00"},"shouldPrintLetter":{"type":"boolean","description":"Adding a customer contact may cause a letter to be generated. You can set up a customer contact type to generate a form letter whenever a customer contact of this type is added.  If the letter is going to be printed in the next batch run, the Print Letter switch is on. Turning the switch off removes the letter from being printed in the next batch run. This applies to letters that have never been printed and those that have been set to reprint.","example":"false"},"letterPrintDateTime":{"type":"string","format":"date-time","description":"The letter extract batch process will update the date and time that the letter was produced for sending."},"letterTemplate":{"type":"object","description":"If the customer contact references a customer contact type that, in turn, references a letter template, the template controls the type of information that is merged into the 'form letter' and how the letter is physically produced.","properties":{"_link":{"type":"string","description":"_link"},"letterTemplate":{"type":"string","maxLength":12,"description":"If the customer contact references a customer contact type that, in turn, references a letter template, the template controls the type of information that is merged into the 'form letter' and how the letter is physically produced."}}},"customerContactType":{"type":"object","properties":{"contactClass":{"type":"string","maxLength":4,"description":"Contact Class categorizes customer contacts into larger groupings for reporting purposes.","example":"CSS"},"contactType":{"type":"string","maxLength":12,"description":"Every customer contact has a Contact Type that classifies the record for reporting purposes. Every contact type, in turn, references a Contact Class.  The customer contact type controls the relationship validation among person, account, and premise. You can set up a customer contact type to generate a form letter whenever a customer contact of this type is added. In fact, this is the only way to generate a letter in the system.","example":"ACCESS"}}},"customerContactStatus":{"type":"string","enum":["10  "],"description":"Open designates that the event or issue associated to the contact has not been resolved. For example, if a customer calls with a high bill complaint that can't be resolved immediately, you would turn on the Open switch and enter an appropriate entry in the Log.\n* `10  ` - Open"},"preferredContactMethod":{"type":"string","enum":["C1PC","EM  ","FAX ","N/A ","PH  ","POST","SMS "],"description":"Preferred Contact Method indicates how the person prefers to be contacted.\n* `C1PC` - Person Contact,\n* `EM  ` - Email,\n* `FAX ` - Fax,\n* `N/A ` - Not Applicable,\n* `PH  ` - Phone,\n* `POST` - Postal,\n* `SMS ` - SMS","example":"N/A"},"contactDetail":{"type":"object","description":"Contact Detail ID is a system-assigned, unique identifier of the person contact associated with the customers preferred contact method.","properties":{"_link":{"type":"string","description":"_link"},"contactDetailId":{"type":"string","maxLength":10,"description":"Person Contact"}}},"user":{"type":"object","description":"User ID of the user who created the contact.","properties":{"_link":{"type":"string","description":"_link"},"userId":{"type":"string","maxLength":8,"description":"User"}}},"person":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"personId":{"type":"string","maxLength":10,"description":"Person ID displays the associated person's unique, system-generated ID. If the customer contact is Person-based the Person ID cannot be changed. There should be no value if the Customer Contact Type indicates that a person is not allowed on customer contacts of this type.","example":"5775933103"}}},"premise":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"premiseId":{"type":"string","maxLength":10,"description":"Premise ID field displays the associated premise's unique, system-generated ID. If the customer contact is Premise-based the Premise ID cannot be changed.  There should be no value if the Customer Contact Type indicates that a premise is not allowed on customer contacts of this type."}}},"account":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"accountId":{"type":"string","maxLength":10,"description":"Account ID displays the account's unique, system-generated ID. The account must be associated to the person when the contact is created or updated.  There should be no value if the Customer Contact Type indicates that an account is not allowed on customer contacts of this type.","example":"5922116763"}}},"customerContactEntity":{"type":"string","enum":["PER ","PREM"],"description":"Indicates if customer contact is related to the customer as person-based or to a service location as premise-based.\n* `PER ` - Person,\n* `PREM` - Premise","example":"PER"},"longDescription":{"type":"string","maxLength":4000,"description":"Stores comments that can provide initial information about why the record was created and any other relevant text for historical reference purposes."},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version number is used for internal concurrency checks.","example":"1"},"characteristics":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"characteristicType":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"characteristicType":{"type":"string","maxLength":8,"description":"Characteristic Type"}}},"typeOfCharacteristicValue":{"type":"string","maxLength":4,"description":"Type of Characteristic Value indicates whether the characteristic type value is Adhoc, Predefined, Foreign Key, or a File/URL Location."},"characteristicValue":{"type":"object","properties":{"_link":{"type":"string","description":"(_link)"},"value":{"type":"string","description":"(value)"},"value2":{"type":"string","description":"(value2)"},"value3":{"type":"string","description":"(value3)"},"value4":{"type":"string","description":"(value4)"},"value5":{"type":"string","description":"(value5)"}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version number is used for internal concurrency checks.","example":"1"}}}}}},"logs":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"customerContactLogId":{"type":"string","maxLength":12,"description":"Customer Contact Log ID is a system-assigned, unique identifier of the log entry."},"triggerDate":{"type":"string","format":"date","description":"Trigger Date is only used if you want the system to remind a user about this customer contact on a future date. The system will create a To Do entry to remind the user about the customer contact.   This value defines the latest date on which the To Do entry should be created because the background process that's responsible for creating these To Do entries has a parameter called Lead Time that is used to define the number of days before the Trigger Date that the To Do entry should be created."},"toDoRole":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"toDoRoleId":{"type":"string","maxLength":10,"description":"To Do Role"}}},"assignedToUser":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"assignedToUserId":{"type":"string","maxLength":8,"description":"User"}}},"user":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"userId":{"type":"string","maxLength":8,"description":"User"}}},"creationDateTime":{"type":"string","format":"date-time","description":"Create Date / Time is the date and time when the log entry was created."},"logEntry":{"type":"string","maxLength":2000,"description":"Log Entry can be used to describe the reason for the log entry."},"triggerBusinessProcess":{"type":"boolean","description":"Trigger Business Process is a true or false value for reminders."},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version number is used for internal concurrency checks.","example":"1"}}}}}}},"xml":{"name":"C1-CustCntct"}},"UPDATECUSTOMERCONTACT_response":{"type":"object","properties":{"_self":{"type":"string","description":"_self"},"customerContactId":{"type":"string","maxLength":10,"description":"System-assigned, unique identifier of the customer contact record","example":"5774836290"},"contactDateTime":{"type":"string","format":"date-time","description":"Contact Date/Time displays the date and time that the contact was saved into the system..","example":"2017-04-05T14:25:43-04:00"},"shouldPrintLetter":{"type":"boolean","description":"Adding a customer contact may cause a letter to be generated. You can set up a customer contact type to generate a form letter whenever a customer contact of this type is added.  If the letter is going to be printed in the next batch run, the Print Letter switch is on. Turning the switch off removes the letter from being printed in the next batch run. This applies to letters that have never been printed and those that have been set to reprint.","example":"false"},"letterPrintDateTime":{"type":"string","format":"date-time","description":"The letter extract batch process will update the date and time that the letter was produced for sending."},"letterTemplate":{"type":"object","description":"If the customer contact references a customer contact type that, in turn, references a letter template, the template controls the type of information that is merged into the 'form letter' and how the letter is physically produced.","properties":{"_link":{"type":"string","description":"_link"},"letterTemplate":{"type":"string","maxLength":12,"description":"If the customer contact references a customer contact type that, in turn, references a letter template, the template controls the type of information that is merged into the 'form letter' and how the letter is physically produced."}}},"customerContactType":{"type":"object","properties":{"contactClass":{"type":"string","maxLength":4,"description":"Contact Class categorizes customer contacts into larger groupings for reporting purposes.","example":"CSS"},"contactType":{"type":"string","maxLength":12,"description":"Every customer contact has a Contact Type that classifies the record for reporting purposes. Every contact type, in turn, references a Contact Class.  The customer contact type controls the relationship validation among person, account, and premise. You can set up a customer contact type to generate a form letter whenever a customer contact of this type is added. In fact, this is the only way to generate a letter in the system.","example":"ACCESS"}}},"customerContactStatus":{"type":"string","enum":["10  "],"description":"Open designates that the event or issue associated to the contact has not been resolved. For example, if a customer calls with a high bill complaint that can't be resolved immediately, you would turn on the Open switch and enter an appropriate entry in the Log.\n* `10  ` - Open"},"preferredContactMethod":{"type":"string","enum":["C1PC","EM  ","FAX ","N/A ","PH  ","POST","SMS "],"description":"Preferred Contact Method indicates how the person prefers to be contacted.\n* `C1PC` - Person Contact,\n* `EM  ` - Email,\n* `FAX ` - Fax,\n* `N/A ` - Not Applicable,\n* `PH  ` - Phone,\n* `POST` - Postal,\n* `SMS ` - SMS","example":"N/A"},"contactDetail":{"type":"object","description":"Contact Detail ID is a system-assigned, unique identifier of the person contact associated with the customers preferred contact method.","properties":{"_link":{"type":"string","description":"_link"},"contactDetailId":{"type":"string","maxLength":10,"description":"Person Contact"}}},"user":{"type":"object","description":"User ID of the user who created the contact.","properties":{"_link":{"type":"string","description":"_link"},"userId":{"type":"string","maxLength":8,"description":"User"}}},"person":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"personId":{"type":"string","maxLength":10,"description":"Person ID displays the associated person's unique, system-generated ID. If the customer contact is Person-based the Person ID cannot be changed. There should be no value if the Customer Contact Type indicates that a person is not allowed on customer contacts of this type.","example":"5775933103"}}},"premise":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"premiseId":{"type":"string","maxLength":10,"description":"Premise ID field displays the associated premise's unique, system-generated ID. If the customer contact is Premise-based the Premise ID cannot be changed.  There should be no value if the Customer Contact Type indicates that a premise is not allowed on customer contacts of this type."}}},"account":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"accountId":{"type":"string","maxLength":10,"description":"Account ID displays the account's unique, system-generated ID. The account must be associated to the person when the contact is created or updated.  There should be no value if the Customer Contact Type indicates that an account is not allowed on customer contacts of this type.","example":"5922116763"}}},"customerContactEntity":{"type":"string","enum":["PER ","PREM"],"description":"Indicates if customer contact is related to the customer as person-based or to a service location as premise-based.\n* `PER ` - Person,\n* `PREM` - Premise","example":"PER"},"longDescription":{"type":"string","maxLength":4000,"description":"Stores comments that can provide initial information about why the record was created and any other relevant text for historical reference purposes."},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version number is used for internal concurrency checks.","example":"1"},"characteristics":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"characteristicType":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"characteristicType":{"type":"string","maxLength":8,"description":"Characteristic Type"}}},"typeOfCharacteristicValue":{"type":"string","maxLength":4,"description":"Type of Char Value"},"characteristicValue":{"type":"object","properties":{"_link":{"type":"string","description":"(_link)"},"value":{"type":"string","description":"(value)"},"value2":{"type":"string","description":"(value2)"},"value3":{"type":"string","description":"(value3)"},"value4":{"type":"string","description":"(value4)"},"value5":{"type":"string","description":"(value5)"}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version number is used for internal concurrency checks.","example":"1"}}}}}},"logs":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"customerContactLogId":{"type":"string","maxLength":12,"description":"Customer Contact Log ID"},"triggerDate":{"type":"string","format":"date","description":"Trigger Date is only used if you want the system to remind a user about this customer contact on a future date. The system will create a To Do entry to remind the user about the customer contact.   This value defines the latest date on which the To Do entry should be created because the background process that's responsible for creating these To Do entries has a parameter called Lead Time that is used to define the number of days before the Trigger Date that the To Do entry should be created."},"toDoRole":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"toDoRoleId":{"type":"string","maxLength":10,"description":"To Do Role"}}},"assignedToUser":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"assignedToUserId":{"type":"string","maxLength":8,"description":"User"}}},"user":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"userId":{"type":"string","maxLength":8,"description":"User"}}},"creationDateTime":{"type":"string","format":"date-time","description":"Create Date/Time"},"logEntry":{"type":"string","maxLength":2000,"description":"Log Entry can be used to describe the reason for the log entry."},"triggerBusinessProcess":{"type":"boolean","description":"Trigger Business Process is a true or false value for reminders."},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version number is used for internal concurrency checks.","example":"1"}}}}}}},"xml":{"name":"C1-CustCntct"}},"DELETECUSTOMERCONTACT_request":{"type":"object","properties":{"customerContactId":{"type":"string","maxLength":10,"description":"System-assigned, unique identifier of the customer contact record","example":"5774836290"}},"xml":{"name":"C1-DelCustCt"}},"DELETECUSTOMERCONTACT_response":{"type":"object","properties":{"customerContactId":{"type":"string","maxLength":10,"description":"System-assigned, unique identifier of the customer contact record","example":"5774836290"}},"xml":{"name":"C1-DelCustCt"}},"UPDATECUTPROCESS_request":{"type":"object","properties":{"name":{"type":"string","description":"(name)"},"cutProcessId":{"type":"string","maxLength":12,"description":"Cut Process ID is the system-assigned unique identifier of the cut process.","example":"460555550000"},"overdueProcess":{"type":"object","properties":{"overdueProcessId":{"type":"string","maxLength":12,"description":"Overdue Process ID is the system-assigned unique identifier of the cut process.","example":"460352888888"}}},"overdueEvent":{"type":"number","maximum":999,"minimum":0,"description":"Overdue Event  that created the cut process."},"serviceAgreement":{"type":"object","description":"Service Agreement identifies the service agreement being cut.","properties":{"serviceAgreementId":{"type":"string","maxLength":10,"description":"Service Agreement"}}},"status":{"type":"string","enum":["10  ","20  "],"description":"Status defines the state of the cut process.\n* `10  ` - Active,\n* `20  ` - Inactive","example":"10"},"statusReason":{"type":"string","enum":["10  ","20  ","30  ","40  "],"description":"Cut Status Reason\n* `10  ` - Events Pending,\n* `20  ` - Completed,\n* `30  ` - Canceled by System,\n* `40  ` - Canceled by User","example":"20"},"cutProcessTemplate":{"type":"object","description":"Cut Process Template defines the template that was used to create the cut process's events.","properties":{"cutProcessTemplate":{"type":"string","maxLength":12,"description":"Cut Process Template defines the template that was used to create the cut process's events.","example":"STDCUT"}}},"creationDateTime":{"type":"string","format":"date-time","description":"Create Date/Time defines the creation date/time of the cut process.","example":"2005-04-18T07:50:51-04:00"},"inactiveDateTime":{"type":"string","format":"date-time","description":"Inactive Date/Time is the date and time that the cut process became Inactive.","example":"2008-06-04T15:12:44-04:00"},"comments":{"type":"string","maxLength":2000,"description":"Enter any Comments about the cut process."},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks.","example":"1"},"events":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"cutProcessId":{"type":"string","maxLength":12,"description":"Cut Process ID"},"eventSequence":{"type":"number","maximum":999,"minimum":-999,"description":"Event Sequence is the unique identifier of the event.","example":"10"},"status":{"type":"string","enum":["10  ","20  ","30  ","40  "],"description":"Event Status:\n* `10  ` - Pending,\n* `20  ` - Waiting,\n* `30  ` - Completed,\n* `40  ` - Canceled"},"statusDateTime":{"type":"string","format":"date-time","description":"Status Date/Time","example":"2008-06-04T15:13:00-04:00"},"cancellationComment":{"type":"string","maxLength":254,"description":"Enter any Comments about cancelling the cut event."},"cutEventType":{"type":"object","properties":{"cutEventType":{"type":"string","maxLength":12,"description":"Cut Event Type"}}},"daysAfterPreviousResponse":{"type":"number","maximum":999,"minimum":-999,"description":"Days After Prev Response defines how a dependent event's trigger date is calculated. The trigger date is set equal to X days after the last dependent event is completed, where X is the number in this field.","example":"1"},"dependOnOtherEvents":{"type":"boolean","description":"If Dependent on Other Events is turned on, the event can only be triggered after the events specified in the Event Dependencies are all Complete or Canceled.","example":"false"},"triggerDate":{"type":"string","format":"date","description":"If Dependent on Other Events is turned off, enter the desired activation date in the Trigger Date field.","example":"2005-04-19"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"},"eventDependencies":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"cutProcessId":{"type":"string","maxLength":12,"description":"Cut Process ID"},"eventSequence2":{"type":"number","maximum":999,"minimum":-999,"description":"Event Sequence is the unique identifier of the event.","example":"10"},"sequence":{"type":"number","maximum":999,"minimum":-999,"description":"Sequence Number","example":"11"},"dependentOnSequence":{"type":"number","maximum":999,"minimum":-999,"description":"When Dependent on Other Events is turned on, the Dependent on Sequence field defines the event sequence number on which this event depends."},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"}}}}}}}}}}},"premise":{"type":"object","properties":{"premiseId":{"type":"string","maxLength":10,"description":"Premise identifies the service agreement's characteristic premise (if any)."}}}},"xml":{"name":"C1CutProcess"}},"ACTIONCUTPROCESS_response":{"type":"object","properties":{"_self":{"type":"string","description":"_self"},"name":{"type":"string","description":"(name)"},"cutProcessId":{"type":"string","maxLength":12,"description":"Cut Process ID is the system-assigned unique identifier of the cut process.","example":"460555550000"},"overdueProcess":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"overdueProcessId":{"type":"string","maxLength":12,"description":"Overdue Process ID is the system-assigned unique identifier of the cut process.","example":"460352888888"}}},"overdueEvent":{"type":"number","maximum":999,"minimum":0,"description":"Overdue Event  that created the cut process."},"serviceAgreement":{"type":"object","description":"Service Agreement identifies the service agreement being cut.","properties":{"_link":{"type":"string","description":"_link"},"serviceAgreementId":{"type":"string","maxLength":10,"description":"Service Agreement"}}},"status":{"type":"string","enum":["10  ","20  "],"description":"Status defines the state of the cut process.\n* `10  ` - Active,\n* `20  ` - Inactive","example":"10"},"statusReason":{"type":"string","enum":["10  ","20  ","30  ","40  "],"description":"Cut Status Reason\n* `10  ` - Events Pending,\n* `20  ` - Completed,\n* `30  ` - Canceled by System,\n* `40  ` - Canceled by User","example":"20"},"cutProcessTemplate":{"type":"object","description":"Cut Process Template defines the template that was used to create the cut process's events.","properties":{"_link":{"type":"string","description":"_link"},"cutProcessTemplate":{"type":"string","maxLength":12,"description":"Cut Process Template defines the template that was used to create the cut process's events.","example":"STDCUT"}}},"creationDateTime":{"type":"string","format":"date-time","description":"Create Date/Time defines the creation date/time of the cut process.","example":"2005-04-18T07:50:51-04:00"},"inactiveDateTime":{"type":"string","format":"date-time","description":"Inactive Date/Time is the date and time that the cut process became Inactive.","example":"2008-06-04T15:12:44-04:00"},"comments":{"type":"string","maxLength":2000,"description":"Enter any Comments about the cut process."},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks.","example":"1"},"events":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"cutProcessId":{"type":"string","maxLength":12,"description":"Cut Process ID"},"eventSequence":{"type":"number","maximum":999,"minimum":-999,"description":"Event Sequence is the unique identifier of the event.","example":"10"},"status":{"type":"string","enum":["10  ","20  ","30  ","40  "],"description":"Event Status:\n* `10  ` - Pending,\n* `20  ` - Waiting,\n* `30  ` - Completed,\n* `40  ` - Canceled"},"statusDateTime":{"type":"string","format":"date-time","description":"Status Date/Time","example":"2008-06-04T15:13:00-04:00"},"cancellationComment":{"type":"string","maxLength":254,"description":"Enter any Comments about cancelling the cut event."},"cutEventType":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"cutEventType":{"type":"string","maxLength":12,"description":"Cut Event Type"}}},"daysAfterPreviousResponse":{"type":"number","maximum":999,"minimum":-999,"description":"Days After Prev Response defines how a dependent event's trigger date is calculated. The trigger date is set equal to X days after the last dependent event is completed, where X is the number in this field.","example":"1"},"dependOnOtherEvents":{"type":"boolean","description":"If Dependent on Other Events is turned on, the event can only be triggered after the events specified in the Event Dependencies are all Complete or Canceled.","example":"false"},"triggerDate":{"type":"string","format":"date","description":"If Dependent on Other Events is turned off, enter the desired activation date in the Trigger Date field.","example":"2005-04-19"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"},"eventDependencies":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"cutProcessId":{"type":"string","maxLength":12,"description":"Cut Process ID"},"eventSequence2":{"type":"number","maximum":999,"minimum":-999,"description":"Event Sequence is the unique identifier of the event.","example":"10"},"sequence":{"type":"number","maximum":999,"minimum":-999,"description":"Sequence Number","example":"11"},"dependentOnSequence":{"type":"number","maximum":999,"minimum":-999,"description":"When Dependent on Other Events is turned on, the Dependent on Sequence field defines the event sequence number on which this event depends."},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"}}}}}}}}}}},"premise":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"premiseId":{"type":"string","maxLength":10,"description":"Premise identifies the service agreement's characteristic premise (if any)."}}}},"xml":{"name":"C1CutProcess"}},"GETCUTPROCESS_response":{"type":"object","properties":{"_self":{"type":"string","description":"_self"},"name":{"type":"string","description":"(name)"},"cutProcessId":{"type":"string","maxLength":12,"description":"Cut Process ID is the system-assigned unique identifier of the cut process.","example":"460555550000"},"overdueProcess":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"overdueProcessId":{"type":"string","maxLength":12,"description":"Overdue Process ID is the system-assigned unique identifier of the cut process.","example":"460352888888"}}},"overdueEvent":{"type":"number","maximum":999,"minimum":0,"description":"Overdue Event  that created the cut process."},"serviceAgreement":{"type":"object","description":"Service Agreement identifies the service agreement being cut.","properties":{"_link":{"type":"string","description":"_link"},"serviceAgreementId":{"type":"string","maxLength":10,"description":"Service Agreement"}}},"status":{"type":"string","enum":["10  ","20  "],"description":"Status defines the state of the cut process.\n* `10  ` - Active,\n* `20  ` - Inactive","example":"10"},"statusReason":{"type":"string","enum":["10  ","20  ","30  ","40  "],"description":"Cut Status Reason\n* `10  ` - Events Pending,\n* `20  ` - Completed,\n* `30  ` - Canceled by System,\n* `40  ` - Canceled by User","example":"20"},"cutProcessTemplate":{"type":"object","description":"Cut Process Template defines the template that was used to create the cut process's events.","properties":{"_link":{"type":"string","description":"_link"},"cutProcessTemplate":{"type":"string","maxLength":12,"description":"Cut Process Template defines the template that was used to create the cut process's events.","example":"STDCUT"}}},"creationDateTime":{"type":"string","format":"date-time","description":"Create Date/Time defines the creation date/time of the cut process.","example":"2005-04-18T07:50:51-04:00"},"inactiveDateTime":{"type":"string","format":"date-time","description":"Inactive Date/Time is the date and time that the cut process became Inactive.","example":"2008-06-04T15:12:44-04:00"},"comments":{"type":"string","maxLength":2000,"description":"Enter any Comments about the cut process."},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks.","example":"1"},"events":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"cutProcessId":{"type":"string","maxLength":12,"description":"Cut Process ID"},"eventSequence":{"type":"number","maximum":999,"minimum":-999,"description":"Event Sequence is the unique identifier of the event.","example":"10"},"status":{"type":"string","enum":["10  ","20  ","30  ","40  "],"description":"Event Status:\n* `10  ` - Pending,\n* `20  ` - Waiting,\n* `30  ` - Completed,\n* `40  ` - Canceled"},"statusDateTime":{"type":"string","format":"date-time","description":"Status Date/Time","example":"2008-06-04T15:13:00-04:00"},"cancellationComment":{"type":"string","maxLength":254,"description":"Enter any Comments about cancelling the cut event."},"cutEventType":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"cutEventType":{"type":"string","maxLength":12,"description":"Cut Event Type"}}},"daysAfterPreviousResponse":{"type":"number","maximum":999,"minimum":-999,"description":"Days After Prev Response defines how a dependent event's trigger date is calculated. The trigger date is set equal to X days after the last dependent event is completed, where X is the number in this field.","example":"1"},"dependOnOtherEvents":{"type":"boolean","description":"If Dependent on Other Events is turned on, the event can only be triggered after the events specified in the Event Dependencies are all Complete or Canceled.","example":"false"},"triggerDate":{"type":"string","format":"date","description":"If Dependent on Other Events is turned off, enter the desired activation date in the Trigger Date field.","example":"2005-04-19"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"},"eventDependencies":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"cutProcessId":{"type":"string","maxLength":12,"description":"Cut Process ID"},"eventSequence2":{"type":"number","maximum":999,"minimum":-999,"description":"Event Sequence is the unique identifier of the event.","example":"10"},"sequence":{"type":"number","maximum":999,"minimum":-999,"description":"Sequence Number","example":"11"},"dependentOnSequence":{"type":"number","maximum":999,"minimum":-999,"description":"When Dependent on Other Events is turned on, the Dependent on Sequence field defines the event sequence number on which this event depends."},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"}}}}}}}}}}},"premise":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"premiseId":{"type":"string","maxLength":10,"description":"Premise identifies the service agreement's characteristic premise (if any)."}}}},"xml":{"name":"C1CutProcess"}},"ACTIONCUTPROCESS_request":{"type":"object","properties":{"name":{"type":"string","description":"(name)"},"cutProcessId":{"type":"string","maxLength":12,"description":"Cut Process ID is the system-assigned unique identifier of the cut process.","example":"460555550000"},"overdueProcess":{"type":"object","properties":{"overdueProcessId":{"type":"string","maxLength":12,"description":"Overdue Process ID is the system-assigned unique identifier of the cut process.","example":"460352888888"}}},"overdueEvent":{"type":"number","maximum":999,"minimum":0,"description":"Overdue Event  that created the cut process."},"serviceAgreement":{"type":"object","description":"Service Agreement identifies the service agreement being cut.","properties":{"serviceAgreementId":{"type":"string","maxLength":10,"description":"Service Agreement"}}},"status":{"type":"string","enum":["10  ","20  "],"description":"Status defines the state of the cut process.\n* `10  ` - Active,\n* `20  ` - Inactive","example":"10"},"statusReason":{"type":"string","enum":["10  ","20  ","30  ","40  "],"description":"Cut Status Reason\n* `10  ` - Events Pending,\n* `20  ` - Completed,\n* `30  ` - Canceled by System,\n* `40  ` - Canceled by User","example":"20"},"cutProcessTemplate":{"type":"object","description":"Cut Process Template defines the template that was used to create the cut process's events.","properties":{"cutProcessTemplate":{"type":"string","maxLength":12,"description":"Cut Process Template defines the template that was used to create the cut process's events.","example":"STDCUT"}}},"creationDateTime":{"type":"string","format":"date-time","description":"Create Date/Time defines the creation date/time of the cut process.","example":"2005-04-18T07:50:51-04:00"},"inactiveDateTime":{"type":"string","format":"date-time","description":"Inactive Date/Time is the date and time that the cut process became Inactive.","example":"2008-06-04T15:12:44-04:00"},"comments":{"type":"string","maxLength":2000,"description":"Enter any Comments about the cut process."},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks.","example":"1"},"events":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"cutProcessId":{"type":"string","maxLength":12,"description":"Cut Process ID"},"eventSequence":{"type":"number","maximum":999,"minimum":-999,"description":"Event Sequence is the unique identifier of the event.","example":"10"},"status":{"type":"string","enum":["10  ","20  ","30  ","40  "],"description":"Event Status:\n* `10  ` - Pending,\n* `20  ` - Waiting,\n* `30  ` - Completed,\n* `40  ` - Canceled"},"statusDateTime":{"type":"string","format":"date-time","description":"Status Date/Time","example":"2008-06-04T15:13:00-04:00"},"cancellationComment":{"type":"string","maxLength":254,"description":"Enter any Comments about cancelling the cut event."},"cutEventType":{"type":"object","properties":{"cutEventType":{"type":"string","maxLength":12,"description":"Cut Event Type"}}},"daysAfterPreviousResponse":{"type":"number","maximum":999,"minimum":-999,"description":"Days After Prev Response defines how a dependent event's trigger date is calculated. The trigger date is set equal to X days after the last dependent event is completed, where X is the number in this field.","example":"1"},"dependOnOtherEvents":{"type":"boolean","description":"If Dependent on Other Events is turned on, the event can only be triggered after the events specified in the Event Dependencies are all Complete or Canceled.","example":"false"},"triggerDate":{"type":"string","format":"date","description":"If Dependent on Other Events is turned off, enter the desired activation date in the Trigger Date field.","example":"2005-04-19"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"},"eventDependencies":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"cutProcessId":{"type":"string","maxLength":12,"description":"Cut Process ID"},"eventSequence2":{"type":"number","maximum":999,"minimum":-999,"description":"Event Sequence is the unique identifier of the event.","example":"10"},"sequence":{"type":"number","maximum":999,"minimum":-999,"description":"Sequence Number","example":"11"},"dependentOnSequence":{"type":"number","maximum":999,"minimum":-999,"description":"When Dependent on Other Events is turned on, the Dependent on Sequence field defines the event sequence number on which this event depends."},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"}}}}}}}}}}},"premise":{"type":"object","properties":{"premiseId":{"type":"string","maxLength":10,"description":"Premise identifies the service agreement's characteristic premise (if any)."}}}},"xml":{"name":"C1CutProcess"}},"UPDATECUTPROCESS_response":{"type":"object","properties":{"_self":{"type":"string","description":"_self"},"name":{"type":"string","description":"(name)"},"cutProcessId":{"type":"string","maxLength":12,"description":"Cut Process ID is the system-assigned unique identifier of the cut process.","example":"460555550000"},"overdueProcess":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"overdueProcessId":{"type":"string","maxLength":12,"description":"Overdue Process ID is the system-assigned unique identifier of the cut process.","example":"460352888888"}}},"overdueEvent":{"type":"number","maximum":999,"minimum":0,"description":"Overdue Event  that created the cut process."},"serviceAgreement":{"type":"object","description":"Service Agreement identifies the service agreement being cut.","properties":{"_link":{"type":"string","description":"_link"},"serviceAgreementId":{"type":"string","maxLength":10,"description":"Service Agreement"}}},"status":{"type":"string","enum":["10  ","20  "],"description":"Status defines the state of the cut process.\n* `10  ` - Active,\n* `20  ` - Inactive","example":"10"},"statusReason":{"type":"string","enum":["10  ","20  ","30  ","40  "],"description":"Cut Status Reason\n* `10  ` - Events Pending,\n* `20  ` - Completed,\n* `30  ` - Canceled by System,\n* `40  ` - Canceled by User","example":"20"},"cutProcessTemplate":{"type":"object","description":"Cut Process Template defines the template that was used to create the cut process's events.","properties":{"_link":{"type":"string","description":"_link"},"cutProcessTemplate":{"type":"string","maxLength":12,"description":"Cut Process Template defines the template that was used to create the cut process's events.","example":"STDCUT"}}},"creationDateTime":{"type":"string","format":"date-time","description":"Create Date/Time defines the creation date/time of the cut process.","example":"2005-04-18T07:50:51-04:00"},"inactiveDateTime":{"type":"string","format":"date-time","description":"Inactive Date/Time is the date and time that the cut process became Inactive.","example":"2008-06-04T15:12:44-04:00"},"comments":{"type":"string","maxLength":2000,"description":"Enter any Comments about the cut process."},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks.","example":"1"},"events":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"cutProcessId":{"type":"string","maxLength":12,"description":"Cut Process ID"},"eventSequence":{"type":"number","maximum":999,"minimum":-999,"description":"Event Sequence is the unique identifier of the event.","example":"10"},"status":{"type":"string","enum":["10  ","20  ","30  ","40  "],"description":"Event Status:\n* `10  ` - Pending,\n* `20  ` - Waiting,\n* `30  ` - Completed,\n* `40  ` - Canceled"},"statusDateTime":{"type":"string","format":"date-time","description":"Status Date/Time","example":"2008-06-04T15:13:00-04:00"},"cancellationComment":{"type":"string","maxLength":254,"description":"Enter any Comments about cancelling the cut event."},"cutEventType":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"cutEventType":{"type":"string","maxLength":12,"description":"Cut Event Type"}}},"daysAfterPreviousResponse":{"type":"number","maximum":999,"minimum":-999,"description":"Days After Prev Response defines how a dependent event's trigger date is calculated. The trigger date is set equal to X days after the last dependent event is completed, where X is the number in this field.","example":"1"},"dependOnOtherEvents":{"type":"boolean","description":"If Dependent on Other Events is turned on, the event can only be triggered after the events specified in the Event Dependencies are all Complete or Canceled.","example":"false"},"triggerDate":{"type":"string","format":"date","description":"If Dependent on Other Events is turned off, enter the desired activation date in the Trigger Date field.","example":"2005-04-19"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"},"eventDependencies":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"cutProcessId":{"type":"string","maxLength":12,"description":"Cut Process ID"},"eventSequence2":{"type":"number","maximum":999,"minimum":-999,"description":"Event Sequence is the unique identifier of the event.","example":"10"},"sequence":{"type":"number","maximum":999,"minimum":-999,"description":"Sequence Number","example":"11"},"dependentOnSequence":{"type":"number","maximum":999,"minimum":-999,"description":"When Dependent on Other Events is turned on, the Dependent on Sequence field defines the event sequence number on which this event depends."},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"}}}}}}}}}}},"premise":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"premiseId":{"type":"string","maxLength":10,"description":"Premise identifies the service agreement's characteristic premise (if any)."}}}},"xml":{"name":"C1CutProcess"}},"GETUSAGETRANSACTION_response":{"type":"object","properties":{"_self":{"type":"string","description":"_self"},"usageTransactionId":{"type":"string","maxLength":14,"description":"Usage Transaction ID is a system assigned random number that stays with a usage transaction record.","example":"05458709929330"},"status":{"type":"string","maxLength":12,"description":"Status"},"usageType":{"type":"string","enum":["D2CS","D2IN","D2IS","D2PS","D2SC","D2SF"],"description":"Usage Type flag\n* `D2CS` - Correlated SQ,\n* `D2IN` - Frequently Read,\n* `D2IS` - Frequently Read and Manually Read Scalar,\n* `D2PS` - Profiled SQ,\n* `D2SC` - Manually Read Scalar,\n* `D2SF` - Deprecated - Scalar For Calculation Purposes Only","example":"D2CS"},"usageSubscription":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"usageSubscriptionId":{"type":"string","maxLength":12,"description":"Usage Subscription"}}},"previousUsageTransaction":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"previousUsageTransactionId":{"type":"string","maxLength":14,"description":"Usage Transaction ID"}}},"usageExternalId":{"type":"string","maxLength":60,"description":"An ID used by external systems used to identify the usage transaction .When Oracle Utilities Meter Data Management is integrated with Oracle Utilities Customer Care and Billing, Oracle Utilities Customer Care and Billing can send this to help identify the previous usage transaction."},"startDateTime":{"type":"string","format":"date-time","description":"Defines the start date and time of the usage period.","example":"2013-01-02T00:00:00-08:00"},"endDateTime":{"type":"string","format":"date-time","description":"End Date/Time"},"estimateThroughDate":{"type":"string","format":"date","description":"Estimate Through Date","example":"07-01-2017"},"alignmentDateTime":{"type":"string","format":"date-time","description":"Alignment Date/Time"},"calculationGroup":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"calculationGroup":{"type":"string","maxLength":30,"description":"Calculation Group"}}},"measurementCycle":{"type":"object","description":"Measurement Cycle specifies the schedule used for when the service point is visited and the the device read.","properties":{"_link":{"type":"string","description":"_link"},"measurementCycle":{"type":"string","maxLength":30,"description":"Measurement Cycle specifies the schedule used for when the service point is visited and the the device read."}}},"measurementCycleRoute":{"type":"string","maxLength":30,"description":"Route specifies the group of service points in a cycle that are visited by a meter reader."},"scheduledSelectionDate":{"type":"string","format":"date","description":"Scheduled Selection Date"},"billCondition":{"type":"string","enum":["D2CL","D2IC","D2IL","D2IM"],"description":"The status of the bill associated with the usage transaction (if applicable), used for informational purposes only.\n* `D2CL` - Closing,\n* `D2IC` - Initial and Closing,\n* `D2IL` - Initial,\n* `D2IM` - Interim","example":"D2IL"},"automatedRetry":{"type":"string","enum":["D1NA","D1NO","D1YS"],"description":"A flag that indicates if creation of the usage transaction should be automatically retried in the event of an error.\n* `D1NA` - No - Automatic Discard,\n* `D1NO` - No,\n* `D1YS` - Yes","example":"D1NA"},"nextRetryDateTime":{"type":"string","format":"date-time","description":"Next Retry Date/Time"},"retryUntilDateTime":{"type":"string","format":"date-time","description":"The date time until which the system will attempt to retry creating the usage transaction in the event of an error (applicable only if the Automated Retry flag is set to \"Yes\")."},"subUsageTransactionExist":{"type":"string","enum":["D2NO","D2YS"],"description":"Sub Usage Transactions flag\n* `D2NO` - No,\n* `D2YS` - Yes","example":"D2NO"},"deferCalculation":{"type":"string","enum":["D2NO","D2YS"],"description":"Defer Calculation:\n* `D2NO` - No,\n* `D2YS` - Yes"},"isTraceOn":{"type":"string","enum":["D1NO","D1YS"],"description":"Indicates if tracing is on for the usage transaction.\n* `D1NO` - Off,\n* `D1YS` - On","example":"D1YS"},"skipDetails":{"type":"object","properties":{"skip":{"type":"string","enum":["D2NO","D2YS"],"description":"A flag that indicates if the usage transaction should be skipped.\n* `D2NO` - No,\n* `D2YS` - Yes","example":"D2NO"},"skipReason":{"type":"string","enum":["D2NS"],"description":"Reason for skipping the usage transaction.\n* `D2NS` - No Scheduled Read","example":"D2NS"},"nextScheduledReadDate":{"type":"string","format":"date","description":"The next scheduled read date for the device from which the measurements used to create the usage transaction came."}}},"calculationMode":{"type":"string","enum":["D2HC"],"description":"A flag that indicates the mode in which the usage transaction calculations are/were performed.\n* `D2HC` - Hypothetical Calculation","example":"D2HC"},"usedOnBill":{"type":"string","enum":["D1NO","D1YS"],"description":"This flag indicates (Yes or No) whether or not the usage transaction's service quantities have been used on a completed bill.\n* `D1NO` - No,\n* `D1YS` - Yes","example":"D1YS"},"linkedToFrozenBillSegment":{"type":"string","enum":["D1NO","D1YS"],"description":"This flag indicates (Yes or No) whether or not the usage transaction is linked to a frozen bill segment.\n* `D1NO` - No,\n* `D1YS` - Yes","example":"D1NO"},"usageAdjustmentProfileFactors":{"type":"object","properties":{"profileFactorsList":{"type":"array","items":{"type":"object","properties":{"profileFactor":{"type":"string","maxLength":30,"description":"Factor"},"value":{"type":"string","maxLength":16,"description":"Factor Characteristic Value"}}}}}},"currentToDoId":{"type":"string","maxLength":14,"description":"To Do ID"},"previousToDoId":{"type":"string","maxLength":14,"description":"To Do ID"},"comments":{"type":"string","maxLength":254,"description":"comments"},"requestMode":{"type":"string","enum":["D2BB","D2OB"],"description":"Request\n* `D2BB` - Batch,\n* `D2OB` - Online","example":"D2BB"},"intervalMeasuringComponent":{"type":"object","properties":{"startDateTime":{"type":"string","format":"date-time","description":"Defines the start date and time of the usage period.","example":"2013-01-02T00:00:00-08:00"},"endDateTimeFrom":{"type":"string","format":"date-time","description":"Defines the start date and time for the 'end range' of the usage period.","example":"2013-01-03T00:00:00-08:00"},"endDateTimeTo":{"type":"string","format":"date-time","description":"Defines the end date and time for the 'end range' of the usage period.","example":"2013-01-03T00:00:00-08:00"}}},"scalarMeasuringComponent":{"type":"object","properties":{"startDateTime":{"type":"string","format":"date-time","description":"Defines the start date and time of the usage period.","example":"2013-01-02T00:00:00-08:00"},"estimateTime":{"type":"string","enum":["D1EF","D1ET"],"description":"Estimate Time\n* `D1EF` - End Date Time From,\n* `D1ET` - End Date Time To","example":"D1EF"},"endDateTimeFrom":{"type":"string","format":"date-time","description":"Defines the start date and time for the 'end range' of the usage period.","example":"2013-01-03T00:00:00-08:00"},"endDateTimeTo":{"type":"string","format":"date-time","description":"Defines the end date and time for the 'end range' of the usage period.","example":"2013-01-03T00:00:00-08:00"},"endRangeOption":{"type":"string","enum":["D2SC","D2SP"],"description":"End Range Option indicates the end range option. Valid values include \"Specified\" and \"Derive Using Service Cycle Schedule\"\n* `D2SC` - Derive Using Service Cycle Schedule,\n* `D2SP` - Specified","example":"D2SC"},"minDaysOffset":{"type":"number","maximum":999,"minimum":-999,"description":"Minimum Offset Days / Maximum Offset Days  are used when End Range Option is set to \"Dervice Using Service Cycle Schedule\", these values define a range of days for the end date of the usage transaction, based on the Service Cycle Schedule date."},"maxDaysOffset":{"type":"number","maximum":999,"minimum":-999,"description":"Minimum Offset Days / Maximum Offset Days  are used when End Range Option is set to \"Dervice Using Service Cycle Schedule\", these values define a range of days for the end date of the usage transaction, based on the Service Cycle Schedule date."},"allowEstimate":{"type":"string","enum":["D2AE","D2DE"],"description":"Allow Estimate indicates whether or not to allow use of estimated measurement data when calculating usage.\n* `D2AE` - Allow Estimates,\n* `D2DE` - Do Not Allow Estimates","example":"D2AE"},"estimateDate":{"type":"string","format":"date","description":"Estimate Date indicates the date on which estimated measurement data used in the usage calculation was estimated."},"isEstimate":{"type":"string","enum":["D2NO","D2YS"],"description":"Is Estimate indicates if estimated measurement data was used in the usage calculation.\n* `D2NO` - No,\n* `D2YS` - Yes","example":"D2NO"}}},"dateBreaks":{"type":"object","properties":{"dateBreaksList":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"dateBreak":{"type":"string","format":"date","description":"Date breaks are used to break up a usage period into sub-periods based on the dates on which rate changes took place for the usage transaction (and its related account)."}}}}}}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks.","example":"2"},"usagePeriods":{"type":"object","properties":{"usagePeriodsList":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"sequence":{"type":"number","maximum":999,"minimum":-999,"description":"Period Sequence Number"},"startDateTime":{"type":"string","format":"date-time","description":"Defines the start date and time of the usage period.","example":"2013-01-02T00:00:00-08:00"},"endDateTime":{"type":"string","format":"date-time","description":"End Date/Time"},"usageType":{"type":"string","enum":["D2CS","D2IN","D2IS","D2PS","D2SC","D2SF"],"description":"Usage Type flag\n* `D2CS` - Correlated SQ,\n* `D2IN` - Frequently Read,\n* `D2IS` - Frequently Read and Manually Read Scalar,\n* `D2PS` - Profiled SQ,\n* `D2SC` - Manually Read Scalar,\n* `D2SF` - Deprecated - Scalar For Calculation Purposes Only","example":"D2CS"},"serviceQuantities":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"sqSequence":{"type":"number","maximum":99999,"minimum":-99999,"description":"Service Quantity Sequence"},"sqType":{"type":"string","enum":["D1FC","D1IT","D1MC","D1OT","D1PK","D1SU"],"description":"Usage Service Quantity Type\n* `D1FC` - Factor,\n* `D1IT` - Item,\n* `D1MC` - Measuring Component,\n* `D1OT` - Other,\n* `D1PK` - Peak Across Usage Periods,\n* `D1SU` - Summation","example":"D1FC"},"uom":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"uom":{"type":"string","maxLength":30,"description":"Unit of Measure"}}},"tou":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"tou":{"type":"string","maxLength":30,"description":"Time of Use"}}},"sqi":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"sqi":{"type":"string","maxLength":30,"description":"Service Quantity Identifier"}}},"quantity":{"type":"number","maximum":9999999999.999998,"minimum":-9999999999.999998,"description":"Quantity","example":"9.840000"},"servicePoint":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"servicePointId":{"type":"string","maxLength":12,"description":"Service Point ID"}}},"measuringComponent":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"measuringComponentId":{"type":"string","maxLength":12,"description":"Measuring Component ID"}}},"touMap":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"touMap":{"type":"string","maxLength":12,"description":"TOU Map"}}},"factor":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"factor":{"type":"string","maxLength":30,"description":"Factor"}}},"characteristicType":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"characteristicType":{"type":"string","maxLength":8,"description":"Characteristic Type"}}},"characteristicValue":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"characteristicValue":{"type":"string","maxLength":16,"description":"Characteristic Value"}}},"calculationGroup":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"calculationGroup":{"type":"string","maxLength":30,"description":"Calculation Group"}}},"calculationRule":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"calculationRule":{"type":"string","maxLength":30,"description":"Calculation Rule"}}},"intervalData":{"type":"string","enum":["D1EX","D1NE"],"description":"Interval Data:\n* `D1EX` - Exist,\n* `D1NE` - Does Not Exist"},"secondsPerInterval":{"type":"integer","description":"Interval Size"},"estimationIndicator":{"type":"string","enum":["D2ES","D2NE"],"description":"Estimation Indicator\n* `D2ES` - Estimated,\n* `D2NE` - Not Estimated"},"shouldExtractIntervalData":{"type":"string","enum":["D1NO","D1YS"],"description":"Extract Interval Data:\n* `D1NO` - No,\n* `D1YS` - Yes"}}}}}},"itemDetail":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"itemDetailsSeq":{"type":"number","maximum":99999,"minimum":0,"description":"Item Detail Sequence"},"badgedItem":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"badgedItemId":{"type":"string","maxLength":12,"description":"Device ID"}}},"itemType":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"itemType":{"type":"string","maxLength":30,"description":"Device Type"}}},"itemCount":{"type":"number","maximum":999999999.99,"minimum":-999999999.99,"description":"Item Count"},"startDateTime":{"type":"string","format":"date-time","description":"Defines the start date and time of the usage period.","example":"2013-01-02T00:00:00-08:00"},"endDateTime":{"type":"string","format":"date-time","description":"End Date/Time"},"quantity":{"type":"number","maximum":9999999999.999998,"minimum":-9999999999.999998,"description":"Quantity","example":"9.840000"},"uom":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"uom":{"type":"string","maxLength":30,"description":"Unit of Measure"}}},"servicePoint":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"servicePointId":{"type":"string","maxLength":12,"description":"Service Point ID"}}},"overrideQuantity":{"type":"string","enum":["D1OP"],"description":"Override Quantity flag\n* `D1OP` - Override Quantity Present","example":"D1OP"},"calculationGroup":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"calculationGroup":{"type":"string","maxLength":30,"description":"Calculation Group"}}},"usageRule":{"type":"string","maxLength":30,"description":"Usage calculation rules are standard and custom rules that perform calculations on measurement data to generate bill determinants.","example":"ZZS-MRULGRP-SCALAR-RULE"}}}}}},"sqsEstimationIndicators":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"uom":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"uom":{"type":"string","maxLength":30,"description":"Unit of Measure"}}},"tou":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"tou":{"type":"string","maxLength":30,"description":"Time of Use"}}},"sqi":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"sqi":{"type":"string","maxLength":30,"description":"Service Quantity Identifier"}}},"estimationIndicator":{"type":"string","enum":["D2ES","D2NE"],"description":"Estimation Indicator\n* `D2ES` - Estimated,\n* `D2NE` - Not Estimated"}}}}}}}}}}}}},"usageTransactionReadingDetails":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"servicePoint":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"servicePointId":{"type":"string","maxLength":12,"description":"Service Point ID"}}},"sequence":{"type":"number","maximum":999,"minimum":-999,"description":"Sequence"},"uom":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"uom":{"type":"string","maxLength":30,"description":"Unit of Measure"}}},"tou":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"tou":{"type":"string","maxLength":30,"description":"Time of Use"}}},"sqi":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"sqi":{"type":"string","maxLength":30,"description":"Service Quantity Identifier"}}},"measuringComponentId":{"type":"string","maxLength":12,"description":"Measuring Component ID","example":"658852900520"},"startDateTime":{"type":"string","format":"date-time","description":"Defines the start date and time of the usage period.","example":"2013-01-02T00:00:00-08:00"},"startMeasurement":{"type":"number","maximum":9999999999.999998,"minimum":-9999999999.999998,"description":"Start Measurement","example":"0.000000"},"startMeasurementCondition":{"type":"string","enum":["102000","ZZ-test-mark1","100000","901000","ZZBUG","402000","201000","ZZ-500001","501000","ZZ-301024","ZZ-301022","101500","ZZ-301501","ZZ-401000","ZZ-301515","ZZ-301514","ZZ-301513","101000","409000","401000","zz-test3","ZZ-TestBug","zz-test5","ZZ-301031","ZZ-301491","100500","ZZ-301511","ZZ-TEST-AGAIN","301000","ZZ_Test211"],"description":"Start Measurement Condition\n* `102000` - No Read - Disconnected,\n* `ZZ-test-mark1` - zz-test-mark1,\n* `100000` - No Read - System,\n* `901000` - Super,\n* `ZZBUG` - Override description,\n* `402000` - Office Estimate,\n* `201000` - Missing,\n* `ZZ-500001` - Prorated,\n* `501000` - Regular,\n* `ZZ-301024` - ZZ Estimate - Interval Interpolation,\n* `ZZ-301022` - ZZ Estimate - Interval Averaging,\n* `101500` - No Read - Outage Fill,\n* `ZZ-301501` - ZZ Scalar Calculation from Estimated Interval Read,\n* `ZZ-401000` - ZZ-External Estimate,\n* `ZZ-301515` - ZZ Prorated - Scalar Proration from Regular Read,\n* `ZZ-301514` - ZZ Prorated - Scalar Adjustment from Regular Interval,\n* `ZZ-301513` - ZZ Prorated - Interval Adjustment from Regular Scalar,\n* `101000` - No Read - Outage,\n* `409000` - Combined Quantity,\n* `401000` - External Estimate,\n* `zz-test3` - Override description,\n* `ZZ-TestBug` - ZZ-TestBug-Override description,\n* `zz-test5` - zz test 5,\n* `ZZ-301031` - ZZ Estimate - Int Adj From Scalar,\n* `ZZ-301491` - ZZ Estimate - Scalar Estimation,\n* `100500` - No Read - Field,\n* `ZZ-301511` - ZZ Scalar Proration from Estimation Read,\n* `ZZ-TEST-AGAIN` - ZZ-TEST ONLY,\n* `301000` - System Estimate,\n* `ZZ_Test211` - ZZ_Test211-UPD","example":"501000"},"endDateTime":{"type":"string","format":"date-time","description":"End Date/Time"},"endMeasurement":{"type":"number","maximum":9999999999.999998,"minimum":-9999999999.999998,"description":"End Measurement","example":"0.080000"},"endMeasurementCondition":{"type":"string","enum":["102000","ZZ-test-mark1","100000","901000","ZZBUG","402000","201000","ZZ-500001","501000","ZZ-301024","ZZ-301022","101500","ZZ-301501","ZZ-401000","ZZ-301515","ZZ-301514","ZZ-301513","101000","409000","401000","zz-test3","ZZ-TestBug","zz-test5","ZZ-301031","ZZ-301491","100500","ZZ-301511","ZZ-TEST-AGAIN","301000","ZZ_Test211"],"description":"Condition:\n* `102000` - No Read - Disconnected,\n* `ZZ-test-mark1` - zz-test-mark1,\n* `100000` - No Read - System,\n* `901000` - Super,\n* `ZZBUG` - Override description,\n* `402000` - Office Estimate,\n* `201000` - Missing,\n* `ZZ-500001` - Prorated,\n* `501000` - Regular,\n* `ZZ-301024` - ZZ Estimate - Interval Interpolation,\n* `ZZ-301022` - ZZ Estimate - Interval Averaging,\n* `101500` - No Read - Outage Fill,\n* `ZZ-301501` - ZZ Scalar Calculation from Estimated Interval Read,\n* `ZZ-401000` - ZZ-External Estimate,\n* `ZZ-301515` - ZZ Prorated - Scalar Proration from Regular Read,\n* `ZZ-301514` - ZZ Prorated - Scalar Adjustment from Regular Interval,\n* `ZZ-301513` - ZZ Prorated - Interval Adjustment from Regular Scalar,\n* `101000` - No Read - Outage,\n* `409000` - Combined Quantity,\n* `401000` - External Estimate,\n* `zz-test3` - Override description,\n* `ZZ-TestBug` - ZZ-TestBug-Override description,\n* `zz-test5` - zz test 5,\n* `ZZ-301031` - ZZ Estimate - Int Adj From Scalar,\n* `ZZ-301491` - ZZ Estimate - Scalar Estimation,\n* `100500` - No Read - Field,\n* `ZZ-301511` - ZZ Scalar Proration from Estimation Read,\n* `ZZ-TEST-AGAIN` - ZZ-TEST ONLY,\n* `301000` - System Estimate,\n* `ZZ_Test211` - ZZ_Test211-UPD"},"quantity":{"type":"number","maximum":9999999999.999998,"minimum":-9999999999.999998,"description":"Quantity","example":"9.840000"},"finalUom":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"finalUom":{"type":"string","maxLength":30,"description":"Final UOM"}}},"finalTou":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"finalTou":{"type":"string","maxLength":30,"description":"Final TOU"}}},"finalSqi":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"finalSqi":{"type":"string","maxLength":30,"description":"Final SQI"}}},"finalQuantity":{"type":"number","maximum":9999999999.999998,"minimum":-9999999999.999998,"description":"Final Quantity","example":"9.840000"},"spHowToUse":{"type":"string","enum":["D1AD","D1CK","D1ST"],"description":"Usage:\n* `D1AD` - Add,\n* `D1CK` - Exclude,\n* `D1ST` - Subtract"},"mcHowToUse":{"type":"string","enum":["+   ","-   ","C   ","P   "],"description":"How To Use\n* `+   ` - Additive,\n* `-   ` - Subtractive,\n* `C   ` - Check,\n* `P   ` - Peak","example":"P"},"measuresPeakQuantity":{"type":"string","enum":["D1DP","D1MP"],"description":"Measures Peak Quantity\n* `D1DP` - No,\n* `D1MP` - Yes","example":"D1DP"},"appliedMultiplier":{"type":"number","maximum":1000000000000,"minimum":-1000000000000,"description":"Applied Multiplier","example":"123.000000"},"usePercent":{"type":"number","maximum":999,"minimum":-999,"description":"Use percent","example":"100"},"calculationGroup":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"calculationGroup":{"type":"string","maxLength":30,"description":"Calculation Group"}}},"usageRule":{"type":"string","maxLength":30,"description":"Usage calculation rules are standard and custom rules that perform calculations on measurement data to generate bill determinants.","example":"ZZS-MRULGRP-SCALAR-RULE"}}}}}},"subUsageTransactions":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"subUsageTransactionId":{"type":"string","description":"(subUsageTransactionId)"},"startDateTime":{"type":"string","format":"date-time","description":"(startDateTime)"},"endDateTime":{"type":"string","format":"date-time","description":"(endDateTime)"},"calculationGroup":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"calculationGroup":{"type":"string","maxLength":30,"description":"Calculation Group"}}}}}}}},"characteristics":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"characteristicType":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"characteristicType":{"type":"string","maxLength":8,"description":"Characteristic Type"}}},"characteristicValue":{"type":"string","maxLength":16,"description":"Characteristic Value Indicate the value of the characteristic.","example":"ADV"},"effectiveDate":{"type":"string","format":"date","description":"Effective Date Indicate the effective date of the characteristic type and value. The service point's install date defaults."},"adhocCharacteristicValue":{"type":"string","maxLength":254,"description":"Ad hoc Characteristics Value do not have their valid values defined in a discreet list because the possible values are infinite.","example":"77"},"characteristicValueForeignKey":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"id":{"type":"string","description":"(characteristicValueForeignKey1)"}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks.","example":"2"}}}}}},"serviceQuantitiesData":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"periodSequenceNumber":{"type":"number","maximum":999,"minimum":-999,"description":"Period Sequence Number"},"quantity":{"type":"number","maximum":9999999999.999998,"minimum":-9999999999.999998,"description":"Quantity","example":"9.840000"},"serviceQuantityDataDateTime":{"type":"string","format":"date-time","description":"Service Quantity Data Date/Time"},"serviceQuantityIntervalCondition":{"type":"string","maxLength":254,"description":"Service Quantity  Interval Condition"},"serviceQuantitySequenceNumber":{"type":"number","maximum":99999,"minimum":-99999,"description":"Service Quantity Sequence"}}}}}},"nextActions":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"_link":{"type":"string","description":"(_link)"},"actionName":{"type":"string","description":"(actionName)"}}}}}},"exceptions":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"sequence":{"type":"number","maximum":99999,"minimum":-99999,"description":"Sequence"},"usageGroup":{"type":"string","maxLength":30,"description":"Usage group used to calculate usage transactions (e.g., bill determinants)","example":"ZZS-MRULEGRP-SCALAR-ITEM"},"usageRule":{"type":"string","maxLength":30,"description":"Usage calculation rules are standard and custom rules that perform calculations on measurement data to generate bill determinants.","example":"ZZS-MRULGRP-SCALAR-RULE"},"exceptionType":{"type":"string","maxLength":30,"description":"Exception Type"},"exceptionSeverity":{"type":"string","enum":["D1IF","D1IS","D1TM"],"description":"Exception Severity\n* `D1IF` - Information,\n* `D1IS` - Issues,\n* `D1TM` - Terminate","example":"D1IF"},"exceptionRequiresApproval":{"type":"string","enum":["D1NO","D1YS"],"description":"Exception Requires Approval flag\n* `D1NO` - No,\n* `D1YS` - Yes","example":"D1NO"},"toDoType":{"type":"string","maxLength":8,"description":"To Do Type"},"toDoRole":{"type":"string","maxLength":10,"description":"To Do Role"},"messageCategory":{"type":"number","maximum":99999,"minimum":-99999,"description":"Message category within Oracle Utilities Application Framework."},"messageNumber":{"type":"number","maximum":99999,"minimum":-99999,"description":"Message Number within Oracle Utilities Application Framework."},"messageParameters":{"type":"object","properties":{"messageParametersList":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"sequence":{"type":"number","maximum":999,"minimum":-999,"description":"Message Parameter Sequence"},"parameter":{"type":"string","maxLength":2000,"description":"Message Parameter Value"},"parameterType":{"type":"string","enum":["AMT ","DATE","DTTM","DUR ","FLD ","MMDD","MSG ","NBR ","SRVC","TBL ","TIME"],"description":"Message Parameter Type\n* `AMT ` - Amount parameter,\n* `DATE` - Date format parameter,\n* `DTTM` - Date/time format parameter,\n* `DUR ` - Duration parameter,\n* `FLD ` - Field name parameter,\n* `MMDD` - Month/Day format parameter,\n* `MSG ` - Message parameter,\n* `NBR ` - Numeric parameter,\n* `SRVC` - Service name parameter,\n* `TBL ` - Table name parameter,\n* `TIME` - Time format parameter","example":"AMT"}}}}}}}}}}}}},"traces":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"sequence":{"type":"number","maximum":99999,"minimum":-99999,"description":"Sequence"},"usageGroup":{"type":"string","maxLength":30,"description":"Usage group used to calculate usage transactions (e.g., bill determinants)","example":"ZZS-MRULEGRP-SCALAR-ITEM"},"usageRule":{"type":"string","maxLength":30,"description":"Usage calculation rules are standard and custom rules that perform calculations on measurement data to generate bill determinants.","example":"ZZS-MRULGRP-SCALAR-RULE"},"criteriaSequence":{"type":"number","maximum":999,"minimum":-999,"description":"Sequence"},"duration":{"type":"number","maximum":9999999999,"minimum":-9999999999,"description":"Duration"},"messageCategory":{"type":"number","maximum":99999,"minimum":-99999,"description":"Message category within Oracle Utilities Application Framework."},"messageNumber":{"type":"number","maximum":99999,"minimum":-99999,"description":"Message Number within Oracle Utilities Application Framework."},"messageParameters":{"type":"object","properties":{"messageParametersList":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"sequence":{"type":"number","maximum":999,"minimum":-999,"description":"Message Parameter Sequence"},"parameter":{"type":"string","maxLength":2000,"description":"Message Parameter Value"},"parameterType":{"type":"string","enum":["AMT ","DATE","DTTM","DUR ","FLD ","MMDD","MSG ","NBR ","SRVC","TBL ","TIME"],"description":"Message Parameter Type\n* `AMT ` - Amount parameter,\n* `DATE` - Date format parameter,\n* `DTTM` - Date/time format parameter,\n* `DUR ` - Duration parameter,\n* `FLD ` - Field name parameter,\n* `MMDD` - Month/Day format parameter,\n* `MSG ` - Message parameter,\n* `NBR ` - Numeric parameter,\n* `SRVC` - Service name parameter,\n* `TBL ` - Table name parameter,\n* `TIME` - Time format parameter","example":"AMT"}}}}}}}}}}}}},"initialCalculation":{"type":"boolean","description":"Initial Calculation","example":"true"},"subUsageToDoIds":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"currentToDoId":{"type":"string","maxLength":14,"description":"To Do ID"}}}}}}},"xml":{"name":"D1UsgTransac"}},"CREATEUSAGETRANSACTION_request":{"type":"object","properties":{"usageTransactionId":{"type":"string","maxLength":14,"description":"Usage Transaction ID is a system assigned random number that stays with a usage transaction record.","example":"05458709929330"},"httpMethod":{"type":"string","enum":["DELT","GET ","POST","PTCH","PUT "],"description":"HTTP Method\n* `DELT` - Delete,\n* `GET ` - Get,\n* `POST` - Post,\n* `PTCH` - Patch,\n* `PUT ` - Put","example":"DELT"},"status":{"type":"string","maxLength":12,"description":"Status"},"usageType":{"type":"string","enum":["D2CS","D2IN","D2IS","D2PS","D2SC","D2SF"],"description":"Usage Type flag\n* `D2CS` - Correlated SQ,\n* `D2IN` - Frequently Read,\n* `D2IS` - Frequently Read and Manually Read Scalar,\n* `D2PS` - Profiled SQ,\n* `D2SC` - Manually Read Scalar,\n* `D2SF` - Deprecated - Scalar For Calculation Purposes Only","example":"D2CS"},"usageSubscription":{"type":"object","properties":{"usageSubscriptionId":{"type":"string","maxLength":12,"description":"Usage Subscription"}}},"previousUsageTransaction":{"type":"object","properties":{"previousUsageTransactionId":{"type":"string","maxLength":14,"description":"Usage Transaction ID"}}},"usageExternalId":{"type":"string","maxLength":60,"description":"An ID used by external systems used to identify the usage transaction .When Oracle Utilities Meter Data Management is integrated with Oracle Utilities Customer Care and Billing, Oracle Utilities Customer Care and Billing can send this to help identify the previous usage transaction."},"startDateTime":{"type":"string","format":"date-time","description":"Defines the start date and time of the usage period.","example":"2013-01-02T00:00:00-08:00"},"endDateTime":{"type":"string","format":"date-time","description":"End Date/Time"},"estimateThroughDate":{"type":"string","format":"date","description":"Estimate Through Date","example":"07-01-2017"},"alignmentDateTime":{"type":"string","format":"date-time","description":"Alignment Date/Time"},"calculationGroup":{"type":"object","properties":{"calculationGroup":{"type":"string","maxLength":30,"description":"Calculation Group"}}},"measurementCycle":{"type":"object","description":"Measurement Cycle specifies the schedule used for when the service point is visited and the the device read.","properties":{"measurementCycle":{"type":"string","maxLength":30,"description":"Measurement Cycle specifies the schedule used for when the service point is visited and the the device read."}}},"measurementCycleRoute":{"type":"string","maxLength":30,"description":"Route specifies the group of service points in a cycle that are visited by a meter reader."},"scheduledSelectionDate":{"type":"string","format":"date","description":"Scheduled Selection Date"},"billCondition":{"type":"string","enum":["D2CL","D2IC","D2IL","D2IM"],"description":"The status of the bill associated with the usage transaction (if applicable), used for informational purposes only.\n* `D2CL` - Closing,\n* `D2IC` - Initial and Closing,\n* `D2IL` - Initial,\n* `D2IM` - Interim","example":"D2IL"},"automatedRetry":{"type":"string","enum":["D1NA","D1NO","D1YS"],"description":"A flag that indicates if creation of the usage transaction should be automatically retried in the event of an error.\n* `D1NA` - No - Automatic Discard,\n* `D1NO` - No,\n* `D1YS` - Yes","example":"D1NA"},"nextRetryDateTime":{"type":"string","format":"date-time","description":"Next Retry Date/Time"},"retryUntilDateTime":{"type":"string","format":"date-time","description":"The date time until which the system will attempt to retry creating the usage transaction in the event of an error (applicable only if the Automated Retry flag is set to \"Yes\")."},"subUsageTransactionExist":{"type":"string","enum":["D2NO","D2YS"],"description":"Sub Usage Transactions flag\n* `D2NO` - No,\n* `D2YS` - Yes","example":"D2NO"},"deferCalculation":{"type":"string","enum":["D2NO","D2YS"],"description":"Defer Calculation:\n* `D2NO` - No,\n* `D2YS` - Yes"},"isTraceOn":{"type":"string","enum":["D1NO","D1YS"],"description":"Indicates if tracing is on for the usage transaction.\n* `D1NO` - Off,\n* `D1YS` - On","example":"D1YS"},"skipDetails":{"type":"object","properties":{"skip":{"type":"string","enum":["D2NO","D2YS"],"description":"A flag that indicates if the usage transaction should be skipped.\n* `D2NO` - No,\n* `D2YS` - Yes","example":"D2NO"},"skipReason":{"type":"string","enum":["D2NS"],"description":"Reason for skipping the usage transaction.\n* `D2NS` - No Scheduled Read","example":"D2NS"},"nextScheduledReadDate":{"type":"string","format":"date","description":"The next scheduled read date for the device from which the measurements used to create the usage transaction came."}}},"calculationMode":{"type":"string","enum":["D2HC"],"description":"A flag that indicates the mode in which the usage transaction calculations are/were performed.\n* `D2HC` - Hypothetical Calculation","example":"D2HC"},"usedOnBill":{"type":"string","enum":["D1NO","D1YS"],"description":"This flag indicates (Yes or No) whether or not the usage transaction's service quantities have been used on a completed bill.\n* `D1NO` - No,\n* `D1YS` - Yes","example":"D1YS"},"linkedToFrozenBillSegment":{"type":"string","enum":["D1NO","D1YS"],"description":"This flag indicates (Yes or No) whether or not the usage transaction is linked to a frozen bill segment.\n* `D1NO` - No,\n* `D1YS` - Yes","example":"D1NO"},"usageAdjustmentProfileFactors":{"type":"object","properties":{"profileFactorsList":{"type":"array","items":{"type":"object","properties":{"profileFactor":{"type":"string","maxLength":30,"description":"Factor"},"value":{"type":"string","maxLength":16,"description":"Factor Characteristic Value"}}}}}},"currentToDoId":{"type":"string","maxLength":14,"description":"To Do ID"},"previousToDoId":{"type":"string","maxLength":14,"description":"To Do ID"},"comments":{"type":"string","maxLength":254,"description":"comments"},"requestMode":{"type":"string","enum":["D2BB","D2OB"],"description":"Request\n* `D2BB` - Batch,\n* `D2OB` - Online","example":"D2BB"},"intervalMeasuringComponent":{"type":"object","properties":{"startDateTime":{"type":"string","format":"date-time","description":"Defines the start date and time of the usage period.","example":"2013-01-02T00:00:00-08:00"},"endDateTimeFrom":{"type":"string","format":"date-time","description":"Defines the start date and time for the 'end range' of the usage period.","example":"2013-01-03T00:00:00-08:00"},"endDateTimeTo":{"type":"string","format":"date-time","description":"Defines the end date and time for the 'end range' of the usage period.","example":"2013-01-03T00:00:00-08:00"}}},"scalarMeasuringComponent":{"type":"object","properties":{"startDateTime":{"type":"string","format":"date-time","description":"Defines the start date and time of the usage period.","example":"2013-01-02T00:00:00-08:00"},"estimateTime":{"type":"string","enum":["D1EF","D1ET"],"description":"Estimate Time\n* `D1EF` - End Date Time From,\n* `D1ET` - End Date Time To","example":"D1EF"},"endDateTimeFrom":{"type":"string","format":"date-time","description":"Defines the start date and time for the 'end range' of the usage period.","example":"2013-01-03T00:00:00-08:00"},"endDateTimeTo":{"type":"string","format":"date-time","description":"Defines the end date and time for the 'end range' of the usage period.","example":"2013-01-03T00:00:00-08:00"},"endRangeOption":{"type":"string","enum":["D2SC","D2SP"],"description":"End Range Option indicates the end range option. Valid values include \"Specified\" and \"Derive Using Service Cycle Schedule\"\n* `D2SC` - Derive Using Service Cycle Schedule,\n* `D2SP` - Specified","example":"D2SC"},"minDaysOffset":{"type":"number","maximum":999,"minimum":-999,"description":"Minimum Offset Days / Maximum Offset Days  are used when End Range Option is set to \"Dervice Using Service Cycle Schedule\", these values define a range of days for the end date of the usage transaction, based on the Service Cycle Schedule date."},"maxDaysOffset":{"type":"number","maximum":999,"minimum":-999,"description":"Minimum Offset Days / Maximum Offset Days  are used when End Range Option is set to \"Dervice Using Service Cycle Schedule\", these values define a range of days for the end date of the usage transaction, based on the Service Cycle Schedule date."},"allowEstimate":{"type":"string","enum":["D2AE","D2DE"],"description":"Allow Estimate indicates whether or not to allow use of estimated measurement data when calculating usage.\n* `D2AE` - Allow Estimates,\n* `D2DE` - Do Not Allow Estimates","example":"D2AE"},"estimateDate":{"type":"string","format":"date","description":"Estimate Date indicates the date on which estimated measurement data used in the usage calculation was estimated."},"isEstimate":{"type":"string","enum":["D2NO","D2YS"],"description":"Is Estimate indicates if estimated measurement data was used in the usage calculation.\n* `D2NO` - No,\n* `D2YS` - Yes","example":"D2NO"}}},"dateBreaks":{"type":"object","properties":{"dateBreaksList":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"dateBreak":{"type":"string","format":"date","description":"Date breaks are used to break up a usage period into sub-periods based on the dates on which rate changes took place for the usage transaction (and its related account)."}}}}}}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks.","example":"2"},"usagePeriods":{"type":"object","properties":{"usagePeriodsList":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"sequence":{"type":"number","maximum":999,"minimum":-999,"description":"Period Sequence Number"},"startDateTime":{"type":"string","format":"date-time","description":"Defines the start date and time of the usage period.","example":"2013-01-02T00:00:00-08:00"},"endDateTime":{"type":"string","format":"date-time","description":"End Date/Time"},"usageType":{"type":"string","enum":["D2CS","D2IN","D2IS","D2PS","D2SC","D2SF"],"description":"Usage Type flag\n* `D2CS` - Correlated SQ,\n* `D2IN` - Frequently Read,\n* `D2IS` - Frequently Read and Manually Read Scalar,\n* `D2PS` - Profiled SQ,\n* `D2SC` - Manually Read Scalar,\n* `D2SF` - Deprecated - Scalar For Calculation Purposes Only","example":"D2CS"},"serviceQuantities":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"sqSequence":{"type":"number","maximum":99999,"minimum":-99999,"description":"Service Quantity Sequence"},"sqType":{"type":"string","enum":["D1FC","D1IT","D1MC","D1OT","D1PK","D1SU"],"description":"Usage Service Quantity Type\n* `D1FC` - Factor,\n* `D1IT` - Item,\n* `D1MC` - Measuring Component,\n* `D1OT` - Other,\n* `D1PK` - Peak Across Usage Periods,\n* `D1SU` - Summation","example":"D1FC"},"uom":{"type":"object","properties":{"uom":{"type":"string","maxLength":30,"description":"Unit of Measure"}}},"tou":{"type":"object","properties":{"tou":{"type":"string","maxLength":30,"description":"Time of Use"}}},"sqi":{"type":"object","properties":{"sqi":{"type":"string","maxLength":30,"description":"Service Quantity Identifier"}}},"quantity":{"type":"number","maximum":9999999999.999998,"minimum":-9999999999.999998,"description":"Quantity","example":"9.840000"},"servicePoint":{"type":"object","properties":{"servicePointId":{"type":"string","maxLength":12,"description":"Service Point ID"}}},"measuringComponent":{"type":"object","properties":{"measuringComponentId":{"type":"string","maxLength":12,"description":"Measuring Component ID"}}},"touMap":{"type":"object","properties":{"touMap":{"type":"string","maxLength":12,"description":"TOU Map"}}},"factor":{"type":"object","properties":{"factor":{"type":"string","maxLength":30,"description":"Factor"}}},"characteristicType":{"type":"object","properties":{"characteristicType":{"type":"string","maxLength":8,"description":"Characteristic Type"}}},"characteristicValue":{"type":"object","properties":{"characteristicValue":{"type":"string","maxLength":16,"description":"Characteristic Value"}}},"calculationGroup":{"type":"object","properties":{"calculationGroup":{"type":"string","maxLength":30,"description":"Calculation Group"}}},"calculationRule":{"type":"object","properties":{"calculationRule":{"type":"string","maxLength":30,"description":"Calculation Rule"}}},"intervalData":{"type":"string","enum":["D1EX","D1NE"],"description":"Interval Data:\n* `D1EX` - Exist,\n* `D1NE` - Does Not Exist"},"secondsPerInterval":{"type":"integer","description":"Interval Size"},"estimationIndicator":{"type":"string","enum":["D2ES","D2NE"],"description":"Estimation Indicator\n* `D2ES` - Estimated,\n* `D2NE` - Not Estimated"},"shouldExtractIntervalData":{"type":"string","enum":["D1NO","D1YS"],"description":"Extract Interval Data:\n* `D1NO` - No,\n* `D1YS` - Yes"}}}}}},"itemDetail":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"itemDetailsSeq":{"type":"number","maximum":99999,"minimum":0,"description":"Item Detail Sequence"},"badgedItem":{"type":"object","properties":{"badgedItemId":{"type":"string","maxLength":12,"description":"Device ID"}}},"itemType":{"type":"object","properties":{"itemType":{"type":"string","maxLength":30,"description":"Device Type"}}},"itemCount":{"type":"number","maximum":999999999.99,"minimum":-999999999.99,"description":"Item Count"},"startDateTime":{"type":"string","format":"date-time","description":"Defines the start date and time of the usage period.","example":"2013-01-02T00:00:00-08:00"},"endDateTime":{"type":"string","format":"date-time","description":"End Date/Time"},"quantity":{"type":"number","maximum":9999999999.999998,"minimum":-9999999999.999998,"description":"Quantity","example":"9.840000"},"uom":{"type":"object","properties":{"uom":{"type":"string","maxLength":30,"description":"Unit of Measure"}}},"servicePoint":{"type":"object","properties":{"servicePointId":{"type":"string","maxLength":12,"description":"Service Point ID"}}},"overrideQuantity":{"type":"string","enum":["D1OP"],"description":"Override Quantity flag\n* `D1OP` - Override Quantity Present","example":"D1OP"},"calculationGroup":{"type":"object","properties":{"calculationGroup":{"type":"string","maxLength":30,"description":"Calculation Group"}}},"usageRule":{"type":"string","maxLength":30,"description":"Usage calculation rules are standard and custom rules that perform calculations on measurement data to generate bill determinants.","example":"ZZS-MRULGRP-SCALAR-RULE"}}}}}},"sqsEstimationIndicators":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"uom":{"type":"object","properties":{"uom":{"type":"string","maxLength":30,"description":"Unit of Measure"}}},"tou":{"type":"object","properties":{"tou":{"type":"string","maxLength":30,"description":"Time of Use"}}},"sqi":{"type":"object","properties":{"sqi":{"type":"string","maxLength":30,"description":"Service Quantity Identifier"}}},"estimationIndicator":{"type":"string","enum":["D2ES","D2NE"],"description":"Estimation Indicator\n* `D2ES` - Estimated,\n* `D2NE` - Not Estimated"}}}}}}}}}}}}},"usageTransactionReadingDetails":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"servicePoint":{"type":"object","properties":{"servicePointId":{"type":"string","maxLength":12,"description":"Service Point ID"}}},"sequence":{"type":"number","maximum":999,"minimum":-999,"description":"Sequence"},"uom":{"type":"object","properties":{"uom":{"type":"string","maxLength":30,"description":"Unit of Measure"}}},"tou":{"type":"object","properties":{"tou":{"type":"string","maxLength":30,"description":"Time of Use"}}},"sqi":{"type":"object","properties":{"sqi":{"type":"string","maxLength":30,"description":"Service Quantity Identifier"}}},"measuringComponentId":{"type":"string","maxLength":12,"description":"Measuring Component ID","example":"658852900520"},"startDateTime":{"type":"string","format":"date-time","description":"Defines the start date and time of the usage period.","example":"2013-01-02T00:00:00-08:00"},"startMeasurement":{"type":"number","maximum":9999999999.999998,"minimum":-9999999999.999998,"description":"Start Measurement","example":"0.000000"},"startMeasurementCondition":{"type":"string","enum":["102000","ZZ-test-mark1","100000","901000","ZZBUG","402000","201000","ZZ-500001","501000","ZZ-301024","ZZ-301022","101500","ZZ-301501","ZZ-401000","ZZ-301515","ZZ-301514","ZZ-301513","101000","409000","401000","zz-test3","ZZ-TestBug","zz-test5","ZZ-301031","ZZ-301491","100500","ZZ-301511","ZZ-TEST-AGAIN","301000","ZZ_Test211"],"description":"Start Measurement Condition\n* `102000` - No Read - Disconnected,\n* `ZZ-test-mark1` - zz-test-mark1,\n* `100000` - No Read - System,\n* `901000` - Super,\n* `ZZBUG` - Override description,\n* `402000` - Office Estimate,\n* `201000` - Missing,\n* `ZZ-500001` - Prorated,\n* `501000` - Regular,\n* `ZZ-301024` - ZZ Estimate - Interval Interpolation,\n* `ZZ-301022` - ZZ Estimate - Interval Averaging,\n* `101500` - No Read - Outage Fill,\n* `ZZ-301501` - ZZ Scalar Calculation from Estimated Interval Read,\n* `ZZ-401000` - ZZ-External Estimate,\n* `ZZ-301515` - ZZ Prorated - Scalar Proration from Regular Read,\n* `ZZ-301514` - ZZ Prorated - Scalar Adjustment from Regular Interval,\n* `ZZ-301513` - ZZ Prorated - Interval Adjustment from Regular Scalar,\n* `101000` - No Read - Outage,\n* `409000` - Combined Quantity,\n* `401000` - External Estimate,\n* `zz-test3` - Override description,\n* `ZZ-TestBug` - ZZ-TestBug-Override description,\n* `zz-test5` - zz test 5,\n* `ZZ-301031` - ZZ Estimate - Int Adj From Scalar,\n* `ZZ-301491` - ZZ Estimate - Scalar Estimation,\n* `100500` - No Read - Field,\n* `ZZ-301511` - ZZ Scalar Proration from Estimation Read,\n* `ZZ-TEST-AGAIN` - ZZ-TEST ONLY,\n* `301000` - System Estimate,\n* `ZZ_Test211` - ZZ_Test211-UPD","example":"501000"},"endDateTime":{"type":"string","format":"date-time","description":"End Date/Time"},"endMeasurement":{"type":"number","maximum":9999999999.999998,"minimum":-9999999999.999998,"description":"End Measurement","example":"0.080000"},"endMeasurementCondition":{"type":"string","enum":["102000","ZZ-test-mark1","100000","901000","ZZBUG","402000","201000","ZZ-500001","501000","ZZ-301024","ZZ-301022","101500","ZZ-301501","ZZ-401000","ZZ-301515","ZZ-301514","ZZ-301513","101000","409000","401000","zz-test3","ZZ-TestBug","zz-test5","ZZ-301031","ZZ-301491","100500","ZZ-301511","ZZ-TEST-AGAIN","301000","ZZ_Test211"],"description":"Condition:\n* `102000` - No Read - Disconnected,\n* `ZZ-test-mark1` - zz-test-mark1,\n* `100000` - No Read - System,\n* `901000` - Super,\n* `ZZBUG` - Override description,\n* `402000` - Office Estimate,\n* `201000` - Missing,\n* `ZZ-500001` - Prorated,\n* `501000` - Regular,\n* `ZZ-301024` - ZZ Estimate - Interval Interpolation,\n* `ZZ-301022` - ZZ Estimate - Interval Averaging,\n* `101500` - No Read - Outage Fill,\n* `ZZ-301501` - ZZ Scalar Calculation from Estimated Interval Read,\n* `ZZ-401000` - ZZ-External Estimate,\n* `ZZ-301515` - ZZ Prorated - Scalar Proration from Regular Read,\n* `ZZ-301514` - ZZ Prorated - Scalar Adjustment from Regular Interval,\n* `ZZ-301513` - ZZ Prorated - Interval Adjustment from Regular Scalar,\n* `101000` - No Read - Outage,\n* `409000` - Combined Quantity,\n* `401000` - External Estimate,\n* `zz-test3` - Override description,\n* `ZZ-TestBug` - ZZ-TestBug-Override description,\n* `zz-test5` - zz test 5,\n* `ZZ-301031` - ZZ Estimate - Int Adj From Scalar,\n* `ZZ-301491` - ZZ Estimate - Scalar Estimation,\n* `100500` - No Read - Field,\n* `ZZ-301511` - ZZ Scalar Proration from Estimation Read,\n* `ZZ-TEST-AGAIN` - ZZ-TEST ONLY,\n* `301000` - System Estimate,\n* `ZZ_Test211` - ZZ_Test211-UPD"},"quantity":{"type":"number","maximum":9999999999.999998,"minimum":-9999999999.999998,"description":"Quantity","example":"9.840000"},"finalUom":{"type":"object","properties":{"finalUom":{"type":"string","maxLength":30,"description":"Final UOM"}}},"finalTou":{"type":"object","properties":{"finalTou":{"type":"string","maxLength":30,"description":"Final TOU"}}},"finalSqi":{"type":"object","properties":{"finalSqi":{"type":"string","maxLength":30,"description":"Final SQI"}}},"finalQuantity":{"type":"number","maximum":9999999999.999998,"minimum":-9999999999.999998,"description":"Final Quantity","example":"9.840000"},"spHowToUse":{"type":"string","enum":["D1AD","D1CK","D1ST"],"description":"Usage:\n* `D1AD` - Add,\n* `D1CK` - Exclude,\n* `D1ST` - Subtract"},"mcHowToUse":{"type":"string","enum":["+   ","-   ","C   ","P   "],"description":"How To Use\n* `+   ` - Additive,\n* `-   ` - Subtractive,\n* `C   ` - Check,\n* `P   ` - Peak","example":"P"},"measuresPeakQuantity":{"type":"string","enum":["D1DP","D1MP"],"description":"Measures Peak Quantity\n* `D1DP` - No,\n* `D1MP` - Yes","example":"D1DP"},"appliedMultiplier":{"type":"number","maximum":1000000000000,"minimum":-1000000000000,"description":"Applied Multiplier","example":"123.000000"},"usePercent":{"type":"number","maximum":999,"minimum":-999,"description":"Use percent","example":"100"},"calculationGroup":{"type":"object","properties":{"calculationGroup":{"type":"string","maxLength":30,"description":"Calculation Group"}}},"usageRule":{"type":"string","maxLength":30,"description":"Usage calculation rules are standard and custom rules that perform calculations on measurement data to generate bill determinants.","example":"ZZS-MRULGRP-SCALAR-RULE"}}}}}},"subUsageTransactions":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"subUsageTransactionId":{"type":"string","description":"(subUsageTransactionId)"},"startDateTime":{"type":"string","format":"date-time","description":"(startDateTime)"},"endDateTime":{"type":"string","format":"date-time","description":"(endDateTime)"},"calculationGroup":{"type":"object","properties":{"calculationGroup":{"type":"string","maxLength":30,"description":"Calculation Group"}}}}}}}},"characteristics":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"characteristicType":{"type":"object","properties":{"characteristicType":{"type":"string","maxLength":8,"description":"Characteristic Type"}}},"characteristicValue":{"type":"string","maxLength":16,"description":"Characteristic Value Indicate the value of the characteristic.","example":"ADV"},"effectiveDate":{"type":"string","format":"date","description":"Effective Date Indicate the effective date of the characteristic type and value. The service point's install date defaults."},"adhocCharacteristicValue":{"type":"string","maxLength":254,"description":"Ad hoc Characteristics Value do not have their valid values defined in a discreet list because the possible values are infinite.","example":"77"},"characteristicValueForeignKey":{"type":"object","properties":{"id":{"type":"string","description":"(characteristicValueForeignKey1)"}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks.","example":"2"}}}}}},"serviceQuantitiesData":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"periodSequenceNumber":{"type":"number","maximum":999,"minimum":-999,"description":"Period Sequence Number"},"quantity":{"type":"number","maximum":9999999999.999998,"minimum":-9999999999.999998,"description":"Quantity","example":"9.840000"},"serviceQuantityDataDateTime":{"type":"string","format":"date-time","description":"Service Quantity Data Date/Time"},"serviceQuantityIntervalCondition":{"type":"string","maxLength":254,"description":"Service Quantity  Interval Condition"},"serviceQuantitySequenceNumber":{"type":"number","maximum":99999,"minimum":-99999,"description":"Service Quantity Sequence"}}}}}},"nextActions":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"_link":{"type":"string","description":"(_link)"},"actionName":{"type":"string","description":"(actionName)"}}}}}},"exceptions":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"sequence":{"type":"number","maximum":99999,"minimum":-99999,"description":"Sequence"},"usageGroup":{"type":"string","maxLength":30,"description":"Usage group used to calculate usage transactions (e.g., bill determinants)","example":"ZZS-MRULEGRP-SCALAR-ITEM"},"usageRule":{"type":"string","maxLength":30,"description":"Usage calculation rules are standard and custom rules that perform calculations on measurement data to generate bill determinants.","example":"ZZS-MRULGRP-SCALAR-RULE"},"exceptionType":{"type":"string","maxLength":30,"description":"Exception Type"},"exceptionSeverity":{"type":"string","enum":["D1IF","D1IS","D1TM"],"description":"Exception Severity\n* `D1IF` - Information,\n* `D1IS` - Issues,\n* `D1TM` - Terminate","example":"D1IF"},"exceptionRequiresApproval":{"type":"string","enum":["D1NO","D1YS"],"description":"Exception Requires Approval flag\n* `D1NO` - No,\n* `D1YS` - Yes","example":"D1NO"},"toDoType":{"type":"string","maxLength":8,"description":"To Do Type"},"toDoRole":{"type":"string","maxLength":10,"description":"To Do Role"},"messageCategory":{"type":"number","maximum":99999,"minimum":-99999,"description":"Message category within Oracle Utilities Application Framework."},"messageNumber":{"type":"number","maximum":99999,"minimum":-99999,"description":"Message Number within Oracle Utilities Application Framework."},"messageParameters":{"type":"object","properties":{"messageParametersList":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"sequence":{"type":"number","maximum":999,"minimum":-999,"description":"Message Parameter Sequence"},"parameter":{"type":"string","maxLength":2000,"description":"Message Parameter Value"},"parameterType":{"type":"string","enum":["AMT ","DATE","DTTM","DUR ","FLD ","MMDD","MSG ","NBR ","SRVC","TBL ","TIME"],"description":"Message Parameter Type\n* `AMT ` - Amount parameter,\n* `DATE` - Date format parameter,\n* `DTTM` - Date/time format parameter,\n* `DUR ` - Duration parameter,\n* `FLD ` - Field name parameter,\n* `MMDD` - Month/Day format parameter,\n* `MSG ` - Message parameter,\n* `NBR ` - Numeric parameter,\n* `SRVC` - Service name parameter,\n* `TBL ` - Table name parameter,\n* `TIME` - Time format parameter","example":"AMT"}}}}}}}}}}}}},"traces":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"sequence":{"type":"number","maximum":99999,"minimum":-99999,"description":"Sequence"},"usageGroup":{"type":"string","maxLength":30,"description":"Usage group used to calculate usage transactions (e.g., bill determinants)","example":"ZZS-MRULEGRP-SCALAR-ITEM"},"usageRule":{"type":"string","maxLength":30,"description":"Usage calculation rules are standard and custom rules that perform calculations on measurement data to generate bill determinants.","example":"ZZS-MRULGRP-SCALAR-RULE"},"criteriaSequence":{"type":"number","maximum":999,"minimum":-999,"description":"Sequence"},"duration":{"type":"number","maximum":9999999999,"minimum":-9999999999,"description":"Duration"},"messageCategory":{"type":"number","maximum":99999,"minimum":-99999,"description":"Message category within Oracle Utilities Application Framework."},"messageNumber":{"type":"number","maximum":99999,"minimum":-99999,"description":"Message Number within Oracle Utilities Application Framework."},"messageParameters":{"type":"object","properties":{"messageParametersList":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"sequence":{"type":"number","maximum":999,"minimum":-999,"description":"Message Parameter Sequence"},"parameter":{"type":"string","maxLength":2000,"description":"Message Parameter Value"},"parameterType":{"type":"string","enum":["AMT ","DATE","DTTM","DUR ","FLD ","MMDD","MSG ","NBR ","SRVC","TBL ","TIME"],"description":"Message Parameter Type\n* `AMT ` - Amount parameter,\n* `DATE` - Date format parameter,\n* `DTTM` - Date/time format parameter,\n* `DUR ` - Duration parameter,\n* `FLD ` - Field name parameter,\n* `MMDD` - Month/Day format parameter,\n* `MSG ` - Message parameter,\n* `NBR ` - Numeric parameter,\n* `SRVC` - Service name parameter,\n* `TBL ` - Table name parameter,\n* `TIME` - Time format parameter","example":"AMT"}}}}}}}}}}}}},"initialCalculation":{"type":"boolean","description":"Initial Calculation","example":"true"},"subUsageToDoIds":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"currentToDoId":{"type":"string","maxLength":14,"description":"To Do ID"}}}}}}},"xml":{"name":"D1UsgTransac"}},"UPDATEUSAGETRANSACTION_response":{"type":"object","properties":{"_self":{"type":"string","description":"_self"},"usageTransactionId":{"type":"string","maxLength":14,"description":"Usage Transaction ID is a system assigned random number that stays with a usage transaction record.","example":"05458709929330"},"httpMethod":{"type":"string","enum":["DELT","GET ","POST","PTCH","PUT "],"description":"HTTP Method\n* `DELT` - Delete,\n* `GET ` - Get,\n* `POST` - Post,\n* `PTCH` - Patch,\n* `PUT ` - Put","example":"DELT"},"status":{"type":"string","maxLength":12,"description":"Status"},"usageType":{"type":"string","enum":["D2CS","D2IN","D2IS","D2PS","D2SC","D2SF"],"description":"Usage Type flag\n* `D2CS` - Correlated SQ,\n* `D2IN` - Frequently Read,\n* `D2IS` - Frequently Read and Manually Read Scalar,\n* `D2PS` - Profiled SQ,\n* `D2SC` - Manually Read Scalar,\n* `D2SF` - Deprecated - Scalar For Calculation Purposes Only","example":"D2CS"},"usageSubscription":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"usageSubscriptionId":{"type":"string","maxLength":12,"description":"Usage Subscription"}}},"previousUsageTransaction":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"previousUsageTransactionId":{"type":"string","maxLength":14,"description":"Usage Transaction ID"}}},"usageExternalId":{"type":"string","maxLength":60,"description":"An ID used by external systems used to identify the usage transaction .When Oracle Utilities Meter Data Management is integrated with Oracle Utilities Customer Care and Billing, Oracle Utilities Customer Care and Billing can send this to help identify the previous usage transaction."},"startDateTime":{"type":"string","format":"date-time","description":"Defines the start date and time of the usage period.","example":"2013-01-02T00:00:00-08:00"},"endDateTime":{"type":"string","format":"date-time","description":"End Date/Time"},"estimateThroughDate":{"type":"string","format":"date","description":"Estimate Through Date","example":"07-01-2017"},"alignmentDateTime":{"type":"string","format":"date-time","description":"Alignment Date/Time"},"calculationGroup":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"calculationGroup":{"type":"string","maxLength":30,"description":"Calculation Group"}}},"measurementCycle":{"type":"object","description":"Measurement Cycle specifies the schedule used for when the service point is visited and the the device read.","properties":{"_link":{"type":"string","description":"_link"},"measurementCycle":{"type":"string","maxLength":30,"description":"Measurement Cycle specifies the schedule used for when the service point is visited and the the device read."}}},"measurementCycleRoute":{"type":"string","maxLength":30,"description":"Route specifies the group of service points in a cycle that are visited by a meter reader."},"scheduledSelectionDate":{"type":"string","format":"date","description":"Scheduled Selection Date"},"billCondition":{"type":"string","enum":["D2CL","D2IC","D2IL","D2IM"],"description":"The status of the bill associated with the usage transaction (if applicable), used for informational purposes only.\n* `D2CL` - Closing,\n* `D2IC` - Initial and Closing,\n* `D2IL` - Initial,\n* `D2IM` - Interim","example":"D2IL"},"automatedRetry":{"type":"string","enum":["D1NA","D1NO","D1YS"],"description":"A flag that indicates if creation of the usage transaction should be automatically retried in the event of an error.\n* `D1NA` - No - Automatic Discard,\n* `D1NO` - No,\n* `D1YS` - Yes","example":"D1NA"},"nextRetryDateTime":{"type":"string","format":"date-time","description":"Next Retry Date/Time"},"retryUntilDateTime":{"type":"string","format":"date-time","description":"The date time until which the system will attempt to retry creating the usage transaction in the event of an error (applicable only if the Automated Retry flag is set to \"Yes\")."},"subUsageTransactionExist":{"type":"string","enum":["D2NO","D2YS"],"description":"Sub Usage Transactions flag\n* `D2NO` - No,\n* `D2YS` - Yes","example":"D2NO"},"deferCalculation":{"type":"string","enum":["D2NO","D2YS"],"description":"Defer Calculation:\n* `D2NO` - No,\n* `D2YS` - Yes"},"isTraceOn":{"type":"string","enum":["D1NO","D1YS"],"description":"Indicates if tracing is on for the usage transaction.\n* `D1NO` - Off,\n* `D1YS` - On","example":"D1YS"},"skipDetails":{"type":"object","properties":{"skip":{"type":"string","enum":["D2NO","D2YS"],"description":"A flag that indicates if the usage transaction should be skipped.\n* `D2NO` - No,\n* `D2YS` - Yes","example":"D2NO"},"skipReason":{"type":"string","enum":["D2NS"],"description":"Reason for skipping the usage transaction.\n* `D2NS` - No Scheduled Read","example":"D2NS"},"nextScheduledReadDate":{"type":"string","format":"date","description":"The next scheduled read date for the device from which the measurements used to create the usage transaction came."}}},"calculationMode":{"type":"string","enum":["D2HC"],"description":"A flag that indicates the mode in which the usage transaction calculations are/were performed.\n* `D2HC` - Hypothetical Calculation","example":"D2HC"},"usedOnBill":{"type":"string","enum":["D1NO","D1YS"],"description":"This flag indicates (Yes or No) whether or not the usage transaction's service quantities have been used on a completed bill.\n* `D1NO` - No,\n* `D1YS` - Yes","example":"D1YS"},"linkedToFrozenBillSegment":{"type":"string","enum":["D1NO","D1YS"],"description":"This flag indicates (Yes or No) whether or not the usage transaction is linked to a frozen bill segment.\n* `D1NO` - No,\n* `D1YS` - Yes","example":"D1NO"},"usageAdjustmentProfileFactors":{"type":"object","properties":{"profileFactorsList":{"type":"array","items":{"type":"object","properties":{"profileFactor":{"type":"string","maxLength":30,"description":"Factor"},"value":{"type":"string","maxLength":16,"description":"Factor Characteristic Value"}}}}}},"currentToDoId":{"type":"string","maxLength":14,"description":"To Do ID"},"previousToDoId":{"type":"string","maxLength":14,"description":"To Do ID"},"comments":{"type":"string","maxLength":254,"description":"comments"},"requestMode":{"type":"string","enum":["D2BB","D2OB"],"description":"Request\n* `D2BB` - Batch,\n* `D2OB` - Online","example":"D2BB"},"intervalMeasuringComponent":{"type":"object","properties":{"startDateTime":{"type":"string","format":"date-time","description":"Defines the start date and time of the usage period.","example":"2013-01-02T00:00:00-08:00"},"endDateTimeFrom":{"type":"string","format":"date-time","description":"Defines the start date and time for the 'end range' of the usage period.","example":"2013-01-03T00:00:00-08:00"},"endDateTimeTo":{"type":"string","format":"date-time","description":"Defines the end date and time for the 'end range' of the usage period.","example":"2013-01-03T00:00:00-08:00"}}},"scalarMeasuringComponent":{"type":"object","properties":{"startDateTime":{"type":"string","format":"date-time","description":"Defines the start date and time of the usage period.","example":"2013-01-02T00:00:00-08:00"},"estimateTime":{"type":"string","enum":["D1EF","D1ET"],"description":"Estimate Time\n* `D1EF` - End Date Time From,\n* `D1ET` - End Date Time To","example":"D1EF"},"endDateTimeFrom":{"type":"string","format":"date-time","description":"Defines the start date and time for the 'end range' of the usage period.","example":"2013-01-03T00:00:00-08:00"},"endDateTimeTo":{"type":"string","format":"date-time","description":"Defines the end date and time for the 'end range' of the usage period.","example":"2013-01-03T00:00:00-08:00"},"endRangeOption":{"type":"string","enum":["D2SC","D2SP"],"description":"End Range Option indicates the end range option. Valid values include \"Specified\" and \"Derive Using Service Cycle Schedule\"\n* `D2SC` - Derive Using Service Cycle Schedule,\n* `D2SP` - Specified","example":"D2SC"},"minDaysOffset":{"type":"number","maximum":999,"minimum":-999,"description":"Minimum Offset Days / Maximum Offset Days  are used when End Range Option is set to \"Dervice Using Service Cycle Schedule\", these values define a range of days for the end date of the usage transaction, based on the Service Cycle Schedule date."},"maxDaysOffset":{"type":"number","maximum":999,"minimum":-999,"description":"Minimum Offset Days / Maximum Offset Days  are used when End Range Option is set to \"Dervice Using Service Cycle Schedule\", these values define a range of days for the end date of the usage transaction, based on the Service Cycle Schedule date."},"allowEstimate":{"type":"string","enum":["D2AE","D2DE"],"description":"Allow Estimate indicates whether or not to allow use of estimated measurement data when calculating usage.\n* `D2AE` - Allow Estimates,\n* `D2DE` - Do Not Allow Estimates","example":"D2AE"},"estimateDate":{"type":"string","format":"date","description":"Estimate Date indicates the date on which estimated measurement data used in the usage calculation was estimated."},"isEstimate":{"type":"string","enum":["D2NO","D2YS"],"description":"Is Estimate indicates if estimated measurement data was used in the usage calculation.\n* `D2NO` - No,\n* `D2YS` - Yes","example":"D2NO"}}},"dateBreaks":{"type":"object","properties":{"dateBreaksList":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"dateBreak":{"type":"string","format":"date","description":"Date breaks are used to break up a usage period into sub-periods based on the dates on which rate changes took place for the usage transaction (and its related account)."}}}}}}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks.","example":"2"},"usagePeriods":{"type":"object","properties":{"usagePeriodsList":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"sequence":{"type":"number","maximum":999,"minimum":-999,"description":"Period Sequence Number"},"startDateTime":{"type":"string","format":"date-time","description":"Defines the start date and time of the usage period.","example":"2013-01-02T00:00:00-08:00"},"endDateTime":{"type":"string","format":"date-time","description":"End Date/Time"},"usageType":{"type":"string","enum":["D2CS","D2IN","D2IS","D2PS","D2SC","D2SF"],"description":"Usage Type flag\n* `D2CS` - Correlated SQ,\n* `D2IN` - Frequently Read,\n* `D2IS` - Frequently Read and Manually Read Scalar,\n* `D2PS` - Profiled SQ,\n* `D2SC` - Manually Read Scalar,\n* `D2SF` - Deprecated - Scalar For Calculation Purposes Only","example":"D2CS"},"serviceQuantities":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"sqSequence":{"type":"number","maximum":99999,"minimum":-99999,"description":"Service Quantity Sequence"},"sqType":{"type":"string","enum":["D1FC","D1IT","D1MC","D1OT","D1PK","D1SU"],"description":"Usage Service Quantity Type\n* `D1FC` - Factor,\n* `D1IT` - Item,\n* `D1MC` - Measuring Component,\n* `D1OT` - Other,\n* `D1PK` - Peak Across Usage Periods,\n* `D1SU` - Summation","example":"D1FC"},"uom":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"uom":{"type":"string","maxLength":30,"description":"Unit of Measure"}}},"tou":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"tou":{"type":"string","maxLength":30,"description":"Time of Use"}}},"sqi":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"sqi":{"type":"string","maxLength":30,"description":"Service Quantity Identifier"}}},"quantity":{"type":"number","maximum":9999999999.999998,"minimum":-9999999999.999998,"description":"Quantity","example":"9.840000"},"servicePoint":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"servicePointId":{"type":"string","maxLength":12,"description":"Service Point ID"}}},"measuringComponent":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"measuringComponentId":{"type":"string","maxLength":12,"description":"Measuring Component ID"}}},"touMap":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"touMap":{"type":"string","maxLength":12,"description":"TOU Map"}}},"factor":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"factor":{"type":"string","maxLength":30,"description":"Factor"}}},"characteristicType":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"characteristicType":{"type":"string","maxLength":8,"description":"Characteristic Type"}}},"characteristicValue":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"characteristicValue":{"type":"string","maxLength":16,"description":"Characteristic Value"}}},"calculationGroup":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"calculationGroup":{"type":"string","maxLength":30,"description":"Calculation Group"}}},"calculationRule":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"calculationRule":{"type":"string","maxLength":30,"description":"Calculation Rule"}}},"intervalData":{"type":"string","enum":["D1EX","D1NE"],"description":"Interval Data:\n* `D1EX` - Exist,\n* `D1NE` - Does Not Exist"},"secondsPerInterval":{"type":"integer","description":"Interval Size"},"estimationIndicator":{"type":"string","enum":["D2ES","D2NE"],"description":"Estimation Indicator\n* `D2ES` - Estimated,\n* `D2NE` - Not Estimated"},"shouldExtractIntervalData":{"type":"string","enum":["D1NO","D1YS"],"description":"Extract Interval Data:\n* `D1NO` - No,\n* `D1YS` - Yes"}}}}}},"itemDetail":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"itemDetailsSeq":{"type":"number","maximum":99999,"minimum":0,"description":"Item Detail Sequence"},"badgedItem":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"badgedItemId":{"type":"string","maxLength":12,"description":"Device ID"}}},"itemType":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"itemType":{"type":"string","maxLength":30,"description":"Device Type"}}},"itemCount":{"type":"number","maximum":999999999.99,"minimum":-999999999.99,"description":"Item Count"},"startDateTime":{"type":"string","format":"date-time","description":"Defines the start date and time of the usage period.","example":"2013-01-02T00:00:00-08:00"},"endDateTime":{"type":"string","format":"date-time","description":"End Date/Time"},"quantity":{"type":"number","maximum":9999999999.999998,"minimum":-9999999999.999998,"description":"Quantity","example":"9.840000"},"uom":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"uom":{"type":"string","maxLength":30,"description":"Unit of Measure"}}},"servicePoint":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"servicePointId":{"type":"string","maxLength":12,"description":"Service Point ID"}}},"overrideQuantity":{"type":"string","enum":["D1OP"],"description":"Override Quantity flag\n* `D1OP` - Override Quantity Present","example":"D1OP"},"calculationGroup":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"calculationGroup":{"type":"string","maxLength":30,"description":"Calculation Group"}}},"usageRule":{"type":"string","maxLength":30,"description":"Usage calculation rules are standard and custom rules that perform calculations on measurement data to generate bill determinants.","example":"ZZS-MRULGRP-SCALAR-RULE"}}}}}},"sqsEstimationIndicators":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"uom":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"uom":{"type":"string","maxLength":30,"description":"Unit of Measure"}}},"tou":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"tou":{"type":"string","maxLength":30,"description":"Time of Use"}}},"sqi":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"sqi":{"type":"string","maxLength":30,"description":"Service Quantity Identifier"}}},"estimationIndicator":{"type":"string","enum":["D2ES","D2NE"],"description":"Estimation Indicator\n* `D2ES` - Estimated,\n* `D2NE` - Not Estimated"}}}}}}}}}}}}},"usageTransactionReadingDetails":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"servicePoint":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"servicePointId":{"type":"string","maxLength":12,"description":"Service Point ID"}}},"sequence":{"type":"number","maximum":999,"minimum":-999,"description":"Sequence"},"uom":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"uom":{"type":"string","maxLength":30,"description":"Unit of Measure"}}},"tou":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"tou":{"type":"string","maxLength":30,"description":"Time of Use"}}},"sqi":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"sqi":{"type":"string","maxLength":30,"description":"Service Quantity Identifier"}}},"measuringComponentId":{"type":"string","maxLength":12,"description":"Measuring Component ID","example":"658852900520"},"startDateTime":{"type":"string","format":"date-time","description":"Defines the start date and time of the usage period.","example":"2013-01-02T00:00:00-08:00"},"startMeasurement":{"type":"number","maximum":9999999999.999998,"minimum":-9999999999.999998,"description":"Start Measurement","example":"0.000000"},"startMeasurementCondition":{"type":"string","enum":["102000","ZZ-test-mark1","100000","901000","ZZBUG","402000","201000","ZZ-500001","501000","ZZ-301024","ZZ-301022","101500","ZZ-301501","ZZ-401000","ZZ-301515","ZZ-301514","ZZ-301513","101000","409000","401000","zz-test3","ZZ-TestBug","zz-test5","ZZ-301031","ZZ-301491","100500","ZZ-301511","ZZ-TEST-AGAIN","301000","ZZ_Test211"],"description":"Start Measurement Condition\n* `102000` - No Read - Disconnected,\n* `ZZ-test-mark1` - zz-test-mark1,\n* `100000` - No Read - System,\n* `901000` - Super,\n* `ZZBUG` - Override description,\n* `402000` - Office Estimate,\n* `201000` - Missing,\n* `ZZ-500001` - Prorated,\n* `501000` - Regular,\n* `ZZ-301024` - ZZ Estimate - Interval Interpolation,\n* `ZZ-301022` - ZZ Estimate - Interval Averaging,\n* `101500` - No Read - Outage Fill,\n* `ZZ-301501` - ZZ Scalar Calculation from Estimated Interval Read,\n* `ZZ-401000` - ZZ-External Estimate,\n* `ZZ-301515` - ZZ Prorated - Scalar Proration from Regular Read,\n* `ZZ-301514` - ZZ Prorated - Scalar Adjustment from Regular Interval,\n* `ZZ-301513` - ZZ Prorated - Interval Adjustment from Regular Scalar,\n* `101000` - No Read - Outage,\n* `409000` - Combined Quantity,\n* `401000` - External Estimate,\n* `zz-test3` - Override description,\n* `ZZ-TestBug` - ZZ-TestBug-Override description,\n* `zz-test5` - zz test 5,\n* `ZZ-301031` - ZZ Estimate - Int Adj From Scalar,\n* `ZZ-301491` - ZZ Estimate - Scalar Estimation,\n* `100500` - No Read - Field,\n* `ZZ-301511` - ZZ Scalar Proration from Estimation Read,\n* `ZZ-TEST-AGAIN` - ZZ-TEST ONLY,\n* `301000` - System Estimate,\n* `ZZ_Test211` - ZZ_Test211-UPD","example":"501000"},"endDateTime":{"type":"string","format":"date-time","description":"End Date/Time"},"endMeasurement":{"type":"number","maximum":9999999999.999998,"minimum":-9999999999.999998,"description":"End Measurement","example":"0.080000"},"endMeasurementCondition":{"type":"string","enum":["102000","ZZ-test-mark1","100000","901000","ZZBUG","402000","201000","ZZ-500001","501000","ZZ-301024","ZZ-301022","101500","ZZ-301501","ZZ-401000","ZZ-301515","ZZ-301514","ZZ-301513","101000","409000","401000","zz-test3","ZZ-TestBug","zz-test5","ZZ-301031","ZZ-301491","100500","ZZ-301511","ZZ-TEST-AGAIN","301000","ZZ_Test211"],"description":"Condition:\n* `102000` - No Read - Disconnected,\n* `ZZ-test-mark1` - zz-test-mark1,\n* `100000` - No Read - System,\n* `901000` - Super,\n* `ZZBUG` - Override description,\n* `402000` - Office Estimate,\n* `201000` - Missing,\n* `ZZ-500001` - Prorated,\n* `501000` - Regular,\n* `ZZ-301024` - ZZ Estimate - Interval Interpolation,\n* `ZZ-301022` - ZZ Estimate - Interval Averaging,\n* `101500` - No Read - Outage Fill,\n* `ZZ-301501` - ZZ Scalar Calculation from Estimated Interval Read,\n* `ZZ-401000` - ZZ-External Estimate,\n* `ZZ-301515` - ZZ Prorated - Scalar Proration from Regular Read,\n* `ZZ-301514` - ZZ Prorated - Scalar Adjustment from Regular Interval,\n* `ZZ-301513` - ZZ Prorated - Interval Adjustment from Regular Scalar,\n* `101000` - No Read - Outage,\n* `409000` - Combined Quantity,\n* `401000` - External Estimate,\n* `zz-test3` - Override description,\n* `ZZ-TestBug` - ZZ-TestBug-Override description,\n* `zz-test5` - zz test 5,\n* `ZZ-301031` - ZZ Estimate - Int Adj From Scalar,\n* `ZZ-301491` - ZZ Estimate - Scalar Estimation,\n* `100500` - No Read - Field,\n* `ZZ-301511` - ZZ Scalar Proration from Estimation Read,\n* `ZZ-TEST-AGAIN` - ZZ-TEST ONLY,\n* `301000` - System Estimate,\n* `ZZ_Test211` - ZZ_Test211-UPD"},"quantity":{"type":"number","maximum":9999999999.999998,"minimum":-9999999999.999998,"description":"Quantity","example":"9.840000"},"finalUom":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"finalUom":{"type":"string","maxLength":30,"description":"Final UOM"}}},"finalTou":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"finalTou":{"type":"string","maxLength":30,"description":"Final TOU"}}},"finalSqi":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"finalSqi":{"type":"string","maxLength":30,"description":"Final SQI"}}},"finalQuantity":{"type":"number","maximum":9999999999.999998,"minimum":-9999999999.999998,"description":"Final Quantity","example":"9.840000"},"spHowToUse":{"type":"string","enum":["D1AD","D1CK","D1ST"],"description":"Usage:\n* `D1AD` - Add,\n* `D1CK` - Exclude,\n* `D1ST` - Subtract"},"mcHowToUse":{"type":"string","enum":["+   ","-   ","C   ","P   "],"description":"How To Use\n* `+   ` - Additive,\n* `-   ` - Subtractive,\n* `C   ` - Check,\n* `P   ` - Peak","example":"P"},"measuresPeakQuantity":{"type":"string","enum":["D1DP","D1MP"],"description":"Measures Peak Quantity\n* `D1DP` - No,\n* `D1MP` - Yes","example":"D1DP"},"appliedMultiplier":{"type":"number","maximum":1000000000000,"minimum":-1000000000000,"description":"Applied Multiplier","example":"123.000000"},"usePercent":{"type":"number","maximum":999,"minimum":-999,"description":"Use percent","example":"100"},"calculationGroup":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"calculationGroup":{"type":"string","maxLength":30,"description":"Calculation Group"}}},"usageRule":{"type":"string","maxLength":30,"description":"Usage calculation rules are standard and custom rules that perform calculations on measurement data to generate bill determinants.","example":"ZZS-MRULGRP-SCALAR-RULE"}}}}}},"subUsageTransactions":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"subUsageTransactionId":{"type":"string","description":"(subUsageTransactionId)"},"startDateTime":{"type":"string","format":"date-time","description":"(startDateTime)"},"endDateTime":{"type":"string","format":"date-time","description":"(endDateTime)"},"calculationGroup":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"calculationGroup":{"type":"string","maxLength":30,"description":"Calculation Group"}}}}}}}},"characteristics":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"characteristicType":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"characteristicType":{"type":"string","maxLength":8,"description":"Characteristic Type"}}},"characteristicValue":{"type":"string","maxLength":16,"description":"Characteristic Value Indicate the value of the characteristic.","example":"ADV"},"effectiveDate":{"type":"string","format":"date","description":"Effective Date Indicate the effective date of the characteristic type and value. The service point's install date defaults."},"adhocCharacteristicValue":{"type":"string","maxLength":254,"description":"Ad hoc Characteristics Value do not have their valid values defined in a discreet list because the possible values are infinite.","example":"77"},"characteristicValueForeignKey":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"id":{"type":"string","description":"(characteristicValueForeignKey1)"}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks.","example":"2"}}}}}},"serviceQuantitiesData":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"periodSequenceNumber":{"type":"number","maximum":999,"minimum":-999,"description":"Period Sequence Number"},"quantity":{"type":"number","maximum":9999999999.999998,"minimum":-9999999999.999998,"description":"Quantity","example":"9.840000"},"serviceQuantityDataDateTime":{"type":"string","format":"date-time","description":"Service Quantity Data Date/Time"},"serviceQuantityIntervalCondition":{"type":"string","maxLength":254,"description":"Service Quantity  Interval Condition"},"serviceQuantitySequenceNumber":{"type":"number","maximum":99999,"minimum":-99999,"description":"Service Quantity Sequence"}}}}}},"nextActions":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"_link":{"type":"string","description":"(_link)"},"actionName":{"type":"string","description":"(actionName)"}}}}}},"exceptions":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"sequence":{"type":"number","maximum":99999,"minimum":-99999,"description":"Sequence"},"usageGroup":{"type":"string","maxLength":30,"description":"Usage group used to calculate usage transactions (e.g., bill determinants)","example":"ZZS-MRULEGRP-SCALAR-ITEM"},"usageRule":{"type":"string","maxLength":30,"description":"Usage calculation rules are standard and custom rules that perform calculations on measurement data to generate bill determinants.","example":"ZZS-MRULGRP-SCALAR-RULE"},"exceptionType":{"type":"string","maxLength":30,"description":"Exception Type"},"exceptionSeverity":{"type":"string","enum":["D1IF","D1IS","D1TM"],"description":"Exception Severity\n* `D1IF` - Information,\n* `D1IS` - Issues,\n* `D1TM` - Terminate","example":"D1IF"},"exceptionRequiresApproval":{"type":"string","enum":["D1NO","D1YS"],"description":"Exception Requires Approval flag\n* `D1NO` - No,\n* `D1YS` - Yes","example":"D1NO"},"toDoType":{"type":"string","maxLength":8,"description":"To Do Type"},"toDoRole":{"type":"string","maxLength":10,"description":"To Do Role"},"messageCategory":{"type":"number","maximum":99999,"minimum":-99999,"description":"Message category within Oracle Utilities Application Framework."},"messageNumber":{"type":"number","maximum":99999,"minimum":-99999,"description":"Message Number within Oracle Utilities Application Framework."},"messageParameters":{"type":"object","properties":{"messageParametersList":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"sequence":{"type":"number","maximum":999,"minimum":-999,"description":"Message Parameter Sequence"},"parameter":{"type":"string","maxLength":2000,"description":"Message Parameter Value"},"parameterType":{"type":"string","enum":["AMT ","DATE","DTTM","DUR ","FLD ","MMDD","MSG ","NBR ","SRVC","TBL ","TIME"],"description":"Message Parameter Type\n* `AMT ` - Amount parameter,\n* `DATE` - Date format parameter,\n* `DTTM` - Date/time format parameter,\n* `DUR ` - Duration parameter,\n* `FLD ` - Field name parameter,\n* `MMDD` - Month/Day format parameter,\n* `MSG ` - Message parameter,\n* `NBR ` - Numeric parameter,\n* `SRVC` - Service name parameter,\n* `TBL ` - Table name parameter,\n* `TIME` - Time format parameter","example":"AMT"}}}}}}}}}}}}},"traces":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"sequence":{"type":"number","maximum":99999,"minimum":-99999,"description":"Sequence"},"usageGroup":{"type":"string","maxLength":30,"description":"Usage group used to calculate usage transactions (e.g., bill determinants)","example":"ZZS-MRULEGRP-SCALAR-ITEM"},"usageRule":{"type":"string","maxLength":30,"description":"Usage calculation rules are standard and custom rules that perform calculations on measurement data to generate bill determinants.","example":"ZZS-MRULGRP-SCALAR-RULE"},"criteriaSequence":{"type":"number","maximum":999,"minimum":-999,"description":"Sequence"},"duration":{"type":"number","maximum":9999999999,"minimum":-9999999999,"description":"Duration"},"messageCategory":{"type":"number","maximum":99999,"minimum":-99999,"description":"Message category within Oracle Utilities Application Framework."},"messageNumber":{"type":"number","maximum":99999,"minimum":-99999,"description":"Message Number within Oracle Utilities Application Framework."},"messageParameters":{"type":"object","properties":{"messageParametersList":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"sequence":{"type":"number","maximum":999,"minimum":-999,"description":"Message Parameter Sequence"},"parameter":{"type":"string","maxLength":2000,"description":"Message Parameter Value"},"parameterType":{"type":"string","enum":["AMT ","DATE","DTTM","DUR ","FLD ","MMDD","MSG ","NBR ","SRVC","TBL ","TIME"],"description":"Message Parameter Type\n* `AMT ` - Amount parameter,\n* `DATE` - Date format parameter,\n* `DTTM` - Date/time format parameter,\n* `DUR ` - Duration parameter,\n* `FLD ` - Field name parameter,\n* `MMDD` - Month/Day format parameter,\n* `MSG ` - Message parameter,\n* `NBR ` - Numeric parameter,\n* `SRVC` - Service name parameter,\n* `TBL ` - Table name parameter,\n* `TIME` - Time format parameter","example":"AMT"}}}}}}}}}}}}},"initialCalculation":{"type":"boolean","description":"Initial Calculation","example":"true"},"subUsageToDoIds":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"currentToDoId":{"type":"string","maxLength":14,"description":"To Do ID"}}}}}}},"xml":{"name":"D1UsgTransac"}},"DELETEUSAGETRANSACTION_request":{"type":"object","properties":{"usageTransactionId":{"type":"string","maxLength":14,"description":"Usage Transaction ID is a system assigned random number that stays with a usage transaction record.","example":"05458709929330"}},"xml":{"name":"D1-DelUsgTrn"}},"DELETEUSAGETRANSACTION_response":{"type":"object","properties":{"usageTransactionId":{"type":"string","maxLength":14,"description":"Usage Transaction ID is a system assigned random number that stays with a usage transaction record.","example":"05458709929330"}},"xml":{"name":"D1-DelUsgTrn"}},"CREATEUSAGETRANSACTION_response":{"type":"object","properties":{"_self":{"type":"string","description":"_self"},"usageTransactionId":{"type":"string","maxLength":14,"description":"Usage Transaction ID is a system assigned random number that stays with a usage transaction record.","example":"05458709929330"},"httpMethod":{"type":"string","enum":["DELT","GET ","POST","PTCH","PUT "],"description":"HTTP Method\n* `DELT` - Delete,\n* `GET ` - Get,\n* `POST` - Post,\n* `PTCH` - Patch,\n* `PUT ` - Put","example":"DELT"},"status":{"type":"string","maxLength":12,"description":"Status"},"usageType":{"type":"string","enum":["D2CS","D2IN","D2IS","D2PS","D2SC","D2SF"],"description":"Usage Type flag\n* `D2CS` - Correlated SQ,\n* `D2IN` - Frequently Read,\n* `D2IS` - Frequently Read and Manually Read Scalar,\n* `D2PS` - Profiled SQ,\n* `D2SC` - Manually Read Scalar,\n* `D2SF` - Deprecated - Scalar For Calculation Purposes Only","example":"D2CS"},"usageSubscription":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"usageSubscriptionId":{"type":"string","maxLength":12,"description":"Usage Subscription"}}},"previousUsageTransaction":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"previousUsageTransactionId":{"type":"string","maxLength":14,"description":"Usage Transaction ID"}}},"usageExternalId":{"type":"string","maxLength":60,"description":"An ID used by external systems used to identify the usage transaction .When Oracle Utilities Meter Data Management is integrated with Oracle Utilities Customer Care and Billing, Oracle Utilities Customer Care and Billing can send this to help identify the previous usage transaction."},"startDateTime":{"type":"string","format":"date-time","description":"Defines the start date and time of the usage period.","example":"2013-01-02T00:00:00-08:00"},"endDateTime":{"type":"string","format":"date-time","description":"End Date/Time"},"estimateThroughDate":{"type":"string","format":"date","description":"Estimate Through Date","example":"07-01-2017"},"alignmentDateTime":{"type":"string","format":"date-time","description":"Alignment Date/Time"},"calculationGroup":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"calculationGroup":{"type":"string","maxLength":30,"description":"Calculation Group"}}},"measurementCycle":{"type":"object","description":"Measurement Cycle specifies the schedule used for when the service point is visited and the the device read.","properties":{"_link":{"type":"string","description":"_link"},"measurementCycle":{"type":"string","maxLength":30,"description":"Measurement Cycle specifies the schedule used for when the service point is visited and the the device read."}}},"measurementCycleRoute":{"type":"string","maxLength":30,"description":"Route specifies the group of service points in a cycle that are visited by a meter reader."},"scheduledSelectionDate":{"type":"string","format":"date","description":"Scheduled Selection Date"},"billCondition":{"type":"string","enum":["D2CL","D2IC","D2IL","D2IM"],"description":"The status of the bill associated with the usage transaction (if applicable), used for informational purposes only.\n* `D2CL` - Closing,\n* `D2IC` - Initial and Closing,\n* `D2IL` - Initial,\n* `D2IM` - Interim","example":"D2IL"},"automatedRetry":{"type":"string","enum":["D1NA","D1NO","D1YS"],"description":"A flag that indicates if creation of the usage transaction should be automatically retried in the event of an error.\n* `D1NA` - No - Automatic Discard,\n* `D1NO` - No,\n* `D1YS` - Yes","example":"D1NA"},"nextRetryDateTime":{"type":"string","format":"date-time","description":"Next Retry Date/Time"},"retryUntilDateTime":{"type":"string","format":"date-time","description":"The date time until which the system will attempt to retry creating the usage transaction in the event of an error (applicable only if the Automated Retry flag is set to \"Yes\")."},"subUsageTransactionExist":{"type":"string","enum":["D2NO","D2YS"],"description":"Sub Usage Transactions flag\n* `D2NO` - No,\n* `D2YS` - Yes","example":"D2NO"},"deferCalculation":{"type":"string","enum":["D2NO","D2YS"],"description":"Defer Calculation:\n* `D2NO` - No,\n* `D2YS` - Yes"},"isTraceOn":{"type":"string","enum":["D1NO","D1YS"],"description":"Indicates if tracing is on for the usage transaction.\n* `D1NO` - Off,\n* `D1YS` - On","example":"D1YS"},"skipDetails":{"type":"object","properties":{"skip":{"type":"string","enum":["D2NO","D2YS"],"description":"A flag that indicates if the usage transaction should be skipped.\n* `D2NO` - No,\n* `D2YS` - Yes","example":"D2NO"},"skipReason":{"type":"string","enum":["D2NS"],"description":"Reason for skipping the usage transaction.\n* `D2NS` - No Scheduled Read","example":"D2NS"},"nextScheduledReadDate":{"type":"string","format":"date","description":"The next scheduled read date for the device from which the measurements used to create the usage transaction came."}}},"calculationMode":{"type":"string","enum":["D2HC"],"description":"A flag that indicates the mode in which the usage transaction calculations are/were performed.\n* `D2HC` - Hypothetical Calculation","example":"D2HC"},"usedOnBill":{"type":"string","enum":["D1NO","D1YS"],"description":"This flag indicates (Yes or No) whether or not the usage transaction's service quantities have been used on a completed bill.\n* `D1NO` - No,\n* `D1YS` - Yes","example":"D1YS"},"linkedToFrozenBillSegment":{"type":"string","enum":["D1NO","D1YS"],"description":"This flag indicates (Yes or No) whether or not the usage transaction is linked to a frozen bill segment.\n* `D1NO` - No,\n* `D1YS` - Yes","example":"D1NO"},"usageAdjustmentProfileFactors":{"type":"object","properties":{"profileFactorsList":{"type":"array","items":{"type":"object","properties":{"profileFactor":{"type":"string","maxLength":30,"description":"Factor"},"value":{"type":"string","maxLength":16,"description":"Factor Characteristic Value"}}}}}},"currentToDoId":{"type":"string","maxLength":14,"description":"To Do ID"},"previousToDoId":{"type":"string","maxLength":14,"description":"To Do ID"},"comments":{"type":"string","maxLength":254,"description":"comments"},"requestMode":{"type":"string","enum":["D2BB","D2OB"],"description":"Request\n* `D2BB` - Batch,\n* `D2OB` - Online","example":"D2BB"},"intervalMeasuringComponent":{"type":"object","properties":{"startDateTime":{"type":"string","format":"date-time","description":"Defines the start date and time of the usage period.","example":"2013-01-02T00:00:00-08:00"},"endDateTimeFrom":{"type":"string","format":"date-time","description":"Defines the start date and time for the 'end range' of the usage period.","example":"2013-01-03T00:00:00-08:00"},"endDateTimeTo":{"type":"string","format":"date-time","description":"Defines the end date and time for the 'end range' of the usage period.","example":"2013-01-03T00:00:00-08:00"}}},"scalarMeasuringComponent":{"type":"object","properties":{"startDateTime":{"type":"string","format":"date-time","description":"Defines the start date and time of the usage period.","example":"2013-01-02T00:00:00-08:00"},"estimateTime":{"type":"string","enum":["D1EF","D1ET"],"description":"Estimate Time\n* `D1EF` - End Date Time From,\n* `D1ET` - End Date Time To","example":"D1EF"},"endDateTimeFrom":{"type":"string","format":"date-time","description":"Defines the start date and time for the 'end range' of the usage period.","example":"2013-01-03T00:00:00-08:00"},"endDateTimeTo":{"type":"string","format":"date-time","description":"Defines the end date and time for the 'end range' of the usage period.","example":"2013-01-03T00:00:00-08:00"},"endRangeOption":{"type":"string","enum":["D2SC","D2SP"],"description":"End Range Option indicates the end range option. Valid values include \"Specified\" and \"Derive Using Service Cycle Schedule\"\n* `D2SC` - Derive Using Service Cycle Schedule,\n* `D2SP` - Specified","example":"D2SC"},"minDaysOffset":{"type":"number","maximum":999,"minimum":-999,"description":"Minimum Offset Days / Maximum Offset Days  are used when End Range Option is set to \"Dervice Using Service Cycle Schedule\", these values define a range of days for the end date of the usage transaction, based on the Service Cycle Schedule date."},"maxDaysOffset":{"type":"number","maximum":999,"minimum":-999,"description":"Minimum Offset Days / Maximum Offset Days  are used when End Range Option is set to \"Dervice Using Service Cycle Schedule\", these values define a range of days for the end date of the usage transaction, based on the Service Cycle Schedule date."},"allowEstimate":{"type":"string","enum":["D2AE","D2DE"],"description":"Allow Estimate indicates whether or not to allow use of estimated measurement data when calculating usage.\n* `D2AE` - Allow Estimates,\n* `D2DE` - Do Not Allow Estimates","example":"D2AE"},"estimateDate":{"type":"string","format":"date","description":"Estimate Date indicates the date on which estimated measurement data used in the usage calculation was estimated."},"isEstimate":{"type":"string","enum":["D2NO","D2YS"],"description":"Is Estimate indicates if estimated measurement data was used in the usage calculation.\n* `D2NO` - No,\n* `D2YS` - Yes","example":"D2NO"}}},"dateBreaks":{"type":"object","properties":{"dateBreaksList":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"dateBreak":{"type":"string","format":"date","description":"Date breaks are used to break up a usage period into sub-periods based on the dates on which rate changes took place for the usage transaction (and its related account)."}}}}}}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks.","example":"2"},"usagePeriods":{"type":"object","properties":{"usagePeriodsList":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"sequence":{"type":"number","maximum":999,"minimum":-999,"description":"Period Sequence Number"},"startDateTime":{"type":"string","format":"date-time","description":"Defines the start date and time of the usage period.","example":"2013-01-02T00:00:00-08:00"},"endDateTime":{"type":"string","format":"date-time","description":"End Date/Time"},"usageType":{"type":"string","enum":["D2CS","D2IN","D2IS","D2PS","D2SC","D2SF"],"description":"Usage Type flag\n* `D2CS` - Correlated SQ,\n* `D2IN` - Frequently Read,\n* `D2IS` - Frequently Read and Manually Read Scalar,\n* `D2PS` - Profiled SQ,\n* `D2SC` - Manually Read Scalar,\n* `D2SF` - Deprecated - Scalar For Calculation Purposes Only","example":"D2CS"},"serviceQuantities":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"sqSequence":{"type":"number","maximum":99999,"minimum":-99999,"description":"Service Quantity Sequence"},"sqType":{"type":"string","enum":["D1FC","D1IT","D1MC","D1OT","D1PK","D1SU"],"description":"Usage Service Quantity Type\n* `D1FC` - Factor,\n* `D1IT` - Item,\n* `D1MC` - Measuring Component,\n* `D1OT` - Other,\n* `D1PK` - Peak Across Usage Periods,\n* `D1SU` - Summation","example":"D1FC"},"uom":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"uom":{"type":"string","maxLength":30,"description":"Unit of Measure"}}},"tou":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"tou":{"type":"string","maxLength":30,"description":"Time of Use"}}},"sqi":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"sqi":{"type":"string","maxLength":30,"description":"Service Quantity Identifier"}}},"quantity":{"type":"number","maximum":9999999999.999998,"minimum":-9999999999.999998,"description":"Quantity","example":"9.840000"},"servicePoint":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"servicePointId":{"type":"string","maxLength":12,"description":"Service Point ID"}}},"measuringComponent":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"measuringComponentId":{"type":"string","maxLength":12,"description":"Measuring Component ID"}}},"touMap":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"touMap":{"type":"string","maxLength":12,"description":"TOU Map"}}},"factor":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"factor":{"type":"string","maxLength":30,"description":"Factor"}}},"characteristicType":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"characteristicType":{"type":"string","maxLength":8,"description":"Characteristic Type"}}},"characteristicValue":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"characteristicValue":{"type":"string","maxLength":16,"description":"Characteristic Value"}}},"calculationGroup":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"calculationGroup":{"type":"string","maxLength":30,"description":"Calculation Group"}}},"calculationRule":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"calculationRule":{"type":"string","maxLength":30,"description":"Calculation Rule"}}},"intervalData":{"type":"string","enum":["D1EX","D1NE"],"description":"Interval Data:\n* `D1EX` - Exist,\n* `D1NE` - Does Not Exist"},"secondsPerInterval":{"type":"integer","description":"Interval Size"},"estimationIndicator":{"type":"string","enum":["D2ES","D2NE"],"description":"Estimation Indicator\n* `D2ES` - Estimated,\n* `D2NE` - Not Estimated"},"shouldExtractIntervalData":{"type":"string","enum":["D1NO","D1YS"],"description":"Extract Interval Data:\n* `D1NO` - No,\n* `D1YS` - Yes"}}}}}},"itemDetail":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"itemDetailsSeq":{"type":"number","maximum":99999,"minimum":0,"description":"Item Detail Sequence"},"badgedItem":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"badgedItemId":{"type":"string","maxLength":12,"description":"Device ID"}}},"itemType":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"itemType":{"type":"string","maxLength":30,"description":"Device Type"}}},"itemCount":{"type":"number","maximum":999999999.99,"minimum":-999999999.99,"description":"Item Count"},"startDateTime":{"type":"string","format":"date-time","description":"Defines the start date and time of the usage period.","example":"2013-01-02T00:00:00-08:00"},"endDateTime":{"type":"string","format":"date-time","description":"End Date/Time"},"quantity":{"type":"number","maximum":9999999999.999998,"minimum":-9999999999.999998,"description":"Quantity","example":"9.840000"},"uom":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"uom":{"type":"string","maxLength":30,"description":"Unit of Measure"}}},"servicePoint":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"servicePointId":{"type":"string","maxLength":12,"description":"Service Point ID"}}},"overrideQuantity":{"type":"string","enum":["D1OP"],"description":"Override Quantity flag\n* `D1OP` - Override Quantity Present","example":"D1OP"},"calculationGroup":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"calculationGroup":{"type":"string","maxLength":30,"description":"Calculation Group"}}},"usageRule":{"type":"string","maxLength":30,"description":"Usage calculation rules are standard and custom rules that perform calculations on measurement data to generate bill determinants.","example":"ZZS-MRULGRP-SCALAR-RULE"}}}}}},"sqsEstimationIndicators":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"uom":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"uom":{"type":"string","maxLength":30,"description":"Unit of Measure"}}},"tou":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"tou":{"type":"string","maxLength":30,"description":"Time of Use"}}},"sqi":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"sqi":{"type":"string","maxLength":30,"description":"Service Quantity Identifier"}}},"estimationIndicator":{"type":"string","enum":["D2ES","D2NE"],"description":"Estimation Indicator\n* `D2ES` - Estimated,\n* `D2NE` - Not Estimated"}}}}}}}}}}}}},"usageTransactionReadingDetails":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"servicePoint":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"servicePointId":{"type":"string","maxLength":12,"description":"Service Point ID"}}},"sequence":{"type":"number","maximum":999,"minimum":-999,"description":"Sequence"},"uom":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"uom":{"type":"string","maxLength":30,"description":"Unit of Measure"}}},"tou":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"tou":{"type":"string","maxLength":30,"description":"Time of Use"}}},"sqi":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"sqi":{"type":"string","maxLength":30,"description":"Service Quantity Identifier"}}},"measuringComponentId":{"type":"string","maxLength":12,"description":"Measuring Component ID","example":"658852900520"},"startDateTime":{"type":"string","format":"date-time","description":"Defines the start date and time of the usage period.","example":"2013-01-02T00:00:00-08:00"},"startMeasurement":{"type":"number","maximum":9999999999.999998,"minimum":-9999999999.999998,"description":"Start Measurement","example":"0.000000"},"startMeasurementCondition":{"type":"string","enum":["102000","ZZ-test-mark1","100000","901000","ZZBUG","402000","201000","ZZ-500001","501000","ZZ-301024","ZZ-301022","101500","ZZ-301501","ZZ-401000","ZZ-301515","ZZ-301514","ZZ-301513","101000","409000","401000","zz-test3","ZZ-TestBug","zz-test5","ZZ-301031","ZZ-301491","100500","ZZ-301511","ZZ-TEST-AGAIN","301000","ZZ_Test211"],"description":"Start Measurement Condition\n* `102000` - No Read - Disconnected,\n* `ZZ-test-mark1` - zz-test-mark1,\n* `100000` - No Read - System,\n* `901000` - Super,\n* `ZZBUG` - Override description,\n* `402000` - Office Estimate,\n* `201000` - Missing,\n* `ZZ-500001` - Prorated,\n* `501000` - Regular,\n* `ZZ-301024` - ZZ Estimate - Interval Interpolation,\n* `ZZ-301022` - ZZ Estimate - Interval Averaging,\n* `101500` - No Read - Outage Fill,\n* `ZZ-301501` - ZZ Scalar Calculation from Estimated Interval Read,\n* `ZZ-401000` - ZZ-External Estimate,\n* `ZZ-301515` - ZZ Prorated - Scalar Proration from Regular Read,\n* `ZZ-301514` - ZZ Prorated - Scalar Adjustment from Regular Interval,\n* `ZZ-301513` - ZZ Prorated - Interval Adjustment from Regular Scalar,\n* `101000` - No Read - Outage,\n* `409000` - Combined Quantity,\n* `401000` - External Estimate,\n* `zz-test3` - Override description,\n* `ZZ-TestBug` - ZZ-TestBug-Override description,\n* `zz-test5` - zz test 5,\n* `ZZ-301031` - ZZ Estimate - Int Adj From Scalar,\n* `ZZ-301491` - ZZ Estimate - Scalar Estimation,\n* `100500` - No Read - Field,\n* `ZZ-301511` - ZZ Scalar Proration from Estimation Read,\n* `ZZ-TEST-AGAIN` - ZZ-TEST ONLY,\n* `301000` - System Estimate,\n* `ZZ_Test211` - ZZ_Test211-UPD","example":"501000"},"endDateTime":{"type":"string","format":"date-time","description":"End Date/Time"},"endMeasurement":{"type":"number","maximum":9999999999.999998,"minimum":-9999999999.999998,"description":"End Measurement","example":"0.080000"},"endMeasurementCondition":{"type":"string","enum":["102000","ZZ-test-mark1","100000","901000","ZZBUG","402000","201000","ZZ-500001","501000","ZZ-301024","ZZ-301022","101500","ZZ-301501","ZZ-401000","ZZ-301515","ZZ-301514","ZZ-301513","101000","409000","401000","zz-test3","ZZ-TestBug","zz-test5","ZZ-301031","ZZ-301491","100500","ZZ-301511","ZZ-TEST-AGAIN","301000","ZZ_Test211"],"description":"Condition:\n* `102000` - No Read - Disconnected,\n* `ZZ-test-mark1` - zz-test-mark1,\n* `100000` - No Read - System,\n* `901000` - Super,\n* `ZZBUG` - Override description,\n* `402000` - Office Estimate,\n* `201000` - Missing,\n* `ZZ-500001` - Prorated,\n* `501000` - Regular,\n* `ZZ-301024` - ZZ Estimate - Interval Interpolation,\n* `ZZ-301022` - ZZ Estimate - Interval Averaging,\n* `101500` - No Read - Outage Fill,\n* `ZZ-301501` - ZZ Scalar Calculation from Estimated Interval Read,\n* `ZZ-401000` - ZZ-External Estimate,\n* `ZZ-301515` - ZZ Prorated - Scalar Proration from Regular Read,\n* `ZZ-301514` - ZZ Prorated - Scalar Adjustment from Regular Interval,\n* `ZZ-301513` - ZZ Prorated - Interval Adjustment from Regular Scalar,\n* `101000` - No Read - Outage,\n* `409000` - Combined Quantity,\n* `401000` - External Estimate,\n* `zz-test3` - Override description,\n* `ZZ-TestBug` - ZZ-TestBug-Override description,\n* `zz-test5` - zz test 5,\n* `ZZ-301031` - ZZ Estimate - Int Adj From Scalar,\n* `ZZ-301491` - ZZ Estimate - Scalar Estimation,\n* `100500` - No Read - Field,\n* `ZZ-301511` - ZZ Scalar Proration from Estimation Read,\n* `ZZ-TEST-AGAIN` - ZZ-TEST ONLY,\n* `301000` - System Estimate,\n* `ZZ_Test211` - ZZ_Test211-UPD"},"quantity":{"type":"number","maximum":9999999999.999998,"minimum":-9999999999.999998,"description":"Quantity","example":"9.840000"},"finalUom":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"finalUom":{"type":"string","maxLength":30,"description":"Final UOM"}}},"finalTou":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"finalTou":{"type":"string","maxLength":30,"description":"Final TOU"}}},"finalSqi":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"finalSqi":{"type":"string","maxLength":30,"description":"Final SQI"}}},"finalQuantity":{"type":"number","maximum":9999999999.999998,"minimum":-9999999999.999998,"description":"Final Quantity","example":"9.840000"},"spHowToUse":{"type":"string","enum":["D1AD","D1CK","D1ST"],"description":"Usage:\n* `D1AD` - Add,\n* `D1CK` - Exclude,\n* `D1ST` - Subtract"},"mcHowToUse":{"type":"string","enum":["+   ","-   ","C   ","P   "],"description":"How To Use\n* `+   ` - Additive,\n* `-   ` - Subtractive,\n* `C   ` - Check,\n* `P   ` - Peak","example":"P"},"measuresPeakQuantity":{"type":"string","enum":["D1DP","D1MP"],"description":"Measures Peak Quantity\n* `D1DP` - No,\n* `D1MP` - Yes","example":"D1DP"},"appliedMultiplier":{"type":"number","maximum":1000000000000,"minimum":-1000000000000,"description":"Applied Multiplier","example":"123.000000"},"usePercent":{"type":"number","maximum":999,"minimum":-999,"description":"Use percent","example":"100"},"calculationGroup":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"calculationGroup":{"type":"string","maxLength":30,"description":"Calculation Group"}}},"usageRule":{"type":"string","maxLength":30,"description":"Usage calculation rules are standard and custom rules that perform calculations on measurement data to generate bill determinants.","example":"ZZS-MRULGRP-SCALAR-RULE"}}}}}},"subUsageTransactions":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"subUsageTransactionId":{"type":"string","description":"(subUsageTransactionId)"},"startDateTime":{"type":"string","format":"date-time","description":"(startDateTime)"},"endDateTime":{"type":"string","format":"date-time","description":"(endDateTime)"},"calculationGroup":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"calculationGroup":{"type":"string","maxLength":30,"description":"Calculation Group"}}}}}}}},"characteristics":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"characteristicType":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"characteristicType":{"type":"string","maxLength":8,"description":"Characteristic Type"}}},"characteristicValue":{"type":"string","maxLength":16,"description":"Characteristic Value Indicate the value of the characteristic.","example":"ADV"},"effectiveDate":{"type":"string","format":"date","description":"Effective Date Indicate the effective date of the characteristic type and value. The service point's install date defaults."},"adhocCharacteristicValue":{"type":"string","maxLength":254,"description":"Ad hoc Characteristics Value do not have their valid values defined in a discreet list because the possible values are infinite.","example":"77"},"characteristicValueForeignKey":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"id":{"type":"string","description":"(characteristicValueForeignKey1)"}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks.","example":"2"}}}}}},"serviceQuantitiesData":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"periodSequenceNumber":{"type":"number","maximum":999,"minimum":-999,"description":"Period Sequence Number"},"quantity":{"type":"number","maximum":9999999999.999998,"minimum":-9999999999.999998,"description":"Quantity","example":"9.840000"},"serviceQuantityDataDateTime":{"type":"string","format":"date-time","description":"Service Quantity Data Date/Time"},"serviceQuantityIntervalCondition":{"type":"string","maxLength":254,"description":"Service Quantity  Interval Condition"},"serviceQuantitySequenceNumber":{"type":"number","maximum":99999,"minimum":-99999,"description":"Service Quantity Sequence"}}}}}},"nextActions":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"_link":{"type":"string","description":"(_link)"},"actionName":{"type":"string","description":"(actionName)"}}}}}},"exceptions":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"sequence":{"type":"number","maximum":99999,"minimum":-99999,"description":"Sequence"},"usageGroup":{"type":"string","maxLength":30,"description":"Usage group used to calculate usage transactions (e.g., bill determinants)","example":"ZZS-MRULEGRP-SCALAR-ITEM"},"usageRule":{"type":"string","maxLength":30,"description":"Usage calculation rules are standard and custom rules that perform calculations on measurement data to generate bill determinants.","example":"ZZS-MRULGRP-SCALAR-RULE"},"exceptionType":{"type":"string","maxLength":30,"description":"Exception Type"},"exceptionSeverity":{"type":"string","enum":["D1IF","D1IS","D1TM"],"description":"Exception Severity\n* `D1IF` - Information,\n* `D1IS` - Issues,\n* `D1TM` - Terminate","example":"D1IF"},"exceptionRequiresApproval":{"type":"string","enum":["D1NO","D1YS"],"description":"Exception Requires Approval flag\n* `D1NO` - No,\n* `D1YS` - Yes","example":"D1NO"},"toDoType":{"type":"string","maxLength":8,"description":"To Do Type"},"toDoRole":{"type":"string","maxLength":10,"description":"To Do Role"},"messageCategory":{"type":"number","maximum":99999,"minimum":-99999,"description":"Message category within Oracle Utilities Application Framework."},"messageNumber":{"type":"number","maximum":99999,"minimum":-99999,"description":"Message Number within Oracle Utilities Application Framework."},"messageParameters":{"type":"object","properties":{"messageParametersList":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"sequence":{"type":"number","maximum":999,"minimum":-999,"description":"Message Parameter Sequence"},"parameter":{"type":"string","maxLength":2000,"description":"Message Parameter Value"},"parameterType":{"type":"string","enum":["AMT ","DATE","DTTM","DUR ","FLD ","MMDD","MSG ","NBR ","SRVC","TBL ","TIME"],"description":"Message Parameter Type\n* `AMT ` - Amount parameter,\n* `DATE` - Date format parameter,\n* `DTTM` - Date/time format parameter,\n* `DUR ` - Duration parameter,\n* `FLD ` - Field name parameter,\n* `MMDD` - Month/Day format parameter,\n* `MSG ` - Message parameter,\n* `NBR ` - Numeric parameter,\n* `SRVC` - Service name parameter,\n* `TBL ` - Table name parameter,\n* `TIME` - Time format parameter","example":"AMT"}}}}}}}}}}}}},"traces":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"sequence":{"type":"number","maximum":99999,"minimum":-99999,"description":"Sequence"},"usageGroup":{"type":"string","maxLength":30,"description":"Usage group used to calculate usage transactions (e.g., bill determinants)","example":"ZZS-MRULEGRP-SCALAR-ITEM"},"usageRule":{"type":"string","maxLength":30,"description":"Usage calculation rules are standard and custom rules that perform calculations on measurement data to generate bill determinants.","example":"ZZS-MRULGRP-SCALAR-RULE"},"criteriaSequence":{"type":"number","maximum":999,"minimum":-999,"description":"Sequence"},"duration":{"type":"number","maximum":9999999999,"minimum":-9999999999,"description":"Duration"},"messageCategory":{"type":"number","maximum":99999,"minimum":-99999,"description":"Message category within Oracle Utilities Application Framework."},"messageNumber":{"type":"number","maximum":99999,"minimum":-99999,"description":"Message Number within Oracle Utilities Application Framework."},"messageParameters":{"type":"object","properties":{"messageParametersList":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"sequence":{"type":"number","maximum":999,"minimum":-999,"description":"Message Parameter Sequence"},"parameter":{"type":"string","maxLength":2000,"description":"Message Parameter Value"},"parameterType":{"type":"string","enum":["AMT ","DATE","DTTM","DUR ","FLD ","MMDD","MSG ","NBR ","SRVC","TBL ","TIME"],"description":"Message Parameter Type\n* `AMT ` - Amount parameter,\n* `DATE` - Date format parameter,\n* `DTTM` - Date/time format parameter,\n* `DUR ` - Duration parameter,\n* `FLD ` - Field name parameter,\n* `MMDD` - Month/Day format parameter,\n* `MSG ` - Message parameter,\n* `NBR ` - Numeric parameter,\n* `SRVC` - Service name parameter,\n* `TBL ` - Table name parameter,\n* `TIME` - Time format parameter","example":"AMT"}}}}}}}}}}}}},"initialCalculation":{"type":"boolean","description":"Initial Calculation","example":"true"},"subUsageToDoIds":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"currentToDoId":{"type":"string","maxLength":14,"description":"To Do ID"}}}}}}},"xml":{"name":"D1UsgTransac"}},"ACTIONUSAGETRANSACTION_request":{"type":"object","properties":{"usageTransactionId":{"type":"string","maxLength":14,"description":"Usage Transaction ID is a system assigned random number that stays with a usage transaction record.","example":"05458709929330"},"name":{"type":"string","description":"(name)"},"statusReason":{"type":"string","maxLength":30,"description":"Status Reason"},"nextActions":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"_link":{"type":"string","description":"(_link)"},"actionName":{"type":"string","description":"(actionName)"}}}}}}},"xml":{"name":"D1-PthUsgTrn"}},"ACTIONUSAGETRANSACTION_response":{"type":"object","properties":{"_self":{"type":"string","description":"_self"},"usageTransactionId":{"type":"string","maxLength":14,"description":"Usage Transaction ID is a system assigned random number that stays with a usage transaction record.","example":"05458709929330"},"name":{"type":"string","description":"(name)"},"statusReason":{"type":"string","maxLength":30,"description":"Status Reason"},"nextActions":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"_link":{"type":"string","description":"(_link)"},"actionName":{"type":"string","description":"(actionName)"}}}}}}},"xml":{"name":"D1-PthUsgTrn"}},"UPDATEUSAGETRANSACTION_request":{"type":"object","properties":{"usageTransactionId":{"type":"string","maxLength":14,"description":"Usage Transaction ID is a system assigned random number that stays with a usage transaction record.","example":"05458709929330"},"httpMethod":{"type":"string","enum":["DELT","GET ","POST","PTCH","PUT "],"description":"HTTP Method\n* `DELT` - Delete,\n* `GET ` - Get,\n* `POST` - Post,\n* `PTCH` - Patch,\n* `PUT ` - Put","example":"DELT"},"status":{"type":"string","maxLength":12,"description":"Status"},"usageType":{"type":"string","enum":["D2CS","D2IN","D2IS","D2PS","D2SC","D2SF"],"description":"Usage Type flag\n* `D2CS` - Correlated SQ,\n* `D2IN` - Frequently Read,\n* `D2IS` - Frequently Read and Manually Read Scalar,\n* `D2PS` - Profiled SQ,\n* `D2SC` - Manually Read Scalar,\n* `D2SF` - Deprecated - Scalar For Calculation Purposes Only","example":"D2CS"},"usageSubscription":{"type":"object","properties":{"usageSubscriptionId":{"type":"string","maxLength":12,"description":"Usage Subscription"}}},"previousUsageTransaction":{"type":"object","properties":{"previousUsageTransactionId":{"type":"string","maxLength":14,"description":"Usage Transaction ID"}}},"usageExternalId":{"type":"string","maxLength":60,"description":"An ID used by external systems used to identify the usage transaction .When Oracle Utilities Meter Data Management is integrated with Oracle Utilities Customer Care and Billing, Oracle Utilities Customer Care and Billing can send this to help identify the previous usage transaction."},"startDateTime":{"type":"string","format":"date-time","description":"Defines the start date and time of the usage period.","example":"2013-01-02T00:00:00-08:00"},"endDateTime":{"type":"string","format":"date-time","description":"End Date/Time"},"estimateThroughDate":{"type":"string","format":"date","description":"Estimate Through Date","example":"07-01-2017"},"alignmentDateTime":{"type":"string","format":"date-time","description":"Alignment Date/Time"},"calculationGroup":{"type":"object","properties":{"calculationGroup":{"type":"string","maxLength":30,"description":"Calculation Group"}}},"measurementCycle":{"type":"object","description":"Measurement Cycle specifies the schedule used for when the service point is visited and the the device read.","properties":{"measurementCycle":{"type":"string","maxLength":30,"description":"Measurement Cycle specifies the schedule used for when the service point is visited and the the device read."}}},"measurementCycleRoute":{"type":"string","maxLength":30,"description":"Route specifies the group of service points in a cycle that are visited by a meter reader."},"scheduledSelectionDate":{"type":"string","format":"date","description":"Scheduled Selection Date"},"billCondition":{"type":"string","enum":["D2CL","D2IC","D2IL","D2IM"],"description":"The status of the bill associated with the usage transaction (if applicable), used for informational purposes only.\n* `D2CL` - Closing,\n* `D2IC` - Initial and Closing,\n* `D2IL` - Initial,\n* `D2IM` - Interim","example":"D2IL"},"automatedRetry":{"type":"string","enum":["D1NA","D1NO","D1YS"],"description":"A flag that indicates if creation of the usage transaction should be automatically retried in the event of an error.\n* `D1NA` - No - Automatic Discard,\n* `D1NO` - No,\n* `D1YS` - Yes","example":"D1NA"},"nextRetryDateTime":{"type":"string","format":"date-time","description":"Next Retry Date/Time"},"retryUntilDateTime":{"type":"string","format":"date-time","description":"The date time until which the system will attempt to retry creating the usage transaction in the event of an error (applicable only if the Automated Retry flag is set to \"Yes\")."},"subUsageTransactionExist":{"type":"string","enum":["D2NO","D2YS"],"description":"Sub Usage Transactions flag\n* `D2NO` - No,\n* `D2YS` - Yes","example":"D2NO"},"deferCalculation":{"type":"string","enum":["D2NO","D2YS"],"description":"Defer Calculation:\n* `D2NO` - No,\n* `D2YS` - Yes"},"isTraceOn":{"type":"string","enum":["D1NO","D1YS"],"description":"Indicates if tracing is on for the usage transaction.\n* `D1NO` - Off,\n* `D1YS` - On","example":"D1YS"},"skipDetails":{"type":"object","properties":{"skip":{"type":"string","enum":["D2NO","D2YS"],"description":"A flag that indicates if the usage transaction should be skipped.\n* `D2NO` - No,\n* `D2YS` - Yes","example":"D2NO"},"skipReason":{"type":"string","enum":["D2NS"],"description":"Reason for skipping the usage transaction.\n* `D2NS` - No Scheduled Read","example":"D2NS"},"nextScheduledReadDate":{"type":"string","format":"date","description":"The next scheduled read date for the device from which the measurements used to create the usage transaction came."}}},"calculationMode":{"type":"string","enum":["D2HC"],"description":"A flag that indicates the mode in which the usage transaction calculations are/were performed.\n* `D2HC` - Hypothetical Calculation","example":"D2HC"},"usedOnBill":{"type":"string","enum":["D1NO","D1YS"],"description":"This flag indicates (Yes or No) whether or not the usage transaction's service quantities have been used on a completed bill.\n* `D1NO` - No,\n* `D1YS` - Yes","example":"D1YS"},"linkedToFrozenBillSegment":{"type":"string","enum":["D1NO","D1YS"],"description":"This flag indicates (Yes or No) whether or not the usage transaction is linked to a frozen bill segment.\n* `D1NO` - No,\n* `D1YS` - Yes","example":"D1NO"},"usageAdjustmentProfileFactors":{"type":"object","properties":{"profileFactorsList":{"type":"array","items":{"type":"object","properties":{"profileFactor":{"type":"string","maxLength":30,"description":"Factor"},"value":{"type":"string","maxLength":16,"description":"Factor Characteristic Value"}}}}}},"currentToDoId":{"type":"string","maxLength":14,"description":"To Do ID"},"previousToDoId":{"type":"string","maxLength":14,"description":"To Do ID"},"comments":{"type":"string","maxLength":254,"description":"comments"},"requestMode":{"type":"string","enum":["D2BB","D2OB"],"description":"Request\n* `D2BB` - Batch,\n* `D2OB` - Online","example":"D2BB"},"intervalMeasuringComponent":{"type":"object","properties":{"startDateTime":{"type":"string","format":"date-time","description":"Defines the start date and time of the usage period.","example":"2013-01-02T00:00:00-08:00"},"endDateTimeFrom":{"type":"string","format":"date-time","description":"Defines the start date and time for the 'end range' of the usage period.","example":"2013-01-03T00:00:00-08:00"},"endDateTimeTo":{"type":"string","format":"date-time","description":"Defines the end date and time for the 'end range' of the usage period.","example":"2013-01-03T00:00:00-08:00"}}},"scalarMeasuringComponent":{"type":"object","properties":{"startDateTime":{"type":"string","format":"date-time","description":"Defines the start date and time of the usage period.","example":"2013-01-02T00:00:00-08:00"},"estimateTime":{"type":"string","enum":["D1EF","D1ET"],"description":"Estimate Time\n* `D1EF` - End Date Time From,\n* `D1ET` - End Date Time To","example":"D1EF"},"endDateTimeFrom":{"type":"string","format":"date-time","description":"Defines the start date and time for the 'end range' of the usage period.","example":"2013-01-03T00:00:00-08:00"},"endDateTimeTo":{"type":"string","format":"date-time","description":"Defines the end date and time for the 'end range' of the usage period.","example":"2013-01-03T00:00:00-08:00"},"endRangeOption":{"type":"string","enum":["D2SC","D2SP"],"description":"End Range Option indicates the end range option. Valid values include \"Specified\" and \"Derive Using Service Cycle Schedule\"\n* `D2SC` - Derive Using Service Cycle Schedule,\n* `D2SP` - Specified","example":"D2SC"},"minDaysOffset":{"type":"number","maximum":999,"minimum":-999,"description":"Minimum Offset Days / Maximum Offset Days  are used when End Range Option is set to \"Dervice Using Service Cycle Schedule\", these values define a range of days for the end date of the usage transaction, based on the Service Cycle Schedule date."},"maxDaysOffset":{"type":"number","maximum":999,"minimum":-999,"description":"Minimum Offset Days / Maximum Offset Days  are used when End Range Option is set to \"Dervice Using Service Cycle Schedule\", these values define a range of days for the end date of the usage transaction, based on the Service Cycle Schedule date."},"allowEstimate":{"type":"string","enum":["D2AE","D2DE"],"description":"Allow Estimate indicates whether or not to allow use of estimated measurement data when calculating usage.\n* `D2AE` - Allow Estimates,\n* `D2DE` - Do Not Allow Estimates","example":"D2AE"},"estimateDate":{"type":"string","format":"date","description":"Estimate Date indicates the date on which estimated measurement data used in the usage calculation was estimated."},"isEstimate":{"type":"string","enum":["D2NO","D2YS"],"description":"Is Estimate indicates if estimated measurement data was used in the usage calculation.\n* `D2NO` - No,\n* `D2YS` - Yes","example":"D2NO"}}},"dateBreaks":{"type":"object","properties":{"dateBreaksList":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"dateBreak":{"type":"string","format":"date","description":"Date breaks are used to break up a usage period into sub-periods based on the dates on which rate changes took place for the usage transaction (and its related account)."}}}}}}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks.","example":"2"},"usagePeriods":{"type":"object","properties":{"usagePeriodsList":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"sequence":{"type":"number","maximum":999,"minimum":-999,"description":"Period Sequence Number"},"startDateTime":{"type":"string","format":"date-time","description":"Defines the start date and time of the usage period.","example":"2013-01-02T00:00:00-08:00"},"endDateTime":{"type":"string","format":"date-time","description":"End Date/Time"},"usageType":{"type":"string","enum":["D2CS","D2IN","D2IS","D2PS","D2SC","D2SF"],"description":"Usage Type flag\n* `D2CS` - Correlated SQ,\n* `D2IN` - Frequently Read,\n* `D2IS` - Frequently Read and Manually Read Scalar,\n* `D2PS` - Profiled SQ,\n* `D2SC` - Manually Read Scalar,\n* `D2SF` - Deprecated - Scalar For Calculation Purposes Only","example":"D2CS"},"serviceQuantities":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"sqSequence":{"type":"number","maximum":99999,"minimum":-99999,"description":"Service Quantity Sequence"},"sqType":{"type":"string","enum":["D1FC","D1IT","D1MC","D1OT","D1PK","D1SU"],"description":"Usage Service Quantity Type\n* `D1FC` - Factor,\n* `D1IT` - Item,\n* `D1MC` - Measuring Component,\n* `D1OT` - Other,\n* `D1PK` - Peak Across Usage Periods,\n* `D1SU` - Summation","example":"D1FC"},"uom":{"type":"object","properties":{"uom":{"type":"string","maxLength":30,"description":"Unit of Measure"}}},"tou":{"type":"object","properties":{"tou":{"type":"string","maxLength":30,"description":"Time of Use"}}},"sqi":{"type":"object","properties":{"sqi":{"type":"string","maxLength":30,"description":"Service Quantity Identifier"}}},"quantity":{"type":"number","maximum":9999999999.999998,"minimum":-9999999999.999998,"description":"Quantity","example":"9.840000"},"servicePoint":{"type":"object","properties":{"servicePointId":{"type":"string","maxLength":12,"description":"Service Point ID"}}},"measuringComponent":{"type":"object","properties":{"measuringComponentId":{"type":"string","maxLength":12,"description":"Measuring Component ID"}}},"touMap":{"type":"object","properties":{"touMap":{"type":"string","maxLength":12,"description":"TOU Map"}}},"factor":{"type":"object","properties":{"factor":{"type":"string","maxLength":30,"description":"Factor"}}},"characteristicType":{"type":"object","properties":{"characteristicType":{"type":"string","maxLength":8,"description":"Characteristic Type"}}},"characteristicValue":{"type":"object","properties":{"characteristicValue":{"type":"string","maxLength":16,"description":"Characteristic Value"}}},"calculationGroup":{"type":"object","properties":{"calculationGroup":{"type":"string","maxLength":30,"description":"Calculation Group"}}},"calculationRule":{"type":"object","properties":{"calculationRule":{"type":"string","maxLength":30,"description":"Calculation Rule"}}},"intervalData":{"type":"string","enum":["D1EX","D1NE"],"description":"Interval Data:\n* `D1EX` - Exist,\n* `D1NE` - Does Not Exist"},"secondsPerInterval":{"type":"integer","description":"Interval Size"},"estimationIndicator":{"type":"string","enum":["D2ES","D2NE"],"description":"Estimation Indicator\n* `D2ES` - Estimated,\n* `D2NE` - Not Estimated"},"shouldExtractIntervalData":{"type":"string","enum":["D1NO","D1YS"],"description":"Extract Interval Data:\n* `D1NO` - No,\n* `D1YS` - Yes"}}}}}},"itemDetail":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"itemDetailsSeq":{"type":"number","maximum":99999,"minimum":0,"description":"Item Detail Sequence"},"badgedItem":{"type":"object","properties":{"badgedItemId":{"type":"string","maxLength":12,"description":"Device ID"}}},"itemType":{"type":"object","properties":{"itemType":{"type":"string","maxLength":30,"description":"Device Type"}}},"itemCount":{"type":"number","maximum":999999999.99,"minimum":-999999999.99,"description":"Item Count"},"startDateTime":{"type":"string","format":"date-time","description":"Defines the start date and time of the usage period.","example":"2013-01-02T00:00:00-08:00"},"endDateTime":{"type":"string","format":"date-time","description":"End Date/Time"},"quantity":{"type":"number","maximum":9999999999.999998,"minimum":-9999999999.999998,"description":"Quantity","example":"9.840000"},"uom":{"type":"object","properties":{"uom":{"type":"string","maxLength":30,"description":"Unit of Measure"}}},"servicePoint":{"type":"object","properties":{"servicePointId":{"type":"string","maxLength":12,"description":"Service Point ID"}}},"overrideQuantity":{"type":"string","enum":["D1OP"],"description":"Override Quantity flag\n* `D1OP` - Override Quantity Present","example":"D1OP"},"calculationGroup":{"type":"object","properties":{"calculationGroup":{"type":"string","maxLength":30,"description":"Calculation Group"}}},"usageRule":{"type":"string","maxLength":30,"description":"Usage calculation rules are standard and custom rules that perform calculations on measurement data to generate bill determinants.","example":"ZZS-MRULGRP-SCALAR-RULE"}}}}}},"sqsEstimationIndicators":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"uom":{"type":"object","properties":{"uom":{"type":"string","maxLength":30,"description":"Unit of Measure"}}},"tou":{"type":"object","properties":{"tou":{"type":"string","maxLength":30,"description":"Time of Use"}}},"sqi":{"type":"object","properties":{"sqi":{"type":"string","maxLength":30,"description":"Service Quantity Identifier"}}},"estimationIndicator":{"type":"string","enum":["D2ES","D2NE"],"description":"Estimation Indicator\n* `D2ES` - Estimated,\n* `D2NE` - Not Estimated"}}}}}}}}}}}}},"usageTransactionReadingDetails":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"servicePoint":{"type":"object","properties":{"servicePointId":{"type":"string","maxLength":12,"description":"Service Point ID"}}},"sequence":{"type":"number","maximum":999,"minimum":-999,"description":"Sequence"},"uom":{"type":"object","properties":{"uom":{"type":"string","maxLength":30,"description":"Unit of Measure"}}},"tou":{"type":"object","properties":{"tou":{"type":"string","maxLength":30,"description":"Time of Use"}}},"sqi":{"type":"object","properties":{"sqi":{"type":"string","maxLength":30,"description":"Service Quantity Identifier"}}},"measuringComponentId":{"type":"string","maxLength":12,"description":"Measuring Component ID","example":"658852900520"},"startDateTime":{"type":"string","format":"date-time","description":"Defines the start date and time of the usage period.","example":"2013-01-02T00:00:00-08:00"},"startMeasurement":{"type":"number","maximum":9999999999.999998,"minimum":-9999999999.999998,"description":"Start Measurement","example":"0.000000"},"startMeasurementCondition":{"type":"string","enum":["102000","ZZ-test-mark1","100000","901000","ZZBUG","402000","201000","ZZ-500001","501000","ZZ-301024","ZZ-301022","101500","ZZ-301501","ZZ-401000","ZZ-301515","ZZ-301514","ZZ-301513","101000","409000","401000","zz-test3","ZZ-TestBug","zz-test5","ZZ-301031","ZZ-301491","100500","ZZ-301511","ZZ-TEST-AGAIN","301000","ZZ_Test211"],"description":"Start Measurement Condition\n* `102000` - No Read - Disconnected,\n* `ZZ-test-mark1` - zz-test-mark1,\n* `100000` - No Read - System,\n* `901000` - Super,\n* `ZZBUG` - Override description,\n* `402000` - Office Estimate,\n* `201000` - Missing,\n* `ZZ-500001` - Prorated,\n* `501000` - Regular,\n* `ZZ-301024` - ZZ Estimate - Interval Interpolation,\n* `ZZ-301022` - ZZ Estimate - Interval Averaging,\n* `101500` - No Read - Outage Fill,\n* `ZZ-301501` - ZZ Scalar Calculation from Estimated Interval Read,\n* `ZZ-401000` - ZZ-External Estimate,\n* `ZZ-301515` - ZZ Prorated - Scalar Proration from Regular Read,\n* `ZZ-301514` - ZZ Prorated - Scalar Adjustment from Regular Interval,\n* `ZZ-301513` - ZZ Prorated - Interval Adjustment from Regular Scalar,\n* `101000` - No Read - Outage,\n* `409000` - Combined Quantity,\n* `401000` - External Estimate,\n* `zz-test3` - Override description,\n* `ZZ-TestBug` - ZZ-TestBug-Override description,\n* `zz-test5` - zz test 5,\n* `ZZ-301031` - ZZ Estimate - Int Adj From Scalar,\n* `ZZ-301491` - ZZ Estimate - Scalar Estimation,\n* `100500` - No Read - Field,\n* `ZZ-301511` - ZZ Scalar Proration from Estimation Read,\n* `ZZ-TEST-AGAIN` - ZZ-TEST ONLY,\n* `301000` - System Estimate,\n* `ZZ_Test211` - ZZ_Test211-UPD","example":"501000"},"endDateTime":{"type":"string","format":"date-time","description":"End Date/Time"},"endMeasurement":{"type":"number","maximum":9999999999.999998,"minimum":-9999999999.999998,"description":"End Measurement","example":"0.080000"},"endMeasurementCondition":{"type":"string","enum":["102000","ZZ-test-mark1","100000","901000","ZZBUG","402000","201000","ZZ-500001","501000","ZZ-301024","ZZ-301022","101500","ZZ-301501","ZZ-401000","ZZ-301515","ZZ-301514","ZZ-301513","101000","409000","401000","zz-test3","ZZ-TestBug","zz-test5","ZZ-301031","ZZ-301491","100500","ZZ-301511","ZZ-TEST-AGAIN","301000","ZZ_Test211"],"description":"Condition:\n* `102000` - No Read - Disconnected,\n* `ZZ-test-mark1` - zz-test-mark1,\n* `100000` - No Read - System,\n* `901000` - Super,\n* `ZZBUG` - Override description,\n* `402000` - Office Estimate,\n* `201000` - Missing,\n* `ZZ-500001` - Prorated,\n* `501000` - Regular,\n* `ZZ-301024` - ZZ Estimate - Interval Interpolation,\n* `ZZ-301022` - ZZ Estimate - Interval Averaging,\n* `101500` - No Read - Outage Fill,\n* `ZZ-301501` - ZZ Scalar Calculation from Estimated Interval Read,\n* `ZZ-401000` - ZZ-External Estimate,\n* `ZZ-301515` - ZZ Prorated - Scalar Proration from Regular Read,\n* `ZZ-301514` - ZZ Prorated - Scalar Adjustment from Regular Interval,\n* `ZZ-301513` - ZZ Prorated - Interval Adjustment from Regular Scalar,\n* `101000` - No Read - Outage,\n* `409000` - Combined Quantity,\n* `401000` - External Estimate,\n* `zz-test3` - Override description,\n* `ZZ-TestBug` - ZZ-TestBug-Override description,\n* `zz-test5` - zz test 5,\n* `ZZ-301031` - ZZ Estimate - Int Adj From Scalar,\n* `ZZ-301491` - ZZ Estimate - Scalar Estimation,\n* `100500` - No Read - Field,\n* `ZZ-301511` - ZZ Scalar Proration from Estimation Read,\n* `ZZ-TEST-AGAIN` - ZZ-TEST ONLY,\n* `301000` - System Estimate,\n* `ZZ_Test211` - ZZ_Test211-UPD"},"quantity":{"type":"number","maximum":9999999999.999998,"minimum":-9999999999.999998,"description":"Quantity","example":"9.840000"},"finalUom":{"type":"object","properties":{"finalUom":{"type":"string","maxLength":30,"description":"Final UOM"}}},"finalTou":{"type":"object","properties":{"finalTou":{"type":"string","maxLength":30,"description":"Final TOU"}}},"finalSqi":{"type":"object","properties":{"finalSqi":{"type":"string","maxLength":30,"description":"Final SQI"}}},"finalQuantity":{"type":"number","maximum":9999999999.999998,"minimum":-9999999999.999998,"description":"Final Quantity","example":"9.840000"},"spHowToUse":{"type":"string","enum":["D1AD","D1CK","D1ST"],"description":"Usage:\n* `D1AD` - Add,\n* `D1CK` - Exclude,\n* `D1ST` - Subtract"},"mcHowToUse":{"type":"string","enum":["+   ","-   ","C   ","P   "],"description":"How To Use\n* `+   ` - Additive,\n* `-   ` - Subtractive,\n* `C   ` - Check,\n* `P   ` - Peak","example":"P"},"measuresPeakQuantity":{"type":"string","enum":["D1DP","D1MP"],"description":"Measures Peak Quantity\n* `D1DP` - No,\n* `D1MP` - Yes","example":"D1DP"},"appliedMultiplier":{"type":"number","maximum":1000000000000,"minimum":-1000000000000,"description":"Applied Multiplier","example":"123.000000"},"usePercent":{"type":"number","maximum":999,"minimum":-999,"description":"Use percent","example":"100"},"calculationGroup":{"type":"object","properties":{"calculationGroup":{"type":"string","maxLength":30,"description":"Calculation Group"}}},"usageRule":{"type":"string","maxLength":30,"description":"Usage calculation rules are standard and custom rules that perform calculations on measurement data to generate bill determinants.","example":"ZZS-MRULGRP-SCALAR-RULE"}}}}}},"subUsageTransactions":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"subUsageTransactionId":{"type":"string","description":"(subUsageTransactionId)"},"startDateTime":{"type":"string","format":"date-time","description":"(startDateTime)"},"endDateTime":{"type":"string","format":"date-time","description":"(endDateTime)"},"calculationGroup":{"type":"object","properties":{"calculationGroup":{"type":"string","maxLength":30,"description":"Calculation Group"}}}}}}}},"characteristics":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"characteristicType":{"type":"object","properties":{"characteristicType":{"type":"string","maxLength":8,"description":"Characteristic Type"}}},"characteristicValue":{"type":"string","maxLength":16,"description":"Characteristic Value Indicate the value of the characteristic.","example":"ADV"},"effectiveDate":{"type":"string","format":"date","description":"Effective Date Indicate the effective date of the characteristic type and value. The service point's install date defaults."},"adhocCharacteristicValue":{"type":"string","maxLength":254,"description":"Ad hoc Characteristics Value do not have their valid values defined in a discreet list because the possible values are infinite.","example":"77"},"characteristicValueForeignKey":{"type":"object","properties":{"id":{"type":"string","description":"(characteristicValueForeignKey1)"}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks.","example":"2"}}}}}},"serviceQuantitiesData":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"periodSequenceNumber":{"type":"number","maximum":999,"minimum":-999,"description":"Period Sequence Number"},"quantity":{"type":"number","maximum":9999999999.999998,"minimum":-9999999999.999998,"description":"Quantity","example":"9.840000"},"serviceQuantityDataDateTime":{"type":"string","format":"date-time","description":"Service Quantity Data Date/Time"},"serviceQuantityIntervalCondition":{"type":"string","maxLength":254,"description":"Service Quantity  Interval Condition"},"serviceQuantitySequenceNumber":{"type":"number","maximum":99999,"minimum":-99999,"description":"Service Quantity Sequence"}}}}}},"nextActions":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"_link":{"type":"string","description":"(_link)"},"actionName":{"type":"string","description":"(actionName)"}}}}}},"exceptions":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"sequence":{"type":"number","maximum":99999,"minimum":-99999,"description":"Sequence"},"usageGroup":{"type":"string","maxLength":30,"description":"Usage group used to calculate usage transactions (e.g., bill determinants)","example":"ZZS-MRULEGRP-SCALAR-ITEM"},"usageRule":{"type":"string","maxLength":30,"description":"Usage calculation rules are standard and custom rules that perform calculations on measurement data to generate bill determinants.","example":"ZZS-MRULGRP-SCALAR-RULE"},"exceptionType":{"type":"string","maxLength":30,"description":"Exception Type"},"exceptionSeverity":{"type":"string","enum":["D1IF","D1IS","D1TM"],"description":"Exception Severity\n* `D1IF` - Information,\n* `D1IS` - Issues,\n* `D1TM` - Terminate","example":"D1IF"},"exceptionRequiresApproval":{"type":"string","enum":["D1NO","D1YS"],"description":"Exception Requires Approval flag\n* `D1NO` - No,\n* `D1YS` - Yes","example":"D1NO"},"toDoType":{"type":"string","maxLength":8,"description":"To Do Type"},"toDoRole":{"type":"string","maxLength":10,"description":"To Do Role"},"messageCategory":{"type":"number","maximum":99999,"minimum":-99999,"description":"Message category within Oracle Utilities Application Framework."},"messageNumber":{"type":"number","maximum":99999,"minimum":-99999,"description":"Message Number within Oracle Utilities Application Framework."},"messageParameters":{"type":"object","properties":{"messageParametersList":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"sequence":{"type":"number","maximum":999,"minimum":-999,"description":"Message Parameter Sequence"},"parameter":{"type":"string","maxLength":2000,"description":"Message Parameter Value"},"parameterType":{"type":"string","enum":["AMT ","DATE","DTTM","DUR ","FLD ","MMDD","MSG ","NBR ","SRVC","TBL ","TIME"],"description":"Message Parameter Type\n* `AMT ` - Amount parameter,\n* `DATE` - Date format parameter,\n* `DTTM` - Date/time format parameter,\n* `DUR ` - Duration parameter,\n* `FLD ` - Field name parameter,\n* `MMDD` - Month/Day format parameter,\n* `MSG ` - Message parameter,\n* `NBR ` - Numeric parameter,\n* `SRVC` - Service name parameter,\n* `TBL ` - Table name parameter,\n* `TIME` - Time format parameter","example":"AMT"}}}}}}}}}}}}},"traces":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"sequence":{"type":"number","maximum":99999,"minimum":-99999,"description":"Sequence"},"usageGroup":{"type":"string","maxLength":30,"description":"Usage group used to calculate usage transactions (e.g., bill determinants)","example":"ZZS-MRULEGRP-SCALAR-ITEM"},"usageRule":{"type":"string","maxLength":30,"description":"Usage calculation rules are standard and custom rules that perform calculations on measurement data to generate bill determinants.","example":"ZZS-MRULGRP-SCALAR-RULE"},"criteriaSequence":{"type":"number","maximum":999,"minimum":-999,"description":"Sequence"},"duration":{"type":"number","maximum":9999999999,"minimum":-9999999999,"description":"Duration"},"messageCategory":{"type":"number","maximum":99999,"minimum":-99999,"description":"Message category within Oracle Utilities Application Framework."},"messageNumber":{"type":"number","maximum":99999,"minimum":-99999,"description":"Message Number within Oracle Utilities Application Framework."},"messageParameters":{"type":"object","properties":{"messageParametersList":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"sequence":{"type":"number","maximum":999,"minimum":-999,"description":"Message Parameter Sequence"},"parameter":{"type":"string","maxLength":2000,"description":"Message Parameter Value"},"parameterType":{"type":"string","enum":["AMT ","DATE","DTTM","DUR ","FLD ","MMDD","MSG ","NBR ","SRVC","TBL ","TIME"],"description":"Message Parameter Type\n* `AMT ` - Amount parameter,\n* `DATE` - Date format parameter,\n* `DTTM` - Date/time format parameter,\n* `DUR ` - Duration parameter,\n* `FLD ` - Field name parameter,\n* `MMDD` - Month/Day format parameter,\n* `MSG ` - Message parameter,\n* `NBR ` - Numeric parameter,\n* `SRVC` - Service name parameter,\n* `TBL ` - Table name parameter,\n* `TIME` - Time format parameter","example":"AMT"}}}}}}}}}}}}},"initialCalculation":{"type":"boolean","description":"Initial Calculation","example":"true"},"subUsageToDoIds":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"currentToDoId":{"type":"string","maxLength":14,"description":"To Do ID"}}}}}}},"xml":{"name":"D1UsgTransac"}},"GETPERSON_response":{"type":"object","properties":{"_self":{"type":"string","description":"_self"},"personId":{"type":"string","maxLength":10,"description":"Person ID is a system-assigned random number that stays with a person for the life of the system.","example":"5775933103"},"personOrBusiness":{"type":"string","enum":["B   ","P   "],"description":"Defines the person entity as a person or business which controls validation of the person entity's primary name.\n* `B   ` - Business,\n* `P   ` - Person"},"lifeSupportSensitiveLoad":{"type":"string","enum":["N   ","Y   "],"description":"Life Support / Sensitive Load indicates if the person has life support or sensitive load equipment.\n* `N   ` - None,\n* `Y   ` - LS/SL","example":"N"},"lifeSupportSensitiveLoadDescription":{"type":"string","maxLength":1000,"description":"Life Support or Sensitive Load Description supports additional notes for life support information or equipment associated with the person."},"emailAddress":{"type":"string","maxLength":254,"description":"Email Address"},"overrideMailingName1":{"type":"string","maxLength":254,"description":"Override Mailing Name for addressee on the person's correspondence and bills."},"overrideMailingAddress":{"type":"object","description":"Override Mailing Address if the person wants their bills, letters, quotes, and statements sent to an address other than their service addresses. For example, a post office box. The address constituents may differ depending on the Country.","properties":{"address1":{"type":"string","maxLength":254,"description":"Address"},"address2":{"type":"string","maxLength":254,"description":"Address 2"},"address3":{"type":"string","maxLength":254,"description":"Address 3"},"address4":{"type":"string","maxLength":254,"description":"Address 4"},"city":{"type":"string","maxLength":90,"description":"City"},"streetNumber1":{"type":"string","maxLength":6,"description":"Number 1"},"streetNumber2":{"type":"string","maxLength":4,"description":"Number 2"},"county":{"type":"string","maxLength":90,"description":"County"},"postal":{"type":"string","maxLength":12,"description":"Postal"},"state":{"type":"string","maxLength":6,"description":"State"},"country":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"country":{"type":"string","maxLength":3,"description":"Country"}}},"houseType":{"type":"string","enum":["AB  ","WW  "],"description":"House Type indicates the type of house.\n* `AB  ` - House Boat References,\n* `WW  ` - House Trailer Reference"},"taxVendorGeographicalCode":{"type":"string","maxLength":11,"description":"Geographical Code is used to apply proper taxation rules to the physical address location."},"isInCityLimit":{"type":"boolean","description":"In City Limit indicates if the address is considered within the physical city limits. A value of true indicates within city limits."}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"},"language":{"type":"object","description":"Language in which the person prefers their bills and correspondences.","properties":{"_link":{"type":"string","description":"_link"},"language":{"type":"string","maxLength":3,"description":"Language in which the person prefers their bills and correspondences.","example":"ENG"}}},"overrideMailingName2":{"type":"string","maxLength":254,"description":"Override Mailing Name Line 2 for addressee on the person's correspondence and bills."},"overrideMailingName3":{"type":"string","maxLength":254,"description":"Override Mailing Name Line 3 for addressee on the person's correspondence and bills."},"timeZone":{"type":"object","description":"Defines the person's Time Zone preference if it is different from the system installation's time zone.","properties":{"_link":{"type":"string","description":"_link"},"timeZone":{"type":"string","maxLength":10,"description":"Defines the person's Time Zone preference if it is different from the system installation's time zone."}}},"contactDetails":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"contactDetailId":{"type":"string","maxLength":10,"description":"Person Contact"},"contactDetailValue":{"type":"string","maxLength":254,"description":"Contact Detail Value contains the specific contact information such as, the phone number or email address in the associated format.","example":"krish11@yahoo.com,\n\n(415) 987-1298"},"contactDetailStatus":{"type":"string","enum":["C1AP","C1PN","C1RJ","ZZBN","ZZPE"],"description":"Contact Status indicates the option contact's status. The initial status can be defined from the Person Contact Type and manually maintained, or configured to be controlled by a process such as an Opt-In process.\n* `C1AP` - Approved,\n* `C1PN` - Pending,\n* `C1RJ` - Rejected,\n* `ZZBN` - ZZBounced,\n* `ZZPE` - ZZPending","example":"Contact Status:\n\n    C1AP - Approved,\n    C1PN - Pending,\n    C1RJ - Rejected"},"contactDetailValueExtension":{"type":"string","maxLength":6,"description":"Extension, if any, of the contact information. (This field is only active when the contact's contact routing is phone or fax.)"},"contactDetailActiveInactive":{"type":"string","enum":["C1AC","C1IN"],"description":"Most contact preferences will remain active. When a contact is no longer valid, the existing contact should be updated to Inactive.\n* `C1AC` - Active,\n* `C1IN` - Inactive","example":"Active/Inactive:\n\n    C1AC - Active,\n    C1IN - Inactive"},"contactDetailPrimary":{"type":"string","enum":["C1NO","C1YS"],"description":"Primary switch must be set for exactly one person contact for each contact routing.\n* `C1NO` - No,\n* `C1YS` - Yes","example":"Primary:\n\n    C1NO - No,\n    C1YS - Yes"},"contactNickname":{"type":"string","maxLength":100,"description":"Contact Nickname can be assigned by self-service users."},"personContactType":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"personContactType":{"type":"string","maxLength":30,"description":"Person Contact Type"}}},"doNotDisturbStartDate":{"type":"string","description":"Do Not Disturb (From)"},"doNotDisturbEndDate":{"type":"string","description":"Do Not Disturb (To)"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"}}}}}},"paymentOptions":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"selfServicePaymentOptionId":{"type":"string","maxLength":12,"description":"Payment Option ID is a system-assigned random number for the record."},"paymentType":{"type":"string","enum":["27  ","28  ","37  ","38  ","47  "],"description":"Payment type is a two-digit code that indicates the banking transaction as a debit or credit and type of financial account.\n* `27  ` - Checking Withdrawal,\n* `28  ` - Checking Debit Prenotification,\n* `37  ` - Savings Withdrawal,\n* `38  ` - Savings Debit Prenotification,\n* `47  ` - Credit Card Withdrawal","example":"47 (Credit Card Withdrawal)"},"creditCardInfo":{"type":"object","properties":{"cardType":{"type":"string","enum":["C1AM","C1DV","C1MC","C1VS"],"description":"Card type indicates the credit card processing network such as American Express, Discover, MasterCard, or Visa.\n* `C1AM` - American Express,\n* `C1DV` - Discover,\n* `C1MC` - MasterCard,\n* `C1VS` - Visa","example":"C1AM"},"cardNumber":{"type":"string","maxLength":60,"description":"Number of the credit card."},"expiryMonth":{"type":"string","maxLength":2,"description":"Credit card expiration month."},"expiryYear":{"type":"string","maxLength":4,"description":"Credit card expiration year"},"cardHolderFirstName":{"type":"string","maxLength":50,"description":"Cardholder First Name"},"cardHolderLastName":{"type":"string","maxLength":50,"description":"Credit card holder Last Name"},"addressLine1":{"type":"string","maxLength":254,"description":"Address"},"addressLine2":{"type":"string","maxLength":254,"description":"Address 2"},"addressLine3":{"type":"string","maxLength":254,"description":"Address 3"},"addressLine4":{"type":"string","maxLength":254,"description":"Address 4"},"streetNumber1":{"type":"string","maxLength":6,"description":"Number 1"},"streetNumber2":{"type":"string","maxLength":4,"description":"Number 2"},"city":{"type":"string","maxLength":90,"description":"City"},"county":{"type":"string","maxLength":90,"description":"County"},"postal":{"type":"string","maxLength":12,"description":"Postal"},"state":{"type":"string","maxLength":6,"description":"State"}}},"bankAccountInfo":{"type":"object","properties":{"routingNumber":{"type":"string","maxLength":30,"description":"The routing number identifies the bank or financial institution for payment transactions."},"accountNumber":{"type":"string","maxLength":50,"description":"The account number to be used for payment transactions.","example":"1223428263"},"autoPaySource":{"type":"string","maxLength":12,"description":"Auto Pay Source"}}}}}}}},"seasonalAddresses":{"type":"object","description":"Seasonal Addresses are used if the person wants their correspondence sent to an alternate address during predefined seasonal periods.","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"sequence":{"type":"number","maximum":999,"minimum":-999,"description":"A sequence is used to define the order of the records."},"effectiveStatus":{"type":"string","enum":["A   ","I   "],"description":"Status of the address must be Active to be used. The status can be set to Inactive for the seasonal address to be ignored.\n* `A   ` - Active,\n* `I   ` - Inactive","example":"Status:\n\n    A - Active,\n    I - Inactive"},"startMonthDay":{"type":"string","maxLength":4,"description":"Start Month Day contains the day and month when the season starts.","example":"0201"},"endMonthDay":{"type":"string","maxLength":4,"description":"End Month Day contains the day and month when the season ends.","example":"1231"},"address":{"type":"object","properties":{"country":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"country":{"type":"string","maxLength":3,"description":"Country"}}},"postal":{"type":"string","maxLength":12,"description":"Postal"},"address1":{"type":"string","maxLength":254,"description":"Address"},"address2":{"type":"string","maxLength":254,"description":"Address 2"},"address3":{"type":"string","maxLength":254,"description":"Address 3"},"address4":{"type":"string","maxLength":254,"description":"Address 4"},"streetNumber1":{"type":"string","maxLength":6,"description":"Number 1"},"streetNumber2":{"type":"string","maxLength":4,"description":"Number 2"},"city":{"type":"string","maxLength":90,"description":"City"},"county":{"type":"string","maxLength":90,"description":"County"},"state":{"type":"string","maxLength":6,"description":"State"},"houseType":{"type":"string","enum":["AB  ","WW  "],"description":"House Type indicates the type of house.\n* `AB  ` - House Boat References,\n* `WW  ` - House Trailer Reference"},"isInCityLimit":{"type":"boolean","description":"In City Limit indicates if the address is considered within the physical city limits. A value of true indicates within city limits."},"taxVendorGeographicalCode":{"type":"string","maxLength":11,"description":"Geographical Code is used to apply proper taxation rules to the physical address location."}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"}}}}}},"characteristics":{"type":"object","description":"Configured additional attributes for any additional information that needs to be maintained for persons.","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"effectiveDate":{"type":"string","format":"date","description":"Effective Date defines the date on which the characteristic becomes effective."},"characteristicType":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"characteristicType":{"type":"string","maxLength":8,"description":"Characteristic Type"}}},"typeOfCharacteristicValue":{"type":"string","maxLength":4,"description":"Type of Characteristic Value indicates whether the characteristic type value is Adhoc, Predefined, Foreign Key, or a File or URL Location."},"characteristicValue":{"type":"object","properties":{"_link":{"type":"string","description":"(_link)"},"value":{"type":"string","description":"(value)"},"value2":{"type":"string","description":"(value2)"},"value3":{"type":"string","description":"(value3)"},"value4":{"type":"string","description":"(value4)"},"value5":{"type":"string","description":"(value5)"}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"}}}}}},"identifiers":{"type":"object","description":"Identifiers are used for validating the identity of a customer based on their provided form of identification.","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"idType":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"idType":{"type":"string","maxLength":8,"description":"ID Type indicates the type of identification and receives a default value from the Installation Record based on the Person Type."}}},"idNumber":{"type":"string","maxLength":100,"description":"ID Number"},"isPrimaryId":{"type":"boolean","description":"Primary ID switch is true if this is the primary means of identification for the customer.","example":"false"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"}}}}}},"names":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"sequence":{"type":"number","maximum":999,"minimum":-999,"description":"A sequence is used to define the order of the records."},"personName":{"type":"string","maxLength":254,"description":"Person Name captures the person's name. The name is case-sensitive."},"nameType":{"type":"string","enum":["AL  ","ALT ","DBA ","FORM","LGAL","PRIM"],"description":"Name Type indicates if the name is an Alias, Alternate Representation, Doing Business As, Legal, or Primary name. Note, for new persons, a value of Primary is the default value. The values for the name type field are customizable using the applicable lookup table.\n* `AL  ` - Alias,\n* `ALT ` - Alternate Representation,\n* `DBA ` - Doing Business As,\n* `FORM` - Former,\n* `LGAL` - Legal,\n* `PRIM` - Primary","example":"PRIM (Primary)"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"},"isPrimaryName":{"type":"boolean","description":"Primary Name is defined as true if this is the primary name for the customer.","example":"true"}}}}}},"relationships":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"childPersonId":{"type":"string","maxLength":10,"description":"Person ID"},"personRelationshipType":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"personRelationshipType":{"type":"string","maxLength":8,"description":"Relationship Type"}}},"startDate":{"type":"string","format":"date","description":"Start Date indicates the date on which this relationship began.","example":"1950-01-01"},"endDate":{"type":"string","format":"date","description":"End Date indicates the relationship expires, indicate the date the relationship stops.","example":"1950-01-01"},"hasFinancialRelationship":{"type":"boolean","description":"Financial Relationship indicates if the child person is related to accounts which should be displayed in the parent person's hierarchy.","example":"false"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"}}}}}}},"xml":{"name":"C1-Person"}},"DELETEPERSON_request":{"type":"object","properties":{"personId":{"type":"string","maxLength":10,"description":"Person ID is a system-assigned random number that stays with a person for the life of the system.","example":"5775933103"}},"xml":{"name":"C1-DelPerson"}},"UPDATEPERSON_request":{"type":"object","properties":{"personId":{"type":"string","maxLength":10,"description":"Person ID is a system-assigned random number that stays with a person for the life of the system.","example":"5775933103"},"personOrBusiness":{"type":"string","enum":["B   ","P   "],"description":"Defines the person entity as a person or business which controls validation of the person entity's primary name.\n* `B   ` - Business,\n* `P   ` - Person"},"lifeSupportSensitiveLoad":{"type":"string","enum":["N   ","Y   "],"description":"Life Support / Sensitive Load indicates if the person has life support or sensitive load equipment.\n* `N   ` - None,\n* `Y   ` - LS/SL","example":"N"},"lifeSupportSensitiveLoadDescription":{"type":"string","maxLength":1000,"description":"Life Support or Sensitive Load Description supports additional notes for life support information or equipment associated with the person."},"emailAddress":{"type":"string","maxLength":254,"description":"Email Address"},"overrideMailingName1":{"type":"string","maxLength":254,"description":"Override Mailing Name for addressee on the person's correspondence and bills."},"overrideMailingAddress":{"type":"object","description":"Override Mailing Address if the person wants their bills, letters, quotes, and statements sent to an address other than their service addresses. For example, a post office box. The address constituents may differ depending on the Country.","properties":{"address1":{"type":"string","maxLength":254,"description":"Address"},"address2":{"type":"string","maxLength":254,"description":"Address 2"},"address3":{"type":"string","maxLength":254,"description":"Address 3"},"address4":{"type":"string","maxLength":254,"description":"Address 4"},"city":{"type":"string","maxLength":90,"description":"City"},"streetNumber1":{"type":"string","maxLength":6,"description":"Number 1"},"streetNumber2":{"type":"string","maxLength":4,"description":"Number 2"},"county":{"type":"string","maxLength":90,"description":"County"},"postal":{"type":"string","maxLength":12,"description":"Postal"},"state":{"type":"string","maxLength":6,"description":"State"},"country":{"type":"object","properties":{"country":{"type":"string","maxLength":3,"description":"Country"}}},"houseType":{"type":"string","enum":["AB  ","WW  "],"description":"House Type indicates the type of house.\n* `AB  ` - House Boat References,\n* `WW  ` - House Trailer Reference"},"taxVendorGeographicalCode":{"type":"string","maxLength":11,"description":"Geographical Code is used to apply proper taxation rules to the physical address location."},"isInCityLimit":{"type":"boolean","description":"In City Limit indicates if the address is considered within the physical city limits. A value of true indicates within city limits."}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"},"language":{"type":"object","description":"Language in which the person prefers their bills and correspondences.","properties":{"language":{"type":"string","maxLength":3,"description":"Language in which the person prefers their bills and correspondences.","example":"ENG"}}},"overrideMailingName2":{"type":"string","maxLength":254,"description":"Override Mailing Name Line 2 for addressee on the person's correspondence and bills."},"overrideMailingName3":{"type":"string","maxLength":254,"description":"Override Mailing Name Line 3 for addressee on the person's correspondence and bills."},"timeZone":{"type":"object","description":"Defines the person's Time Zone preference if it is different from the system installation's time zone.","properties":{"timeZone":{"type":"string","maxLength":10,"description":"Defines the person's Time Zone preference if it is different from the system installation's time zone."}}},"contactDetails":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"contactDetailId":{"type":"string","maxLength":10,"description":"Person Contact"},"contactDetailValue":{"type":"string","maxLength":254,"description":"Contact Detail Value contains the specific contact information such as, the phone number or email address in the associated format.","example":"krish11@yahoo.com,\n\n(415) 987-1298"},"contactDetailStatus":{"type":"string","enum":["C1AP","C1PN","C1RJ","ZZBN","ZZPE"],"description":"Contact Status indicates the option contact's status. The initial status can be defined from the Person Contact Type and manually maintained, or configured to be controlled by a process such as an Opt-In process.\n* `C1AP` - Approved,\n* `C1PN` - Pending,\n* `C1RJ` - Rejected,\n* `ZZBN` - ZZBounced,\n* `ZZPE` - ZZPending","example":"Contact Status:\n\n    C1AP - Approved,\n    C1PN - Pending,\n    C1RJ - Rejected"},"contactDetailValueExtension":{"type":"string","maxLength":6,"description":"Extension, if any, of the contact information. (This field is only active when the contact's contact routing is phone or fax.)"},"contactDetailActiveInactive":{"type":"string","enum":["C1AC","C1IN"],"description":"Most contact preferences will remain active. When a contact is no longer valid, the existing contact should be updated to Inactive.\n* `C1AC` - Active,\n* `C1IN` - Inactive","example":"Active/Inactive:\n\n    C1AC - Active,\n    C1IN - Inactive"},"contactDetailPrimary":{"type":"string","enum":["C1NO","C1YS"],"description":"Primary switch must be set for exactly one person contact for each contact routing.\n* `C1NO` - No,\n* `C1YS` - Yes","example":"Primary:\n\n    C1NO - No,\n    C1YS - Yes"},"contactNickname":{"type":"string","maxLength":100,"description":"Contact Nickname can be assigned by self-service users."},"personContactType":{"type":"object","properties":{"personContactType":{"type":"string","maxLength":30,"description":"Person Contact Type"}}},"doNotDisturbStartDate":{"type":"string","description":"Do Not Disturb (From)"},"doNotDisturbEndDate":{"type":"string","description":"Do Not Disturb (To)"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"}}}}}},"paymentOptions":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"selfServicePaymentOptionId":{"type":"string","maxLength":12,"description":"Payment Option ID is a system-assigned random number for the record."},"paymentType":{"type":"string","enum":["27  ","28  ","37  ","38  ","47  "],"description":"Payment type is a two-digit code that indicates the banking transaction as a debit or credit and type of financial account.\n* `27  ` - Checking Withdrawal,\n* `28  ` - Checking Debit Prenotification,\n* `37  ` - Savings Withdrawal,\n* `38  ` - Savings Debit Prenotification,\n* `47  ` - Credit Card Withdrawal","example":"47 (Credit Card Withdrawal)"},"creditCardInfo":{"type":"object","properties":{"cardType":{"type":"string","enum":["C1AM","C1DV","C1MC","C1VS"],"description":"Card type indicates the credit card processing network such as American Express, Discover, MasterCard, or Visa.\n* `C1AM` - American Express,\n* `C1DV` - Discover,\n* `C1MC` - MasterCard,\n* `C1VS` - Visa","example":"C1AM"},"cardNumber":{"type":"string","maxLength":60,"description":"Number of the credit card."},"expiryMonth":{"type":"string","maxLength":2,"description":"Credit card expiration month."},"expiryYear":{"type":"string","maxLength":4,"description":"Credit card expiration year"},"cardHolderFirstName":{"type":"string","maxLength":50,"description":"Cardholder First Name"},"cardHolderLastName":{"type":"string","maxLength":50,"description":"Credit card holder last name."},"addressLine1":{"type":"string","maxLength":254,"description":"Address"},"addressLine2":{"type":"string","maxLength":254,"description":"Address 2"},"addressLine3":{"type":"string","maxLength":254,"description":"Address 3"},"addressLine4":{"type":"string","maxLength":254,"description":"Address 4"},"streetNumber1":{"type":"string","maxLength":6,"description":"Number 1"},"streetNumber2":{"type":"string","maxLength":4,"description":"Number 2"},"city":{"type":"string","maxLength":90,"description":"City"},"county":{"type":"string","maxLength":90,"description":"County"},"postal":{"type":"string","maxLength":12,"description":"Postal"},"state":{"type":"string","maxLength":6,"description":"State"}}},"bankAccountInfo":{"type":"object","properties":{"routingNumber":{"type":"string","maxLength":30,"description":"The routing number identifies the bank or financial institution for payment transactions."},"accountNumber":{"type":"string","maxLength":50,"description":"The account number to be used for payment transactions.","example":"1223428263"},"autoPaySource":{"type":"string","maxLength":12,"description":"Auto Pay Source"}}}}}}}},"seasonalAddresses":{"type":"object","description":"Seasonal Addresses are used if the person wants their correspondence sent to an alternate address during predefined seasonal periods.","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"sequence":{"type":"number","maximum":999,"minimum":-999,"description":"A sequence is used to define the order of the records."},"effectiveStatus":{"type":"string","enum":["A   ","I   "],"description":"Status of the address must be Active to be used. The status can be set to Inactive for the seasonal address to be ignored.\n* `A   ` - Active,\n* `I   ` - Inactive","example":"Status:\n\n    A - Active,\n    I - Inactive"},"startMonthDay":{"type":"string","maxLength":4,"description":"Start Month Day contains the day and month when the season starts.","example":"0201"},"endMonthDay":{"type":"string","maxLength":4,"description":"End Month Day contains the day and month when the season ends.","example":"1231"},"address":{"type":"object","properties":{"country":{"type":"object","properties":{"country":{"type":"string","maxLength":3,"description":"Country"}}},"postal":{"type":"string","maxLength":12,"description":"Postal"},"address1":{"type":"string","maxLength":254,"description":"Address"},"address2":{"type":"string","maxLength":254,"description":"Address 2"},"address3":{"type":"string","maxLength":254,"description":"Address 3"},"address4":{"type":"string","maxLength":254,"description":"Address 4"},"streetNumber1":{"type":"string","maxLength":6,"description":"Number 1"},"streetNumber2":{"type":"string","maxLength":4,"description":"Number 2"},"city":{"type":"string","maxLength":90,"description":"City"},"county":{"type":"string","maxLength":90,"description":"County"},"state":{"type":"string","maxLength":6,"description":"State"},"houseType":{"type":"string","enum":["AB  ","WW  "],"description":"House Type indicates the type of house.\n* `AB  ` - House Boat References,\n* `WW  ` - House Trailer Reference"},"isInCityLimit":{"type":"boolean","description":"In City Limit indicates if the address is considered within the physical city limits. A value of true indicates within city limits."},"taxVendorGeographicalCode":{"type":"string","maxLength":11,"description":"Geographical Code is used to apply proper taxation rules to the physical address location."}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"}}}}}},"characteristics":{"type":"object","description":"Configured additional attributes for any additional information that needs to be maintained for persons.","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"effectiveDate":{"type":"string","format":"date","description":"Effective Date defines the date on which the characteristic becomes effective."},"characteristicType":{"type":"object","properties":{"characteristicType":{"type":"string","maxLength":8,"description":"Characteristic Type"}}},"characteristicValue":{"type":"object","properties":{"_link":{"type":"string","description":"(_link)"},"value":{"type":"string","description":"(value)"},"value2":{"type":"string","description":"(value2)"},"value3":{"type":"string","description":"(value3)"},"value4":{"type":"string","description":"(value4)"},"value5":{"type":"string","description":"(value5)"}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"}}}}}},"identifiers":{"type":"object","description":"Identifiers are used for validating the identity of a customer based on their provided form of identification.","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"idType":{"type":"object","properties":{"idType":{"type":"string","maxLength":8,"description":"ID Type indicates the type of identification and receives a default value from the Installation Record based on the Person Type."}}},"idNumber":{"type":"string","maxLength":100,"description":"ID Number"},"isPrimaryId":{"type":"boolean","description":"Primary ID switch is true if this is the primary means of identification for the customer.","example":"false"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"}}}}}},"names":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"sequence":{"type":"number","maximum":999,"minimum":-999,"description":"A sequence is used to define the order of the records."},"personName":{"type":"string","maxLength":254,"description":"Person Name captures the person's name. The name is case-sensitive."},"nameType":{"type":"string","enum":["AL  ","ALT ","DBA ","FORM","LGAL","PRIM"],"description":"Name Type indicates if the name is an Alias, Alternate Representation, Doing Business As, Legal, or Primary name. Note, for new persons, a value of Primary is the default value. The values for the name type field are customizable using the applicable lookup table.\n* `AL  ` - Alias,\n* `ALT ` - Alternate Representation,\n* `DBA ` - Doing Business As,\n* `FORM` - Former,\n* `LGAL` - Legal,\n* `PRIM` - Primary","example":"PRIM (Primary)"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"},"isPrimaryName":{"type":"boolean","description":"Primary Name is defined as true if this is the primary name for the customer.","example":"true"}}}}}},"relationships":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"childPersonId":{"type":"string","maxLength":10,"description":"Person ID"},"personRelationshipType":{"type":"object","properties":{"personRelationshipType":{"type":"string","maxLength":8,"description":"Relationship Type"}}},"startDate":{"type":"string","format":"date","description":"Start Date indicates the date on which this relationship began.","example":"1950-01-01"},"endDate":{"type":"string","format":"date","description":"End Date indicates the relationship expires, indicate the date the relationship stops.","example":"1950-01-01"},"hasFinancialRelationship":{"type":"boolean","description":"Financial Relationship indicates if the child person is related to accounts which should be displayed in the parent person's hierarchy.","example":"false"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"}}}}}}},"xml":{"name":"C1-Person"}},"CREATEPERSON_request":{"type":"object","properties":{"personOrBusiness":{"type":"string","enum":["B   ","P   "],"description":"Defines the person entity as a person or business which controls validation of the person entity's primary name.\n* `B   ` - Business,\n* `P   ` - Person"},"lifeSupportSensitiveLoad":{"type":"string","enum":["N   ","Y   "],"description":"Life Support / Sensitive Load indicates if the person has life support or sensitive load equipment.\n* `N   ` - None,\n* `Y   ` - LS/SL","example":"N"},"lifeSupportSensitiveLoadDescription":{"type":"string","maxLength":1000,"description":"Life Support or Sensitive Load Description supports additional notes for life support information or equipment associated with the person."},"emailAddress":{"type":"string","maxLength":254,"description":"Email Address"},"overrideMailingName1":{"type":"string","maxLength":254,"description":"Override Mailing Name for addressee on the person's correspondence and bills."},"overrideMailingAddress":{"type":"object","description":"Override Mailing Address if the person wants their bills, letters, quotes, and statements sent to an address other than their service addresses. For example, a post office box. The address constituents may differ depending on the Country.","properties":{"address1":{"type":"string","maxLength":254,"description":"Address"},"address2":{"type":"string","maxLength":254,"description":"Address 2"},"address3":{"type":"string","maxLength":254,"description":"Address 3"},"address4":{"type":"string","maxLength":254,"description":"Address 4"},"city":{"type":"string","maxLength":90,"description":"City"},"streetNumber1":{"type":"string","maxLength":6,"description":"Number 1"},"streetNumber2":{"type":"string","maxLength":4,"description":"Number 2"},"county":{"type":"string","maxLength":90,"description":"County"},"postal":{"type":"string","maxLength":12,"description":"Postal"},"state":{"type":"string","maxLength":6,"description":"State"},"country":{"type":"object","properties":{"country":{"type":"string","maxLength":3,"description":"Country"}}},"houseType":{"type":"string","enum":["AB  ","WW  "],"description":"House Type indicates the type of house.\n* `AB  ` - House Boat References,\n* `WW  ` - House Trailer Reference"},"taxVendorGeographicalCode":{"type":"string","maxLength":11,"description":"Geographical Code is used to apply proper taxation rules to the physical address location."},"isInCityLimit":{"type":"boolean","description":"In City Limit indicates if the address is considered within the physical city limits. A value of true indicates within city limits."}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"},"language":{"type":"object","description":"Language in which the person prefers their bills and correspondences.","properties":{"language":{"type":"string","maxLength":3,"description":"Language in which the person prefers their bills and correspondences.","example":"ENG"}}},"overrideMailingName2":{"type":"string","maxLength":254,"description":"Override Mailing Name Line 2 for addressee on the person's correspondence and bills."},"overrideMailingName3":{"type":"string","maxLength":254,"description":"Override Mailing Name Line 3 for addressee on the person's correspondence and bills."},"timeZone":{"type":"object","description":"Defines the person's Time Zone preference if it is different from the system installation's time zone.","properties":{"timeZone":{"type":"string","maxLength":10,"description":"Defines the person's Time Zone preference if it is different from the system installation's time zone."}}},"contactDetails":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"contactDetailValue":{"type":"string","maxLength":254,"description":"Contact Detail Value contains the specific contact information such as, the phone number or email address in the associated format.","example":"krish11@yahoo.com,\n\n(415) 987-1298"},"contactDetailStatus":{"type":"string","enum":["C1AP","C1PN","C1RJ","ZZBN","ZZPE"],"description":"Contact Status indicates the option contact's status. The initial status can be defined from the Person Contact Type and manually maintained, or configured to be controlled by a process such as an Opt-In process.\n* `C1AP` - Approved,\n* `C1PN` - Pending,\n* `C1RJ` - Rejected,\n* `ZZBN` - ZZBounced,\n* `ZZPE` - ZZPending","example":"Contact Status:\n\n    C1AP - Approved,\n    C1PN - Pending,\n    C1RJ - Rejected"},"contactDetailValueExtension":{"type":"string","maxLength":6,"description":"Extension, if any, of the contact information. (This field is only active when the contact's contact routing is phone or fax.)"},"contactDetailActiveInactive":{"type":"string","enum":["C1AC","C1IN"],"description":"Most contact preferences will remain active. When a contact is no longer valid, the existing contact should be updated to Inactive.\n* `C1AC` - Active,\n* `C1IN` - Inactive","example":"Active/Inactive:\n\n    C1AC - Active,\n    C1IN - Inactive"},"contactDetailPrimary":{"type":"string","enum":["C1NO","C1YS"],"description":"Primary switch must be set for exactly one person contact for each contact routing.\n* `C1NO` - No,\n* `C1YS` - Yes","example":"Primary:\n\n    C1NO - No,\n    C1YS - Yes"},"contactNickname":{"type":"string","maxLength":100,"description":"Contact Nickname can be assigned by self-service users."},"personContactType":{"type":"object","properties":{"personContactType":{"type":"string","maxLength":30,"description":"Person Contact Type"}}},"doNotDisturbStartDate":{"type":"string","description":"Do Not Disturb (From)"},"doNotDisturbEndDate":{"type":"string","description":"Do Not Disturb (To)"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"}}}}}},"paymentOptions":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"paymentType":{"type":"string","enum":["27  ","28  ","37  ","38  ","47  "],"description":"Payment type is a two-digit code that indicates the banking transaction as a debit or credit and type of financial account.\n* `27  ` - Checking Withdrawal,\n* `28  ` - Checking Debit Prenotification,\n* `37  ` - Savings Withdrawal,\n* `38  ` - Savings Debit Prenotification,\n* `47  ` - Credit Card Withdrawal","example":"47 (Credit Card Withdrawal)"},"creditCardInfo":{"type":"object","properties":{"cardType":{"type":"string","enum":["C1AM","C1DV","C1MC","C1VS"],"description":"Card type indicates the credit card processing network such as American Express, Discover, MasterCard, or Visa.\n* `C1AM` - American Express,\n* `C1DV` - Discover,\n* `C1MC` - MasterCard,\n* `C1VS` - Visa","example":"C1AM"},"cardNumber":{"type":"string","maxLength":60,"description":"Number of the credit card."},"expiryMonth":{"type":"string","maxLength":2,"description":"Credit card expiration month."},"expiryYear":{"type":"string","maxLength":4,"description":"Credit card expiration year"},"cardHolderFirstName":{"type":"string","maxLength":50,"description":"Cardholder First Name"},"cardHolderLastName":{"type":"string","maxLength":50,"description":"Credit card holder Last Name"},"addressLine1":{"type":"string","maxLength":254,"description":"Address"},"addressLine2":{"type":"string","maxLength":254,"description":"Address 2"},"addressLine3":{"type":"string","maxLength":254,"description":"Address 3"},"addressLine4":{"type":"string","maxLength":254,"description":"Address 4"},"streetNumber1":{"type":"string","maxLength":6,"description":"Number 1"},"streetNumber2":{"type":"string","maxLength":4,"description":"Number 2"},"city":{"type":"string","maxLength":90,"description":"City"},"county":{"type":"string","maxLength":90,"description":"County"},"postal":{"type":"string","maxLength":12,"description":"Postal"},"state":{"type":"string","maxLength":6,"description":"State"}}},"bankAccountInfo":{"type":"object","properties":{"routingNumber":{"type":"string","maxLength":30,"description":"The routing number identifies the bank or financial institution for payment transactions."},"accountNumber":{"type":"string","maxLength":50,"description":"The account number to be used for payment transactions.","example":"1223428263"},"autoPaySource":{"type":"string","maxLength":12,"description":"Auto Pay Source"}}}}}}}},"seasonalAddresses":{"type":"object","description":"Seasonal Addresses are used if the person wants their correspondence sent to an alternate address during predefined seasonal periods.","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"sequence":{"type":"number","maximum":999,"minimum":-999,"description":"A sequence is used to define the order of the records."},"effectiveStatus":{"type":"string","enum":["A   ","I   "],"description":"Status of the address must be Active to be used. The status can be set to Inactive for the seasonal address to be ignored.\n* `A   ` - Active,\n* `I   ` - Inactive","example":"Status:\n\n    A - Active,\n    I - Inactive"},"startMonthDay":{"type":"string","maxLength":4,"description":"Start Month Day contains the day and month when the season starts.","example":"0201"},"endMonthDay":{"type":"string","maxLength":4,"description":"End Month Day contains the day and month when the season ends.","example":"1231"},"address":{"type":"object","properties":{"country":{"type":"object","properties":{"country":{"type":"string","maxLength":3,"description":"Country"}}},"postal":{"type":"string","maxLength":12,"description":"Postal"},"address1":{"type":"string","maxLength":254,"description":"Address"},"address2":{"type":"string","maxLength":254,"description":"Address 2"},"address3":{"type":"string","maxLength":254,"description":"Address 3"},"address4":{"type":"string","maxLength":254,"description":"Address 4"},"streetNumber1":{"type":"string","maxLength":6,"description":"Number 1"},"streetNumber2":{"type":"string","maxLength":4,"description":"Number 2"},"city":{"type":"string","maxLength":90,"description":"City"},"county":{"type":"string","maxLength":90,"description":"County"},"state":{"type":"string","maxLength":6,"description":"State"},"houseType":{"type":"string","enum":["AB  ","WW  "],"description":"House Type indicates the type of house.\n* `AB  ` - House Boat References,\n* `WW  ` - House Trailer Reference"},"isInCityLimit":{"type":"boolean","description":"In City Limit indicates if the address is considered within the physical city limits. A value of true indicates within city limits."},"taxVendorGeographicalCode":{"type":"string","maxLength":11,"description":"Geographical Code is used to apply proper taxation rules to the physical address location."}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"}}}}}},"characteristics":{"type":"object","description":"Configured additional attributes for any additional information that needs to be maintained for persons.","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"effectiveDate":{"type":"string","format":"date","description":"Effective Date defines the date on which the characteristic becomes effective."},"characteristicType":{"type":"object","properties":{"characteristicType":{"type":"string","maxLength":8,"description":"Characteristic Type"}}},"characteristicValue":{"type":"object","properties":{"_link":{"type":"string","description":"(_link)"},"value":{"type":"string","description":"(value)"},"value2":{"type":"string","description":"(value2)"},"value3":{"type":"string","description":"(value3)"},"value4":{"type":"string","description":"(value4)"},"value5":{"type":"string","description":"(value5)"}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"}}}}}},"identifiers":{"type":"object","description":"Identifiers are used for validating the identity of a customer based on their provided form of identification.","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"idType":{"type":"object","properties":{"idType":{"type":"string","maxLength":8,"description":"ID Type indicates the type of identification and receives a default value from the Installation Record based on the Person Type."}}},"idNumber":{"type":"string","maxLength":100,"description":"ID Number"},"isPrimaryId":{"type":"boolean","description":"Primary ID switch is true if this is the primary means of identification for the customer.","example":"false"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"}}}}}},"names":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"sequence":{"type":"number","maximum":999,"minimum":-999,"description":"A sequence is used to define the order of the records."},"personName":{"type":"string","maxLength":254,"description":"Person Name captures the person's name. The name is case-sensitive."},"nameType":{"type":"string","enum":["AL  ","ALT ","DBA ","FORM","LGAL","PRIM"],"description":"Name Type indicates if the name is an Alias, Alternate Representation, Doing Business As, Legal, or Primary name. Note, for new persons, a value of Primary is the default value. The values for the name type field are customizable using the applicable lookup table.\n* `AL  ` - Alias,\n* `ALT ` - Alternate Representation,\n* `DBA ` - Doing Business As,\n* `FORM` - Former,\n* `LGAL` - Legal,\n* `PRIM` - Primary","example":"PRIM (Primary)"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"},"isPrimaryName":{"type":"boolean","description":"Primary Name is defined as true if this is the primary name for the customer.","example":"true"}}}}}},"relationships":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"childPersonId":{"type":"string","maxLength":10,"description":"Person ID"},"personRelationshipType":{"type":"object","properties":{"personRelationshipType":{"type":"string","maxLength":8,"description":"Relationship Type"}}},"startDate":{"type":"string","format":"date","description":"Start Date indicates the date on which this relationship began.","example":"1950-01-01"},"endDate":{"type":"string","format":"date","description":"End Date indicates the relationship expires, indicate the date the relationship stops.","example":"1950-01-01"},"hasFinancialRelationship":{"type":"boolean","description":"Financial Relationship indicates if the child person is related to accounts which should be displayed in the parent person's hierarchy.","example":"false"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"}}}}}}},"xml":{"name":"C1-Person"}},"CREATEPERSON_response":{"type":"object","properties":{"_self":{"type":"string","description":"_self"},"personId":{"type":"string","maxLength":10,"description":"Person ID is a system-assigned random number that stays with a person for the life of the system.","example":"5775933103"},"personOrBusiness":{"type":"string","enum":["B   ","P   "],"description":"Defines the person entity as a person or business which controls validation of the person entity's primary name.\n* `B   ` - Business,\n* `P   ` - Person"},"lifeSupportSensitiveLoad":{"type":"string","enum":["N   ","Y   "],"description":"Life Support / Sensitive Load indicates if the person has life support or sensitive load equipment.\n* `N   ` - None,\n* `Y   ` - LS/SL","example":"N"},"lifeSupportSensitiveLoadDescription":{"type":"string","maxLength":1000,"description":"Life Support or Sensitive Load Description supports additional notes for life support information or equipment associated with the person."},"emailAddress":{"type":"string","maxLength":254,"description":"Email Address"},"overrideMailingName1":{"type":"string","maxLength":254,"description":"Override Mailing Name for addressee on the person's correspondence and bills."},"overrideMailingAddress":{"type":"object","description":"Override Mailing Address if the person wants their bills, letters, quotes, and statements sent to an address other than their service addresses. For example, a post office box. The address constituents may differ depending on the Country.","properties":{"address1":{"type":"string","maxLength":254,"description":"Address"},"address2":{"type":"string","maxLength":254,"description":"Address 2"},"address3":{"type":"string","maxLength":254,"description":"Address 3"},"address4":{"type":"string","maxLength":254,"description":"Address 4"},"city":{"type":"string","maxLength":90,"description":"City"},"streetNumber1":{"type":"string","maxLength":6,"description":"Number 1"},"streetNumber2":{"type":"string","maxLength":4,"description":"Number 2"},"county":{"type":"string","maxLength":90,"description":"County"},"postal":{"type":"string","maxLength":12,"description":"Postal"},"state":{"type":"string","maxLength":6,"description":"State"},"country":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"country":{"type":"string","maxLength":3,"description":"Country"}}},"houseType":{"type":"string","enum":["AB  ","WW  "],"description":"House Type indicates the type of house.\n* `AB  ` - House Boat References,\n* `WW  ` - House Trailer Reference"},"taxVendorGeographicalCode":{"type":"string","maxLength":11,"description":"Geographical Code is used to apply proper taxation rules to the physical address location."},"isInCityLimit":{"type":"boolean","description":"In City Limit indicates if the address is considered within the physical city limits. A value of true indicates within city limits."}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"},"language":{"type":"object","description":"Language in which the person prefers their bills and correspondences.","properties":{"_link":{"type":"string","description":"_link"},"language":{"type":"string","maxLength":3,"description":"Language in which the person prefers their bills and correspondences.","example":"ENG"}}},"overrideMailingName2":{"type":"string","maxLength":254,"description":"Override Mailing Name Line 2 for addressee on the person's correspondence and bills."},"overrideMailingName3":{"type":"string","maxLength":254,"description":"Override Mailing Name Line 3 for addressee on the person's correspondence and bills."},"timeZone":{"type":"object","description":"Defines the person's Time Zone preference if it is different from the system installation's time zone.","properties":{"_link":{"type":"string","description":"_link"},"timeZone":{"type":"string","maxLength":10,"description":"Defines the person's Time Zone preference if it is different from the system installation's time zone."}}},"contactDetails":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"contactDetailId":{"type":"string","maxLength":10,"description":"Person Contact"},"contactDetailValue":{"type":"string","maxLength":254,"description":"Contact Detail Value contains the specific contact information such as, the phone number or email address in the associated format.","example":"krish11@yahoo.com,\n\n(415) 987-1298"},"contactDetailStatus":{"type":"string","enum":["C1AP","C1PN","C1RJ","ZZBN","ZZPE"],"description":"Contact Status indicates the option contact's status. The initial status can be defined from the Person Contact Type and manually maintained, or configured to be controlled by a process such as an Opt-In process.\n* `C1AP` - Approved,\n* `C1PN` - Pending,\n* `C1RJ` - Rejected,\n* `ZZBN` - ZZBounced,\n* `ZZPE` - ZZPending","example":"Contact Status:\n\n    C1AP - Approved,\n    C1PN - Pending,\n    C1RJ - Rejected"},"contactDetailValueExtension":{"type":"string","maxLength":6,"description":"Extension, if any, of the contact information. (This field is only active when the contact's contact routing is phone or fax.)"},"contactDetailActiveInactive":{"type":"string","enum":["C1AC","C1IN"],"description":"Most contact preferences will remain active. When a contact is no longer valid, the existing contact should be updated to Inactive.\n* `C1AC` - Active,\n* `C1IN` - Inactive","example":"Active/Inactive:\n\n    C1AC - Active,\n    C1IN - Inactive"},"contactDetailPrimary":{"type":"string","enum":["C1NO","C1YS"],"description":"Primary switch must be set for exactly one person contact for each contact routing.\n* `C1NO` - No,\n* `C1YS` - Yes","example":"Primary:\n\n    C1NO - No,\n    C1YS - Yes"},"contactNickname":{"type":"string","maxLength":100,"description":"Contact Nickname can be assigned by self-service users."},"personContactType":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"personContactType":{"type":"string","maxLength":30,"description":"Person Contact Type"}}},"doNotDisturbStartDate":{"type":"string","description":"Do Not Disturb (From)"},"doNotDisturbEndDate":{"type":"string","description":"Do Not Disturb (To)"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"}}}}}},"paymentOptions":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"selfServicePaymentOptionId":{"type":"string","maxLength":12,"description":"Payment Option ID is a system-assigned random number for the record."},"paymentType":{"type":"string","enum":["27  ","28  ","37  ","38  ","47  "],"description":"Payment type is a two-digit code that indicates the banking transaction as a debit or credit and type of financial account.\n* `27  ` - Checking Withdrawal,\n* `28  ` - Checking Debit Prenotification,\n* `37  ` - Savings Withdrawal,\n* `38  ` - Savings Debit Prenotification,\n* `47  ` - Credit Card Withdrawal","example":"47 (Credit Card Withdrawal)"},"creditCardInfo":{"type":"object","properties":{"cardType":{"type":"string","enum":["C1AM","C1DV","C1MC","C1VS"],"description":"Card type indicates the credit card processing network such as American Express, Discover, MasterCard, or Visa.\n* `C1AM` - American Express,\n* `C1DV` - Discover,\n* `C1MC` - MasterCard,\n* `C1VS` - Visa","example":"C1AM"},"cardNumber":{"type":"string","maxLength":60,"description":"Number of the credit card."},"expiryMonth":{"type":"string","maxLength":2,"description":"Credit card expiration month."},"expiryYear":{"type":"string","maxLength":4,"description":"Credit card expiration year"},"cardHolderFirstName":{"type":"string","maxLength":50,"description":"Cardholder First Name"},"cardHolderLastName":{"type":"string","maxLength":50,"description":"Credit card holder Last Name"},"addressLine1":{"type":"string","maxLength":254,"description":"Address"},"addressLine2":{"type":"string","maxLength":254,"description":"Address 2"},"addressLine3":{"type":"string","maxLength":254,"description":"Address 3"},"addressLine4":{"type":"string","maxLength":254,"description":"Address 4"},"streetNumber1":{"type":"string","maxLength":6,"description":"Number 1"},"streetNumber2":{"type":"string","maxLength":4,"description":"Number 2"},"city":{"type":"string","maxLength":90,"description":"City"},"county":{"type":"string","maxLength":90,"description":"County"},"postal":{"type":"string","maxLength":12,"description":"Postal"},"state":{"type":"string","maxLength":6,"description":"State"}}},"bankAccountInfo":{"type":"object","properties":{"routingNumber":{"type":"string","maxLength":30,"description":"The routing number identifies the bank or financial institution for payment transactions."},"accountNumber":{"type":"string","maxLength":50,"description":"The account number to be used for payment transactions.","example":"1223428263"},"autoPaySource":{"type":"string","maxLength":12,"description":"Auto Pay Source"}}}}}}}},"seasonalAddresses":{"type":"object","description":"Seasonal Addresses are used if the person wants their correspondence sent to an alternate address during predefined seasonal periods.","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"sequence":{"type":"number","maximum":999,"minimum":-999,"description":"A sequence is used to define the order of the records."},"effectiveStatus":{"type":"string","enum":["A   ","I   "],"description":"Status of the address must be Active to be used. The status can be set to Inactive for the seasonal address to be ignored.\n* `A   ` - Active,\n* `I   ` - Inactive","example":"Status:\n\n    A - Active,\n    I - Inactive"},"startMonthDay":{"type":"string","maxLength":4,"description":"Start Month Day contains the day and month when the season starts.","example":"0201"},"endMonthDay":{"type":"string","maxLength":4,"description":"End Month Day contains the day and month when the season ends.","example":"1231"},"address":{"type":"object","properties":{"country":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"country":{"type":"string","maxLength":3,"description":"Country"}}},"postal":{"type":"string","maxLength":12,"description":"Postal"},"address1":{"type":"string","maxLength":254,"description":"Address"},"address2":{"type":"string","maxLength":254,"description":"Address 2"},"address3":{"type":"string","maxLength":254,"description":"Address 3"},"address4":{"type":"string","maxLength":254,"description":"Address 4"},"streetNumber1":{"type":"string","maxLength":6,"description":"Number 1"},"streetNumber2":{"type":"string","maxLength":4,"description":"Number 2"},"city":{"type":"string","maxLength":90,"description":"City"},"county":{"type":"string","maxLength":90,"description":"County"},"state":{"type":"string","maxLength":6,"description":"State"},"houseType":{"type":"string","enum":["AB  ","WW  "],"description":"House Type indicates the type of house.\n* `AB  ` - House Boat References,\n* `WW  ` - House Trailer Reference"},"isInCityLimit":{"type":"boolean","description":"In City Limit indicates if the address is considered within the physical city limits. A value of true indicates within city limits."},"taxVendorGeographicalCode":{"type":"string","maxLength":11,"description":"Geographical Code is used to apply proper taxation rules to the physical address location."}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"}}}}}},"characteristics":{"type":"object","description":"Configured additional attributes for any additional information that needs to be maintained for persons.","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"effectiveDate":{"type":"string","format":"date","description":"Effective Date defines the date on which the characteristic becomes effective."},"characteristicType":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"characteristicType":{"type":"string","maxLength":8,"description":"Characteristic Type"}}},"typeOfCharacteristicValue":{"type":"string","maxLength":4,"description":"Type of Char Value"},"characteristicValue":{"type":"object","properties":{"_link":{"type":"string","description":"(_link)"},"value":{"type":"string","description":"(value)"},"value2":{"type":"string","description":"(value2)"},"value3":{"type":"string","description":"(value3)"},"value4":{"type":"string","description":"(value4)"},"value5":{"type":"string","description":"(value5)"}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"}}}}}},"identifiers":{"type":"object","description":"Identifiers are used for validating the identity of a customer based on their provided form of identification.","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"idType":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"idType":{"type":"string","maxLength":8,"description":"ID Type indicates the type of identification and receives a default value from the Installation Record based on the Person Type."}}},"idNumber":{"type":"string","maxLength":100,"description":"ID Number"},"isPrimaryId":{"type":"boolean","description":"Primary ID switch is true if this is the primary means of identification for the customer.","example":"false"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"}}}}}},"names":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"sequence":{"type":"number","maximum":999,"minimum":-999,"description":"A sequence is used to define the order of the records."},"personName":{"type":"string","maxLength":254,"description":"Person Name captures the person's name. The name is case-sensitive."},"nameType":{"type":"string","enum":["AL  ","ALT ","DBA ","FORM","LGAL","PRIM"],"description":"Name Type indicates if the name is an Alias, Alternate Representation, Doing Business As, Legal, or Primary name. Note, for new persons, a value of Primary is the default value. The values for the name type field are customizable using the applicable lookup table.\n* `AL  ` - Alias,\n* `ALT ` - Alternate Representation,\n* `DBA ` - Doing Business As,\n* `FORM` - Former,\n* `LGAL` - Legal,\n* `PRIM` - Primary","example":"PRIM (Primary)"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"},"isPrimaryName":{"type":"boolean","description":"Primary Name is defined as true if this is the primary name for the customer.","example":"true"}}}}}},"relationships":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"childPersonId":{"type":"string","maxLength":10,"description":"Person ID"},"personRelationshipType":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"personRelationshipType":{"type":"string","maxLength":8,"description":"Relationship Type"}}},"startDate":{"type":"string","format":"date","description":"Start Date indicates the date on which this relationship began.","example":"1950-01-01"},"endDate":{"type":"string","format":"date","description":"End Date indicates the relationship expires, indicate the date the relationship stops.","example":"1950-01-01"},"hasFinancialRelationship":{"type":"boolean","description":"Financial Relationship indicates if the child person is related to accounts which should be displayed in the parent person's hierarchy.","example":"false"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"}}}}}}},"xml":{"name":"C1-Person"}},"UPDATEPERSON_response":{"type":"object","properties":{"_self":{"type":"string","description":"_self"},"personId":{"type":"string","maxLength":10,"description":"Person ID is a system-assigned random number that stays with a person for the life of the system.","example":"5775933103"},"personOrBusiness":{"type":"string","enum":["B   ","P   "],"description":"Defines the person entity as a person or business which controls validation of the person entity's primary name.\n* `B   ` - Business,\n* `P   ` - Person"},"lifeSupportSensitiveLoad":{"type":"string","enum":["N   ","Y   "],"description":"Life Support / Sensitive Load indicates if the person has life support or sensitive load equipment.\n* `N   ` - None,\n* `Y   ` - LS/SL","example":"N"},"lifeSupportSensitiveLoadDescription":{"type":"string","maxLength":1000,"description":"Life Support or Sensitive Load Description supports additional notes for life support information or equipment associated with the person."},"emailAddress":{"type":"string","maxLength":254,"description":"Email Address"},"overrideMailingName1":{"type":"string","maxLength":254,"description":"Override Mailing Name for addressee on the person's correspondence and bills."},"overrideMailingAddress":{"type":"object","description":"Override Mailing Address if the person wants their bills, letters, quotes, and statements sent to an address other than their service addresses. For example, a post office box. The address constituents may differ depending on the Country.","properties":{"address1":{"type":"string","maxLength":254,"description":"Address"},"address2":{"type":"string","maxLength":254,"description":"Address 2"},"address3":{"type":"string","maxLength":254,"description":"Address 3"},"address4":{"type":"string","maxLength":254,"description":"Address 4"},"city":{"type":"string","maxLength":90,"description":"City"},"streetNumber1":{"type":"string","maxLength":6,"description":"Number 1"},"streetNumber2":{"type":"string","maxLength":4,"description":"Number 2"},"county":{"type":"string","maxLength":90,"description":"County"},"postal":{"type":"string","maxLength":12,"description":"Postal"},"state":{"type":"string","maxLength":6,"description":"State"},"country":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"country":{"type":"string","maxLength":3,"description":"Country"}}},"houseType":{"type":"string","enum":["AB  ","WW  "],"description":"House Type indicates the type of house.\n* `AB  ` - House Boat References,\n* `WW  ` - House Trailer Reference"},"taxVendorGeographicalCode":{"type":"string","maxLength":11,"description":"Geographical Code is used to apply proper taxation rules to the physical address location."},"isInCityLimit":{"type":"boolean","description":"In City Limit indicates if the address is considered within the physical city limits. A value of true indicates within city limits."}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"},"language":{"type":"object","description":"Language in which the person prefers their bills and correspondences.","properties":{"_link":{"type":"string","description":"_link"},"language":{"type":"string","maxLength":3,"description":"Language in which the person prefers their bills and correspondences.","example":"ENG"}}},"overrideMailingName2":{"type":"string","maxLength":254,"description":"Override Mailing Name Line 2 for addressee on the person's correspondence and bills."},"overrideMailingName3":{"type":"string","maxLength":254,"description":"Override Mailing Name Line 3 for addressee on the person's correspondence and bills."},"timeZone":{"type":"object","description":"Defines the person's Time Zone preference if it is different from the system installation's time zone.","properties":{"_link":{"type":"string","description":"_link"},"timeZone":{"type":"string","maxLength":10,"description":"Defines the person's Time Zone preference if it is different from the system installation's time zone."}}},"contactDetails":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"contactDetailId":{"type":"string","maxLength":10,"description":"Person Contact"},"contactDetailValue":{"type":"string","maxLength":254,"description":"Contact Detail Value contains the specific contact information such as, the phone number or email address in the associated format.","example":"krish11@yahoo.com,\n\n(415) 987-1298"},"contactDetailStatus":{"type":"string","enum":["C1AP","C1PN","C1RJ","ZZBN","ZZPE"],"description":"Contact Status indicates the option contact's status. The initial status can be defined from the Person Contact Type and manually maintained, or configured to be controlled by a process such as an Opt-In process.\n* `C1AP` - Approved,\n* `C1PN` - Pending,\n* `C1RJ` - Rejected,\n* `ZZBN` - ZZBounced,\n* `ZZPE` - ZZPending","example":"Contact Status:\n\n    C1AP - Approved,\n    C1PN - Pending,\n    C1RJ - Rejected"},"contactDetailValueExtension":{"type":"string","maxLength":6,"description":"Extension, if any, of the contact information. (This field is only active when the contact's contact routing is phone or fax.)"},"contactDetailActiveInactive":{"type":"string","enum":["C1AC","C1IN"],"description":"Most contact preferences will remain active. When a contact is no longer valid, the existing contact should be updated to Inactive.\n* `C1AC` - Active,\n* `C1IN` - Inactive","example":"Active/Inactive:\n\n    C1AC - Active,\n    C1IN - Inactive"},"contactDetailPrimary":{"type":"string","enum":["C1NO","C1YS"],"description":"Primary switch must be set for exactly one person contact for each contact routing.\n* `C1NO` - No,\n* `C1YS` - Yes","example":"Primary:\n\n    C1NO - No,\n    C1YS - Yes"},"contactNickname":{"type":"string","maxLength":100,"description":"Contact Nickname can be assigned by self-service users."},"personContactType":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"personContactType":{"type":"string","maxLength":30,"description":"Person Contact Type"}}},"doNotDisturbStartDate":{"type":"string","description":"Do Not Disturb (From)"},"doNotDisturbEndDate":{"type":"string","description":"Do Not Disturb (To)"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"}}}}}},"paymentOptions":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"selfServicePaymentOptionId":{"type":"string","maxLength":12,"description":"Payment Option ID is a system-assigned random number for the record."},"paymentType":{"type":"string","enum":["27  ","28  ","37  ","38  ","47  "],"description":"Payment type is a two-digit code that indicates the banking transaction as a debit or credit and type of financial account.\n* `27  ` - Checking Withdrawal,\n* `28  ` - Checking Debit Prenotification,\n* `37  ` - Savings Withdrawal,\n* `38  ` - Savings Debit Prenotification,\n* `47  ` - Credit Card Withdrawal","example":"47 (Credit Card Withdrawal)"},"creditCardInfo":{"type":"object","properties":{"cardType":{"type":"string","enum":["C1AM","C1DV","C1MC","C1VS"],"description":"Card type indicates the credit card processing network such as American Express, Discover, MasterCard, or Visa.\n* `C1AM` - American Express,\n* `C1DV` - Discover,\n* `C1MC` - MasterCard,\n* `C1VS` - Visa","example":"C1AM"},"cardNumber":{"type":"string","maxLength":60,"description":"Number of the credit card."},"expiryMonth":{"type":"string","maxLength":2,"description":"Credit card expiration month."},"expiryYear":{"type":"string","maxLength":4,"description":"Credit card expiration year"},"cardHolderFirstName":{"type":"string","maxLength":50,"description":"Cardholder First Name"},"cardHolderLastName":{"type":"string","maxLength":50,"description":"Credit card holder Last Name"},"addressLine1":{"type":"string","maxLength":254,"description":"Address"},"addressLine2":{"type":"string","maxLength":254,"description":"Address 2"},"addressLine3":{"type":"string","maxLength":254,"description":"Address 3"},"addressLine4":{"type":"string","maxLength":254,"description":"Address 4"},"streetNumber1":{"type":"string","maxLength":6,"description":"Number 1"},"streetNumber2":{"type":"string","maxLength":4,"description":"Number 2"},"city":{"type":"string","maxLength":90,"description":"City"},"county":{"type":"string","maxLength":90,"description":"County"},"postal":{"type":"string","maxLength":12,"description":"Postal"},"state":{"type":"string","maxLength":6,"description":"State"}}},"bankAccountInfo":{"type":"object","properties":{"routingNumber":{"type":"string","maxLength":30,"description":"The routing number identifies the bank or financial institution for payment transactions."},"accountNumber":{"type":"string","maxLength":50,"description":"The account number to be used for payment transactions.","example":"1223428263"},"autoPaySource":{"type":"string","maxLength":12,"description":"Auto Pay Source"}}}}}}}},"seasonalAddresses":{"type":"object","description":"Seasonal Addresses are used if the person wants their correspondence sent to an alternate address during predefined seasonal periods.","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"sequence":{"type":"number","maximum":999,"minimum":-999,"description":"A sequence is used to define the order of the records."},"effectiveStatus":{"type":"string","enum":["A   ","I   "],"description":"Status of the address must be Active to be used. The status can be set to Inactive for the seasonal address to be ignored.\n* `A   ` - Active,\n* `I   ` - Inactive","example":"Status:\n\n    A - Active,\n    I - Inactive"},"startMonthDay":{"type":"string","maxLength":4,"description":"Start Month Day contains the day and month when the season starts.","example":"0201"},"endMonthDay":{"type":"string","maxLength":4,"description":"End Month Day contains the day and month when the season ends.","example":"1231"},"address":{"type":"object","properties":{"country":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"country":{"type":"string","maxLength":3,"description":"Country"}}},"postal":{"type":"string","maxLength":12,"description":"Postal"},"address1":{"type":"string","maxLength":254,"description":"Address"},"address2":{"type":"string","maxLength":254,"description":"Address 2"},"address3":{"type":"string","maxLength":254,"description":"Address 3"},"address4":{"type":"string","maxLength":254,"description":"Address 4"},"streetNumber1":{"type":"string","maxLength":6,"description":"Number 1"},"streetNumber2":{"type":"string","maxLength":4,"description":"Number 2"},"city":{"type":"string","maxLength":90,"description":"City"},"county":{"type":"string","maxLength":90,"description":"County"},"state":{"type":"string","maxLength":6,"description":"State"},"houseType":{"type":"string","enum":["AB  ","WW  "],"description":"House Type indicates the type of house.\n* `AB  ` - House Boat References,\n* `WW  ` - House Trailer Reference"},"isInCityLimit":{"type":"boolean","description":"In City Limit indicates if the address is considered within the physical city limits. A value of true indicates within city limits."},"taxVendorGeographicalCode":{"type":"string","maxLength":11,"description":"Geographical Code is used to apply proper taxation rules to the physical address location."}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"}}}}}},"characteristics":{"type":"object","description":"Configured additional attributes for any additional information that needs to be maintained for persons.","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"effectiveDate":{"type":"string","format":"date","description":"Effective Date defines the date on which the characteristic becomes effective."},"characteristicType":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"characteristicType":{"type":"string","maxLength":8,"description":"Characteristic Type"}}},"typeOfCharacteristicValue":{"type":"string","maxLength":4,"description":"Type of Char Value"},"characteristicValue":{"type":"object","properties":{"_link":{"type":"string","description":"(_link)"},"value":{"type":"string","description":"(value)"},"value2":{"type":"string","description":"(value2)"},"value3":{"type":"string","description":"(value3)"},"value4":{"type":"string","description":"(value4)"},"value5":{"type":"string","description":"(value5)"}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"}}}}}},"identifiers":{"type":"object","description":"Identifiers are used for validating the identity of a customer based on their provided form of identification.","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"idType":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"idType":{"type":"string","maxLength":8,"description":"ID Type indicates the type of identification and receives a default value from the Installation Record based on the Person Type."}}},"idNumber":{"type":"string","maxLength":100,"description":"ID Number"},"isPrimaryId":{"type":"boolean","description":"Primary ID switch is true if this is the primary means of identification for the customer.","example":"false"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"}}}}}},"names":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"sequence":{"type":"number","maximum":999,"minimum":-999,"description":"A sequence is used to define the order of the records."},"personName":{"type":"string","maxLength":254,"description":"Person Name captures the person's name. The name is case-sensitive."},"nameType":{"type":"string","enum":["AL  ","ALT ","DBA ","FORM","LGAL","PRIM"],"description":"Name Type indicates if the name is an Alias, Alternate Representation, Doing Business As, Legal, or Primary name. Note, for new persons, a value of Primary is the default value. The values for the name type field are customizable using the applicable lookup table.\n* `AL  ` - Alias,\n* `ALT ` - Alternate Representation,\n* `DBA ` - Doing Business As,\n* `FORM` - Former,\n* `LGAL` - Legal,\n* `PRIM` - Primary","example":"PRIM (Primary)"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"},"isPrimaryName":{"type":"boolean","description":"Primary Name is defined as true if this is the primary name for the customer.","example":"true"}}}}}},"relationships":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"childPersonId":{"type":"string","maxLength":10,"description":"Person ID"},"personRelationshipType":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"personRelationshipType":{"type":"string","maxLength":8,"description":"Relationship Type"}}},"startDate":{"type":"string","format":"date","description":"Start Date indicates the date on which this relationship began.","example":"1950-01-01"},"endDate":{"type":"string","format":"date","description":"End Date indicates the relationship expires, indicate the date the relationship stops.","example":"1950-01-01"},"hasFinancialRelationship":{"type":"boolean","description":"Financial Relationship indicates if the child person is related to accounts which should be displayed in the parent person's hierarchy.","example":"false"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"}}}}}}},"xml":{"name":"C1-Person"}},"DELETEPERSON_response":{"type":"object","properties":{"personId":{"type":"string","maxLength":10,"description":"Person ID is a system-assigned random number that stays with a person for the life of the system.","example":"5775933103"}},"xml":{"name":"C1-DelPerson"}},"UPDATEPAYMENTEVENT_request":{"type":"object","properties":{"paymentEventId":{"type":"string","maxLength":12,"description":"Payment Event ID is the system-assigned unique identifier of the payment event.","example":"317772795000"},"payorAccount":{"type":"object","properties":{"payorAccountId":{"type":"string","maxLength":10,"description":"Account ID"}}},"matchType":{"type":"string","maxLength":8,"description":"Match Type and Match Value should only be used if either of the following conditions is true:\n\n        This Account ID belongs to an open item customer class. In this situation, specify a Match Type to define how the payment should be matched to the customer's open-items and use Match Value to define the open-items covered by the payment. \n        The customer wants to restrict the distribution of the payment to a specific service agreement. In this situation, specify a Match Type of \"service agreement ID\" and a Match Value of the respective service agreement ID.","example":"BILL-ID\n\n(Bill ID / Sequential Bill Number)"},"matchValue":{"type":"string","maxLength":30,"description":"Match Type and Match Value should only be used if either of the following conditions is true:\n\n        This Account ID belongs to an open item customer class. In this situation, specify a Match Type to define how the payment should be matched to the customer's open-items and use Match Value to define the open-items covered by the payment. \n        The customer wants to restrict the distribution of the payment to a specific service agreement. In this situation, specify a Match Type of \"service agreement ID\" and a Match Value of the respective service agreement ID.","example":"995516242555"},"paymentAmount":{"type":"number","description":"Payment Amount"},"totTenderAmt":{"type":"number","maximum":0,"minimum":0,"description":"Total Tender Amount is the total amount of all tenders linked to the tender control."},"nonCisName":{"type":"string","maxLength":50,"description":"Non CIS Name"},"referenceNumber":{"type":"string","maxLength":30,"description":"Reference Number"},"nonCisComments":{"type":"string","maxLength":254,"description":"Non CIS Comments"},"isNonCisAccount":{"type":"boolean","description":"Non CIS Switch is turned on if the payment is linked to an Account ID that belongs to a customer class that is used for non-CIS payments."},"nonCisSaId":{"type":"string","maxLength":10,"description":"Non CIS Service Agreement ID for account that belongs to a customer class that is used for non-CIS payments."},"paymentTemplate":{"type":"string","maxLength":12,"description":"Payment Templates can be configured for common types of payment allocations to pre-populate the payment distribution and allowing non-CIS payments to be directly allocated against distribution codes."},"bank":{"type":"string","maxLength":5,"description":"Define the Bank Code and Bank Account into which the tender source's moneys will be deposited. The bank account defines the distribution code used to build the GL details for the payment."},"tenderSource":{"type":"string","maxLength":8,"description":"Tender Source is the source of the tenders (e.g., cash drawer 22, lockbox 1 at Bank of America).","example":"ACH \n\n(Auto pay)"},"shouldOverrideTenderAuthorization":{"type":"boolean","description":"The Authorization Override checkbox is only displayed if the tender type selected requires authorization. Use the Authorization override checkbox to indicate whether or not tender authorization should take place. If Authorization override is checked, an authorization code must be entered and the system bypasses the authorization web service call."},"tenderAuthorizationCode":{"type":"string","maxLength":60,"description":"If authorization override is checked, an authorization code must be entered and the system bypasses the authorization web service call."},"tenderReversal":{"type":"string","maxLength":10,"description":"Tender Reversal Code"},"payEventAlternateCurrency":{"type":"object","properties":{"payEventAlternateCurrency":{"type":"string","maxLength":1,"description":"Pay Event Alternate Currency Info"}}},"account":{"type":"object","properties":{"accountId":{"type":"string","maxLength":10,"description":"Account ID"}}},"transferNonCisName":{"type":"string","maxLength":50,"description":"Following parameters must be specified in the Payment Event Transfer dialog to transfer a payment - Non CIS Name, Reference Number, and Non CIS Comments.\n\nNon CIS Name, Reference Number, and Non CIS Comments appear if the Account ID belongs to a customer class that is used for non-CIS payments."},"transferNonCisReferenceNumber":{"type":"string","maxLength":30,"description":"Following parameters must be specified in the Payment Event Transfer dialog to transfer a payment - Non CIS Name, Reference Number, and Non CIS Comments.\n\nNon CIS Name, Reference Number, and Non CIS Comments appear if the Account ID belongs to a customer class that is used for non-CIS payments."},"transferNonCISComment":{"type":"string","maxLength":254,"description":"Following parameters must be specified in the Payment Event Transfer dialog to transfer a payment - Non CIS Name, Reference Number, and Non CIS Comments.\n\nNon CIS Name, Reference Number, and Non CIS Comments appear if the Account ID belongs to a customer class that is used for non-CIS payments."},"cancelReason":{"type":"object","properties":{"cancelReason":{"type":"string","maxLength":4,"description":"Cancel Reason"}}},"paymentTotalAmount":{"type":"number","description":"Payment Total Amount"},"tenderTotalAmount":{"type":"number","description":"Tender Amount contains the amount of the tender."},"numberOfPayments":{"type":"number","maximum":999999999999999,"minimum":0,"description":"Payment Number"},"numberOfTenders":{"type":"number","maximum":999999999999999,"minimum":0,"description":"Tender Number"},"currency":{"type":"object","properties":{"currency":{"type":"string","maxLength":3,"description":"Currency Code"}}},"characteristicValueDescription":{"type":"string","maxLength":60,"description":"Char Value Description"},"characteristicValueForeignKeys":{"type":"string","maxLength":254,"description":"Characteristic Value Foreign Keys"},"characteristicValueForeignKeyInformation":{"type":"string","maxLength":254,"description":"Characteristic Value Foreign Key Information"},"charateristicValue":{"type":"string","maxLength":150,"description":"Characteristic Value Indicate the value of the characteristic."},"user":{"type":"object","description":"USER ID","properties":{"user":{"type":"string","maxLength":8,"description":"USER ID"}}},"description":{"type":"string","maxLength":60,"description":"Description"},"accountNumber":{"type":"string","maxLength":50,"description":"Account Number"},"account2":{"type":"object","properties":{"accountId2":{"type":"string","maxLength":30,"description":"Account ID references the payment's account. The name of the account's main customer is displayed adjacent."}}},"paymentDate":{"type":"string","format":"date","description":"Payment Date is the business date associated with the payment event."},"creationDateTime":{"type":"string","format":"date-time","description":"Create Date/Time"},"document":{"type":"object","properties":{"documentId":{"type":"string","maxLength":30,"description":"Document ID"}}},"accountT":{"type":"object","properties":{"accountIdT":{"type":"string","maxLength":10,"description":"Account ID references the payment's account. The name of the account's main customer is displayed adjacent."}}},"paymentEventId2":{"type":"string","maxLength":30,"description":"Payment Event ID is the system-assigned unique identifier of the payment event.","example":"755669969777"},"entityName2":{"type":"string","maxLength":254,"description":"Name"},"account3":{"type":"object","properties":{"acctId3":{"type":"string","maxLength":10,"description":"Reversal Account ID"}}},"paymentEventException":{"type":"string","maxLength":254,"description":"Message"},"hasTransfer":{"type":"boolean","description":"(hasTransfer)"},"canDistribute":{"type":"boolean","description":"(canDistribute)"},"shouldAllPaymentsFreeze":{"type":"boolean","description":"(shouldAllPaymentsFreeze)"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"},"payments":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"payment":{"type":"object","properties":{"paymentId":{"type":"string","maxLength":12,"description":"Payment ID"}}},"paymentEventId2":{"type":"string","maxLength":12,"description":"Payment Event ID is the system-assigned unique identifier of the payment event.","example":"317772795000"},"cancelReason":{"type":"object","properties":{"cancelReason":{"type":"string","maxLength":4,"description":"Cancel Reason"}}},"accountId":{"type":"string","maxLength":10,"description":"Account ID"},"paymentStatus":{"type":"string","enum":["10  ","20  ","30  ","50  ","60  "],"description":"Payment Status is the payment's status. If the payment's status is Error , the error message is displayed adjacent.\n* `10  ` - Incomplete,\n* `20  ` - Error,\n* `30  ` - Freezable,\n* `50  ` - Frozen,\n* `60  ` - Canceled","example":"10"},"payStatusMessage":{"type":"string","maxLength":10,"description":"Payment Status Message"},"paymentAmount":{"type":"number","description":"Payment Amount"},"currency":{"type":"string","maxLength":3,"description":"Currency Code"},"nonCisName":{"type":"string","maxLength":50,"description":"Non CIS Name"},"referenceNumber":{"type":"string","maxLength":30,"description":"Reference Number"},"nonCisComments":{"type":"string","maxLength":254,"description":"Non CIS Comments"},"matchType":{"type":"string","maxLength":8,"description":"Match Type"},"matchValue":{"type":"string","maxLength":30,"description":"Match Value"},"paymentSegmentTotal":{"type":"number","description":"Payment Segment Total","example":"28.43"},"paymentAccountCash":{"type":"string","maxLength":30,"description":"Use Cash-Only Threshold to define the number of cash-only points a customer must have before the system warns the CSR accepting payments that the account is cash-only."},"isNonCisPayment":{"type":"boolean","description":"Non-CIS Account Switch","example":"false"},"isOpenItemAccounting":{"type":"boolean","description":"Open Item Accounting Switch","example":"false"},"bill":{"type":"object","properties":{"billId":{"type":"string","maxLength":12,"description":"Bill ID"},"billTotal":{"type":"number","description":"Bill Total"},"billDate":{"type":"string","format":"date","description":"Bill Date"}}},"paymentException":{"type":"string","maxLength":254,"description":"Message"},"paymentId":{"type":"string","maxLength":12,"description":"Payment ID"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"},"nextActions":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"_link":{"type":"string","description":"(_link)"},"actionName":{"type":"string","description":"(actionName)"}}}}}}}}}}},"paymentTenders":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"paymentTender":{"type":"object","properties":{"paymentTenderId":{"type":"string","maxLength":12,"description":"Pay Tender ID"}}},"payorAccountId":{"type":"string","maxLength":10,"description":"Account ID"},"currency":{"type":"string","maxLength":3,"description":"Currency Code"},"tenderType":{"type":"string","maxLength":4,"description":"Tender Type"},"tenderControl":{"type":"object","properties":{"tenderControlId":{"type":"string","maxLength":10,"description":"Tender Control ID"}}},"isIncludedInTenderControlBalance":{"type":"boolean","description":"Turn off Included in Tender Ctl Balance if the tender should not be included in the tender amount in the tender control's tender balance. You would turn this switch off if you canceled a tender because it was mistakenly applied to the wrong account (or the amount was wrong). This switch is only enabled if:\n\n        The tender control isn't balanced .\n        The tender is canceled"},"tenderAmount":{"type":"number","description":"Tender Amount is the amount of the tender. The amount is disabled if the payment was made in an alternate currency."},"checkNumber":{"type":"string","maxLength":10,"description":"Check Number"},"tenderStatus":{"type":"string","enum":["25  ","60  "],"description":"Tender Status is the tender's status.\n* `25  ` - Valid,\n* `60  ` - Canceled","example":"Valid"},"cancelReason":{"type":"object","properties":{"cancelReason":{"type":"string","maxLength":4,"description":"Cancel Reason"}}},"adjustment":{"type":"object","properties":{"adjustmentId":{"type":"string","maxLength":12,"description":"Adjustment ID"}}},"customerId":{"type":"string","maxLength":36,"description":"Customer ID is the customer's account ID that appeared on the interfaced payment."},"micrId":{"type":"string","maxLength":30,"description":"MICR ID"},"name":{"type":"string","maxLength":40,"description":"Name is the customer's name on the interfaced payment record."},"externalReferenceId":{"type":"string","maxLength":36,"description":"External Reference ID"},"alternateCurrency":{"type":"string","maxLength":3,"description":"Alternate Currency Code"},"externalAccountId":{"type":"string","maxLength":50,"description":"External Account ID is the customer's account number at the financial institution."},"altTenderAmount":{"type":"number","maximum":9999999999999.99,"minimum":-9999999999999.99,"description":"Alternate Amount"},"encryptedMicrId":{"type":"string","maxLength":64,"description":"Encrypted Micr ID"},"hashMicrId":{"type":"string","maxLength":88,"description":"Hash MICR ID"},"tenderTypeNonCredit":{"type":"string","description":"(tenderTypeNonCredit)"},"isTenderTypeAuthorized":{"type":"boolean","description":"(isTenderTypeAuthorized)"},"hasCashTendered":{"type":"boolean","description":"(hasCashTendered)"},"hasCancelTender":{"type":"boolean","description":"(hasCancelTender)"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"},"characteristics":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"sequence":{"type":"number","maximum":999,"minimum":-999,"description":"Sequence"},"characteristicType":{"type":"object","properties":{"characteristicType":{"type":"string","description":"(characteristicType5)"}}},"characteristicValueForeignKey":{"type":"object","properties":{"characteristicValueForeignKey":{"type":"string","description":"(characteristicValueForeignKey12)"}}},"adhocCharacteristicValue":{"type":"string","description":"(adhocCharacteristicValue2)"},"characteristicValue":{"type":"string","description":"(characteristicValue3)"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"}}}}}}}}}}},"tenderType":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"tenderedAmount":{"type":"number","description":"Amount Tendered contains the amount that was tendered by the customer."},"tenderType":{"type":"string","maxLength":4,"description":"Tender Type"},"checkNumber":{"type":"string","maxLength":10,"description":"Check Number"},"micrId":{"type":"string","maxLength":30,"description":"MICR ID"},"hashMicrId":{"type":"string","maxLength":88,"description":"Hash MICR ID"},"externalReferenceId":{"type":"string","maxLength":36,"description":"External Reference ID"},"comment":{"type":"string","maxLength":254,"description":"Use Comments to describe anything unusual about the tender control (e.g., to explain why a large over/under amount was created)."},"alternateCurrency":{"type":"object","properties":{"alternateCurrency":{"type":"string","maxLength":3,"description":"Alternate Currency Code"}}},"alternateTenderAmount":{"type":"number","maximum":9999999999999.99,"minimum":-9999999999999.99,"description":"Alternate Amount"}}}}}},"exceptions":{"type":"object","properties":{"paymentEventId":{"type":"string","maxLength":12,"description":"Payment Event ID is the system-assigned unique identifier of the payment event.","example":"317772795000"},"messageCategory2":{"type":"number","maximum":99999,"minimum":-99999,"description":"Message category within Oracle Utilities Application Framework","example":"11"},"messageNumber2":{"type":"number","maximum":99999,"minimum":-99999,"description":"Message number within Oracle Utilities Application Framework.","example":"14107"},"paymentEventExceptionType":{"type":"string","enum":["10  ","20  "],"description":"Payment Exception Type\n* `10  ` - Unbalanced Event,\n* `20  ` - Unfrozen Payment","example":"20"},"expandedMessage2":{"type":"string","maxLength":254,"description":"Message"},"messageParameter12":{"type":"string","maxLength":2000,"description":"Message Parameter","example":"."},"messageParameter22":{"type":"string","maxLength":2000,"description":"Message Parameter"},"messageParameter32":{"type":"string","maxLength":2000,"description":"Message Parameter"},"messageParameter42":{"type":"string","maxLength":2000,"description":"Message Parameter"},"messageParameter52":{"type":"string","maxLength":2000,"description":"Message Parameter"},"messageParameter62":{"type":"string","maxLength":2000,"description":"Message Parameter"},"messageParameter72":{"type":"string","maxLength":2000,"description":"Message Parameter"},"messageParameter82":{"type":"string","maxLength":2000,"description":"Message Parameter"},"messageParameter92":{"type":"string","maxLength":2000,"description":"Message Parameter"},"userId2":{"type":"string","maxLength":30,"description":"User"},"isReviewed2":{"type":"boolean","description":"Reviewed","example":"false"},"reviewUser2":{"type":"string","maxLength":8,"description":"Review User"},"reviewedDate2":{"type":"string","format":"date","description":"Review Date"},"comments2":{"type":"string","maxLength":254,"description":"Comments"},"creationDateTime2":{"type":"string","format":"date-time","description":"Create Date/Time","example":"2010-11-24T17:49:23-05:00"},"version23":{"type":"number","maximum":0,"minimum":0,"description":"Version2"}}},"characteristics":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"sequence":{"type":"number","maximum":999,"minimum":-999,"description":"Sequence"},"characteristicType":{"type":"object","properties":{"characteristicType":{"type":"string","maxLength":8,"description":"Characteristic Type"}}},"typeOfCharacteristicValue":{"type":"string","maxLength":4,"description":"Type of Char Value"},"characteristicValue":{"type":"object","properties":{"_link":{"type":"string","description":"(_link)"},"value":{"type":"string","description":"(value)"},"value2":{"type":"string","description":"(value2)"},"value3":{"type":"string","description":"(value3)"},"value4":{"type":"string","description":"(value4)"},"value5":{"type":"string","description":"(value5)"}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"}}}}}}},"xml":{"name":"C1-PayEvent"}},"GETPAYMENTEVENT_response":{"type":"object","properties":{"_self":{"type":"string","description":"_self"},"payorAccount":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"payorAccountId":{"type":"string","maxLength":10,"description":"Account ID"}}},"matchType":{"type":"string","maxLength":8,"description":"Match Type and Match Value should only be used if either of the following conditions is true:\n\n        This Account ID belongs to an open item customer class. In this situation, specify a Match Type to define how the payment should be matched to the customer's open-items and use Match Value to define the open-items covered by the payment. \n        The customer wants to restrict the distribution of the payment to a specific service agreement. In this situation, specify a Match Type of \"service agreement ID\" and a Match Value of the respective service agreement ID.","example":"BILL-ID\n\n(Bill ID / Sequential Bill Number)"},"matchValue":{"type":"string","maxLength":30,"description":"Match Type and Match Value should only be used if either of the following conditions is true:\n\n        This Account ID belongs to an open item customer class. In this situation, specify a Match Type to define how the payment should be matched to the customer's open-items and use Match Value to define the open-items covered by the payment. \n        The customer wants to restrict the distribution of the payment to a specific service agreement. In this situation, specify a Match Type of \"service agreement ID\" and a Match Value of the respective service agreement ID.","example":"995516242555"},"paymentAmount":{"type":"number","description":"Payment Amount"},"totTenderAmt":{"type":"number","maximum":0,"minimum":0,"description":"Total Tender Amount is the total amount of all tenders linked to the tender control."},"nonCisName":{"type":"string","maxLength":50,"description":"Non CIS Name"},"referenceNumber":{"type":"string","maxLength":30,"description":"Reference Number"},"nonCisComments":{"type":"string","maxLength":254,"description":"Non CIS Comments"},"isNonCisAccount":{"type":"boolean","description":"Non CIS Switch is turned on if the payment is linked to an Account ID that belongs to a customer class that is used for non-CIS payments."},"nonCisSaId":{"type":"string","maxLength":10,"description":"Non CIS Service Agreement ID for account that belongs to a customer class that is used for non-CIS payments."},"paymentTemplate":{"type":"string","maxLength":12,"description":"Payment Templates can be configured for common types of payment allocations to pre-populate the payment distribution and allowing non-CIS payments to be directly allocated against distribution codes."},"bank":{"type":"string","maxLength":5,"description":"Define the Bank Code and Bank Account into which the tender source's moneys will be deposited. The bank account defines the distribution code used to build the GL details for the payment."},"tenderSource":{"type":"string","maxLength":8,"description":"Tender Source is the source of the tenders (e.g., cash drawer 22, lockbox 1 at Bank of America).","example":"ACH \n\n(Auto pay)"},"shouldOverrideTenderAuthorization":{"type":"boolean","description":"The Authorization Override checkbox is only displayed if the tender type selected requires authorization. Use the Authorization override checkbox to indicate whether or not tender authorization should take place. If Authorization override is checked, an authorization code must be entered and the system bypasses the authorization web service call."},"tenderAuthorizationCode":{"type":"string","maxLength":60,"description":"If authorization override is checked, an authorization code must be entered and the system bypasses the authorization web service call."},"tenderReversal":{"type":"string","maxLength":10,"description":"Tender Reversal Code"},"payEventAlternateCurrency":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"payEventAlternateCurrency":{"type":"string","maxLength":1,"description":"Pay Event Alternate Currency Info"}}},"account":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"accountId":{"type":"string","maxLength":10,"description":"Account ID"}}},"transferNonCisName":{"type":"string","maxLength":50,"description":"Following parameters must be specified in the Payment Event Transfer dialog to transfer a payment - Non CIS Name, Reference Number, and Non CIS Comments.\n\nNon CIS Name, Reference Number, and Non CIS Comments appear if the Account ID belongs to a customer class that is used for non-CIS payments."},"transferNonCisReferenceNumber":{"type":"string","maxLength":30,"description":"Following parameters must be specified in the Payment Event Transfer dialog to transfer a payment - Non CIS Name, Reference Number, and Non CIS Comments.\n\nNon CIS Name, Reference Number, and Non CIS Comments appear if the Account ID belongs to a customer class that is used for non-CIS payments."},"transferNonCISComment":{"type":"string","maxLength":254,"description":"Following parameters must be specified in the Payment Event Transfer dialog to transfer a payment - Non CIS Name, Reference Number, and Non CIS Comments.\n\nNon CIS Name, Reference Number, and Non CIS Comments appear if the Account ID belongs to a customer class that is used for non-CIS payments."},"cancelReason":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"cancelReason":{"type":"string","maxLength":4,"description":"Cancel Reason"}}},"paymentTotalAmount":{"type":"number","description":"Payment Total Amount"},"tenderTotalAmount":{"type":"number","description":"Tender Amount contains the amount of the tender."},"numberOfPayments":{"type":"number","maximum":999999999999999,"minimum":0,"description":"Payment Number"},"numberOfTenders":{"type":"number","maximum":999999999999999,"minimum":0,"description":"Tender Number"},"currency":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"currency":{"type":"string","maxLength":3,"description":"Currency Code"}}},"characteristicValueDescription":{"type":"string","maxLength":60,"description":"Char Value Description"},"characteristicValueForeignKeys":{"type":"string","maxLength":254,"description":"Characteristic Value Foreign Keys"},"characteristicValueForeignKeyInformation":{"type":"string","maxLength":254,"description":"Characteristic Value Foreign Key Information"},"charateristicValue":{"type":"string","maxLength":150,"description":"Characteristic Value Indicate the value of the characteristic."},"user":{"type":"object","description":"USER ID","properties":{"_link":{"type":"string","description":"_link"},"user":{"type":"string","maxLength":8,"description":"USER ID"}}},"description":{"type":"string","maxLength":60,"description":"Description"},"accountNumber":{"type":"string","maxLength":50,"description":"Account Number"},"account2":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"accountId2":{"type":"string","maxLength":30,"description":"Account ID references the payment's account. The name of the account's main customer is displayed adjacent."}}},"paymentDate":{"type":"string","format":"date","description":"Payment Date is the business date associated with the payment event."},"creationDateTime":{"type":"string","format":"date-time","description":"Create Date/Time"},"document":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"documentId":{"type":"string","maxLength":30,"description":"Document ID"}}},"accountT":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"accountIdT":{"type":"string","maxLength":10,"description":"Account ID references the payment's account. The name of the account's main customer is displayed adjacent."}}},"paymentEventId2":{"type":"string","maxLength":30,"description":"Payment Event ID is the system-assigned unique identifier of the payment event.","example":"755669969777"},"entityName2":{"type":"string","maxLength":254,"description":"Name"},"account3":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"acctId3":{"type":"string","maxLength":10,"description":"Reversal Account ID"}}},"paymentEventException":{"type":"string","maxLength":254,"description":"Message"},"hasTransfer":{"type":"boolean","description":"(hasTransfer)"},"canDistribute":{"type":"boolean","description":"(canDistribute)"},"shouldAllPaymentsFreeze":{"type":"boolean","description":"(shouldAllPaymentsFreeze)"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"},"payments":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"payment":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"paymentId":{"type":"string","maxLength":12,"description":"Payment ID"}}},"paymentEventId2":{"type":"string","maxLength":12,"description":"Payment Event ID is the system-assigned unique identifier of the payment event.","example":"317772795000"},"cancelReason":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"cancelReason":{"type":"string","maxLength":4,"description":"Cancel Reason"}}},"accountId":{"type":"string","maxLength":10,"description":"Account ID"},"paymentStatus":{"type":"string","enum":["10  ","20  ","30  ","50  ","60  "],"description":"Payment Status is the payment's status. If the payment's status is Error , the error message is displayed adjacent.\n* `10  ` - Incomplete,\n* `20  ` - Error,\n* `30  ` - Freezable,\n* `50  ` - Frozen,\n* `60  ` - Canceled","example":"10"},"payStatusMessage":{"type":"string","maxLength":10,"description":"Payment Status Message"},"paymentAmount":{"type":"number","description":"Payment Amount is the amount of the account's debt relieved by the payment."},"currency":{"type":"string","maxLength":3,"description":"Currency Code"},"nonCisName":{"type":"string","maxLength":50,"description":"Non CIS Name is the name of the person remitting the payment."},"referenceNumber":{"type":"string","maxLength":30,"description":"Reference Number is the reference number of the item being paid (e.g., the property tax reference number)."},"nonCisComments":{"type":"string","maxLength":254,"description":"Non CIS Name is the name of the person remitting the payment.","example":"ZZMXA,CX_test"},"matchType":{"type":"string","maxLength":8,"description":"Match Type and Match Value should only be used if either of the following conditions is true:\n\n        This Account ID belongs to an open item customer class. In this situation, specify a Match Type to define how the payment should be matched to the customer's open-items and use Match Value to define the open-items covered by the payment. \n        The customer wants to restrict the distribution of the payment to a specific service agreement. In this situation, specify a Match Type of \"service agreement ID\" and a Match Value of the respective service agreement ID.","example":"BILL-ID\n\n(Bill ID / Sequential Bill Number)"},"matchValue":{"type":"string","maxLength":30,"description":"Match Type and Match Value should only be used if either of the following conditions is true:\n\n        This Account ID belongs to an open item customer class. In this situation, specify a Match Type to define how the payment should be matched to the customer's open-items and use Match Value to define the open-items covered by the payment. \n        The customer wants to restrict the distribution of the payment to a specific service agreement. In this situation, specify a Match Type of \"service agreement ID\" and a Match Value of the respective service agreement ID.","example":"995516242555"},"paymentSegmentTotal":{"type":"number","description":"Payment Segment Total","example":"28.43"},"paymentAccountCash":{"type":"string","maxLength":30,"description":"Use Cash-Only Threshold to define the number of cash-only points a customer must have before the system warns the CSR accepting payments that the account is cash-only."},"isNonCisPayment":{"type":"boolean","description":"Non-CIS Account Switch","example":"false"},"isOpenItemAccounting":{"type":"boolean","description":"Open Item Accounting Switch","example":"false"},"bill":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"billId":{"type":"string","maxLength":12,"description":"Bill ID"},"billTotal":{"type":"number","description":"Bill Total"},"billDate":{"type":"string","format":"date","description":"Bill Date"}}},"paymentException":{"type":"string","maxLength":254,"description":"Message"},"paymentId2":{"type":"string","maxLength":12,"description":"Payment ID"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"},"nextActions":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"_link":{"type":"string","description":"(_link)"},"actionName":{"type":"string","description":"(actionName)"}}}}}}}}}}},"paymentTenders":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"paymentTender":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"paymentTenderId":{"type":"string","maxLength":12,"description":"Pay Tender ID"}}},"payorAccountId":{"type":"string","maxLength":10,"description":"Account ID"},"currency":{"type":"string","maxLength":3,"description":"Currency Code"},"tenderType":{"type":"string","maxLength":4,"description":"Tender Type"},"tenderControl":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"tenderControlId":{"type":"string","maxLength":10,"description":"Tender Control ID"}}},"isIncludedInTenderControlBalance":{"type":"boolean","description":"Turn off Included in Tender Ctl Balance if the tender should not be included in the tender amount in the tender control's tender balance. You would turn this switch off if you canceled a tender because it was mistakenly applied to the wrong account (or the amount was wrong). This switch is only enabled if:\n\n        The tender control isn't balanced .\n        The tender is canceled"},"tenderAmount":{"type":"number","description":"Tender Amount is the amount of the tender. The amount is disabled if the payment was made in an alternate currency."},"checkNumber":{"type":"string","maxLength":10,"description":"Check Number"},"tenderStatus":{"type":"string","enum":["25  ","60  "],"description":"Tender Status is the tender's status.\n* `25  ` - Valid,\n* `60  ` - Canceled","example":"Valid"},"cancelReason":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"cancelReason":{"type":"string","maxLength":4,"description":"Cancel Reason"}}},"adjustment":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"adjustmentId":{"type":"string","maxLength":12,"description":"Adjustment ID"}}},"customerId":{"type":"string","maxLength":36,"description":"Customer ID is the customer's account ID that appeared on the interfaced payment."},"micrId":{"type":"string","maxLength":30,"description":"MICR ID"},"name":{"type":"string","maxLength":40,"description":"Name is the customer's name on the interfaced payment record."},"externalReferenceId":{"type":"string","maxLength":36,"description":"External Reference ID"},"alternateCurrency":{"type":"string","maxLength":3,"description":"Alternate Currency Code"},"externalAccountId":{"type":"string","maxLength":50,"description":"External Account ID is the customer's account number at the financial institution."},"altTenderAmount":{"type":"number","maximum":9999999999999.99,"minimum":-9999999999999.99,"description":"Alternate Amount"},"encryptedMicrId":{"type":"string","maxLength":64,"description":"Encrypted Micr ID"},"hashMicrId":{"type":"string","maxLength":88,"description":"Hash MICR ID"},"tenderTypeNonCredit":{"type":"string","description":"(tenderTypeNonCredit)"},"isTenderTypeAuthorized":{"type":"boolean","description":"(isTenderTypeAuthorized)"},"hasCashTendered":{"type":"boolean","description":"(hasCashTendered)"},"hasCancelTender":{"type":"boolean","description":"(hasCancelTender)"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"},"characteristics":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"sequence":{"type":"number","maximum":999,"minimum":-999,"description":"Sequence"},"characteristicType":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"characteristicType":{"type":"string","description":"(characteristicType5)"}}},"characteristicValueForeignKey":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"characteristicValueForeignKey":{"type":"string","description":"(characteristicValueForeignKey12)"}}},"adhocCharacteristicValue":{"type":"string","description":"(adhocCharacteristicValue2)"},"characteristicValue":{"type":"string","description":"(characteristicValue3)"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"}}}}}}}}}}},"tenderType":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"tenderedAmount":{"type":"number","description":"Amount Tendered contains the amount that was tendered by the customer."},"tenderType":{"type":"string","maxLength":4,"description":"Tender Type"},"checkNumber":{"type":"string","maxLength":10,"description":"Check Number"},"micrId":{"type":"string","maxLength":30,"description":"MICR ID"},"hashMicrId":{"type":"string","maxLength":88,"description":"Hash MICR ID"},"externalReferenceId":{"type":"string","maxLength":36,"description":"External Reference ID"},"comment":{"type":"string","maxLength":254,"description":"Use Comments to describe anything unusual about the tender control (e.g., to explain why a large over/under amount was created)."},"alternateCurrency":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"alternateCurrency":{"type":"string","maxLength":3,"description":"Alternate Currency Code"}}},"alternateTenderAmount":{"type":"number","maximum":9999999999999.99,"minimum":-9999999999999.99,"description":"Alternate Amount"}}}}}},"exceptions":{"type":"object","properties":{"paymentEventId":{"type":"string","maxLength":12,"description":"Payment Event ID is the system-assigned unique identifier of the payment event.","example":"317772795000"},"messageCategory2":{"type":"number","maximum":99999,"minimum":-99999,"description":"Message category within Oracle Utilities Application Framework","example":"11"},"messageNumber2":{"type":"number","maximum":99999,"minimum":-99999,"description":"Message number within Oracle Utilities Application Framework.","example":"14107"},"paymentEventExceptionType":{"type":"string","enum":["10  ","20  "],"description":"Payment Exception Type\n* `10  ` - Unbalanced Event,\n* `20  ` - Unfrozen Payment","example":"20"},"expandedMessage2":{"type":"string","maxLength":254,"description":"Message"},"messageParameter12":{"type":"string","maxLength":2000,"description":"Message Parameter","example":"."},"messageParameter22":{"type":"string","maxLength":2000,"description":"Message Parameter"},"messageParameter32":{"type":"string","maxLength":2000,"description":"Message Parameter"},"messageParameter42":{"type":"string","maxLength":2000,"description":"Message Parameter"},"messageParameter52":{"type":"string","maxLength":2000,"description":"Message Parameter"},"messageParameter62":{"type":"string","maxLength":2000,"description":"Message Parameter"},"messageParameter72":{"type":"string","maxLength":2000,"description":"Message Parameter"},"messageParameter82":{"type":"string","maxLength":2000,"description":"Message Parameter"},"messageParameter92":{"type":"string","maxLength":2000,"description":"Message Parameter"},"userId2":{"type":"string","maxLength":30,"description":"User"},"isReviewed2":{"type":"boolean","description":"Reviewed","example":"false"},"reviewUser2":{"type":"string","maxLength":8,"description":"Review User"},"reviewedDate2":{"type":"string","format":"date","description":"Review Date"},"comments2":{"type":"string","maxLength":254,"description":"Comments"},"creationDateTime2":{"type":"string","format":"date-time","description":"Create Date/Time","example":"2010-11-24T17:49:23-05:00"},"version23":{"type":"number","maximum":0,"minimum":0,"description":"Version2"}}},"characteristics":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"sequence":{"type":"number","maximum":999,"minimum":-999,"description":"Sequence"},"characteristicType":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"characteristicType":{"type":"string","maxLength":8,"description":"Characteristic Type"}}},"typeOfCharacteristicValue":{"type":"string","maxLength":4,"description":"Type of Char Value"},"characteristicValue":{"type":"object","properties":{"_link":{"type":"string","description":"(_link)"},"value":{"type":"string","description":"(value)"},"value2":{"type":"string","description":"(value2)"},"value3":{"type":"string","description":"(value3)"},"value4":{"type":"string","description":"(value4)"},"value5":{"type":"string","description":"(value5)"}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"}}}}}}},"xml":{"name":"C1-PayEvent"}},"ACTIONPAYMENTEVENT_request":{"type":"object","properties":{"name":{"type":"string","description":"(name)"},"paymentEventId":{"type":"string","maxLength":12,"description":"Payment Event ID is the system-assigned unique identifier of the payment event.","example":"317772795000"},"_self":{"type":"string","description":"(_self)"},"matchType":{"type":"string","maxLength":8,"description":"Match Type and Match Value should only be used if either of the following conditions is true:\n\n        This Account ID belongs to an open item customer class. In this situation, specify a Match Type to define how the payment should be matched to the customer's open-items and use Match Value to define the open-items covered by the payment. \n        The customer wants to restrict the distribution of the payment to a specific service agreement. In this situation, specify a Match Type of \"service agreement ID\" and a Match Value of the respective service agreement ID.","example":"BILL-ID\n\n(Bill ID / Sequential Bill Number)"},"matchValue":{"type":"string","maxLength":30,"description":"Match Type and Match Value should only be used if either of the following conditions is true:\n\n        This Account ID belongs to an open item customer class. In this situation, specify a Match Type to define how the payment should be matched to the customer's open-items and use Match Value to define the open-items covered by the payment. \n        The customer wants to restrict the distribution of the payment to a specific service agreement. In this situation, specify a Match Type of \"service agreement ID\" and a Match Value of the respective service agreement ID.","example":"995516242555"},"accountId":{"type":"string","maxLength":10,"description":"Account ID"},"canFreezePayment":{"type":"boolean","description":"Freeze Payment Switch"},"transferNonCisName":{"type":"string","maxLength":50,"description":"Following parameters must be specified in the Payment Event Transfer dialog to transfer a payment - Non CIS Name, Reference Number, and Non CIS Comments.\n\nNon CIS Name, Reference Number, and Non CIS Comments appear if the Account ID belongs to a customer class that is used for non-CIS payments."},"transferNonCisReferenceNumber":{"type":"string","maxLength":30,"description":"Following parameters must be specified in the Payment Event Transfer dialog to transfer a payment - Non CIS Name, Reference Number, and Non CIS Comments.\n\nNon CIS Name, Reference Number, and Non CIS Comments appear if the Account ID belongs to a customer class that is used for non-CIS payments."},"transferNonCISComment":{"type":"string","maxLength":254,"description":"Following parameters must be specified in the Payment Event Transfer dialog to transfer a payment - Non CIS Name, Reference Number, and Non CIS Comments.\n\nNon CIS Name, Reference Number, and Non CIS Comments appear if the Account ID belongs to a customer class that is used for non-CIS payments."},"cancelReason":{"type":"string","maxLength":4,"description":"Cancel Reason"},"cancelReasonDescription":{"type":"string","maxLength":100,"description":"Cancel Reason Description"},"nextActions":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"actionName":{"type":"string","description":"(actionName)"},"_link":{"type":"string","description":"(_link)"}}}}}}},"xml":{"name":"C1-ActPayEve"}},"UPDATEPAYMENTEVENT_response":{"type":"object","properties":{"_self":{"type":"string","description":"_self"},"payorAccount":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"payorAccountId":{"type":"string","maxLength":10,"description":"Account ID"}}},"matchType":{"type":"string","maxLength":8,"description":"Match Type and Match Value should only be used if either of the following conditions is true:\n\n        This Account ID belongs to an open item customer class. In this situation, specify a Match Type to define how the payment should be matched to the customer's open-items and use Match Value to define the open-items covered by the payment. \n        The customer wants to restrict the distribution of the payment to a specific service agreement. In this situation, specify a Match Type of \"service agreement ID\" and a Match Value of the respective service agreement ID.","example":"BILL-ID\n\n(Bill ID / Sequential Bill Number)"},"matchValue":{"type":"string","maxLength":30,"description":"Match Type and Match Value should only be used if either of the following conditions is true:\n\n        This Account ID belongs to an open item customer class. In this situation, specify a Match Type to define how the payment should be matched to the customer's open-items and use Match Value to define the open-items covered by the payment. \n        The customer wants to restrict the distribution of the payment to a specific service agreement. In this situation, specify a Match Type of \"service agreement ID\" and a Match Value of the respective service agreement ID.","example":"995516242555"},"paymentAmount":{"type":"number","description":"Payment Amount"},"totTenderAmt":{"type":"number","maximum":0,"minimum":0,"description":"Total Tender Amount is the total amount of all tenders linked to the tender control."},"nonCisName":{"type":"string","maxLength":50,"description":"Non CIS Name"},"referenceNumber":{"type":"string","maxLength":30,"description":"Reference Number"},"nonCisComments":{"type":"string","maxLength":254,"description":"Non CIS Comments"},"isNonCisAccount":{"type":"boolean","description":"Non CIS Switch is turned on if the payment is linked to an Account ID that belongs to a customer class that is used for non-CIS payments."},"nonCisSaId":{"type":"string","maxLength":10,"description":"Non CIS Service Agreement ID for account that belongs to a customer class that is used for non-CIS payments."},"paymentTemplate":{"type":"string","maxLength":12,"description":"Payment Templates can be configured for common types of payment allocations to pre-populate the payment distribution and allowing non-CIS payments to be directly allocated against distribution codes."},"bank":{"type":"string","maxLength":5,"description":"Define the Bank Code and Bank Account into which the tender source's moneys will be deposited. The bank account defines the distribution code used to build the GL details for the payment."},"tenderSource":{"type":"string","maxLength":8,"description":"Tender Source is the source of the tenders (e.g., cash drawer 22, lockbox 1 at Bank of America).","example":"ACH \n\n(Auto pay)"},"shouldOverrideTenderAuthorization":{"type":"boolean","description":"The Authorization Override checkbox is only displayed if the tender type selected requires authorization. Use the Authorization override checkbox to indicate whether or not tender authorization should take place. If Authorization override is checked, an authorization code must be entered and the system bypasses the authorization web service call."},"tenderAuthorizationCode":{"type":"string","maxLength":60,"description":"If authorization override is checked, an authorization code must be entered and the system bypasses the authorization web service call."},"tenderReversal":{"type":"string","maxLength":10,"description":"Tender Reversal Code"},"payEventAlternateCurrency":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"payEventAlternateCurrency":{"type":"string","maxLength":1,"description":"Pay Event Alternate Currency Info"}}},"account":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"accountId":{"type":"string","maxLength":10,"description":"Account ID"}}},"transferNonCisName":{"type":"string","maxLength":50,"description":"Following parameters must be specified in the Payment Event Transfer dialog to transfer a payment - Non CIS Name, Reference Number, and Non CIS Comments.\n\nNon CIS Name, Reference Number, and Non CIS Comments appear if the Account ID belongs to a customer class that is used for non-CIS payments."},"transferNonCisReferenceNumber":{"type":"string","maxLength":30,"description":"Following parameters must be specified in the Payment Event Transfer dialog to transfer a payment - Non CIS Name, Reference Number, and Non CIS Comments.\n\nNon CIS Name, Reference Number, and Non CIS Comments appear if the Account ID belongs to a customer class that is used for non-CIS payments."},"transferNonCISComment":{"type":"string","maxLength":254,"description":"Following parameters must be specified in the Payment Event Transfer dialog to transfer a payment - Non CIS Name, Reference Number, and Non CIS Comments.\n\nNon CIS Name, Reference Number, and Non CIS Comments appear if the Account ID belongs to a customer class that is used for non-CIS payments."},"cancelReason":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"cancelReason":{"type":"string","maxLength":4,"description":"Cancel Reason"}}},"paymentTotalAmount":{"type":"number","description":"Payment Total Amount"},"tenderTotalAmount":{"type":"number","description":"Tender Amount contains the amount of the tender."},"numberOfPayments":{"type":"number","maximum":999999999999999,"minimum":0,"description":"Payment Number"},"numberOfTenders":{"type":"number","maximum":999999999999999,"minimum":0,"description":"Tender Number"},"currency":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"currency":{"type":"string","maxLength":3,"description":"Currency Code"}}},"characteristicValueDescription":{"type":"string","maxLength":60,"description":"Char Value Description"},"characteristicValueForeignKeys":{"type":"string","maxLength":254,"description":"Characteristic Value Foreign Keys"},"characteristicValueForeignKeyInformation":{"type":"string","maxLength":254,"description":"Characteristic Value Foreign Key Information"},"charateristicValue":{"type":"string","maxLength":150,"description":"Characteristic Value Indicate the value of the characteristic."},"user":{"type":"object","description":"USER ID","properties":{"_link":{"type":"string","description":"_link"},"user":{"type":"string","maxLength":8,"description":"USER ID"}}},"description":{"type":"string","maxLength":60,"description":"Description"},"accountNumber":{"type":"string","maxLength":50,"description":"Account Number"},"account2":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"accountId2":{"type":"string","maxLength":30,"description":"Account ID references the payment's account. The name of the account's main customer is displayed adjacent."}}},"paymentDate":{"type":"string","format":"date","description":"Payment Date is the business date associated with the payment event."},"creationDateTime":{"type":"string","format":"date-time","description":"Create Date/Time"},"document":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"documentId":{"type":"string","maxLength":30,"description":"Document ID"}}},"accountT":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"accountIdT":{"type":"string","maxLength":10,"description":"Account ID references the payment's account. The name of the account's main customer is displayed adjacent."}}},"paymentEventId2":{"type":"string","maxLength":30,"description":"Payment Event ID is the system-assigned unique identifier of the payment event.","example":"755669969777"},"entityName2":{"type":"string","maxLength":254,"description":"Name"},"account3":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"acctId3":{"type":"string","maxLength":10,"description":"Reversal Account ID"}}},"paymentEventException":{"type":"string","maxLength":254,"description":"Message"},"hasTransfer":{"type":"boolean","description":"(hasTransfer)"},"canDistribute":{"type":"boolean","description":"(canDistribute)"},"shouldAllPaymentsFreeze":{"type":"boolean","description":"(shouldAllPaymentsFreeze)"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"},"payments":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"payment":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"paymentId":{"type":"string","maxLength":12,"description":"Payment ID"}}},"paymentEventId2":{"type":"string","maxLength":12,"description":"Payment Event ID is the system-assigned unique identifier of the payment event.","example":"317772795000"},"cancelReason":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"cancelReason":{"type":"string","maxLength":4,"description":"Cancel Reason"}}},"accountId":{"type":"string","maxLength":10,"description":"Account ID"},"paymentStatus":{"type":"string","enum":["10  ","20  ","30  ","50  ","60  "],"description":"Payment Status is the payment's status. If the payment's status is Error , the error message is displayed adjacent.\n* `10  ` - Incomplete,\n* `20  ` - Error,\n* `30  ` - Freezable,\n* `50  ` - Frozen,\n* `60  ` - Canceled","example":"10"},"payStatusMessage":{"type":"string","maxLength":10,"description":"Payment Status Message"},"paymentAmount":{"type":"number","description":"Payment Amount"},"currency":{"type":"string","maxLength":3,"description":"Currency Code"},"nonCisName":{"type":"string","maxLength":50,"description":"Non CIS Name"},"referenceNumber":{"type":"string","maxLength":30,"description":"Reference Number"},"nonCisComments":{"type":"string","maxLength":254,"description":"Non CIS Comments"},"matchType":{"type":"string","maxLength":8,"description":"Match Type"},"matchValue":{"type":"string","maxLength":30,"description":"Match Value"},"paymentSegmentTotal":{"type":"number","description":"Payment Segment Total","example":"28.43"},"paymentAccountCash":{"type":"string","maxLength":30,"description":"Use Cash-Only Threshold to define the number of cash-only points a customer must have before the system warns the CSR accepting payments that the account is cash-only."},"isNonCisPayment":{"type":"boolean","description":"Non-CIS Account Switch","example":"false"},"isOpenItemAccounting":{"type":"boolean","description":"Open Item Accounting Switch","example":"false"},"bill":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"billId":{"type":"string","maxLength":12,"description":"Bill ID"},"billTotal":{"type":"number","description":"Bill Total"},"billDate":{"type":"string","format":"date","description":"Bill Date"}}},"paymentException":{"type":"string","maxLength":254,"description":"Message"},"paymentId":{"type":"string","maxLength":12,"description":"Payment ID"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"},"nextActions":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"_link":{"type":"string","description":"(_link)"},"actionName":{"type":"string","description":"(actionName)"}}}}}}}}}}},"paymentTenders":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"paymentTender":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"paymentTenderId":{"type":"string","maxLength":12,"description":"Pay Tender ID"}}},"payorAccountId":{"type":"string","maxLength":10,"description":"Account ID"},"currency":{"type":"string","maxLength":3,"description":"Currency Code"},"tenderType":{"type":"string","maxLength":4,"description":"Tender Type"},"tenderControl":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"tenderControlId":{"type":"string","maxLength":10,"description":"Tender Control ID"}}},"isIncludedInTenderControlBalance":{"type":"boolean","description":"Turn off Included in Tender Ctl Balance if the tender should not be included in the tender amount in the tender control's tender balance. You would turn this switch off if you canceled a tender because it was mistakenly applied to the wrong account (or the amount was wrong). This switch is only enabled if:\n\n        The tender control isn't balanced .\n        The tender is canceled"},"tenderAmount":{"type":"number","description":"Tender Amount is the amount of the tender. The amount is disabled if the payment was made in an alternate currency."},"checkNumber":{"type":"string","maxLength":10,"description":"Check Number"},"tenderStatus":{"type":"string","enum":["25  ","60  "],"description":"Tender Status is the tender's status.\n* `25  ` - Valid,\n* `60  ` - Canceled","example":"Valid"},"cancelReason":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"cancelReason":{"type":"string","maxLength":4,"description":"Cancel Reason"}}},"adjustment":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"adjustmentId":{"type":"string","maxLength":12,"description":"Adjustment ID"}}},"customerId":{"type":"string","maxLength":36,"description":"Customer ID is the customer's account ID that appeared on the interfaced payment."},"micrId":{"type":"string","maxLength":30,"description":"MICR ID"},"name":{"type":"string","maxLength":40,"description":"Name is the customer's name on the interfaced payment record."},"externalReferenceId":{"type":"string","maxLength":36,"description":"External Reference ID"},"alternateCurrency":{"type":"string","maxLength":3,"description":"Alternate Currency Code"},"externalAccountId":{"type":"string","maxLength":50,"description":"External Account ID is the customer's account number at the financial institution."},"altTenderAmount":{"type":"number","maximum":9999999999999.99,"minimum":-9999999999999.99,"description":"Alternate Amount"},"encryptedMicrId":{"type":"string","maxLength":64,"description":"Encrypted Micr ID"},"hashMicrId":{"type":"string","maxLength":88,"description":"Hash MICR ID"},"tenderTypeNonCredit":{"type":"string","description":"(tenderTypeNonCredit)"},"isTenderTypeAuthorized":{"type":"boolean","description":"(isTenderTypeAuthorized)"},"hasCashTendered":{"type":"boolean","description":"(hasCashTendered)"},"hasCancelTender":{"type":"boolean","description":"(hasCancelTender)"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"},"characteristics":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"sequence":{"type":"number","maximum":999,"minimum":-999,"description":"Sequence"},"characteristicType":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"characteristicType":{"type":"string","description":"(characteristicType5)"}}},"characteristicValueForeignKey":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"characteristicValueForeignKey":{"type":"string","description":"(characteristicValueForeignKey12)"}}},"adhocCharacteristicValue":{"type":"string","description":"(adhocCharacteristicValue2)"},"characteristicValue":{"type":"string","description":"(characteristicValue3)"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"}}}}}}}}}}},"tenderType":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"tenderedAmount":{"type":"number","description":"Amount Tendered contains the amount that was tendered by the customer."},"tenderType":{"type":"string","maxLength":4,"description":"Tender Type"},"checkNumber":{"type":"string","maxLength":10,"description":"Check Number"},"micrId":{"type":"string","maxLength":30,"description":"MICR ID"},"hashMicrId":{"type":"string","maxLength":88,"description":"Hash MICR ID"},"externalReferenceId":{"type":"string","maxLength":36,"description":"External Reference ID"},"comment":{"type":"string","maxLength":254,"description":"Use Comments to describe anything unusual about the tender control (e.g., to explain why a large over/under amount was created)."},"alternateCurrency":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"alternateCurrency":{"type":"string","maxLength":3,"description":"Alternate Currency Code"}}},"alternateTenderAmount":{"type":"number","maximum":9999999999999.99,"minimum":-9999999999999.99,"description":"Alternate Amount"}}}}}},"exceptions":{"type":"object","properties":{"paymentEventId":{"type":"string","maxLength":12,"description":"Payment Event ID is the system-assigned unique identifier of the payment event.","example":"317772795000"},"messageCategory2":{"type":"number","maximum":99999,"minimum":-99999,"description":"Message category within Oracle Utilities Application Framework","example":"11"},"messageNumber2":{"type":"number","maximum":99999,"minimum":-99999,"description":"Message number within Oracle Utilities Application Framework.","example":"14107"},"paymentEventExceptionType":{"type":"string","enum":["10  ","20  "],"description":"Payment Exception Type\n* `10  ` - Unbalanced Event,\n* `20  ` - Unfrozen Payment","example":"20"},"expandedMessage2":{"type":"string","maxLength":254,"description":"Message"},"messageParameter12":{"type":"string","maxLength":2000,"description":"Message Parameter","example":"."},"messageParameter22":{"type":"string","maxLength":2000,"description":"Message Parameter"},"messageParameter32":{"type":"string","maxLength":2000,"description":"Message Parameter"},"messageParameter42":{"type":"string","maxLength":2000,"description":"Message Parameter"},"messageParameter52":{"type":"string","maxLength":2000,"description":"Message Parameter"},"messageParameter62":{"type":"string","maxLength":2000,"description":"Message Parameter"},"messageParameter72":{"type":"string","maxLength":2000,"description":"Message Parameter"},"messageParameter82":{"type":"string","maxLength":2000,"description":"Message Parameter"},"messageParameter92":{"type":"string","maxLength":2000,"description":"Message Parameter"},"userId2":{"type":"string","maxLength":30,"description":"User"},"isReviewed2":{"type":"boolean","description":"Reviewed","example":"false"},"reviewUser2":{"type":"string","maxLength":8,"description":"Review User"},"reviewedDate2":{"type":"string","format":"date","description":"Review Date"},"comments2":{"type":"string","maxLength":254,"description":"Comments"},"creationDateTime2":{"type":"string","format":"date-time","description":"Create Date/Time","example":"2010-11-24T17:49:23-05:00"},"version23":{"type":"number","maximum":0,"minimum":0,"description":"Version2"}}},"characteristics":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"sequence":{"type":"number","maximum":999,"minimum":-999,"description":"Sequence"},"characteristicType":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"characteristicType":{"type":"string","maxLength":8,"description":"Characteristic Type"}}},"typeOfCharacteristicValue":{"type":"string","maxLength":4,"description":"Type of Char Value"},"characteristicValue":{"type":"object","properties":{"_link":{"type":"string","description":"(_link)"},"value":{"type":"string","description":"(value)"},"value2":{"type":"string","description":"(value2)"},"value3":{"type":"string","description":"(value3)"},"value4":{"type":"string","description":"(value4)"},"value5":{"type":"string","description":"(value5)"}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"}}}}}}},"xml":{"name":"C1-PayEvent"}},"CREATEPAYMENTEVENT_request":{"type":"object","properties":{"payorAccount":{"type":"object","properties":{"payorAccountId":{"type":"string","maxLength":10,"description":"Account ID"}}},"matchType":{"type":"string","maxLength":8,"description":"Match Type and Match Value should only be used if either of the following conditions is true:\n\n        This Account ID belongs to an open item customer class. In this situation, specify a Match Type to define how the payment should be matched to the customer's open-items and use Match Value to define the open-items covered by the payment. \n        The customer wants to restrict the distribution of the payment to a specific service agreement. In this situation, specify a Match Type of \"service agreement ID\" and a Match Value of the respective service agreement ID.","example":"BILL-ID\n\n(Bill ID / Sequential Bill Number)"},"matchValue":{"type":"string","maxLength":30,"description":"Match Type and Match Value should only be used if either of the following conditions is true:\n\n        This Account ID belongs to an open item customer class. In this situation, specify a Match Type to define how the payment should be matched to the customer's open-items and use Match Value to define the open-items covered by the payment. \n        The customer wants to restrict the distribution of the payment to a specific service agreement. In this situation, specify a Match Type of \"service agreement ID\" and a Match Value of the respective service agreement ID.","example":"995516242555"},"paymentAmount":{"type":"number","description":"Payment Amount"},"totTenderAmt":{"type":"number","maximum":0,"minimum":0,"description":"Total Tender Amount is the total amount of all tenders linked to the tender control."},"nonCisName":{"type":"string","maxLength":50,"description":"Non CIS Name"},"referenceNumber":{"type":"string","maxLength":30,"description":"Reference Number"},"nonCisComments":{"type":"string","maxLength":254,"description":"Non CIS Comments"},"isNonCisAccount":{"type":"boolean","description":"Non CIS Switch is turned on if the payment is linked to an Account ID that belongs to a customer class that is used for non-CIS payments."},"nonCisSaId":{"type":"string","maxLength":10,"description":"Non CIS Service Agreement ID for account that belongs to a customer class that is used for non-CIS payments."},"paymentTemplate":{"type":"string","maxLength":12,"description":"Payment Templates can be configured for common types of payment allocations to pre-populate the payment distribution and allowing non-CIS payments to be directly allocated against distribution codes."},"bank":{"type":"string","maxLength":5,"description":"Define the Bank Code and Bank Account into which the tender source's moneys will be deposited. The bank account defines the distribution code used to build the GL details for the payment."},"tenderSource":{"type":"string","maxLength":8,"description":"Tender Source is the source of the tenders (e.g., cash drawer 22, lockbox 1 at Bank of America).","example":"ACH \n\n(Auto pay)"},"shouldOverrideTenderAuthorization":{"type":"boolean","description":"The Authorization Override checkbox is only displayed if the tender type selected requires authorization. Use the Authorization override checkbox to indicate whether or not tender authorization should take place. If Authorization override is checked, an authorization code must be entered and the system bypasses the authorization web service call."},"tenderAuthorizationCode":{"type":"string","maxLength":60,"description":"If authorization override is checked, an authorization code must be entered and the system bypasses the authorization web service call."},"tenderReversal":{"type":"string","maxLength":10,"description":"Tender Reversal Code"},"payEventAlternateCurrency":{"type":"object","properties":{"payEventAlternateCurrency":{"type":"string","maxLength":1,"description":"Pay Event Alternate Currency Info"}}},"account":{"type":"object","properties":{"accountId":{"type":"string","maxLength":10,"description":"Account ID"}}},"transferNonCisName":{"type":"string","maxLength":50,"description":"Following parameters must be specified in the Payment Event Transfer dialog to transfer a payment - Non CIS Name, Reference Number, and Non CIS Comments.\n\nNon CIS Name, Reference Number, and Non CIS Comments appear if the Account ID belongs to a customer class that is used for non-CIS payments."},"transferNonCisReferenceNumber":{"type":"string","maxLength":30,"description":"Following parameters must be specified in the Payment Event Transfer dialog to transfer a payment - Non CIS Name, Reference Number, and Non CIS Comments.\n\nNon CIS Name, Reference Number, and Non CIS Comments appear if the Account ID belongs to a customer class that is used for non-CIS payments."},"transferNonCISComment":{"type":"string","maxLength":254,"description":"Following parameters must be specified in the Payment Event Transfer dialog to transfer a payment - Non CIS Name, Reference Number, and Non CIS Comments.\n\nNon CIS Name, Reference Number, and Non CIS Comments appear if the Account ID belongs to a customer class that is used for non-CIS payments."},"cancelReason":{"type":"object","properties":{"cancelReason":{"type":"string","maxLength":4,"description":"Cancel Reason"}}},"paymentTotalAmount":{"type":"number","description":"Payment Total Amount"},"tenderTotalAmount":{"type":"number","description":"Tender Amount contains the amount of the tender."},"numberOfPayments":{"type":"number","maximum":999999999999999,"minimum":0,"description":"Payment Number"},"numberOfTenders":{"type":"number","maximum":999999999999999,"minimum":0,"description":"Tender Number"},"currency":{"type":"object","properties":{"currency":{"type":"string","maxLength":3,"description":"Currency Code"}}},"characteristicValueDescription":{"type":"string","maxLength":60,"description":"Char Value Description"},"characteristicValueForeignKeys":{"type":"string","maxLength":254,"description":"Characteristic Value Foreign Keys"},"characteristicValueForeignKeyInformation":{"type":"string","maxLength":254,"description":"Characteristic Value Foreign Key Information"},"charateristicValue":{"type":"string","maxLength":150,"description":"Characteristic Value Indicate the value of the characteristic."},"user":{"type":"object","description":"USER ID","properties":{"user":{"type":"string","maxLength":8,"description":"USER ID"}}},"description":{"type":"string","maxLength":60,"description":"Description"},"accountNumber":{"type":"string","maxLength":50,"description":"Account Number"},"account2":{"type":"object","properties":{"accountId2":{"type":"string","maxLength":30,"description":"Account ID references the payment's account. The name of the account's main customer is displayed adjacent."}}},"paymentDate":{"type":"string","format":"date","description":"Payment Date is the business date associated with the payment event."},"creationDateTime":{"type":"string","format":"date-time","description":"Create Date/Time"},"document":{"type":"object","properties":{"documentId":{"type":"string","maxLength":30,"description":"Document ID"}}},"accountT":{"type":"object","properties":{"accountIdT":{"type":"string","maxLength":10,"description":"Account ID references the payment's account. The name of the account's main customer is displayed adjacent."}}},"paymentEventId2":{"type":"string","maxLength":30,"description":"Payment Event ID is the system-assigned unique identifier of the payment event.","example":"755669969777"},"entityName2":{"type":"string","maxLength":254,"description":"Name"},"account3":{"type":"object","properties":{"acctId3":{"type":"string","maxLength":10,"description":"Reversal Account ID"}}},"paymentEventException":{"type":"string","maxLength":254,"description":"Message"},"hasTransfer":{"type":"boolean","description":"(hasTransfer)"},"canDistribute":{"type":"boolean","description":"(canDistribute)"},"shouldAllPaymentsFreeze":{"type":"boolean","description":"(shouldAllPaymentsFreeze)"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"},"payments":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"payment":{"type":"object","properties":{"paymentId":{"type":"string","maxLength":12,"description":"Payment ID"}}},"paymentEventId2":{"type":"string","maxLength":12,"description":"Payment Event ID is the system-assigned unique identifier of the payment event.","example":"317772795000"},"cancelReason":{"type":"object","properties":{"cancelReason":{"type":"string","maxLength":4,"description":"Cancel Reason"}}},"accountId":{"type":"string","maxLength":10,"description":"Account ID"},"paymentStatus":{"type":"string","enum":["10  ","20  ","30  ","50  ","60  "],"description":"Payment Status is the payment's status. If the payment's status is Error , the error message is displayed adjacent.\n* `10  ` - Incomplete,\n* `20  ` - Error,\n* `30  ` - Freezable,\n* `50  ` - Frozen,\n* `60  ` - Canceled","example":"10"},"payStatusMessage":{"type":"string","maxLength":10,"description":"Payment Status Message"},"paymentAmount":{"type":"number","description":"Payment Amount"},"currency":{"type":"string","maxLength":3,"description":"Currency Code"},"nonCisName":{"type":"string","maxLength":50,"description":"Non CIS Name"},"referenceNumber":{"type":"string","maxLength":30,"description":"Reference Number"},"nonCisComments":{"type":"string","maxLength":254,"description":"Non CIS Comments"},"matchType":{"type":"string","maxLength":8,"description":"Match Type"},"matchValue":{"type":"string","maxLength":30,"description":"Match Value"},"paymentSegmentTotal":{"type":"number","description":"Payment Segment Total","example":"28.43"},"paymentAccountCash":{"type":"string","maxLength":30,"description":"Use Cash-Only Threshold to define the number of cash-only points a customer must have before the system warns the CSR accepting payments that the account is cash-only."},"isNonCisPayment":{"type":"boolean","description":"Non-CIS Account Switch","example":"false"},"isOpenItemAccounting":{"type":"boolean","description":"Open Item Accounting Switch","example":"false"},"bill":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"billId":{"type":"string","maxLength":12,"description":"Bill ID"},"billTotal":{"type":"number","description":"Bill Total"},"billDate":{"type":"string","format":"date","description":"Bill Date"}}},"paymentException":{"type":"string","maxLength":254,"description":"Message"},"paymentId2":{"type":"string","maxLength":12,"description":"Payment ID"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"},"nextActions":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"_link":{"type":"string","description":"(_link)"},"actionName":{"type":"string","description":"(actionName)"}}}}}}}}}}},"paymentTenders":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"paymentTender":{"type":"object","properties":{"paymentTenderId":{"type":"string","maxLength":12,"description":"Pay Tender ID"}}},"payorAccountId":{"type":"string","maxLength":10,"description":"Account ID"},"currency":{"type":"string","maxLength":3,"description":"Currency Code"},"tenderType":{"type":"string","maxLength":4,"description":"Tender Type"},"tenderControl":{"type":"object","properties":{"tenderControlId":{"type":"string","maxLength":10,"description":"Tender Control ID"}}},"isIncludedInTenderControlBalance":{"type":"boolean","description":"Turn off Included in Tender Ctl Balance if the tender should not be included in the tender amount in the tender control's tender balance. You would turn this switch off if you canceled a tender because it was mistakenly applied to the wrong account (or the amount was wrong). This switch is only enabled if:\n\n        The tender control isn't balanced .\n        The tender is canceled"},"tenderAmount":{"type":"number","description":"Tender Amount is the amount of the tender. The amount is disabled if the payment was made in an alternate currency."},"checkNumber":{"type":"string","maxLength":10,"description":"Check Number"},"tenderStatus":{"type":"string","enum":["25  ","60  "],"description":"Tender Status is the tender's status.\n* `25  ` - Valid,\n* `60  ` - Canceled","example":"Valid"},"cancelReason":{"type":"object","properties":{"cancelReason":{"type":"string","maxLength":4,"description":"Cancel Reason"}}},"adjustment":{"type":"object","properties":{"adjustmentId":{"type":"string","maxLength":12,"description":"Adjustment ID"}}},"customerId":{"type":"string","maxLength":36,"description":"Customer ID is the customer's account ID that appeared on the interfaced payment."},"micrId":{"type":"string","maxLength":30,"description":"MICR ID"},"name":{"type":"string","maxLength":40,"description":"Name is the customer's name on the interfaced payment record."},"externalReferenceId":{"type":"string","maxLength":36,"description":"External Reference ID"},"alternateCurrency":{"type":"string","maxLength":3,"description":"Alternate Currency Code"},"externalAccountId":{"type":"string","maxLength":50,"description":"External Account ID is the customer's account number at the financial institution."},"altTenderAmount":{"type":"number","maximum":9999999999999.99,"minimum":-9999999999999.99,"description":"Alternate Amount"},"encryptedMicrId":{"type":"string","maxLength":64,"description":"Encrypted Micr ID"},"hashMicrId":{"type":"string","maxLength":88,"description":"Hash MICR ID"},"tenderTypeNonCredit":{"type":"string","description":"(tenderTypeNonCredit)"},"isTenderTypeAuthorized":{"type":"boolean","description":"(isTenderTypeAuthorized)"},"hasCashTendered":{"type":"boolean","description":"(hasCashTendered)"},"hasCancelTender":{"type":"boolean","description":"(hasCancelTender)"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"},"characteristics":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"sequence":{"type":"number","maximum":999,"minimum":-999,"description":"Sequence"},"characteristicType":{"type":"object","properties":{"characteristicType":{"type":"string","description":"(characteristicType5)"}}},"characteristicValueForeignKey":{"type":"object","properties":{"characteristicValueForeignKey":{"type":"string","description":"(characteristicValueForeignKey12)"}}},"adhocCharacteristicValue":{"type":"string","description":"(adhocCharacteristicValue2)"},"characteristicValue":{"type":"string","description":"(characteristicValue3)"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"}}}}}}}}}}},"tenderType":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"tenderedAmount":{"type":"number","description":"Amount Tendered contains the amount that was tendered by the customer."},"tenderType":{"type":"string","maxLength":4,"description":"Tender Type"},"checkNumber":{"type":"string","maxLength":10,"description":"Check Number"},"micrId":{"type":"string","maxLength":30,"description":"MICR ID"},"hashMicrId":{"type":"string","maxLength":88,"description":"Hash MICR ID"},"externalReferenceId":{"type":"string","maxLength":36,"description":"External Reference ID"},"comment":{"type":"string","maxLength":254,"description":"Use Comments to describe anything unusual about the tender control (e.g., to explain why a large over/under amount was created)."},"alternateCurrency":{"type":"object","properties":{"alternateCurrency":{"type":"string","maxLength":3,"description":"Alternate Currency Code"}}},"alternateTenderAmount":{"type":"number","maximum":9999999999999.99,"minimum":-9999999999999.99,"description":"Alternate Amount"}}}}}},"exceptions":{"type":"object","properties":{"paymentEventId":{"type":"string","maxLength":12,"description":"Payment Event ID is the system-assigned unique identifier of the payment event.","example":"317772795000"},"messageCategory2":{"type":"number","maximum":99999,"minimum":-99999,"description":"Message category within Oracle Utilities Application Framework","example":"11"},"messageNumber2":{"type":"number","maximum":99999,"minimum":-99999,"description":"Message number within Oracle Utilities Application Framework.","example":"14107"},"paymentEventExceptionType":{"type":"string","enum":["10  ","20  "],"description":"Payment Exception Type\n* `10  ` - Unbalanced Event,\n* `20  ` - Unfrozen Payment","example":"20"},"expandedMessage2":{"type":"string","maxLength":254,"description":"Message"},"messageParameter12":{"type":"string","maxLength":2000,"description":"Message Parameter","example":"."},"messageParameter22":{"type":"string","maxLength":2000,"description":"Message Parameter"},"messageParameter32":{"type":"string","maxLength":2000,"description":"Message Parameter"},"messageParameter42":{"type":"string","maxLength":2000,"description":"Message Parameter"},"messageParameter52":{"type":"string","maxLength":2000,"description":"Message Parameter"},"messageParameter62":{"type":"string","maxLength":2000,"description":"Message Parameter"},"messageParameter72":{"type":"string","maxLength":2000,"description":"Message Parameter"},"messageParameter82":{"type":"string","maxLength":2000,"description":"Message Parameter"},"messageParameter92":{"type":"string","maxLength":2000,"description":"Message Parameter"},"userId2":{"type":"string","maxLength":30,"description":"User"},"isReviewed2":{"type":"boolean","description":"Reviewed","example":"false"},"reviewUser2":{"type":"string","maxLength":8,"description":"Review User"},"reviewedDate2":{"type":"string","format":"date","description":"Review Date"},"comments2":{"type":"string","maxLength":254,"description":"Comments"},"creationDateTime2":{"type":"string","format":"date-time","description":"Create Date/Time","example":"2010-11-24T17:49:23-05:00"},"version23":{"type":"number","maximum":0,"minimum":0,"description":"Version2"}}},"characteristics":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"sequence":{"type":"number","maximum":999,"minimum":-999,"description":"Sequence"},"characteristicType":{"type":"object","properties":{"characteristicType":{"type":"string","maxLength":8,"description":"Characteristic Type"}}},"typeOfCharacteristicValue":{"type":"string","maxLength":4,"description":"Type of Char Value"},"characteristicValue":{"type":"object","properties":{"_link":{"type":"string","description":"(_link)"},"value":{"type":"string","description":"(value)"},"value2":{"type":"string","description":"(value2)"},"value3":{"type":"string","description":"(value3)"},"value4":{"type":"string","description":"(value4)"},"value5":{"type":"string","description":"(value5)"}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"}}}}}}},"xml":{"name":"C1-PayEvent"}},"ACTIONPAYMENTEVENT_response":{"type":"object","properties":{"name":{"type":"string","description":"(name)"},"paymentEventId":{"type":"string","maxLength":12,"description":"Payment Event ID is the system-assigned unique identifier of the payment event.","example":"317772795000"},"_self":{"type":"string","description":"(_self)"},"matchType":{"type":"string","maxLength":8,"description":"Match Type and Match Value should only be used if either of the following conditions is true:\n\n        This Account ID belongs to an open item customer class. In this situation, specify a Match Type to define how the payment should be matched to the customer's open-items and use Match Value to define the open-items covered by the payment. \n        The customer wants to restrict the distribution of the payment to a specific service agreement. In this situation, specify a Match Type of \"service agreement ID\" and a Match Value of the respective service agreement ID.","example":"BILL-ID\n\n(Bill ID / Sequential Bill Number)"},"matchValue":{"type":"string","maxLength":30,"description":"Match Type and Match Value should only be used if either of the following conditions is true:\n\n        This Account ID belongs to an open item customer class. In this situation, specify a Match Type to define how the payment should be matched to the customer's open-items and use Match Value to define the open-items covered by the payment. \n        The customer wants to restrict the distribution of the payment to a specific service agreement. In this situation, specify a Match Type of \"service agreement ID\" and a Match Value of the respective service agreement ID.","example":"995516242555"},"accountId":{"type":"string","maxLength":10,"description":"Account ID"},"canFreezePayment":{"type":"boolean","description":"Freeze Payment Switch"},"transferNonCisName":{"type":"string","maxLength":50,"description":"Following parameters must be specified in the Payment Event Transfer dialog to transfer a payment - Non CIS Name, Reference Number, and Non CIS Comments.\n\nNon CIS Name, Reference Number, and Non CIS Comments appear if the Account ID belongs to a customer class that is used for non-CIS payments."},"transferNonCisReferenceNumber":{"type":"string","maxLength":30,"description":"Following parameters must be specified in the Payment Event Transfer dialog to transfer a payment - Non CIS Name, Reference Number, and Non CIS Comments.\n\nNon CIS Name, Reference Number, and Non CIS Comments appear if the Account ID belongs to a customer class that is used for non-CIS payments."},"transferNonCISComment":{"type":"string","maxLength":254,"description":"Following parameters must be specified in the Payment Event Transfer dialog to transfer a payment - Non CIS Name, Reference Number, and Non CIS Comments.\n\nNon CIS Name, Reference Number, and Non CIS Comments appear if the Account ID belongs to a customer class that is used for non-CIS payments."},"cancelReason":{"type":"string","maxLength":4,"description":"Cancel Reason"},"cancelReasonDescription":{"type":"string","maxLength":100,"description":"Cancel Reason Description"},"nextActions":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"actionName":{"type":"string","description":"(actionName)"},"_link":{"type":"string","description":"(_link)"}}}}}}},"xml":{"name":"C1-ActPayEve"}},"CREATEPAYMENTEVENT_response":{"type":"object","properties":{"_self":{"type":"string","description":"_self"},"paymentEventId":{"type":"string","maxLength":12,"description":"Payment Event ID is the system-assigned unique identifier of the payment event.","example":"317772795000"},"payorAccount":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"payorAccountId":{"type":"string","maxLength":10,"description":"Account ID"}}},"matchType":{"type":"string","maxLength":8,"description":"Match Type and Match Value should only be used if either of the following conditions is true:\n\n        This Account ID belongs to an open item customer class. In this situation, specify a Match Type to define how the payment should be matched to the customer's open-items and use Match Value to define the open-items covered by the payment. \n        The customer wants to restrict the distribution of the payment to a specific service agreement. In this situation, specify a Match Type of \"service agreement ID\" and a Match Value of the respective service agreement ID.","example":"BILL-ID\n\n(Bill ID / Sequential Bill Number)"},"matchValue":{"type":"string","maxLength":30,"description":"Match Type and Match Value should only be used if either of the following conditions is true:\n\n        This Account ID belongs to an open item customer class. In this situation, specify a Match Type to define how the payment should be matched to the customer's open-items and use Match Value to define the open-items covered by the payment. \n        The customer wants to restrict the distribution of the payment to a specific service agreement. In this situation, specify a Match Type of \"service agreement ID\" and a Match Value of the respective service agreement ID.","example":"995516242555"},"paymentAmount":{"type":"number","description":"Payment Amount"},"totTenderAmt":{"type":"number","maximum":0,"minimum":0,"description":"Total Tender Amount is the total amount of all tenders linked to the tender control."},"nonCisName":{"type":"string","maxLength":50,"description":"Non CIS Name"},"referenceNumber":{"type":"string","maxLength":30,"description":"Reference Number"},"nonCisComments":{"type":"string","maxLength":254,"description":"Non CIS Comments"},"isNonCisAccount":{"type":"boolean","description":"Non CIS Switch is turned on if the payment is linked to an Account ID that belongs to a customer class that is used for non-CIS payments."},"nonCisSaId":{"type":"string","maxLength":10,"description":"Non CIS Service Agreement ID for account that belongs to a customer class that is used for non-CIS payments."},"paymentTemplate":{"type":"string","maxLength":12,"description":"Payment Templates can be configured for common types of payment allocations to pre-populate the payment distribution and allowing non-CIS payments to be directly allocated against distribution codes."},"bank":{"type":"string","maxLength":5,"description":"Define the Bank Code and Bank Account into which the tender source's moneys will be deposited. The bank account defines the distribution code used to build the GL details for the payment."},"tenderSource":{"type":"string","maxLength":8,"description":"Tender Source is the source of the tenders (e.g., cash drawer 22, lockbox 1 at Bank of America).","example":"ACH \n\n(Auto pay)"},"shouldOverrideTenderAuthorization":{"type":"boolean","description":"The Authorization Override checkbox is only displayed if the tender type selected requires authorization. Use the Authorization override checkbox to indicate whether or not tender authorization should take place. If Authorization override is checked, an authorization code must be entered and the system bypasses the authorization web service call."},"tenderAuthorizationCode":{"type":"string","maxLength":60,"description":"If authorization override is checked, an authorization code must be entered and the system bypasses the authorization web service call."},"tenderReversal":{"type":"string","maxLength":10,"description":"Tender Reversal Code"},"payEventAlternateCurrency":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"payEventAlternateCurrency":{"type":"string","maxLength":1,"description":"Pay Event Alternate Currency Info"}}},"account":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"accountId":{"type":"string","maxLength":10,"description":"Account ID"}}},"transferNonCisName":{"type":"string","maxLength":50,"description":"Following parameters must be specified in the Payment Event Transfer dialog to transfer a payment - Non CIS Name, Reference Number, and Non CIS Comments.\n\nNon CIS Name, Reference Number, and Non CIS Comments appear if the Account ID belongs to a customer class that is used for non-CIS payments."},"transferNonCisReferenceNumber":{"type":"string","maxLength":30,"description":"Following parameters must be specified in the Payment Event Transfer dialog to transfer a payment - Non CIS Name, Reference Number, and Non CIS Comments.\n\nNon CIS Name, Reference Number, and Non CIS Comments appear if the Account ID belongs to a customer class that is used for non-CIS payments."},"transferNonCISComment":{"type":"string","maxLength":254,"description":"Following parameters must be specified in the Payment Event Transfer dialog to transfer a payment - Non CIS Name, Reference Number, and Non CIS Comments.\n\nNon CIS Name, Reference Number, and Non CIS Comments appear if the Account ID belongs to a customer class that is used for non-CIS payments."},"cancelReason":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"cancelReason":{"type":"string","maxLength":4,"description":"Cancel Reason"}}},"paymentTotalAmount":{"type":"number","description":"Payment Total Amount"},"tenderTotalAmount":{"type":"number","description":"Tender Amount contains the amount of the tender."},"numberOfPayments":{"type":"number","maximum":999999999999999,"minimum":0,"description":"Payment Number"},"numberOfTenders":{"type":"number","maximum":999999999999999,"minimum":0,"description":"Tender Number"},"currency":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"currency":{"type":"string","maxLength":3,"description":"Currency Code"}}},"characteristicValueDescription":{"type":"string","maxLength":60,"description":"Char Value Description"},"characteristicValueForeignKeys":{"type":"string","maxLength":254,"description":"Characteristic Value Foreign Keys"},"characteristicValueForeignKeyInformation":{"type":"string","maxLength":254,"description":"Characteristic Value Foreign Key Information"},"charateristicValue":{"type":"string","maxLength":150,"description":"Characteristic Value Indicate the value of the characteristic."},"user":{"type":"object","description":"USER ID","properties":{"_link":{"type":"string","description":"_link"},"user":{"type":"string","maxLength":8,"description":"USER ID"}}},"description":{"type":"string","maxLength":60,"description":"Description"},"accountNumber":{"type":"string","maxLength":50,"description":"Account Number"},"account2":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"accountId2":{"type":"string","maxLength":30,"description":"Account ID references the payment's account. The name of the account's main customer is displayed adjacent."}}},"paymentDate":{"type":"string","format":"date","description":"Payment Date is the business date associated with the payment event."},"creationDateTime":{"type":"string","format":"date-time","description":"Create Date/Time"},"document":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"documentId":{"type":"string","maxLength":30,"description":"Document ID"}}},"accountT":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"accountIdT":{"type":"string","maxLength":10,"description":"Account ID references the payment's account. The name of the account's main customer is displayed adjacent."}}},"paymentEventId2":{"type":"string","maxLength":30,"description":"Payment Event ID is the system-assigned unique identifier of the payment event.","example":"755669969777"},"entityName2":{"type":"string","maxLength":254,"description":"Name"},"account3":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"acctId3":{"type":"string","maxLength":10,"description":"Reversal Account ID"}}},"paymentEventException":{"type":"string","maxLength":254,"description":"Message"},"hasTransfer":{"type":"boolean","description":"(hasTransfer)"},"canDistribute":{"type":"boolean","description":"(canDistribute)"},"shouldAllPaymentsFreeze":{"type":"boolean","description":"(shouldAllPaymentsFreeze)"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"},"payments":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"payment":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"paymentId":{"type":"string","maxLength":12,"description":"Payment ID"}}},"paymentEventId2":{"type":"string","maxLength":12,"description":"Payment Event ID is the system-assigned unique identifier of the payment event.","example":"317772795000"},"cancelReason":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"cancelReason":{"type":"string","maxLength":4,"description":"Cancel Reason"}}},"accountId":{"type":"string","maxLength":10,"description":"Account ID"},"paymentStatus":{"type":"string","enum":["10  ","20  ","30  ","50  ","60  "],"description":"Payment Status is the payment's status. If the payment's status is Error , the error message is displayed adjacent.\n* `10  ` - Incomplete,\n* `20  ` - Error,\n* `30  ` - Freezable,\n* `50  ` - Frozen,\n* `60  ` - Canceled","example":"10"},"payStatusMessage":{"type":"string","maxLength":10,"description":"Payment Status Message"},"paymentAmount":{"type":"number","description":"Payment Amount"},"currency":{"type":"string","maxLength":3,"description":"Currency Code"},"nonCisName":{"type":"string","maxLength":50,"description":"Non CIS Name"},"referenceNumber":{"type":"string","maxLength":30,"description":"Reference Number"},"nonCisComments":{"type":"string","maxLength":254,"description":"Non CIS Comments"},"matchType":{"type":"string","maxLength":8,"description":"Match Type"},"matchValue":{"type":"string","maxLength":30,"description":"Match Value"},"paymentSegmentTotal":{"type":"number","description":"Payment Segment Total","example":"28.43"},"paymentAccountCash":{"type":"string","maxLength":30,"description":"Use Cash-Only Threshold to define the number of cash-only points a customer must have before the system warns the CSR accepting payments that the account is cash-only."},"isNonCisPayment":{"type":"boolean","description":"Non-CIS Account Switch","example":"false"},"isOpenItemAccounting":{"type":"boolean","description":"Open Item Accounting Switch","example":"false"},"bill":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"billId":{"type":"string","maxLength":12,"description":"Bill ID"},"billTotal":{"type":"number","description":"Bill Total"},"billDate":{"type":"string","format":"date","description":"Bill Date"}}},"paymentException":{"type":"string","maxLength":254,"description":"Message"},"paymentId2":{"type":"string","maxLength":12,"description":"Payment ID"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"},"nextActions":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"_link":{"type":"string","description":"(_link)"},"actionName":{"type":"string","description":"(actionName)"}}}}}}}}}}},"paymentTenders":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"paymentTender":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"paymentTenderId":{"type":"string","maxLength":12,"description":"Pay Tender ID"}}},"payorAccountId":{"type":"string","maxLength":10,"description":"Account ID"},"currency":{"type":"string","maxLength":3,"description":"Currency Code"},"tenderType":{"type":"string","maxLength":4,"description":"Tender Type"},"tenderControl":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"tenderControlId":{"type":"string","maxLength":10,"description":"Tender Control ID"}}},"isIncludedInTenderControlBalance":{"type":"boolean","description":"Turn off Included in Tender Ctl Balance if the tender should not be included in the tender amount in the tender control's tender balance. You would turn this switch off if you canceled a tender because it was mistakenly applied to the wrong account (or the amount was wrong). This switch is only enabled if:\n\n        The tender control isn't balanced .\n        The tender is canceled"},"tenderAmount":{"type":"number","description":"Tender Amount is the amount of the tender. The amount is disabled if the payment was made in an alternate currency."},"checkNumber":{"type":"string","maxLength":10,"description":"Check Number"},"tenderStatus":{"type":"string","enum":["25  ","60  "],"description":"Tender Status is the tender's status.\n* `25  ` - Valid,\n* `60  ` - Canceled","example":"Valid"},"cancelReason":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"cancelReason":{"type":"string","maxLength":4,"description":"Cancel Reason"}}},"adjustment":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"adjustmentId":{"type":"string","maxLength":12,"description":"Adjustment ID"}}},"customerId":{"type":"string","maxLength":36,"description":"Customer ID is the customer's account ID that appeared on the interfaced payment."},"micrId":{"type":"string","maxLength":30,"description":"MICR ID"},"name":{"type":"string","maxLength":40,"description":"Name is the customer's name on the interfaced payment record."},"externalReferenceId":{"type":"string","maxLength":36,"description":"External Reference ID"},"alternateCurrency":{"type":"string","maxLength":3,"description":"Alternate Currency Code"},"externalAccountId":{"type":"string","maxLength":50,"description":"External Account ID is the customer's account number at the financial institution."},"altTenderAmount":{"type":"number","maximum":9999999999999.99,"minimum":-9999999999999.99,"description":"Alternate Amount"},"encryptedMicrId":{"type":"string","maxLength":64,"description":"Encrypted Micr ID"},"hashMicrId":{"type":"string","maxLength":88,"description":"Hash MICR ID"},"tenderTypeNonCredit":{"type":"string","description":"(tenderTypeNonCredit)"},"isTenderTypeAuthorized":{"type":"boolean","description":"(isTenderTypeAuthorized)"},"hasCashTendered":{"type":"boolean","description":"(hasCashTendered)"},"hasCancelTender":{"type":"boolean","description":"(hasCancelTender)"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"},"characteristics":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"sequence":{"type":"number","maximum":999,"minimum":-999,"description":"Sequence"},"characteristicType":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"characteristicType":{"type":"string","description":"(characteristicType5)"}}},"characteristicValueForeignKey":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"characteristicValueForeignKey":{"type":"string","description":"(characteristicValueForeignKey12)"}}},"adhocCharacteristicValue":{"type":"string","description":"(adhocCharacteristicValue2)"},"characteristicValue":{"type":"string","description":"(characteristicValue3)"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"}}}}}}}}}}},"tenderType":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"tenderedAmount":{"type":"number","description":"Amount Tendered contains the amount that was tendered by the customer."},"tenderType":{"type":"string","maxLength":4,"description":"Tender Type"},"checkNumber":{"type":"string","maxLength":10,"description":"Check Number"},"micrId":{"type":"string","maxLength":30,"description":"MICR ID"},"hashMicrId":{"type":"string","maxLength":88,"description":"Hash MICR ID"},"externalReferenceId":{"type":"string","maxLength":36,"description":"External Reference ID"},"comment":{"type":"string","maxLength":254,"description":"Use Comments to describe anything unusual about the tender control (e.g., to explain why a large over/under amount was created)."},"alternateCurrency":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"alternateCurrency":{"type":"string","maxLength":3,"description":"Alternate Currency Code"}}},"alternateTenderAmount":{"type":"number","maximum":9999999999999.99,"minimum":-9999999999999.99,"description":"Alternate Amount"}}}}}},"exceptions":{"type":"object","properties":{"paymentEventId":{"type":"string","maxLength":12,"description":"Payment Event ID is the system-assigned unique identifier of the payment event.","example":"317772795000"},"messageCategory2":{"type":"number","maximum":99999,"minimum":-99999,"description":"Message category within Oracle Utilities Application Framework","example":"11"},"messageNumber2":{"type":"number","maximum":99999,"minimum":-99999,"description":"Message number within Oracle Utilities Application Framework.","example":"14107"},"paymentEventExceptionType":{"type":"string","enum":["10  ","20  "],"description":"Payment Exception Type\n* `10  ` - Unbalanced Event,\n* `20  ` - Unfrozen Payment","example":"20"},"expandedMessage2":{"type":"string","maxLength":254,"description":"Message"},"messageParameter12":{"type":"string","maxLength":2000,"description":"Message Parameter","example":"."},"messageParameter22":{"type":"string","maxLength":2000,"description":"Message Parameter"},"messageParameter32":{"type":"string","maxLength":2000,"description":"Message Parameter"},"messageParameter42":{"type":"string","maxLength":2000,"description":"Message Parameter"},"messageParameter52":{"type":"string","maxLength":2000,"description":"Message Parameter"},"messageParameter62":{"type":"string","maxLength":2000,"description":"Message Parameter"},"messageParameter72":{"type":"string","maxLength":2000,"description":"Message Parameter"},"messageParameter82":{"type":"string","maxLength":2000,"description":"Message Parameter"},"messageParameter92":{"type":"string","maxLength":2000,"description":"Message Parameter"},"userId2":{"type":"string","maxLength":30,"description":"User"},"isReviewed2":{"type":"boolean","description":"Reviewed","example":"false"},"reviewUser2":{"type":"string","maxLength":8,"description":"Review User"},"reviewedDate2":{"type":"string","format":"date","description":"Review Date"},"comments2":{"type":"string","maxLength":254,"description":"Comments"},"creationDateTime2":{"type":"string","format":"date-time","description":"Create Date/Time","example":"2010-11-24T17:49:23-05:00"},"version23":{"type":"number","maximum":0,"minimum":0,"description":"Version2"}}},"characteristics":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"sequence":{"type":"number","maximum":999,"minimum":-999,"description":"Sequence"},"characteristicType":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"characteristicType":{"type":"string","maxLength":8,"description":"Characteristic Type"}}},"typeOfCharacteristicValue":{"type":"string","maxLength":4,"description":"Type of Char Value"},"characteristicValue":{"type":"object","properties":{"_link":{"type":"string","description":"(_link)"},"value":{"type":"string","description":"(value)"},"value2":{"type":"string","description":"(value2)"},"value3":{"type":"string","description":"(value3)"},"value4":{"type":"string","description":"(value4)"},"value5":{"type":"string","description":"(value5)"}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"}}}}}}},"xml":{"name":"C1-PayEvent"}},"DELETEPAYMENTEVENT_request":{"type":"object","properties":{"paymentEventId":{"type":"string","maxLength":12,"description":"Payment Event ID is the system-assigned unique identifier of the payment event.","example":"317772795000"}},"xml":{"name":"C1DelPayEve"}},"DELETEPAYMENTEVENT_response":{"type":"object","properties":{"paymentEventId":{"type":"string","maxLength":12,"description":"Payment Event ID is the system-assigned unique identifier of the payment event.","example":"317772795000"}},"xml":{"name":"C1DelPayEve"}},"CREATEPAYMENTTENDER_response":{"type":"object","properties":{"_self":{"type":"string","description":"_self"},"paymentEvent":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"paymentEventId":{"type":"string","maxLength":12,"description":"Payment Event ID"}}},"paymentTenderId":{"type":"string","maxLength":12,"description":"Pay Tender ID is the system-assigned unique identifier of the tender.","example":"221888888888"},"payorAccount":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"payorAccountId":{"type":"string","maxLength":10,"description":"Account ID"}}},"currency":{"type":"object","description":"Currency Code defines the currency in which the account's financial transactions are expressed.","properties":{"_link":{"type":"string","description":"_link"},"currency":{"type":"string","maxLength":3,"description":"Currency Code"}}},"tenderType":{"type":"object","description":"Tender Type describes what was remitted (e.g., cash, check).","properties":{"_link":{"type":"string","description":"_link"},"tenderType":{"type":"string","maxLength":4,"description":"Tender Type"}}},"tenderControl":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"tenderControlId":{"type":"string","maxLength":10,"description":"Tender Control ID is the identity of the remittance processor batch or cash drawer bundle in which the tender was remitted.","example":"0225339900"}}},"tenderAmount":{"type":"number","description":"Tender Amount is the amount of the tender. The amount is disabled if the payment was made in an alternate currency.","example":"$25.00"},"checkNumber":{"type":"string","maxLength":10,"description":"If a check was used for payment, the Check Number contains the identity of the check."},"tenderStatus":{"type":"string","enum":["25  ","60  "],"description":"Tender Status is the tender's status.\n* `25  ` - Valid,\n* `60  ` - Canceled","example":"Valid"},"cancelReason":{"type":"object","description":"If the payment is canceled , the Cancel Reason is displayed.","properties":{"_link":{"type":"string","description":"_link"},"cancelReason":{"type":"string","maxLength":4,"description":"Cancel Reason"}}},"adjustment":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"adjustmentId":{"type":"string","maxLength":12,"description":"Adjustment ID is displayed if there is an adjustment associated with the payment."}}},"customerId":{"type":"string","maxLength":36,"description":"Customer ID is the customer's account ID that appeared on the interfaced payment."},"micrId":{"type":"string","maxLength":30,"description":"MICR ID is the value of the magnetic ink character recognition (MICR) line on the payment."},"name":{"type":"string","maxLength":40,"description":"Name is the customer's name on the interfaced payment record."},"externalReferenceId":{"type":"string","maxLength":36,"description":"Ext. Reference ID is the unique identifier of the payment upload interface record."},"alternateCurrency":{"type":"object","description":"If the payment tender was remitted in an alternate currency, i.e. a currency other than the payor account's currency.","properties":{"_link":{"type":"string","description":"_link"},"alternateCurrency":{"type":"string","maxLength":3,"description":"If the payment tender was remitted in an alternate currency, i.e. a currency other than the payor account's currency."}}},"alternateTenderAmount":{"type":"object","description":"Tender Amount","properties":{"_link":{"type":"string","description":"_link"},"alternateTenderAmount":{"type":"number","maximum":9999999999999.99,"minimum":-9999999999999.99,"description":"Tender Amount"}}},"encryptedMicrId":{"type":"string","maxLength":64,"description":"Encrypted MICR ID"},"hashMicrId":{"type":"string","maxLength":88,"description":"A hash representation of MICR ID field."},"tndrTypeNonCredit":{"type":"string","description":"(tndrTypeNonCredit)"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks.","example":"1"},"autoPayClearing":{"type":"object","properties":{"autopayClearingId":{"type":"string","maxLength":12,"description":"Auto Pay Clearing ID is PK of the auto pay staging record."},"accountAutoPay":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"accountAutoPayId":{"type":"string","maxLength":10,"description":"Auto Pay ID is the unique, system-assigned identifier of the auto-pay record."}}},"bill":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"billId":{"type":"string","maxLength":12,"description":"Bill ID"}}},"scheduleExtractDate":{"type":"string","format":"date","description":"Scheduled Extract Date is the date the automatic payment request was sent / is scheduled to be sent to the financial institution."},"batchControl":{"type":"object","description":"If the tender controls are created for a background process, such as the automatic payment extract, Batch Code is displayed.\n\nBatch Code is the batch code for which the tender control was created.","properties":{"_link":{"type":"string","description":"_link"},"batchControl":{"type":"string","maxLength":8,"description":"If the tender controls are created for a background process, such as the automatic payment extract, Batch Code is displayed.\n\nBatch Code is the batch code for which the tender control was created."}}},"batchNumber":{"type":"number","maximum":9999999999,"minimum":-9999999999,"description":"If the tender controls are created for a background process, such as the automatic payment extract, Batch Number is displayed.\n\nBatch Number is the batch number for which the tender control was created."},"autopaySource":{"type":"object","description":"Auto Pay Source Code is the financial institution / credit card company that receives the automatic payment request.","properties":{"_link":{"type":"string","description":"_link"},"autopaySourceCd":{"type":"string","maxLength":12,"description":"Auto Pay Source"}}},"externalAccountId":{"type":"string","maxLength":50,"description":"External Account ID is the customer's account number at the financial institution."},"expireDate":{"type":"string","format":"date","description":"Expires On is only needed if the Tender Type indicates that an expiration date is necessary (e.g., for a credit card payment)."},"entityName":{"type":"string","maxLength":254,"description":"Name is the customer's name in the financial institution's system."},"autopayDistributeAndFreezeDate":{"type":"string","format":"date","description":"The automatic payment is NOT distributed and frozen when the automatic payment is initially created. A separate background process distributes and freezes the automatic payment on the automatic payment GL distribution date . On the GL distribution date, the automatic payment will be interfaced to the general ledger."},"encryptedExternalAccountId":{"type":"string","maxLength":108,"description":"External Account ID is used to define the customer's bank account / credit card number.\n\nThe system supports encryption for the External Account ID. If your implementation has configured the system to encrypt the External Account ID, the data will be returned with a masked value; such as, *******."},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks.","example":"1"}}},"characteristics":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"effectiveDate":{"type":"string","format":"date","description":"Effective Date defines the date on which the characteristic becomes effective. The effective date defaults from the Installation Record.","example":"2016-01-01"},"characteristicType":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"characteristicType":{"type":"string","maxLength":8,"description":"Characteristic Type"}}},"typeOfCharacteristicValue":{"type":"string","maxLength":4,"description":"Characteristic Value indicates the value of the characteristic if the characteristic type is pre-defined or foreign key reference.","example":"02-20-2008"},"characteristicValue":{"type":"object","properties":{"_link":{"type":"string","description":"(_link)"},"value":{"type":"string","description":"(value)"},"value2":{"type":"string","description":"(value2)"},"value3":{"type":"string","description":"(value3)"},"value4":{"type":"string","description":"(value4)"},"value5":{"type":"string","description":"(value5)"}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks.","example":"1"}}}}}},"tenders":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"paymentTenderId":{"type":"string","maxLength":12,"description":"Pay Tender ID is the system-assigned unique identifier of the tender.","example":"221888888888"},"payorAccount":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"payorAccountId":{"type":"string","maxLength":10,"description":"Account ID"}}},"currency":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"currency":{"type":"string","maxLength":3,"description":"Currency Code"}}},"tenderType":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"tenderType":{"type":"string","maxLength":4,"description":"Tender Type"}}},"tenderControl":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"tenderControlId":{"type":"string","maxLength":10,"description":"Tender Control ID"}}},"isIncludedInTenderControlBalance":{"type":"boolean","description":"Included in Tender Ctl Balance"},"tenderAmount":{"type":"number","description":"Tender Amount is the amount of the tender. The amount is disabled if the payment was made in an alternate currency.","example":"$25.00"},"checkNumber":{"type":"string","maxLength":10,"description":"Check Number"},"tenderStatus":{"type":"string","enum":["25  ","60  "],"description":"Tender Status is the tender's status.\n* `25  ` - Valid,\n* `60  ` - Canceled","example":"Valid"},"cancelReason":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"cancelReason":{"type":"string","maxLength":4,"description":"Cancel Reason"}}},"adjustment":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"adjustmentId":{"type":"string","maxLength":12,"description":"Adjustment ID"}}},"customerId":{"type":"string","maxLength":36,"description":"Customer ID is the customer's account ID that appeared on the interfaced payment."},"micrId2":{"type":"string","maxLength":30,"description":"MICR ID is the value of the magnetic ink character recognition (MICR) line on the payment."},"name":{"type":"string","maxLength":40,"description":"Name is the customer's name on the interfaced payment record."},"externalReferenceId2":{"type":"string","maxLength":36,"description":"Ext. Reference ID is the unique identifier of the payment upload interface record."},"alternateCurrency":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"alternateCurrency":{"type":"string","maxLength":3,"description":"Alternate Currency Code"}}},"altTenderAmount2":{"type":"number","maximum":9999999999999.99,"minimum":-9999999999999.99,"description":"Tender Amount"},"encryptedMicrId2":{"type":"string","maxLength":64,"description":"Encrypted MICR ID"},"hashMicrId2":{"type":"string","maxLength":88,"description":"A hash representation of MICR ID field."},"tndrTypeNonCredit":{"type":"string","description":"(tndrTypeNonCredit)"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks.","example":"1"},"autoPayClearing":{"type":"object","properties":{"autopayClearingId":{"type":"string","maxLength":12,"description":"Auto Pay Clearing ID is PK of the auto pay staging record."},"accountAutoPay":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"accountAutoPayId":{"type":"string","maxLength":10,"description":"Auto Pay ID"}}},"bill":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"billId":{"type":"string","maxLength":12,"description":"Bill ID"}}},"scheduleExtractDate":{"type":"string","format":"date","description":"Scheduled Extract Date is the date the automatic payment request was sent / is scheduled to be sent to the financial institution."},"batchControl":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"batchControl":{"type":"string","maxLength":8,"description":"Batch Control"}}},"batchNumber":{"type":"number","maximum":9999999999,"minimum":-9999999999,"description":"If the tender controls are created for a background process, such as the automatic payment extract, Batch Number is displayed.\n\nBatch Number is the batch number for which the tender control was created."},"autopaySource":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"autopaySourceCd":{"type":"string","maxLength":12,"description":"Auto Pay Source"}}},"externalAccountId":{"type":"string","maxLength":50,"description":"External Account ID is the customer's account number at the financial institution."},"expireDate":{"type":"string","format":"date","description":"Expires On is only needed if the Tender Type indicates that an expiration date is necessary (e.g., for a credit card payment)."},"entityName":{"type":"string","maxLength":254,"description":"Name is the customer's name in the financial institution's system."},"autopayDistributeAndFreezeDate":{"type":"string","format":"date","description":"The automatic payment is NOT distributed and frozen when the automatic payment is initially created. A separate background process distributes and freezes the automatic payment on the automatic payment GL distribution date . On the GL distribution date, the automatic payment will be interfaced to the general ledger."},"encryptedExternalAccountId":{"type":"string","maxLength":108,"description":"External Account ID is used to define the customer's bank account / credit card number.\n\nThe system supports encryption for the External Account ID. If your implementation has configured the system to encrypt the External Account ID, the data will be returned with a masked value; such as, *******."},"version3":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks.","example":"1"}}},"nextActions":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"_link":{"type":"string","description":"(_link)"},"actionName":{"type":"string","description":"(actionName)"}}}}}}}}}}}},"xml":{"name":"C1CreatPayTe"}},"CREATEPAYMENTTENDER_request":{"type":"object","properties":{"paymentEvent":{"type":"object","properties":{"paymentEventId":{"type":"string","maxLength":12,"description":"Payment Event ID"}}},"paymentTenderId":{"type":"string","maxLength":12,"description":"Pay Tender ID is the system-assigned unique identifier of the tender.","example":"221888888888"},"payorAccount":{"type":"object","properties":{"payorAccountId":{"type":"string","maxLength":10,"description":"Account ID"}}},"currency":{"type":"object","description":"Currency Code defines the currency in which the account's financial transactions are expressed.","properties":{"currency":{"type":"string","maxLength":3,"description":"Currency Code"}}},"tenderType":{"type":"object","description":"Tender Type describes what was remitted (e.g., cash, check).","properties":{"tenderType":{"type":"string","maxLength":4,"description":"Tender Type"}}},"tenderControl":{"type":"object","properties":{"tenderControlId":{"type":"string","maxLength":10,"description":"Tender Control ID is the identity of the remittance processor batch or cash drawer bundle in which the tender was remitted.","example":"0225339900"}}},"tenderAmount":{"type":"number","description":"Tender Amount is the amount of the tender. The amount is disabled if the payment was made in an alternate currency.","example":"$25.00"},"checkNumber":{"type":"string","maxLength":10,"description":"If a check was used for payment, the Check Number contains the identity of the check."},"tenderStatus":{"type":"string","enum":["25  ","60  "],"description":"Tender Status is the tender's status.\n* `25  ` - Valid,\n* `60  ` - Canceled","example":"Valid"},"cancelReason":{"type":"object","description":"If the payment is canceled , the Cancel Reason is displayed.","properties":{"cancelReason":{"type":"string","maxLength":4,"description":"Cancel Reason"}}},"adjustment":{"type":"object","properties":{"adjustmentId":{"type":"string","maxLength":12,"description":"Adjustment ID is displayed if there is an adjustment associated with the payment."}}},"customerId":{"type":"string","maxLength":36,"description":"Customer ID is the customer's account ID that appeared on the interfaced payment."},"micrId":{"type":"string","maxLength":30,"description":"MICR ID is the value of the magnetic ink character recognition (MICR) line on the payment."},"name":{"type":"string","maxLength":40,"description":"Name is the customer's name on the interfaced payment record."},"externalReferenceId":{"type":"string","maxLength":36,"description":"Ext. Reference ID is the unique identifier of the payment upload interface record."},"alternateCurrency":{"type":"object","description":"If the payment tender was remitted in an alternate currency, i.e. a currency other than the payor account's currency.","properties":{"alternateCurrency":{"type":"string","maxLength":3,"description":"If the payment tender was remitted in an alternate currency, i.e. a currency other than the payor account's currency."}}},"alternateTenderAmount":{"type":"object","description":"Tender Amount","properties":{"alternateTenderAmount":{"type":"number","maximum":9999999999999.99,"minimum":-9999999999999.99,"description":"Tender Amount"}}},"encryptedMicrId":{"type":"string","maxLength":64,"description":"Encrypted MICR ID"},"hashMicrId":{"type":"string","maxLength":88,"description":"A hash representation of MICR ID field."},"tndrTypeNonCredit":{"type":"string","description":"(tndrTypeNonCredit)"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks.","example":"1"},"autoPayClearing":{"type":"object","properties":{"autopayClearingId":{"type":"string","maxLength":12,"description":"Auto Pay Clearing ID is PK of the auto pay staging record."},"accountAutoPay":{"type":"object","properties":{"accountAutoPayId":{"type":"string","maxLength":10,"description":"Auto Pay ID is the unique, system-assigned identifier of the auto-pay record."}}},"bill":{"type":"object","properties":{"billId":{"type":"string","maxLength":12,"description":"Bill ID"}}},"scheduleExtractDate":{"type":"string","format":"date","description":"Scheduled Extract Date is the date the automatic payment request was sent / is scheduled to be sent to the financial institution."},"batchControl":{"type":"object","description":"If the tender controls are created for a background process, such as the automatic payment extract, Batch Code is displayed.\n\nBatch Code is the batch code for which the tender control was created.","properties":{"batchControl":{"type":"string","maxLength":8,"description":"If the tender controls are created for a background process, such as the automatic payment extract, Batch Code is displayed.\n\nBatch Code is the batch code for which the tender control was created."}}},"batchNumber":{"type":"number","maximum":9999999999,"minimum":-9999999999,"description":"If the tender controls are created for a background process, such as the automatic payment extract, Batch Number is displayed.\n\nBatch Number is the batch number for which the tender control was created."},"autopaySource":{"type":"object","description":"Auto Pay Source Code is the financial institution / credit card company that receives the automatic payment request.","properties":{"autopaySourceCd":{"type":"string","maxLength":12,"description":"Auto Pay Source"}}},"externalAccountId":{"type":"string","maxLength":50,"description":"External Account ID is the customer's account number at the financial institution."},"expireDate":{"type":"string","format":"date","description":"Expires On is only needed if the Tender Type indicates that an expiration date is necessary (e.g., for a credit card payment)."},"entityName":{"type":"string","maxLength":254,"description":"Name is the customer's name in the financial institution's system."},"autopayDistributeAndFreezeDate":{"type":"string","format":"date","description":"The automatic payment is NOT distributed and frozen when the automatic payment is initially created. A separate background process distributes and freezes the automatic payment on the automatic payment GL distribution date . On the GL distribution date, the automatic payment will be interfaced to the general ledger."},"encryptedExternalAccountId":{"type":"string","maxLength":108,"description":"External Account ID is used to define the customer's bank account / credit card number.\n\nThe system supports encryption for the External Account ID. If your implementation has configured the system to encrypt the External Account ID, the data will be returned with a masked value; such as, *******."},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks.","example":"1"}}},"characteristics":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"effectiveDate":{"type":"string","format":"date","description":"Effective Date defines the date on which the characteristic becomes effective. The effective date defaults from the Installation Record.","example":"2016-01-01"},"characteristicType":{"type":"object","properties":{"characteristicType":{"type":"string","maxLength":8,"description":"Characteristic Type"}}},"typeOfCharacteristicValue":{"type":"string","maxLength":4,"description":"Characteristic Value indicates the value of the characteristic if the characteristic type is pre-defined or foreign key reference.","example":"02-20-2008"},"characteristicValue":{"type":"object","properties":{"_link":{"type":"string","description":"(_link)"},"value":{"type":"string","description":"(value)"},"value2":{"type":"string","description":"(value2)"},"value3":{"type":"string","description":"(value3)"},"value4":{"type":"string","description":"(value4)"},"value5":{"type":"string","description":"(value5)"}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks.","example":"1"}}}}}},"tenders":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"paymentTenderId":{"type":"string","maxLength":12,"description":"Pay Tender ID is the system-assigned unique identifier of the tender.","example":"221888888888"},"payorAccount":{"type":"object","properties":{"payorAccountId":{"type":"string","maxLength":10,"description":"Account ID"}}},"currency":{"type":"object","properties":{"currency":{"type":"string","maxLength":3,"description":"Currency Code"}}},"tenderType":{"type":"object","properties":{"tenderType":{"type":"string","maxLength":4,"description":"Tender Type"}}},"tenderControl":{"type":"object","properties":{"tenderControlId":{"type":"string","maxLength":10,"description":"Tender Control ID"}}},"isIncludedInTenderControlBalance":{"type":"boolean","description":"Included in Tender Ctl Balance"},"tenderAmount":{"type":"number","description":"Tender Amount is the amount of the tender. The amount is disabled if the payment was made in an alternate currency.","example":"$25.00"},"checkNumber":{"type":"string","maxLength":10,"description":"Check Number"},"tenderStatus":{"type":"string","enum":["25  ","60  "],"description":"Tender Status is the tender's status.\n* `25  ` - Valid,\n* `60  ` - Canceled","example":"Valid"},"cancelReason":{"type":"object","properties":{"cancelReason":{"type":"string","maxLength":4,"description":"Cancel Reason"}}},"adjustment":{"type":"object","properties":{"adjustmentId":{"type":"string","maxLength":12,"description":"Adjustment ID"}}},"customerId":{"type":"string","maxLength":36,"description":"Customer ID is the customer's account ID that appeared on the interfaced payment."},"micrId2":{"type":"string","maxLength":30,"description":"MICR ID is the value of the magnetic ink character recognition (MICR) line on the payment."},"name":{"type":"string","maxLength":40,"description":"Name is the customer's name on the interfaced payment record."},"externalReferenceId2":{"type":"string","maxLength":36,"description":"Ext. Reference ID is the unique identifier of the payment upload interface record."},"alternateCurrency":{"type":"object","properties":{"alternateCurrency":{"type":"string","maxLength":3,"description":"Alternate Currency Code"}}},"altTenderAmount2":{"type":"number","maximum":9999999999999.99,"minimum":-9999999999999.99,"description":"Tender Amount"},"encryptedMicrId2":{"type":"string","maxLength":64,"description":"Encrypted MICR ID"},"hashMicrId2":{"type":"string","maxLength":88,"description":"A hash representation of MICR ID field."},"tndrTypeNonCredit":{"type":"string","description":"(tndrTypeNonCredit)"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks.","example":"1"},"autoPayClearing":{"type":"object","properties":{"autopayClearingId":{"type":"string","maxLength":12,"description":"Auto Pay Clearing ID is PK of the auto pay staging record."},"accountAutoPay":{"type":"object","properties":{"accountAutoPayId":{"type":"string","maxLength":10,"description":"Auto Pay ID"}}},"bill":{"type":"object","properties":{"billId":{"type":"string","maxLength":12,"description":"Bill ID"}}},"scheduleExtractDate":{"type":"string","format":"date","description":"Scheduled Extract Date is the date the automatic payment request was sent / is scheduled to be sent to the financial institution."},"batchControl":{"type":"object","properties":{"batchControl":{"type":"string","maxLength":8,"description":"Batch Control"}}},"batchNumber":{"type":"number","maximum":9999999999,"minimum":-9999999999,"description":"If the tender controls are created for a background process, such as the automatic payment extract, Batch Number is displayed.\n\nBatch Number is the batch number for which the tender control was created."},"autopaySource":{"type":"object","properties":{"autopaySourceCd":{"type":"string","maxLength":12,"description":"Auto Pay Source"}}},"externalAccountId":{"type":"string","maxLength":50,"description":"External Account ID is the customer's account number at the financial institution."},"expireDate":{"type":"string","format":"date","description":"Expires On is only needed if the Tender Type indicates that an expiration date is necessary (e.g., for a credit card payment)."},"entityName":{"type":"string","maxLength":254,"description":"Name is the customer's name in the financial institution's system."},"autopayDistributeAndFreezeDate":{"type":"string","format":"date","description":"The automatic payment is NOT distributed and frozen when the automatic payment is initially created. A separate background process distributes and freezes the automatic payment on the automatic payment GL distribution date . On the GL distribution date, the automatic payment will be interfaced to the general ledger."},"encryptedExternalAccountId":{"type":"string","maxLength":108,"description":"External Account ID is used to define the customer's bank account / credit card number.\n\nThe system supports encryption for the External Account ID. If your implementation has configured the system to encrypt the External Account ID, the data will be returned with a masked value; such as, *******."},"version3":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks.","example":"1"}}},"nextActions":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"_link":{"type":"string","description":"(_link)"},"actionName":{"type":"string","description":"(actionName)"}}}}}}}}}}}},"xml":{"name":"C1CreatPayTe"}},"ACTIONPAYMENTTENDER_request":{"type":"object","properties":{"paymentTenderId":{"type":"string","maxLength":12,"description":"Pay Tender ID is the system-assigned unique identifier of the tender.","example":"221888888888"},"_self":{"type":"string","description":"(_self)"},"name":{"type":"string","description":"(name)"},"cancelReason":{"type":"string","maxLength":4,"description":"If the payment is canceled , the Cancel Reason is displayed.","example":"Data entry error"}},"xml":{"name":"C1-ActPytTdr"}},"GETPAYMENTTENDER_response":{"type":"object","properties":{"_self":{"type":"string","description":"_self"},"paymentEvent":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"paymentEventId":{"type":"string","maxLength":12,"description":"Payment Event ID"}}},"paymentTenderId":{"type":"string","maxLength":12,"description":"Pay Tender ID is the system-assigned unique identifier of the tender.","example":"221888888888"},"payorAccount":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"payorAccountId":{"type":"string","maxLength":10,"description":"Account ID"}}},"currency":{"type":"object","description":"Currency Code defines the currency in which the account's financial transactions are expressed.","properties":{"_link":{"type":"string","description":"_link"},"currency":{"type":"string","maxLength":3,"description":"Currency Code"}}},"tenderType":{"type":"object","description":"Tender Type describes what was remitted (e.g., cash, check).","properties":{"_link":{"type":"string","description":"_link"},"tenderType":{"type":"string","maxLength":4,"description":"Tender Type"}}},"tenderControl":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"tenderControlId":{"type":"string","maxLength":10,"description":"Tender Control ID is the identity of the remittance processor batch or cash drawer bundle in which the tender was remitted.","example":"0225339900"}}},"tenderAmount":{"type":"number","description":"Tender Amount is the amount of the tender. The amount is disabled if the payment was made in an alternate currency.","example":"$25.00"},"checkNumber":{"type":"string","maxLength":10,"description":"If a check was used for payment, the Check Number contains the identity of the check."},"tenderStatus":{"type":"string","enum":["25  ","60  "],"description":"Tender Status is the tender's status.\n* `25  ` - Valid,\n* `60  ` - Canceled","example":"Valid"},"cancelReason":{"type":"object","description":"If the payment is canceled , the Cancel Reason is displayed.","properties":{"_link":{"type":"string","description":"_link"},"cancelReason":{"type":"string","maxLength":4,"description":"Cancel Reason"}}},"adjustment":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"adjustmentId":{"type":"string","maxLength":12,"description":"Adjustment ID is displayed if there is an adjustment associated with the payment."}}},"customerId":{"type":"string","maxLength":36,"description":"Customer ID is the customer's account ID that appeared on the interfaced payment."},"micrId":{"type":"string","maxLength":30,"description":"MICR ID is the value of the magnetic ink character recognition (MICR) line on the payment."},"name":{"type":"string","maxLength":40,"description":"Name is the customer's name on the interfaced payment record."},"externalReferenceId":{"type":"string","maxLength":36,"description":"Ext. Reference ID is the unique identifier of the payment upload interface record."},"alternateCurrency":{"type":"object","description":"If the payment tender was remitted in an alternate currency, i.e. a currency other than the payor account's currency.","properties":{"_link":{"type":"string","description":"_link"},"alternateCurrency":{"type":"string","maxLength":3,"description":"If the payment tender was remitted in an alternate currency, i.e. a currency other than the payor account's currency."}}},"alternateTenderAmount":{"type":"object","description":"Tender Amount","properties":{"_link":{"type":"string","description":"_link"},"alternateTenderAmount":{"type":"number","maximum":9999999999999.99,"minimum":-9999999999999.99,"description":"Tender Amount"}}},"encryptedMicrId":{"type":"string","maxLength":64,"description":"Encrypted MICR ID"},"hashMicrId":{"type":"string","maxLength":88,"description":"A hash representation of MICR ID field."},"tndrTypeNonCredit":{"type":"string","description":"(tndrTypeNonCredit)"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks.","example":"1"},"autoPayClearing":{"type":"object","properties":{"autopayClearingId":{"type":"string","maxLength":12,"description":"Auto Pay Clearing ID is PK of the auto pay staging record."},"accountAutoPay":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"accountAutoPayId":{"type":"string","maxLength":10,"description":"Auto Pay ID is the unique, system-assigned identifier of the auto-pay record."}}},"bill":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"billId":{"type":"string","maxLength":12,"description":"Bill ID"}}},"scheduleExtractDate":{"type":"string","format":"date","description":"Scheduled Extract Date is the date the automatic payment request was sent / is scheduled to be sent to the financial institution."},"batchControl":{"type":"object","description":"If the tender controls are created for a background process, such as the automatic payment extract, Batch Code is displayed.\n\nBatch Code is the batch code for which the tender control was created.","properties":{"_link":{"type":"string","description":"_link"},"batchControl":{"type":"string","maxLength":8,"description":"If the tender controls are created for a background process, such as the automatic payment extract, Batch Code is displayed.\n\nBatch Code is the batch code for which the tender control was created."}}},"batchNumber":{"type":"number","maximum":9999999999,"minimum":-9999999999,"description":"If the tender controls are created for a background process, such as the automatic payment extract, Batch Number is displayed.\n\nBatch Number is the batch number for which the tender control was created."},"autopaySource":{"type":"object","description":"Auto Pay Source Code is the financial institution / credit card company that receives the automatic payment request.","properties":{"_link":{"type":"string","description":"_link"},"autopaySourceCd":{"type":"string","maxLength":12,"description":"Auto Pay Source"}}},"externalAccountId":{"type":"string","maxLength":50,"description":"External Account ID is the customer's account number at the financial institution."},"expireDate":{"type":"string","format":"date","description":"Expires On is only needed if the Tender Type indicates that an expiration date is necessary (e.g., for a credit card payment)."},"entityName":{"type":"string","maxLength":254,"description":"Name is the customer's name in the financial institution's system."},"autopayDistributeAndFreezeDate":{"type":"string","format":"date","description":"The automatic payment is NOT distributed and frozen when the automatic payment is initially created. A separate background process distributes and freezes the automatic payment on the automatic payment GL distribution date . On the GL distribution date, the automatic payment will be interfaced to the general ledger."},"encryptedExternalAccountId":{"type":"string","maxLength":108,"description":"External Account ID is used to define the customer's bank account / credit card number.\n\nThe system supports encryption for the External Account ID. If your implementation has configured the system to encrypt the External Account ID, the data will be returned with a masked value; such as, *******."},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks.","example":"1"}}},"characteristics":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"effectiveDate":{"type":"string","format":"date","description":"Effective Date defines the date on which the characteristic becomes effective. The effective date defaults from the Installation Record.","example":"2016-01-01"},"characteristicType":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"characteristicType":{"type":"string","maxLength":8,"description":"Characteristic Type"}}},"typeOfCharacteristicValue":{"type":"string","maxLength":4,"description":"Characteristic Value indicates the value of the characteristic if the characteristic type is pre-defined or foreign key reference.","example":"02-20-2008"},"characteristicValue":{"type":"object","properties":{"_link":{"type":"string","description":"(_link)"},"value":{"type":"string","description":"(value)"},"value2":{"type":"string","description":"(value2)"},"value3":{"type":"string","description":"(value3)"},"value4":{"type":"string","description":"(value4)"},"value5":{"type":"string","description":"(value5)"}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks.","example":"1"}}}}}},"nextActions":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"_link":{"type":"string","description":"(_link)"},"actionName":{"type":"string","description":"(actionName)"}}}}}}},"xml":{"name":"C1PaymTender"}},"ACTIONPAYMENTTENDER_response":{"type":"object","properties":{"paymentTenderId":{"type":"string","maxLength":12,"description":"Pay Tender ID is the system-assigned unique identifier of the tender.","example":"221888888888"},"_self":{"type":"string","description":"(_self)"},"name":{"type":"string","description":"(name)"},"cancelReason":{"type":"string","maxLength":4,"description":"If the payment is canceled , the Cancel Reason is displayed.","example":"Data entry error"}},"xml":{"name":"C1-ActPytTdr"}},"UPDATEPAYMENTTENDER_response":{"type":"object","properties":{"_self":{"type":"string","description":"_self"},"paymentEvent":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"paymentEventId":{"type":"string","maxLength":12,"description":"Payment Event ID"}}},"paymentTenderId":{"type":"string","maxLength":12,"description":"Pay Tender ID is the system-assigned unique identifier of the tender.","example":"221888888888"},"payorAccount":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"payorAccountId":{"type":"string","maxLength":10,"description":"Account ID"}}},"currency":{"type":"object","description":"Currency Code defines the currency in which the account's financial transactions are expressed.","properties":{"_link":{"type":"string","description":"_link"},"currency":{"type":"string","maxLength":3,"description":"Currency Code"}}},"tenderType":{"type":"object","description":"Tender Type describes what was remitted (e.g., cash, check).","properties":{"_link":{"type":"string","description":"_link"},"tenderType":{"type":"string","maxLength":4,"description":"Tender Type"}}},"tenderControl":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"tenderControlId":{"type":"string","maxLength":10,"description":"Tender Control ID is the identity of the remittance processor batch or cash drawer bundle in which the tender was remitted.","example":"0225339900"}}},"tenderAmount":{"type":"number","description":"Tender Amount is the amount of the tender. The amount is disabled if the payment was made in an alternate currency.","example":"$25.00"},"checkNumber":{"type":"string","maxLength":10,"description":"If a check was used for payment, the Check Number contains the identity of the check."},"tenderStatus":{"type":"string","enum":["25  ","60  "],"description":"Tender Status is the tender's status.\n* `25  ` - Valid,\n* `60  ` - Canceled","example":"Valid"},"cancelReason":{"type":"object","description":"If the payment is canceled , the Cancel Reason is displayed.","properties":{"_link":{"type":"string","description":"_link"},"cancelReason":{"type":"string","maxLength":4,"description":"Cancel Reason"}}},"adjustment":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"adjustmentId":{"type":"string","maxLength":12,"description":"Adjustment ID is displayed if there is an adjustment associated with the payment."}}},"customerId":{"type":"string","maxLength":36,"description":"Customer ID is the customer's account ID that appeared on the interfaced payment."},"micrId":{"type":"string","maxLength":30,"description":"MICR ID is the value of the magnetic ink character recognition (MICR) line on the payment."},"name":{"type":"string","maxLength":40,"description":"Name is the customer's name on the interfaced payment record."},"externalReferenceId":{"type":"string","maxLength":36,"description":"Ext. Reference ID is the unique identifier of the payment upload interface record."},"alternateCurrency":{"type":"object","description":"If the payment tender was remitted in an alternate currency, i.e. a currency other than the payor account's currency.","properties":{"_link":{"type":"string","description":"_link"},"alternateCurrency":{"type":"string","maxLength":3,"description":"If the payment tender was remitted in an alternate currency, i.e. a currency other than the payor account's currency."}}},"alternateTenderAmount":{"type":"object","description":"Tender Amount","properties":{"_link":{"type":"string","description":"_link"},"alternateTenderAmount":{"type":"number","maximum":9999999999999.99,"minimum":-9999999999999.99,"description":"Tender Amount"}}},"encryptedMicrId":{"type":"string","maxLength":64,"description":"Encrypted MICR ID"},"hashMicrId":{"type":"string","maxLength":88,"description":"A hash representation of MICR ID field."},"tndrTypeNonCredit":{"type":"string","description":"(tndrTypeNonCredit)"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks.","example":"1"},"autoPayClearing":{"type":"object","properties":{"autopayClearingId":{"type":"string","maxLength":12,"description":"Auto Pay Clearing ID is PK of the auto pay staging record."},"accountAutoPay":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"accountAutoPayId":{"type":"string","maxLength":10,"description":"Auto Pay ID is the unique, system-assigned identifier of the auto-pay record."}}},"bill":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"billId":{"type":"string","maxLength":12,"description":"Bill ID"}}},"scheduleExtractDate":{"type":"string","format":"date","description":"Scheduled Extract Date is the date the automatic payment request was sent / is scheduled to be sent to the financial institution."},"batchControl":{"type":"object","description":"If the tender controls are created for a background process, such as the automatic payment extract, Batch Code is displayed.\n\nBatch Code is the batch code for which the tender control was created.","properties":{"_link":{"type":"string","description":"_link"},"batchControl":{"type":"string","maxLength":8,"description":"If the tender controls are created for a background process, such as the automatic payment extract, Batch Code is displayed.\n\nBatch Code is the batch code for which the tender control was created."}}},"batchNumber":{"type":"number","maximum":9999999999,"minimum":-9999999999,"description":"If the tender controls are created for a background process, such as the automatic payment extract, Batch Number is displayed.\n\nBatch Number is the batch number for which the tender control was created."},"autopaySource":{"type":"object","description":"Auto Pay Source Code is the financial institution / credit card company that receives the automatic payment request.","properties":{"_link":{"type":"string","description":"_link"},"autopaySourceCd":{"type":"string","maxLength":12,"description":"Auto Pay Source"}}},"externalAccountId":{"type":"string","maxLength":50,"description":"External Account ID is the customer's account number at the financial institution."},"expireDate":{"type":"string","format":"date","description":"Expires On is only needed if the Tender Type indicates that an expiration date is necessary (e.g., for a credit card payment)."},"entityName":{"type":"string","maxLength":254,"description":"Name is the customer's name in the financial institution's system."},"autopayDistributeAndFreezeDate":{"type":"string","format":"date","description":"The automatic payment is NOT distributed and frozen when the automatic payment is initially created. A separate background process distributes and freezes the automatic payment on the automatic payment GL distribution date . On the GL distribution date, the automatic payment will be interfaced to the general ledger."},"encryptedExternalAccountId":{"type":"string","maxLength":108,"description":"External Account ID is used to define the customer's bank account / credit card number.\n\nThe system supports encryption for the External Account ID. If your implementation has configured the system to encrypt the External Account ID, the data will be returned with a masked value; such as, *******."},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks.","example":"1"}}},"characteristics":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"effectiveDate":{"type":"string","format":"date","description":"Effective Date defines the date on which the characteristic becomes effective. The effective date defaults from the Installation Record.","example":"2016-01-01"},"characteristicType":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"characteristicType":{"type":"string","maxLength":8,"description":"Characteristic Type"}}},"typeOfCharacteristicValue":{"type":"string","maxLength":4,"description":"Characteristic Value indicates the value of the characteristic if the characteristic type is pre-defined or foreign key reference.","example":"02-20-2008"},"characteristicValue":{"type":"object","properties":{"_link":{"type":"string","description":"(_link)"},"value":{"type":"string","description":"(value)"},"value2":{"type":"string","description":"(value2)"},"value3":{"type":"string","description":"(value3)"},"value4":{"type":"string","description":"(value4)"},"value5":{"type":"string","description":"(value5)"}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks.","example":"1"}}}}}},"nextActions":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"_link":{"type":"string","description":"(_link)"},"actionName":{"type":"string","description":"(actionName)"}}}}}}},"xml":{"name":"C1PaymTender"}},"UPDATEPAYMENTTENDER_request":{"type":"object","properties":{"paymentEvent":{"type":"object","properties":{"paymentEventId":{"type":"string","maxLength":12,"description":"Payment Event ID"}}},"paymentTenderId":{"type":"string","maxLength":12,"description":"Pay Tender ID is the system-assigned unique identifier of the tender.","example":"221888888888"},"payorAccount":{"type":"object","properties":{"payorAccountId":{"type":"string","maxLength":10,"description":"Account ID"}}},"currency":{"type":"object","description":"Currency Code defines the currency in which the account's financial transactions are expressed.","properties":{"currency":{"type":"string","maxLength":3,"description":"Currency Code"}}},"tenderType":{"type":"object","description":"Tender Type describes what was remitted (e.g., cash, check).","properties":{"tenderType":{"type":"string","maxLength":4,"description":"Tender Type"}}},"tenderControl":{"type":"object","properties":{"tenderControlId":{"type":"string","maxLength":10,"description":"Tender Control ID is the identity of the remittance processor batch or cash drawer bundle in which the tender was remitted.","example":"0225339900"}}},"tenderAmount":{"type":"number","description":"Tender Amount is the amount of the tender. The amount is disabled if the payment was made in an alternate currency.","example":"$25.00"},"checkNumber":{"type":"string","maxLength":10,"description":"If a check was used for payment, the Check Number contains the identity of the check."},"tenderStatus":{"type":"string","enum":["25  ","60  "],"description":"Tender Status is the tender's status.\n* `25  ` - Valid,\n* `60  ` - Canceled","example":"Valid"},"cancelReason":{"type":"object","description":"If the payment is canceled , the Cancel Reason is displayed.","properties":{"cancelReason":{"type":"string","maxLength":4,"description":"Cancel Reason"}}},"adjustment":{"type":"object","properties":{"adjustmentId":{"type":"string","maxLength":12,"description":"Adjustment ID is displayed if there is an adjustment associated with the payment."}}},"customerId":{"type":"string","maxLength":36,"description":"Customer ID is the customer's account ID that appeared on the interfaced payment."},"micrId":{"type":"string","maxLength":30,"description":"MICR ID is the value of the magnetic ink character recognition (MICR) line on the payment."},"name":{"type":"string","maxLength":40,"description":"Name is the customer's name on the interfaced payment record."},"externalReferenceId":{"type":"string","maxLength":36,"description":"Ext. Reference ID is the unique identifier of the payment upload interface record."},"alternateCurrency":{"type":"object","description":"If the payment tender was remitted in an alternate currency, i.e. a currency other than the payor account's currency.","properties":{"alternateCurrency":{"type":"string","maxLength":3,"description":"If the payment tender was remitted in an alternate currency, i.e. a currency other than the payor account's currency."}}},"alternateTenderAmount":{"type":"object","description":"Tender Amount","properties":{"alternateTenderAmount":{"type":"number","maximum":9999999999999.99,"minimum":-9999999999999.99,"description":"Tender Amount"}}},"encryptedMicrId":{"type":"string","maxLength":64,"description":"Encrypted MICR ID"},"hashMicrId":{"type":"string","maxLength":88,"description":"A hash representation of MICR ID field."},"tndrTypeNonCredit":{"type":"string","description":"(tndrTypeNonCredit)"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks.","example":"1"},"autoPayClearing":{"type":"object","properties":{"autopayClearingId":{"type":"string","maxLength":12,"description":"Auto Pay Clearing ID is PK of the auto pay staging record."},"accountAutoPay":{"type":"object","properties":{"accountAutoPayId":{"type":"string","maxLength":10,"description":"Auto Pay ID is the unique, system-assigned identifier of the auto-pay record."}}},"bill":{"type":"object","properties":{"billId":{"type":"string","maxLength":12,"description":"Bill ID"}}},"scheduleExtractDate":{"type":"string","format":"date","description":"Scheduled Extract Date is the date the automatic payment request was sent / is scheduled to be sent to the financial institution."},"batchControl":{"type":"object","description":"If the tender controls are created for a background process, such as the automatic payment extract, Batch Code is displayed.\n\nBatch Code is the batch code for which the tender control was created.","properties":{"batchControl":{"type":"string","maxLength":8,"description":"If the tender controls are created for a background process, such as the automatic payment extract, Batch Code is displayed.\n\nBatch Code is the batch code for which the tender control was created."}}},"batchNumber":{"type":"number","maximum":9999999999,"minimum":-9999999999,"description":"If the tender controls are created for a background process, such as the automatic payment extract, Batch Number is displayed.\n\nBatch Number is the batch number for which the tender control was created."},"autopaySource":{"type":"object","description":"Auto Pay Source Code is the financial institution / credit card company that receives the automatic payment request.","properties":{"autopaySourceCd":{"type":"string","maxLength":12,"description":"Auto Pay Source"}}},"externalAccountId":{"type":"string","maxLength":50,"description":"External Account ID is the customer's account number at the financial institution."},"expireDate":{"type":"string","format":"date","description":"Expires On is only needed if the Tender Type indicates that an expiration date is necessary (e.g., for a credit card payment)."},"entityName":{"type":"string","maxLength":254,"description":"Name is the customer's name in the financial institution's system."},"autopayDistributeAndFreezeDate":{"type":"string","format":"date","description":"The automatic payment is NOT distributed and frozen when the automatic payment is initially created. A separate background process distributes and freezes the automatic payment on the automatic payment GL distribution date . On the GL distribution date, the automatic payment will be interfaced to the general ledger."},"encryptedExternalAccountId":{"type":"string","maxLength":108,"description":"External Account ID is used to define the customer's bank account / credit card number.\n\nThe system supports encryption for the External Account ID. If your implementation has configured the system to encrypt the External Account ID, the data will be returned with a masked value; such as, *******."},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks.","example":"1"}}},"characteristics":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"effectiveDate":{"type":"string","format":"date","description":"Effective Date defines the date on which the characteristic becomes effective. The effective date defaults from the Installation Record.","example":"2016-01-01"},"characteristicType":{"type":"object","properties":{"characteristicType":{"type":"string","maxLength":8,"description":"Characteristic Type"}}},"typeOfCharacteristicValue":{"type":"string","maxLength":4,"description":"Characteristic Value indicates the value of the characteristic if the characteristic type is pre-defined or foreign key reference.","example":"02-20-2008"},"characteristicValue":{"type":"object","properties":{"_link":{"type":"string","description":"(_link)"},"value":{"type":"string","description":"(value)"},"value2":{"type":"string","description":"(value2)"},"value3":{"type":"string","description":"(value3)"},"value4":{"type":"string","description":"(value4)"},"value5":{"type":"string","description":"(value5)"}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks.","example":"1"}}}}}},"nextActions":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"_link":{"type":"string","description":"(_link)"},"actionName":{"type":"string","description":"(actionName)"}}}}}}},"xml":{"name":"C1PaymTender"}},"ACTIONPAYMENT_response":{"type":"object","properties":{"paymentId":{"type":"string","maxLength":12,"description":"Payment ID is the system-assigned unique identifier of the payment.","example":"317896608844"},"name":{"type":"string","description":"(name)"},"cancelReason":{"type":"string","maxLength":30,"description":"If the payment is canceled , the Cancel Reason is displayed.","example":"Data entry error"},"paymentStatus":{"type":"string","enum":["10  ","20  ","30  ","50  ","60  "],"description":"Payment Status is the payment's status.\n* `10  ` - Incomplete,\n* `20  ` - Error,\n* `30  ` - Freezable,\n* `50  ` - Frozen,\n* `60  ` - Canceled","example":"30"},"isPayTransfer":{"type":"boolean","description":"When Payment Transfer button is clicked, the Payment Event Transfer dialog opens to transfer a payment.","example":"true"},"transferAccountId":{"type":"string","maxLength":10,"description":"Account ID is the account to which the payment event should be transferred."},"transferNonCisName":{"type":"string","maxLength":50,"description":"Following parameters must be specified in the Payment Event Transfer dialog to transfer a payment - Non CIS Name, Reference Number, and Non CIS Comments.\n\nNon CIS Name, Reference Number, and Non CIS Comments appear if the Account ID belongs to a customer class that is used for non-CIS payments."},"transferNonCisReferenceNumber":{"type":"string","maxLength":30,"description":"Following parameters must be specified in the Payment Event Transfer dialog to transfer a payment - Non CIS Name, Reference Number, and Non CIS Comments.\n\nNon CIS Name, Reference Number, and Non CIS Comments appear if the Account ID belongs to a customer class that is used for non-CIS payments."},"transferNonCISComment":{"type":"string","maxLength":254,"description":"Following parameters must be specified in the Payment Event Transfer dialog to transfer a payment - Non CIS Name, Reference Number, and Non CIS Comments.\n\nNon CIS Name, Reference Number, and Non CIS Comments appear if the Account ID belongs to a customer class that is used for non-CIS payments."},"transferCancelReason":{"type":"string","maxLength":4,"description":"Cancel Reason defines why you are performing the payment event transfer.","example":"NSF\n\n(Non sufficient funds)"},"transferMatchType":{"type":"string","maxLength":8,"description":"Match Type and Match Value are defaulted based on their values for the payment event that you are transferring. If necessary, modify the values appropriately for the account to which you are transferring the payment event.","example":"BILL-ID\n\n(Bill ID / Sequential Bill Number)"},"transferMatchValue":{"type":"string","maxLength":30,"description":"Match Type and Match Value are defaulted based on their values for the payment event that you are transferring. If necessary, modify the values appropriately for the account to which you are transferring the payment event.","example":"995516242555"},"nextActions":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"actionName":{"type":"string","description":"(actionName)"},"_link":{"type":"string","description":"(_link)"}}}}}}},"xml":{"name":"C1ActionPyt"}},"UPDATEPAYMENT_response":{"type":"object","properties":{"_self":{"type":"string","description":"_self"},"paymentId":{"type":"string","maxLength":12,"description":"Payment ID is the system-assigned unique identifier of the payment.","example":"317896608844"},"paymentEvent":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"paymentEventId":{"type":"string","maxLength":12,"description":"Payment Event ID is the system-assigned unique identifier of the payment event.","example":"317772795000"},"PayEventException":{"type":"string","maxLength":30,"description":"Exception Messages"}}},"cancelReason":{"type":"string","maxLength":30,"description":"If the payment is canceled , the Cancel Reason is displayed.","example":"Data entry error"},"currency":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"currency":{"type":"string","maxLength":3,"description":"Currency Code"}}},"account":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"accountId":{"type":"string","maxLength":10,"description":"Account ID"}}},"paymentStatus":{"type":"string","enum":["10  ","20  ","30  ","50  ","60  "],"description":"Payment Status is the payment's status.\n* `10  ` - Incomplete,\n* `20  ` - Error,\n* `30  ` - Freezable,\n* `50  ` - Frozen,\n* `60  ` - Canceled","example":"30"},"paymentAmount":{"type":"number","description":"Payment Amount is the amount of the payment. This field is gray after the payment is frozen.","example":"300"},"nonCisName":{"type":"string","maxLength":50,"description":"If the payment is linked to an Account ID that belongs to a customer class that is used for non-CIS payments, the following fields appear (note, these fields are gray after the payment is frozen):\n\n    Name is the name of the person remitting the payment.\n    Reference Number is the reference number of the item being paid (e.g., the property tax reference number).\n    Comments are used to describe anything unusual about the non-CIS payment.","example":"ZZMXA,CX_test"},"nonCisReferenceNumber":{"type":"string","maxLength":30,"description":"If the payment is linked to an Account ID that belongs to a customer class that is used for non-CIS payments, the following fields appear (note, these fields are gray after the payment is frozen):\n\n    Name is the name of the person remitting the payment.\n    Reference Number is the reference number of the item being paid (e.g., the property tax reference number).\n    Comments are used to describe anything unusual about the non-CIS payment."},"nonCisComments":{"type":"string","maxLength":254,"description":"If the payment is linked to an Account ID that belongs to a customer class that is used for non-CIS payments, the following fields appear (note, these fields are gray after the payment is frozen):\n\n    Name is the name of the person remitting the payment.\n    Reference Number is the reference number of the item being paid (e.g., the property tax reference number).\n    Comments are used to describe anything unusual about the non-CIS payment."},"matchType":{"type":"object","description":"Match Type and Match Value will only be used if either of the following conditions is true:\n\n    The Account ID belongs to an open item customer class. In this situation, specify a Match Type to define how the payment should be matched to the customer's open-items and use Match Value to define the open-items covered by the payment\n    The customer wants to restrict the distribution of the payment to a specific service agreement. In this situation, specify a Match Type of \"service agreement ID\" and a Match Value of the respective service agreement ID.\n\nMatch Type and Match Value are gray after the payment is frozen.","properties":{"_link":{"type":"string","description":"_link"},"matchType":{"type":"string","maxLength":8,"description":"Match Type and Match Value will only be used if either of the following conditions is true:\n\n    The Account ID belongs to an open item customer class. In this situation, specify a Match Type to define how the payment should be matched to the customer's open-items and use Match Value to define the open-items covered by the payment\n    The customer wants to restrict the distribution of the payment to a specific service agreement. In this situation, specify a Match Type of \"service agreement ID\" and a Match Value of the respective service agreement ID.\n\nMatch Type and Match Value are gray after the payment is frozen."}}},"matchValue":{"type":"string","maxLength":30,"description":"Match Type and Match Value will only be used if either of the following conditions is true:\n\n    The Account ID belongs to an open item customer class. In this situation, specify a Match Type to define how the payment should be matched to the customer's open-items and use Match Value to define the open-items covered by the payment\n    The customer wants to restrict the distribution of the payment to a specific service agreement. In this situation, specify a Match Type of \"service agreement ID\" and a Match Value of the respective service agreement ID.\n\nMatch Type and Match Value are gray after the payment is frozen."},"accountCheckDigit":{"type":"string","maxLength":1,"description":"Account Check Digit"},"paymentAccountCash":{"type":"string","maxLength":30,"description":"Use Cash-Only Threshold to define the number of cash-only points a customer must have before the system warns the CSR accepting payments that the account is cash-only."},"isOpenItemAccounting":{"type":"boolean","description":"Open Item Accounting Switch","example":"false"},"isNonCISAccount":{"type":"boolean","description":"Non-CIS Account Switch","example":"true"},"isPayTransfer":{"type":"boolean","description":"When Payment Transfer button is clicked, the Payment Event Transfer dialog opens to transfer a payment.","example":"true"},"transferAccountId":{"type":"string","maxLength":10,"description":"Account ID is the account to which the payment event should be transferred."},"transferNonCisName":{"type":"string","maxLength":50,"description":"Following parameters must be specified in the Payment Event Transfer dialog to transfer a payment - Non CIS Name, Reference Number, and Non CIS Comments.\n\nNon CIS Name, Reference Number, and Non CIS Comments appear if the Account ID belongs to a customer class that is used for non-CIS payments."},"transferNonCisReferenceNumber":{"type":"string","maxLength":30,"description":"Following parameters must be specified in the Payment Event Transfer dialog to transfer a payment - Non CIS Name, Reference Number, and Non CIS Comments.\n\nNon CIS Name, Reference Number, and Non CIS Comments appear if the Account ID belongs to a customer class that is used for non-CIS payments."},"transferNonCISComment":{"type":"string","maxLength":254,"description":"Following parameters must be specified in the Payment Event Transfer dialog to transfer a payment - Non CIS Name, Reference Number, and Non CIS Comments.\n\nNon CIS Name, Reference Number, and Non CIS Comments appear if the Account ID belongs to a customer class that is used for non-CIS payments."},"transferCancelReason":{"type":"string","maxLength":4,"description":"Cancel Reason defines why you are performing the payment event transfer.","example":"NSF\n\n(Non sufficient funds)"},"transferMatchType":{"type":"string","maxLength":8,"description":"Match Type and Match Value are defaulted based on their values for the payment event that you are transferring. If necessary, modify the values appropriately for the account to which you are transferring the payment event.","example":"BILL-ID\n\n(Bill ID / Sequential Bill Number)"},"transferMatchValue":{"type":"string","maxLength":30,"description":"Match Type and Match Value are defaulted based on their values for the payment event that you are transferring. If necessary, modify the values appropriately for the account to which you are transferring the payment event.","example":"995516242555"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks.","example":"20"},"paySegments":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"paySegment":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"paySegmentId":{"type":"string","maxLength":12,"description":"Pay Segment ID"}}},"currency":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"currency":{"type":"string","maxLength":3,"description":"Currency Code"}}},"serviceAgreement":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"serviceAgreement":{"type":"string","maxLength":10,"description":"Service Agreement"}}},"paySegmentAmount":{"type":"number","description":"Distributed Amount is the amount of the service agreement's debt relieved by the payment.","example":"25.08"},"adjustment":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"adjustmentId":{"type":"string","maxLength":12,"description":"Adjustment ID"}}},"matchEvent":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"matchEventId":{"type":"string","maxLength":12,"description":"Match Event ID"}}},"financialTransaction":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"financialTransactionId":{"type":"string","maxLength":12,"description":"Financial Transaction ID"}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"}}}}}},"Exception":{"type":"object","properties":{"messageCategory":{"type":"object","description":"Message category within Oracle Utilities Application Framework.","properties":{"_link":{"type":"string","description":"_link"},"messageCategory":{"type":"number","maximum":99999,"minimum":-99999,"description":"Message category within Oracle Utilities Application Framework.","example":"11"}}},"messageNumber":{"type":"number","maximum":99999,"minimum":-99999,"description":"Message number within Oracle Utilities Application Framework.","example":"14107"},"paymentExceptionType":{"type":"string","enum":["10  ","20  ","30  ","40  "],"description":"Payment Exception Type\n* `10  ` - No Payment Segment found,\n* `20  ` - No SA found for this acct.,\n* `30  ` - Unbalanced Payment,\n* `40  ` - Payment in error","example":"40"},"expandedMessage":{"type":"string","maxLength":254,"description":"Expanded Message exception","example":"The Payment is incomplete."},"messageParameter1":{"type":"string","maxLength":2000,"description":"Message Parameter"},"messageParameter2":{"type":"string","maxLength":2000,"description":"Message Parameter"},"messageParameter3":{"type":"string","maxLength":2000,"description":"Message Parameter"},"messageParameter4":{"type":"string","maxLength":2000,"description":"Message Parameter"},"messageParameter5":{"type":"string","maxLength":2000,"description":"Message Parameter"},"messageParameter6":{"type":"string","maxLength":2000,"description":"Message Parameter"},"messageParameter7":{"type":"string","maxLength":2000,"description":"Message Parameter"},"messageParameter8":{"type":"string","maxLength":2000,"description":"Message Parameter"},"messageParameter9":{"type":"string","maxLength":2000,"description":"Message Parameter"},"callingProgramSequence":{"type":"string","maxLength":254,"description":"Calling Program Sequence"},"user":{"type":"object","description":"User","properties":{"_link":{"type":"string","description":"_link"},"user":{"type":"string","maxLength":8,"description":"User"}}},"isReviewed":{"type":"boolean","description":"Reviewed","example":"false"},"reviewUser":{"type":"object","description":"Review User","properties":{"_link":{"type":"string","description":"_link"},"reviewUser":{"type":"string","maxLength":8,"description":"Review User"}}},"reviewedDate":{"type":"string","format":"date","description":"Review Date"},"comments":{"type":"string","maxLength":254,"description":"Comments"},"creationDateTime":{"type":"string","format":"date-time","description":"Create Date/Time","example":"2010-11-24T17:49:23-05:00"},"version":{"type":"number","maximum":0,"minimum":0,"description":"The Version number is used for internal concurrency checks.","example":"1"}}},"characteristics":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"sequence":{"type":"number","maximum":999,"minimum":-999,"description":"Sequence Controls the order in which characteristics of the same type are displayed.","example":"1"},"characteristicType":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"characteristicType":{"type":"string","maxLength":8,"description":"Characteristic Type"}}},"typeOfCharacteristicValue":{"type":"string","maxLength":4,"description":"Type of Char Value"},"characteristicValue":{"type":"object","properties":{"_link":{"type":"string","description":"(_link)"},"value":{"type":"string","description":"(value)"},"value2":{"type":"string","description":"(value2)"},"value3":{"type":"string","description":"(value3)"},"value4":{"type":"string","description":"(value4)"},"value5":{"type":"string","description":"(value5)"}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks.","example":"20"}}}}}},"nextActions":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"_link":{"type":"string","description":"(_link)"},"actionName":{"type":"string","description":"(actionName)"}}}}}}},"xml":{"name":"C1-CxPayment"}},"GETPAYMENT_response":{"type":"object","properties":{"_self":{"type":"string","description":"_self"},"paymentId":{"type":"string","maxLength":12,"description":"Payment ID is the system-assigned unique identifier of the payment.","example":"317896608844"},"paymentEvent":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"paymentEventId":{"type":"string","maxLength":12,"description":"Payment Event ID is the system-assigned unique identifier of the payment event.","example":"317772795000"},"PayEventException":{"type":"string","maxLength":30,"description":"Exception Messages"}}},"cancelReason":{"type":"string","maxLength":30,"description":"If the payment is canceled , the Cancel Reason is displayed.","example":"Data entry error"},"currency":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"currency":{"type":"string","maxLength":3,"description":"Currency Code"}}},"account":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"accountId":{"type":"string","maxLength":10,"description":"Account ID"}}},"paymentStatus":{"type":"string","enum":["10  ","20  ","30  ","50  ","60  "],"description":"Payment Status is the payment's status.\n* `10  ` - Incomplete,\n* `20  ` - Error,\n* `30  ` - Freezable,\n* `50  ` - Frozen,\n* `60  ` - Canceled","example":"30"},"paymentAmount":{"type":"number","description":"Payment Amount is the amount of the payment. This field is gray after the payment is frozen.","example":"300"},"nonCisName":{"type":"string","maxLength":50,"description":"If the payment is linked to an Account ID that belongs to a customer class that is used for non-CIS payments, the following fields appear (note, these fields are gray after the payment is frozen):\n\n    Name is the name of the person remitting the payment.\n    Reference Number is the reference number of the item being paid (e.g., the property tax reference number).\n    Comments are used to describe anything unusual about the non-CIS payment.","example":"ZZMXA,CX_test"},"nonCisReferenceNumber":{"type":"string","maxLength":30,"description":"If the payment is linked to an Account ID that belongs to a customer class that is used for non-CIS payments, the following fields appear (note, these fields are gray after the payment is frozen):\n\n    Name is the name of the person remitting the payment.\n    Reference Number is the reference number of the item being paid (e.g., the property tax reference number).\n    Comments are used to describe anything unusual about the non-CIS payment."},"nonCisComments":{"type":"string","maxLength":254,"description":"If the payment is linked to an Account ID that belongs to a customer class that is used for non-CIS payments, the following fields appear (note, these fields are gray after the payment is frozen):\n\n    Name is the name of the person remitting the payment.\n    Reference Number is the reference number of the item being paid (e.g., the property tax reference number).\n    Comments are used to describe anything unusual about the non-CIS payment."},"matchType":{"type":"object","description":"Match Type and Match Value will only be used if either of the following conditions is true:\n\n    The Account ID belongs to an open item customer class. In this situation, specify a Match Type to define how the payment should be matched to the customer's open-items and use Match Value to define the open-items covered by the payment\n    The customer wants to restrict the distribution of the payment to a specific service agreement. In this situation, specify a Match Type of \"service agreement ID\" and a Match Value of the respective service agreement ID.\n\nMatch Type and Match Value are gray after the payment is frozen.","properties":{"_link":{"type":"string","description":"_link"},"matchType":{"type":"string","maxLength":8,"description":"Match Type and Match Value will only be used if either of the following conditions is true:\n\n    The Account ID belongs to an open item customer class. In this situation, specify a Match Type to define how the payment should be matched to the customer's open-items and use Match Value to define the open-items covered by the payment\n    The customer wants to restrict the distribution of the payment to a specific service agreement. In this situation, specify a Match Type of \"service agreement ID\" and a Match Value of the respective service agreement ID.\n\nMatch Type and Match Value are gray after the payment is frozen."}}},"matchValue":{"type":"string","maxLength":30,"description":"Match Type and Match Value will only be used if either of the following conditions is true:\n\n    The Account ID belongs to an open item customer class. In this situation, specify a Match Type to define how the payment should be matched to the customer's open-items and use Match Value to define the open-items covered by the payment\n    The customer wants to restrict the distribution of the payment to a specific service agreement. In this situation, specify a Match Type of \"service agreement ID\" and a Match Value of the respective service agreement ID.\n\nMatch Type and Match Value are gray after the payment is frozen."},"accountCheckDigit":{"type":"string","maxLength":1,"description":"Account Check Digit"},"paymentAccountCash":{"type":"string","maxLength":30,"description":"Use Cash-Only Threshold to define the number of cash-only points a customer must have before the system warns the CSR accepting payments that the account is cash-only."},"isOpenItemAccounting":{"type":"boolean","description":"Open Item Accounting Switch","example":"false"},"isNonCISAccount":{"type":"boolean","description":"Non-CIS Account Switch","example":"true"},"isPayTransfer":{"type":"boolean","description":"When Payment Transfer button is clicked, the Payment Event Transfer dialog opens to transfer a payment.","example":"true"},"transferAccountId":{"type":"string","maxLength":10,"description":"Account ID is the account to which the payment event should be transferred."},"transferNonCisName":{"type":"string","maxLength":50,"description":"Following parameters must be specified in the Payment Event Transfer dialog to transfer a payment - Non CIS Name, Reference Number, and Non CIS Comments.\n\nNon CIS Name, Reference Number, and Non CIS Comments appear if the Account ID belongs to a customer class that is used for non-CIS payments."},"transferNonCisReferenceNumber":{"type":"string","maxLength":30,"description":"Following parameters must be specified in the Payment Event Transfer dialog to transfer a payment - Non CIS Name, Reference Number, and Non CIS Comments.\n\nNon CIS Name, Reference Number, and Non CIS Comments appear if the Account ID belongs to a customer class that is used for non-CIS payments."},"transferNonCISComment":{"type":"string","maxLength":254,"description":"Following parameters must be specified in the Payment Event Transfer dialog to transfer a payment - Non CIS Name, Reference Number, and Non CIS Comments.\n\nNon CIS Name, Reference Number, and Non CIS Comments appear if the Account ID belongs to a customer class that is used for non-CIS payments."},"transferCancelReason":{"type":"string","maxLength":4,"description":"Cancel Reason defines why you are performing the payment event transfer.","example":"NSF\n\n(Non sufficient funds)"},"transferMatchType":{"type":"string","maxLength":8,"description":"Match Type and Match Value are defaulted based on their values for the payment event that you are transferring. If necessary, modify the values appropriately for the account to which you are transferring the payment event.","example":"BILL-ID\n\n(Bill ID / Sequential Bill Number)"},"transferMatchValue":{"type":"string","maxLength":30,"description":"Match Type and Match Value are defaulted based on their values for the payment event that you are transferring. If necessary, modify the values appropriately for the account to which you are transferring the payment event.","example":"995516242555"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks.","example":"20"},"paySegments":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"paySegment":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"paySegmentId":{"type":"string","maxLength":12,"description":"Pay Segment ID"}}},"currency":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"currency":{"type":"string","maxLength":3,"description":"Currency Code"}}},"serviceAgreement":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"serviceAgreement":{"type":"string","maxLength":10,"description":"Service Agreement"}}},"paySegmentAmount":{"type":"number","description":"Distributed Amount is the amount of the service agreement's debt relieved by the payment.","example":"25.08"},"adjustment":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"adjustmentId":{"type":"string","maxLength":12,"description":"Adjustment ID"}}},"matchEvent":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"matchEventId":{"type":"string","maxLength":12,"description":"Match Event ID"}}},"financialTransaction":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"financialTransactionId":{"type":"string","maxLength":12,"description":"Financial Transaction ID"}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"}}}}}},"Exception":{"type":"object","properties":{"messageCategory":{"type":"object","description":"Message category within Oracle Utilities Application Framework.","properties":{"_link":{"type":"string","description":"_link"},"messageCategory":{"type":"number","maximum":99999,"minimum":-99999,"description":"Message category within Oracle Utilities Application Framework.","example":"11"}}},"messageNumber":{"type":"number","maximum":99999,"minimum":-99999,"description":"Message number within Oracle Utilities Application Framework.","example":"14107"},"paymentExceptionType":{"type":"string","enum":["10  ","20  ","30  ","40  "],"description":"Payment Exception Type\n* `10  ` - No Payment Segment found,\n* `20  ` - No SA found for this acct.,\n* `30  ` - Unbalanced Payment,\n* `40  ` - Payment in error","example":"40"},"expandedMessage":{"type":"string","maxLength":254,"description":"Expanded Message exception","example":"The Payment is incomplete."},"messageParameter1":{"type":"string","maxLength":2000,"description":"Message Parameter"},"messageParameter2":{"type":"string","maxLength":2000,"description":"Message Parameter"},"messageParameter3":{"type":"string","maxLength":2000,"description":"Message Parameter"},"messageParameter4":{"type":"string","maxLength":2000,"description":"Message Parameter"},"messageParameter5":{"type":"string","maxLength":2000,"description":"Message Parameter"},"messageParameter6":{"type":"string","maxLength":2000,"description":"Message Parameter"},"messageParameter7":{"type":"string","maxLength":2000,"description":"Message Parameter"},"messageParameter8":{"type":"string","maxLength":2000,"description":"Message Parameter"},"messageParameter9":{"type":"string","maxLength":2000,"description":"Message Parameter"},"callingProgramSequence":{"type":"string","maxLength":254,"description":"Calling Program Sequence"},"user":{"type":"object","description":"User","properties":{"_link":{"type":"string","description":"_link"},"user":{"type":"string","maxLength":8,"description":"User"}}},"isReviewed":{"type":"boolean","description":"Reviewed","example":"false"},"reviewUser":{"type":"object","description":"Review User","properties":{"_link":{"type":"string","description":"_link"},"reviewUser":{"type":"string","maxLength":8,"description":"Review User"}}},"reviewedDate":{"type":"string","format":"date","description":"Review Date"},"comments":{"type":"string","maxLength":254,"description":"Comments"},"creationDateTime":{"type":"string","format":"date-time","description":"Create Date/Time","example":"2010-11-24T17:49:23-05:00"},"version":{"type":"number","maximum":0,"minimum":0,"description":"The Version number is used for internal concurrency checks.","example":"1"}}},"characteristics":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"sequence":{"type":"number","maximum":999,"minimum":-999,"description":"Sequence Controls the order in which characteristics of the same type are displayed.","example":"1"},"characteristicType":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"characteristicType":{"type":"string","maxLength":8,"description":"Characteristic Type"}}},"typeOfCharacteristicValue":{"type":"string","maxLength":4,"description":"Type of Char Value"},"characteristicValue":{"type":"object","properties":{"_link":{"type":"string","description":"(_link)"},"value":{"type":"string","description":"(value)"},"value2":{"type":"string","description":"(value2)"},"value3":{"type":"string","description":"(value3)"},"value4":{"type":"string","description":"(value4)"},"value5":{"type":"string","description":"(value5)"}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks.","example":"20"}}}}}},"nextActions":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"_link":{"type":"string","description":"(_link)"},"actionName":{"type":"string","description":"(actionName)"}}}}}}},"xml":{"name":"C1-CxPayment"}},"DELETEPAYMENT_request":{"type":"object","properties":{"paymentId":{"type":"string","maxLength":12,"description":"Payment ID is the system-assigned unique identifier of the payment.","example":"317896608844"}},"xml":{"name":"C1-DeltPaymt"}},"CREATEPAYMENT_response":{"type":"object","properties":{"_self":{"type":"string","description":"_self"},"paymentId":{"type":"string","maxLength":12,"description":"Payment ID is the system-assigned unique identifier of the payment.","example":"317896608844"},"paymentEvent":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"paymentEventId":{"type":"string","maxLength":12,"description":"Payment Event ID is the system-assigned unique identifier of the payment event.","example":"317772795000"},"PayEventException":{"type":"string","maxLength":30,"description":"Exception Messages"}}},"cancelReason":{"type":"string","maxLength":30,"description":"If the payment is canceled , the Cancel Reason is displayed.","example":"Data entry error"},"currency":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"currency":{"type":"string","maxLength":3,"description":"Currency Code"}}},"account":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"accountId":{"type":"string","maxLength":10,"description":"Account ID"}}},"paymentStatus":{"type":"string","enum":["10  ","20  ","30  ","50  ","60  "],"description":"Payment Status is the payment's status.\n* `10  ` - Incomplete,\n* `20  ` - Error,\n* `30  ` - Freezable,\n* `50  ` - Frozen,\n* `60  ` - Canceled","example":"30"},"paymentAmount":{"type":"number","description":"Payment Amount is the amount of the payment. This field is gray after the payment is frozen.","example":"300"},"nonCisName":{"type":"string","maxLength":50,"description":"If the payment is linked to an Account ID that belongs to a customer class that is used for non-CIS payments, the following fields appear (note, these fields are gray after the payment is frozen):\n\n    Name is the name of the person remitting the payment.\n    Reference Number is the reference number of the item being paid (e.g., the property tax reference number).\n    Comments are used to describe anything unusual about the non-CIS payment.","example":"ZZMXA,CX_test"},"nonCisReferenceNumber":{"type":"string","maxLength":30,"description":"If the payment is linked to an Account ID that belongs to a customer class that is used for non-CIS payments, the following fields appear (note, these fields are gray after the payment is frozen):\n\n    Name is the name of the person remitting the payment.\n    Reference Number is the reference number of the item being paid (e.g., the property tax reference number).\n    Comments are used to describe anything unusual about the non-CIS payment."},"nonCisComments":{"type":"string","maxLength":254,"description":"If the payment is linked to an Account ID that belongs to a customer class that is used for non-CIS payments, the following fields appear (note, these fields are gray after the payment is frozen):\n\n    Name is the name of the person remitting the payment.\n    Reference Number is the reference number of the item being paid (e.g., the property tax reference number).\n    Comments are used to describe anything unusual about the non-CIS payment."},"matchType":{"type":"object","description":"Match Type and Match Value will only be used if either of the following conditions is true:\n\n    The Account ID belongs to an open item customer class. In this situation, specify a Match Type to define how the payment should be matched to the customer's open-items and use Match Value to define the open-items covered by the payment\n    The customer wants to restrict the distribution of the payment to a specific service agreement. In this situation, specify a Match Type of \"service agreement ID\" and a Match Value of the respective service agreement ID.\n\nMatch Type and Match Value are gray after the payment is frozen.","properties":{"_link":{"type":"string","description":"_link"},"matchType":{"type":"string","maxLength":8,"description":"Match Type and Match Value will only be used if either of the following conditions is true:\n\n    The Account ID belongs to an open item customer class. In this situation, specify a Match Type to define how the payment should be matched to the customer's open-items and use Match Value to define the open-items covered by the payment\n    The customer wants to restrict the distribution of the payment to a specific service agreement. In this situation, specify a Match Type of \"service agreement ID\" and a Match Value of the respective service agreement ID.\n\nMatch Type and Match Value are gray after the payment is frozen."}}},"matchValue":{"type":"string","maxLength":30,"description":"Match Type and Match Value will only be used if either of the following conditions is true:\n\n    The Account ID belongs to an open item customer class. In this situation, specify a Match Type to define how the payment should be matched to the customer's open-items and use Match Value to define the open-items covered by the payment\n    The customer wants to restrict the distribution of the payment to a specific service agreement. In this situation, specify a Match Type of \"service agreement ID\" and a Match Value of the respective service agreement ID.\n\nMatch Type and Match Value are gray after the payment is frozen."},"accountCheckDigit":{"type":"string","maxLength":1,"description":"Account Check Digit"},"paymentAccountCash":{"type":"string","maxLength":30,"description":"Use Cash-Only Threshold to define the number of cash-only points a customer must have before the system warns the CSR accepting payments that the account is cash-only."},"isOpenItemAccounting":{"type":"boolean","description":"Open Item Accounting Switch","example":"false"},"isNonCISAccount":{"type":"boolean","description":"Non-CIS Account Switch","example":"true"},"isPayTransfer":{"type":"boolean","description":"When Payment Transfer button is clicked, the Payment Event Transfer dialog opens to transfer a payment.","example":"true"},"transferAccountId":{"type":"string","maxLength":10,"description":"Account ID is the account to which the payment event should be transferred."},"transferNonCisName":{"type":"string","maxLength":50,"description":"Following parameters must be specified in the Payment Event Transfer dialog to transfer a payment - Non CIS Name, Reference Number, and Non CIS Comments.\n\nNon CIS Name, Reference Number, and Non CIS Comments appear if the Account ID belongs to a customer class that is used for non-CIS payments."},"transferNonCisReferenceNumber":{"type":"string","maxLength":30,"description":"Following parameters must be specified in the Payment Event Transfer dialog to transfer a payment - Non CIS Name, Reference Number, and Non CIS Comments.\n\nNon CIS Name, Reference Number, and Non CIS Comments appear if the Account ID belongs to a customer class that is used for non-CIS payments."},"transferNonCISComment":{"type":"string","maxLength":254,"description":"Following parameters must be specified in the Payment Event Transfer dialog to transfer a payment - Non CIS Name, Reference Number, and Non CIS Comments.\n\nNon CIS Name, Reference Number, and Non CIS Comments appear if the Account ID belongs to a customer class that is used for non-CIS payments."},"transferCancelReason":{"type":"string","maxLength":4,"description":"Cancel Reason defines why you are performing the payment event transfer.","example":"NSF\n\n(Non sufficient funds)"},"transferMatchType":{"type":"string","maxLength":8,"description":"Match Type and Match Value are defaulted based on their values for the payment event that you are transferring. If necessary, modify the values appropriately for the account to which you are transferring the payment event.","example":"BILL-ID\n\n(Bill ID / Sequential Bill Number)"},"transferMatchValue":{"type":"string","maxLength":30,"description":"Match Type and Match Value are defaulted based on their values for the payment event that you are transferring. If necessary, modify the values appropriately for the account to which you are transferring the payment event.","example":"995516242555"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks.","example":"20"},"paySegments":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"paySegment":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"paySegmentId":{"type":"string","maxLength":12,"description":"Pay Segment ID"}}},"currency":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"currency":{"type":"string","maxLength":3,"description":"Currency Code"}}},"serviceAgreement":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"serviceAgreement":{"type":"string","maxLength":10,"description":"Service Agreement"}}},"paySegmentAmount":{"type":"number","description":"Distributed Amount is the amount of the service agreement's debt relieved by the payment.","example":"25.08"},"adjustment":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"adjustmentId":{"type":"string","maxLength":12,"description":"Adjustment ID"}}},"matchEvent":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"matchEventId":{"type":"string","maxLength":12,"description":"Match Event ID"}}},"financialTransaction":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"financialTransactionId":{"type":"string","maxLength":12,"description":"Financial Transaction ID"}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"}}}}}},"Exception":{"type":"object","properties":{"messageCategory":{"type":"object","description":"Message category within Oracle Utilities Application Framework.","properties":{"_link":{"type":"string","description":"_link"},"messageCategory":{"type":"number","maximum":99999,"minimum":-99999,"description":"Message category within Oracle Utilities Application Framework.","example":"11"}}},"messageNumber":{"type":"number","maximum":99999,"minimum":-99999,"description":"Message number within Oracle Utilities Application Framework.","example":"14107"},"paymentExceptionType":{"type":"string","enum":["10  ","20  ","30  ","40  "],"description":"Payment Exception Type\n* `10  ` - No Payment Segment found,\n* `20  ` - No SA found for this acct.,\n* `30  ` - Unbalanced Payment,\n* `40  ` - Payment in error","example":"40"},"expandedMessage":{"type":"string","maxLength":254,"description":"Expanded Message exception","example":"The Payment is incomplete."},"messageParameter1":{"type":"string","maxLength":2000,"description":"Message Parameter"},"messageParameter2":{"type":"string","maxLength":2000,"description":"Message Parameter"},"messageParameter3":{"type":"string","maxLength":2000,"description":"Message Parameter"},"messageParameter4":{"type":"string","maxLength":2000,"description":"Message Parameter"},"messageParameter5":{"type":"string","maxLength":2000,"description":"Message Parameter"},"messageParameter6":{"type":"string","maxLength":2000,"description":"Message Parameter"},"messageParameter7":{"type":"string","maxLength":2000,"description":"Message Parameter"},"messageParameter8":{"type":"string","maxLength":2000,"description":"Message Parameter"},"messageParameter9":{"type":"string","maxLength":2000,"description":"Message Parameter"},"callingProgramSequence":{"type":"string","maxLength":254,"description":"Calling Program Sequence"},"user":{"type":"object","description":"User","properties":{"_link":{"type":"string","description":"_link"},"user":{"type":"string","maxLength":8,"description":"User"}}},"isReviewed":{"type":"boolean","description":"Reviewed","example":"false"},"reviewUser":{"type":"object","description":"Review User","properties":{"_link":{"type":"string","description":"_link"},"reviewUser":{"type":"string","maxLength":8,"description":"Review User"}}},"reviewedDate":{"type":"string","format":"date","description":"Review Date"},"comments":{"type":"string","maxLength":254,"description":"Comments"},"creationDateTime":{"type":"string","format":"date-time","description":"Create Date/Time","example":"2010-11-24T17:49:23-05:00"},"version":{"type":"number","maximum":0,"minimum":0,"description":"The Version number is used for internal concurrency checks.","example":"1"}}},"characteristics":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"sequence":{"type":"number","maximum":999,"minimum":-999,"description":"Sequence Controls the order in which characteristics of the same type are displayed.","example":"1"},"characteristicType":{"type":"object","properties":{"_link":{"type":"string","description":"_link"},"characteristicType":{"type":"string","maxLength":8,"description":"Characteristic Type"}}},"typeOfCharacteristicValue":{"type":"string","maxLength":4,"description":"Type of Char Value"},"characteristicValue":{"type":"object","properties":{"_link":{"type":"string","description":"(_link)"},"value":{"type":"string","description":"(value)"},"value2":{"type":"string","description":"(value2)"},"value3":{"type":"string","description":"(value3)"},"value4":{"type":"string","description":"(value4)"},"value5":{"type":"string","description":"(value5)"}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks.","example":"20"}}}}}},"nextActions":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"_link":{"type":"string","description":"(_link)"},"actionName":{"type":"string","description":"(actionName)"}}}}}}},"xml":{"name":"C1-CxPayment"}},"UPDATEPAYMENT_request":{"type":"object","properties":{"paymentId":{"type":"string","maxLength":12,"description":"Payment ID is the system-assigned unique identifier of the payment.","example":"317896608844"},"paymentEvent":{"type":"object","properties":{"paymentEventId":{"type":"string","maxLength":12,"description":"Payment Event ID is the system-assigned unique identifier of the payment event.","example":"317772795000"},"PayEventException":{"type":"string","maxLength":30,"description":"Exception Messages"}}},"cancelReason":{"type":"string","maxLength":30,"description":"If the payment is canceled , the Cancel Reason is displayed.","example":"Data entry error"},"currency":{"type":"object","properties":{"currency":{"type":"string","maxLength":3,"description":"Currency Code"}}},"account":{"type":"object","properties":{"accountId":{"type":"string","maxLength":10,"description":"Account ID"}}},"paymentStatus":{"type":"string","enum":["10  ","20  ","30  ","50  ","60  "],"description":"Payment Status is the payment's status.\n* `10  ` - Incomplete,\n* `20  ` - Error,\n* `30  ` - Freezable,\n* `50  ` - Frozen,\n* `60  ` - Canceled","example":"30"},"paymentAmount":{"type":"number","description":"Payment Amount is the amount of the payment. This field is gray after the payment is frozen.","example":"300"},"nonCisName":{"type":"string","maxLength":50,"description":"If the payment is linked to an Account ID that belongs to a customer class that is used for non-CIS payments, the following fields appear (note, these fields are gray after the payment is frozen):\n\n    Name is the name of the person remitting the payment.\n    Reference Number is the reference number of the item being paid (e.g., the property tax reference number).\n    Comments are used to describe anything unusual about the non-CIS payment.","example":"ZZMXA,CX_test"},"nonCisReferenceNumber":{"type":"string","maxLength":30,"description":"If the payment is linked to an Account ID that belongs to a customer class that is used for non-CIS payments, the following fields appear (note, these fields are gray after the payment is frozen):\n\n    Name is the name of the person remitting the payment.\n    Reference Number is the reference number of the item being paid (e.g., the property tax reference number).\n    Comments are used to describe anything unusual about the non-CIS payment."},"nonCisComments":{"type":"string","maxLength":254,"description":"If the payment is linked to an Account ID that belongs to a customer class that is used for non-CIS payments, the following fields appear (note, these fields are gray after the payment is frozen):\n\n    Name is the name of the person remitting the payment.\n    Reference Number is the reference number of the item being paid (e.g., the property tax reference number).\n    Comments are used to describe anything unusual about the non-CIS payment."},"matchType":{"type":"object","description":"Match Type and Match Value will only be used if either of the following conditions is true:\n\n    The Account ID belongs to an open item customer class. In this situation, specify a Match Type to define how the payment should be matched to the customer's open-items and use Match Value to define the open-items covered by the payment\n    The customer wants to restrict the distribution of the payment to a specific service agreement. In this situation, specify a Match Type of \"service agreement ID\" and a Match Value of the respective service agreement ID.\n\nMatch Type and Match Value are gray after the payment is frozen.","properties":{"matchType":{"type":"string","maxLength":8,"description":"Match Type and Match Value will only be used if either of the following conditions is true:\n\n    The Account ID belongs to an open item customer class. In this situation, specify a Match Type to define how the payment should be matched to the customer's open-items and use Match Value to define the open-items covered by the payment\n    The customer wants to restrict the distribution of the payment to a specific service agreement. In this situation, specify a Match Type of \"service agreement ID\" and a Match Value of the respective service agreement ID.\n\nMatch Type and Match Value are gray after the payment is frozen."}}},"matchValue":{"type":"string","maxLength":30,"description":"Match Type and Match Value will only be used if either of the following conditions is true:\n\n    The Account ID belongs to an open item customer class. In this situation, specify a Match Type to define how the payment should be matched to the customer's open-items and use Match Value to define the open-items covered by the payment\n    The customer wants to restrict the distribution of the payment to a specific service agreement. In this situation, specify a Match Type of \"service agreement ID\" and a Match Value of the respective service agreement ID.\n\nMatch Type and Match Value are gray after the payment is frozen."},"accountCheckDigit":{"type":"string","maxLength":1,"description":"Account Check Digit"},"paymentAccountCash":{"type":"string","maxLength":30,"description":"Use Cash-Only Threshold to define the number of cash-only points a customer must have before the system warns the CSR accepting payments that the account is cash-only."},"isOpenItemAccounting":{"type":"boolean","description":"Open Item Accounting Switch","example":"false"},"isNonCISAccount":{"type":"boolean","description":"Non-CIS Account Switch","example":"true"},"isPayTransfer":{"type":"boolean","description":"When Payment Transfer button is clicked, the Payment Event Transfer dialog opens to transfer a payment.","example":"true"},"transferAccountId":{"type":"string","maxLength":10,"description":"Account ID is the account to which the payment event should be transferred."},"transferNonCisName":{"type":"string","maxLength":50,"description":"Following parameters must be specified in the Payment Event Transfer dialog to transfer a payment - Non CIS Name, Reference Number, and Non CIS Comments.\n\nNon CIS Name, Reference Number, and Non CIS Comments appear if the Account ID belongs to a customer class that is used for non-CIS payments."},"transferNonCisReferenceNumber":{"type":"string","maxLength":30,"description":"Following parameters must be specified in the Payment Event Transfer dialog to transfer a payment - Non CIS Name, Reference Number, and Non CIS Comments.\n\nNon CIS Name, Reference Number, and Non CIS Comments appear if the Account ID belongs to a customer class that is used for non-CIS payments."},"transferNonCISComment":{"type":"string","maxLength":254,"description":"Following parameters must be specified in the Payment Event Transfer dialog to transfer a payment - Non CIS Name, Reference Number, and Non CIS Comments.\n\nNon CIS Name, Reference Number, and Non CIS Comments appear if the Account ID belongs to a customer class that is used for non-CIS payments."},"transferCancelReason":{"type":"string","maxLength":4,"description":"Cancel Reason defines why you are performing the payment event transfer.","example":"NSF\n\n(Non sufficient funds)"},"transferMatchType":{"type":"string","maxLength":8,"description":"Match Type and Match Value are defaulted based on their values for the payment event that you are transferring. If necessary, modify the values appropriately for the account to which you are transferring the payment event.","example":"BILL-ID\n\n(Bill ID / Sequential Bill Number)"},"transferMatchValue":{"type":"string","maxLength":30,"description":"Match Type and Match Value are defaulted based on their values for the payment event that you are transferring. If necessary, modify the values appropriately for the account to which you are transferring the payment event.","example":"995516242555"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks.","example":"20"},"paySegments":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"paySegmentId":{"type":"string","maxLength":12,"description":"Pay Segment ID"},"currency2":{"type":"string","maxLength":3,"description":"Currency Code"},"serviceAgreement2":{"type":"string","maxLength":10,"description":"Service Agreement"},"adjustmentId":{"type":"string","maxLength":12,"description":"Adjustment ID"},"matchEventId":{"type":"string","maxLength":12,"description":"Match Event ID"},"financialTransactionId":{"type":"string","maxLength":12,"description":"Financial Transaction ID"},"version2":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"}}}}}},"Exception":{"type":"object","properties":{"messageNumber":{"type":"number","maximum":99999,"minimum":-99999,"description":"Message number within Oracle Utilities Application Framework.","example":"14107"},"paymentExceptionType":{"type":"string","enum":["10  ","20  ","30  ","40  "],"description":"Payment Exception Type\n* `10  ` - No Payment Segment found,\n* `20  ` - No SA found for this acct.,\n* `30  ` - Unbalanced Payment,\n* `40  ` - Payment in error","example":"40"},"expandedMessage":{"type":"string","maxLength":254,"description":"Expanded Message exception","example":"The Payment is incomplete."},"messageParameter1":{"type":"string","maxLength":2000,"description":"Message Parameter"},"messageParameter2":{"type":"string","maxLength":2000,"description":"Message Parameter"},"messageParameter3":{"type":"string","maxLength":2000,"description":"Message Parameter"},"messageParameter4":{"type":"string","maxLength":2000,"description":"Message Parameter"},"messageParameter5":{"type":"string","maxLength":2000,"description":"Message Parameter"},"messageParameter6":{"type":"string","maxLength":2000,"description":"Message Parameter"},"messageParameter7":{"type":"string","maxLength":2000,"description":"Message Parameter"},"messageParameter8":{"type":"string","maxLength":2000,"description":"Message Parameter"},"messageParameter9":{"type":"string","maxLength":2000,"description":"Message Parameter"},"callingProgramSequence":{"type":"string","maxLength":254,"description":"Calling Program Sequence"},"isReviewed":{"type":"boolean","description":"Reviewed","example":"false"},"reviewedDate":{"type":"string","format":"date","description":"Review Date"},"comments":{"type":"string","maxLength":254,"description":"Comments"},"creationDateTime":{"type":"string","format":"date-time","description":"Create Date/Time","example":"2010-11-24T17:49:23-05:00"},"version2":{"type":"number","maximum":0,"minimum":0,"description":"The Version number is used for internal concurrency checks.","example":"1"}}},"characteristics":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"sequence":{"type":"number","maximum":999,"minimum":-999,"description":"Sequence Controls the order in which characteristics of the same type are displayed.","example":"1"},"characteristicType":{"type":"object","properties":{"characteristicType":{"type":"string","maxLength":8,"description":"Characteristic Type"}}},"characteristicValue":{"type":"object","properties":{"_link":{"type":"string","description":"(_link)"},"value":{"type":"string","description":"(value)"},"value2":{"type":"string","description":"(value2)"},"value3":{"type":"string","description":"(value3)"},"value4":{"type":"string","description":"(value4)"},"value5":{"type":"string","description":"(value5)"}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks.","example":"20"}}}}}}},"xml":{"name":"C1-CxPayment"}},"CREATEPAYMENT_request":{"type":"object","properties":{"paymentEvent":{"type":"object","properties":{"paymentEventId":{"type":"string","maxLength":12,"description":"Payment Event ID is the system-assigned unique identifier of the payment event.","example":"317772795000"},"PayEventException":{"type":"string","maxLength":30,"description":"Exception Messages"}}},"cancelReason":{"type":"string","maxLength":30,"description":"If the payment is canceled , the Cancel Reason is displayed.","example":"Data entry error"},"currency":{"type":"object","properties":{"currency":{"type":"string","maxLength":3,"description":"Currency Code"}}},"account":{"type":"object","properties":{"accountId":{"type":"string","maxLength":10,"description":"Account ID"}}},"paymentStatus":{"type":"string","enum":["10  ","20  ","30  ","50  ","60  "],"description":"Payment Status is the payment's status.\n* `10  ` - Incomplete,\n* `20  ` - Error,\n* `30  ` - Freezable,\n* `50  ` - Frozen,\n* `60  ` - Canceled","example":"30"},"paymentAmount":{"type":"number","description":"Payment Amount is the amount of the payment. This field is gray after the payment is frozen.","example":"300"},"nonCisName":{"type":"string","maxLength":50,"description":"If the payment is linked to an Account ID that belongs to a customer class that is used for non-CIS payments, the following fields appear (note, these fields are gray after the payment is frozen):\n\n    Name is the name of the person remitting the payment.\n    Reference Number is the reference number of the item being paid (e.g., the property tax reference number).\n    Comments are used to describe anything unusual about the non-CIS payment.","example":"ZZMXA,CX_test"},"nonCisReferenceNumber":{"type":"string","maxLength":30,"description":"If the payment is linked to an Account ID that belongs to a customer class that is used for non-CIS payments, the following fields appear (note, these fields are gray after the payment is frozen):\n\n    Name is the name of the person remitting the payment.\n    Reference Number is the reference number of the item being paid (e.g., the property tax reference number).\n    Comments are used to describe anything unusual about the non-CIS payment."},"nonCisComments":{"type":"string","maxLength":254,"description":"If the payment is linked to an Account ID that belongs to a customer class that is used for non-CIS payments, the following fields appear (note, these fields are gray after the payment is frozen):\n\n    Name is the name of the person remitting the payment.\n    Reference Number is the reference number of the item being paid (e.g., the property tax reference number).\n    Comments are used to describe anything unusual about the non-CIS payment."},"matchType":{"type":"object","description":"Match Type and Match Value will only be used if either of the following conditions is true:\n\n    The Account ID belongs to an open item customer class. In this situation, specify a Match Type to define how the payment should be matched to the customer's open-items and use Match Value to define the open-items covered by the payment\n    The customer wants to restrict the distribution of the payment to a specific service agreement. In this situation, specify a Match Type of \"service agreement ID\" and a Match Value of the respective service agreement ID.\n\nMatch Type and Match Value are gray after the payment is frozen.","properties":{"matchType":{"type":"string","maxLength":8,"description":"Match Type and Match Value will only be used if either of the following conditions is true:\n\n    The Account ID belongs to an open item customer class. In this situation, specify a Match Type to define how the payment should be matched to the customer's open-items and use Match Value to define the open-items covered by the payment\n    The customer wants to restrict the distribution of the payment to a specific service agreement. In this situation, specify a Match Type of \"service agreement ID\" and a Match Value of the respective service agreement ID.\n\nMatch Type and Match Value are gray after the payment is frozen."}}},"matchValue":{"type":"string","maxLength":30,"description":"Match Type and Match Value will only be used if either of the following conditions is true:\n\n    The Account ID belongs to an open item customer class. In this situation, specify a Match Type to define how the payment should be matched to the customer's open-items and use Match Value to define the open-items covered by the payment\n    The customer wants to restrict the distribution of the payment to a specific service agreement. In this situation, specify a Match Type of \"service agreement ID\" and a Match Value of the respective service agreement ID.\n\nMatch Type and Match Value are gray after the payment is frozen."},"accountCheckDigit":{"type":"string","maxLength":1,"description":"Account Check Digit"},"paymentAccountCash":{"type":"string","maxLength":30,"description":"Use Cash-Only Threshold to define the number of cash-only points a customer must have before the system warns the CSR accepting payments that the account is cash-only."},"isOpenItemAccounting":{"type":"boolean","description":"Open Item Accounting Switch","example":"false"},"isNonCISAccount":{"type":"boolean","description":"Non-CIS Account Switch","example":"true"},"isPayTransfer":{"type":"boolean","description":"When Payment Transfer button is clicked, the Payment Event Transfer dialog opens to transfer a payment.","example":"true"},"transferAccountId":{"type":"string","maxLength":10,"description":"Account ID is the account to which the payment event should be transferred."},"transferNonCisName":{"type":"string","maxLength":50,"description":"Following parameters must be specified in the Payment Event Transfer dialog to transfer a payment - Non CIS Name, Reference Number, and Non CIS Comments.\n\nNon CIS Name, Reference Number, and Non CIS Comments appear if the Account ID belongs to a customer class that is used for non-CIS payments."},"transferNonCisReferenceNumber":{"type":"string","maxLength":30,"description":"Following parameters must be specified in the Payment Event Transfer dialog to transfer a payment - Non CIS Name, Reference Number, and Non CIS Comments.\n\nNon CIS Name, Reference Number, and Non CIS Comments appear if the Account ID belongs to a customer class that is used for non-CIS payments."},"transferNonCISComment":{"type":"string","maxLength":254,"description":"Following parameters must be specified in the Payment Event Transfer dialog to transfer a payment - Non CIS Name, Reference Number, and Non CIS Comments.\n\nNon CIS Name, Reference Number, and Non CIS Comments appear if the Account ID belongs to a customer class that is used for non-CIS payments."},"transferCancelReason":{"type":"string","maxLength":4,"description":"Cancel Reason defines why you are performing the payment event transfer.","example":"NSF\n\n(Non sufficient funds)"},"transferMatchType":{"type":"string","maxLength":8,"description":"Match Type and Match Value are defaulted based on their values for the payment event that you are transferring. If necessary, modify the values appropriately for the account to which you are transferring the payment event.","example":"BILL-ID\n\n(Bill ID / Sequential Bill Number)"},"transferMatchValue":{"type":"string","maxLength":30,"description":"Match Type and Match Value are defaulted based on their values for the payment event that you are transferring. If necessary, modify the values appropriately for the account to which you are transferring the payment event.","example":"995516242555"},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks.","example":"20"},"paySegments":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"paySegmentId":{"type":"string","maxLength":12,"description":"Pay Segment ID"},"currency2":{"type":"string","maxLength":3,"description":"Currency Code"},"serviceAgreement2":{"type":"string","maxLength":10,"description":"Service Agreement"},"adjustmentId":{"type":"string","maxLength":12,"description":"Adjustment ID"},"matchEventId":{"type":"string","maxLength":12,"description":"Match Event ID"},"financialTransactionId":{"type":"string","maxLength":12,"description":"Financial Transaction ID"},"version2":{"type":"number","maximum":99999,"minimum":-99999,"description":"Version"}}}}}},"Exception":{"type":"object","properties":{"messageNumber":{"type":"number","maximum":99999,"minimum":-99999,"description":"Message number within Oracle Utilities Application Framework.","example":"14107"},"paymentExceptionType":{"type":"string","enum":["10  ","20  ","30  ","40  "],"description":"Payment Exception Type\n* `10  ` - No Payment Segment found,\n* `20  ` - No SA found for this acct.,\n* `30  ` - Unbalanced Payment,\n* `40  ` - Payment in error","example":"40"},"expandedMessage":{"type":"string","maxLength":254,"description":"Expanded Message exception","example":"The Payment is incomplete."},"messageParameter1":{"type":"string","maxLength":2000,"description":"Message Parameter"},"messageParameter2":{"type":"string","maxLength":2000,"description":"Message Parameter"},"messageParameter3":{"type":"string","maxLength":2000,"description":"Message Parameter"},"messageParameter4":{"type":"string","maxLength":2000,"description":"Message Parameter"},"messageParameter5":{"type":"string","maxLength":2000,"description":"Message Parameter"},"messageParameter6":{"type":"string","maxLength":2000,"description":"Message Parameter"},"messageParameter7":{"type":"string","maxLength":2000,"description":"Message Parameter"},"messageParameter8":{"type":"string","maxLength":2000,"description":"Message Parameter"},"messageParameter9":{"type":"string","maxLength":2000,"description":"Message Parameter"},"callingProgramSequence":{"type":"string","maxLength":254,"description":"Calling Program Sequence"},"isReviewed":{"type":"boolean","description":"Reviewed","example":"false"},"reviewedDate":{"type":"string","format":"date","description":"Review Date"},"comments":{"type":"string","maxLength":254,"description":"Comments"},"creationDateTime":{"type":"string","format":"date-time","description":"Create Date/Time","example":"2010-11-24T17:49:23-05:00"},"version2":{"type":"number","maximum":0,"minimum":0,"description":"The Version number is used for internal concurrency checks.","example":"1"}}},"characteristics":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"sequence":{"type":"number","maximum":999,"minimum":-999,"description":"Sequence Controls the order in which characteristics of the same type are displayed.","example":"1"},"characteristicType":{"type":"object","properties":{"characteristicType":{"type":"string","maxLength":8,"description":"Characteristic Type"}}},"characteristicValue":{"type":"object","properties":{"_link":{"type":"string","description":"(_link)"},"value":{"type":"string","description":"(value)"},"value2":{"type":"string","description":"(value2)"},"value3":{"type":"string","description":"(value3)"},"value4":{"type":"string","description":"(value4)"},"value5":{"type":"string","description":"(value5)"}}},"version":{"type":"number","maximum":99999,"minimum":-99999,"description":"The Version number is used for internal concurrency checks.","example":"20"}}}}}}},"xml":{"name":"C1-CxPayment"}},"ACTIONPAYMENT_request":{"type":"object","properties":{"paymentId":{"type":"string","maxLength":12,"description":"Payment ID is the system-assigned unique identifier of the payment.","example":"317896608844"},"name":{"type":"string","description":"(name)"},"cancelReason":{"type":"string","maxLength":30,"description":"If the payment is canceled , the Cancel Reason is displayed.","example":"Data entry error"},"paymentStatus":{"type":"string","enum":["10  ","20  ","30  ","50  ","60  "],"description":"Payment Status is the payment's status.\n* `10  ` - Incomplete,\n* `20  ` - Error,\n* `30  ` - Freezable,\n* `50  ` - Frozen,\n* `60  ` - Canceled","example":"30"},"isPayTransfer":{"type":"boolean","description":"When Payment Transfer button is clicked, the Payment Event Transfer dialog opens to transfer a payment.","example":"true"},"transferAccountId":{"type":"string","maxLength":10,"description":"Account ID is the account to which the payment event should be transferred."},"transferNonCisName":{"type":"string","maxLength":50,"description":"Following parameters must be specified in the Payment Event Transfer dialog to transfer a payment - Non CIS Name, Reference Number, and Non CIS Comments.\n\nNon CIS Name, Reference Number, and Non CIS Comments appear if the Account ID belongs to a customer class that is used for non-CIS payments."},"transferNonCisReferenceNumber":{"type":"string","maxLength":30,"description":"Following parameters must be specified in the Payment Event Transfer dialog to transfer a payment - Non CIS Name, Reference Number, and Non CIS Comments.\n\nNon CIS Name, Reference Number, and Non CIS Comments appear if the Account ID belongs to a customer class that is used for non-CIS payments."},"transferNonCISComment":{"type":"string","maxLength":254,"description":"Following parameters must be specified in the Payment Event Transfer dialog to transfer a payment - Non CIS Name, Reference Number, and Non CIS Comments.\n\nNon CIS Name, Reference Number, and Non CIS Comments appear if the Account ID belongs to a customer class that is used for non-CIS payments."},"transferCancelReason":{"type":"string","maxLength":4,"description":"Cancel Reason defines why you are performing the payment event transfer.","example":"NSF\n\n(Non sufficient funds)"},"transferMatchType":{"type":"string","maxLength":8,"description":"Match Type and Match Value are defaulted based on their values for the payment event that you are transferring. If necessary, modify the values appropriately for the account to which you are transferring the payment event.","example":"BILL-ID\n\n(Bill ID / Sequential Bill Number)"},"transferMatchValue":{"type":"string","maxLength":30,"description":"Match Type and Match Value are defaulted based on their values for the payment event that you are transferring. If necessary, modify the values appropriately for the account to which you are transferring the payment event.","example":"995516242555"},"nextActions":{"type":"object","properties":{"_data":{"type":"array","items":{"type":"object","properties":{"actionName":{"type":"string","description":"(actionName)"},"_link":{"type":"string","description":"(_link)"}}}}}}},"xml":{"name":"C1ActionPyt"}},"DELETEPAYMENT_response":{"type":"object","properties":{"paymentId":{"type":"string","maxLength":12,"description":"Payment ID is the system-assigned unique identifier of the payment.","example":"317896608844"}},"xml":{"name":"C1-DeltPaymt"}}}},"security":[{"BasicAuth":[]}],"servers":[{"url":"/"}]}