Get Authorized Dealers

Gets the list of dealers that the requesting user has access to.

GET /v3/api/dealers

Response attributes:

Property	Required/Optional	Type	Description
Id	Required	Long	Field is the backend API identifier and is for development use only. Generally, dealers do not know this value.
Name	Required	String	Field indicates the Name of the dealer.
DealerId	Required	String	Field is business identifier for the dealer and is the proper identifier for business use.
DealerNumber(Legacy)	Required	String	Field is business identifier for the dealer and is the proper identifier for business use.
EntityId	Required	String	This is an internal Aqua field only. This field is not required to interact with Broker API or Portal.
IsOpenOnSaturday	Required	Boolean	Field indicates whether the Dealer is open on Saturdays or not. Field is used for Right to Cancel calculations.
IsRetailDealer	Required	Boolean
Address	Required	Object	Field indicates the address of the dealer.
PhoneNumber	Optional	Object	Field indicates the phone number of the dealer.
MajorProductLine	Required	String	Field returns the major product lines for the dealer. This value is necessary for application submission.
Nickname	Optional	String	Field indicates a nickname for the given dealer.
AffiliateName	Optional	String	Field indicates the Affiliate Name. This field is applicable for Limited Association dealers.
NextAttestationDate	Optional	Date	Field indicates when the dealer has to attest next.
AttestWindowDays	Optional	Integer	Field indicates how long the dealer has to attest. If the dealer does not attest during this window, they will lose access to our systems until they attest again.
IncludeLcc	Required	Boolean	Field indicates whether or not the LCC should be included for the dealer.
Products	Optional	List of Objects	Object containing details regarding applicable products for the dealer.
Options	Optional	List of Objects	Object containing applicable options for the dealer.
Verticals	Optional	List of Objects	Object containing applicable verticals for the dealer.
SalesRepresentatives	Required	List of Objects	Object containing Sales Representatives for the dealer.

"Address" attributes:

Property	Required/Optional	Type	Description
SerializationVersion	Required	Integer	This is an internal Aqua field only. This field is not required to interact with Broker API or Portal.
Address1	Required	String	Field indicates the first address line for the dealer.
Address2	Optional	String	Field indicates the second address line for the dealer.
City	Required	String	Field indicates the city in which the dealer resides.
State	Required	StateEnum	Field indicates the state in which the dealer resides.
PostalCode	Required	String	Field indicates the postal code in which the dealer resides.

"PhoneNumber" attributes:

Property	Required/Optional	Type	Description
SerializationVersion	Required	Integer	This is an internal Aqua field only. This field is not required to interact with Broker API or Portal.
PhoneNumberType	Required	PhoneEnum	Field indicates the type of phone number for the dealer.
AreaCode	Required	String	Field displays the area code portion of the phone number.
CentralOfficeCode	Required	String	Field displays the central office code portion of the phone number.
StationNumber	Required	String	Field displays the station number portion of the phone number.
IsPrimary	Required	Boolean	Field indicates whether or not the phone number is the primary phone number for the dealer.

"Products" attributes:

Property	Required/Optional	Type	Description
SerializationVersion	Required	Integer	This is an internal Aqua field only. This field is not required to interact with Broker API or Portal.
Name	Required	String	Field indicates the name of the product.
Code	Required	String	Field indicates the product code.
IsHomeImprovement	Required	Boolean	Field indicates whether or not the product is for home improvement.
IsMajorProduct	Required	Boolean	Field indicates whether or not the product is the major product for the dealer.

"Options" attributes:

Property	Required/Optional	Type	Description
SerializationVersion	Required	Integer	This is an internal Aqua field only. This field is not required to interact with Broker API or Portal.
Code	Required	String	Field indicates the option code.
Description	Required	String	Field displays the description for the option.

"Verticals" attributes:

Property	Required/Optional	Type	Description
SerializationVersion	Required	Integer	This is an internal Aqua field only. This field is not required to interact with Broker API or Portal.
Value	Required	String	Field displays the value of the vertical.

"SalesRepresentatives" attributes:

Property	Required/Optional	Type	Description
SerializationVersion	Required	Integer	This is an internal Aqua field only. This field is not required to interact with Broker API or Portal.
Initials	Required	String	Field displays the initials of the sales representative.
FirstName	Required	String	Field displays the first name of the sales representative.
LastName	Required	String	Field displays the last name of the sales representative.
Title	Optional	String	Field displays the title of the sales representative.
PhoneNumber	Optional	String	Field displays the phone number of the sales representative.
Email	Required	String	Field displays the email of the sales representative.
PhotoUrl	Optional	String	This is an internal Aqua field only. This field is not required to interact with Broker API or Portal.
SalesRepresentativeType	Required	SalesRepresentativeTypeEnum	Field displays a valid `SalesRepresentativeTypeEnum` value.
IsInternalTeam	Required	Boolean	This is an internal Aqua field only. This field is not required to interact with Broker API or Portal.

Example response:


[
    {
        "Id": 1,
        "Name": "WATER DEALER",
        "DealerNumber": "000001.000",
        "EntityId": "00001",
        "IsOpenOnSaturday": false,
        "IsRetailDealer": false,
        "Address": {
            "SerializationVersion": 1,
            "Address1": "111 ROAD-STREET",
            "Address2": "",
            "City": "ROME",
            "State": "WY",
            "PostalCode": "98754"
        },
        "PhoneNumber": {
            "SerializationVersion": 1,
            "PhoneNumberType": "Home",
            "AreaCode": "999",
            "CentralOfficeCode": "888",
            "StationNumber": "7894",
            "IsPrimary": true
        },
        "MajorProductLine": "MISC WATER",
        "Nickname": null,
        "AffiliateName": null,
        "NextAttestationDate": "2021-11-23T06:00:00",
        "AttestWindowDays": 60,
        "IncludeLcc": false,
        "Products": [
            {
                "SerializationVersion": 1,
                "Name": "Water Treatment System",
                "Code": "WATERTREAT",
                "IsHomeImprovement": false,
                "IsMajorProduct": true
            }
        ],
        "Options": [
            {
                "SerializationVersion": 1,
                "Code": "10.99PAYR",
                "Description": "10.99PAYRATE"
            }, {
                "SerializationVersion": 1,
                "Code": "8.9%+REV",
                "Description": "8.9+PFREVPROMO"
            }
        ],
        "Verticals": [
            {
                "SerializationVersion": 1,
                "Value": "WATERTREAT"
            }
        ],
        "SalesRepresentatives": [
            {
                "SerializationVersion": 1,
                "Initials": "TST",
                "FirstName": "TEST",
                "LastName": "TESTING",
                "Title": "Technical Specialist",
                "PhoneNumber": "8002343663",
                "Email": "testing@aquafinance.com",
                "PhotoUrl": "/media/1216/team-awesome-sauce_2.jpg",
                "SalesRepresentativeType": "DSR",
                "IsInternalTeam": false
            }
        ]
    }
]

Get Products for Dealer

Gets the list of products for a dealer that the requesting user has access to.

GET /v3/api/dealers/{dealerId}/products

Request URL query parameters:

Property	Required/Optional	Type	Description
dealerId	Required	Long	Valid dealer Id that user has access to.

GET /v3/api/dealers/{dealerNumber}/products

Request URL query parameters:

Property	Required/Optional	Type	Description
dealerNumber	Required	String	Valid dealer number that user has access to.

Response attributes:

Property	Required/Optional	Type	Description
ProductOrService	Required	String	Field indicates a valid `ProductOrService` for that dealer number or dealer id.

Example response:


[
    {
        "ProductOrService": "WATERTREAT"
    }
]

Validate Email for Dealer

Validates the submitted email is valid for that dealer's user.

POST v3/api/dealers/{dealerId}/validateEmail

Request attributes:

Property	Required/Optional	Type	Description
dealerId	Required	Long	Valid dealer Id that user has access to.

Example request:


  {
    "EmailAddress": "support@aquafinance.com"
  }

Response attributes:

Property	Required/Optional	Type	Description
EmailAddress	Required	String	Field relays back the email address sent in the request.
DealerId	Required	Long	Field relays back the dealer id sent in the request.

Example response:


  {
    "EmailAddress": "support@aquafinance.com",
    "DealerId": 7
  }

Dealer Attestation Statuses for User

Gets the attestation status of all dealers for the requesting Broker user. The NextAttestationDate and AttestWindowDays are null when attestation is not applicaple for that dealer.

GET /v3/api/dealers/attestation

Property	Nullable	Type	Description
DealerId	No	Long	Valid dealer Id that user has access to.
AttestationCompliant	No	Boolean	Field indicates whether or not the dealer is compliant. If not applicable, this will default to `true`.
NextAttestationDate	Yes	Date	The next date the dealer needs to attest.
AttestWindowDays	Yes	Integer	The amount of days the dealer has to attest.

Example response:


[
    {
        "DealerId": 1,
        "AttestationCompliant": true,
        "NextAttestationDate": "2028-01-01T00:00:00",
        "AttestWindowDays": 60
    },
    {
        "DealerId": 2,
        "AttestationCompliant": true,
        "NextAttestationDate": null,
        "AttestWindowDays": null
    },
    {
        "DealerId": 3,
        "AttestationCompliant": false,
        "NextAttestationDate": "2019-01-01T00:00:00",
        "AttestWindowDays": 60
    }
]

Submit Dealer Document

Submits document for a dealer.

POST /v3/api/dealers/{dealerId}/dealerDocuments

Request attributes:

Property	Required/Optional	Type	Description
DocumentName	Required	String	Field indicates the name of the document being uploaded.
Description	Required	String	Field indicates the decsription of the document being uploaded.
ViewDocumentType	Required	SupportingDocumentTypeEnum	Value must be `dealerDocument`.
Document	Required	Object

"Document" attributes:

Property	Required/Optional	Type	Description
FileName	Required	String	Files with these (.gif, .jpg, .jpeg, .tiff, .pdf, .docx, .png, .bmp) extensions are only allowed.
Content	Required	String	The file itself and MUST be `BASE64` encoded. Maximum file size is 30MB

Example request:


{
    "DocumentName": "Dealer Document",
    "Description": "dealer document",
    "ViewDocumentType": "dealerDocument",
    "Document": {
        "Filename": "myfile.png",
        "Content": "YmaImSFmhpgZYmaImSFmhpgZYmaImSFmhpgZYmaImSEXowYB+y/K/GkAAAAASUVORK5CYII="
    }
}