{"openapi":"3.0.3","info":{"title":"(2025) Miami-Dade WASD-M2C Self Service API","version":"1.0.0","description":"API for the Miami-Dade County Water and Sewer Department Meter-to-Cash Self Service Application."},"paths":{"/ccbConfiguration":{"get":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CCBConfiguration"}},"required":["data"]},"example":{"data":{"contactInfoPhoneNumber":{"aciPaymentFee":4.95,"maximumNumberOfPhones":10,"phoneNumberTypes":[{"code":"BUSINESS","description":"Business Phone"},{"code":"CAMPUS","description":"Campus Phone"},{"code":"CELLULAR","description":"Cellular Phone"},{"code":"DORMITORY","description":"Dormitory Phone"},{"code":"FAX","description":"FAX"},{"code":"HOME","description":"Home Phone"}]},"poolDepthConstant":4.5,"countries":[{"code":"USA","name":"United States","states":[{"code":"AA","name":"Armed Forces Americas NoCanada"},{"code":"AE","name":"Armed Forces AFC-CAN-EURP-MIDE"},{"code":"AK","name":"Alaska"},{"code":"AL","name":"Alabama"},{"code":"AP","name":"Armed Forces Pacific"},{"code":"AR","name":"Arkansas"},{"code":"AS","name":"American Samoa"},{"code":"AZ","name":"Arizona"},{"code":"CA","name":"California"},{"code":"CO","name":"Colorado"},{"code":"CT","name":"Connecticut"},{"code":"DC","name":"District of Columbia"},{"code":"DE","name":"Delaware"},{"code":"FL","name":"Florida"},{"code":"FM","name":"Federated States of Micronesia"},{"code":"GA","name":"Georgia"},{"code":"GU","name":"Guam"},{"code":"HI","name":"Hawaii"},{"code":"IA","name":"Iowa"},{"code":"ID","name":"Idaho"},{"code":"IL","name":"Illinois"},{"code":"IN","name":"Indiana"},{"code":"KS","name":"Kansas"},{"code":"KY","name":"Kentucky"},{"code":"LA","name":"Louisiana"},{"code":"MA","name":"Massachusetts"},{"code":"MD","name":"Maryland"},{"code":"ME","name":"Maine"},{"code":"MH","name":"Marshall Islands"},{"code":"MI","name":"Michigan"},{"code":"MN","name":"Minnesota"},{"code":"MO","name":"Missouri"},{"code":"MP","name":"Northern Mariana Islands"},{"code":"MS","name":"Mississippi"},{"code":"MT","name":"Montana"},{"code":"N/A","name":"N/A"},{"code":"NC","name":"North Carolina"},{"code":"ND","name":"North Dakota"},{"code":"NE","name":"Nebraska"},{"code":"NH","name":"New Hampshire"},{"code":"NJ","name":"New Jersey"},{"code":"NM","name":"New Mexico"},{"code":"NV","name":"Nevada"},{"code":"NY","name":"New York"},{"code":"OH","name":"Ohio"},{"code":"OK","name":"Oklahoma"},{"code":"OR","name":"Oregon"},{"code":"PA","name":"Pennsylvania"},{"code":"PR","name":"Puerto Rico"},{"code":"PW","name":"Palau"},{"code":"RI","name":"Rhode Island"},{"code":"SC","name":"South Carolina"},{"code":"SD","name":"South Dakota"},{"code":"TN","name":"Tennessee"},{"code":"TX","name":"Texas"},{"code":"UT","name":"Utah"},{"code":"VA","name":"Virginia"},{"code":"VI","name":"Virgin Islands"},{"code":"VT","name":"Vermont"},{"code":"WA","name":"Washington"},{"code":"WI","name":"Wisconsin"},{"code":"WV","name":"West Virginia"},{"code":"WY","name":"Wyoming"}]},{"code":"CAN","name":"Canada","states":[{"code":"AB","name":"Alberta"},{"code":"BC","name":"British Columbia"},{"code":"MB","name":"Manitoba"},{"code":"NB","name":"New Brunswick"},{"code":"NF","name":"Newfoundland"},{"code":"NS","name":"Nova Scotia"},{"code":"NT","name":"Northwest Territories"},{"code":"ON","name":"Ontario"},{"code":"PE","name":"Prince Edward Island"},{"code":"PQ","name":"Quebec"},{"code":"SK","name":"Saskatchewan"},{"code":"YT","name":"Yukon Territory"}]},{"code":"ABW","name":"Aruba"},{"code":"AFG","name":"Afghanistan"},{"code":"AGO","name":"Angola"},{"code":"AIA","name":"Anguilla"},{"code":"ALB","name":"Albania"},{"code":"AND","name":"Andorra"},{"code":"ANT","name":"Netherlands Antilles"},{"code":"ARE","name":"United Arab Emirates"},{"code":"ARG","name":"Argentina"},{"code":"ARM","name":"Armenia"},{"code":"ASM","name":"American Samoa"},{"code":"ATA","name":"Antarctica"},{"code":"ATF","name":"French Southern Territories"},{"code":"ATG","name":"Antigua and Barbuda"},{"code":"AUS","name":"Australia"},{"code":"AUT","name":"Austria"},{"code":"AZE","name":"Azerbaijan"},{"code":"BDI","name":"Burundi"},{"code":"BEL","name":"Belgium"},{"code":"BEN","name":"Benin"},{"code":"BFA","name":"Burkina Faso"},{"code":"BGD","name":"Bangladesh"},{"code":"BGR","name":"Bulgaria"},{"code":"BHR","name":"Bahrain"},{"code":"BHS","name":"Bahamas"},{"code":"BIH","name":"Bosnia and Herzegovina"},{"code":"BLR","name":"Belarus"},{"code":"BLZ","name":"Belize"},{"code":"BMU","name":"Bermuda"},{"code":"BOL","name":"Bolivia"},{"code":"BRA","name":"Brazil"},{"code":"BRB","name":"Barbados"},{"code":"BRN","name":"Brunei Darussalam"},{"code":"BTN","name":"Bhutan"},{"code":"BVT","name":"Bouvet Island"},{"code":"BWA","name":"Botswana"},{"code":"CAF","name":"Central African Republic"},{"code":"COM","name":"Comoros"},{"code":"CPV","name":"Cape Verde"},{"code":"CRI","name":"Costa Rica"},{"code":"CUB","name":"Cuba"},{"code":"CXR","name":"Christmas Island"},{"code":"CYM","name":"Cayman Islands"},{"code":"CYP","name":"Cyprus"},{"code":"CZE","name":"Czech Republic"},{"code":"DEU","name":"Germany"},{"code":"DJI","name":"Djibouti"},{"code":"DMA","name":"Dominica"},{"code":"DNK","name":"Denmark"},{"code":"DOM","name":"Dominican Republic"},{"code":"DZA","name":"Algeria"},{"code":"ECU","name":"Ecuador"},{"code":"EGY","name":"Egypt"},{"code":"ERI","name":"Eritrea"},{"code":"ESH","name":"Western Sahara"},{"code":"ESP","name":"Spain"},{"code":"EST","name":"Estonia"},{"code":"ETH","name":"Ethiopia"},{"code":"FIN","name":"Finland"},{"code":"FJI","name":"Fiji"},{"code":"FLK","name":"Falkland Islands (Malvinas)","states":null},{"code":"FRA","name":"France"},{"code":"FRO","name":"Faroe Islands"},{"code":"FSM","name":"Micronesia, Federated States"},{"code":"GAB","name":"Gabon"},{"code":"GBR","name":"United Kingdom"},{"code":"GEO","name":"Georgia"},{"code":"GHA","name":"Ghana"},{"code":"GIB","name":"Gibraltar"},{"code":"GIN","name":"Guinea"},{"code":"GLP","name":"Guadeloupe"},{"code":"GMB","name":"Gambia"},{"code":"GNB","name":"Guinea-Bissau"},{"code":"GNQ","name":"Equatorial Guinea"},{"code":"GRC","name":"Greece"},{"code":"GRD","name":"Grenada"},{"code":"GRL","name":"Greenland"},{"code":"GTM","name":"Guatemala"},{"code":"GUF","name":"French Guiana"},{"code":"GUM","name":"Guam"},{"code":"GUY","name":"Guyana"},{"code":"HKG","name":"Hong Kong"},{"code":"HMD","name":"Heard and McDonald Islands"},{"code":"HND","name":"Honduras"},{"code":"HRV","name":"Croatia"},{"code":"HTI","name":"Haiti"},{"code":"HUN","name":"Hungary"},{"code":"IDN","name":"Indonesia"},{"code":"IND","name":"India"},{"code":"IOT","name":"British Indian Ocean Territory"},{"code":"IRL","name":"Ireland"},{"code":"IRQ","name":"Iraq"},{"code":"ISL","name":"Iceland"},{"code":"ISR","name":"Israel"},{"code":"ITA","name":"Italy"},{"code":"JAM","name":"Jamaica"},{"code":"JOR","name":"Jordan"},{"code":"JPN","name":"Japan"},{"code":"KAZ","name":"Kazakstan"},{"code":"KEN","name":"Kenya"},{"code":"KGZ","name":"Kyrgyzstan"},{"code":"KHM","name":"Cambodia"},{"code":"KIR","name":"Kiribati"},{"code":"KNA","name":"Saint Kitts and Nevis"},{"code":"KOR","name":"Korea, Republic of"},{"code":"KWT","name":"Kuwait"},{"code":"LAO","name":"Lao People's Democratic Rep"},{"code":"LBN","name":"Lebanon"},{"code":"LBR","name":"Liberia"},{"code":"LBY","name":"Libyan Arab Jamahiriya"},{"code":"LCA","name":"Saint Lucia"},{"code":"LIE","name":"Liechtenstein"},{"code":"LKA","name":"Sri Lanka"},{"code":"LSO","name":"Lesotho"},{"code":"LTU","name":"Lithuania"},{"code":"LUX","name":"Luxembourg"},{"code":"LVA","name":"Latvia"},{"code":"MAC","name":"Macau"},{"code":"MAR","name":"Morocco"},{"code":"MCO","name":"Monaco"},{"code":"MDA","name":"Moldova, Republic of"},{"code":"MDG","name":"Madagascar"},{"code":"MDV","name":"Maldives"},{"code":"MEX","name":"Mexico"},{"code":"MHL","name":"Marshall Islands"},{"code":"MIL","name":"Use USA-States of AA, AE or AP"},{"code":"MKD","name":"Fmr Yugoslav Rep of Macedonia"},{"code":"MLI","name":"Mali"},{"code":"MLT","name":"Malta"},{"code":"MMR","name":"Myanmar"},{"code":"MNG","name":"Mongolia"},{"code":"MNP","name":"Northern Mariana Islands"},{"code":"CCK","name":"Cocos (Keeling) Islands"},{"code":"CHE","name":"Switzerland"},{"code":"CHL","name":"Chile"},{"code":"CHN","name":"China"},{"code":"CIV","name":"Cote D'Ivoire"},{"code":"CMR","name":"Cameroon"},{"code":"COD","name":"Congo, The Democratic Republic"},{"code":"COG","name":"Congo"},{"code":"COK","name":"Cook Islands"},{"code":"COL","name":"Colombia"},{"code":"MOZ","name":"Mozambique"},{"code":"MRT","name":"Mauritania"},{"code":"MSR","name":"Montserrat"},{"code":"MTQ","name":"Martinique"},{"code":"MUS","name":"Mauritius"},{"code":"MWI","name":"Malawi"},{"code":"MYS","name":"Malaysia"},{"code":"MYT","name":"Mayotte"},{"code":"NAM","name":"Namibia"},{"code":"NCL","name":"New Caledonia"},{"code":"NER","name":"Niger"},{"code":"NFK","name":"Norfolk Island"},{"code":"NGA","name":"Nigeria"},{"code":"NIC","name":"Nicaragua"},{"code":"NIU","name":"Niue"},{"code":"NLD","name":"Netherlands"},{"code":"NOR","name":"Norway"},{"code":"NPL","name":"Nepal"},{"code":"NRU","name":"Nauru"},{"code":"NZL","name":"New Zealand"},{"code":"OMN","name":"Oman"},{"code":"OTH","name":"DO NOT USE FOR CONVERSION ONLY"},{"code":"PAK","name":"Pakistan"},{"code":"PAN","name":"Panama"},{"code":"PCN","name":"Pitcairn"},{"code":"PER","name":"Peru"},{"code":"PHL","name":"Philippines"},{"code":"PLW","name":"Palau"},{"code":"PNG","name":"Papua New Guinea"},{"code":"POL","name":"Poland"},{"code":"PRI","name":"Puerto Rico"},{"code":"PRT","name":"Portugal"},{"code":"PRY","name":"Paraguay"},{"code":"PYF","name":"French Polynesia"},{"code":"QAT","name":"Qatar"},{"code":"REU","name":"Reunion"},{"code":"ROM","name":"Romania"},{"code":"RUS","name":"Russian Federation"},{"code":"RWA","name":"Rwanda"},{"code":"SAU","name":"Saudi Arabia"},{"code":"SDN","name":"Sudan"},{"code":"SEN","name":"Senegal"},{"code":"SGP","name":"Singapore"},{"code":"SGS","name":"Sth Georgia &amp; Sth Sandwich Is"},{"code":"SHN","name":"Saint Helena"},{"code":"SJM","name":"Svalbard and Jan Mayen"},{"code":"SLB","name":"Solomon Islands"},{"code":"SLE","name":"Sierra Leone"},{"code":"SLV","name":"El Salvador"},{"code":"SMR","name":"San Marino"},{"code":"SOM","name":"Somalia"},{"code":"SPM","name":"Saint Pierre and Miquelon"},{"code":"STP","name":"Sao Tome and Principe"},{"code":"SUR","name":"Suriname"},{"code":"SVK","name":"Slovakia"},{"code":"SVN","name":"Slovenia"},{"code":"SWE","name":"Sweden"},{"code":"SWZ","name":"Swaziland"},{"code":"SYC","name":"Seychelles"},{"code":"SYR","name":"Syrian Arab Republic"},{"code":"TCA","name":"Turks and Caicos Islands"},{"code":"TCD","name":"Chad"},{"code":"TGO","name":"Togo"},{"code":"THA","name":"Thailand"},{"code":"TJK","name":"Tajikistan"},{"code":"TKL","name":"Tokelau"},{"code":"TKM","name":"Turkmenistan"},{"code":"TMP","name":"East Timor"},{"code":"TON","name":"Tonga"},{"code":"TTO","name":"Trinidad and Tobago"},{"code":"TUN","name":"Tunisia"},{"code":"TUR","name":"Turkey"},{"code":"TUV","name":"Tuvalu"},{"code":"TWN","name":"Taiwan, Province of China"},{"code":"TZA","name":"Tanzania, United Republic of"},{"code":"UGA","name":"Uganda"},{"code":"UKR","name":"Ukraine"},{"code":"UMI","name":"US Minor Outlying Islands"},{"code":"URY","name":"Uruguay"},{"code":"UZB","name":"Uzbekistan"},{"code":"VAT","name":"Holy See (Vatican City State)"},{"code":"VCT","name":"St Vincent and the Grenadines"},{"code":"VEN","name":"Venezuela"},{"code":"VGB","name":"Virgin Islands (British)"},{"code":"VIR","name":"Virgin Islands (U.S.)"},{"code":"VNM","name":"Viet Nam"},{"code":"VUT","name":"Vanuatu"},{"code":"WLF","name":"Wallis and Futuna Islands"},{"code":"WSM","name":"Samoa"},{"code":"YEM","name":"Yemen"},{"code":"YUG","name":"Yugoslavia"},{"code":"ZAF","name":"South Africa"},{"code":"ZAR","name":"ZAIRE"},{"code":"ZMB","name":"Zambia"},{"code":"ZWE","name":"Zimbabwe"}]}}}}},"404":{"$ref":"#/components/responses/Error404"},"502":{"$ref":"#/components/responses/Error502"}},"summary":"get-ccb-configuration","operationId":"get-ccb-configuration","description":"Retrieves basic configuration data from CCB services.","tags":["Admin Data"],"parameters":[]}},"/configuration":{"get":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/TeamsiteConfiguration"}}},"example":{"data":{"miamidadeUrls":{"aboutMiamiDadeURL":"https://www.miamidade.gov/global/disclaimer/about-miami-dade-county.page","adaNoticeURL":"https://www.miamidade.gov/global/disclaimer/ada-notice.page","contactMiamiDadeURL":"https://www.miamidade.gov/global/311.page","disclaimerURL":"https://www.miamidade.gov/global/disclaimer/disclaimer.page","facebookAccountURL":"https://www.facebook.com/miamidadecounty","instagramAccountURL":"https://www.instagram.com/miamidadecounty","miamiDadeHomeURL":"https://miamidade.gov","miamiDadePropertySearchURL":"https://www.miamidade.gov/propertysearch/#/","mobileApplicationCenterURL":"https://www.miamidade.gov/global/mobile-applications.page","phoneDirectoryURL":"https://www.miamidade.gov/global/navigation/agency-directory.page","privacyStatementURL":"https://www.miamidade.gov/global/disclaimer/privacy-and-security.page","socialMediaCenterURL":"https://www.miamidade.gov/global/social-media.page","twitterAccountURL":"https://twitter.com/MiamiDadeCounty","youTubeAccountURL":"https://www.youtube.com/user/MiamiDadeTV"},"wasdUrls":{"certifiedMeterTestURL":"https://www.miamidade.gov/global/service.page?Mduid_service=ser1481317436214369","feedbackURL":"https://miamidadecounty.co1.qualtrics.com/jfe/form/SV_ehUyWHof5ekicZL","payWithAutoPayURL":"https://collectpay-uat.princetonecom.com/enrollment/loadLogin.do?id=562104","readYourWaterMeterURL":"https://www.miamidade.gov/global/service.page?Mduid_service=ser1528381732126279","startServiceURL":"http://review-iis.miamidade.gov/water/int/bill_app/session.asp?account=:accountNumber&form=start","tamperingViolationsURL":"https://www.miamidade.gov/global/service.page?Mduid_service=ser1523048123577596","transferServiceURL":"http://review-iis.miamidade.gov/water/int/bill_app/session.asp?account=:accountNumber&form=transfer","undergroundLeakAdjustmentURL":"https://www.miamidade.gov/global/service.page?Mduid_service=ser1481317436214369","wasdTeamsiteURL":"http://review-iis.miamidade.gov/water/int","watsonURL":"https://wasd-chat-int.miamidade.gov/chatservice/html/chat-auth.html"}}}}}},"404":{"$ref":"#/components/responses/Error404"},"502":{"$ref":"#/components/responses/Error502"}},"summary":"get-configuration","operationId":"get-configuration","description":"Retrieves basic, web site, configuration data, including Teamsite URLs.","tags":["Teamsite"],"parameters":[]}},"/phoneNumberTypes":{"get":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"description":"data returned by the operation","type":"object","properties":{"phoneNumberTypes":{"description":"the different types of phones that user contact information can contain","type":"array","items":{"$ref":"#/components/schemas/ContactPhoneNumberType"}}}}}},"example":{"data":{"phoneNumberTypes":[{"code":"BUSINESS","description":"Business Phone"},{"code":"CELLULAR","description":"Cellular Phone"},{"code":"FAX","description":"FAX"},{"code":"HOME","description":"Home Phone"}]}}}}},"404":{"$ref":"#/components/responses/Error404"},"502":{"$ref":"#/components/responses/Error502"}},"summary":"get-phone-number-types","operationId":"get-phone-number-types","description":"Retrieves the different phone number types available in the system.","tags":["Phone Number Types"],"parameters":[]}},"/accounts/{accountId}/paperlessIndicator":{"put":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"description":"data returned by the operation","type":"object","properties":{"paperlessIndicator":{"description":"whether or not the paperless billing request is granted","type":"boolean"},"accountNumber":{"$ref":"#/components/schemas/AccountNumber"}},"required":["accountNumber","paperlessIndicator"]}},"required":["data"]},"example":{"data":{"paperlessIndicator":true,"accountNumber":"0123456789"}}}}},"404":{"$ref":"#/components/responses/Error404"},"502":{"$ref":"#/components/responses/Error502"}},"summary":"put-paperless-indicator","operationId":"put-paperless-indicator","description":"Updates the Paperless Indicator to turn on/off the paperless billing user preference.","tags":["Paperless Billing"],"parameters":[{"name":"accountId","in":"path","description":"an account identifier in the form of a ten digit string","required":true,"example":"0123456789","schema":{"$ref":"#/components/schemas/AccountNumber"}}],"requestBody":{"content":{"application/json":{"example":{"paperlessIndicator":"true"},"schema":{"type":"object","properties":{"paperlessIndicator":{"description":"an indicator of whether or not the account is enrolled in paperless billing","type":"boolean"}},"required":["paperlessIndicator"]}}}}}},"/{webUserId}/accounts":{"get":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"description":"data returned by the operation","type":"object","properties":{"webUserId":{"$ref":"#/components/schemas/WebUserId"},"registrationEmail":{"$ref":"#/components/schemas/RegistrationEmail"},"accounts":{"$ref":"#/components/schemas/Accounts"}},"required":["webUserId","registrationEmail","accounts"]}},"required":["data"]},"example":{"data":{"webUserId":"12345678","registrationEmail":"mail@miamidade.gov","accounts":[{"accountNumber":"0123456789","premiseType":"RES","person":{"id":"9133237200","firstName":"CARLOS","lastName":"RODRIGUEZ"},"accountAddress":{"address1":"PO BOX 651159","address2":null,"city":"MIAMI","state":"FL","zip":"33265","county":"MIAMI-DADE","country":"USA"},"accountStatus":"ACTIVE","accountType":"NORMAL"},{"accountNumber":"0123456789","premiseType":"BUS","business":{"id":"0987654321","entityName":"entityName1"},"accountAddress":{"address1":"PO BOX 651159","address2":null,"city":"MIAMI","state":"FL","zip":"33265","county":"MIAMI-DADE","country":"USA"},"accountStatus":"ACTIVE","accountType":"NORMAL"},{"accountNumber":"0123456789","premiseType":null,"person":{"id":"2213845200","firstName":"ADELA","lastName":"LONDONO"},"accountAddress":{"zip":"33183","country":"USA","address2":null,"city":"MIAMI","address1":"12920 SW 83RD ST","county":null,"state":"FL"},"accountStatus":"PENDING STOP","accountType":"NORMAL","stopDate":"2003-02-28"}]}}}}},"404":{"$ref":"#/components/responses/Error404"},"502":{"$ref":"#/components/responses/Error502"}},"summary":"get-accounts","operationId":"get-accounts","description":"Retrieves a list of accounts for a user.","tags":["Account"],"parameters":[{"name":"webUserId","in":"path","description":"a web user identifier in the form of an eight digit string","required":true,"example":"12345678","schema":{"$ref":"#/components/schemas/WebUserId"}}]}},"/accounts/{accountId}/accountExists":{"get":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"description":"data returned by the operation","type":"object","properties":{"accountStatus":{"$ref":"#/components/schemas/AccountStatus"},"accountNumber":{"$ref":"#/components/schemas/AccountNumber"},"accountExists":{"description":"whether or not the account exists in the CCB system","type":"boolean"}},"required":["accountStatus","accountNumber","accountExists"]}},"required":["data"]},"example":{"data":{"accountStatus":"ACTIVE","accountNumber":"0123456789","accountExists":true}}}}},"404":{"$ref":"#/components/responses/Error404"},"502":{"$ref":"#/components/responses/Error502"}},"summary":"get-account-exists","operationId":"get-account-exists","description":"Checks if an account exists.","tags":["Account"],"parameters":[{"name":"accountId","in":"path","description":"an account identifier in the form of a ten digit string","required":true,"example":"0123456789","schema":{"$ref":"#/components/schemas/AccountNumber"}}]}},"/accountsByPhoneNumber/{phoneNumber}":{"get":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"description":"data returned by the operation","type":"object","oneOf":[{"type":"object","required":["success","accountsList","numberOfAccounts"],"properties":{"accountsList":{"type":"array","items":{"type":"object","properties":{"number":{"$ref":"#/components/schemas/AccountNumber"},"type":{"$ref":"#/components/schemas/PremiseTypeCode"}},"required":["number","type"]}},"numberOfAccounts":{"type":"integer"},"success":{"type":"boolean","description":"whether or not operation succeeded"}}},{"type":"object","required":["success","error"],"properties":{"error":{"$ref":"#/components/schemas/BusinessError"},"success":{"type":"boolean","description":"whether or not operation succeeded"}}}]}},"required":["data"],"example":[{"data":{"accountsList":[{"number":"7937812200","type":"BUS"}],"numberOfAccounts":1},"success":true},{"data":{"error":{"code":"10004","message":"The Account you entered is invalid."}},"success":false}]},"example":{"data":{"accountsList":[{"number":"7937812200","type":"RES"}]}}}}},"404":{"$ref":"#/components/responses/Error404"},"502":{"$ref":"#/components/responses/Error502"}},"summary":"get-accounts-by-phone-number","operationId":"get-accounts-by-phone-number","description":"Retrieves account numbers and premise types by phone number. (Not SSA)","tags":["Account"],"parameters":[{"name":"phoneNumber","in":"path","description":"a phone number in the form of a ten digit string","required":true,"example":"3056657477","schema":{"$ref":"#/components/schemas/PhoneNumber"}}]}},"/ivr/accountsByPhoneNumber/{phoneNumber}":{"get":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"oneOf":[{"type":"object","properties":{"accountsList":{"description":"a collection of account numbers and premise type codes","type":"array","items":{"type":"object","properties":{"number":{"$ref":"#/components/schemas/AccountNumber"},"type":{"$ref":"#/components/schemas/PremiseTypeCode"}},"required":["number","type"]}},"phoneNumber":{"$ref":"#/components/schemas/PhoneNumber"},"hasError":{"type":"boolean","description":"whether or not operation succeeded"},"error":{"description":"null under this variation","type":"object"},"numberOfAccounts":{"type":"integer"}},"required":["accountsList","phoneNumber","hasError","error","numberOfAccounts"]},{"type":"object","properties":{"accountsList":{"description":"a collection of account numbers and premise type codes","type":"array","nullable":true,"items":{"type":"object","properties":{"number":{"$ref":"#/components/schemas/AccountNumber"},"type":{"$ref":"#/components/schemas/PremiseTypeCode"}},"required":["number","type"]}},"phoneNumber":{"$ref":"#/components/schemas/PhoneNumber"},"hasError":{"type":"boolean","description":"whether or not operation succeeded"},"error":{"$ref":"#/components/schemas/BusinessError"}},"required":["accountsList","phoneNumber","hasError","error"]}]}},"required":["data"]},"example":[{"data":{"accountsList":[{"number":"7580073574","type":"RESIDENTIAL"}],"phoneNumber":"7862992240","numberOfAccounts":1,"hasError":false,"error":null}},{"data":{"accountsList":null,"phoneNumber":"3053359992","hasError":true,"error":{"code":"NOPHONE","message":"Unknown Phone Number"}}},{"data":{"accountsList":null,"phoneNumber":"305335999","hasError":true,"error":{"code":"WRNGFMT","message":"Wrong Phone Number Format"}}},{"data":{"accountsList":null,"phoneNumber":"7862087151","hasError":true,"error":{"code":"DUPLACCT","message":"More than 1 account of the same type for phone number."}}}]}}},"404":{"$ref":"#/components/responses/Error404"},"502":{"$ref":"#/components/responses/Error502"}},"summary":"ivr-get-accounts-by-phone-number","operationId":"ivr-get-accounts-by-phone-number","description":"Retrieves account numbers and premise types by phone number. (Not SSA)","tags":["IVR Account"],"parameters":[{"name":"phoneNumber","in":"path","description":"a phone number in the form of a ten digit string","required":true,"example":"3056657477","schema":{"$ref":"#/components/schemas/PhoneNumber"}}]}},"/{webUserId}/accounts/{accountId}/linkAccount":{"post":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"description":"data returned by the operation","type":"object","properties":{"accountNumber":{"$ref":"#/components/schemas/AccountNumber"},"webUserId":{"$ref":"#/components/schemas/WebUserId"},"effectiveDate":{"description":"the date when an account is enrolled","type":"string","format":"date"}},"required":["accountNumber","webUserId","effectiveDate"]}},"required":["data"],"example":{"data":{"accountNumber":"0123456789","webUserId":"12345678","effectiveDate":"2020-05-26"}}},"example":{"data":{"accountNumber":"0123456789","webUserId":"12345678","effectiveDate":"2020-05-26"}}}}},"404":{"$ref":"#/components/responses/Error404"},"502":{"$ref":"#/components/responses/Error502"}},"summary":"post-link-account","operationId":"post-link-account","description":"Link an account to a web user Id.","tags":["Account"],"parameters":[{"name":"webUserId","in":"path","description":"a web user identifier in the form of an eight digit string","required":true,"example":"12345678","schema":{"$ref":"#/components/schemas/WebUserId"}},{"name":"accountId","in":"path","description":"an account identifier in the form of a ten digit string","required":true,"example":"0123456789","schema":{"$ref":"#/components/schemas/AccountNumber"}}],"requestBody":{"content":{"application/json":{"example":{"accountId":"0123456789","webUserId":"12345678","homePhone":"3056657477","businessPhone":"3056657477","mobilePhone":"3056657477","registrationMobilePhone":"3056657477","registrationSecondPhone":"3056657477","email":"mail@miamidade.gov","accountType":"B"},"schema":{"type":"object","required":["accountId","webUserId","homePhone","businessPhone","mobilePhone","registrationMobilePhone","registrationSecondPhone","email","accountType"],"properties":{"accountId":{"$ref":"#/components/schemas/AccountNumber"},"accountType":{"$ref":"#/components/schemas/AccountType"},"businessPhone":{"$ref":"#/components/schemas/PhoneNumber"},"email":{"type":"string","format":"email","description":"the user's registered email"},"homePhone":{"$ref":"#/components/schemas/PhoneNumber"},"mobilePhone":{"$ref":"#/components/schemas/PhoneNumber"},"registrationMobilePhone":{"$ref":"#/components/schemas/PhoneNumber"},"registrationSecondPhone":{"$ref":"#/components/schemas/PhoneNumber"},"webUserId":{"$ref":"#/components/schemas/WebUserId"},"entityId":{"description":"a unique identifier, either a PersonId or BusinessId","oneOf":[{"$ref":"#/components/schemas/BusinessId"},{"$ref":"#/components/schemas/PersonId"}]},"enrollmentIdentifier":{"description":"a unique identifier used to enroll the entity","oneOf":[{"$ref":"#/components/schemas/SocialSecurityNumberLastFourDigits"},{"$ref":"#/components/schemas/DriversLicense"},{"$ref":"#/components/schemas/Passport"},{"$ref":"#/components/schemas/FederalTaxNumber"}]}}}}}}}},"/{webUserId}/accounts/{accountId}/unlinkAccount":{"get":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"description":"data returned by the operation","type":"object","properties":{"accountNumber":{"$ref":"#/components/schemas/AccountNumber"},"webUserId":{"$ref":"#/components/schemas/WebUserId"},"effectiveDate":{"type":"string","format":"date"}},"required":["accountNumber","webUserId","effectiveDate"]}},"required":["data"]},"example":{"data":{"accountNumber":"0123456789","webUserId":"12345678","effectiveDate":"2015-05-26"}}}}},"404":{"$ref":"#/components/responses/Error404"},"502":{"$ref":"#/components/responses/Error502"}},"summary":"get-unlink-account","operationId":"get-unlink-account","description":"Unlink an account from a user Id.","tags":["Account"],"parameters":[{"name":"webUserId","in":"path","description":"a web user identifier in the form of an eight digit string","required":true,"example":"12345678","schema":{"$ref":"#/components/schemas/WebUserId"}},{"name":"accountId","in":"path","description":"an account identifier in the form of a ten digit string","required":true,"example":"0123456789","schema":{"$ref":"#/components/schemas/AccountNumber"}}]}},"/validateUspsAddress&city={city}&state={state}&unit={unit}&zip4={zip4}&zip5={zip5}":{"get":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"description":"data returned by the operation","type":"object","oneOf":[{"$ref":"#/components/schemas/USPSAddress"},{"type":"object","properties":{"error":{"$ref":"#/components/schemas/BusinessError"}},"required":["error"]}]}},"example":{"data":{"unit":"Penthouse","address":"6406 IVY LN","city":"GREENBELT","state":"MD","zip5":"20770","zip4":"1441"}}},"example":{"data":{"unit":"Penthouse","address":"6406 IVY LN","city":"GREENBELT","state":"MD","zip5":"20770","zip4":"1441"}}}}},"404":{"$ref":"#/components/responses/Error404"},"502":{"$ref":"#/components/responses/Error502"}},"summary":"get-validate-usps-address","operationId":"get-validate-usps-address","description":"Validates the given address using the USPS service.","tags":["Address Validation"],"parameters":[{"name":"address","in":"query","description":"a street address","required":true,"example":"6406 Ivy Lane","schema":{"$ref":"#/components/schemas/AddressStreet"}},{"name":"unit","in":"path","description":"a unit number or name","required":true,"example":"Penthouse","schema":{"$ref":"#/components/schemas/AddressStreet"}},{"name":"city","in":"path","description":"a city name","required":true,"example":"Greenbelt","schema":{"$ref":"#/components/schemas/AddressCity"}},{"name":"state","in":"path","description":"a two character uppercase state abbreviation","required":true,"example":"MD","schema":{"$ref":"#/components/schemas/AddressState"}},{"name":"zip5","in":"path","description":"zip5 in the form of a 5 digit string","required":true,"example":"33031","schema":{"$ref":"#/components/schemas/Zip5"}},{"name":"zip4","in":"path","description":"zip4 in the form of a 4 digit string","required":true,"example":"9165","schema":{"$ref":"#/components/schemas/Zip4"}}]}},"/accounts/{accountId}/bills":{"get":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"description":"data returned by the operation","type":"object","properties":{"accountNumber":{"$ref":"#/components/schemas/AccountNumber"},"bills":{"$ref":"#/components/schemas/Bills"}},"required":["bills","accountNumber"]}},"required":["data"]},"example":{"data":{"bills":[{"amountDue":1206.07,"routeSeqNo":"0","pdfAvailable":true,"adjustments":[{"amount":0.01,"description":"Late Payment Fee","type":"RWT-LATE"},{"amount":0.02,"description":"Late Payment Fee","type":"RWW-LATE"},{"amount":0.03,"description":"Late Payment Fee","type":"RWT-LATE"},{"amount":0.04,"description":"Late Payment Fee","type":"RWW-LATE"},{"amount":0.05,"description":"Late Payment Fee","type":"RWT-LATE"},{"amount":0.06,"description":"Late Payment Fee","type":"RWW-LATE"},{"amount":0.07,"description":"Late Payment Fee","type":"RWT-LATE"},{"amount":0.08,"description":"Late Payment Fee","type":"RWW-LATE"},{"amount":0.09,"description":"Late Payment Fee","type":"RWT-LATE"},{"amount":99.55,"description":"Total should be $100.00","type":"RWW-LATE"}],"billSegments":[{"daysOfService":89,"measuredUOM":"CFW","badgeNumber":"36594810","dateFrom":"2025-09-08","spId":"7563322497","finalRegQtyGal":74052,"toReading":1936,"finalUOMGal":"Gals","dateTo":"2025-12-06","finalUOM":"CCF","fromReading":1837,"measuredQty":99,"finalRegQty":99,"meterSize":"5/8\"","isSubMeterPoint":true,"isReadEstimation":false}],"pastDueDate":"2025-01-04","dateTo":"2025-12-06","rank":1,"billDate":"2025-12-14","id":"121782811831","dateFrom":"2025-09-08","currentCharges":1206.07},{"amountDue":191.07,"routeSeqNo":"0","pdfAvailable":true,"adjustments":null,"billSegments":[{"daysOfService":94,"measuredUOM":"CFW","badgeNumber":"36594810","dateFrom":"2025-06-07","spId":"7563322497","finalRegQtyGal":16456,"toReading":1837,"finalUOMGal":"Gals","dateTo":"2025-09-08","finalUOM":"CCF","fromReading":1815,"measuredQty":22,"finalRegQty":22,"meterSize":"5/8\"","isSubMeterPoint":false,"isReadEstimation":false}],"pastDueDate":"2025-10-10","dateTo":"2025-09-08","rank":2,"billDate":"2025-09-19","id":"121219398214","dateFrom":"2025-06-07","currentCharges":157.9},{"amountDue":124.71,"routeSeqNo":"0","pdfAvailable":true,"adjustments":[{"amount":3.1,"description":"Late Payment Fee","type":"RWT-LATE"},{"amount":5.68,"description":"Late Payment Fee","type":"RWW-LATE"}],"billSegments":[{"daysOfService":92,"measuredUOM":"CFW","badgeNumber":"36594810","dateFrom":"2025-03-07","spId":"7563322497","finalRegQtyGal":11968,"toReading":1815,"finalUOMGal":"Gals","dateTo":"2025-06-07","finalUOM":"CCF","fromReading":1799,"measuredQty":16,"finalRegQty":16,"meterSize":"5/8\"","isSubMeterPoint":true,"isReadEstimation":false}],"pastDueDate":"2025-07-05","dateTo":"2025-06-07","rank":3,"billDate":"2025-06-14","id":"121790855008","dateFrom":"2025-03-07","currentCharges":-33.17},{"amountDue":157.88,"routeSeqNo":"0","pdfAvailable":true,"adjustments":null,"billSegments":[{"daysOfService":85,"measuredUOM":"CFW","badgeNumber":"36594810","dateFrom":"2025-12-12","spId":"7563322497","finalRegQtyGal":14212,"toReading":1799,"finalUOMGal":"Gals","dateTo":"2025-03-07","finalUOM":"CCF","fromReading":1780,"measuredQty":19,"finalRegQty":19,"meterSize":"5/8\"","isSubMeterPoint":false,"isReadEstimation":false}],"pastDueDate":"2025-04-05","dateTo":"2025-03-07","rank":4,"billDate":"2025-03-15","id":"121461010204","dateFrom":"2025-12-12","currentCharges":157.88}],"accountNumber":"0123456789"}}}}},"404":{"$ref":"#/components/responses/Error404"},"502":{"$ref":"#/components/responses/Error502"}},"summary":"get-bills","operationId":"get-bills","description":"Retrieves the bills associated with an account.","tags":["Bills"],"parameters":[{"name":"accountId","in":"path","description":"an account identifier in the form of a ten digit string","required":true,"example":"0123456789","schema":{"$ref":"#/components/schemas/AccountNumber"}}]}},"/pdfBill/generatorId/{generatorId}":{"get":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/pdf":{}}},"404":{"$ref":"#/components/responses/Error404"},"502":{"$ref":"#/components/responses/Error502"}},"summary":"get-pdf-bill-by-generator-id","operationId":"get-pdf-bill-by-generator-id","description":"Returns a PDF document for a bill. The identifier is a generatorId. This is used for getting pdf bills when user is not authenticated like a link in an email , where the user can access the bill without having to login.","tags":["Bills"],"parameters":[{"name":"generatorId","in":"path","description":"a bill identifier","required":true,"example":"DBF659CBBFE5D0BCC84227587E8AE2AB","schema":{"type":"string"}}]}},"/pdfBill/{billId}":{"get":{"responses":{"200":{"description":"OK","headers":{},"content":{}},"404":{"$ref":"#/components/responses/Error404"},"502":{"$ref":"#/components/responses/Error502"}},"summary":"get-pdf-bill-by-bill-id","operationId":"get-pdf-bill-by-bill-id","description":"Returns a PDF document for a bill. The identifier is a bill Id.","tags":["Bills"],"parameters":[{"name":"billId","in":"path","description":"a bill identifier","required":true,"example":"012345678901","schema":{"$ref":"#/components/schemas/BillId"}}]}},"/accounts/{accountId}/billExtension":{"post":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"description":"data returned by the operation","type":"object","properties":{"accountNumber":{"$ref":"#/components/schemas/AccountNumber"},"billExtensionDetails":{"$ref":"#/components/schemas/BillExtensionDetails"}},"required":["accountNumber","billExtensionDetails"]}},"required":["data"]},"example":{"data":{"accountNumber":"0123456789","billExtensionDetails":{"accountBalance":0,"billDate":"2025-07-26","billDueMessageCodes":"11029","currentBillAmount":65.3,"extensionDate":"2025-09-13","extnAccountBalance":46,"latePaymentFee":"10 % of 0.00","numberOfExtensions":"2","prevExtensionDate":"2025-03-08","prevExtensionGrantedDate":"2025-03-08"}}}}}},"404":{"$ref":"#/components/responses/Error404"},"502":{"$ref":"#/components/responses/Error502"}},"summary":"post-bill-extension","operationId":"post-bill-extension","description":"Request for a payment extension for an account. It uses CCB services created by IBM for payment extension. It should not be used for future development.","tags":["Bill Extension"],"parameters":[{"name":"accountId","in":"path","description":"an account identifier in the form of a ten digit string","required":true,"example":"0123456789","schema":{"$ref":"#/components/schemas/AccountNumber"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillExtensionConfirmation"},"example":{"acctBalVerified":false,"comments":"This is an example of a comment.","contactClass":"WAT","contactType":"WATBEXTN","grantExtension":20,"personId":"4463474692"}}}}}},"/cases/{caseId}/cancel":{"post":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"cancelledDate":{"description":"the date when user requested the cancellation of this case","type":"string"},"caseId":{"$ref":"#/components/schemas/CaseId"},"isCancelled":{"description":"is the cancellation successful","type":"string"},"messages":{"$ref":"#/components/schemas/Messages"}}}}},"example":{"data":{"caseId":"1559523747","isCancelled":"true","messages":["abcdefghijklmnopqrstuwxyz...","abcdefghijklmnopqrstuwxyz...","abcdefghijklmnopqrstuwxyz..."],"cancelledDate":"2025-05-20"}}}}},"404":{"$ref":"#/components/responses/Error404"}},"summary":"post-case-cancel","operationId":"post-case-cancel","description":"It cancels a case with id = caseId","tags":["Case"],"parameters":[{"name":"caseId","in":"path","description":"a case identifier in the form of a ten digit string","required":true,"example":"0123456789","schema":{"$ref":"#/components/schemas/CaseId"}}],"requestBody":{"content":{"application/json":{"example":{"reason":"the house was sold"},"schema":{"type":"object","properties":{"reason":{"type":"string"}}}}}}}},"/accounts/{accountId}/casestatus":{"get":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"accountNumber":{"$ref":"#/components/schemas/AccountNumber"},"premiseId":{"$ref":"#/components/schemas/PremiseId"},"cases":{"$ref":"#/components/schemas/Cases"}}}}},"example":{"data":{"accountNumber":"0123456789","premiseId":"0123456789","cases":[{"caseStatus":"ACTIVE","caseType":"Pool Credit","confirmationNumber":"0123456789","denialReason":null,"fillDate":"2025-08-21","requestedDate":"2025-08-22"},{"caseStatus":"ACTIVE","caseType":"High Bill Investigation","confirmationNumber":"0123456789","denialReason":null,"requestedDate":"2025-08-22"}]}}}}},"404":{"$ref":"#/components/responses/Error404"}},"summary":"get-case-status","operationId":"get-case-status","description":"Checks the account for a customer case status.","tags":["Case"],"parameters":[{"name":"accountId","in":"path","description":"an account identifier in the form of a ten digit string","required":true,"example":"0123456789","schema":{"$ref":"#/components/schemas/AccountNumber"}}]}},"/accounts/{accountId}/customerContact":{"post":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CustomerContact"}},"required":["data"]},"example":{"data":{"accountNumber":"0123456789","ccId":"4463474179"}}}}},"404":{"$ref":"#/components/responses/Error404"},"502":{"$ref":"#/components/responses/Error502"}},"summary":"post-customer-contact","operationId":"post-customer-contact","description":"Creates a customer contact for an account.","tags":["Contact Information"],"parameters":[{"name":"accountId","in":"path","description":"an account identifier in the form of a ten digit string","required":true,"example":"0123456789","schema":{"$ref":"#/components/schemas/AccountNumber"}}],"requestBody":{"content":{"application/json":{"example":{"personId":"4463474692","contactClass":"WAT","contactType":"WATEXTNTHX","comments":"This is an example of a comment."},"schema":{"$ref":"#/components/schemas/CustomerContactComments"}}}}}},"/{webUserId}/updateRegistrationEmail":{"post":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegistrationEmailUpdate"},"example":{"data":{"webUserId":"12345678","registrationEmail":"mail@miamidade.gov"}}}}},"404":{"$ref":"#/components/responses/Error404"},"502":{"$ref":"#/components/responses/Error502"}},"summary":"post-update-registration-email","operationId":"post-update-registration-email","description":"Processes an update to the user's registered email.","tags":["Contact Information"],"parameters":[{"name":"webUserId","in":"path","description":"a web user identifier in the form of an eight digit string","required":true,"example":"12345678","schema":{"$ref":"#/components/schemas/WebUserId"}}],"requestBody":{"content":{"application/json":{"example":{"registrationEmail":"mail@miamidade.gov"},"schema":{"type":"object","properties":{"registrationEmail":{"$ref":"#/components/schemas/RegistrationEmail"}},"required":["registrationEmail"]}}}}}},"/accounts/{accountId}/emailAddresses":{"get":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"description":"data returned by the operation","type":"object","properties":{"emailAddresses":{"$ref":"#/components/schemas/EmailAddresses"}},"required":["emailAddresses"]}},"required":["data"]},"example":{"data":{"emailAddresses":[{"type":"PER_EMAIL","email":"registration.email@miamidade.gov"},{"type":"ACI_EMAIL","email":"aci.email@miamidade.gov"},{"type":"WEB_EMAIL","email":"web.email@miamidade.gov"},{"type":"PAPERLESS_EMAIL","email":"username@domainname.extension"}]}}}}},"404":{"$ref":"#/components/responses/Error404"},"502":{"$ref":"#/components/responses/Error502"}},"summary":"get-email-addresses","operationId":"get-email-addresses","description":"Retrieves the email addresses associated with an account.","tags":["Contact Information"],"parameters":[{"name":"accountId","in":"path","description":"an account identifier in the form of a ten digit string","required":true,"example":"0123456789","schema":{"$ref":"#/components/schemas/AccountNumber"}}]},"post":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"description":"data returned by the operation","type":"object","properties":{"emailAddresses":{"$ref":"#/components/schemas/EmailAddresses"}},"required":["accountNumber","emailAddresses"]}},"required":["data"]},"example":{"data":{"accountNumber":"0123456789","emailAddresses":[{"id":"0123456789","primary":"Yes","type":"PER_EMAIL","email":"registration.email@miamidade.gov"},{"id":"0123456789","primary":"No","type":"ACI_EMAIL","email":"aci.email@miamidade.gov"},{"id":"0123456789","primary":"No","type":"WEB_EMAIL","email":"web.email@miamidade.gov"},{"id":"0123456789","primary":"No","type":"PAPERLESS_EMAIL","email":"username@domainname.extension"}]}}}}},"404":{"$ref":"#/components/responses/Error404"},"502":{"$ref":"#/components/responses/Error502"}},"summary":"post-email-addresses","operationId":"post-email-addresses","description":"Updates email addresses associated with an account.","tags":["Contact Information"],"parameters":[{"name":"accountId","in":"path","description":"an account identifier in the form of a ten digit string","required":true,"example":"0123456789","schema":{"$ref":"#/components/schemas/AccountNumber"}}],"requestBody":{"content":{"application/json":{"example":{"emailAddresses":[{"id":"0123456789","primary":"Yes","type":"PER_EMAIL","email":"registration.email@miamidade.gov"},{"id":"0123456789","primary":"No","type":"ACI_EMAIL","email":"aci.email@miamidade.gov"},{"id":"0123456789","primary":"No","type":"WEB_EMAIL","email":"web.email@miamidade.gov"},{"id":"0123456789","primary":"No","type":"PAPERLESS_EMAIL","email":"username@domainname.extension"}]},"schema":{"type":"object","properties":{"emailAddresses":{"$ref":"#/components/schemas/EmailAddresses"}},"required":["emailAddresses"]}}}}}},"/accounts/{accountId}/phoneNumbers":{"get":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"description":"data returned by the operation","type":"object","properties":{"phoneNumbers":{"$ref":"#/components/schemas/ContactPhoneNumbers"}},"required":["phoneNumbers"]}},"required":["data"]},"example":{"data":{"accountNumber":"3641991063","numberOfPhoneNumbers":1,"phoneNumbers":[{"number":"3052750001","type":"HOME","sequence":"1"},{"number":"3052750002","type":"CAMPUS","sequence":"2"},{"number":"3052750003","type":"BUSINESS","sequence":"3","extension":"57836"},{"number":"3052750004","type":"BUSINESS","sequence":"4","extension":"1"},{"number":"3052750005","type":"FAX","sequence":"6"},{"number":"3052750006","type":"CELLULAR","sequence":"7"},{"number":"3052750007","type":"DORMITORY","sequence":"8"}]}}}}},"404":{"$ref":"#/components/responses/Error404"},"502":{"$ref":"#/components/responses/Error502"}},"summary":"get-phone-numbers","operationId":"get-phone-numbers","description":"Retrieves the telephone numbers associated with an account.","tags":["Contact Information"],"parameters":[{"name":"accountId","in":"path","description":"an account identifier in the form of a ten digit string","required":true,"example":"0123456789","schema":{"$ref":"#/components/schemas/AccountNumber"}}]},"post":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"description":"data returned by the operation","type":"object","properties":{"accountNumber":{"$ref":"#/components/schemas/AccountNumber"},"numberOfPhoneNumbers":{"description":"a count of the number of phone numbers associated with this account","type":"integer"},"phoneNumbers":{"$ref":"#/components/schemas/ContactPhoneNumbers"}},"required":["accountNumber","numberOfPhoneNumbers","phoneNumbers"]}},"required":["data"]},"example":{"data":{"accountNumber":"0123456789","numberOfPhoneNumbers":3,"phoneNumbers":[{"type":"CELLULAR","number":"3055555555","sequence":"1"},{"type":"HOME","number":"3055555554","sequence":"2"},{"type":"PAGER 1","number":"3055555553","sequence":"3"}]}}}}},"404":{"$ref":"#/components/responses/Error404"},"502":{"$ref":"#/components/responses/Error502"}},"summary":"post-phone-numbers","operationId":"post-phone-numbers","description":"Updates telephone numbers associated with an account.","tags":["Contact Information"],"parameters":[{"name":"accountId","in":"path","description":"an account identifier in the form of a ten digit string","required":true,"example":"0123456789","schema":{"$ref":"#/components/schemas/AccountNumber"}}],"requestBody":{"content":{"application/json":{"example":{"phoneNumbers":[{"type":"BUSINESS","number":"3055555555","sequence":"1","extension":"111"},{"type":"HOME","number":"3055555554","sequence":"2"},{"type":"WSSMOBILE","number":"3055555553","sequence":"3"}]},"schema":{"type":"object","properties":{"phoneNumbers":{"$ref":"#/components/schemas/ContactPhoneNumbers"}},"required":["phoneNumbers"]}}}}}},"/accounts/{accountId}/meterTestEligibility":{"post":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"description":"data returned by the operation","type":"object","properties":{"accountNumber":{"$ref":"#/components/schemas/AccountNumber"},"meterTestDetails":{"$ref":"#/components/schemas/MeterTestEligibility"}},"required":["accountNumber","meterTestDetails"]}},"required":["data"]}}}},"404":{"$ref":"#/components/responses/Error404"},"502":{"$ref":"#/components/responses/Error502"}},"summary":"post-certified-meter-test-eligibility","operationId":"post-certified-meter-test-eligibility","description":"Checks if the account is eligible for a Certified Meter Test (CMT) service request.","tags":["Certified Meter Test"],"parameters":[{"name":"accountId","in":"path","description":"an account identifier in the form of a ten digit string","required":true,"example":"0123456789","schema":{"$ref":"#/components/schemas/AccountNumber"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"badgeNumber":{"$ref":"#/components/schemas/BadgeNumber"}},"required":["badgeNumber"]}}}}}},"/accounts/{accountId}/meterTest":{"post":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"description":"data returned by the operation","type":"object","properties":{"accountNumber":{"$ref":"#/components/schemas/AccountNumber"},"meterTestDetails":{"$ref":"#/components/schemas/MeterTestDetails"}},"required":["accountNumber","meterTestDetails"]}},"required":["data"]},"example":{"data":{"accountNumber":"0123456789","meterTestDetails":{"confirmationNumber":"0987654321","isPaymentRequired":true,"isExtensionGranted":true}}}}}},"404":{"$ref":"#/components/responses/Error404"},"502":{"$ref":"#/components/responses/Error502"}},"summary":"post-certified-meter-test-process","operationId":"post-certified-meter-test-process","description":"Updates a Certified Meter Test (CMT) service request.","tags":["Certified Meter Test"],"parameters":[{"name":"accountId","in":"path","description":"an account identifier in the form of a ten digit string","required":true,"example":"0123456789","schema":{"$ref":"#/components/schemas/AccountNumber"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"confirmationNumber":{"$ref":"#/components/schemas/ConfirmationNumber"}},"required":["confirmationNumber"]}}}}}},"/accounts/{accountId}/financialInfo":{"get":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"description":"data returned by the operation","type":"object","properties":{"accountNumber":{"$ref":"#/components/schemas/AccountNumber"},"financialInformation":{"$ref":"#/components/schemas/FinancialInformation"}},"required":["accountNumber","financialInformation"]}},"required":["data"]},"example":{"data":{"accountNumber":"0123456789","financialInformation":{"autoPayIndicator":false,"cashOnlyIndicator":false,"currentBalance":10000,"eBillIndicator":true,"lastBillAmount":9999.99,"lastBillDate":"2025-04-01","lastBillDueDate":"2025-04-01","lastBillId":"012345678901","lastPaymentAmount":999.99,"lastPaymentDate":"2025-04-01","nextScheduledBillDate":"2025-12-27","nextScheduledReadEnd":"2025-12-20","nextScheduledReadStart":"2025-12-15","pastDueAmount":123.57,"payoffBalance":34.44,"previousBillAmount":99.99,"previousBillDate":"2025-04-01","previousBillId":"012345678901","maximumPayment":30000}}}}}},"404":{"$ref":"#/components/responses/Error404"},"502":{"$ref":"#/components/responses/Error502"}},"summary":"get-financial-information","operationId":"get-financial-information","description":"Retrieves the financial information associated with an account.","tags":["Financial Information"],"parameters":[{"name":"accountId","in":"path","description":"an account identifier in the form of a ten digit string","required":true,"example":"0123456789","schema":{"$ref":"#/components/schemas/AccountNumber"}}]}},"/accounts/{accountId}/highBillEligibility":{"post":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/HighBillEligibility"}}},"example":{"data":{"isAccountEligible":true,"accountNumber":"0123456789","premiseId":"0123456789","confirmationNumber":"0123456789","ineligibleReasons":null,"questions":[{"id":"101","text":"Have you heard any of your toilets hissing or trickling for extended periods of time?"},{"id":"102","text":"Have you filled/topped off your pool recently or used a pressure cleaner?"},{"id":"103","text":"Did you have house guests, water your lawn more than usual, or do anything else out of the ordinary over the past few months?"},{"id":"104","text":"Have you identified any broken pipes/plumbing or any leaky faucets, spigots, or irrigation lines?"}]}}}}},"404":{"$ref":"#/components/responses/Error404"},"502":{"$ref":"#/components/responses/Error502"}},"summary":"post-high-bill-eligibility","operationId":"post-high-bill-eligibility","description":"Checks if the account is eligible for a High Bill Investigation. The results of this service are used by the highBill service.","tags":["High Bill"],"parameters":[{"name":"accountId","in":"path","description":"an account identifier in the form of a ten digit string","required":true,"example":"0123456789","schema":{"$ref":"#/components/schemas/AccountNumber"}}],"requestBody":{"content":{"application/json":{"example":{"premiseId":"0123456789"},"schema":{"type":"object","properties":{"premiseId":{"$ref":"#/components/schemas/PremiseId"}},"required":["premiseId"]}}}}}},"/accounts/{accountId}/highBill":{"post":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"description":"data returned by the operation","type":"object","properties":{"isProcessed":{"description":"whether or not the high bill request was processed","type":"boolean"},"accountNumber":{"$ref":"#/components/schemas/AccountNumber"},"premiseId":{"$ref":"#/components/schemas/PremiseId"},"confirmationNumber":{"$ref":"#/components/schemas/ConfirmationNumber"},"messages":{"$ref":"#/components/schemas/Messages"}},"required":["isProcessed","accountNumber","premiseId","confirmationNumber","messages"]}},"required":["data"],"example":{"data":{"isProcessed":true,"accountNumber":"0123456789","premiseId":"0123456789","confirmationNumber":"0123456789","messages":["abcdefghijklmnopqrstuwxyz...","abcdefghijklmnopqrstuwxyz...","abcdefghijklmnopqrstuwxyz..."]}}},"example":{"data":{"isProcessed":true,"accountNumber":"0123456789","premiseId":"0123456789","confirmationNumber":"0123456789","messages":["abcdefghijklmnopqrstuwxyz...","abcdefghijklmnopqrstuwxyz...","abcdefghijklmnopqrstuwxyz..."]}}}}},"404":{"$ref":"#/components/responses/Error404"},"502":{"$ref":"#/components/responses/Error502"}},"summary":"post-high-bill-process","operationId":"post-high-bill-process","description":"Processes a High Bill Investigation service request. Uses the results from the highBillElibility service.","tags":["High Bill"],"parameters":[{"name":"accountId","in":"path","description":"an account identifier in the form of a ten digit string","required":true,"example":"0123456789","schema":{"$ref":"#/components/schemas/AccountNumber"}}],"requestBody":{"content":{"application/json":{"example":{"premiseId":"0123456789","confirmationNumber":"0123456789","questions":[{"id":"101","response":true},{"id":"102","response":true},{"id":"103","response":true},{"id":"104","response":true}]},"schema":{"type":"object","properties":{"premiseId":{"$ref":"#/components/schemas/PremiseId"},"confirmationNumber":{"$ref":"#/components/schemas/ConfirmationNumber"},"questions":{"$ref":"#/components/schemas/EligibilityQuestions"}},"required":["premiseId","confirmationNumber","questions"]}}}}}},"/accounts/{accountId}/histogram":{"get":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"description":"data returned by the operation","type":"object","properties":{"accountNumber":{"$ref":"#/components/schemas/AccountNumber"},"histogram":{"$ref":"#/components/schemas/WaterAndSewerUsage"}},"required":["accountNumber","histogram"]}},"required":["data"]},"example":{"data":{"accountNumber":"0123456789","histogram":{"sewer":[{"amount":266.08,"billDate":"2025-01-26","billedUsage":44,"billedUsageGal":32912,"dateFrom":"2025-12-18","dateTo":"2025-01-20","rank":22,"serviceType":"WW","uom":"CCF","uomGal":"Gals"},{"amount":226.4,"billDate":"2025-02-24","billedUsage":37,"billedUsageGal":27676,"dateFrom":"2025-01-20","dateTo":"2025-02-17","rank":21,"serviceType":"WW","uom":"CCF","uomGal":"Gals"},{"amount":249.07,"billDate":"2025-03-24","billedUsage":41,"billedUsageGal":30668,"dateFrom":"2025-02-17","dateTo":"2025-03-18","rank":20,"serviceType":"WW","uom":"CCF","uomGal":"Gals"},{"amount":226.4,"billDate":"2025-04-22","billedUsage":37,"billedUsageGal":27676,"dateFrom":"2025-03-18","dateTo":"2025-04-14","rank":19,"serviceType":"WW","uom":"CCF","uomGal":"Gals"},{"amount":232.07,"billDate":"2025-05-23","billedUsage":38,"billedUsageGal":28424,"dateFrom":"2025-04-14","dateTo":"2025-05-12","rank":18,"serviceType":"WW","uom":"CCF","uomGal":"Gals"},{"amount":322.77,"billDate":"2025-06-23","billedUsage":54,"billedUsageGal":40392,"dateFrom":"2025-05-12","dateTo":"2025-06-17","rank":17,"serviceType":"WW","uom":"CCF","uomGal":"Gals"},{"amount":311.44,"billDate":"2025-07-25","billedUsage":52,"billedUsageGal":38896,"dateFrom":"2025-06-17","dateTo":"2025-07-20","rank":16,"serviceType":"WW","uom":"CCF","uomGal":"Gals"},{"amount":317.1,"billDate":"2025-08-23","billedUsage":53,"billedUsageGal":39644,"dateFrom":"2025-07-20","dateTo":"2025-08-17","rank":15,"serviceType":"WW","uom":"CCF","uomGal":"Gals"},{"amount":339.78,"billDate":"2025-09-23","billedUsage":57,"billedUsageGal":42636,"dateFrom":"2025-08-17","dateTo":"2025-09-19","rank":14,"serviceType":"WW","uom":"CCF","uomGal":"Gals"},{"amount":483.7,"billDate":"2025-10-25","billedUsage":78,"billedUsageGal":58344,"dateFrom":"2025-09-19","dateTo":"2025-10-20","rank":13,"serviceType":"WW","uom":"CCF","uomGal":"Gals"},{"amount":405.19,"billDate":"2025-11-23","billedUsage":63,"billedUsageGal":47124,"dateFrom":"2025-10-20","dateTo":"2025-11-17","rank":12,"serviceType":"WW","uom":"CCF","uomGal":"Gals"},{"amount":399.04,"billDate":"2025-12-23","billedUsage":62,"billedUsageGal":46376,"dateFrom":"2025-11-17","dateTo":"2025-12-21","rank":11,"serviceType":"WW","uom":"CCF","uomGal":"Gals"},{"amount":552.68,"billDate":"2025-01-25","billedUsage":87,"billedUsageGal":65076,"dateFrom":"2025-12-21","dateTo":"2025-01-20","rank":10,"serviceType":"WW","uom":"CCF","uomGal":"Gals"},{"amount":460.5,"billDate":"2025-02-22","billedUsage":72,"billedUsageGal":53856,"dateFrom":"2025-01-20","dateTo":"2025-02-16","rank":9,"serviceType":"WW","uom":"CCF","uomGal":"Gals"},{"amount":651.01,"billDate":"2025-03-24","billedUsage":103,"billedUsageGal":77044,"dateFrom":"2025-02-16","dateTo":"2025-03-16","rank":8,"serviceType":"WW","uom":"CCF","uomGal":"Gals"},{"amount":417.48,"billDate":"2025-04-25","billedUsage":65,"billedUsageGal":48620,"dateFrom":"2025-03-16","dateTo":"2025-04-18","rank":7,"serviceType":"WW","uom":"CCF","uomGal":"Gals"},{"amount":306.86,"billDate":"2025-05-24","billedUsage":47,"billedUsageGal":35156,"dateFrom":"2025-04-18","dateTo":"2025-05-18","rank":6,"serviceType":"WW","uom":"CCF","uomGal":"Gals"},{"amount":239.26,"billDate":"2025-06-23","billedUsage":36,"billedUsageGal":26928,"dateFrom":"2025-05-18","dateTo":"2025-06-16","rank":5,"serviceType":"WW","uom":"CCF","uomGal":"Gals"},{"amount":263.84,"billDate":"2025-07-25","billedUsage":40,"billedUsageGal":29920,"dateFrom":"2025-06-16","dateTo":"2025-07-19","rank":4,"serviceType":"WW","uom":"CCF","uomGal":"Gals"},{"amount":269.99,"billDate":"2025-08-24","billedUsage":41,"billedUsageGal":30668,"dateFrom":"2025-07-19","dateTo":"2025-08-16","rank":3,"serviceType":"WW","uom":"CCF","uomGal":"Gals"},{"amount":294.57,"billDate":"2025-09-25","billedUsage":45,"billedUsageGal":33660,"dateFrom":"2025-08-16","dateTo":"2025-09-21","rank":2,"serviceType":"WW","uom":"CCF","uomGal":"Gals"},{"amount":217.66,"billDate":"2025-10-24","billedUsage":32,"billedUsageGal":23936,"dateFrom":"2025-09-21","dateTo":"2025-10-17","rank":1,"serviceType":"WW","uom":"CCF","uomGal":"Gals"}],"water":[{"amount":64.31,"billDate":"2025-01-26","billedUsage":44,"billedUsageGal":32912,"dateFrom":"2025-12-18","dateTo":"2025-01-20","rank":22,"serviceType":"W","uom":"CCF","uomGal":"Gals"},{"amount":51.17,"billDate":"2025-02-24","billedUsage":37,"billedUsageGal":27676,"dateFrom":"2025-01-20","dateTo":"2025-02-17","rank":21,"serviceType":"W","uom":"CCF","uomGal":"Gals"},{"amount":55.3,"billDate":"2025-03-24","billedUsage":41,"billedUsageGal":30668,"dateFrom":"2025-02-17","dateTo":"2025-03-18","rank":20,"serviceType":"W","uom":"CCF","uomGal":"Gals"},{"amount":51.17,"billDate":"2025-04-22","billedUsage":37,"billedUsageGal":27676,"dateFrom":"2025-03-18","dateTo":"2025-04-14","rank":19,"serviceType":"W","uom":"CCF","uomGal":"Gals"},{"amount":51.54,"billDate":"2025-05-23","billedUsage":38,"billedUsageGal":28424,"dateFrom":"2025-04-14","dateTo":"2025-05-12","rank":18,"serviceType":"W","uom":"CCF","uomGal":"Gals"},{"amount":94.37,"billDate":"2025-06-23","billedUsage":54,"billedUsageGal":40392,"dateFrom":"2025-05-12","dateTo":"2025-06-17","rank":17,"serviceType":"W","uom":"CCF","uomGal":"Gals"},{"amount":88.36,"billDate":"2025-07-25","billedUsage":52,"billedUsageGal":38896,"dateFrom":"2025-06-17","dateTo":"2025-07-20","rank":16,"serviceType":"W","uom":"CCF","uomGal":"Gals"},{"amount":91.36,"billDate":"2025-08-23","billedUsage":53,"billedUsageGal":39644,"dateFrom":"2025-07-20","dateTo":"2025-08-17","rank":15,"serviceType":"W","uom":"CCF","uomGal":"Gals"},{"amount":103.39,"billDate":"2025-09-23","billedUsage":57,"billedUsageGal":42636,"dateFrom":"2025-08-17","dateTo":"2025-09-19","rank":14,"serviceType":"W","uom":"CCF","uomGal":"Gals"},{"amount":180,"billDate":"2025-10-25","billedUsage":78,"billedUsageGal":58344,"dateFrom":"2025-09-19","dateTo":"2025-10-20","rank":13,"serviceType":"W","uom":"CCF","uomGal":"Gals"},{"amount":132.34,"billDate":"2025-11-23","billedUsage":63,"billedUsageGal":47124,"dateFrom":"2025-10-20","dateTo":"2025-11-17","rank":12,"serviceType":"W","uom":"CCF","uomGal":"Gals"},{"amount":128.99,"billDate":"2025-12-23","billedUsage":62,"billedUsageGal":46376,"dateFrom":"2025-11-17","dateTo":"2025-12-21","rank":11,"serviceType":"W","uom":"CCF","uomGal":"Gals"},{"amount":220.31,"billDate":"2025-01-25","billedUsage":87,"billedUsageGal":65076,"dateFrom":"2025-12-21","dateTo":"2025-01-20","rank":10,"serviceType":"W","uom":"CCF","uomGal":"Gals"},{"amount":162.46,"billDate":"2025-02-22","billedUsage":72,"billedUsageGal":53856,"dateFrom":"2025-01-20","dateTo":"2025-02-16","rank":9,"serviceType":"W","uom":"CCF","uomGal":"Gals"},{"amount":282.02,"billDate":"2025-03-24","billedUsage":103,"billedUsageGal":77044,"dateFrom":"2025-02-16","dateTo":"2025-03-16","rank":8,"serviceType":"W","uom":"CCF","uomGal":"Gals"},{"amount":139.03,"billDate":"2025-04-25","billedUsage":65,"billedUsageGal":48620,"dateFrom":"2025-03-16","dateTo":"2025-04-18","rank":7,"serviceType":"W","uom":"CCF","uomGal":"Gals"},{"amount":78.79,"billDate":"2025-05-24","billedUsage":47,"billedUsageGal":35156,"dateFrom":"2025-04-18","dateTo":"2025-05-18","rank":6,"serviceType":"W","uom":"CCF","uomGal":"Gals"},{"amount":53.86,"billDate":"2025-06-23","billedUsage":36,"billedUsageGal":26928,"dateFrom":"2025-05-18","dateTo":"2025-06-16","rank":5,"serviceType":"W","uom":"CCF","uomGal":"Gals"},{"amount":55.36,"billDate":"2025-07-25","billedUsage":40,"billedUsageGal":29920,"dateFrom":"2025-06-16","dateTo":"2025-07-19","rank":4,"serviceType":"W","uom":"CCF","uomGal":"Gals"},{"amount":58.71,"billDate":"2025-08-24","billedUsage":41,"billedUsageGal":30668,"dateFrom":"2025-07-19","dateTo":"2025-08-16","rank":3,"serviceType":"W","uom":"CCF","uomGal":"Gals"},{"amount":72.09,"billDate":"2025-09-25","billedUsage":45,"billedUsageGal":33660,"dateFrom":"2025-08-16","dateTo":"2025-09-21","rank":2,"serviceType":"W","uom":"CCF","uomGal":"Gals"},{"amount":52.36,"billDate":"2025-10-24","billedUsage":32,"billedUsageGal":23936,"dateFrom":"2025-09-21","dateTo":"2025-10-17","rank":1,"serviceType":"W","uom":"CCF","uomGal":"Gals"}]}}}}}},"404":{"$ref":"#/components/responses/Error404"},"502":{"$ref":"#/components/responses/Error502"}},"summary":"get-histogram","operationId":"get-histogram","description":"Retrieves the histogram data for water and sewer usage for an account.","tags":["Histogram"],"parameters":[{"name":"accountId","in":"path","description":"an account identifier in the form of a ten digit string","required":true,"example":"0123456789","schema":{"$ref":"#/components/schemas/AccountNumber"}}]}},"/accounts/{accountId}/mailingAddress":{"post":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"accountNumber":{"$ref":"#/components/schemas/AccountNumber"},"data":{"description":"data returned by the operation","type":"object","properties":{"billingAddress":{"$ref":"#/components/schemas/BillingAddress"}},"required":["billingAddress"]}},"required":["data","accountNumber"]},"example":{"accountNumber":"0123456789","data":{"billingAddress":{"address1":"Information Technology Division","address2":"5680 SW 87 Avenue","address3":"3W37","city":"MIAMI","state":"FL","zip":"33173","country":"USA","county":"Miami-Dade","samAsPremise":false}}}}}},"404":{"$ref":"#/components/responses/Error404"},"502":{"$ref":"#/components/responses/Error502"}},"summary":"post-mailing-address","operationId":"post-mailing-address","description":"Updates the mailing address associated with an account.","tags":["Mailing Address"],"parameters":[{"name":"accountId","in":"path","description":"an account identifier in the form of a ten digit string","required":true,"example":"0123456789","schema":{"$ref":"#/components/schemas/AccountNumber"}}],"requestBody":{"content":{"application/json":{"example":{"address1":"5680 SW 87th Ave","address2":"3rd floor","city":"Miami","county":"Miami-Dade","state":"FL","zip":"33173","country":"USA","sameAsPremise":false},"schema":{"$ref":"#/components/schemas/BillingAddress"}}}}}},"/accounts/{accountId}/notifications":{"get":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Notifications"},"example":{"data":{"accountNumber":"0123456789","alerts":[{"description":"You may pay by only Cash, Money Order or Cashier's Check.","fieldActivities":null,"priority":1,"sourceId":"0003638082","sourceIdType":"COLL_PROC_ID","type":"cashOnly"},{"description":"Your Service(s) are scheduled to be disconnected for non payment on dates.","fieldActivities":null,"priority":2,"sourceId":"2561331566","sourceIdType":"SEV_PROC_ID","type":"Severance"}],"serviceActivities":[{"type":"HighBillFA","description":"Initiated work on Underground Leak complaint from customer.","fieldActivities":[{"id":"4032692559","typeCode":"UGL HIST","scheduledDateTime":"2025-05-04"},{"id":"4032653632","typeCode":"UGL PROJ","scheduledDateTime":"2025-05-04"}]},{"type":"CertMeterTest","description":"Certified Meter test initiated.","fieldActivities":[{"id":"4032352459","typeCode":"CT FM","scheduledDateTime":"2025-05-04"}]}],"messages":[{"criteria":"customerClass","criteriaValue":"R","code":"DISC","description":"The Miami Dade Water and Sewer Department does not offer discounts on water.  Customers receiving unsolicited calls should never provide any personal information, including your account number.","priority":1},{"criteria":"customerClass","criteriaValue":"R","code":"POOL","description":"Is your pool safe? Miami-Dade County encourages you to have your pool lights inspected by a licensed electrician and take additional steps to avoid serious injuries.  Visit http://www.miamidade.gov/permits/swimming-pool-light.asp to learn more.","priority":2},{"criteria":"customerClass","criteriaValue":"R","code":"REPAIR","description":"Water main repairs will be performed from 01-05-2015 to 08-05-2015. It is advised to boil drinking water during this time.","priority":3}]}}}}},"404":{"$ref":"#/components/responses/Error404"},"502":{"$ref":"#/components/responses/Error502"}},"summary":"get-notifications","operationId":"get-notifications","description":"Retrieves all notifications (alerts, serviceActivities, messages) associated with an account.","tags":["Notifications"],"parameters":[{"name":"accountId","in":"path","description":"an account identifier in the form of a ten digit string","required":true,"example":"0123456789","schema":{"$ref":"#/components/schemas/AccountNumber"}}]}},"/accounts/{accountId}/payments":{"get":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"accountNumber":{"$ref":"#/components/schemas/AccountNumber"},"fromPayDate":{"description":"the start date for this payment list","type":"string","format":"date"},"toPayDate":{"description":"the end date for this payment list","type":"string","format":"date"},"payments":{"$ref":"#/components/schemas/Payments"}}}}},"example":{"data":{"accountNumber":"0123456789","fromPayDate":"2014-04-06","toPayDate":"2015-04-06","payments":[{"id":"0123456789","confirmationNumber":"0123456789","amount":179.3,"status":"Completed","type":"CA","typeDesc":"Cash","payDate":"2014-09-26","cancelCode":null,"cancelDesc":null},{"confirmationNumber":"0123456789","amount":1,"status":"Pending","type":"CD","typeDesc":"Credit Card","payDate":"2021-09-01","cancelCode":null,"cancelDesc":null},{"confirmationNumber":"0123456789","amount":2,"status":"Pending","type":"CM","typeDesc":"Credit Card","payDate":"2021-09-01","cancelCode":null,"cancelDesc":null},{"confirmationNumber":"0123456789","amount":3,"status":"Pending","type":"NC","typeDesc":"Credit Card","payDate":"2021-09-01","cancelCode":null,"cancelDesc":null},{"confirmationNumber":"0123456789","amount":4,"status":"Pending","type":"NP","typeDesc":"Credit Card","payDate":"2021-09-01","cancelCode":null,"cancelDesc":null},{"confirmationNumber":"0123456789","amount":5,"status":"Pending","type":"NW","typeDesc":"Credit Card","payDate":"2021-09-01","cancelCode":null,"cancelDesc":null},{"confirmationNumber":"0123456789","amount":6,"status":"Completed","type":"CA","typeDesc":"Cash","payDate":"2021-09-01","cancelCode":null,"cancelDesc":null},{"confirmationNumber":"0123456789","amount":7,"status":"Completed","type":"CC","typeDesc":"Cash","payDate":"2021-09-01","cancelCode":null,"cancelDesc":null},{"confirmationNumber":"0123456789","amount":8,"status":"Completed","type":"FC","typeDesc":"Cash","payDate":"2021-09-01","cancelCode":null,"cancelDesc":null},{"confirmationNumber":"0123456789","amount":9,"status":"Completed","type":"MO","typeDesc":"Cash","payDate":"2021-09-01","cancelCode":null,"cancelDesc":null},{"confirmationNumber":"0123456789","amount":10,"status":"Completed","type":"TC","typeDesc":"Cash","payDate":"2021-09-01","cancelCode":null,"cancelDesc":null},{"confirmationNumber":"0123456789","amount":11,"status":"Completed","type":"CK","typeDesc":"Check","payDate":"2021-09-01","cancelCode":null,"cancelDesc":null},{"confirmationNumber":"0123456789","amount":12,"status":"Completed","type":"DA","typeDesc":"Check","payDate":"2021-09-01","cancelCode":null,"cancelDesc":null},{"confirmationNumber":"0123456789","amount":13,"status":"Completed","type":"FK","typeDesc":"Check","payDate":"2021-09-01","cancelCode":null,"cancelDesc":null},{"confirmationNumber":"0123456789","amount":14,"status":"Completed","type":"OC","typeDesc":"Check","payDate":"2021-09-01","cancelCode":null,"cancelDesc":null},{"confirmationNumber":"0123456789","amount":15,"status":"Pending","type":"DD","typeDesc":"Bank Debit","payDate":"2021-09-01","cancelCode":null,"cancelDesc":null},{"confirmationNumber":"0123456789","amount":16,"status":"Pending","type":"EM","typeDesc":"Bank Debit","payDate":"2021-09-01","cancelCode":null,"cancelDesc":null},{"confirmationNumber":"0123456789","amount":17,"status":"Pending","type":"EP","typeDesc":"Bank Debit","payDate":"2021-09-01","cancelCode":null,"cancelDesc":null},{"confirmationNumber":"0123456789","amount":18,"status":"Pending","type":"ET","typeDesc":"Bank Debit","payDate":"2021-09-01","cancelCode":null,"cancelDesc":null},{"confirmationNumber":"0123456789","amount":19,"status":"Pending","type":"FU","typeDesc":"Bank Debit","payDate":"2021-09-01","cancelCode":null,"cancelDesc":null},{"confirmationNumber":"0123456789","amount":20,"status":"Pending","type":"HB","typeDesc":"Bank Debit","payDate":"2021-09-01","cancelCode":null,"cancelDesc":null},{"confirmationNumber":"0123456789","amount":21,"status":"Pending","type":"IP","typeDesc":"Bank Debit","payDate":"2021-09-01","cancelCode":null,"cancelDesc":null},{"confirmationNumber":"0123456789","amount":22,"status":"Pending","type":"IV","typeDesc":"Bank Debit","payDate":"2021-09-01","cancelCode":null,"cancelDesc":null},{"confirmationNumber":"0123456789","amount":23,"status":"Pending","type":"MB","typeDesc":"Bank Debit","payDate":"2021-09-01","cancelCode":null,"cancelDesc":null},{"confirmationNumber":"0123456789","amount":24,"status":"Pending","type":"SR","typeDesc":"Bank Debit","payDate":"2021-09-01","cancelCode":null,"cancelDesc":null},{"confirmationNumber":"0123456789","amount":25,"status":"Pending","type":"WB","typeDesc":"Bank Debit","payDate":"2021-09-01","cancelCode":null,"cancelDesc":null},{"confirmationNumber":"0123456789","amount":26,"status":"Completed","type":"C1","typeDesc":"Other","payDate":"2021-09-01","cancelCode":null,"cancelDesc":null},{"confirmationNumber":"0123456789","amount":27,"status":"Completed","type":"CF","typeDesc":"Other","payDate":"2021-09-01","cancelCode":null,"cancelDesc":null},{"confirmationNumber":"0123456789","amount":28,"status":"Completed","type":"CH","typeDesc":"Other","payDate":"2021-09-01","cancelCode":null,"cancelDesc":null},{"confirmationNumber":"0123456789","amount":29,"status":"Completed","type":"CP","typeDesc":"Other","payDate":"2021-09-01","cancelCode":null,"cancelDesc":null},{"confirmationNumber":"0123456789","amount":30,"status":"Completed","type":"L","typeDesc":"Other","payDate":"2021-09-01","cancelCode":null,"cancelDesc":null},{"confirmationNumber":"0123456789","amount":31,"status":"Completed","type":"MX","typeDesc":"Other","payDate":"2021-09-01","cancelCode":null,"cancelDesc":null},{"confirmationNumber":"0123456789","amount":32,"status":"Completed","type":"OVUN","typeDesc":"Other","payDate":"2021-09-01","cancelCode":null,"cancelDesc":null},{"confirmationNumber":"0123456789","amount":33,"status":"Completed","type":"PK","typeDesc":"Other","payDate":"2021-09-01","cancelCode":null,"cancelDesc":null},{"confirmationNumber":"0123456789","amount":34,"status":"Completed","type":"S8","typeDesc":"Other","payDate":"2021-09-01","cancelCode":null,"cancelDesc":null},{"confirmationNumber":"0123456789","amount":35,"status":"Completed","type":"SD","typeDesc":"Other","payDate":"2021-09-01","cancelCode":null,"cancelDesc":null},{"confirmationNumber":"0123456789","amount":36,"status":"Completed","type":"SA","typeDesc":"SSA Customer - ACH","payDate":"2021-09-01","cancelCode":null,"cancelDesc":null},{"confirmationNumber":"0123456789","amount":37,"status":"Completed","type":"SC","typeDesc":"SSA Customer - Credit Card","payDate":"2021-09-01","cancelCode":null,"cancelDesc":null},{"confirmationNumber":"0123456789","amount":38,"status":"Completed","type":"CW","typeDesc":"Chatbox - Credit Card","payDate":"2021-09-01","cancelCode":null,"cancelDesc":null},{"confirmationNumber":"0123456789","amount":39,"status":"Completed","type":"AW","typeDesc":"Chatbox - ACH","payDate":"2021-09-01","cancelCode":null,"cancelDesc":null},{"confirmationNumber":"0123456789","amount":40,"status":"Completed","type":"MS","typeDesc":"Multiple Stubs","payDate":"2021-09-01","cancelCode":null,"cancelDesc":null},{"confirmationNumber":"0123456789","amount":41,"status":"Completed","type":"AD","typeDesc":"Enrollment- Autodebits","payDate":"2021-09-01","cancelCode":null,"cancelDesc":null},{"confirmationNumber":"0123456789","amount":42,"status":"Completed","type":"GL","typeDesc":"Retail Payments to G/L","payDate":"2021-09-01","cancelCode":null,"cancelDesc":null}]}}}}},"404":{"$ref":"#/components/responses/Error404"},"502":{"$ref":"#/components/responses/Error502"}},"summary":"get-payments","operationId":"get-payments","description":"Retrieves the payments, including pending payments, for an account.","tags":["Payments"],"parameters":[{"name":"accountId","in":"path","description":"an account identifier in the form of a ten digit string","required":true,"example":"0123456789","schema":{"$ref":"#/components/schemas/AccountNumber"}}]}},"/accounts/{accountId}/paymentExtensionEligibility":{"post":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"description":"data returned by the operation","type":"object","properties":{"accountNumber":{"$ref":"#/components/schemas/AccountNumber"},"paymentExtensionDetails":{"$ref":"#/components/schemas/PaymentExtensionEligibilityDetails"}},"required":["accountNumber","paymentExtensionDetails"]}},"required":["data"]},"example":{"data":{"accountNumber":"0123456789","paymentExtensionDetails":{"isPreviousBalance":true,"isAccountEligible":true,"isPartialPaymentRequired":true,"messages":["abcdefghijklmnopqrstuwxyz...","abcdefghijklmnopqrstuwxyz...","abcdefghijklmnopqrstuwxyz..."],"requiredPaymentAmount":100,"extensionDate":"2025-01-18","displayExtensionDate":"2025-01-18","confirmationNumber":"0123456789"}}}}}},"404":{"$ref":"#/components/responses/Error404"},"502":{"$ref":"#/components/responses/Error502"}},"summary":"post-payment-extension-eligibility","operationId":"post-payment-extension-eligibility","description":"Checks if the account is eligible for a payment extension.","tags":["Payment Extension"],"parameters":[{"name":"accountId","in":"path","description":"an account identifier in the form of a ten digit string","required":true,"example":"0123456789","schema":{"$ref":"#/components/schemas/AccountNumber"}}],"requestBody":{"content":{"application/json":{"example":{"premiseId":"0123456789"},"schema":{"type":"object","properties":{"premiseId":{"$ref":"#/components/schemas/PremiseId"}},"required":["premiseId"]}}}}}},"/accounts/{accountId}/paymentExtension":{"post":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"description":"data returned by the operation","type":"object","properties":{"accountNumber":{"$ref":"#/components/schemas/AccountNumber"},"paymentExtensionDetails":{"$ref":"#/components/schemas/PaymentExtensionDetails"}},"required":["accountNumber","paymentExtensionDetails"]}},"required":["data"]},"example":{"data":{"accountNumber":"0123456789","paymentExtensionDetails":{"isExtensionGranted":true,"messages":["Your extension has been granted until 2025-01-18.","abcdefghijklmnopqrstuwxyz..."],"confirmationNumber":"0123456789","displayExtensionDate":"2025-01-18","extensionDate":"2025-01-18"}}}}}},"404":{"$ref":"#/components/responses/Error404"},"502":{"$ref":"#/components/responses/Error502"}},"summary":"post-payment-extension-process","operationId":"post-payment-extension-process","description":"Updates a payment extension request for an account.","tags":["Payment Extension"],"parameters":[{"name":"accountId","in":"path","description":"an account identifier in the form of a ten digit string","required":true,"example":"0123456789","schema":{"$ref":"#/components/schemas/AccountNumber"}}],"requestBody":{"content":{"application/json":{"example":{"confirmationNumber":"0123456789"},"schema":{"type":"object","properties":{"confirmationNumber":{"$ref":"#/components/schemas/ConfirmationNumber"}},"required":["confirmationNumber"]}}}}}},"/accounts/{accountId}/personOnAccount":{"get":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PersonOnAccount"}},"required":["data"],"example":{"data":{"accountNumber":"0123456789","personOrBusiness":"B","accountStatus":"ACTIVE","business":{"id":"3735357424","entityName":"KEY COLONY #4 CONDO ASSOC","email":"mail@miamidade.gov"}}}},"example":{"data":{"accountNumber":"0123456789","personOrBusiness":"P","accountStatus":"ACTIVE","person":{"id":"3735357424","firstName":"ARCADIO","lastName":"BENITO"}}}}}},"404":{"$ref":"#/components/responses/Error404"},"502":{"$ref":"#/components/responses/Error502"}},"summary":"get-person-on-account","operationId":"get-person-on-account","description":"Retrieves the person or business entity associated with an account.","tags":["Person On Account"],"parameters":[{"name":"accountId","in":"path","description":"an account identifier in the form of a ten digit string","required":true,"example":"0123456789","schema":{"$ref":"#/components/schemas/AccountNumber"}}]}},"/validateAccount/{webUserId}/accounts/{accountId}&registrationEmail={registrationEmail}":{"get":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ValidateAccount"}}},"example":{"data":{"webUserId":"12345678","person":{"id":"1754541787","firstName":"CARLOS","lastName":"RODRIGUEZ","email":"mail@miamidade.gov","identifications":[{"type":"SSN","description":"Last 4 digits of Social Security Number","format":"NNNN"},{"type":"DL","description":"Drvers License","format":""},{"type":"FTN","description":"F.T.N.","format":""},{"type":"PASSPORT","description":"Passport Number","format":""}]}}}}}},"404":{"$ref":"#/components/responses/Error404"},"502":{"$ref":"#/components/responses/Error502"}},"summary":"get-validate-account","operationId":"get-validate-account","description":"Validate account by web user Id, zip, and registration email.","tags":["Person On Account"],"parameters":[{"name":"webUserId","in":"path","description":"a web user identifier in the form of an eight digit string","required":true,"example":"12345678","schema":{"$ref":"#/components/schemas/WebUserId"}},{"name":"accountId","in":"path","description":"an account identifier in the form of a ten digit string","required":true,"example":"0123456789","schema":{"$ref":"#/components/schemas/AccountNumber"}},{"name":"zip","in":"query","description":"ZIP in the form of an 5 digit string","required":true,"example":"33031","schema":{"$ref":"#/components/schemas/ZipCode"}},{"name":"registrationEmail","in":"path","description":"Registration Email in the form of a string","required":true,"example":"mail@miamidade.gov","schema":{"$ref":"#/components/schemas/RegistrationEmail"}}]}},"/validatePerson/{webUserId}/{personId}/accounts/{accountId}&SSN={SSN}&DL={DL}&passport={passport}&registrationEmail={registrationEmail}":{"get":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ValidatePerson"}},"required":["data"]},"example":{"data":{"accountNumber":"0123456789","hasInvalidData":"false","hasValidSSN":"true","homePhone":"3056657477","mobilePhone":"3056657477","personId":"7637372277"}}}}},"404":{"$ref":"#/components/responses/Error404"},"502":{"$ref":"#/components/responses/Error502"}},"summary":"get-validate-person-on-account","operationId":"get-validate-person-on-account","description":"Validates that a person's DOB, SSN, DL, or Passport is associated with an account.","tags":["Person On Account"],"parameters":[{"name":"webUserId","in":"path","description":"a web user identifier in the form of an eight digit string","required":true,"example":"12345678","schema":{"$ref":"#/components/schemas/WebUserId"}},{"name":"personId","in":"path","description":"a person identifier in the form of a ten digit string","required":true,"example":"0123456789","schema":{"$ref":"#/components/schemas/PersonId"}},{"name":"accountId","in":"path","description":"an account identifier in the form of a ten digit string","required":true,"example":"0123456789","schema":{"$ref":"#/components/schemas/AccountNumber"}},{"name":"DOB","in":"query","description":"Date Of Birth in the form of an ISO Date string","required":true,"example":"2025-01-01","schema":{"type":"string"}},{"name":"SSN","in":"path","description":"Social Security Number in the form of a string","required":true,"example":"000-00-0000","schema":{"type":"string"}},{"name":"DL","in":"path","description":"Driver's License Number in the form of a string","required":true,"example":"FL0123456789","schema":{"type":"string"}},{"name":"passport","in":"path","description":"Passport Number in the form of an N digit string","required":true,"example":"311958555","schema":{"type":"string"}},{"name":"registrationEmail","in":"path","description":"Registration Email in the form of a string","required":true,"example":"mail@miamidade.gov","schema":{"$ref":"#/components/schemas/RegistrationEmail"}}]}},"/validateBusiness/{personId}/accounts/{accountId}&registrationEmail={registrationEmail}":{"get":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ValidateBusiness"}},"required":["data"]},"example":{"data":{"accountNumber":"0123456789","businessPhone":"3056657477","extension":"101","hasInvalidData":"false","hasValidFTN":true,"mobilePhone":"3056657477","personId":"7637372277"}}}}},"404":{"$ref":"#/components/responses/Error404"},"502":{"$ref":"#/components/responses/Error502"}},"summary":"get-validate-business-on-account","operationId":"get-validate-business-on-account","description":"Validates that a business' FTN is associated with an account.","tags":["Person On Account"],"parameters":[{"name":"personId","in":"path","description":"a person identifier in the form of an ten digit string","required":true,"example":"0123456789","schema":{"$ref":"#/components/schemas/PersonId"}},{"name":"accountId","in":"path","description":"an account identifier in the form of a ten digit string","required":true,"example":"0123456789","schema":{"$ref":"#/components/schemas/AccountNumber"}},{"name":"FTN","in":"query","description":"an Federal Tax Number in the pattern \"NN-NNNNNN\" where N is a digit","required":true,"example":"99-999999","schema":{"$ref":"#/components/schemas/FederalTaxNumber"}},{"name":"registrationEmail","in":"path","description":"Registration Email in the form of a string","required":true,"example":"mail@miamidade.gov","schema":{"$ref":"#/components/schemas/RegistrationEmail"}}]}},"/accounts/{accountId}/poolCreditEligibility":{"post":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PoolCreditEligibility"}},"required":["data"]},"example":[{"data":{"ccsHasPoolInfo":true,"isAccountEligible":false,"accountNumber":"0123456789","confirmationNumber":"0123456789","ineligibleReasons":["Water Only billing on your account.","An existing sub-meter which already provides a sewer credit on the bill.","An existing Pool Sewer Credit within the calendar year."],"maxDate":"2025-04-19","minDate":"2025-04-18","poolType":"I","poolVolumeCCF":234,"poolVolumeGallons":12,"premiseId":"0123456789"}},{"data":{"ccsHasPoolInfo":true,"isAccountEligible":false,"accountNumber":"0123456789","confirmationNumber":"0123456789","ineligibleReasons":[],"maxDate":"2025-04-19","minDate":"2025-04-18","poolType":"I","poolVolumeCCF":234,"poolVolumeGallons":12,"premiseId":"0123456789"}}]}}},"404":{"$ref":"#/components/responses/Error404"},"502":{"$ref":"#/components/responses/Error502"}},"summary":"post-pool-credit-eligibility","operationId":"post-pool-credit-eligibility","description":"Checks if the account is eligible for a Pool Credit.","tags":["Pool Credit"],"parameters":[{"name":"accountId","in":"path","description":"an account identifier in the form of a ten digit string","required":true,"example":"0123456789","schema":{"$ref":"#/components/schemas/AccountNumber"}}],"requestBody":{"content":{"application/json":{"example":{"premiseId":"0123456789"},"schema":{"type":"object","properties":{"premiseId":{"$ref":"#/components/schemas/PremiseId"}},"required":["premiseId"]}}}}}},"/accounts/{accountId}/poolCredit":{"post":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PoolCreditConfirmation"}},"required":["data"],"example":{"data":{"accountNumber":"0123456789","premiseId":"0123456789","confirmationNumber":"0123456789","messages":["Pool Volume is insufficient. Minimum Volume required is 5 CCF.","abcdefghijklmnopqrstuwxyz..."]}}},"example":{"data":{"accountNumber":"0123456789","premiseId":"0123456789","confirmationNumber":"0123456789","messages":["Pool Volume is insufficient. Minimum Volume required is 5 CCF.","abcdefghijklmnopqrstuwxyz..."]}}}}},"404":{"$ref":"#/components/responses/Error404"},"502":{"$ref":"#/components/responses/Error502"}},"summary":"post-pool-credit-process","operationId":"post-pool-credit-process","description":"Processes a Pool Credit Service Request.","tags":["Pool Credit"],"parameters":[{"name":"accountId","in":"path","description":"an account identifier in the form of a ten digit string","required":true,"example":"0123456789","schema":{"$ref":"#/components/schemas/AccountNumber"}}],"requestBody":{"content":{"application/json":{"example":{"premiseId":"0123456789","fillDate":"2025-08-22","poolType":"I","poolWidth":123,"poolLength":23,"confirmationNumber":"0123456789"},"schema":{"$ref":"#/components/schemas/PoolCredit"}}}}}},"/accounts/{accountId}/premiseInfo":{"get":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PremiseInformation"}},"required":["data"]},"example":{"data":{"useServiceAddress":true,"hasCciSubmeters":false,"billFrequency":"M","accountNumber":"0123456789","billingAddress":{"address1":"111 NW 1st Street","address2":"#2510","city":"Miami","state":"FL","county":"Miami-Dade","country":"USA","zip":"33128"},"premise":{"id":"0123456789","premiseType":"RES","premiseTypeDesc":"Residential","address":{"address1":"111 NW 1st Street","address2":"#2510","city":"Miami","state":"FL","county":"Miami-Dade","country":"USA","zip":"33128"},"pool":{"onPropertyRecord":"+","size":99,"type":"I"},"location":{"latitude":25.775238,"longitude":-80.196685},"folio":"0123456789012","municipalityCode":"30","districtCode":"DIST 13"}}}}}},"404":{"$ref":"#/components/responses/Error404"},"502":{"$ref":"#/components/responses/Error502"}},"summary":"get-premise-information","operationId":"get-premise-information","description":"Retrieves the premise information associated with an account.","tags":["Premise Information"],"parameters":[{"name":"accountId","in":"path","description":"an account identifier in the form of a ten digit string","required":true,"example":"0123456789","schema":{"$ref":"#/components/schemas/AccountNumber"}}]}},"/accounts/{accountId}/reconnectEligibility":{"post":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"description":"data returned by the operation","type":"object","properties":{"accountNumber":{"$ref":"#/components/schemas/AccountNumber"},"reconnectDetails":{"$ref":"#/components/schemas/ReconnectEligibilityDetails"}},"required":["reconnectDetails","accountNumber"]}},"required":["data"]},"example":{"data":{"accountNumber":"0123456789","reconnectDetails":{"requiredPaymentAmount":null,"confirmationNumber":"0123456789","timeSlots":[{"description":"08:00AM - 12:00PM","value":"AM 08:00","available":false},{"description":"08:30AM - 12:30PM","value":"AM 08:30","available":false},{"description":"09:00AM - 01:00PM","value":"AM 09:00","available":false},{"description":"09:30AM - 01:30PM","value":"AM 09:30","available":true},{"description":"10:00AM - 02:00PM","value":"AM 10:00","available":true},{"description":"10:30AM - 02:30PM","value":"AM 10:30","available":true},{"description":"11:00AM - 03:00PM","value":"AM 11:00","available":true},{"description":"11:30AM - 03:30PM","value":"AM 11:30","available":true},{"description":"12:00PM - 04:00PM","value":"PM 12:00","available":true},{"description":"12:30PM - 04:30PM","value":"PM 12:30","available":true},{"description":"01:00PM - 05:00PM","value":"PM 01:00","available":true},{"description":"01:30PM - 05:30PM","value":"PM 01:30","available":true},{"description":"02:00PM - 06:00PM","value":"PM 02:00","available":true},{"description":"02:30PM - 06:30PM","value":"PM 02:30","available":true},{"description":"03:00PM - 07:00PM","value":"PM 03:00","available":true},{"description":"03:30PM - 07:30PM","value":"PM 03:30","available":true},{"description":"04:00PM - 08:00PM","value":"PM 04:00","available":true},{"description":"04:30PM - 08:30PM","value":"PM 04:30","available":true},{"description":"05:00PM - 09:00PM","value":"PM 05:00","available":true},{"description":"05:30PM - 09:30PM","value":"PM 05:30","available":true},{"description":"06:00PM - 10:00PM","value":"PM 06:00","available":true},{"description":"06:30PM - 10:30PM","value":"PM 06:30","available":true},{"description":"07:00PM - 11:00PM","value":"PM 07:00","available":true}],"availableDates":["2025-11-04","2025-11-07","2025-11-08","2025-11-09","2025-11-14","2025-11-15","2025-11-17","2025-11-21","2025-11-22","2025-11-25","2025-11-28","2025-11-29","2025-12-03","2025-12-05"],"isAccountEligible":true,"messages":["abcdefghijklmnopqrstuwxyz...","abcdefghijklmnopqrstuwxyz..."],"isNonSufficientFunds":true,"isPaymentRequired":false}}}}}},"404":{"$ref":"#/components/responses/Error404"},"502":{"$ref":"#/components/responses/Error502"}},"summary":"post-reconnect-eligibility","operationId":"post-reconnect-eligibility","description":"Requests the account eligibility for a service reconnect.","tags":["Reconnect"],"parameters":[{"name":"accountId","in":"path","description":"an account identifier in the form of a ten digit string","required":true,"example":"0123456789","schema":{"$ref":"#/components/schemas/AccountNumber"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"premiseId":{"$ref":"#/components/schemas/PremiseId"}},"required":["premiseId"]}}}}}},"/accounts/{accountId}/reconnect":{"post":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"description":"data returned by the operation","type":"object","oneOf":[{"type":"object","properties":{"accountNumber":{"$ref":"#/components/schemas/AccountNumber"},"reconnectDetails":{"$ref":"#/components/schemas/ReconnectDetails"}},"required":["accountNumber","reconnectDetails"]},{"type":"object","properties":{"accountNumber":{"$ref":"#/components/schemas/AccountNumber"},"reconnectDetails":{"$ref":"#/components/schemas/ReconnectDetails"},"error":{"$ref":"#/components/schemas/BusinessError"}},"required":["accountNumber","reconnectDetails","error"]}]}},"required":["data"],"example":{"data":{"accountNumber":"0123456789","reconnectDetails":{"confirmationNumber":"0123456789","timeWindow":"5:00 PM to 9:00 PM","isReconnectGranted":true,"messages":["abcdefghijklmnopqrstuwxyz...","abcdefghijklmnopqrstuwxyz...","abcdefghijklmnopqrstuwxyz..."]}}}},"example":{"data":{"accountNumber":"0123456789","reconnectDetails":{"confirmationNumber":"0123456789","timeWindow":"5:00 PM to 9:00 PM","isReconnectGranted":true,"messages":["abcdefghijklmnopqrstuwxyz...","abcdefghijklmnopqrstuwxyz...","abcdefghijklmnopqrstuwxyz..."]}}}}}},"404":{"$ref":"#/components/responses/Error404"},"502":{"$ref":"#/components/responses/Error502"}},"summary":"post-reconnect-process","operationId":"post-reconnect-process","description":"Updates a reconnect service request.","tags":["Reconnect"],"parameters":[{"name":"accountId","in":"path","description":"an account identifier in the form of a ten digit string","required":true,"example":"0123456789","schema":{"$ref":"#/components/schemas/AccountNumber"}}],"requestBody":{"content":{"application/json":{"example":{"confirmationNumber":"0123456789","fieldActivityInstructions":"I have a big old dog","preferredDate":"2025-03-04","preferredTime":"1700"},"schema":{"$ref":"#/components/schemas/ReconnectConfirmation"}}}}}},"/accounts/{accountId}/services":{"get":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"description":"data returned by the operation","type":"object","properties":{"accountNumber":{"$ref":"#/components/schemas/AccountNumber"},"services":{"$ref":"#/components/schemas/Services"}},"required":["accountNumber","services"]}},"required":["data"]},"example":{"data":{"accountNumber":"0123456789","services":[{"id":"0123456789","mainSp":["0123456789","0123456789","0123456789"],"rate":6,"saType":"RWW-C","saTypeDesc":"TYPE","serviceType":"WW","serviceTypeDesc":"TYPE","status":"Active","waterOnly":"false"},{"id":"0123456789","mainSp":["0123456789","0123456789","0123456789"],"rate":6,"saType":"RWW-B","saTypeDesc":"TYPE","serviceType":"W","serviceTypeDesc":"TYPE","status":"Active","waterOnly":"true"}]}}}}},"404":{"$ref":"#/components/responses/Error404"},"502":{"$ref":"#/components/responses/Error502"}},"summary":"get-services","operationId":"get-services","description":"Retrieves the services associated with an account.","tags":["Services"],"parameters":[{"name":"accountId","in":"path","description":"an account identifier in the form of a ten digit string","required":true,"example":"0123456789","schema":{"$ref":"#/components/schemas/AccountNumber"}}]}},"/accounts/{accountId}/serviceTypes":{"get":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"description":"data returned by the operation","type":"object","properties":{"accountNumber":{"$ref":"#/components/schemas/AccountNumber"},"serviceTypes":{"$ref":"#/components/schemas/ServiceTypes"}},"required":["accountNumber","serviceTypes"]}},"required":["data"]},"example":{"data":{"accountNumber":"0123456789","serviceTypes":[{"serviceType":"W","serviceDescription":"Water"},{"serviceType":"WW","serviceDescription":"Wastewater"}]}}}}},"404":{"$ref":"#/components/responses/Error404"},"502":{"$ref":"#/components/responses/Error502"}},"summary":"get-service-types","operationId":"get-service-types","description":"Retrieves the service types associated with an account.","tags":["Service Types"],"parameters":[{"name":"accountId","in":"path","description":"an account identifier in the form of a ten digit string","required":true,"example":"0123456789","schema":{"$ref":"#/components/schemas/AccountNumber"}}]}},"/accounts/{accountId}/servicePoints":{"get":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"description":"data returned by the operation","type":"object","properties":{"accountNumber":{"$ref":"#/components/schemas/AccountNumber"},"servicePoints":{"$ref":"#/components/schemas/ServicePoints"}},"required":["accountNumber","servicePoints"]}},"required":["data"]},"example":{"data":{"accountNumber":"0123456789","servicePoints":[{"badgeNumber":"01234567","id":"0123456789","isSubMeterPoint":"N","location":{"latitude":25.775238,"longitude":-80.196685},"route":"6666","saspUsageFlg":"+","size":"5/8 INCH WATER METER","type":"5/8"},{"badgeNumber":"01234567","id":"0123456789","isSubMeterPoint":"N","location":{"latitude":25.775238,"longitude":-80.196685},"route":"6666","saspUsageFlg":"+","size":"5/8 INCH WATER METER","type":"5/8"}]}}}}},"404":{"$ref":"#/components/responses/Error404"},"502":{"$ref":"#/components/responses/Error502"}},"summary":"get-service-points","operationId":"get-service-points","description":"Retrieves the meter points information for an account.","tags":["Service Points"],"parameters":[{"name":"accountId","in":"path","description":"an account identifier in the form of a ten digit string","required":true,"example":"0123456789","schema":{"$ref":"#/components/schemas/AccountNumber"}}]}},"/accounts/{accountId}/stopServiceEligibility":{"post":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/StopServiceEligibilityConfirmation"}},"required":["data"],"example":{"data":{"accountNumber":"0123456789","blockedDates":["2025-04-04","2025-04-07","2025-04-08","2025-04-09","2025-04-14","2025-04-15","2025-04-17","2025-04-21","2025-04-22","2025-04-25","2025-04-28","2025-04-29","2025-05-03","2025-05-05"],"existingStopDate":null,"ineligibleReasons":null,"isAccountEligible":true,"premiseId":"0123456789"}}},"example":{"data":{"accountNumber":"0123456789","blockedDates":["2025-04-04","2025-04-07","2025-04-08","2025-04-09","2025-04-14","2025-04-15","2025-04-17","2025-04-21","2025-04-22","2025-04-25","2025-04-28","2025-04-29","2025-05-03","2025-05-05"],"existingStopDate":null,"ineligibleReasons":null,"isAccountEligible":true,"premiseId":"0123456789"}}}}},"404":{"$ref":"#/components/responses/Error404"},"502":{"$ref":"#/components/responses/Error502"}},"summary":"post-stop-service-eligibility","operationId":"post-stop-service-eligibility","description":"Checks if the account is eligible for a stop service service request.","tags":["Stop Service"],"parameters":[{"name":"accountId","in":"path","description":"an account identifier in the form of a ten digit string","required":true,"example":"0123456789","schema":{"$ref":"#/components/schemas/AccountNumber"}}],"requestBody":{"content":{"application/json":{"example":{"premiseId":"0123456789","accountStatus":"ACTIVE"},"schema":{"type":"object","properties":{"premiseId":{"$ref":"#/components/schemas/PremiseId"},"accountStatus":{"$ref":"#/components/schemas/AccountStatus"}},"required":["premiseId","accountStatus"]}}}}}},"/accounts/{accountId}/stopService":{"post":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/StopServiceConfirmation"}},"required":["data"]},"example":{"data":{"premiseId":"0123456789","accountNumber":"0123456789","effectiveStopDate":"2025-06-15","confirmationNumber":"0123456789"}}}}},"404":{"$ref":"#/components/responses/Error404"},"502":{"$ref":"#/components/responses/Error502"}},"summary":"post-stop-service-process","operationId":"post-stop-service-process","description":"Processes a stop service service request.","tags":["Stop Service"],"parameters":[{"name":"accountId","in":"path","description":"an account identifier in the form of a ten digit string","required":true,"example":"0123456789","schema":{"$ref":"#/components/schemas/AccountNumber"}}],"requestBody":{"content":{"application/json":{"example":{"accessInstructions":"Gate Code is 1234.","accountStatus":"ACTIVE","comments":"This is an example of a comment.","premiseId":"0123456789","requestedBy":"Tony","requestedStopDate":"2025-06-15"},"schema":{"$ref":"#/components/schemas/StopService"}}}}}},"/accounts/{accountId}/cciEligibility":{"post":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CCIEligibility"}},"required":["data"]},"example":{"data":{"accountNumber":"0123456789","ineligibleReasons":null,"isAccountEligible":true,"premiseId":"0123456789"}}}}},"404":{"$ref":"#/components/responses/Error404"},"502":{"$ref":"#/components/responses/Error502"}},"summary":"post-cci-eligibility","operationId":"post-cci-eligibility","description":"Checks if the the account is eligible for submeters.","tags":["Submeters"],"parameters":[{"name":"accountId","in":"path","description":"an account identifier in the form of a ten digit string","required":true,"example":"0123456789","schema":{"$ref":"#/components/schemas/AccountNumber"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"premiseId":{"$ref":"#/components/schemas/PremiseId"}},"required":["premiseId"]}}}}}},"/accounts/{accountId}/cciSubmeters":{"get":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"description":"data returned by the operation","type":"object","properties":{"accountNumber":{"$ref":"#/components/schemas/AccountNumber"},"submeters":{"$ref":"#/components/schemas/CCISubmeters"}},"required":["accountNumber","submeters"]}},"required":["data"]},"example":{"data":{"accountNumber":"0123456789","submeters":[{"badgeNumber":"19424169","location":{"latitude":25.775238,"longitude":-80.196685},"locationDetails":"SUB:CCI ROOF","meterConfigurationId":"8028452257","meterDigits":4,"meterId":"8024052829","route":"6666","size":"5/8 INCH WATER METER","spId":"0123456789","type":"5/8","messages":[{"message":"You have missed the past two windows. Another missed read and you will be removed from the program","code":"11111"}],"meterReads":[{"readDate":"2025-03-20","readType":"Customer Read","meterReading":4000},{"readDate":"2025-02-20","readType":"Customer Read","meterReading":3000},{"readDate":"2025-01-20","readType":"Customer Read","meterReading":2000},{"readDate":"2012-12-20","readType":"Customer Read","meterReading":0}],"temporaryRead":{"readDate":"2021-04-20","readType":"Temporary Read","meterReading":1004}},{"meterConfigurationId":"3478389761","meterId":"3478974178","spId":"0123456789","badgeNumber":"18309966","type":"1","size":"1 INCH WATER METER","route":"6666","location":{"latitude":25.775238,"longitude":-80.196685},"locationDetails":"SUB CCI:@ ROOF N ESMT/COOLING TOWER","meterDigits":5,"messages":[{"message":"You have missed the past two windows. Another missed read and you will be removed from the program","code":"11111"}],"meterReads":[{"readDate":"2021-03-20","readType":"Customer Read","meterReading":40005},{"readDate":"2021-02-20","readType":"Office Read","meterReading":30005},{"readDate":"2021-01-20","readType":"Customer Read","meterReading":20005},{"readDate":"2019-12-20","readType":"Customer Read","meterReading":10005}],"temporaryRead":{"readDate":"2021-04-20","readType":"Temporary Read","meterReading":20005}},{"meterConfigurationId":"8644450181","meterId":"8645992499","spId":"0123456789","badgeNumber":"20256771","type":"5/8","size":"5/8 INCH WATER METER","route":"6666","location":{"latitude":25.775238,"longitude":-80.196685},"locationDetails":"SUB CCI: 20'N/SE COR/BLDG","meterDigits":6,"messages":[{"message":"You have missed the past two windows. Another missed read and you will be removed from the program","code":"11111"}],"meterReads":[{"readDate":"2021-03-20","readType":"Customer Read","meterReading":400006},{"readDate":"2021-02-20","readType":"Office Read","meterReading":300006},{"readDate":"2021-01-20","readType":"Customer Read","meterReading":200006},{"readDate":"2019-12-20","readType":"Customer Read","meterReading":100006}],"temporaryRead":{"readDate":"2021-04-20","readType":"Temporary Read","meterReading":300060}},{"meterConfigurationId":"0372035581","meterId":"0372035345","spId":"0123456789","badgeNumber":"14232162","type":"2","size":"2 INCH WATER METER","route":"6666","location":{"latitude":25.775238,"longitude":-80.196685},"locationDetails":"SUB: R C/HOUSE WALL ATTACHED TO SPIGOT","meterDigits":5,"messages":[{"message":"You have missed the past two windows. Another missed read and you will be removed from the program","code":"11111"}],"meterReads":[{"readDate":"2021-03-20","readType":"Customer Read","meterReading":40050},{"readDate":"2021-02-20","readType":"Office Read","meterReading":30050},{"readDate":"2021-01-20","readType":"Customer Read","meterReading":20050},{"readDate":"2019-12-20","readType":"Customer Read","meterReading":10050}],"temporaryRead":{"readDate":"2021-04-20","readType":"Temporary Read","meterReading":41115}},{"meterConfigurationId":"4951383592","meterId":"4951383592","spId":"0123456789","badgeNumber":"18310008","type":"1.5","size":"1.5 INCH WATER METER","route":"6666","location":{"latitude":25.775238,"longitude":-80.196685},"locationDetails":"SUB:INSIDE WEST WALL CCI MTR BLVD","meterDigits":5,"messages":[{"message":"You have missed the past two windows. Another missed read and you will be removed from the program","code":"11111"}],"meterReads":[{"readDate":"2021-03-20","readType":"Customer Read","meterReading":45000},{"readDate":"2021-02-20","readType":"Office Read","meterReading":35000},{"readDate":"2021-01-20","readType":"Customer Read","meterReading":25000},{"readDate":"2019-12-20","readType":"Customer Read","meterReading":15000}],"temporaryRead":{"readDate":"2021-04-20","readType":"Temporary Read","meterReading":42225}},{"meterConfigurationId":"1063776465","meterId":"1063776862","spId":"0123456789","badgeNumber":"14232140","type":"5/8","size":"5/8 INCH WATER METER","route":"6666","location":{"latitude":25.775238,"longitude":-80.196685},"locationDetails":"SUB CCI: ON ROOF WEST SIDE/CT","meterDigits":5,"messages":[{"message":"You have missed the past two windows. Another missed read and you will be removed from the program","code":"11111"}],"meterReads":[{"readDate":"2021-03-20","readType":"Customer Read","meterReading":40500},{"readDate":"2021-02-20","readType":"Office Read","meterReading":30500},{"readDate":"2021-01-20","readType":"Customer Read","meterReading":20500},{"readDate":"2019-12-20","readType":"Customer Read","meterReading":10500}],"temporaryRead":{"readDate":"2021-04-20","readType":"Temporary Read","meterReading":43335}},{"meterConfigurationId":"3485067051","meterId":"3485002445","spId":"0123456789","badgeNumber":"06406175","type":"1","size":"1 INCH WATER METER","route":"6666","location":{"latitude":25.775238,"longitude":-80.196685},"locationDetails":"CCI SUB: 20'N/SE COR/BLDG @WALL","meterDigits":5,"messages":[{"message":"You have missed the past two windows. Another missed read and you will be removed from the program","code":"11111"}],"meterReads":[{"readDate":"2025-03-20","readType":"No Read","meterReading":40000},{"readDate":"2025-02-20","readType":"System Estimate","meterReading":30000},{"readDate":"2025-01-20","readType":"Service Provider Estimate","meterReading":20000},{"readDate":"2021-12-20","readType":"Office Estimate","meterReading":10000},{"readDate":"2021-12-19","readType":"System Prorate","meterReading":9000},{"readDate":"2021-12-18","readType":"Customer Read","meterReading":8000},{"readDate":"2021-12-17","readType":"Regular","meterReading":7000},{"readDate":"2021-12-16","readType":"Verified","meterReading":0},{"readDate":"2021-12-15","readType":"Billing Force","meterReading":99999},{"readDate":"2025-03-21","readType":"Office Estimate","meterReading":40001}],"temporaryRead":null},{"meterConfigurationId":"0868636863","meterId":"0868636551","spId":"0123456789","badgeNumber":"16200353","type":"5/8","size":"5/8 INCH WATER METER","route":"6666","location":{"latitude":25.775238,"longitude":-80.196685},"locationDetails":"SUB: CCI 4TH FLOOR PUMP ROOM","meterDigits":5,"messages":[{"message":"You have missed the past two windows. Another missed read and you will be removed from the program","code":"11111"}],"meterReads":[{"readDate":"2021-03-20","readType":"Customer Read","meterReading":40055},{"readDate":"2021-02-20","readType":"Office Read","meterReading":30055},{"readDate":"2021-01-20","readType":"Customer Read","meterReading":20055},{"readDate":"2019-12-20","readType":"Customer Read","meterReading":10055}],"temporaryRead":{"readDate":"2021-04-20","readType":"Temporary Read","meterReading":75555}},{"meterConfigurationId":"2815256773","meterId":"2815271407","spId":"0123456789","badgeNumber":"09406372","type":"2","size":"2 INCH WATER METER","route":"6666","location":{"latitude":25.775238,"longitude":-80.196685},"locationDetails":"SUB:CCI @ PRKNG GAR INSDE CHEMICAL RM @ WALL","meterDigits":6,"messages":[{"message":"You have missed the past two windows. Another missed read and you will be removed from the program","code":"11111"}],"meterReads":[{"readDate":"2021-03-20","readType":"Customer Read","meterReading":400060},{"readDate":"2021-02-20","readType":"Office Read","meterReading":300060},{"readDate":"2021-01-20","readType":"Customer Read","meterReading":200060},{"readDate":"2019-12-20","readType":"Customer Read","meterReading":100060}],"temporaryRead":{"readDate":"2021-04-20","readType":"Temporary Read","meterReading":866665}},{"meterConfigurationId":"4202947120","meterId":"4202970786","spId":"0123456789","badgeNumber":"06410723","type":"1.5","size":"1.5 INCH WATER METER","route":"6666","location":{"latitude":25.775238,"longitude":-80.196685},"locationDetails":"SUB:CCI S ESMT S SIDE/BLDG 25'W/EBL INSDE POOL RM","meterDigits":6,"messages":[{"message":"You have missed the past two windows. Another missed read and you will be removed from the program","code":"11111"}],"meterReads":[{"readDate":"2021-03-20","readType":"Office Read","meterReading":40000},{"readDate":"2021-02-20","readType":"Office Read","meterReading":30000},{"readDate":"2021-01-20","readType":"Office Read","meterReading":20000},{"readDate":"2019-12-20","readType":"Office Read","meterReading":10000}],"temporaryRead":{"readDate":"2021-04-20","readType":"Temporary Read","meterReading":966665}}]}}}}},"404":{"$ref":"#/components/responses/Error404"},"502":{"$ref":"#/components/responses/Error502"}},"summary":"get-cci-submeters","operationId":"get-cci-submeters","description":"Retrieves the submeters associated with an account.","tags":["Submeters"],"parameters":[{"name":"accountId","in":"path","description":"an account identifier in the form of a ten digit string","required":true,"example":"0123456789","schema":{"$ref":"#/components/schemas/AccountNumber"}},{"name":"premiseId","in":"query","description":"Premise ID in the form of a ten digit string","required":true,"example":"0123456789","schema":{"$ref":"#/components/schemas/PremiseId"}}]}},"/accounts/{accountId}/cciMeterReadWindows":{"get":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"description":"data returned by the operation","type":"object","properties":{"accountNumber":{"$ref":"#/components/schemas/AccountNumber"},"readWindows":{"$ref":"#/components/schemas/CCIReadWindows"}},"required":["accountNumber","readWindows"]}},"required":["data"]},"example":{"data":{"accountNumber":"0123456789","readWindows":[{"index":-3,"startDate":"2021-12-07","endDate":"2021-12-14"},{"index":-2,"startDate":"2025-03-07","endDate":"2025-01-14"},{"index":-1,"startDate":"2025-04-07","endDate":"2025-04-14"},{"index":0,"startDate":"2025-05-07","endDate":"2025-05-14"},{"index":1,"startDate":"2025-06-07","endDate":"2025-06-14"},{"index":2,"startDate":"2025-07-07","endDate":"2025-07-14"},{"index":3,"startDate":"2025-08-07","endDate":"2025-08-14"}]}}}}},"404":{"$ref":"#/components/responses/Error404"},"502":{"$ref":"#/components/responses/Error502"}},"summary":"get-cci-meter-read-window","operationId":"get-cci-meter-read-window","description":"Retrieves the submeter reading windows for an account.","tags":["Submeters"],"parameters":[{"name":"accountId","in":"path","description":"an account identifier in the form of a ten digit string","required":true,"example":"0123456789","schema":{"$ref":"#/components/schemas/AccountNumber"}}]}},"/accounts/{accountId}/cciSubmitMeterRead":{"post":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"description":"data returned by the operation","type":"object","properties":{"accountNumber":{"$ref":"#/components/schemas/AccountNumber"},"cciReads":{"$ref":"#/components/schemas/CCIReads"}},"required":["accountNumber","cciReads"]}},"required":["data"]},"example":{"data":{"accountNumber":"0123456789","cciReads":[{"badgeNumber":"19424169","locationDetails":"SUB:CCI ROOF","isReadSubmitted":true,"confirmationNumber":"0123456789","submitDate":"2021-03-11","submittedReading":1221,"messages":[{"message":"Read accepted for 01221","code":"22222"}]},{"badgeNumber":"18309966","locationDetails":"SUB CCI:@ ROOF N ESMT/COOLING TOWER","isReadSubmitted":false,"confirmationNumber":null,"submitDate":null,"submittedReading":null,"messages":[{"message":"Read Window missed.","code":"33333"},{"message":"No Active CCI Meter Installed.","code":"11304"}]},{"badgeNumber":"20256771","locationDetails":"SUB CCI: 20'N/SE COR/BLDG","isReadSubmitted":false,"confirmationNumber":null,"submitDate":null,"submittedReading":null,"messages":[{"message":"You did not submit a reading for this submeter.","code":"99999"}]},{"badgeNumber":"14232162","locationDetails":"SUB: R C/HOUSE WALL ATTACHED TO SPIGOT","isReadSubmitted":true,"confirmationNumber":"0123456789","submitDate":"2021-03-11","submittedReading":1,"messages":[{"message":"Read accepted for 00001","code":"22222"}]},{"badgeNumber":"18310008","locationDetails":"SUB:INSIDE WEST WALL CCI MTR BLVD","isReadSubmitted":true,"confirmationNumber":"0123456789","submitDate":"2021-03-11","submittedReading":10,"messages":[{"message":"Read accepted for 00010","code":"22222"}]},{"badgeNumber":"14232140","locationDetails":"SUB CCI: ON ROOF WEST SIDE/CT","isReadSubmitted":true,"confirmationNumber":"0123456789","submitDate":"2021-03-11","submittedReading":100,"messages":[{"message":"Read accepted for 00100","code":"22222"}]},{"badgeNumber":"06406175","locationDetails":"CCI SUB: 20'N/SE COR/BLDG @WALL","isReadSubmitted":true,"confirmationNumber":"0123456789","submitDate":"2021-03-11","submittedReading":1000,"messages":[{"message":"Read accepted for 01000","code":"22222"}]},{"badgeNumber":"16200353","locationDetails":"SUB: CCI 4TH FLOOR PUMP ROOM","isReadSubmitted":true,"confirmationNumber":"0123456789","submitDate":"2021-03-11","submittedReading":10000,"messages":[{"message":"Read accepted for 10000","code":"22222"}]},{"badgeNumber":"09406372","locationDetails":"SUB:CCI @ PRKNG GAR INSDE CHEMICAL RM @ WALL","isReadSubmitted":true,"confirmationNumber":"0123456789","submitDate":"2021-03-11","submittedReading":6,"messages":[{"message":"Read accepted for 000006","code":"22222"}]},{"badgeNumber":"06410723","locationDetails":"SUB:CCI S ESMT S SIDE/BLDG 25'W/EBL INSDE POOL RM","isReadSubmitted":true,"confirmationNumber":"0123456789","submitDate":"2021-03-11","submittedReading":999999,"messages":[{"message":"Read accepted for 999999","code":"22222"}]}]}}}}},"404":{"$ref":"#/components/responses/Error404"},"502":{"$ref":"#/components/responses/Error502"}},"summary":"post-cci-submit-meter-read","operationId":"post-cci-submit-meter-read","description":"Update submeter readings.","tags":["Submeters"],"parameters":[{"name":"accountId","in":"path","description":"an account identifier in the form of a ten digit string","required":true,"example":"0123456789","schema":{"$ref":"#/components/schemas/AccountNumber"}}],"requestBody":{"content":{"application/json":{"example":{"premiseId":"0123456789","meters":[{"meterConfigurationId":"8028452257","meterReading":1234},{"meterConfigurationId":"3478389761","meterReading":4567},{"meterConfigurationId":"8644450181","meterReading":55555},{"meterConfigurationId":"0372035581","meterReading":891011},{"meterConfigurationId":"4951383592","meterReading":1234},{"meterConfigurationId":"1063776465","meterReading":4567},{"meterConfigurationId":"3485067051","meterReading":55555},{"meterConfigurationId":"0868636863","meterReading":891011},{"meterConfigurationId":"2815256773","meterReading":999999},{"meterConfigurationId":"4202947120","meterReading":null}]},"schema":{"type":"object","properties":{"premiseId":{"$ref":"#/components/schemas/PremiseId"},"meters":{"$ref":"#/components/schemas/CCISubmeterUpdates"}},"required":["premiseId","meters"]}}}}}},"/{accountId}/payment/achFundingPortal":{"get":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"description":"data returned by the operation","type":"object","oneOf":[{"$ref":"#/components/schemas/ACHFundingPortalConfirmation"},{"type":"object","properties":{"error":{"$ref":"#/components/schemas/BusinessError"}},"required":["error"]}]}},"required":["data"]},"example":{"data":{"accountNumber":"0123456789","fundingUrl":"https://collectpay-uat.princetonecom.com:443/fundingPortal/processFunding.do?ssoKey=NTYyMTA0OjAwMjkxNTQyMDA6MTUzNjg2Njk0MzM0NTplbl9VUzpkM2QzZHk1bmIyOW5iR1V1WTI5dDo1NjIxMDQ6TVNNb0wzZkxtQm5yOUtib0VkV09OamlJLnY0dWlub2RlMQ%3D%3D"}}}}},"404":{"$ref":"#/components/responses/Error404"},"502":{"$ref":"#/components/responses/Error502"}},"summary":"get-ach-funding-portal","operationId":"get-ach-funding-portal","description":"Retrieves the bank account funding portal information associated with an account.","tags":["Pending Payments"],"parameters":[{"name":"accountId","in":"path","description":"an account identifier in the form of a ten digit string","required":true,"example":"0123456789","schema":{"$ref":"#/components/schemas/AccountNumber"}}]}},"/{accountId}/payment/achFundingSources":{"get":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"description":"data returned by the operation","type":"object","oneOf":[{"type":"object","properties":{"accountNumber":{"$ref":"#/components/schemas/AccountNumber"},"tokens":{"$ref":"#/components/schemas/ACHFundingSourceTokens"}},"required":["accountNumber","tokens"]},{"type":"object","properties":{"error":{"$ref":"#/components/schemas/BusinessError"}},"required":["error"]}]}},"required":["data"],"example":{"data":{"accountNumber":"0123456789","tokens":[{"fundingAccountNickname":"Lollipop","fundingDate":"09/12/2023","fundingSubType":"PERSONAL CHECKING","id":"163cf7eb34ce2c3ff00245a8406a407251420a292d08471482192ad9bdce591c","isAttachedToAutoPay":false,"isAttachedToProfileId":false,"maskedFundingAccount":"******0123","singleUse":"N"},{"fundingAccountNickname":"Giddy Up","fundingDate":"09/12/2023","fundingSubType":"PERSONAL CHECKING","id":"163cf7eb34ce2c3ff00245a8406a407251420a292d08471482192ad9bdce591d","isAttachedToAutoPay":false,"isAttachedToProfileId":false,"maskedFundingAccount":"******4567","singleUse":"N"}]}}},"example":{"data":{"accountNumber":"0123456789","tokens":[{"fundingAccountNickname":"Lollipop","fundingDate":"09/12/2023","fundingSubType":"PERSONAL CHECKING","id":"163cf7eb34ce2c3ff00245a8406a407251420a292d08471482192ad9bdce591c","isAttachedToAutoPay":false,"isAttachedToProfileId":false,"maskedFundingAccount":"******0123","singleUse":"N"},{"fundingAccountNickname":"Giddy Up","fundingDate":"09/12/2023","fundingSubType":"PERSONAL CHECKING","id":"163cf7eb34ce2c3ff00245a8406a407251420a292d08471482192ad9bdce591d","isAttachedToAutoPay":false,"isAttachedToProfileId":false,"maskedFundingAccount":"******4567","singleUse":"N"}]}}}}},"404":{"$ref":"#/components/responses/Error404"},"502":{"$ref":"#/components/responses/Error502"}},"summary":"get-ach-funding-sources","operationId":"get-ach-funding-sources","description":"Retrieves the bank account funding sources from ACI.","tags":["Funding Sources"],"parameters":[{"name":"accountId","in":"path","description":"an account identifier in the form of a ten digit string","required":true,"example":"0123456789","schema":{"$ref":"#/components/schemas/AccountNumber"}}]},"post":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"description":"data returned by the operation","type":"object","oneOf":[{"$ref":"#/components/schemas/ACHFundingSourceAddedConfirmation"},{"type":"object","properties":{"error":{"$ref":"#/components/schemas/BusinessError"}},"required":["error"]}]}},"required":["data"],"example":{"data":{"id":"fdffb569bb332afebf5332c99cf8bf646d2cc81d0cf0b743c7e38d5ff7d3a0a1<","fundingSubType":"PERSONAL SAVINGS","maskedFundingAccount":"*****3123","fundingAccountNickname":"Bank Account Funding Test","singleUse":"N"}}},"example":{"data":{"id":"fdffb569bb332afebf5332c99cf8bf646d2cc81d0cf0b743c7e38d5ff7d3a0a1<","fundingSubType":"PERSONAL SAVINGS","maskedFundingAccount":"*****3123","fundingAccountNickname":"Bank Account Funding Test","singleUse":"N"}}}}},"404":{"$ref":"#/components/responses/Error404"},"502":{"$ref":"#/components/responses/Error502"}},"summary":"post-ach-funding-sources","operationId":"post-ach-funding-sources","description":"Updates Bank Account Funding Sources from ACI.","tags":["Funding Sources"],"parameters":[{"name":"accountId","in":"path","description":"an account identifier in the form of a ten digit string","required":true,"example":"0123456789","schema":{"$ref":"#/components/schemas/AccountNumber"}}],"requestBody":{"content":{"application/json":{"example":{"accountHolderName":"John Doe","accountNickName":"Bank Account Funding Test","accountState":"FL","accountType":"PERSONAL SAVINGS","accountZip":"33172","bankAccountNumber":"123123123","routingNumber":"021200025","singleUse":false},"schema":{"$ref":"#/components/schemas/ACHFundingSourceAddition"}}}}}},"/{accountId}/payment/achPendingPayments":{"post":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"description":"a collection of ACH pending payments","type":"object","properties":{"data":{"description":"data returned by the operation","type":"object","oneOf":[{"description":"data returned by the operation","type":"object","properties":{"paymentDateTo":{"type":"string","format":"date"},"payments":{"type":"array","items":{"type":"object","properties":{"confirmationNumber":{"$ref":"#/components/schemas/ConfirmationNumber"},"fundingType":{"type":"string"},"payerName":{"type":"string"},"paymentAmount":{"$ref":"#/components/schemas/PaymentAmount"},"paymentCreatedDate":{"type":"string","format":"date"},"paymentDate":{"type":"string","format":"date"},"paymentFee":{"$ref":"#/components/schemas/PaymentFee"},"paymentStatus":{"type":"string"},"requestedPaymentDate":{"type":"string","format":"date"}},"required":["confirmationNumber","fundingType","payerName","paymentAmount","paymentCreatedDate","paymentDate","paymentFee","paymentStatus","requestedPaymentDate"]}},"paymentDateFrom":{"type":"string","format":"date"},"accountNumber":{"$ref":"#/components/schemas/AccountNumber"}},"required":["paymentDateTo","payments","paymentDateFrom","accountNumber"]},{"type":"object","properties":{"error":{"$ref":"#/components/schemas/BusinessError"}},"required":["error"]}]}},"required":["data"],"example":{"data":{"paymentDateTo":"2025-10-16","payments":[{"confirmationNumber":"0123456789","fundingType":"BANK","payerName":"JOSE CUERVO","paymentAmount":135,"paymentCreatedDate":"2025-07-12","paymentDate":"2025-07-15","paymentFee":4.59,"paymentStatus":"Pending","requestedPaymentDate":"2025-07-12"},{"confirmationNumber":"0123456789","fundingType":"BANK","payerName":"JOSE CUERVO","paymentAmount":35,"paymentCreatedDate":"2025-07-12","paymentDate":"2025-07-12","paymentFee":4.59,"paymentStatus":"Pending","requestedPaymentDate":"2025-07-12"},{"paymentFee":4.59,"confirmationNumber":"0123456789","requestedPaymentDate":"2025-07-12","fundingType":"BANK","paymentCreatedDate":"2025-07-12","payerName":"JOSE CUERVO","paymentDate":"2025-07-12","paymentAmount":25,"paymentStatus":"Pending"},{"paymentFee":4.59,"confirmationNumber":"0123456789","requestedPaymentDate":"2025-07-12","fundingType":"BANK","paymentCreatedDate":"2025-07-12","payerName":"JOSE CUERVO","paymentDate":"2025-07-12","paymentAmount":20,"paymentStatus":"Pending"},{"paymentFee":4.59,"confirmationNumber":"0123456789","requestedPaymentDate":"2025-07-12","fundingType":"BANK","paymentCreatedDate":"2025-07-12","payerName":"JOSE CUERVO","paymentDate":"2025-07-12","paymentAmount":20,"paymentStatus":"Pending"},{"paymentFee":4.59,"confirmationNumber":"0123456789","requestedPaymentDate":"2025-07-12","fundingType":"BANK","paymentCreatedDate":"2025-07-12","payerName":"JOSE CUERVO","paymentDate":"2025-07-12","paymentAmount":20,"paymentStatus":"Pending"},{"paymentFee":4.59,"confirmationNumber":"0123456789","requestedPaymentDate":"2025-07-12","fundingType":"BANK","paymentCreatedDate":"2025-07-12","payerName":"JOSE CUERVO","paymentDate":"2025-07-12","paymentAmount":20,"paymentStatus":"Pending"},{"paymentFee":4.59,"confirmationNumber":"0123456789","requestedPaymentDate":"2025-07-12","fundingType":"BANK","paymentCreatedDate":"2025-07-12","payerName":"JOSE CUERVO","paymentDate":"2025-07-12","paymentAmount":20,"paymentStatus":"Pending"},{"paymentFee":2.5,"confirmationNumber":"0123456789","requestedPaymentDate":"2025-07-12","fundingType":"BANK","paymentCreatedDate":"2025-07-12","payerName":"JOSE CUERVO","paymentDate":"2025-07-12","paymentAmount":20,"paymentStatus":"Pending"},{"paymentFee":4.59,"confirmationNumber":"0123456789","requestedPaymentDate":"2025-07-12","fundingType":"BANK","paymentCreatedDate":"2025-07-12","payerName":"JOSE CUERVO","paymentDate":"2025-07-12","paymentAmount":20,"paymentStatus":"Pending"},{"paymentFee":4.59,"confirmationNumber":"0123456789","requestedPaymentDate":"2025-07-12","fundingType":"BANK","paymentCreatedDate":"2025-07-12","payerName":"JOSE CUERVO","paymentDate":"2025-07-12","paymentAmount":15,"paymentStatus":"Pending"},{"paymentFee":4.59,"confirmationNumber":"0123456789","requestedPaymentDate":"2025-07-12","fundingType":"BANK","paymentCreatedDate":"2025-07-12","payerName":"JOSE CUERVO","paymentDate":"2025-07-12","paymentAmount":5,"paymentStatus":"Pending"},{"paymentFee":4.59,"confirmationNumber":"0123456789","requestedPaymentDate":"2025-05-25","fundingType":"BANK","paymentCreatedDate":"2025-05-24","payerName":"JOSE CUERVO","paymentDate":"2025-05-28","paymentAmount":5,"paymentStatus":"Pending"},{"paymentFee":4.59,"confirmationNumber":"0123456789","requestedPaymentDate":"2025-05-22","fundingType":"BANK","paymentCreatedDate":"2025-05-22","payerName":"JOSE CUERVO","paymentDate":"2025-05-22","paymentAmount":5,"paymentStatus":"Pending"}],"paymentDateFrom":"2025-01-01","accountNumber":"0123456789"}}},"example":{"data":{"paymentDateTo":"2025-10-16","payments":[{"paymentFee":4.59,"confirmationNumber":"0123456789","requestedPaymentDate":"2025-07-12","fundingType":"BANK","paymentCreatedDate":"2025-07-12","payerName":"JOSE CUERVO","paymentDate":"2025-07-15","paymentAmount":135,"paymentStatus":"Pending"},{"paymentFee":4.59,"confirmationNumber":"0123456789","requestedPaymentDate":"2025-07-12","fundingType":"BANK","paymentCreatedDate":"2025-07-12","payerName":"JOSE CUERVO","paymentDate":"2025-07-12","paymentAmount":35,"paymentStatus":"Pending"},{"paymentFee":4.59,"confirmationNumber":"0123456789","requestedPaymentDate":"2025-07-12","fundingType":"BANK","paymentCreatedDate":"2025-07-12","payerName":"JOSE CUERVO","paymentDate":"2025-07-12","paymentAmount":25,"paymentStatus":"Pending"},{"paymentFee":4.59,"confirmationNumber":"0123456789","requestedPaymentDate":"2025-07-12","fundingType":"BANK","paymentCreatedDate":"2025-07-12","payerName":"JOSE CUERVO","paymentDate":"2025-07-12","paymentAmount":20,"paymentStatus":"Pending"},{"paymentFee":4.59,"confirmationNumber":"0123456789","requestedPaymentDate":"2025-07-12","fundingType":"BANK","paymentCreatedDate":"2025-07-12","payerName":"JOSE CUERVO","paymentDate":"2025-07-12","paymentAmount":20,"paymentStatus":"Pending"},{"paymentFee":4.59,"confirmationNumber":"0123456789","requestedPaymentDate":"2025-07-12","fundingType":"BANK","paymentCreatedDate":"2025-07-12","payerName":"JOSE CUERVO","paymentDate":"2025-07-12","paymentAmount":20,"paymentStatus":"Pending"},{"paymentFee":4.59,"confirmationNumber":"0123456789","requestedPaymentDate":"2025-07-12","fundingType":"BANK","paymentCreatedDate":"2025-07-12","payerName":"JOSE CUERVO","paymentDate":"2025-07-12","paymentAmount":20,"paymentStatus":"Pending"},{"paymentFee":4.59,"confirmationNumber":"0123456789","requestedPaymentDate":"2025-07-12","fundingType":"BANK","paymentCreatedDate":"2025-07-12","payerName":"JOSE CUERVO","paymentDate":"2025-07-12","paymentAmount":20,"paymentStatus":"Pending"},{"paymentFee":4.59,"confirmationNumber":"0123456789","requestedPaymentDate":"2025-07-12","fundingType":"BANK","paymentCreatedDate":"2025-07-12","payerName":"JOSE CUERVO","paymentDate":"2025-07-12","paymentAmount":20,"paymentStatus":"Pending"},{"paymentFee":4.59,"confirmationNumber":"0123456789","requestedPaymentDate":"2025-07-12","fundingType":"BANK","paymentCreatedDate":"2025-07-12","payerName":"JOSE CUERVO","paymentDate":"2025-07-12","paymentAmount":20,"paymentStatus":"Pending"},{"paymentFee":4.59,"confirmationNumber":"0123456789","requestedPaymentDate":"2025-07-12","fundingType":"BANK","paymentCreatedDate":"2025-07-12","payerName":"JOSE CUERVO","paymentDate":"2025-07-12","paymentAmount":15,"paymentStatus":"Pending"},{"paymentFee":4.59,"confirmationNumber":"0123456789","requestedPaymentDate":"2025-07-12","fundingType":"BANK","paymentCreatedDate":"2025-07-12","payerName":"JOSE CUERVO","paymentDate":"2025-07-12","paymentAmount":5,"paymentStatus":"Pending"},{"paymentFee":4.59,"confirmationNumber":"0123456789","requestedPaymentDate":"2025-05-25","fundingType":"BANK","paymentCreatedDate":"2025-05-24","payerName":"JOSE CUERVO","paymentDate":"2025-05-28","paymentAmount":5,"paymentStatus":"Pending"},{"paymentFee":4.59,"confirmationNumber":"0123456789","requestedPaymentDate":"2025-05-22","fundingType":"BANK","paymentCreatedDate":"2025-05-22","payerName":"JOSE CUERVO","paymentDate":"2025-05-22","paymentAmount":5,"paymentStatus":"Pending"}],"paymentDateFrom":"2025-01-01","accountNumber":"0123456789"}}}}},"404":{"$ref":"#/components/responses/Error404"},"502":{"$ref":"#/components/responses/Error502"}},"summary":"post-ach-pending-payments","operationId":"post-ach-pending-payments","description":"Checks ACI if recent payment was made with ACH on file.","tags":["Pending Payments"],"parameters":[{"name":"accountId","in":"path","description":"an account identifier in the form of a ten digit string","required":true,"example":"0123456789","schema":{"$ref":"#/components/schemas/AccountNumber"}}],"requestBody":{"content":{"application/json":{"example":{"paymentDateFrom":"2025-01-01","paymentDateTo":"2025-10-16"},"schema":{"type":"object","properties":{"paymentDateFrom":{"type":"string","format":"date"},"paymentDateTo":{"type":"string","format":"date"}},"required":["paymentDateFrom","paymentDateTo"]}}}}}},"/{accountId}/payment/achMakePayment":{"post":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"description":"data returned by the operation","type":"object","oneOf":[{"$ref":"#/components/schemas/ACHPaymentConfirmation"},{"type":"object","properties":{"error":{"$ref":"#/components/schemas/BusinessError"}},"required":["error"]}]}},"required":["data"]},"example":{"data":{"confirmationNumber":"0123456789","totalPaymentAmount":5.5,"paymentAmount":2,"paymentFee":4.59,"donationAmount":1,"paymentDate":"2025-08-24"}}}}},"404":{"$ref":"#/components/responses/Error404"},"502":{"$ref":"#/components/responses/Error502"}},"summary":"post-ach-make-payment","operationId":"post-ach-make-payment","description":"Makes a payment via ACH.","tags":["Pending Payments"],"parameters":[{"name":"accountId","in":"path","description":"an account identifier in the form of a ten digit string","required":true,"example":"0123456789","schema":{"$ref":"#/components/schemas/AccountNumber"}}],"requestBody":{"content":{"application/json":{"example":{"fundingToken":"163cf7eb34ce2c3ff00245a8406a407251420a292d08471482192ad9bdce591c","requestedPaymentDate":"2025-08-24","amount":2,"donationAmount":1,"emailAddress":"mail@miamidade.gov"},"schema":{"type":"object","description":"an ACH payment","properties":{"amount":{"type":"number","multipleOf":0.01},"donationAmount":{"$ref":"#/components/schemas/DonationAmount"},"emailAddress":{"description":"an email address","type":"string","format":"email"},"fundingToken":{"type":"string","pattern":"^[0-9a-f]+$"},"requestedPaymentDate":{"type":"string","format":"date"}},"required":["fundingToken","requestedPaymentDate","amount","donationAmount","emailAddress"]}}}}}},"/{accountId}/payment/achCancelPayment":{"post":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"description":"data returned by the operation","type":"object","oneOf":[{"$ref":"#/components/schemas/CancelPendingPaymentConfirmation"},{"type":"object","properties":{"error":{"$ref":"#/components/schemas/BusinessError"}},"required":["error"]}]}},"required":["data"],"example":{"data":{"confirmationNumber":"0123456789","accountNumber":"0123456789"}}},"example":{"data":{"confirmationNumber":"0123456789","accountNumber":"0123456789"}}}}},"404":{"$ref":"#/components/responses/Error404"},"502":{"$ref":"#/components/responses/Error502"}},"summary":"post-ach-cancel-payment","operationId":"post-ach-cancel-payment","description":"Cancels a bank account payment associated with an account number.","tags":["Pending Payments"],"parameters":[{"name":"accountId","in":"path","description":"an account identifier in the form of a ten digit string","required":true,"example":"0123456789","schema":{"$ref":"#/components/schemas/AccountNumber"}}],"requestBody":{"content":{"application/json":{"example":{"confirmationNumber":"0123456789"},"schema":{"type":"object","properties":{"confirmationNumber":{"$ref":"#/components/schemas/ConfirmationNumber"}},"required":["confirmationNumber"]}}}}}},"/{accountId}/payment/ccFundingPortal":{"get":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"description":"data returned by the operation","type":"object","oneOf":[{"$ref":"#/components/schemas/CCFundingPortalConfirmation"},{"type":"object","properties":{"error":{"$ref":"#/components/schemas/BusinessError"}},"required":["error"]}]}},"required":["data"]},"example":{"data":{"accountNumber":"0123456789","fundingUrl":"https://collectpay-uat.princetonecom.com:443/fundingPortal/processFunding.do?ssoKey=NTYyMTA0OjAwMjkxNTQyMDA6MTUzNjg2Njk0MzM0NTplbl9VUzpkM2QzZHk1bmIyOW5iR1V1WTI5dDo1NjIxMDQ6TVNNb0wzZkxtQm5yOUtib0VkV09OamlJLnY0dWlub2RlMQ%3D%3D"}}}}},"404":{"$ref":"#/components/responses/Error404"},"502":{"$ref":"#/components/responses/Error502"}},"summary":"get-cc-funding-portal","operationId":"get-cc-funding-portal","description":"Retrieves the credit card funding portal information associated with an account.","tags":["Pending Payments"],"parameters":[{"name":"accountId","in":"path","description":"an account identifier in the form of a ten digit string","required":true,"example":"0123456789","schema":{"$ref":"#/components/schemas/AccountNumber"}}]}},"/{accountId}/payment/ccFundingSources":{"get":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"description":"data returned by the operation","type":"object","oneOf":[{"type":"object","properties":{"accountNumber":{"$ref":"#/components/schemas/AccountNumber"},"tokens":{"description":"the tokens for the funding sources","type":"array","nullable":true,"items":{"type":"object","properties":{"expiryDate":{"type":"string"},"fundingAccountNickname":{"type":"string"},"fundingDate":{"type":"string"},"fundingSubType":{"type":"string"},"id":{"type":"string"},"maskedFundingAccount":{"type":"string"},"singleUse":{"type":"string"}},"required":["expiryDate","fundingAccountNickname","fundingDate","fundingSubType","id","maskedFundingAccount","singleUse"]}}},"required":["accountNumber","tokens"]},{"type":"object","properties":{"error":{"$ref":"#/components/schemas/BusinessError"}},"required":["error"]}]}},"required":["data"],"example":{"data":{"accountNumber":"0123456789","tokens":[{"id":"05398413ff713a88216bc5d3e4b0e9386a90e7919743db2affce7d1e417118da","fundingSubType":"DISC","maskedFundingAccount":"************0467","fundingAccountNickname":"Lollipop","singleUse":"N","fundingDate":"","expiryDate":"062021"},{"id":"05398413ff713a88216bc5d3e4b0e9386a90e7919743db2affce7d1e417118db","fundingSubType":"VISA","maskedFundingAccount":"************0463","fundingAccountNickname":"GiddyUp","singleUse":"Y","fundingDate":"","expiryDate":"062021"}]}}},"example":{"data":{"accountNumber":"0123456789","tokens":[{"id":"05398413ff713a88216bc5d3e4b0e9386a90e7919743db2affce7d1e417118da","fundingSubType":"DISC","maskedFundingAccount":"************0467","fundingAccountNickname":"Lollipop","singleUse":"N","fundingDate":"","expiryDate":"062021"},{"id":"05398413ff713a88216bc5d3e4b0e9386a90e7919743db2affce7d1e417118db","fundingSubType":"VISA","maskedFundingAccount":"************0463","fundingAccountNickname":"GiddyUp","singleUse":"Y","fundingDate":"","expiryDate":"062021"}]}}}}},"404":{"$ref":"#/components/responses/Error404"},"502":{"$ref":"#/components/responses/Error502"}},"summary":"get-cc-funding-sources","operationId":"get-cc-funding-sources","description":"Retrieves the credit card funding sources from ACI.","tags":["Funding Sources"],"parameters":[{"name":"accountId","in":"path","description":"an account identifier in the form of a ten digit string","required":true,"example":"0123456789","schema":{"$ref":"#/components/schemas/AccountNumber"}}]},"post":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"description":"a credit card funding source","type":"object","oneOf":[{"type":"object","properties":{"expiryDate":{"type":"string"},"fundingAccountNickname":{"type":"string"},"fundingSubType":{"type":"string"},"id":{"type":"string"},"maskedFundingAccount":{"type":"string"},"singleUse":{"type":"string"}},"required":["expiryDate","fundingAccountNickname","fundingSubType","id","maskedFundingAccount","singleUse"]},{"type":"object","properties":{"error":{"$ref":"#/components/schemas/BusinessError"}},"required":["error"]}]}},"required":["data"],"example":{"data":{"expiryDate":"062021","fundingAccountNickname":"Credit Card Funding Test","fundingSubType":"DISC","id":"05398413ff713a88216bc5d3e4b0e9386a90e7919743db2affce7d1e417118da","maskedFundingAccount":"************0467","singleUse":"N"}}},"example":{"data":{"expiryDate":"062021","fundingAccountNickname":"Credit Card Funding Test","fundingSubType":"DISC","id":"05398413ff713a88216bc5d3e4b0e9386a90e7919743db2affce7d1e417118da","maskedFundingAccount":"************0467","singleUse":"N"}}}}},"404":{"$ref":"#/components/responses/Error404"},"502":{"$ref":"#/components/responses/Error502"}},"summary":"post-cc-funding-sources","operationId":"post-cc-funding-sources","description":"Updates CC Funding Sources from ACI.","tags":["Funding Sources"],"parameters":[{"name":"accountId","in":"path","description":"an account identifier in the form of a ten digit string","required":true,"example":"0123456789","schema":{"$ref":"#/components/schemas/AccountNumber"}}],"requestBody":{"content":{"application/json":{"example":{"accountHolderName":"John Doe","accountNickName":"Credit Card Funding Test","accountState":"FL","accountZip":"33172","cardNumber":"4111111111111111","expirationMonth":"10","expirationYear":"2025","securityCode":"123","singleUse":false},"schema":{"$ref":"#/components/schemas/CCFundingSourceAddition"}}}}}},"/{accountId}/payment/ccPendingPayments":{"post":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"description":"data returned by the operation","type":"object","oneOf":[{"type":"object","properties":{"accountNumber":{"$ref":"#/components/schemas/AccountNumber"},"paymentDateFrom":{"type":"string","format":"date"},"paymentDateTo":{"type":"string","format":"date"},"payments":{"$ref":"#/components/schemas/CCPendingPayments"}},"required":["accountNumber","paymentDateFrom","paymentDateTo","payments"]},{"type":"object","properties":{"error":{"$ref":"#/components/schemas/BusinessError"}},"required":["error"]}]}},"required":["data"],"example":{"data":{"paymentDateTo":"2024-05-31","payments":[],"paymentDateFrom":"2025-05-31","accountNumber":"0123456789"}}},"example":{"data":{"accountNumber":"0123456789","paymentDateFrom":"2025-01-01","paymentDateTo":"2025-10-16","payments":[{"paymentFee":4.59,"confirmationNumber":"0123456789","requestedPaymentDate":"2025-05-19","fundingType":"CREDIT CARD","paymentCreatedDate":"2025-05-19T20:38:03","payerName":"JOSE CUERVO","paymentDate":"2025-05-20","paymentAmount":1,"paymentStatus":"Completed"},{"paymentFee":4.59,"confirmationNumber":"0123456789","requestedPaymentDate":"2025-05-19","fundingType":"CREDIT CARD","paymentCreatedDate":"2025-05-19T20:36:40","payerName":"JOSE CUERVO","paymentDate":"2025-05-20","paymentAmount":1,"paymentStatus":"Completed"},{"paymentFee":4.59,"confirmationNumber":"0123456789","requestedPaymentDate":"2025-04-29","fundingType":"CREDIT CARD","paymentCreatedDate":"2025-04-29T13:34:21","payerName":"JOSE CUERVO","paymentDate":"2025-04-29","paymentAmount":1,"paymentStatus":"Completed"},{"paymentFee":4.59,"confirmationNumber":"0123456789","requestedPaymentDate":"2025-01-26","fundingType":"CREDIT CARD","paymentCreatedDate":"2025-01-26T13:32:33","payerName":"JOSE CUERVO","paymentDate":"2025-01-28","paymentAmount":3,"paymentStatus":"Pending"}]}}}}},"404":{"$ref":"#/components/responses/Error404"},"502":{"$ref":"#/components/responses/Error502"}},"summary":"post-cc-pending-payments","operationId":"post-cc-pending-payments","description":"Checks ACI if recent payment was made with CC on file.","tags":["Pending Payments"],"parameters":[{"name":"accountId","in":"path","description":"an account identifier in the form of a ten digit string","required":true,"example":"0123456789","schema":{"$ref":"#/components/schemas/AccountNumber"}}],"requestBody":{"content":{"application/json":{"example":{"paymentDateFrom":"2025-01-01","paymentDateTo":"2025-10-16"},"schema":{"type":"object","properties":{"paymentDateFrom":{"type":"string","format":"date"},"paymentDateTo":{"type":"string","format":"date"}},"required":["paymentDateFrom","paymentDateTo"]}}}}}},"/{accountId}/payment/ccMakePayment":{"post":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CCPaymentConfirmation"}}},"example":{"data":{"confirmationNumber":"0123456789","donationAmount":1,"paymentAmount":2,"paymentDate":"2025-08-24","paymentFee":4.59,"totalPaymentAmount":6.95}}}}},"404":{"$ref":"#/components/responses/Error404"},"502":{"$ref":"#/components/responses/Error502"}},"summary":"post-cc-make-payment","operationId":"post-cc-make-payment","description":"Makes a payment with CC on file.","tags":["Pending Payments"],"parameters":[{"name":"accountId","in":"path","description":"an account identifier in the form of a ten digit string","required":true,"example":"0123456789","schema":{"$ref":"#/components/schemas/AccountNumber"}}],"requestBody":{"content":{"application/json":{"example":{"amount":2,"donationAmount":1,"emailAddress":"mail@miamidade.gov","fundingToken":"05398413ff713a88216bc5d3e4b0e9386a90e7919743db2affce7d1e417118da","requestedPaymentDate":"2025-08-24"},"schema":{"description":"a credit card payment","type":"object","properties":{"amount":{"type":"number","multipleOf":0.01},"donationAmount":{"$ref":"#/components/schemas/DonationAmount"},"emailAddress":{"type":"string","format":"email","description":"an email address"},"fundingToken":{"type":"string","pattern":"^[0-9a-f]+$"},"requestedPaymentDate":{"type":"string","format":"date"}},"required":["fundingToken","requestedPaymentDate","amount","donationAmount","emailAddress"]}}}}}},"/{accountId}/payment/ccCancelPayment":{"post":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"description":"a cancelled credit card confirmation","type":"object","oneOf":[{"type":"object","properties":{"accountNumber":{"$ref":"#/components/schemas/AccountNumber"},"confirmationNumber":{"$ref":"#/components/schemas/ConfirmationNumber"}},"required":["confirmationNumber","accountNumber"]},{"type":"object","properties":{"error":{"$ref":"#/components/schemas/BusinessError"}},"required":["error"]}]}},"required":["data"],"example":{"data":{"confirmationNumber":"0123456789","accountNumber":"0123456789"}}},"example":{"data":{"confirmationNumber":"0123456789","accountNumber":"0123456789"}}}}},"404":{"$ref":"#/components/responses/Error404"},"502":{"$ref":"#/components/responses/Error502"}},"summary":"post-cc-cancel-payment","operationId":"post-cc-cancel-payment","description":"Cancels a credit card payment associated with an account number.","tags":["Pending Payments"],"parameters":[{"name":"accountId","in":"path","description":"an account identifier in the form of a ten digit string","required":true,"example":"0123456789","schema":{"$ref":"#/components/schemas/AccountNumber"}}],"requestBody":{"content":{"application/json":{"example":{"confirmationNumber":"0123456789"},"schema":{"type":"object","properties":{"confirmationNumber":{"$ref":"#/components/schemas/ConfirmationNumber"}},"required":["confirmationNumber"]}}}}}},"/{accountId}/payment/deleteFunding":{"post":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"description":"data returned by the operation","type":"object","properties":{"tokenId":{"$ref":"#/components/schemas/TokenId"}},"required":["tokenId"]}},"required":["data"],"example":{"data":{"tokenId":"163cf7eb34ce2c3ff00245a8406a407251420a292d08471482192ad9bdce591c"}}},"example":{"data":{"tokenId":"163cf7eb34ce2c3ff00245a8406a407251420a292d08471482192ad9bdce591c"}}}}},"404":{"$ref":"#/components/responses/Error404"},"502":{"$ref":"#/components/responses/Error502"}},"summary":"post-delete-funding","operationId":"post-delete-funding","description":"Deletes the funding token (CC or ACH) associated with an account number.","tags":["Pending Payments"],"parameters":[{"name":"accountId","in":"path","description":"an account identifier in the form of a ten digit string","required":true,"example":"0123456789","schema":{"$ref":"#/components/schemas/AccountNumber"}}],"requestBody":{"content":{"application/json":{"example":{"tokenId":"163cf7eb34ce2c3ff00245a8406a407251420a292d08471482192ad9bdce591c"},"schema":{"description":"a funding token identifier","type":"object","properties":{"tokenId":{"$ref":"#/components/schemas/TokenId"}},"required":["tokenId"]}}}}}},"/{accountId}/payment/profileId":{"get":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ProfileId"}},"required":["data"]},"example":{"data":{"profileCount":1,"profileId":"10011528","consumerName":"Wasd Tester Account"}}}}},"404":{"$ref":"#/components/responses/Error404"},"502":{"$ref":"#/components/responses/Error502"}},"summary":"get-profile-id-in-payment-processor","operationId":"get-profile-id-in-payment-processor","description":"Retrieves the the profile id associated with an account number.","tags":["Pending Payments"],"parameters":[{"name":"accountId","in":"path","description":"an account identifier in the form of a ten digit string","required":true,"example":"0123456789","schema":{"$ref":"#/components/schemas/AccountNumber"}}]}},"/accounts/{accountId}/zipCode":{"get":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"description":"data returned by the operation","type":"object","oneOf":[{"type":"object","required":["data","success"],"properties":{"data":{"type":"object","properties":{"zipCode":{"$ref":"#/components/schemas/ZipCode"},"accountNumber":{"$ref":"#/components/schemas/AccountNumber"}},"required":["zipCode","accountNumber"]},"success":{"type":"boolean","description":"whether or not operation succeeded"}}},{"type":"object","required":["success","error"],"properties":{"error":{"$ref":"#/components/schemas/BusinessError"},"success":{"type":"boolean","description":"whether or not operation succeeded"}}}]}},"required":["data"]},"example":[{"data":{"zipCode":"33196","accountNumber":"0123456789"},"success":true},{"data":{"error":{"code":"10004","message":"The Account you entered is invalid. Please enter a valid Water and Sewer Account as it appears on your bill."}}}]}}},"404":{"$ref":"#/components/responses/Error404"}},"summary":"get-verify-account-by-zipcode","operationId":"get-verify-account-by-zipcode","description":"Retrieve the ZIP Code information for an account.","tags":["ZIP Code"],"parameters":[{"name":"accountId","in":"path","description":"an account identifier in the form of a ten digit string","required":true,"example":"0123456789","schema":{"$ref":"#/components/schemas/AccountNumber"}}]}},"/ivr/accounts/{accountId}/zipCode":{"get":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"data":{"type":"object","properties":{"zipCode":{"$ref":"#/components/schemas/ZipCode"},"number":{"$ref":"#/components/schemas/AccountNumber"}},"required":["zipCode","number"]}},"required":["data"]},{"type":"object","required":["error"],"properties":{"error":{"$ref":"#/components/schemas/BusinessError"}}}]},"example":[{"data":{"number":"6621024782","zipCode":"33173"}},{"error":{"code":"10004","message":"The Account you entered is invalid. Please enter a valid Water and Sewer Account as it appears on your bill."}},{"error":{"code":"10001","message":"Invalid Environment. Please call Customer Support at 305-665-7477."}}]}}},"404":{"$ref":"#/components/responses/Error404"},"502":{"$ref":"#/components/responses/Error502"}},"summary":"ivr-get-verify-account-by-zipcode","operationId":"ivr-get-verify-account-by-zipcode","description":"Retrieve the ZIP Code information for an account.","tags":["IVR ZIP Code"],"parameters":[{"name":"accountId","in":"path","description":"an account identifier in the form of a ten digit string","required":true,"example":"0123456789","schema":{"$ref":"#/components/schemas/AccountNumber"}}]}},"/validatePersonEquifax&firstname={firstname}&lastname={lastname}":{"get":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"isValid":{"type":"boolean"}}}}},"example":{"data":{"isValid":true}}}}},"404":{"$ref":"#/components/responses/Error404"}},"summary":"get-validate-person-on-equifax","operationId":"get-validate-person-on-equifax","description":"Validates a customer via the Equifax service.","tags":["Start Service"],"parameters":[{"name":"ssn","in":"query","description":"a social security number in the form of a nine digit string","required":true,"example":"012345678","schema":{"$ref":"#/components/schemas/SocialSecurityNumberNoDashes"}},{"name":"firstname","in":"path","description":"a person's first name","required":true,"example":"Joe","schema":{"$ref":"#/components/schemas/PersonName"}},{"name":"lastname","in":"path","description":"a person's last name","required":true,"example":"Cool","schema":{"$ref":"#/components/schemas/PersonName"}}]}},"/validatePersonEquifaxCheck":{"post":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string"},"consumers":{"type":"object","properties":{"equifaxDTECReport":{"type":"array","items":{"type":"object","properties":{"customerReferenceNumber":{"type":"string"},"customerNumber":{"type":"string"},"consumerReferralCode":{"type":"string"},"outputFormatCode":{"type":"string"},"hitCode":{"type":"object","properties":{"code":{"type":"string"},"description":{"type":"string"}}},"reportDate":{"type":"string"},"subjectName":{"type":"object","properties":{"firstName":{"type":"string"},"lastName":{"type":"string"},"middleName":{"type":"string"}}},"subjectSocialNum":{"type":"integer"},"birthDate":{"type":"string"},"fraudIDScanAlertCodes":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string"},"description":{"type":"string"}}}},"fraudVictimIndicator":{"type":"object","properties":{"code":{"type":"string"},"description":{"type":"string"}}},"addresses":{"type":"array","items":{"type":"object","properties":{"addressType":{"type":"string"},"houseNumber":{"type":"integer"},"streetName":{"type":"string"},"streetType":{"type":"string"},"cityName":{"type":"string"},"stateAbbreviation":{"type":"string"},"zipCode":{"$ref":"#/components/schemas/ZipCode"},"sourceOfAddress":{"type":"object","properties":{"code":{"type":"string"},"description":{"type":"string"}}},"dateFirstReported":{"type":"string"},"dateLastReported":{"type":"string"},"addressLine1":{"type":"string"},"rentOwnBuy":{"type":"string"}},"required":["addressType","houseNumber","streetName","streetType","cityName","stateAbbreviation","zipCode","sourceOfAddress","dateFirstReported","dateLastReported","addressLine1"]}},"employments":{"type":"array","items":{"type":"object","properties":{"identifier":{"type":"string"},"employer":{"type":"string"}}}}}}}}}}},"example":{"status":"completed","consumers":{"equifaxDTECReport":[{"customerReferenceNumber":"2C800002-DOR7","customerNumber":"999XX12345","consumerReferralCode":"347","outputFormatCode":"0D","hitCode":{"code":"6","description":"Hit and Automated Consumer Narrative"},"reportDate":"08242021","subjectName":{"firstName":"LJBKFJ","lastName":"KHJGUFJM","middleName":"X"},"subjectSocialNum":666123456,"birthDate":"06061966","fraudIDScanAlertCodes":[{"code":"L","description":"FRAUD VICTIM ALERT PRESENT IN DATABASE"}],"fraudVictimIndicator":{"code":"X","description":"Fraud Victim Extended Alert"},"addresses":[{"addressType":"current","houseNumber":123,"streetName":"POIBHHFJD","streetType":"ST","cityName":"ATLANTA","stateAbbreviation":"GA","zipCode":30374,"sourceOfAddress":{"code":"T","description":"AUT**"},"dateFirstReported":"05002021","dateLastReported":"06122021","addressLine1":"123 POIBHHFJD ST"},{"addressType":"former","houseNumber":456,"streetName":"POYUFHJ","streetType":"LN","cityName":"ATLANTA","stateAbbreviation":"GA","zipCode":30374,"rentOwnBuy":"R","sourceOfAddress":{"code":"T","description":"AUT**"},"dateFirstReported":"02002020","dateLastReported":"06112021","addressLine1":"456 POYUFHJ LN"}],"employments":[{"identifier":"current","employer":"IAX"}]}]}}}}},"400":{"description":"Bad Request","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"efxErrorCode":{"type":"string"},"description":{"type":"string"},"additionalErrorDetails":{"type":"object","properties":{"status":{"type":"integer"},"message":{"type":"string"},"code":{"type":"string"},"timestamp":{"type":"string"}},"required":["status","message","code","timestamp"]}},"required":["efxErrorCode","description","additionalErrorDetails"]},"example":{"efxErrorCode":"400.00","description":"Please refer to additionalErrorDetails","additionalErrorDetails":{"status":400,"message":"Bad Request","code":"9fef081d-ae42-4088-a3d1-be1f9c61e0bf","timestamp":"2021-05-11T14:26:34.000Z"}}}}},"401":{"description":"Unauthorized","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"efxErrorCode":{"type":"string"},"description":{"type":"string"}},"required":["efxErrorCode","description"]},"example":{"efxErrorCode":"401.01","description":"Access Token Expired"}}}},"403":{"description":"Forbidden","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"efxErrorCode":{"type":"string"},"description":{"type":"string"}},"required":["efxErrorCode","description"]},"example":{"efxErrorCode":"403.01","description":"Access denied"}}}},"404":{"$ref":"#/components/responses/Error404"},"415":{"description":"Unsupported Media Type","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"efxErrorCode":{"type":"string"},"description":{"type":"string"}},"required":["efxErrorCode","description"]},"example":{"efxErrorCode":"415.01","description":"Payload Format is in an Unsupported Format"}}}},"500":{"description":"Internal Server Error","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"efxErrorCode":{"type":"string"},"description":{"type":"string"}},"required":["efxErrorCode","description"]},"example":{"efxErrorCode":"500.01","description":"An internal error has occurred."}}}},"501":{"description":"Not Implemented","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"efxErrorCode":{"type":"string"},"description":{"type":"string"}},"required":["efxErrorCode","description"]},"example":{"efxErrorCode":"501.01","description":"Not-implemented - Specified resource is not implementedd"}}}},"503":{"description":"Service Unavailable","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"efxErrorCode":{"type":"string"},"description":{"type":"string"}},"required":["efxErrorCode","description"]},"example":{"efxErrorCode":"503.01","description":"Service is un-available"}}}},"504":{"description":"Gateway Timeout","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"efxErrorCode":{"type":"string"},"description":{"type":"string"}},"required":["efxErrorCode","description"]},"example":{"efxErrorCode":"504.01","description":"Gateway timeout"}}}}},"summary":"post-validate-person-on-equifax-check","operationId":"post-validate-person-on-equifax-check","description":"Validates a person via the Equifax service.","tags":["Start Service"],"parameters":[],"requestBody":{"content":{"application/json":{"example":{"consumers":{"socialNum":[{"identifier":"current","number":"666123456"}]},"customerReferenceidentifier":"2C800002-DOR7","customerConfiguration":{"equifaxDTECReport":{"memberNumber":"999XX12345","securityCode":"@U2","customerCode":"IAPI","outputFormat":"0D"}}},"schema":{"type":"object","properties":{"consumers":{"type":"object","properties":{"socialNum":{"type":"array","items":{"type":"object","properties":{"identifier":{"type":"string"},"number":{"type":"string"}},"required":["identifier","number"]}}},"required":["socialNum"]},"customerReferenceidentifier":{"type":"string"},"customerConfiguration":{"type":"object","properties":{"equifaxDTECReport":{"type":"object","properties":{"memberNumber":{"type":"string"},"securityCode":{"type":"string"},"customerCode":{"type":"string"},"outputFormat":{"type":"string"}},"required":["memberNumber","securityCode","customerCode","outputFormat"]}},"required":["equifaxDTECReport"]}},"required":["consumers","customerReferenceidentifier","customerConfiguration"]}}}}}},"/validateCompanySunBiz":{"get":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"isValid":{"type":"boolean"}}}}},"example":{"data":{"isValid":true}}}}},"404":{"$ref":"#/components/responses/Error404"}},"summary":"get-validate-business-on-sunbiz","operationId":"get-validate-business-on-sunbiz","description":"Validates a company, with the given company name, via SunBiz service.","tags":["Start Service"],"parameters":[{"name":"name","in":"query","description":"the name of the a company","required":true,"example":"Fizzy Cola","schema":{"$ref":"#/components/schemas/EntityName"}}]}},"/validateCompanySunBizCheck":{"get":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"exist":{"type":"boolean"},"search":{"type":"string"},"companies":{"type":"array","items":{"type":"object","properties":{"feiEinNumber":{"type":"string"},"eventEffectiveDate":{"type":"string"},"lastEventFileDate":{"type":"string"},"lastEvent":{"type":"string"},"name":{"type":"string"},"documentId":{"type":"string"},"fileDate":{"type":"string"},"entityStateCountry":{"type":"string"},"status":{"type":"string"}},"required":["feiEinNumber","eventEffectiveDate","lastEventFileDate","lastEvent","name","documentId","fileDate","entityStateCountry","status"]}},"match":{"type":"object","properties":{"feiEinNumber":{"type":"string"},"eventEffectiveDate":{"type":"string"},"lastEventFileDate":{"type":"string"},"lastEvent":{"type":"string"},"name":{"type":"string"},"documentId":{"type":"string"},"fileDate":{"type":"string"},"entityStateCountry":{"type":"string"},"status":{"type":"string"}}}}}}},"example":{"data":{"exist":true,"search":"650415435","companies":[{"feiEinNumber":"65-0415435","eventEffectiveDate":"NONE","lastEventFileDate":"08/23/1996","lastEvent":"ADMIN DISSOLUTION FOR ANNUAL REPORT","name":"GUN LOVERS AND COLLECTORS OF FLORIDA, INC.","documentId":"P93000036976","fileDate":"05/21/1993","entityStateCountry":"FL","status":"INACTIVE"},{"feiEinNumber":"65-0415436","eventEffectiveDate":"NONE","lastEventFileDate":"08/25/1995","lastEvent":"ADMIN DISSOLUTION FOR ANNUAL REPORT","name":"MARINE ACRYLIC DESIGNS, INC.","documentId":"P93000028140","fileDate":"04/15/1993","entityStateCountry":"FL","status":"INACTIVE"},{"feiEinNumber":"65-0415437","eventEffectiveDate":"NONE","lastEventFileDate":"09/25/2020","lastEvent":"ADMIN DISSOLUTION FOR ANNUAL REPORT","name":"MEDIA SERVICES, INC.","documentId":"P93000039519","fileDate":"06/03/1993","entityStateCountry":"FL","status":"INACTIVE"},{"feiEinNumber":"65-0415437","eventEffectiveDate":"NONE","lastEventFileDate":"09/25/2020","lastEvent":"ADMIN DISSOLUTION FOR ANNUAL REPORT","name":"MEDIA SERVICES BOCA INC.","documentId":"P93000039519","fileDate":"06/03/1993","entityStateCountry":"FL","status":"INACTIVE"},{"feiEinNumber":"65-0415437","eventEffectiveDate":"NONE","lastEventFileDate":"09/25/2020","lastEvent":"ADMIN DISSOLUTION FOR ANNUAL REPORT","name":"MEDIA SERVICES INCORPORATED","documentId":"P93000039519","fileDate":"06/03/1993","entityStateCountry":"FL","status":"INACTIVE"},{"feiEinNumber":"65-0415438","eventEffectiveDate":"NONE","lastEventFileDate":"05/06/2005","lastEvent":"AMENDMENT","name":"LA MILAGROSA HOME CARE, INC.","documentId":"P93000036262","fileDate":"05/19/1993","entityStateCountry":"FL","status":"ACTIVE"},{"feiEinNumber":"65-0415438","eventEffectiveDate":"NONE","lastEventFileDate":"05/06/2005","lastEvent":"AMENDMENT","name":"THE MIRACULOUS HOME CARE, INC.","documentId":"P93000036262","fileDate":"05/19/1993","entityStateCountry":"FL","status":"ACTIVE"},{"feiEinNumber":"65-0415439","eventEffectiveDate":"NONE","lastEventFileDate":"09/26/1997","lastEvent":"ADMIN DISSOLUTION FOR ANNUAL REPORT","name":"M.J. SHOELSON, INC.","documentId":"P93000036187","fileDate":"05/19/1993","entityStateCountry":"FL","status":"INACTIVE"},{"feiEinNumber":"65-0415441","eventEffectiveDate":"NONE","lastEventFileDate":"08/25/1995","lastEvent":"ADMIN DISSOLUTION FOR ANNUAL REPORT","name":"KING TOURS OF NAPLES, INC.","documentId":"P93000032110","fileDate":"04/30/1993","entityStateCountry":"FL","status":"INACTIVE"},{"feiEinNumber":"65-0415442","eventEffectiveDate":"NONE","lastEventFileDate":"09/26/1997","lastEvent":"ADMIN DISSOLUTION FOR ANNUAL REPORT","name":"WILLIAM SEAY, INC.","documentId":"P93000032911","fileDate":"05/06/1993","entityStateCountry":"FL","status":"INACTIVE"},{"feiEinNumber":"65-0415445","eventEffectiveDate":"NONE","lastEventFileDate":"09/26/1997","lastEvent":"ADMIN DISSOLUTION FOR ANNUAL REPORT","name":"INFO-NT, INC.","documentId":"P93000040280","fileDate":"06/01/1993","entityStateCountry":"FL","status":"INACTIVE"},{"feiEinNumber":"65-0415448","eventEffectiveDate":"NONE","lastEventFileDate":"09/24/2021","lastEvent":"ADMIN DISSOLUTION FOR ANNUAL REPORT","name":"GUARANTEE RESTORATION SYSTEM, INC.","documentId":"P93000039679","fileDate":"06/04/1993","entityStateCountry":"FL","status":"INACTIVE"},{"feiEinNumber":"65-0415449","eventEffectiveDate":"NONE","lastEventFileDate":"05/22/2006","lastEvent":"VOLUNTARY DISSOLUTION","name":"MICHAUD, BUSCHMANN, FOX, FERRARA & MITTTELMARK, P.A.","documentId":"P93000042831","fileDate":"06/11/1993","entityStateCountry":"FL","status":"INACTIVE"},{"feiEinNumber":"65-0415449","eventEffectiveDate":"NONE","lastEventFileDate":"05/22/2006","lastEvent":"VOLUNTARY DISSOLUTION","name":"MICHAUD, BUSCHMANN, MITTELMARK, MILLIAN, BLITZ & SHENDELL, P.A.","documentId":"P93000042831","fileDate":"06/11/1993","entityStateCountry":"FL","status":"INACTIVE"},{"feiEinNumber":"65-0415449","eventEffectiveDate":"NONE","lastEventFileDate":"05/22/2006","lastEvent":"VOLUNTARY DISSOLUTION","name":"MICHAUD, BUSCHMANN, MITTELMARK, MILLIAN, BLITZ, WARREN & COEL, P.A.","documentId":"P93000042831","fileDate":"06/11/1993","entityStateCountry":"FL","status":"INACTIVE"},{"feiEinNumber":"65-0415450","eventEffectiveDate":"NONE","lastEventFileDate":"09/19/2003","lastEvent":"ADMIN DISSOLUTION FOR ANNUAL REPORT","name":"VICON HOMES, INC.","documentId":"P92000015044","fileDate":"12/23/1992","entityStateCountry":"FL","status":"INACTIVE"},{"feiEinNumber":"65-0415451","eventEffectiveDate":"NONE","lastEventFileDate":"08/25/1995","lastEvent":"ADMIN DISSOLUTION FOR ANNUAL REPORT","name":"UNITY MANAGEMENT CORP.","documentId":"P93000008081","fileDate":"01/29/1993","entityStateCountry":"FL","status":"INACTIVE"},{"feiEinNumber":"65-0415452","eventEffectiveDate":"NONE","lastEventFileDate":"09/26/1997","lastEvent":"ADMIN DISSOLUTION FOR ANNUAL REPORT","name":"JUST LESLIE, INC.","documentId":"P93000046317","fileDate":"06/25/1993","entityStateCountry":"FL","status":"INACTIVE"},{"feiEinNumber":"65-0415453","eventEffectiveDate":"NONE","lastEventFileDate":"08/25/1995","lastEvent":"ADMIN DISSOLUTION FOR ANNUAL REPORT","name":"SPINNING HARD RECORDS, INC.","documentId":"P93000008093","fileDate":"01/29/1993","entityStateCountry":"FL","status":"INACTIVE"},{"feiEinNumber":"65-0415454","eventEffectiveDate":"NONE","lastEventFileDate":"09/26/1997","lastEvent":"ADMIN DISSOLUTION FOR ANNUAL REPORT","name":"COSTA RICA FIRST CORP.","documentId":"V57245","fileDate":"08/13/1992","entityStateCountry":"FL","status":"INACTIVE"}],"match":{"feiEinNumber":"65-0415435","eventEffectiveDate":"NONE","lastEventFileDate":"08/23/1996","lastEvent":"ADMIN DISSOLUTION FOR ANNUAL REPORT","name":"GUN LOVERS AND COLLECTORS OF FLORIDA, INC.","documentId":"P93000036976","fileDate":"05/21/1993","entityStateCountry":"FL","status":"INACTIVE"}}}}}},"404":{"$ref":"#/components/responses/Error404"},"502":{"$ref":"#/components/responses/Error502"}},"summary":"get-validate-business-on-sunbiz-check","operationId":"get-validate-business-on-sunbiz-check","description":"Retrieves the eligible buisnesses from SunBiz that meet the search criteria parameters.","tags":["Start Service"],"parameters":[{"name":"FTN","in":"query","description":"the FTN (Federal Tax Number) of the business that the caller wants to do an id check for","required":true,"example":"99-999999","schema":{"$ref":"#/components/schemas/FederalTaxNumber"}}]}},"/validateCompany":{"get":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"exist":{"type":"boolean"},"search":{"type":"string"},"companies":{"type":"array","items":{"type":"object","properties":{"feiEinNumber":{"type":"string"},"eventEffectiveDate":{"type":"string"},"lastEventFileDate":{"type":"string"},"lastEvent":{"type":"string"},"name":{"type":"string"},"documentId":{"type":"string"},"fileDate":{"type":"string"},"entityStateCountry":{"type":"string"},"status":{"type":"string"}},"required":["feiEinNumber","eventEffectiveDate","lastEventFileDate","lastEvent","name","documentId","fileDate","entityStateCountry","status"]}},"match":{"type":"object","properties":{"feiEinNumber":{"type":"string"},"eventEffectiveDate":{"type":"string"},"lastEventFileDate":{"type":"string"},"lastEvent":{"type":"string"},"name":{"type":"string"},"documentId":{"type":"string"},"fileDate":{"type":"string"},"entityStateCountry":{"type":"string"},"status":{"type":"string"}}}}}}},"example":{"data":{"exist":true,"search":"Coca Cola","companies":[{"feiEinNumber":"65-0415435","eventEffectiveDate":"NONE","lastEventFileDate":"08/23/1996","lastEvent":"ADMIN DISSOLUTION FOR ANNUAL REPORT","name":"GUN LOVERS AND COLLECTORS OF FLORIDA, INC.","documentId":"P93000036976","fileDate":"05/21/1993","entityStateCountry":"FL","status":"INACTIVE"},{"feiEinNumber":"65-0415436","eventEffectiveDate":"NONE","lastEventFileDate":"08/25/1995","lastEvent":"ADMIN DISSOLUTION FOR ANNUAL REPORT","name":"MARINE ACRYLIC DESIGNS, INC.","documentId":"P93000028140","fileDate":"04/15/1993","entityStateCountry":"FL","status":"INACTIVE"},{"feiEinNumber":"65-0415437","eventEffectiveDate":"NONE","lastEventFileDate":"09/25/2020","lastEvent":"ADMIN DISSOLUTION FOR ANNUAL REPORT","name":"MEDIA SERVICES, INC.","documentId":"P93000039519","fileDate":"06/03/1993","entityStateCountry":"FL","status":"INACTIVE"},{"feiEinNumber":"65-0415437","eventEffectiveDate":"NONE","lastEventFileDate":"09/25/2020","lastEvent":"ADMIN DISSOLUTION FOR ANNUAL REPORT","name":"MEDIA SERVICES BOCA INC.","documentId":"P93000039519","fileDate":"06/03/1993","entityStateCountry":"FL","status":"INACTIVE"},{"feiEinNumber":"65-0415437","eventEffectiveDate":"NONE","lastEventFileDate":"09/25/2020","lastEvent":"ADMIN DISSOLUTION FOR ANNUAL REPORT","name":"MEDIA SERVICES INCORPORATED","documentId":"P93000039519","fileDate":"06/03/1993","entityStateCountry":"FL","status":"INACTIVE"},{"feiEinNumber":"65-0415438","eventEffectiveDate":"NONE","lastEventFileDate":"05/06/2005","lastEvent":"AMENDMENT","name":"LA MILAGROSA HOME CARE, INC.","documentId":"P93000036262","fileDate":"05/19/1993","entityStateCountry":"FL","status":"ACTIVE"},{"feiEinNumber":"65-0415438","eventEffectiveDate":"NONE","lastEventFileDate":"05/06/2005","lastEvent":"AMENDMENT","name":"THE MIRACULOUS HOME CARE, INC.","documentId":"P93000036262","fileDate":"05/19/1993","entityStateCountry":"FL","status":"ACTIVE"},{"feiEinNumber":"65-0415439","eventEffectiveDate":"NONE","lastEventFileDate":"09/26/1997","lastEvent":"ADMIN DISSOLUTION FOR ANNUAL REPORT","name":"M.J. SHOELSON, INC.","documentId":"P93000036187","fileDate":"05/19/1993","entityStateCountry":"FL","status":"INACTIVE"},{"feiEinNumber":"65-0415441","eventEffectiveDate":"NONE","lastEventFileDate":"08/25/1995","lastEvent":"ADMIN DISSOLUTION FOR ANNUAL REPORT","name":"KING TOURS OF NAPLES, INC.","documentId":"P93000032110","fileDate":"04/30/1993","entityStateCountry":"FL","status":"INACTIVE"},{"feiEinNumber":"65-0415442","eventEffectiveDate":"NONE","lastEventFileDate":"09/26/1997","lastEvent":"ADMIN DISSOLUTION FOR ANNUAL REPORT","name":"WILLIAM SEAY, INC.","documentId":"P93000032911","fileDate":"05/06/1993","entityStateCountry":"FL","status":"INACTIVE"},{"feiEinNumber":"65-0415445","eventEffectiveDate":"NONE","lastEventFileDate":"09/26/1997","lastEvent":"ADMIN DISSOLUTION FOR ANNUAL REPORT","name":"INFO-NT, INC.","documentId":"P93000040280","fileDate":"06/01/1993","entityStateCountry":"FL","status":"INACTIVE"},{"feiEinNumber":"65-0415448","eventEffectiveDate":"NONE","lastEventFileDate":"09/24/2021","lastEvent":"ADMIN DISSOLUTION FOR ANNUAL REPORT","name":"GUARANTEE RESTORATION SYSTEM, INC.","documentId":"P93000039679","fileDate":"06/04/1993","entityStateCountry":"FL","status":"INACTIVE"},{"feiEinNumber":"65-0415449","eventEffectiveDate":"NONE","lastEventFileDate":"05/22/2006","lastEvent":"VOLUNTARY DISSOLUTION","name":"MICHAUD, BUSCHMANN, FOX, FERRARA & MITTTELMARK, P.A.","documentId":"P93000042831","fileDate":"06/11/1993","entityStateCountry":"FL","status":"INACTIVE"},{"feiEinNumber":"65-0415449","eventEffectiveDate":"NONE","lastEventFileDate":"05/22/2006","lastEvent":"VOLUNTARY DISSOLUTION","name":"MICHAUD, BUSCHMANN, MITTELMARK, MILLIAN, BLITZ & SHENDELL, P.A.","documentId":"P93000042831","fileDate":"06/11/1993","entityStateCountry":"FL","status":"INACTIVE"},{"feiEinNumber":"65-0415449","eventEffectiveDate":"NONE","lastEventFileDate":"05/22/2006","lastEvent":"VOLUNTARY DISSOLUTION","name":"MICHAUD, BUSCHMANN, MITTELMARK, MILLIAN, BLITZ, WARREN & COEL, P.A.","documentId":"P93000042831","fileDate":"06/11/1993","entityStateCountry":"FL","status":"INACTIVE"},{"feiEinNumber":"65-0415450","eventEffectiveDate":"NONE","lastEventFileDate":"09/19/2003","lastEvent":"ADMIN DISSOLUTION FOR ANNUAL REPORT","name":"VICON HOMES, INC.","documentId":"P92000015044","fileDate":"12/23/1992","entityStateCountry":"FL","status":"INACTIVE"},{"feiEinNumber":"65-0415451","eventEffectiveDate":"NONE","lastEventFileDate":"08/25/1995","lastEvent":"ADMIN DISSOLUTION FOR ANNUAL REPORT","name":"UNITY MANAGEMENT CORP.","documentId":"P93000008081","fileDate":"01/29/1993","entityStateCountry":"FL","status":"INACTIVE"},{"feiEinNumber":"65-0415452","eventEffectiveDate":"NONE","lastEventFileDate":"09/26/1997","lastEvent":"ADMIN DISSOLUTION FOR ANNUAL REPORT","name":"JUST LESLIE, INC.","documentId":"P93000046317","fileDate":"06/25/1993","entityStateCountry":"FL","status":"INACTIVE"},{"feiEinNumber":"65-0415453","eventEffectiveDate":"NONE","lastEventFileDate":"08/25/1995","lastEvent":"ADMIN DISSOLUTION FOR ANNUAL REPORT","name":"SPINNING HARD RECORDS, INC.","documentId":"P93000008093","fileDate":"01/29/1993","entityStateCountry":"FL","status":"INACTIVE"},{"feiEinNumber":"65-0415454","eventEffectiveDate":"NONE","lastEventFileDate":"09/26/1997","lastEvent":"ADMIN DISSOLUTION FOR ANNUAL REPORT","name":"COSTA RICA FIRST CORP.","documentId":"V57245","fileDate":"08/13/1992","entityStateCountry":"FL","status":"INACTIVE"}],"match":{"feiEinNumber":"65-0415435","eventEffectiveDate":"NONE","lastEventFileDate":"08/23/1996","lastEvent":"ADMIN DISSOLUTION FOR ANNUAL REPORT","name":"GUN LOVERS AND COLLECTORS OF FLORIDA, INC.","documentId":"P93000036976","fileDate":"05/21/1993","entityStateCountry":"FL","status":"INACTIVE"}}}}}},"404":{"$ref":"#/components/responses/Error404"},"502":{"$ref":"#/components/responses/Error502"}},"summary":"get-validate-company","operationId":"get-validate-company","description":"Retrieves the eligible businesses from SunBiz that meet the search criteria parameters.","tags":["Start Service"],"parameters":[{"name":"name","in":"query","description":"the name of the business that the caller wants to do an id check for","required":true,"example":"Company Name","schema":{"$ref":"#/components/schemas/EntityName"}}]}},"/accounts/{accountId}/serviceRequests":{"post":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceRequests"}}}},"404":{"$ref":"#/components/responses/Error404"},"502":{"$ref":"#/components/responses/Error502"}},"summary":"service-requests","operationId":"service-requests","description":"Retrieves all service requests for the given account and premise.","tags":["Service Requests"],"parameters":[{"name":"accountId","in":"path","description":"an account identifier in the form of a ten digit string","required":true,"example":"0123456789","schema":{"$ref":"#/components/schemas/AccountNumber"}},{"name":"premiseId","in":"query","description":"Premise ID in the form of a ten digit string","required":true,"example":"0123456789","schema":{"$ref":"#/components/schemas/PremiseId"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"accountId":{"$ref":"#/components/schemas/AccountNumber"},"premiseId":{"$ref":"#/components/schemas/PremiseId"}},"required":["accountId","premiseId"]}}}}}}},"components":{"responses":{"Error404":{"description":"The specified resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error404"}}}},"Error502":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error502"}}}}},"schemas":{"Account":{"description":"an account","type":"object","required":["accountStatus","accountAddress","accountType","accountNumber"],"properties":{"accountStatus":{"$ref":"#/components/schemas/AccountStatus"},"accountAddress":{"$ref":"#/components/schemas/AccountAddress"},"accountType":{"$ref":"#/components/schemas/AccountType"},"accountNumber":{"$ref":"#/components/schemas/AccountNumber"},"premiseType":{"$ref":"#/components/schemas/PremiseTypeCode"},"stopDate":{"type":"string","format":"date","nullable":true},"person":{"$ref":"#/components/schemas/Person"},"business":{"$ref":"#/components/schemas/Business"}}},"Accounts":{"description":"a collection of accounts","type":"array","items":{"$ref":"#/components/schemas/Account"}},"AccountAddress":{"description":"an address within Miami-Dade County","type":"object","properties":{"address1":{"$ref":"#/components/schemas/AddressStreet"},"address2":{"$ref":"#/components/schemas/AddressStreet"},"address3":{"$ref":"#/components/schemas/AddressStreet"},"city":{"$ref":"#/components/schemas/AddressCity"},"state":{"$ref":"#/components/schemas/AddressStateCode"},"zip":{"$ref":"#/components/schemas/ZipCode"},"country":{"$ref":"#/components/schemas/CountryCode"},"county":{"$ref":"#/components/schemas/AddressCounty"}}},"AccountNumber":{"description":"a WASD account ID in the form of a ten digit string","type":"string","minLength":10,"maxLength":10,"pattern":"^[0-9]{10}$"},"AccountStatus":{"description":"the status of the account, e.g. one of 'PENDING', 'ACTIVE', 'PENDING STOP', or 'CLOSED'","type":"string","enum":["PENDING","ACTIVE","PENDING STOP","CLOSED"]},"AccountType":{"description":"an account type, e.g. 'NEW BUSINESS'","type":"string","enum":["NORMAL","PLC","PLCS","SEPTIC","NEW BUSINESS"]},"ACHDonation":{"type":"object","properties":{"fundingToken":{"$ref":"#/components/schemas/FundingToken"},"requestedPaymentDate":{"type":"string","format":"date"},"amount":{"type":"number","multipleOf":0.01},"emailAddress":{"description":"an email address","type":"string","format":"email"}},"required":["fundingToken","requestedPaymentDate","amount","emailAddress"]},"ACHDonationConfirmation":{"type":"object","properties":{"confirmationNumber":{"$ref":"#/components/schemas/ConfirmationNumber"},"paymentAmount":{"$ref":"#/components/schemas/PaymentAmount"},"paymentFee":{"$ref":"#/components/schemas/PaymentFee"},"paymentDate":{"type":"string","format":"date"}},"required":["confirmationNumber","paymentAmount","paymentFee","paymentDate"]},"ACHFundingPortal":{"description":"a collection of ACH funding portal URLs","type":"object","required":["successUrl","failureUrl","timeOutUrl"],"properties":{"successUrl":{"type":"string","format":"uri"},"failureUrl":{"type":"string","format":"uri"},"timeOutUrl":{"type":"string","format":"uri"}}},"ACHFundingPortalConfirmation":{"type":"object","required":["accountNumber","fundingUrl"],"properties":{"accountNumber":{"$ref":"#/components/schemas/AccountNumber"},"fundingUrl":{"type":"string","format":"uri"}}},"ACHFundingSourceAddedConfirmation":{"description":"an ACH funding source added confirmation","type":"object","required":["fundingAccountNickname","fundingSubType","id","maskedFundingAccount","singleUse"],"properties":{"fundingAccountNickname":{"type":"string"},"fundingSubType":{"type":"string"},"id":{"type":"string"},"maskedFundingAccount":{"type":"string"},"singleUse":{"type":"string"}}},"ACHFundingSourceAddition":{"description":"bank account funding source details","type":"object","required":["accountHolderName","accountNickName","accountState","accountType","accountZip","bankAccountNumber","routingNumber","singleUse"],"properties":{"accountHolderName":{"type":"string"},"accountNickName":{"type":"string"},"accountState":{"type":"string"},"accountType":{"type":"string"},"accountZip":{"$ref":"#/components/schemas/ZipCode"},"bankAccountNumber":{"type":"string"},"routingNumber":{"type":"string"},"singleUse":{"type":"boolean"}}},"ACHFundingSourceToken":{"description":"an ACH funding source token details","type":"object","required":["fundingAccountNickname","fundingDate","fundingSubType","id","maskedFundingAccount","singleUse"],"properties":{"fundingAccountNickname":{"type":"string","nullable":true},"fundingDate":{"type":"string","nullable":true},"fundingSubType":{"type":"string"},"id":{"type":"string"},"isAttachedToAutoPay":{"type":"boolean"},"isAttachedToProfileId":{"type":"boolean"},"maskedFundingAccount":{"type":"string"},"singleUse":{"type":"string"}}},"ACHFundingSourceTokens":{"type":"array","items":{"$ref":"#/components/schemas/ACHFundingSourceToken"}},"ACHPayment":{"type":"object","description":"an ACH payment","properties":{"fundingToken":{"$ref":"#/components/schemas/FundingToken"},"requestedPaymentDate":{"type":"string","format":"date"},"amount":{"type":"number","multipleOf":0.01},"donationAmount":{"$ref":"#/components/schemas/DonationAmount"},"emailAddress":{"description":"an email address","type":"string","format":"email"}},"required":["amount","donationAmount","emailAddress","fundingToken","requestedPaymentDate"]},"ACHPaymentConfirmation":{"description":"an ACH payment confirmation details","type":"object","required":["confirmationNumber","paymentAmount","paymentFee","paymentDate","donationAmount","totalPaymentAmount"],"properties":{"confirmationNumber":{"$ref":"#/components/schemas/ConfirmationNumber"},"donationAmount":{"$ref":"#/components/schemas/DonationAmount"},"paymentAmount":{"$ref":"#/components/schemas/PaymentAmount"},"paymentDate":{"type":"string","format":"date"},"paymentFee":{"$ref":"#/components/schemas/PaymentFee"},"totalPaymentAmount":{"$ref":"#/components/schemas/PaymentAmount"}}},"ACHPendingPaymentItem":{"description":"an ACH pending payment item","type":"object","required":["paymentFee","confirmationNumber","requestedPaymentDate","fundingType","paymentCreatedDate","payerName","paymentDate","paymentAmount","paymentStatus"],"properties":{"confirmationNumber":{"$ref":"#/components/schemas/ConfirmationNumber"},"fundingType":{"type":"string"},"payerName":{"type":"string"},"paymentAmount":{"$ref":"#/components/schemas/PaymentAmount"},"paymentCreatedDate":{"type":"string","format":"date"},"paymentDate":{"type":"string","format":"date"},"paymentFee":{"$ref":"#/components/schemas/PaymentFee"},"paymentStatus":{"type":"string"},"requestedPaymentDate":{"type":"string","format":"date"}}},"ACHPendingPayments":{"description":"a collection of ACH pending payment items","type":"array","items":{"$ref":"#/components/schemas/ACHPendingPaymentItem"}},"ACHPaymentRequest":{"description":"an ACH payment request","type":"object","required":["fundingToken","amount","requestedPaymentDate","emailAddress","donationAmount"],"properties":{"amount":{"type":"number","multipleOf":0.01},"donationAmount":{"$ref":"#/components/schemas/DonationAmount"},"emailAddress":{"type":"string","format":"email"},"fundingToken":{"$ref":"#/components/schemas/FundingToken"},"requestedPaymentDate":{"type":"string"}}},"ACHPendingPaymentsRequest":{"type":"object","properties":{"paymentDateFrom":{"type":"string","format":"date"},"paymentDateTo":{"type":"string","format":"date"}},"required":["paymentDateFrom","paymentDateTo"]},"ACIPayment":{"description":"an ACI payment","type":"object","required":["paymentFee","confirmationNumber","requestedPaymentDate","fundingType","paymentCreatedDate","payerName","paymentDate","paymentAmount","paymentStatus"],"properties":{"confirmationNumber":{"$ref":"#/components/schemas/ConfirmationNumber"},"fundingType":{"type":"string"},"payerName":{"type":"string"},"paymentAmount":{"$ref":"#/components/schemas/PaymentAmount"},"paymentCreatedDate":{"type":"string"},"paymentDate":{"type":"string"},"paymentFee":{"$ref":"#/components/schemas/PaymentFee"},"paymentStatus":{"type":"string"},"requestedPaymentDate":{"type":"string"}}},"ACIPayments":{"description":"a collection of ACI payments","type":"object","required":["paymentDateTo","payments","paymentDateFrom","accountNumber"],"properties":{"accountNumber":{"$ref":"#/components/schemas/AccountNumber"},"paymentDateTo":{"type":"string"},"paymentDateFrom":{"type":"string"},"payments":{"type":"array","items":{"$ref":"#/components/schemas/ACIPayment"},"uniqueItems":true}}},"Address":{"description":"a physical street address","type":"object","required":["address1","address2","city","state","zip","county","country"],"properties":{"address1":{"$ref":"#/components/schemas/AddressStreet"},"address2":{"$ref":"#/components/schemas/AddressStreet"},"address3":{"$ref":"#/components/schemas/AddressStreet"},"city":{"$ref":"#/components/schemas/AddressCity"},"state":{"$ref":"#/components/schemas/AddressStateCode"},"zip":{"$ref":"#/components/schemas/AddressZip"},"county":{"$ref":"#/components/schemas/AddressCounty"},"country":{"$ref":"#/components/schemas/CountryCode"}}},"AddressCity":{"description":"the name of the city that the street address is in","type":"string","maxLength":34},"AddressCountryCode":{"type":"object","properties":{"description":{"type":"string","example":"an address country code in ISO format, e.g. 'USA'"},"type":{"type":"string","example":"USA"},"minLength":{"type":"number","example":3},"maxLength":{"type":"number","example":3}}},"AddressCountryName":{"type":"object","properties":{"description":{"type":"string","example":"the formal name of a country, e.g. 'United States'"},"type":{"type":"string","example":"United States"}}},"AddressCounty":{"description":"the name of the county that the street address is in","type":"string","maxLength":0,"nullable":true},"AddressStateCode":{"description":"a two character state code, e.g. 'FL', or the 'N\\A' value","type":"string","minLength":2,"maxLength":3,"example":"FL"},"AddressState":{"type":"object","required":["code","name"],"properties":{"code":{"$ref":"#/components/schemas/AddressStateCode"},"name":{"$ref":"#/components/schemas/AddressStateName"}},"nullable":true},"AddressStates":{"description":"a collection of state codes and names","type":"array","items":{"$ref":"#/components/schemas/AddressState"}},"AddressStateName":{"description":"the formal name of a state code, e.g. 'Florida'","type":"string","example":"Florida"},"AddressStreet":{"description":"a whole or partial street address","type":"string","maxLength":100,"nullable":true,"example":"3071 SW 38th Ave"},"AddressZip":{"description":"a postal code used by the United States Postal Service (USPS)","type":"string","minLength":5,"maxLength":5,"pattern":"^[0-9]{5}$"},"AdjustmentType":{"type":"object","properties":{"description":{"type":"string","example":"an adjustment type (too many to enumerate)"},"type":{"type":"string","example":"RWT-LATE","description":"description of an adjustment type"}}},"Adjustment":{"type":"object","properties":{"amount":{"type":"number","example":0.01},"description":{"type":"string","example":"Late Payment Fee"},"type":{"type":"string","example":"RWT-LATE"}}},"AvailableDates":{"description":"a collection of business days available for reconnect scheduling, in YYYY-MM-DD format","type":"array","items":{"type":"string","format":"date"},"nullable":true},"BadgeNumber":{"description":"a meter badge identifier","type":"string","pattern":"^[a-zA-Z0-9]*$"},"BillAdjustmentItem":{"description":"miscellaneous credit or charges on bill","type":"object","required":["type","amount","description"],"properties":{"type":{"$ref":"#/components/schemas/BillAdjustmentType"},"amount":{"description":"the currency amount of the adjustment","type":"number","multipleOf":0.01,"example":99.99},"description":{"description":"a description of the adjustment","type":"string"}}},"BillAdjustments":{"description":"a collection of any miscellaneous credit or charges on bill","type":"array","items":{"$ref":"#/components/schemas/BillAdjustmentItem"},"nullable":true},"BillAdjustmentType":{"type":"object","properties":{"description":{"type":"string","example":"a bill adjustment type"},"type":{"type":"string","example":"``"}}},"BillItem":{"description":"a bill item","type":"object","required":["amountDue","routeSeqNo","pdfAvailable","adjustments","billSegments","pastDueDate","dateTo","rank","billDate","id","dateFrom","currentCharges"],"properties":{"adjustments":{"$ref":"#/components/schemas/BillAdjustments"},"amountDue":{"description":"the currency amount due","type":"number","multipleOf":0.01,"example":1206.07},"billDate":{"type":"string","example":"2025-12-14"},"billSegments":{"$ref":"#/components/schemas/BillSegments"},"currentCharges":{"description":"the currency amount of the current charges","type":"number","multipleOf":0.01,"example":1206.07},"dateFrom":{"type":"string","example":"2025-09-08"},"dateTo":{"type":"string","example":"2025-12-06"},"id":{"$ref":"#/components/schemas/BillId"},"pastDueDate":{"type":"string","example":"2025-01-04"},"pdfAvailable":{"type":"boolean","default":false},"rank":{"type":"number","minimum":1,"example":1},"routeSeqNo":{"$ref":"#/components/schemas/RouteSequenceNumber"}}},"Bills":{"description":"a collection of bill items","type":"array","items":{"$ref":"#/components/schemas/BillItem"},"nullable":true},"BillExtensionDetails":{"description":"bill extension details","type":"object","properties":{"accountBalance":{"description":"this accounts current balance","type":"number","multipleOf":0.01,"example":100.99},"billDate":{"description":"the date of this bill","type":"string","format":"date","example":"2025-04-01"},"billDueMessageCodes":{"description":"CCB message number for returned messages","type":"string","example":"88888"},"currentBillAmount":{"description":"the amount of the latest bill","type":"number","multipleOf":0.01,"example":100},"extensionDate":{"description":"the end date of this extension","type":"string","format":"date","example":"2025-04-01"},"extnAccountBalance":{"description":"required balance to obtain this extension","type":"number","example":100.01},"latePaymentFee":{"description":"fee charged when payment is late","type":"string","example":"15.00"},"numberOfExtensions":{"description":"number of extensions already requested for this bill","type":"string","example":"1"},"prevExtensionDate":{"description":"the end date of the previous extension","type":"string","format":"date","example":"2025-04-01"},"prevExtensionGrantedDate":{"description":"the grant date of the previous extension","type":"string","format":"date","example":"2025-04-01"}},"required":["latePaymentFee","prevExtensionDate","prevExtensionGrantedDate","billDueMessageCodes","currentBillAmount","extnAccountBalance","numberOfExtensions","billDate","extensionDate","accountBalance"]},"BillExtensionConfirmation":{"type":"object","properties":{"acctBalVerified":{"description":"account balance verified","type":"boolean"},"comments":{"description":"customer provided comments for field service staff","type":"string"},"contactClass":{"$ref":"#/components/schemas/ContactClass"},"contactType":{"$ref":"#/components/schemas/ContactType"},"grantExtension":{"$ref":"#/components/schemas/GrantExtension"},"personId":{"$ref":"#/components/schemas/PersonId"}},"required":["personId","contactClass","contactType","comments","grantExtension","acctBalVerified"]},"BillFrequency":{"description":"the bill frequency, e.g. 'M' for Monthly, 'Q' for Quarterly","type":"string","enum":["M","Q"],"nullable":true},"BillId":{"description":"a bill identifier","type":"string","minLength":12,"maxLength":12,"pattern":"^[0-9]{12}$"},"BillSegmentItem":{"description":"a bill segment item","type":"object","required":["daysOfService","measuredUOM","badgeNumber","dateFrom","spId","finalRegQtyGal","toReading","finalUOMGal","dateTo","finalUOM","fromReading","measuredQty","finalRegQty","meterSize"],"properties":{"badgeNumber":{"$ref":"#/components/schemas/BadgeNumber"},"dateFrom":{"description":"start date of service on bill segment","type":"string","example":"2025-09-08"},"dateTo":{"description":"end date of service on bill segment","type":"string","example":"2025-12-06"},"daysOfService":{"description":"duration of service on bill in days","type":"integer","example":89},"finalRegQty":{"description":"final registered quantity","type":"integer","example":74052},"finalRegQtyGal":{"description":"final registered reading in gallons","type":"integer","example":99},"finalUOM":{"description":"final unit of measure in CCFs (Centum Cubic Feet)","type":"string","default":"CCF"},"finalUOMGal":{"$ref":"#/components/schemas/UOMGal"},"fromReading":{"description":"starting register read","type":"integer","example":1837},"measuredQty":{"description":"measured quantity","type":"integer","example":99},"measuredUOM":{"description":"unit of mesaure in CFWs (Cubic Feet of Water) of the meter register","type":"string","default":"CFW"},"meterSize":{"description":"meter size in inches","type":"string","example":"5/8\""},"spId":{"$ref":"#/components/schemas/SpId"},"toReading":{"description":"ending register read","type":"integer","example":1936}}},"BillSegments":{"description":"a collection of bill segment items","type":"array","items":{"$ref":"#/components/schemas/BillSegmentItem"},"nullable":true},"BillingAddress":{"description":"a billing address item","type":"object","required":["billingAddress"],"properties":{"billingAddress":{"type":"object","required":["sameAsPremise","country","address1","address2","address3","city","state","zip","county"],"properties":{"sameAsPremise":{"type":"boolean"},"address1":{"$ref":"#/components/schemas/AddressStreet"},"address2":{"$ref":"#/components/schemas/AddressStreet"},"address3":{"$ref":"#/components/schemas/AddressStreet"},"city":{"$ref":"#/components/schemas/AddressCity"},"state":{"$ref":"#/components/schemas/AddressStateCode"},"zip":{"$ref":"#/components/schemas/BillingAddressPostalCode"},"county":{"$ref":"#/components/schemas/AddressCounty"},"country":{"$ref":"#/components/schemas/CountryCode"}}}}},"BillingAddressPostalCode":{"description":"an address postal code, e.g. USA or Canada","oneOf":[{"$ref":"#/components/schemas/USAPostalCode"},{"$ref":"#/components/schemas/CANPostalCode"}]},"BlockedDates":{"description":"a collections of non business dates that can not be used for field activities","type":"array","items":{"type":"string","format":"date"},"nullable":true},"Business":{"description":"an enrollment business entity and their identifiers","type":"object","required":["id","entityName"],"properties":{"id":{"$ref":"#/components/schemas/BusinessId"},"entityName":{"$ref":"#/components/schemas/EntityName"},"email":{"description":"an email address","type":"string","format":"email"},"identifications":{"$ref":"#/components/schemas/Identifications"}}},"BusinessEntity":{"type":"object","required":["id","entityName"],"properties":{"id":{"$ref":"#/components/schemas/BusinessId"},"entityName":{"$ref":"#/components/schemas/EntityName"},"email":{"description":"an email address","type":"string","format":"email"}}},"BusinessId":{"description":"a WASD business identifier in the form of a ten digit string","type":"string","minLength":10,"maxLength":10,"pattern":"^[0-9]{10}$"},"CANPostalCode":{"description":"a Canadian postal code","type":"string","pattern":"/^[ABCEGHJ-NPRSTVXY][0-9][ABCEGHJ-NPRSTV-Z] [0-9][ABCEGHJ-NPRSTV-Z][0-9]$/"},"CancelCaseConfirmation":{"description":"a cancel case response","type":"object","required":["isCancelled","cancelledDate","messages","caseId"],"properties":{"isCancelled":{"description":"is the cancellation successful","type":"boolean"},"cancelledDate":{"description":"the date when user requested the cancellation of this case","type":"string","nullable":true},"messages":{"$ref":"#/components/schemas/Messages"},"caseId":{"$ref":"#/components/schemas/CaseId"}}},"CancelPendingPaymentConfirmation":{"description":"a cancel pending payment confirmation","type":"object","required":["accountNumber","confirmationNumber"],"properties":{"accountNumber":{"$ref":"#/components/schemas/AccountNumber"},"confirmationNumber":{"$ref":"#/components/schemas/ConfirmationNumber"}}},"CaseId":{"description":"a case confirmation number","type":"string","minLength":10,"maxLength":10,"nullable":true,"pattern":"^[0-9]{10}$","example":"0123456789"},"CaseStatus":{"description":"the status of a case","type":"string","enum":["ACTIVE","APPROVAL","APPROVED","CANCELED","CHECK FA","CLOSED","CLSD-RBLL","DENIED","DENIED-LTR","DET POOL TYP","ELIGIBLE","ELIGIBLE-SM","FA WORK SM","FA WORKING","FAILURE","GEN FA","GEN MR","OVERRIDE","PENDING","POST AUDIT","POST DATE","PYMNT REQD","QUESTIONS","READ MISSED","START","SUCCESS"]},"CaseType":{"description":"the type of the case, e.g. 'Pool Credit Request', 'High Bill Investigation Request'","type":"string","enum":["Customer Call-In","High Bill Investigation Request","Pool Credit Request","Payment Extension Request","Reconnect"]},"Cases":{"description":"a collection of cases","type":"array","items":{"type":"object","properties":{"caseType":{"$ref":"#/components/schemas/CaseType"},"confirmationNumber":{"$ref":"#/components/schemas/ConfirmationNumber"},"caseStatus":{"$ref":"#/components/schemas/CaseStatus"},"requestedDate":{"description":"the date when the case was created","type":"string","format":"date"},"fillDate":{"description":"the date when a customer's pool was last filled","type":"string","format":"date"},"denialReason":{"description":"reason why a case would be denied eligibility","type":"string","nullable":true}},"required":["caseType","confirmationNumber","caseStatus","requestedDate","denialReason"]}},"CCBConfiguration":{"description":"data returned by the operation","type":"object","properties":{"aciPaymentFee":{"description":"the fee that is charged when a user uses ACI to make a payment","$ref":"#/components/schemas/PaymentFee"},"contactInfoPhoneNumber":{"$ref":"#/components/schemas/ContactPhoneNumberMetadata"},"poolDepthConstant":{"description":"volume used in pool volume calculation","type":"number","multipleOf":0.01},"countries":{"$ref":"#/components/schemas/Countries"}},"required":["aciPaymentFee","contactInfoPhoneNumber","poolDepthConstant","countries"]},"CcId":{"description":"a customer contact id, or some features this as a confirmation numbers","type":"string","minLength":10,"maxLength":10,"pattern":"^[0-9]{10}$"},"CCDonation":{"description":"a credit card donation payment","type":"object","properties":{"fundingToken":{"$ref":"#/components/schemas/FundingToken"},"requestedPaymentDate":{"type":"string","format":"date"},"amount":{"type":"number","multipleOf":0.01},"emailAddress":{"description":"an email address","type":"string","format":"email"}},"required":["fundingToken","requestedPaymentDate","amount","emailAddress"]},"CCDonationConfirmation":{"description":"a credit card donation payment confirmation","type":"object","properties":{"confirmationNumber":{"$ref":"#/components/schemas/ConfirmationNumber"},"paymentAmount":{"$ref":"#/components/schemas/PaymentAmount"},"paymentFee":{"$ref":"#/components/schemas/PaymentFee"},"paymentDate":{"type":"string","format":"date"}},"required":["confirmationNumber","paymentAmount","paymentFee","paymentDate"]},"CCFundingPortal":{"description":"a collection of credit card funding portal URLs","type":"object","required":["successUrl","failureUrl","timeOutUrl"],"properties":{"successUrl":{"type":"string","format":"uri"},"failureUrl":{"type":"string","format":"uri"},"timeOutUrl":{"type":"string","format":"uri"}}},"CCFundingPortalConfirmation":{"description":"a credit card funding portal confirmation item","type":"object","required":["accountNumber","fundingUrl"],"properties":{"accountNumber":{"$ref":"#/components/schemas/AccountNumber"},"fundingUrl":{"type":"string","format":"uri"}}},"CCFundingSourceToken":{"description":"a credit card funding source token item","type":"object","required":["fundingAccountNickname","expiryDate","fundingSubType","id","maskedFundingAccount","singleUse"],"properties":{"fundingAccountNickname":{"type":"string","nullable":true},"fundingDate":{"type":"string","nullable":true},"fundingSubType":{"type":"string"},"id":{"type":"string"},"maskedFundingAccount":{"type":"string"},"singleUse":{"type":"string"}}},"CCFundingSourceTokens":{"description":"a collection of credit card funding source tokens","type":"array","items":{"$ref":"#/components/schemas/CCFundingSourceToken"},"nullable":true},"CCFundingSources":{"description":"a collection of credit card funding source token items","type":"object","required":["accountNumber","tokens"],"properties":{"accountNumber":{"$ref":"#/components/schemas/AccountNumber"},"tokens":{"$ref":"#/components/schemas/CCFundingSourceTokens"}}},"CCFundingSourceAddedConfirmation":{"description":"a credit card funding source added confirmation item","type":"object","required":["fundingAccountNickname","fundingSubType","id","maskedFundingAccount","singleUse","expiryDate"],"properties":{"expiryDate":{"type":"string"},"fundingAccountNickname":{"type":"string"},"fundingSubType":{"type":"string"},"id":{"type":"string","pattern":"^[0-9a-f]+$"},"maskedFundingAccount":{"type":"string"},"singleUse":{"type":"string"}}},"CCFundingSourceAddition":{"description":"a credit card funding source addition","type":"object","required":["accountHolderName","fundingUrl","accountState","accountZip","cardNumber","expirationMonth","expirationYear","securityCode"],"properties":{"accountHolderName":{"type":"string"},"accountNickName":{"type":"string"},"accountState":{"type":"string"},"accountZip":{"$ref":"#/components/schemas/ZipCode"},"cardNumber":{"type":"string"},"expirationMonth":{"type":"string"},"expirationYear":{"type":"string"},"securityCode":{"type":"string"},"singleUse":{"type":"string"}}},"CCPaymentRequest":{"description":"a credit card payment request","type":"object","required":["fundingToken","amount","requestedPaymentDate","emailAddress","donationAmount"],"properties":{"amount":{"type":"number","multipleOf":0.01},"donationAmount":{"$ref":"#/components/schemas/DonationAmount"},"emailAddress":{"type":"string","format":"email","nullable":true},"fundingToken":{"$ref":"#/components/schemas/FundingToken"},"requestedPaymentDate":{"type":"string"}}},"CCPendingPaymentsRequest":{"type":"object","properties":{"paymentDateFrom":{"type":"string","format":"date"},"paymentDateTo":{"type":"string","format":"date"}},"required":["paymentDateFrom","paymentDateTo"]},"CCIEligibility":{"description":"a submeter service request eligibility details","type":"object","required":["isAccountEligible","accountNumber","premiseId","ineligibleReasons"],"properties":{"accountNumber":{"$ref":"#/components/schemas/AccountNumber"},"ineligibleReasons":{"$ref":"#/components/schemas/IneligibleReasons"},"isAccountEligible":{"type":"boolean"},"premiseId":{"$ref":"#/components/schemas/PremiseId"}}},"CCIConfirmation":{"description":"a submeter update confirmation details","type":"object","required":["accountNumber","cciReads"],"properties":{"accountNumber":{"$ref":"#/components/schemas/AccountNumber"},"cciReads":{"type":"array","items":{"type":"object","required":["badgeNumber","locationDetails","isReadSubmitted","confirmationNumber","submitDate","submittedReading","messages"],"properties":{"badgeNumber":{"$ref":"#/components/schemas/BadgeNumber"},"confirmationNumber":{"$ref":"#/components/schemas/ConfirmationNumber"},"isReadSubmitted":{"type":"boolean"},"locationDetails":{"type":"string"},"messages":{"$ref":"#/components/schemas/Messages"},"previousReading":{"type":"integer","nullable":true},"submitDate":{"type":"string","nullable":true},"submittedReading":{"description":"submitted meter reading value","type":"integer","nullable":true}}}}}},"CCIRead":{"type":"object","required":["badgeNumber","locationDetails","isReadSubmitted","confirmationNumber","submitDate","submittedReading","messages"],"properties":{"badgeNumber":{"$ref":"#/components/schemas/BadgeNumber"},"confirmationNumber":{"$ref":"#/components/schemas/ConfirmationNumber"},"isReadSubmitted":{"type":"boolean"},"locationDetails":{"type":"string"},"messages":{"$ref":"#/components/schemas/Messages"},"submitDate":{"type":"string","nullable":true},"submittedReading":{"description":"submitted meter reading value","type":"integer","minimum":0,"maximum":999999,"nullable":true}}},"CCIReads":{"description":"a collection of CCI submeter reads","type":"array","items":{"$ref":"#/components/schemas/CCIRead"}},"CCIMeterReadItem":{"description":"a submeter read item","type":"object","required":["readDate","readType","meterReading"],"properties":{"readDate":{"type":"string","format":"date"},"readType":{"$ref":"#/components/schemas/MeterReadingType"},"meterReading":{"$ref":"#/components/schemas/MeterReading"}}},"CCIMeterReads":{"description":"a collections of meter reads","type":"array","items":{"$ref":"#/components/schemas/CCIMeterReadItem"}},"CCIReadWindow":{"description":"a submeter read window","type":"object","required":["index","startDate","endDate"],"properties":{"index":{"type":"number","enum":[-3,-2,-1,0,1,2,3]},"startDate":{"type":"string","format":"date"},"endDate":{"type":"string","format":"date"}}},"CCIReadWindows":{"description":"a collection of submeter read windows","type":"object","required":["readWindows"],"properties":{"readWindows":{"description":"a collection of meter read windows","type":"array","items":{"$ref":"#/components/schemas/CCIReadWindow"}}}},"CCISubmeter":{"description":"a submeter","type":"object","required":["meterConfigurationId","meterId","spId","badgeNumber","type","size","route","location","locationDetails","meterDigits","messages","meterReads","temporaryRead"],"properties":{"meterConfigurationId":{"$ref":"#/components/schemas/MeterConfigurationId"},"meterId":{"$ref":"#/components/schemas/MeterId"},"spId":{"$ref":"#/components/schemas/SpId"},"badgeNumber":{"$ref":"#/components/schemas/BadgeNumber"},"type":{"description":"a meter type code","type":"string"},"size":{"description":"a meter type description","type":"string"},"route":{"description":"route code","type":"string"},"location":{"$ref":"#/components/schemas/Location"},"locationDetails":{"description":"the location where a submeter is located on the property","type":"string"},"meterDigits":{"description":"the number of digits a meter displays","type":"number","minimum":4,"maximum":6},"messages":{"$ref":"#/components/schemas/Messages"},"meterReads":{"$ref":"#/components/schemas/CCIMeterReads"},"temporaryRead":{"$ref":"#/components/schemas/CCIMeterReadItem"}}},"CCISubmeters":{"description":"a collection of submeters","type":"object","required":["submeters"],"properties":{"submeters":{"type":"array","items":{"$ref":"#/components/schemas/CCISubmeter"}}}},"CCISubmeterReading":{"description":"a submeter reading","type":"object","required":["accountNumber","meterConfigurationId","messages","meterReads","temporaryRead"],"properties":{"accountNumber":{"$ref":"#/components/schemas/AccountNumber"},"meterConfigurationId":{"$ref":"#/components/schemas/MeterConfigurationId"},"messages":{"$ref":"#/components/schemas/Messages"},"meterReads":{"$ref":"#/components/schemas/CCIMeterReads"},"temporaryRead":{"$ref":"#/components/schemas/CCIMeterReadItem"}}},"CCISubmeterReadings":{"description":"a collection of submeter readings","type":"object","required":["submeters","accountNumber"],"properties":{"accountNumber":{"$ref":"#/components/schemas/AccountNumber"},"submeters":{"type":"array","items":{"$ref":"#/components/schemas/CCISubmeterReading"},"nullable":true}}},"CCISubmeterUpdate":{"description":"a submeter reading update","type":"object","required":["meterConfigurationId","meterReading"],"properties":{"meterConfigurationId":{"$ref":"#/components/schemas/MeterConfigurationId"},"meterReading":{"type":"number","minimum":0,"maximum":999999}}},"CCISubmeterUpdates":{"description":"a collection of submeter reading updates","type":"object","required":["meters"],"properties":{"meters":{"type":"array","items":{"$ref":"#/components/schemas/CCISubmeterUpdate"},"nullable":true}}},"CCPaymentConfirmation":{"description":"a credit card payment confirmation","type":"object","required":["confirmationNumber","donationAmount","paymentAmount","paymentDate","paymentFee","totalPaymentAmount"],"properties":{"confirmationNumber":{"$ref":"#/components/schemas/ConfirmationNumber"},"paymentAmount":{"$ref":"#/components/schemas/PaymentAmount"},"paymentFee":{"$ref":"#/components/schemas/PaymentFee"},"paymentDate":{"type":"string","format":"date"},"donationAmount":{"$ref":"#/components/schemas/DonationAmount"},"totalPaymentAmount":{"$ref":"#/components/schemas/PaymentAmount"}}},"CCPendingPaymentItem":{"description":"a credit card pending payment","type":"object","required":["confirmationNumber","fundingType","payerName","paymentAmount","paymentCreatedDate","paymentDate","paymentFee","paymentStatus","requestedPaymentDate"],"properties":{"confirmationNumber":{"$ref":"#/components/schemas/ConfirmationNumber"},"fundingType":{"type":"string"},"payerName":{"type":"string"},"paymentAmount":{"$ref":"#/components/schemas/PaymentAmount"},"paymentCreatedDate":{"type":"string"},"paymentDate":{"type":"string","format":"date"},"paymentFee":{"$ref":"#/components/schemas/PaymentFee"},"paymentStatus":{"type":"string"},"requestedPaymentDate":{"type":"string","format":"date"}}},"CCPendingPayments":{"description":"a collection of pending credit card payments","type":"array","items":{"$ref":"#/components/schemas/CCPendingPaymentItem"}},"ConfirmationNumber":{"description":"a case confirmation number","type":"string","minLength":10,"maxLength":10,"pattern":"^[0-9]{10}$","nullable":true},"ContactClass":{"description":"customer contact class","type":"string","example":["1XLT","311","311S","ACH","AMIP","APPT","BFW","BILL","C&C","CASH","CLTR","CNSF","COLL","COLW","COMM","CR","CRSS","CSHL","CSSS","CT","CUST","DCRP","DEV","DIST","DONA","ESCH","FB","FL","FLTM","FOU","GEN","HEAR","HI4F","IVM","IVR","LIEN","LS","MASS","MRC","MRE","MRF","MS","NBPA","NBU","NBWI","OUT","PAUD","PND","POOL","POR","QC","RECW","RTE","SEPT","SPCL","SUBM","SUBU","SUPC","SUSA","SVCM","SVCP","SVCW","SVLN","SVLW","SVS","SWCO","SWR","SYSU","TAMP","UGL","VAND","WAT","WEBM","WEBS","WO"]},"ContactType":{"description":"customer contact type","type":"string","example":["1LIFE FORM","1XLIFE APRVD","1XLIFE DENY","1XLIFELIGIBL","1XLIFEREQREC","1XLT REBILL","24HR CERT PH","24HR CERT WI","24HR CERTFAX","24HR PICK-UP","24HR RECEIVD","2PAY IN 5DAY","311 BAL INQ","311 EXT DENY","311 INFO","311 PYMT EXT","311 START","311 STOP","311 TRANSFER","311 X-BILINQ","311 X-G/LRST","311 X-LIEN","311 X-PYMTEX","311 X-RECON","311 X-TMPR","311 X-UGL","48HRCALLFOLU","ACCT PROB","ACCT PROBLEM","ACCT WORKED","ACTIVE METER","ACTIVE MTR","ADMIN HRG","AMI PROJ 1","AMI PROJ 2","ANSWRNG MCH","AP REF NOTE","APPOINTMENT","APPT SVC VER","APT NUMBER","ASSIST REP","ASSISTEDEMP","ASST DIR","AST BRANCHES","AST OTHER","AST REP","AST SUPV","ATTEMPTED ??","ATTORNEY LTR","BACKFLOW","BALANCE INQ","BALANCE XFER","BANK DIS TRN","BANK DISMISS","BANK RESRCH","BANKRUPT","BANKRUPTCY","BENCH TEST","BFW-FINALWRN","BFW-HRS","BFW-INITWRN","BILL ADD SRC","BILL ADJ","BILL ADJ INQ","BILL ADJ OLD","BILL INQ","BILL INQUIRY","BILL PRINT","BILL STATEMT","BILLING INQ","BILLING STMT","BILLS RET MR","BKLT CREOLE","BKLT ENGLISH","BKLT NONE","BKLT SPANISH","BKN PA TERM","BKRTCY","BKRTCY DCHGD","BKRTCY DMISD","BKRTCY INFO","BKRTCY PNDG","BKRTCY STLDM","BKRTCY-PACER","BRKN PIPE","BROKEN PA","BROKEN PA MT","BROKEN PAY","BROKN VERBAL","CALL BACK","CALLDCONTACT","CALLED CUST","CC INFO REQ","CCB CORR","CCI","CCI REMOVAL","CCI-ADD","CCI-MISSREAD","CDINTHBLTR","CERTIFIED TS","CHECK READ","CHG ACT DATE","CHG INFO","CHK INFO REQ","CIT ISSUED","CITATION ACT","CK PHONE PAY","CK-4-TAMP","CLDNOCONTACT","CLERICAL SUP","CM","CM CANCEL","CM-MULT AFTR","CM-MULT REG","CM-RMSUBM","CMA","CMWSSSTOP","CNST TMP LTR","CO-OP","CO-OP COMP","CO-OP DONE","CO-OP FOL-UP","CO-OP REVIEW","COLL OR CUT","COLLECT CALL","COLLECTIONS","COM BUS LIT","COMM TMP LTR","COMMIT LTR","COMPLAINT","COMPLETED","CONFIRMATION","CONFISCATE","CONP ORANGE","CONSTRUCTION","CONSUMP INQ","CONTACT CUST","COUNTY MGR","CREDIT","CREDIT CARD","CT","CT ADJ DONE","CT DNQ","CT DROP OFF","CT LTR SENT","CT PNDG $$","CT PROVIDED","CT RCVD","CT RCVDPRO","CT REBILL","CT REQ DUP","CT REQUEST","CURRENT TENT","CUST CALL BK","CUST CALLED","CUST COMP","CUST MLG PMT","CUST REL","CUST REM","CUST REPLY","CUST SERV","CUST SURVEY","CUT-COLLECT","DADE CTY FIN","DAT NTRY ERR","DATA CLEANUP","DEACTIVATE S","DECEASED","DENY NAME CH","DEP INQ","DEP REVERSAL","DEPCONVDATE","DEPOSIT ADD","DEPOSIT INQ","DEPOSIT REMV","DERM PAYMT","DERM/HDEPT","DEV COR","DEV DEPOSIT","DEV NAME","DEV PAY COR","DIRECTOR","DISPUTERESLT","DIV CHIEF","DM","DM CANCEL","DM FIRELINE","DM MULTI","DM REQ","DM-CM","DM/CM","DM/CMA","DMFIRELINE","DMMULTI","DOOR","DROPBOX","DRPBX PAY RC","DUE DATE","DUP BILL","DUP BILL REQ","DYE TEST","E BOX","E-MAIL RCVD","E-MAIL RESP","E-PAYBILL","EBOX LTR SNT","EMP COMPL","ENROLL","EPAY OFF","EPAY ON","ERR COR","ERROR","ERRORS","ESCHEAT","ESCHEAT CHK","ESCHEAT POR","ESCHT-LTR","ESTMATE READ","EXT CLOSED","EXT DENIED","EXT ISSUED","EXT OVERRIDE","EXT PYREQD","EXTEN DENIAL","EXTEN DENIED","EXTENSION","EXTN DENIED","FA COMPLETED","FA RESEARCH","FAILED TEST","FAXED INFO","FB","FB REF CKPOR","FB RESEARCH","FINAL B-CERT","FIRE HYDR","FIRELINE","FIRELINE LTR","FIRELINES","FL OWNER","FL-LAST","FL-LIEN","FL-PAST","FL-TRAN","FLOAT METER","FLOAT MTR PD","FLOATING MR","FLOATING MTR","FM","FM BROKEN","FOL UP CRTTO","FOLLOW UP","FOLLOW-UP","FOLLOWUP","FORWD TIMEXP","FTN X REF","FTN XREF","G/L CORR","GEN MTR","GOVERNMENTAL","GOVFM-LTR","HAZARD","HAZARDOUS","HB","HB NOTIFYLTR","HBI REQAPVD","HBI REQCANC","HBI REQCLSD","HBI REQDENY","HBI REQRCVD","HEAR FOLLUP","HEAR RESC NO","HEARING","HEARING CANC","HEARING CONF","HEARING DROP","HEARING FORM","HEARING NOSH","HEARING REQ","HEARING RESC","HEARING SCH","HEARING-GEN","HEARING-LTR","HEARING/RCVD","HI2 PROCESS","HIGH 1 LTR","HIGH 4 LTR","HIGH BILL","HOLIDAY","HRG CALL CUS","HRG CANCELED","HRG CUS CALL","HRG HD DEC","HRG HD NO DE","HRG INFO MIS","HRG INQUIRY","HRG MISS PMT","HRG RCVD","HRG RESCH","HRG SCH","HRGRT CR INC","HRNG SUP APP","HYD TAMP LTR","INC ACCT NUM","INFO ONLY","INFO REQ","INFORMATION","INQUIRY","INS MTR","INSP SCHED","INSTALL BF","INSTALL SERV","INSUFFICIENT","INT SUB INSP","INVALID EMAI","INVALID PH#","INVESTI-INFO","IVR PAY INQ","JOB ORD","L REST","LAB/WTR PROD","LANDLORD","LARGE CR APR","LARGE CR FIN","LATE READING","LATE REM DEN","LEAD COPPER","LEADWORKER","LEAK","LEAK @ METER","LEAK SUB MTR","LEGAL OFC","LEGAL RETURN","LEGAL SENT","LEGAL SETTLE","LETTER","LETTERSENT","LIEN","LIEN $ COLL","LIEN B4 CONV","LIEN CR BAL","LIEN NOTICE","LIEN PA","LIEN RELEASE","LIEN SATISFD","LIFETIME CR","LISTND 2MSG","LOC/HOUR","LOI","LOI COLLECTD","LOI PHONE","LOI WALK IN","LOW PRESS","LOW PRESSURE","LS-CONFRM","LS-DENIAL","LS-INFNOTRCV","LS-INQ/RQST","LS-MISSINFO","LS-ORIGRQST","LS-REMFORM","LS-REMOVAL","LS-UPDATE","LTR CREDIT","M-B-OWNER","M-COVID19","M2Q REROUTE","MAC","MAIL","MAIL ADDRESS","MAIL RCVD","MAIL SENT","MAINT BBL","MAINT BRK CV","MAINT BRK LD","MAINT COB","MAINT DD","MAINT DMG DL","MAINTENANCE","MANHOLE","MC SUGGEST","METER CHANGE","MHCVR BROKEN","MHOF","MISAPPLY PAY","MISC","MISC PH INQ","MISC-CERT","MISC-CERT CA","MISCELLANOUS","MISS COVER","MISSING PHON","MISSING SSID","MNSF","MODIFY CM","MODIFY DM","MORA INQUIRY","MOVED NO ADD","MTR BX MAINT","MTR MAT","MTR SIZE","MTRRD DT INQ","MU-CER CA DW","MU-CERT","MU-CERT CA","MU-CERT DW","MULTI UNIT","MULTI-UNIT","MUNI CORRECT","MUST B OWNER","MUT-CERT","NAME CHANGE","NAME CHNG","NAME SPELL","NB PLAN-REV","NBU","NDINTHBLTR","NEED INFO","NEW APP","NEW APP TAKN","NEW BUS","NEW BUSINESS","NEW CONS","NEW CUST","NEW PHONE#","NEW SVC","NEW TENANT","NEWSVC","NO ACCESS","NO ACTIVE SA","NO CALL","NO CALL IN","NO CUST VALD","NO FOLLOWUP","NO MAIL BOX","NO OFF IN ST","NO PAY RPT","NO READ 1CYC","NO READ 2CYC","NO RECONNECT","NO SHOW","NO SUCH NUM#","NO SUCH ST","NO/DPT/DV/SS","NOACCESSPREM","NOL","NON CONTACTS","NON WASD","NON-CONS CON","NON-CONSOPL","NOTICE/LEVY","NSF CHG PERC","NSF ERROR","NSF FEE","NSF FLAT FEE","NSF WEB","NWNR","OFF LOC REQ","OGA","OTHER","OTHERWOFFICE","OTHRWTRSWRU","OUTLET DNQ","OUTLET REBIL","OVERPAY REFN","OVERPAYMENT","OWNER INQ","OWNER TENANT","PA CREATED","PA DENIED","PA DISCONECT","PA DOORHANG","PA ESTABLISH","PA EXPIRED","PA INQUIRY","PA LETTER","PA MLD","PA MOD APPR","PA MOD DENY","PA MOD REQ","PA MODIFY","PA PHONECALL","PA RCVD","PA REV MAIL","PA REV REC","PA SA STOP","PA SATISFIED","PA VOID NLE","PA-LTR","PACOVID CALL","PAPERLESS","PAR REF NBF","PASSWORD","PAY AGREE","PAY ARR","PAY ARR LT","PAY EXT","PAY EXT DEN","PAY LOC","PAY MIS/COR","PAYMENT ARR","PAYMENT INQ","PAYMENT PROC","PAYMENT RCVD","PAYMENT WSE","PAYOFF PHONE","PAYOFF W-I","PEN INQ","PEN REMOVAL","PENALTY INQ","PENALTY REV","PENALTY RM D","PEND REVIEW","PH CERT UPDT","PHONE CH/ADD","PHONE DISCTD","PHONE UPDATE","PHONE#UPDATE","PIL","PIL INQ","PIL LTR","PLC FAXED","PLC MAILED","PLC PAY REC","PLC REQ CANC","PMT INQUIRY","PMT ONLINE","PMT RCVD","PNDG INFO","PNDNG INFO","POBOX CLOSED","POOL","POOL CR APVD","POOL CR CLSD","POOL CR RQST","POOL CRED RQ","POOL DEN","POOL DNQ","POOL DRP OFF","POOL DUP","POOL FAXED","POOL LTR PRO","POOL PNDGINF","POOL POST DT","POOL RCVDPRO","POOL REQ","POOL REQ DUP","POOL REQRCVD","POOL SIZE ??","POOL-DENIAL","POR","POST OFF RT","POST WRG ACT","POSTED TWICE","PP ACTIVE","PP BROKEN","PP DENIED","PP INQUIRY","PP REVISED","PP SATISFIED","PRESSURE TST","PRIORITY REC","PRIVATE WELL","PRO DM","PRO DM-CM","PRO INQ","PROBATE","PT","PUBLIC WORKS","PUMP STAT","PUMP STATION","PYMNT CORR","PYMT PROCESS","Q-COVID19","Q2M REROUTE","R-FINAL BILL","R/O","RADIO SHOW","RATE CHANGE","RCN CR CLSD","RCN DNQ","RCN FACR","RCN OVERRIDE","RCN PYRQ","RCN REQRCV","RCN-FARESCH","RD MTR PNDG","RD SCH MAIL","RDG CHG","RE-CONNECT","RE-ROUTE LTR","READ METER","READ SUB-MTR","REBILL","REBILL SA SP","REC AFTER HR","REC DENIED","REC DM REG","REC DMAFTER","REC REG HR","REC WRITEOFF","RECO OK IF $","RECONNECT","RECONNECT DE","RECORD CORR","REF CANCEL","REF CK INQ","REF CK REQ","REF CK TRSF","REF NB FEES","REF NOTATION","REF TO COLL","REFUND","REFUND CK TR","REFUSED","REINSTATMEMO","REL PAST DUE","REM LATE REB","REM LATE UGL","REM MTR DEMO","REM SUB SYST","REMAILED","REMINDER LTR","REMOVE MTR","REPLACE MTR","REPORTS","REQ BKFL QRY","REQ INSP","REQ READ","REQUEST EXT","REQUIRE BKFL","REREAD","REROUTE","REROUTE NTFY","RES TAMP LTR","RET4 BETADD","RETURNED CK","RMD NOTENMLD","RMND NOTEMLD","RT CHECK INQ","RT CHECK SC","RTN","RTN CANC","RTN MOD","RTNNFO","RTNNO","SASP FIXED","SDINTHBLTR","SENT LETTER","SENT TO DCCC","SEPARATE-SVC","SEPTIC CONS","SERV VER","SERVERREQ","SERVERRESLT","SERVICE INST","SET METE DEN","SET METER","SETMTR DEN","SEWER COLL","SEWER DISP","SEWER METER","SEWER ONLY","SHOWER KIT","SHOWERHEAD","SINKHOLE","SM","SM AFTER HR","SM REG HR","SMIA G-CANS","SPAN CAL BCK","SPAN X-FER","SPECIAL PROJ","SPK W/CUST","SPOKETOCUST","SPV ESC","SS X REF","SSN CROSS","SSPHUPDT","START","STATUS","STOP","STOPPED SUBM","STORM DRAIN","STORM ERU","STORM STOP","STORMW REM","STORMWATER","STRMWATR INQ","SUB  LTR","SUB METER","SUB MTR BILL","SUB MTR INQ","SUB MTR PURC","SUB MTR SOLD","SUBUNIT REBI","SUP CALL BAC","SUP CALL BK","SUP FNL APPR","SUP FNL APR","SUPERVISOR","SUPV CALL BK","SVC CH RM DE","SVC CH RM DN","SVC CHAR","SVC CHG INQ","SVC CHG REM","SVC CHG RMVD","SVC INSPCTN","SVC VER RD","SVC VER S M","SVC VERF","SVC VERF REQ","SVC VERF RES","SWR BILL INF","SWR BU","SWR CALL OUT","SWR CON","SYSTEM ERROR","T/O FOR REP","T/O REPAIRS","TAMPCALL","TAMPERING","TERMINATION","TEST","TEST BF PROP","TEST CANCEL","TEST IVR","TEST REQUEST","TITLE CO INQ","TKN WRNG ADD","TMS","TO FOR REP","TOILET REBTE","TON AFT REP","TOOK MSG4CST","TR9819036534","TRANSFER","TRANSFER SVC","TRANSFERCALL","TROUBLE","UGL","UGL ADJ APRV","UGL ADJ DENY","UGL ADJ PRCD","UGL ADJ RCVD","UGL ADJ RQST","UGL CR POSDT","UGL DEN","UGL DNQ","UGL DROP OFF","UGL DUP","UGL DUP REQ","UGL EXT","UGL FAXED","UGL FORM LTR","UGL PDNG $$","UGL PND INFO","UGL PNDG INF","UGL PROVIDED","UGL RCVDPRO","UGL RD PNDG","UGL RECEIVED","UGL REQ","UGL-30DAYDN","UGL-DENIAL","UGL-FIN APPR","UGL-FORMRCVD","UGL-REBILL","UGL-SUP REV","UGLX RCVDPRO","UNABLE 2 FWD","UNCLAIMED","UNENROLL","UNENROLL CSR","UNENROLL WEB","UNENROLLPROG","UNKNOWN","UNLOCK","UNPRSED PYMT","UPD ADR WEB","UPD BILL PRT","UPD EMAIL","UPD EMAILWEB","UPD PH ENROL","UPD PH WEB","UPDATE CON","USAGE NOTIFY","VACANT","VAND APPVD","VAND DENIED","VAND RCVD","VAND REBILL","VAND REVIEW","VER ADD","VERBAL AGRMT","VERBAL NOTIF","VERBAL SATIS","VERIFY SRVC","VOID AP REF","VOID/REISSUE","W-9","W/O COMMENTS","WARN ISSUED","WARN NOTIFY","WASD DISP","WASD DONATE","WASHMC REBTE","WATBEXTN","WATER","WATER DISP","WATER DISTRB","WATER OFF","WATER QLTY","WATEXTNTHX","WDINTHBLTR","WEB LTR EROR","WEB LTR SENT","WEED","WHOLESALE","WRONG DEVICE","WRONG PH#","WRONG ZIPCOD","WSA","WSE BILL","WSE REBILL","WTR LEFT ON","WTR QUAL","WTR QUAL INQ","WTR QUALITY","WTR REST INQ","WTR SVC REQ","X-BNKRPTY","X-PLC","XFER $ TITLE","XFER ERROR","XFER PHN PAY","XFER TO CSVC","XFR SVC","XREF","XREF-ADV","XREF-FLTG"]},"ContactPhoneNumber":{"description":"a contact information telephone number and it's type","type":"object","required":["number","type","sequence"],"properties":{"number":{"$ref":"#/components/schemas/PhoneNumber"},"type":{"$ref":"#/components/schemas/ContactPhoneNumberType"},"sequence":{"description":"this contact information telephone number's display sequence","type":"string"},"extension":{"$ref":"#/components/schemas/PhoneNumberExtension"}}},"ContactPhoneNumbers":{"description":"a collection of contact information telephone numbers","type":"object","required":["phoneNumbers"],"properties":{"phoneNumbers":{"description":"a collection of telephone numbers","type":"array","items":{"$ref":"#/components/schemas/ContactPhoneNumber"}},"numberOfPhoneNumbers":{"description":"the number of phone numbers in the collection","type":"number","maximum":10}}},"ContactPhoneNumberMetadata":{"description":"contact information telephone number metadata","type":"object","properties":{"maximumNumberOfPhones":{"description":"the maximum number of phones that user contact information can contain","type":"integer","default":10},"phoneNumberTypes":{"description":"the different types of phones that user contact information can contain","type":"array","items":{"$ref":"#/components/schemas/ContactPhoneNumberType"}}}},"ContactPhoneNumberType":{"description":"a contact information telephone number type","type":"object","required":["code","description"],"properties":{"code":{"$ref":"#/components/schemas/ContactPhoneNumberTypeCode"},"description":{"description":"a contact information telephone number type description","type":"string","minLength":1}}},"ContactPhoneNumberTypeCode":{"description":"a contact information telephone number type identifier","type":"string","enum":["BUSINESS","CAMPUS","CELLULAR","DORMITORY","FAX","HOME","IVR","PAGER 1","PAGER 2","TELEX","WSSBUSINESS","WSSHOME","WSSMOBILE"]},"Country":{"description":"a country code per ISO-3166-1 ALPHA-3 encoding, e.g. USA","type":"string","minLength":3,"maxLength":3,"pattern":"^[A-Z]{3}$"},"CountryCode":{"description":"a country code per ISO-3166-1 ALPHA-3 encoding, e.g. USA","type":"string","minLength":3,"maxLength":3,"pattern":"^[A-Z]{3}$"},"Countries":{"description":"a collection of country codes, formal country name, and states or provinces, within the country, if applicable","type":"array","items":{"required":["code","name"],"type":"object","properties":{"code":{"$ref":"#/components/schemas/CountryCode"},"name":{"$ref":"#/components/schemas/AddressCountryName"},"states":{"type":"array","items":{"$ref":"#/components/schemas/AddressState"}}}},"example":[{"code":"USA","name":"United States","states":[{"code":"AA","name":"Armed Forces Americas NoCanada"},{"code":"AE","name":"Armed Forces AFC-CAN-EURP-MIDE"},{"code":"AK","name":"Alaska"},{"code":"AL","name":"Alabama"},{"code":"AP","name":"Armed Forces Pacific"},{"code":"AR","name":"Arkansas"},{"code":"AS","name":"American Samoa"},{"code":"AZ","name":"Arizona"},{"code":"CA","name":"California"},{"code":"CO","name":"Colorado"},{"code":"CT","name":"Connecticut"},{"code":"DC","name":"District of Columbia"},{"code":"DE","name":"Delaware"},{"code":"FL","name":"Florida"},{"code":"FM","name":"Federated States of Micronesia"},{"code":"GA","name":"Georgia"},{"code":"GU","name":"Guam"},{"code":"HI","name":"Hawaii"},{"code":"IA","name":"Iowa"},{"code":"ID","name":"Idaho"},{"code":"IL","name":"Illinois"},{"code":"IN","name":"Indiana"},{"code":"KS","name":"Kansas"},{"code":"KY","name":"Kentucky"},{"code":"LA","name":"Louisiana"},{"code":"MA","name":"Massachusetts"},{"code":"MD","name":"Maryland"},{"code":"ME","name":"Maine"},{"code":"MH","name":"Marshall Islands"},{"code":"MI","name":"Michigan"},{"code":"MN","name":"Minnesota"},{"code":"MO","name":"Missouri"},{"code":"MP","name":"Northern Mariana Islands"},{"code":"MS","name":"Mississippi"},{"code":"MT","name":"Montana"},{"code":"N/A","name":"N/A"},{"code":"NC","name":"North Carolina"},{"code":"ND","name":"North Dakota"},{"code":"NE","name":"Nebraska"},{"code":"NH","name":"New Hampshire"},{"code":"NJ","name":"New Jersey"},{"code":"NM","name":"New Mexico"},{"code":"NV","name":"Nevada"},{"code":"NY","name":"New York"},{"code":"OH","name":"Ohio"},{"code":"OK","name":"Oklahoma"},{"code":"OR","name":"Oregon"},{"code":"PA","name":"Pennsylvania"},{"code":"PR","name":"Puerto Rico"},{"code":"PW","name":"Palau"},{"code":"RI","name":"Rhode Island"},{"code":"SC","name":"South Carolina"},{"code":"SD","name":"South Dakota"},{"code":"TN","name":"Tennessee"},{"code":"TX","name":"Texas"},{"code":"UT","name":"Utah"},{"code":"VA","name":"Virginia"},{"code":"VI","name":"Virgin Islands"},{"code":"VT","name":"Vermont"},{"code":"WA","name":"Washington"},{"code":"WI","name":"Wisconsin"},{"code":"WV","name":"West Virginia"},{"code":"WY","name":"Wyoming"}]},{"code":"CAN","name":"Canada","states":[{"code":"AB","name":"Alberta"},{"code":"BC","name":"British Columbia"},{"code":"MB","name":"Manitoba"},{"code":"NB","name":"New Brunswick"},{"code":"NF","name":"Newfoundland"},{"code":"NS","name":"Nova Scotia"},{"code":"NT","name":"Northwest Territories"},{"code":"ON","name":"Ontario"},{"code":"PE","name":"Prince Edward Island"},{"code":"PQ","name":"Quebec"},{"code":"SK","name":"Saskatchewan"},{"code":"YT","name":"Yukon Territory"}]},{"code":"LBR","name":"Liberia"},{"code":"LBY","name":"Libyan Arab Jamahiriya"},{"code":"LCA","name":"Saint Lucia"},{"code":"LIE","name":"Liechtenstein"},{"code":"LKA","name":"Sri Lanka"},{"code":"LSO","name":"Lesotho"},{"code":"LTU","name":"Lithuania"},{"code":"LUX","name":"Luxembourg"},{"code":"LVA","name":"Latvia"},{"code":"MAC","name":"Macau"},{"code":"MAR","name":"Morocco"},{"code":"MCO","name":"Monaco"},{"code":"MDA","name":"Moldova, Republic of"},{"code":"MDG","name":"Madagascar"},{"code":"MDV","name":"Maldives"},{"code":"MEX","name":"Mexico"},{"code":"MHL","name":"Marshall Islands"},{"code":"MIL","name":"Use USA-States of AA, AE or AP"},{"code":"MKD","name":"Fmr Yugoslav Rep of Macedonia"},{"code":"MLI","name":"Mali"},{"code":"MLT","name":"Malta"},{"code":"MMR","name":"Myanmar"},{"code":"MNG","name":"Mongolia"},{"code":"MNP","name":"Northern Mariana Islands"},{"code":"HTI","name":"Haiti"},{"code":"HUN","name":"Hungary"},{"code":"IDN","name":"Indonesia"},{"code":"IND","name":"India"},{"code":"IOT","name":"British Indian Ocean Territory"},{"code":"IRL","name":"Ireland"},{"code":"IRQ","name":"Iraq"},{"code":"ISL","name":"Iceland"},{"code":"ISR","name":"Israel"},{"code":"ITA","name":"Italy"},{"code":"JAM","name":"Jamaica"},{"code":"JOR","name":"Jordan"},{"code":"JPN","name":"Japan"},{"code":"KAZ","name":"Kazakstan"},{"code":"KEN","name":"Kenya"},{"code":"KGZ","name":"Kyrgyzstan"},{"code":"KHM","name":"Cambodia"},{"code":"KIR","name":"Kiribati"},{"code":"KNA","name":"Saint Kitts and Nevis"},{"code":"KOR","name":"Korea, Republic of"},{"code":"KWT","name":"Kuwait"},{"code":"LAO","name":"Lao People's Democratic Rep"},{"code":"LBN","name":"Lebanon"},{"code":"FRA","name":"France"},{"code":"FRO","name":"Faroe Islands"},{"code":"FSM","name":"Micronesia, Federated States"},{"code":"GAB","name":"Gabon"},{"code":"GBR","name":"United Kingdom"},{"code":"GEO","name":"Georgia"},{"code":"GHA","name":"Ghana"},{"code":"GIB","name":"Gibraltar"},{"code":"GIN","name":"Guinea"},{"code":"GLP","name":"Guadeloupe"},{"code":"GMB","name":"Gambia"},{"code":"GNB","name":"Guinea-Bissau"},{"code":"GNQ","name":"Equatorial Guinea"},{"code":"GRC","name":"Greece"},{"code":"GRD","name":"Grenada"},{"code":"GRL","name":"Greenland"},{"code":"GTM","name":"Guatemala"},{"code":"GUF","name":"French Guiana"},{"code":"GUM","name":"Guam"},{"code":"GUY","name":"Guyana"},{"code":"HKG","name":"Hong Kong"},{"code":"HMD","name":"Heard and McDonald Islands"},{"code":"HND","name":"Honduras"},{"code":"HRV","name":"Croatia"},{"code":"COM","name":"Comoros"},{"code":"CPV","name":"Cape Verde"},{"code":"CRI","name":"Costa Rica"},{"code":"CUB","name":"Cuba"},{"code":"CXR","name":"Christmas Island"},{"code":"CYM","name":"Cayman Islands"},{"code":"CYP","name":"Cyprus"},{"code":"CZE","name":"Czech Republic"},{"code":"DEU","name":"Germany"},{"code":"DJI","name":"Djibouti"},{"code":"DMA","name":"Dominica"},{"code":"DNK","name":"Denmark"},{"code":"DOM","name":"Dominican Republic"},{"code":"DZA","name":"Algeria"},{"code":"ECU","name":"Ecuador"},{"code":"EGY","name":"Egypt"},{"code":"ERI","name":"Eritrea"},{"code":"ESH","name":"Western Sahara"},{"code":"ESP","name":"Spain"},{"code":"EST","name":"Estonia"},{"code":"ETH","name":"Ethiopia"},{"code":"FIN","name":"Finland"},{"code":"FJI","name":"Fiji"},{"code":"FLK","name":"Falkland Islands (Malvinas)"},{"code":"AUT","name":"Austria"},{"code":"AZE","name":"Azerbaijan"},{"code":"BDI","name":"Burundi"},{"code":"BEL","name":"Belgium"},{"code":"BEN","name":"Benin"},{"code":"BFA","name":"Burkina Faso"},{"code":"BGD","name":"Bangladesh"},{"code":"BGR","name":"Bulgaria"},{"code":"BHR","name":"Bahrain"},{"code":"ABW","name":"Aruba"},{"code":"AFG","name":"Afghanistan"},{"code":"AGO","name":"Angola"},{"code":"AIA","name":"Anguilla"},{"code":"ALB","name":"Albania"},{"code":"AND","name":"Andorra"},{"code":"ANT","name":"Netherlands Antilles"},{"code":"ARE","name":"United Arab Emirates"},{"code":"ARG","name":"Argentina"},{"code":"ARM","name":"Armenia"},{"code":"ASM","name":"American Samoa"},{"code":"ATA","name":"Antarctica"},{"code":"ATF","name":"French Southern Territories"},{"code":"ATG","name":"Antigua and Barbuda"},{"code":"AUS","name":"Australia"},{"code":"BHS","name":"Bahamas"},{"code":"BIH","name":"Bosnia and Herzegovina"},{"code":"BLR","name":"Belarus"},{"code":"BLZ","name":"Belize"},{"code":"BMU","name":"Bermuda"},{"code":"BOL","name":"Bolivia"},{"code":"BRA","name":"Brazil"},{"code":"BRB","name":"Barbados"},{"code":"BRN","name":"Brunei Darussalam"},{"code":"BTN","name":"Bhutan"},{"code":"BVT","name":"Bouvet Island"},{"code":"BWA","name":"Botswana"},{"code":"CAF","name":"Central African Republic"},{"code":"CCK","name":"Cocos (Keeling) Islands"},{"code":"CHE","name":"Switzerland"},{"code":"CHL","name":"Chile"},{"code":"CHN","name":"China"},{"code":"CIV","name":"Cote D'Ivoire"},{"code":"CMR","name":"Cameroon"},{"code":"COD","name":"Congo, The Democratic Republic"},{"code":"COG","name":"Congo"},{"code":"COK","name":"Cook Islands"},{"code":"COL","name":"Colombia"},{"code":"MOZ","name":"Mozambique"},{"code":"MRT","name":"Mauritania"},{"code":"MSR","name":"Montserrat"},{"code":"MTQ","name":"Martinique"},{"code":"MUS","name":"Mauritius"},{"code":"MWI","name":"Malawi"},{"code":"MYS","name":"Malaysia"},{"code":"MYT","name":"Mayotte"},{"code":"NAM","name":"Namibia"},{"code":"NCL","name":"New Caledonia"},{"code":"NER","name":"Niger"},{"code":"NFK","name":"Norfolk Island"},{"code":"NGA","name":"Nigeria"},{"code":"NIC","name":"Nicaragua"},{"code":"NIU","name":"Niue"},{"code":"NLD","name":"Netherlands"},{"code":"NOR","name":"Norway"},{"code":"NPL","name":"Nepal"},{"code":"NRU","name":"Nauru"},{"code":"NZL","name":"New Zealand"},{"code":"OMN","name":"Oman"},{"code":"OTH","name":"DO NOT USE FOR CONVERSION ONLY"},{"code":"PAK","name":"Pakistan"},{"code":"PAN","name":"Panama"},{"code":"PCN","name":"Pitcairn"},{"code":"PER","name":"Peru"},{"code":"PHL","name":"Philippines"},{"code":"PLW","name":"Palau"},{"code":"PNG","name":"Papua New Guinea"},{"code":"POL","name":"Poland"},{"code":"PRI","name":"Puerto Rico"},{"code":"PRT","name":"Portugal"},{"code":"PRY","name":"Paraguay"},{"code":"PYF","name":"French Polynesia"},{"code":"QAT","name":"Qatar"},{"code":"REU","name":"Reunion"},{"code":"ROM","name":"Romania"},{"code":"RUS","name":"Russian Federation"},{"code":"RWA","name":"Rwanda"},{"code":"SAU","name":"Saudi Arabia"},{"code":"SDN","name":"Sudan"},{"code":"SEN","name":"Senegal"},{"code":"SGP","name":"Singapore"},{"code":"SGS","name":"Sth Georgia &amp; Sth Sandwich Is"},{"code":"SHN","name":"Saint Helena"},{"code":"SJM","name":"Svalbard and Jan Mayen"},{"code":"SLB","name":"Solomon Islands"},{"code":"SLE","name":"Sierra Leone"},{"code":"SLV","name":"El Salvador"},{"code":"SMR","name":"San Marino"},{"code":"SOM","name":"Somalia"},{"code":"SPM","name":"Saint Pierre and Miquelon"},{"code":"STP","name":"Sao Tome and Principe"},{"code":"SUR","name":"Suriname"},{"code":"SVK","name":"Slovakia"},{"code":"SVN","name":"Slovenia"},{"code":"SWE","name":"Sweden"},{"code":"SWZ","name":"Swaziland"},{"code":"SYC","name":"Seychelles"},{"code":"SYR","name":"Syrian Arab Republic"},{"code":"TCA","name":"Turks and Caicos Islands"},{"code":"TCD","name":"Chad"},{"code":"TGO","name":"Togo"},{"code":"THA","name":"Thailand"},{"code":"TJK","name":"Tajikistan"},{"code":"TKL","name":"Tokelau"},{"code":"TKM","name":"Turkmenistan"},{"code":"TMP","name":"East Timor"},{"code":"TON","name":"Tonga"},{"code":"TTO","name":"Trinidad and Tobago"},{"code":"TUN","name":"Tunisia"},{"code":"TUR","name":"Turkey"},{"code":"TUV","name":"Tuvalu"},{"code":"TWN","name":"Taiwan, Province of China"},{"code":"TZA","name":"Tanzania, United Republic of"},{"code":"UGA","name":"Uganda"},{"code":"UKR","name":"Ukraine"},{"code":"UMI","name":"US Minor Outlying Islands"},{"code":"URY","name":"Uruguay"},{"code":"UZB","name":"Uzbekistan"},{"code":"VAT","name":"Holy See (Vatican City State)"},{"code":"VCT","name":"St Vincent and the Grenadines"},{"code":"VEN","name":"Venezuela"},{"code":"VGB","name":"Virgin Islands (British)"},{"code":"VIR","name":"Virgin Islands (U.S.)"},{"code":"VNM","name":"Viet Nam"},{"code":"VUT","name":"Vanuatu"},{"code":"WLF","name":"Wallis and Futuna Islands"},{"code":"WSM","name":"Samoa"},{"code":"YEM","name":"Yemen"},{"code":"YUG","name":"Yugoslavia"},{"code":"ZAF","name":"South Africa"},{"code":"ZAR","name":"ZAIRE"},{"code":"ZMB","name":"Zambia"},{"code":"ZWE","name":"Zimbabwe"}]},"CustomerContact":{"type":"object","properties":{"accountNumber":{"$ref":"#/components/schemas/AccountNumber"},"ccId":{"$ref":"#/components/schemas/CcId"}},"required":["ccId","accountNumber"]},"CustomerContactComments":{"type":"object","properties":{"personId":{"$ref":"#/components/schemas/PersonId"},"contactClass":{"$ref":"#/components/schemas/ContactClass"},"contactType":{"$ref":"#/components/schemas/ContactType"},"comments":{"description":"customer provided comments for field service staff","type":"string"}},"required":["personId","contactClass","contactType","comments"]},"Date":{"description":"a date in YYYY-MM-DD format","type":"string","format":"date"},"Dates":{"description":"a collection of Dates in YYYY-MM-DD format","type":"array","items":{"type":"string","format":"date"}},"DistrictCode":{"type":"string","enum":["DIST 01","DIST 02","DIST 03","DIST 04","DIST 05","DIST 06","DIST 07","DIST 08","DIST 09","DIST 10","DIST 11","DIST 12","DIST 13"],"nullable":true},"DonationAmount":{"type":"number","multipleOf":0.01,"nullable":true},"DriversLicense":{"type":"object","properties":{"type":{"type":"string"},"pattern":{"type":"string","example":"^[0-9a-f]+$"}}},"EligibilityQuestions":{"description":"questions asked of the customer to establish eligibility","type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"text":{"type":"string"}},"required":["id","text"]},"nullable":true},"Email":{"type":"object","properties":{"description":{"description":"an email address","type":"string","example":"wasd_custrelations@miamidade.gov"},"type":{"type":"string","example":"wasd_custrelations@miamidade.go"},"format":{"type":"string","example":"email"}}},"EmailAddressType":{"description":"an contact information email type, e.g. one of 'EMAIL', 'PAPERLESS_EMAIL', 'WSSACIEMAIL', or 'WSSEMAIL'","type":"string","enum":["EMAIL","PAPERLESS_EMAIL","WSSACIEMAIL","WSSEMAIL"]},"EmailAddress":{"description":"a contact information email address and type","type":"object","required":["id","primary","email","type"],"properties":{"id":{"description":"a contact information id","type":"string"},"primary":{"description":"whether or not this email is the primary email","type":"string"},"email":{"description":"a contact information email address","type":"string","format":"email"},"type":{"$ref":"#/components/schemas/EmailAddressType"}}},"EmailAddresses":{"description":"a collection of email addresses and their types","type":"object","required":["numberOfEmails","emailAddresses"],"properties":{"numberOfEmails":{"type":"number"},"emailAddresses":{"type":"array","items":{"$ref":"#/components/schemas/EmailAddress"},"nullable":true}}},"EntityName":{"description":"either a first name, last name, or business name","type":"string","maxLength":50},"BusinessError":{"type":"object","properties":{"code":{"type":"string","example":"88888","description":"the code of the message"},"message":{"type":"string","example":"abcdefghijklmnopqrstuwxyz..","description":"the text of the message"}}},"FieldActivityId":{"description":"a field actitivity identifier","type":"string","minLength":10,"maxLength":10,"nullable":true,"pattern":"^[0-9]{10}$"},"FieldActivitiesItem":{"description":"a field activity","type":"object","required":["id","typeCode","scheduledDateTime"],"properties":{"id":{"$ref":"#/components/schemas/FieldActivityId"},"typeCode":{"$ref":"#/components/schemas/FieldActivityTypeCode"},"scheduledDateTime":{"description":"when the field activity was scheduled","type":"string","format":"date"}}},"FieldActivityTypeCode":{"description":"field activity type","type":"string"},"FieldActivity":{"type":"object","properties":{"id":{"type":"string","example":"4032692559"},"typeCode":{"type":"string","example":"UGL HIST"},"scheduledDateTime":{"type":"string","example":"05-04-2015"}}},"FinancialInformation":{"description":"an account's financial information","type":"object","required":["autoPayIndicator","cashOnlyIndicator","currentBalance","eBillIndicator","lastBillAmount","lastBillDate","lastBillDueDate","lastBillId","lastPaymentAmount","lastPaymentDate","nextScheduledBillDate","nextScheduledReadEnd","nextScheduledReadStart","pastDueAmount","payoffBalance","previousBillAmount","previousBillDate","previousBillId","maximumPayment","serviceFromDate","serviceToDate"],"properties":{"autoPayIndicator":{"description":"indicates whether or not a customer is enrolled in automatic payments","type":"boolean"},"cashOnlyIndicator":{"description":"indicates whether or not a customer can only pay in cash","type":"boolean"},"currentBalance":{"description":"a customers current balance","type":"number","multipleOf":0.01},"eBillIndicator":{"description":"indicates whether or not a customer is enrolled in electronic billing","type":"boolean"},"lastBillAmount":{"description":"the amount of the most current bill","type":"number","multipleOf":0.01},"lastBillDate":{"description":"the date of the most current bill","type":"string"},"lastBillDueDate":{"description":"the due date of the most current bill","type":"string"},"lastBillId":{"$ref":"#/components/schemas/BillId"},"lastPaymentAmount":{"description":"the amount of the most recent payment","type":"number","multipleOf":0.01},"lastPaymentDate":{"description":"the date of the most recent payment","type":"string"},"nextScheduledBillDate":{"description":"the date of the next scheduled bill","type":"string"},"nextScheduledReadEnd":{"description":"the latest possible date of the next meter reading","type":"string"},"nextScheduledReadStart":{"description":"the earliest possible date of the next meter reading","type":"string"},"pastDueAmount":{"description":"the amount that is past the due date","type":"number","multipleOf":0.01},"payoffBalance":{"description":"the account's pay off balance","type":"number","multipleOf":0.01},"previousBillAmount":{"description":"the amount on this account's previous bill","type":"number","multipleOf":0.01},"previousBillDate":{"description":"the date of this account's previous bill","type":"string"},"previousBillId":{"$ref":"#/components/schemas/BillId"},"maximumPayment":{"description":"the maximum allowable payment for this customer","type":"number","multipleOf":0.01},"serviceFromDate":{"description":"the starting date of this account's previous bill","type":"string"},"serviceToDate":{"description":"the ending date of this account's previous bill","type":"string"}}},"FolioId":{"description":"a Miami-Dade County Property Appraiser Folio Identifier","type":"string","minLength":13,"maxLength":13,"nullable":true,"pattern":"^[0-9]{13}$"},"FundingSourceDeletedConfirmation":{"type":"object","properties":{"data":{"type":"object","properties":{"tokenId":{"$ref":"#/components/schemas/FundingToken"},"status":{"description":"whether or not the funding source was deleted","type":"string"}},"required":["tokenId","status"]}},"required":["data"]},"FundingToken":{"description":"an encrypted funding token","type":"string","pattern":"^[0-9a-f]+$"},"FederalTaxNumber":{"description":"an Federal Tax Number in the pattern \"NN-NNNNNN\" where N is a digit","type":"string","example":"99-999999"},"GrantExtension":{"description":"One of either; 10 - grant extension, 20 - extension inquiry, 30 - test mode, 40 - payment request","type":"integer","enum":[10,20,30,40]},"HighBillConfirmation":{"description":"a high bill confirmation","type":"object","required":["isProcessed","accountNumber","confirmationNumber","premiseId"],"properties":{"isProcessed":{"type":"boolean"},"accountNumber":{"$ref":"#/components/schemas/AccountNumber"},"premiseId":{"$ref":"#/components/schemas/PremiseId"},"confirmationNumber":{"$ref":"#/components/schemas/ConfirmationNumber"},"messages":{"$ref":"#/components/schemas/Messages"}}},"HighBillEligibility":{"description":"a high bill eligibility item","type":"object","required":["isAccountEligible","accountNumber","premiseId","confirmationNumber","ineligibleReasons"],"properties":{"isAccountEligible":{"description":"is account eligible for a high bill investigation","type":"boolean"},"accountNumber":{"$ref":"#/components/schemas/AccountNumber"},"premiseId":{"$ref":"#/components/schemas/PremiseId"},"confirmationNumber":{"$ref":"#/components/schemas/ConfirmationNumber"},"ineligibleReasons":{"$ref":"#/components/schemas/IneligibleReasons"},"questions":{"$ref":"#/components/schemas/EligibilityQuestions"}}},"HighBillRequest":{"type":"object","properties":{"premiseId":{"$ref":"#/components/schemas/PremiseId"},"confirmationNumber":{"$ref":"#/components/schemas/ConfirmationNumber"},"questions":{"$ref":"#/components/schemas/EligibilityQuestions"}},"required":["premiseId","confirmationNumber","questions"]},"Identification":{"description":"an account enrollment identifier for either a Person or Business entity","type":"object","required":["type"],"properties":{"type":{"type":"string"},"description":{"type":"string","nullable":true},"format":{"type":"string","nullable":true},"required":{"type":"string","nullable":true}}},"Identifications":{"description":"a collection of account enrollment identifier for either a Person or Business entity","type":"array","items":{"$ref":"#/components/schemas/Identification"}},"IneligibleReason":{"description":"a reason for disqualifying a case","type":"object","properties":{"code":{"description":"a code for the ineligble reason","type":"string"},"message":{"description":"a message for the ineligble reason","type":"string"}},"required":["message"]},"IneligibleReasons":{"description":"a collection of reasons for disqualifying a case","type":"array","items":{"$ref":"#/components/schemas/IneligibleReason"},"nullable":true},"Latitude":{"description":"a latitude within Miami-Dade County","type":"number","example":25.775238},"Longitude":{"description":"a longitude within Miami-Dade County","type":"number","example":-80.196685},"Location":{"description":"a geographic location within Miami-Dade County","type":"object","properties":{"latitude":{"$ref":"#/components/schemas/Latitude"},"longitude":{"$ref":"#/components/schemas/Longitude"}}},"LinkAccountRequest":{"type":"object","required":["accountId","webUserId","homePhone","businessPhone","mobilePhone","registrationMobilePhone","registrationSecondPhone","email","accountType"],"properties":{"accountId":{"$ref":"#/components/schemas/AccountNumber"},"accountType":{"$ref":"#/components/schemas/ServiceEntity"},"businessPhone":{"$ref":"#/components/schemas/PhoneNumber"},"email":{"description":"the user's registered email","type":"string"},"homePhone":{"$ref":"#/components/schemas/PhoneNumber"},"mobilePhone":{"$ref":"#/components/schemas/PhoneNumber"},"registrationMobilePhone":{"$ref":"#/components/schemas/PhoneNumber"},"registrationSecondPhone":{"$ref":"#/components/schemas/PhoneNumber"},"webUserId":{"$ref":"#/components/schemas/WebUserId"}}},"MainServicePoints":{"description":"a collection of main service points","type":"array","items":{"description":"a main service point","type":"string","minLength":10,"maxLength":10,"pattern":"^[0-9]{10}$"}},"Message":{"description":"a message code and message text","type":"object","properties":{"code":{"description":"a code for the message","type":"string"},"message":{"description":"a message for the message","type":"string"}},"required":["message"]},"Messages":{"description":"a collection of Messages","type":"array","items":{"$ref":"#/components/schemas/Message"},"nullable":true},"MeterConfigurationId":{"description":"a meter configuration identifier in the form of a twelve digit string","type":"string","minLength":10,"maxLength":12,"pattern":"^([0-9]{10}|[0-9]{12})$"},"MeterId":{"description":"a meter identifier in the form of a ten digit string","type":"string","minLength":10,"maxLength":10,"pattern":"^[0-9]{10}$"},"MeterRead":{"type":"object","properties":{"description":{"type":"string","example":"???","description":"a meter reading"},"readDate":{"type":"string","example":"2025-04-01","description":"e.g. 2025-12-25"},"readType":{"type":"string","example":"string","description":"the source of the meter reading"},"meterReading":{"type":"number","example":19999,"description":"the meter reading"}}},"MeterReading":{"description":"a meter reading, varies from 0..999999, depending onthe number of digits a meter supports","type":"integer","minimum":0,"maximum":999999},"MeterReadingType":{"description":"a meter read type, e.g. 'Customer Read'","type":"string","enum":["No Read","System Estimate","Service Provider Estimate","Office Estimate","System Prorate","Customer Read","Regular","Verified","Billing Force"]},"MeterTestDetails":{"description":"the details of a certified meter test service request","type":"object","properties":{"confirmationNumber":{"$ref":"#/components/schemas/ConfirmationNumber"},"isPaymentRequired":{"description":"the required payment to proceed with a meter test","type":"boolean"},"isExtensionGranted":{"description":"whether or not an extension is granted","type":"boolean"}},"required":["confirmationNumber","isPaymentRequired","isExtensionGranted"]},"MeterTestEligibility":{"description":"meter test details","type":"object","properties":{"isAcountEligible":{"type":"boolean"},"isPaymentRequired":{"type":"boolean"},"messages":{"$ref":"#/components/schemas/Messages"},"requiredPaymentAmount":{"description":"the required payment to proceed with a meter test","type":"integer"},"confirmationNumber":{"$ref":"#/components/schemas/ConfirmationNumber"}},"required":["isAcountEligible","isPaymentRequired","messages","requiredPaymentAmount","confirmationNumber"]},"MilitaryTime":{"description":"a time in military formatl e.g. 0800, 23:45, but not e.g. 34:68, 5672","type":"string","minLength":4,"maxLength":5,"pattern":"^([01]?[0-9]|2[0-3]):[0-5][0-9]$"},"MunicipalityCode":{"type":"string","enum":["TX-AV","TX-BHI","TX-BROWD","TX-CB","TX-CG","TX-CGUMDC","TX-DORL","TX-EP","TX-FC","TX-GBMD","TX-HIAMD","TX-HSMD","TX-KB","TX-MBMD","TX-MEMD","TX-MGOPL","TX-MIA","TX-MIAGN","TX-MIAL","TX-MIASH","TX-MSMD","TX-NMBMD","TX-NMMD","TX-OLMD","TX-SWMD","TX-NMBOL","TX-OPL","TX-PBAY","TX-PBAYKBAY","TX-PC","TX-PCCG","TX-SIBMD","TX-SMIA","TX-SW","TX-UNICO","TX-VGMD","TX-WMIA","TX-UNOPL"],"nullable":true},"NotificationAlertItem":{"description":"a notification alert item","type":"object","required":["type","priority","sourceId","sourceIdType","description","fieldActivities"],"properties":{"type":{"type":"string"},"priority":{"description":"the order of the alert when displayed","type":"integer"},"sourceId":{"$ref":"#/components/schemas/SourceId"},"sourceIdType":{"description":"the type of the identifier that signifies where this alert is from","type":"string","nullable":true},"description":{"description":"the alert message returned by the CCB system","type":"string"},"fieldActivities":{"type":"array","items":{"$ref":"#/components/schemas/FieldActivitiesItem"},"nullable":true}}},"NotificationAlerts":{"description":"a collection of notification alert items","type":"array","items":{"$ref":"#/components/schemas/NotificationAlertItem"},"nullable":true},"NotificationMessages":{"description":"a collection of displayable messages","type":"array","items":{"type":"object","properties":{"criteria":{"description":"the message source","type":"string"},"criteriaValue":{"description":"the message source specific identifier","type":"string"},"code":{"$ref":"#/components/schemas/NotificationMessageCode"},"description":{"description":"the text of the message","type":"string"},"priority":{"description":"the order of the message when displayed","type":"integer"}},"required":["code","criteria","criteriaValue","description","priority"]},"nullable":true},"NotificationServiceActivities":{"description":"any field activities requested by this account","type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"description":{"type":"string"},"fieldActivities":{"type":"array","items":{"$ref":"#/components/schemas/FieldActivitiesItem"}}},"required":["type","description","fieldActivities"]},"nullable":true},"Notifications":{"description":"a collection of alerts, messages, and service activities","type":"object","required":["accountNumber","alerts","serviceActivities","messages"],"properties":{"accountNumber":{"$ref":"#/components/schemas/AccountNumber"},"alerts":{"$ref":"#/components/schemas/NotificationAlerts"},"serviceActivities":{"$ref":"#/components/schemas/NotificationServiceActivities"},"messages":{"$ref":"#/components/schemas/NotificationMessages"}}},"NotificationMessageCode":{"description":"a notification message code","type":"string","enum":["2019","AUEX","AUTO","BUDG","CASH","CEN ","CENS","CGSW","CLSE","COB ","COBL","COBP","COBR","COL1","CONS","CONV","CORF","CRED","CUSV","CY19","DER1","DERM","DISC","DISP","DLSW","DUE ","DUP ","ECOM","EPAY","EPB ","FAIL","FERT","FORE","FRAU","GABL","HIST","HOUR","HW05","INIT","IRRI","LATE","LIEN","LIFE","LOC ","MAIL","MDHA","MLS ","MLSW","MSW ","NBDP","NCOM","NOB ","ONLY","OUR ","P&Z ","PAY ","PBSW","PIPE","PLSE","POOL","PP ","PPM ","RATE","REBT","SEP1","SHWR","SMGC","SSN ","TAMP","TES1","TEST","THNX","TMS ","UGLX","VOT1","VOT2","VOTE","VOTZ","WHOL","WP1 ","WP2 ","WP3 ","WQR ","WRP ","XXXX"]},"Question":{"type":"object","properties":{"id":{"type":"string","example":"101"},"text":{"type":"string","example":"Do you like water?"}}},"Passport":{"description":"a user's passport number, used as a unique identifier for the user","type":"string","pattern":"^[0-9]*$"},"Payment":{"description":"a payment","type":"object","required":["id","confirmationNumber","amount","status","type","typeDesc","payDate"],"properties":{"id":{"$ref":"#/components/schemas/PaymentId"},"confirmationNumber":{"$ref":"#/components/schemas/ConfirmationNumber"},"amount":{"description":"the amount of the payment","type":"number","multipleOf":0.01},"status":{"$ref":"#/components/schemas/PaymentStatus"},"type":{"$ref":"#/components/schemas/PaymentType"},"typeDesc":{"description":"payment source description","type":"string"},"payDate":{"description":"date payment posted in the CCB system","type":"string","format":"date"},"cancelCode":{"description":"payment cancelltion code","type":"string"},"cancelDesc":{"description":"payment cancelltion description","type":"string"}}},"Payments":{"description":"a collection of payments","type":"array","items":{"$ref":"#/components/schemas/Payment"},"nullable":true},"PaymentAmount":{"type":"number","multipleOf":0.01,"nullable":true},"PaymentFee":{"type":"number","multipleOf":0.01,"nullable":true},"PaymentId":{"description":"a payment identifier","type":"string","minLength":12,"maxLength":12,"pattern":"^[0-9]{12}$"},"PaymentStatus":{"description":"a payment status","type":"string","enum":["Completed","Cancelled","Pending"]},"PaymentType":{"description":"a payment type","type":"string","enum":["AD","AW","C1","CA","CC","CD","CF","CH","CK","CM","CP","CW","DA","DD","EM","EP","ET","FC","FK","FU","GL","HB","IP","IV","L","MB","MO","MS","MX","NC","NP","NW","OC","OVUN","PK","S8","SA","SC","SD","SR","TC","WB"]},"PaymentExtensionDetails":{"type":"object","properties":{"confirmationNumber":{"$ref":"#/components/schemas/ConfirmationNumber"},"displayExtensionDate":{"description":"e.g. 2022-12-25","type":"string","format":"date"},"extensionDate":{"description":"e.g. 2022-12-25","type":"string","format":"date"},"isExtensionGranted":{"description":"whether or not a payment extension is granted","type":"boolean"},"messages":{"$ref":"#/components/schemas/Messages"}},"required":["isExtensionGranted","messages","confirmationNumber","displayExtensionDate","extensionDate"]},"PaymentExtensionEligibilityDetails":{"type":"object","required":["confirmationNumber","displayExtensionDate","extensionDate","isAccountEligible","isPartialPaymentRequired","isPreviousBalance","messages","requiredPaymentAmount"],"properties":{"confirmationNumber":{"$ref":"#/components/schemas/ConfirmationNumber"},"displayExtensionDate":{"type":"string","format":"date","description":"e.g. 2022-12-25"},"extensionDate":{"type":"string","format":"date","description":"e.g. 2022-12-25"},"isAccountEligible":{"description":"whether or not an account is eligible for a payment extension","type":"boolean"},"isPartialPaymentRequired":{"type":"boolean"},"isPreviousBalance":{"type":"boolean"},"messages":{"$ref":"#/components/schemas/Messages"},"requiredPaymentAmount":{"type":"integer"}}},"Person":{"description":"an enrollment person entity and their identifiers","type":"object","required":["firstName","lastName"],"properties":{"id":{"$ref":"#/components/schemas/PersonId"},"firstName":{"$ref":"#/components/schemas/PersonName"},"lastName":{"$ref":"#/components/schemas/PersonName"},"email":{"type":"string","format":"email","nullable":true},"identifications":{"$ref":"#/components/schemas/Identifications"}}},"PersonEntity":{"description":"a WASD person identifier, and the person's first name and last name","type":"object","properties":{"id":{"$ref":"#/components/schemas/PersonId"},"firstName":{"$ref":"#/components/schemas/PersonName"},"lastName":{"$ref":"#/components/schemas/PersonName"}},"required":["id","firstName","lastName"]},"PersonId":{"description":"a WASD person identifier in the form of a ten digit string","type":"string","minLength":10,"maxLength":10,"pattern":"^[0-9]{10}$"},"PersonName":{"description":"either a person's full name, or part of a person's name","type":"string","maxLength":50,"nullable":true},"PersonOnAccount":{"type":"object","properties":{"accountNumber":{"$ref":"#/components/schemas/AccountNumber"},"personOrBusiness":{"$ref":"#/components/schemas/ServiceEntity"},"accountStatus":{"$ref":"#/components/schemas/AccountStatus"},"business":{"$ref":"#/components/schemas/BusinessEntity"},"person":{"$ref":"#/components/schemas/PersonEntity"}},"anyOf":[{"required":["person"]},{"required":["business"]}],"required":["accountNumber","personOrBusiness","accountStatus"]},"Pool":{"description":"a premise pool","type":"object","properties":{"onPropertyRecord":{"description":"if a pool is on property","type":"string"},"size":{"description":"pool volume in CCFs (Centum Cubic Feet)","type":"integer"},"type":{"$ref":"#/components/schemas/PoolType"}}},"PoolCredit":{"type":"object","properties":{"confirmationNumber":{"$ref":"#/components/schemas/ConfirmationNumber"},"fillDate":{"description":"the date the pool was filled","type":"string","format":"date"},"poolLength":{"description":"the height of the pool in feet","type":"integer","example":15},"poolType":{"$ref":"#/components/schemas/PoolType"},"poolWidth":{"description":"the width of the pool in feet","type":"integer","example":30},"premiseId":{"$ref":"#/components/schemas/PremiseId"}},"required":["premiseId","fillDate","poolType","poolWidth","poolLength","confirmationNumber"]},"PoolCreditConfirmation":{"description":"a pool credit confirmation details","type":"object","required":["accountNumber","premiseId","confirmationNumber","messages"],"properties":{"accountNumber":{"$ref":"#/components/schemas/AccountNumber"},"premiseId":{"$ref":"#/components/schemas/PremiseId"},"confirmationNumber":{"$ref":"#/components/schemas/ConfirmationNumber"},"messages":{"description":"a collection of messages","type":"array","items":{"description":"a message","type":"string"}}}},"PoolCreditEligibility":{"description":"pool credit eligibility details","type":"object","required":["isAccountEligible","accountNumber","premiseId","poolType","ccsHasPoolInfo","poolVolumeCCF","poolVolumeGallons","confirmationNumber","ineligibleReasons","minDate","maxDate"],"properties":{"ccsHasPoolInfo":{"description":"indicates whether pool info is in the CCS system","type":"boolean"},"accountNumber":{"$ref":"#/components/schemas/AccountNumber"},"confirmationNumber":{"$ref":"#/components/schemas/ConfirmationNumber"},"ineligibleReasons":{"description":"a collection of ineligible reasons","type":"array","items":{"description":"the ineligible reason","type":"string"}},"isAccountEligible":{"description":"is this account eligible for a pool credit","type":"boolean"},"maxDate":{"description":"the latest date for which a pool credit request may be submitted","type":"string","format":"date"},"minDate":{"description":"the earliest date for which a pool credit request may be submitted","type":"string","format":"date"},"poolType":{"$ref":"#/components/schemas/PoolType"},"poolVolumeCCF":{"description":"the pool volume in CCFs (Centum Cubic Feet)","type":"integer"},"poolVolumeGallons":{"description":"the pool volume in Gallons","type":"integer"},"premiseId":{"$ref":"#/components/schemas/PremiseId"}}},"PoolType":{"description":"a pool type, 'I' for Inground, 'A' for Above ground","type":"string","enum":["I","A",null],"nullable":true},"PhoneNumber":{"description":"a phone number stored as a ten digit string, e.g. 3056657477","type":"string","minLength":10,"maxLength":10,"nullable":true},"PhoneNumberExtension":{"description":"a telephone number extension","type":"string","pattern":"^[0-9]{6}$","nullable":true},"Premise":{"description":"a premise","type":"object","required":["id","premiseType","premiseTypeDesc","address","pool","location","folio","municipalityCode","districtCode"],"properties":{"id":{"$ref":"#/components/schemas/PremiseId"},"premiseType":{"$ref":"#/components/schemas/PremiseTypeCode"},"premiseTypeDesc":{"type":"string"},"address":{"type":"object","properties":{"address1":{"$ref":"#/components/schemas/AddressStreet"},"address2":{"$ref":"#/components/schemas/AddressStreet"},"address3":{"$ref":"#/components/schemas/AddressStreet"},"city":{"$ref":"#/components/schemas/AddressCity"},"state":{"$ref":"#/components/schemas/AddressStateCode"},"zip":{"$ref":"#/components/schemas/ZipCode"},"county":{"$ref":"#/components/schemas/AddressCounty"},"country":{"$ref":"#/components/schemas/CountryCode"}}},"pool":{"$ref":"#/components/schemas/Pool"},"location":{"$ref":"#/components/schemas/Location"},"folio":{"$ref":"#/components/schemas/FolioId"},"municipalityCode":{"$ref":"#/components/schemas/MunicipalityCode"},"districtCode":{"$ref":"#/components/schemas/DistrictCode"}},"nullable":true},"PremiseId":{"description":"a service location identifier","type":"string","minLength":10,"maxLength":10,"pattern":"^[0-9]{10}$","nullable":true},"PremiseInformation":{"description":"premise information","type":"object","required":["useServiceAddress","billFrequency","accountNumber","billingAddress","premise"],"properties":{"useServiceAddress":{"type":"boolean","nullable":true},"billFrequency":{"$ref":"#/components/schemas/BillFrequency"},"accountNumber":{"$ref":"#/components/schemas/AccountNumber"},"billingAddress":{"$ref":"#/components/schemas/Address"},"premise":{"$ref":"#/components/schemas/Premise"}}},"ProfileId":{"description":"a profile identifier","type":"object","properties":{"profileCount":{"type":"integer"},"profileId":{"type":"string"},"consumerName":{"type":"string"}},"required":["profileCount","profileId","consumerName"]},"PremiseTypeCode":{"description":"an identifier that indicates the type of premise","type":"string","enum":["ABOLISHD","ACLF","ACTOWER","ACTW/SPK","AIRCRMNT","AMUSCNTR","APT +","APT CTR","APT FRON","APT REAR","APT","APTLWR","APTUPR","BAKERY","BAR","BARAPT","BARSTORE","BATHRMS","BBRSHOP","BILLIARD","BNQTHALL","BOAT SPK","BOATDOCK","BOATMFG","BOATRPR","BOWLALLY","BRDGHSE","BREWERY","BTLGPLNT","BTYSHOP","BTYSHPAP","BTYSHPST","BUS TRML","CABANA","CABAPOOL","CASINO","CEMETERY","CHCHAPT","CHDYCARE","CHEMPLNT","CHILPLNT","CHRCHOFC","CHRCHSNG","CHRCHSTR","CHURCH","CISTERN","CMNTPLNT","CNTRYCLB","CONDO","CONST YD","CONSTRLR","CONVCNTR","CR FA","DAYCARE","DAYSPA","DEV2DEV","DNTLOFC","DNTOFSTR","DORMITRY","DPLX +","DPLXFRNT","DRYCLNR","DUPLEX","DUPLEXB","DUPLEXE","DUPLEXL","DUPLEXN","DUPLEXR","DUPLEXS","DUPLEXU","DUPLEXW","DYCARSTR","ELSUBSTN","EMGCYFAC","ERROR","FAC-SMA","FACTORY","FAUCET","FCTRYAPT","FCTRYSTR","FIRELINE","FIRELOOP","FIRESTN","FISHFARM","FLTGMTR","FNTNDRNK","FOODPREP","FOUNTAIN","FSMEDOFC","FUELSTRG","FUNERAL","GARAGE","GRHMCHDC","GRPHOME","GUARDHS","GUESTHS","GYM","GYMSHWR","HANGAR","HOBBY RM","HOSPITAL","HOTEL","HOTLREST","HOTLSTR","HOUSBOAT","HOUSMTR","HYDRANT","ICEVNDNG","JAIL","KENNEL","LAB","LABDNTL","LABMARN","LABMED","LABPHOTO","LANDFILL","LAUNDRY","LIBRARY","LMBRYARD","LNDR +","MAGSTN","MAINTFAC","MARINA","MBLDG/TR","MCHINSHP","MEDOFC","MEDOFCST","MLTRYFCL","MNTNBLDG","MNTRMETR","MNTRMPUM","MONWELL","MOVIESTU","MRINAOFC","MRINAWH","MSTRMETR","MTRORAIL","MUSEUM","NAIL SAL","NBLIENPR","NBPAPREM","NBU FA","NURSERY","NURSNGHM","OFCDAYCR","OFCFCT","OFCGAR","OFCGYM","OFCRSTGY","OFCSTR","OFCSTRWH","OFCTRLR","OFCVEHRP","OFCWHS","OFFICE","PARK","PARKRES","PESTCTRL","PLC","POLICFAC","POOL","POOLBRM","POOLSPKL","PORTERM","PRKNGAR","PRKNGLOT","PRNTNGCO","PUMPSTN","PVTSWPST","PWERPLNT","RECCNTR","RECYAUTO","RECYCLNG","REHABRES","REHABSCH","RES +","RES","RESFRNT","RESREAR","REST +","REST","RHABCNTR","RMGHSAPT","RMGHSOFC","RMGHSRES","RMGHSSTR","RMHSCHCH","RMHSVREP","RMNGHS","RRSTN","SCHAPT","SCHCHAPT","SCHCHRCH","SCHCHRES","SCHOFC","SCHOOL","SCHRES","SEAQURM","SEENUBUS","SEPTAGE","SPRKLCOM","SPRKLRES","SPRKMRES","SPRMRGDH","STABLES","STADIUM","STORAGE","STORE","STRDRCLN","STRFCT","STRPKGAR","STRWHS","SUB UNIT","SUBMETER","SUS FA","SVCESTN","SVCSTNVH","SVCSTNVM","SWRPLNT","TAMPERNG","TEMPCNST","TEMPSVC","THEATRE","TOLLBTH","TRAILER","TRIRAIL","TRLRAPT","TRLRRES","TRNFSTN","TWNHOUSE","VEHDLR","VEHP&B","VEHRENT","VEHREP","VEHRNTWH","VEHRPAPT","VEHRPOFC","VEHRPP&B","VEHRPRES","VEHRPSTR","VEHRPVWH","VEHWSHHD","VEHWSHMC","VEHWSHST","VETCLAPT","VETCLINC","VETCLSTR","VHDLROFC","VHDLRVWH","VHRNTVWH","VWHPLCAB","WAREHSE","WELLHSE","WH FA","WHOLSLE","WHSEFCT","WHSEMINI","WO","WTRPLNT","WUE PN","ZOO"]},"ReadWindow":{"type":"object","properties":{"index":{"type":"number","example":-3},"startDate":{"type":"string","example":"2025-12-07"},"endDate":{"type":"string","example":"2025-12-14"}}},"ReconnectConfirmation":{"type":"object","properties":{"confirmationNumber":{"$ref":"#/components/schemas/ConfirmationNumber"},"fieldActivityInstructions":{"description":"customer instructions for field staff","type":"string"},"preferredDate":{"description":"customer selected schedule date","type":"string","format":"date"},"preferredTime":{"$ref":"#/components/schemas/MilitaryTime"}},"required":["confirmationNumber","fieldActivityInstructions","preferredDate","preferredTime"]},"ReconnectDetails":{"description":"service reconnect details","type":"object","required":["reconnectDetails"],"properties":{"reconnectDetails":{"type":"object","required":["isReconnectGranted","messages","confirmationNumber","timeWindow"],"properties":{"confirmationNumber":{"$ref":"#/components/schemas/ConfirmationNumber"},"isReconnectGranted":{"description":"is the reconnect request granted","type":"boolean"},"messages":{"$ref":"#/components/schemas/Messages"},"timeWindow":{"type":"string","nullable":true}}}}},"ReconnectEligibilityDetails":{"description":"reconnect service eligibility details","type":"object","required":["accountNumber","reconnectDetails"],"properties":{"accountNumber":{"$ref":"#/components/schemas/AccountNumber"},"reconnectDetails":{"type":"object","required":["isAccountEligible","isPaymentRequired","isNonSufficientFunds","messages","requiredPaymentAmount","confirmationNumber"],"properties":{"availableDates":{"$ref":"#/components/schemas/AvailableDates"},"confirmationNumber":{"$ref":"#/components/schemas/ConfirmationNumber"},"isAccountEligible":{"description":"is the account eligibile for a reconnect","type":"boolean"},"isNonSufficientFunds":{"description":"indicates whether or not an account has a returned payment","type":"boolean"},"isPaymentRequired":{"description":"indicates whether or not a payment is required before the account is reconnected","type":"boolean"},"messages":{"$ref":"#/components/schemas/Messages"},"requiredPaymentAmount":{"description":"minimum payment required for a reconnect to be done","type":"number","multipleOf":0.01,"nullable":true},"timeSlots":{"$ref":"#/components/schemas/ReconnectTimeSlots"}}}}},"ReconnectTimeSlot":{"description":"a service reconnect time slot","type":"object","required":["description","value","available"],"properties":{"description":{"description":"the service period","type":"string"},"value":{"description":"the service time","type":"string"},"available":{"description":"indicates that the service time slot is available for scheduling","type":"boolean","example":false}}},"ReconnectTimeSlots":{"description":"a collection of available service periods that a reconnect can be done","type":"array","items":{"$ref":"#/components/schemas/ReconnectTimeSlot"},"nullable":true},"RegistrationEmail":{"description":"a user supplied email at registration time","type":"string","format":"email"},"RegistrationEmailUpdate":{"type":"object","properties":{"data":{"type":"object","properties":{"webUserId":{"$ref":"#/components/schemas/WebUserId"},"registrationEmail":{"$ref":"#/components/schemas/RegistrationEmail"}},"required":["webUserId","registrationEmail"]}},"required":["data"]},"RouteSequenceNumber":{"description":"service cycle route sequence","type":"string","maxLength":8,"nullable":true},"ServiceAgreementId":{"description":"a service agreement identifier","type":"string","minLength":10,"maxLength":10,"pattern":"^[0-9]{10}$"},"Service":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ServiceAgreementId"},"saType":{"description":"an identifier for the type of service","type":"string","example":"RWW-C"},"saTypeDesc":{"description":"a description of the type of service","type":"string","example":"EXAMPLE NEEDED"},"serviceType":{"$ref":"#/components/schemas/ServiceType"},"serviceTypeDesc":{"description":"whether a service is Water or Waste Water","type":"string","example":"EXAMPLE NEEDED"},"rate":{"description":"this service's rate schedule","type":"integer","example":6},"mainSp":{"$ref":"#/components/schemas/MainServicePoints"},"status":{"$ref":"#/components/schemas/ServiceStatus"},"waterOnly":{"description":"is this a water only service, e.g. not waste water","type":"string","example":"true"}}},"Services":{"description":"a collection of services available at this premise","type":"array","items":{"$ref":"#/components/schemas/Service"}},"ServiceActivity":{"type":"object","properties":{"type":{"type":"string","example":"HighBillFA"},"description":{"type":"string","example":"Initiated work on Underground Leak complaint from customer."},"fieldActivities":{"type":"array","items":{}}}},"ServiceEntity":{"description":"a service entity, e.g. 'P' for Person, 'B' for Business","type":"string","enum":["P","B"]},"ServicePointItem":{"description":"a service point","type":"object","required":["id","badgeNumber","type","size","isSubMeterPoint","saspUsageFlg","location"],"properties":{"id":{"description":"DESCRIPTION NEEDED","type":"string","example":"0123456789"},"badgeNumber":{"$ref":"#/components/schemas/BadgeNumber"},"type":{"description":"a meter type code","type":"string","example":"5/8"},"size":{"description":"a meter type description","type":"string","example":"5/8 INCH WATER METER"},"isSubMeterPoint":{"description":"whether or not the service point is a submeter","type":"string","example":"N"},"saspUsageFlg":{"description":"indicates whether a meter is additive or subtractive","type":"string","example":"+"},"route":{"description":"a service route code","type":"string","example":"6666"},"location":{"$ref":"#/components/schemas/Location"}}},"ServicePoints":{"description":"a collection of service point items","type":"array","items":{"$ref":"#/components/schemas/ServicePointItem"},"nullable":true},"ServicePoint":{"description":"DEPRECATED CHECK WHERE USED FIRST","type":"object","properties":{"description":{"type":"string","example":"``","description":"a service point"},"id":{"type":"string","example":"0123456789"},"badgeNumber":{"$ref":"#/components/schemas/BadgeNumber"},"type":{"type":"string","example":"5/8","description":"a meter type code"},"size":{"type":"string","example":"5/8 INCH WATER METER","description":"a meter type description"},"isSubMeterPoint":{"type":"string","example":"N","description":"whether or not the service point is a submeter"},"saspUsageFlg":{"type":"string","example":"+","description":"indicates whether a meter is additive or subtractive"},"route":{"type":"string","example":"6666","description":"a service route code"},"location":{"type":"array","items":{},"description":"<===== CHECK THIS"}}},"ServiceStatus":{"description":"the status of a service","type":"string","enum":["Incomplete","Pending Start","Active","Pending Stop","Stopped","Reactivated","Closed","Canceled"]},"ServiceType":{"description":"an idenifier for the type of service, e.g. W for Water or WW for Waste Water","type":"string","enum":["W","WW"]},"ServiceTypes":{"description":"a collection of service type items","type":"object","required":["serviceTypes","accountNumber"],"properties":{"accountNumber":{"$ref":"#/components/schemas/AccountNumber"},"serviceTypes":{"type":"array","items":{"$ref":"#/components/schemas/ServiceTypeItem"},"nullable":true}}},"ServiceTypeItem":{"description":"a service type item","type":"object","required":["serviceType","serviceDescription"],"properties":{"serviceType":{"$ref":"#/components/schemas/ServiceType"},"serviceDescription":{"description":"whether a service is 'Water' or 'Wastewater'","type":"string"}}},"ServiceRequests":{"type":"object","properties":{"data":{"type":"object","properties":{"accountNumber":{"$ref":"#/components/schemas/AccountNumber"},"premiseId":{"$ref":"#/components/schemas/PremiseId"},"serviceRequests":{"type":"array","items":{"type":"object","properties":{"confirmationNumber":{"$ref":"#/components/schemas/ConfirmationNumber"},"denialReason":{"type":"string"},"description":{"type":"string","minLength":1,"maxLength":256},"lastStatusDate":{"description":"date when service was service request was last updated","type":"string","format":"date"},"requestedDate":{"description":"date when service was requested","type":"string","format":"date"},"status":{"type":"string","minLength":1,"maxLength":256},"submittedBy":{"type":"string"},"type":{"type":"string","minLength":1,"maxLength":256}},"required":["confirmationNumber","denialReason","description","lastStatusDate","requestedDate","status","submittedBy","type"]}}},"required":["accountNumber","premiseId","serviceRequests"]}},"required":["data"]},"SocialSecurityNumberLastFourDigits":{"description":"a valid Social Security Number with dashes","type":"string","minLength":10,"maxLength":10,"pattern":"^[0-9]{4}$"},"SocialSecurityNumberNoDashes":{"description":"a valid Social Security Number with dashes","type":"string","minLength":10,"maxLength":10,"pattern":"^(?!666|000|9[0-9]{2})[0-9]{3}(?!00)[0-9]{2}(?!0{4})[0-9]{4}$"},"SourceId":{"description":"the identifier that signifies where an alert is from","type":"string","minLength":10,"maxLength":10,"pattern":"^[0-9]{10}$"},"SpId":{"description":"a service point identifier","type":"string","minLength":10,"maxLength":10,"pattern":"^[0-9]{10}$"},"StopService":{"description":"details for a stop service request","type":"object","properties":{"accessInstructions":{"description":"customer provided instructions for field service staff","type":"string"},"accountStatus":{"$ref":"#/components/schemas/AccountStatus"},"comments":{"description":"customer provided comments for field service staff","type":"string"},"premiseId":{"$ref":"#/components/schemas/PremiseId"},"requestedBy":{"description":"the name of the customer who requested a stop service","type":"string"},"requestedStopDate":{"description":"customer requested stop schedule","type":"string","format":"date"}},"required":["premiseId","requestedStopDate","requestedBy","accessInstructions","comments","accountStatus"]},"StopServiceConfirmation":{"description":"confirmation details for a stop service request","type":"object","required":["effectiveStopDate","confirmationNumber","premiseId","accountNumber"],"properties":{"accountNumber":{"$ref":"#/components/schemas/AccountNumber"},"confirmationNumber":{"$ref":"#/components/schemas/ConfirmationNumber"},"effectiveStopDate":{"description":"effective stop of service","type":"string"},"premiseId":{"$ref":"#/components/schemas/PremiseId"}}},"StopServiceEligibilityConfirmation":{"description":"eligibility details for a stop service request","type":"object","required":["accountNumber","premiseId","isAccountEligible","existingStopDate","ineligibleReasons","blockedDates"],"properties":{"accountNumber":{"$ref":"#/components/schemas/AccountNumber"},"blockedDates":{"$ref":"#/components/schemas/BlockedDates"},"existingStopDate":{"description":"current stop date in the ccb system","type":"string","nullable":true},"ineligibleReasons":{"$ref":"#/components/schemas/IneligibleReasons"},"isAccountEligible":{"description":"whether or not the account is eligible for a stop service","type":"boolean"},"premiseId":{"$ref":"#/components/schemas/PremiseId"}}},"TeamsiteConfiguration":{"description":"a collection of configuration URLs","type":"object","required":["certifiedMeterTestURL","enrollFreeURL","feedbackURL","payWithAutoPayURL","payWithBankAccountURL","payWithCreditCardURL","readYourWaterMeterURL","startServiceURL","tamperingViolationsURL","transferServiceURL","undergroundLeakAdjustmentURL","wasdTeamsiteURL","watsonURL"],"properties":{"certifiedMeterTestURL":{"type":"string","format":"uri","nullable":true},"enrollFreeURL":{"type":"string","format":"uri","nullable":true},"feedbackURL":{"type":"string","format":"uri","nullable":true},"payWithAutoPayURL":{"type":"string","format":"uri","nullable":true},"payWithBankAccountURL":{"type":"string","format":"uri","nullable":true},"payWithCreditCardURL":{"type":"string","format":"uri","nullable":true},"readYourWaterMeterURL":{"type":"string","format":"uri","nullable":true},"startServiceURL":{"type":"string","format":"uri","nullable":true},"tamperingViolationsURL":{"type":"string","format":"uri","nullable":true},"transferServiceURL":{"type":"string","format":"uri","nullable":true},"undergroundLeakAdjustmentURL":{"type":"string","format":"uri","nullable":true},"wasdTeamsiteURL":{"type":"string","format":"uri","nullable":true},"watsonURL":{"type":"string","format":"uri","nullable":true}}},"Telephone":{"type":"object","properties":{"description":{"type":"string","example":"3056657477","description":"a phone numbers stored as a ten digit string, e.g. 3056657477"},"type":{"type":"string","example":"string"},"minLength":{"type":"number","example":10},"maxLength":{"type":"number","example":10},"pattern":{"type":"string","example":"^[0-9]{10}$"}}},"Token":{"type":"object","properties":{"fundingAccountNickname":{"type":"string","example":"Bank of Miami-Dade County Checking Account"},"fundingDate":{"type":"string","example":"09/12/2023"},"fundingSubType":{"type":"string","example":"PERSONAL CHECKING"},"id":{"type":"string","example":"163cf7eb34ce2c3ff00245a8406a407251420a292d08471482192ad9bdce591c"},"maskedFundingAccount":{"type":"string","example":"******0123"},"singleUse":{"type":"string","example":"N"}}},"TokenId":{"type":"object","properties":{"type":{"type":"string","example":"163cf7eb34ce2c3ff00245a8406a407251420a292d08471482192ad9bdce591c"},"pattern":{"type":"string","example":"^[0-9a-f]+$"}}},"UOM":{"description":"unit of measure in CCFs (Centum Cubic Feet)","type":"string","default":"CCF"},"UOMGal":{"description":"unit of measure in Gallons","type":"string","default":"Gals"},"USAPostalCode":{"description":"a postal code used by the United States Postal Service (USPS)","oneOf":[{"$ref":"#/components/schemas/ZipCode"},{"$ref":"#/components/schemas/ZipPlus4"}]},"USPSAddress":{"description":"a U.S.P.S normalized address","type":"object","required":["unit","address","city","state","zip5","zip4"],"properties":{"unit":{"type":"string","nullable":true},"address":{"$ref":"#/components/schemas/AddressStreet"},"city":{"$ref":"#/components/schemas/AddressCity"},"state":{"$ref":"#/components/schemas/AddressStateCode"},"zip5":{"$ref":"#/components/schemas/Zip5"},"zip4":{"$ref":"#/components/schemas/Zip4"}}},"UsageItem":{"description":"a water or wastewater usage item","type":"object","required":["serviceType","uom","amount","dateTo","rank","billDate","uomGal","dateFrom","billedUsage","billedUsageGal"],"properties":{"serviceType":{"$ref":"#/components/schemas/ServiceType"},"uom":{"$ref":"#/components/schemas/UOM"},"uomGal":{"$ref":"#/components/schemas/UOMGal"},"amount":{"type":"number","multipleOf":0.01},"dateTo":{"type":"string"},"rank":{"type":"number","minimum":1},"billDate":{"type":"string"},"dateFrom":{"type":"string"},"billedUsage":{"type":"number","minimum":0},"billedUsageGal":{"type":"number","minimum":0}},"nullable":true},"ValidateAccount":{"type":"object","properties":{"accountNumber":{"$ref":"#/components/schemas/AccountNumber"},"webUserId":{"$ref":"#/components/schemas/WebUserId"},"person":{"$ref":"#/components/schemas/Person"},"business":{"$ref":"#/components/schemas/Business"}},"required":["accountNumber","webUserId"]},"ValidateBusiness":{"type":"object","properties":{"accountNumber":{"$ref":"#/components/schemas/AccountNumber"},"businessPhone":{"$ref":"#/components/schemas/PhoneNumber"},"extension":{"$ref":"#/components/schemas/PhoneNumberExtension"},"hasInvalidData":{"description":"was invalid data submitted","type":"string"},"hasValidFTN":{"description":"has a valid Federal Tax Number","type":"boolean"},"mobilePhone":{"$ref":"#/components/schemas/PhoneNumber"},"personId":{"$ref":"#/components/schemas/PersonId"}},"required":["hasInvalidData","accountNumber","personId","hasValidFTN","businessPhone","mobilePhone","extension"]},"ValidatePerson":{"type":"object","properties":{"accountNumber":{"$ref":"#/components/schemas/AccountNumber"},"hasInvalidData":{"description":"was invalid data submitted","type":"string"},"hasValidSSN":{"description":"has a valid SSN (Social Security Number)","type":"string"},"homePhone":{"$ref":"#/components/schemas/PhoneNumber"},"mobilePhone":{"$ref":"#/components/schemas/PhoneNumber"},"personId":{"$ref":"#/components/schemas/PersonId"}},"required":["hasInvalidData","accountNumber","personId","hasValidSSN","homePhone","mobilePhone"]},"WaterAndSewerUsage":{"description":"a collection of water and wastewater usage","type":"object","required":["sewer","water"],"properties":{"sewer":{"type":"array","items":{"$ref":"#/components/schemas/UsageItem"},"nullable":true},"water":{"type":"array","items":{"$ref":"#/components/schemas/UsageItem"},"nullable":true}}},"WebUserId":{"description":"a web user identifier in the form of an eight digit string","type":"string","pattern":"^[0-9]{8}$"},"ZipCode":{"description":"a postal code used by the United States Postal Service (USPS)","type":"string","maxLength":5,"minLength":5,"nullable":true,"pattern":"^[0-9]{5}$"},"ZipPlus4":{"description":"a extended postal code used by the United States Postal Service (USPS)","type":"string","pattern":"^[0-9]{5}:[0-9]{4}$"},"Zip5":{"description":"a postal code used by the United States Postal Service (USPS)","type":"string","maxLength":5,"minLength":5,"pattern":"^[0-9]{5}$"},"Zip4":{"description":"a plus-four code used by the United States Postal Service (USPS)","type":"string","maxLength":4,"minLength":4,"pattern":"^[0-9]{4}$"},"Error404":{"description":"Not Found","type":"object","properties":{"code":{"description":"an error indicator","type":"boolean"},"message":{"description":"an error message","type":"string"}},"example":{"code":true,"message":"Not Found"}},"Error502":{"description":"Bad Gateway","type":"object","properties":{"error":{"description":"an error object containing error details and an error message","type":"object","properties":{"code":{"description":"an error code","type":"string"},"message":{"description":"an error message","type":"string"}},"required":["code","message"]}},"required":["error"],"example":{"error":{"code":"502","message":"abcdefghijklmnopqrstuwxyz..."}}}}},"tags":[{"name":"Account","description":"Accounts resources of the **WASD-M2C API**"},{"name":"Address Validation","description":"Address Validation resources of the **WASD-M2C API**"},{"name":"Admin Data","description":"Admin Data resources of the **WASD-M2C API**"},{"name":"Bill Extension","description":"Bill Extension resources of the **WASD-M2C API**"},{"name":"Bills","description":"Bills resources of the **WASD-M2C API**"},{"name":"Case","description":"Case resources of the **WASD-M2C API**"},{"name":"Certified Meter Test","description":"Certified Meter Test resources of the **WASD-M2C API**"},{"name":"Contact Information","description":"Contact Information resources of the **WASD-M2C API**"},{"name":"Financial Information","description":"Financial Information resources of the **WASD-M2C API**"},{"name":"Funding Sources","description":"Funding Sources resources of the **WASD-M2C API**"},{"name":"High Bill","description":"High Bill resources of the **WASD-M2C API**"},{"name":"Histogram","description":"Histogram resources of the **WASD-M2C API**"},{"name":"Mailing Address","description":"Mailing Address resources of the **WASD-M2C API**"},{"name":"Notifications","description":"Notifications resources of the **WASD-M2C API**"},{"name":"Paperless Billing","description":"Paperless Billing resources of the  **WASD-M2C API**"},{"name":"Payment Extension","description":"Payment Extension resources of the **WASD-M2C API**"},{"name":"Payments","description":"Payments resources of the **WASD-M2C API**"},{"name":"Pending Payments","description":"Pending Payments resources of the **WASD-M2C API**"},{"name":"Person On Account","description":"Person or Business on Account resources of the **WASD-M2C API**"},{"name":"Phone Number Types","description":"Phone Number Type resources of the  **WASD-M2C API**"},{"name":"Pool Credit","description":"Pool Credit resources of the **WASD-M2C API**"},{"name":"Premise Information","description":"Premise Information resources of the **WASD-M2C API**"},{"name":"Reconnect","description":"Reconnect Service resources of the **WASD-M2C API**"},{"name":"Service Points","description":"Service Points resources of the **WASD-M2C API**"},{"name":"Service Types","description":"Service Types resources of the **WASD-M2C API**"},{"name":"Services","description":"Services resources of the **WASD-M2C API**"},{"name":"Start Service","description":"not yet implemented"},{"name":"Stop Service","description":"Stop Service resources of the **WASD-M2C API**"},{"name":"Submeters","description":"Submeter resources of the **WASD-M2C API**"},{"name":"Teamsite","description":"Teamsite resources of the **WASD-M2C API**"},{"name":"ZIP Code","description":"ZIP Code resources of the **WASD-M2C API**"}]}