Agents

Agents_Create

Creates a new agent in Rev.io.

Input

  • Agent – Agent object.
    ID As Integer – Prohibited for this API function.
 NameAs String – Agent's Name.
    Number As String – Agent's account number. Leave blank for auto-generated account number.
 PhoneAs String - Agent's telephone number.
    Fax As String – Agent's fax number.
 EmailAs String – Agent's email address.
    HoursOfOperation As String – Hours of operation.
 LocationDetailsAs String – Details of agent location.
    CommissionPlanID As Integer – Commission plan ID of agent.
 Address – Address object
    ID As Integer – Prohibited for this API function.
 FirstNameAs String – Unused.
    LastName As String – Unused.
 Address1As String – First line of Agent's address.
    Address2 As String – Second line of Agent's address.
 CityAs String – City.
    State As String – State.
 ZipAs String – Zip Code (first 5 digits only).
    Zip4 As String – +4 portion of zip code.
 CountryAs String – 3 character Country ISO code. Defaults to USA if not specified.\

Output

  • IDAs Integer – ID of new agent created.

Agents_Query

Look up an agent's information.

Input

  • Choice of the following:
    ID As Integer – ID of Agent.
 NumberAs String – Account number of Agent.\

Output

  • Agent – Agent object.
    • IDAs Integer – ID of existing agent. Required.
    • NameAs String – Agent's Name.
    • NumberAs String – Agent's account number. Leave blank for auto-generated account number.
    • PhoneAs String - Agent's telephone number.
    • FaxAs String – Agent's fax number.
    • EmailAs String – Agent's email address.
    • HoursOfOperationAs String – Hours of operation.
    • LocationDetailsAs String – Details of agent location.
    • CommissionPlanIDAs Integer – Commission plan ID of agent.
    • Address – Address object
    • IDAs Integer – Prohibited for this API function.
    • FirstNameAs String – Unused.
    • LastNameAs String – Unused.
    • Address1As String – First line of Agent's address.
    • Address2As String – Second line of Agent's address.
    • CityAs String – City.
    • StateAs String – State.
    • ZipAs String – Zip Code (first 5 digits only).
    • Zip4As String – +4 portion of zip code.
    • CountryAs String – 3 character Country ISO code. Defaults to USA if not specified.

Agents_Update

Updates an existing agent in Rev.io.

Input

  • Agent – Agent object.
    ID As Integer – ID of existing agent. Required.
 NameAs String – Agent's Name.
    Number As String – Agent's account number. Leave blank for auto-generated account number.
 PhoneAs String - Agent's telephone number.
    Fax As String – Agent's fax number.
 EmailAs String – Agent's email address.
    HoursOfOperation As String – Hours of operation.
 LocationDetailsAs String – Details of agent location.
    CommissionPlanID As Integer – Commission plan ID of agent.
 Address – Address object
    ID As Integer – Prohibited for this API function.
 FirstNameAs String – Unused.
    LastName As String – Unused.
 Address1As String – First line of Agent's address.
    Address2 As String – Second line of Agent's address.
 CityAs String – City.
    State As String – State.
 ZipAs String – Zip Code (first 5 digits only).
    Zip4 As String – +4 portion of zip code.
 CountryAs String – 3 character Country ISO code. Defaults to USA if not specified.\

Output
None