Agents

Agents_Create

Creates a new agent in Rev.io.

Input

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

Output

• ID As 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.
  Number As String – Account number of Agent.
  
  

Output

• Agent – Agent object.
  • ID As Integer – ID of existing agent. Required.
  • Name As String – Agent's Name.
  • Number As String – Agent's account number. Leave blank for auto-generated account number.
  • Phone As String - Agent's telephone number.
  • Fax As String – Agent's fax number.
  • Email As String – Agent's email address.
  • HoursOfOperation As String – Hours of operation.
  • LocationDetails As String – Details of agent location.
  • CommissionPlanID As Integer – Commission plan ID of agent.
  • Address – Address object
  • ID As Integer – Prohibited for this API function.
  • FirstName As String – Unused.
  • LastName As String – Unused.
  • Address1 As String – First line of Agent's address.
  • Address2 As String – Second line of Agent's address.
  • City As String – City.
  • State As String – State.
  • Zip As String – Zip Code (first 5 digits only).
  • Zip4 As String – +4 portion of zip code.
  • Country As 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.
  Name As String – Agent's Name.
  Number As String – Agent's account number. Leave blank for auto-generated account number.
  Phone As String - Agent's telephone number.
  Fax As String – Agent's fax number.
  Email As String – Agent's email address.
  HoursOfOperation As String – Hours of operation.
  LocationDetails As String – Details of agent location.
  CommissionPlanID As Integer – Commission plan ID of agent.
  Address – Address object
  ID As Integer – Prohibited for this API function.
  FirstName As String – Unused.
  LastName As String – Unused.
  Address1 As String – First line of Agent's address.
  Address2 As String – Second line of Agent's address.
  City As String – City.
  State As String – State.
  Zip As String – Zip Code (first 5 digits only).
  Zip4 As String – +4 portion of zip code.
  Country As String – 3 character Country ISO code. Defaults to USA if not specified.
  
  

Output
None