PUT v1/Agency/{id}

Update Agency

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

Agency ID

integer

Required

Body Parameters

AgencyDTO
NameDescriptionTypeAdditional information
CommissionCalcType

Calculation type for commission

CommissionCalcTypeEnum

None.

Agency1099Type

1099 type of the agency

TenNinetyNineTypeEnum

None.

Reportable1099

boolean

None.

TaxIdType

TinTypeEnum

None.

TaxId

string

String length: inclusive between 0 and 128

IRSControlNumber

string

String length: inclusive between 0 and 30

ExemptPayeeCode

Exempt Payee Code - Tax Purposes

string

String length: inclusive between 0 and 150

VendorId

string

String length: inclusive between 0 and 30

W9Address

W9 address of the agency

SystemEntityAddressDTO

None.

LocationAddress

Location address of the agency

SystemEntityAddressDTO

None.

MailingAddress

Mailing address of the agency

SystemEntityAddressDTO

None.

PayDirect

Applicable for subagencies

boolean

None.

AgencyBill

boolean

None.

AgencyBillType

If AgencyBill is true, this field must be specified

AgencyBillTypeEnum

None.

ExternalId

Identifier external to the DRC System; a custom Id

string

String length: inclusive between 0 and 30

ProducerCode

Producer code

string

String length: inclusive between 0 and 50

FirstName

string

String length: inclusive between 0 and 30

LastName

string

String length: inclusive between 0 and 30

CommercialName

string

String length: inclusive between 0 and 500

Email

string

None.

Role

Primary role of the agency. Changing the value of this field after the initial create request is highly unusual and should not be done without caution.

AgentPrimaryRoleEnum

None.

OrganizationIds

Ids of the organizations the agency belongs to

Collection of integer

None.

ParentAgencyId

integer

None.

ParentAgency

AgencyDTO

None.

IsActive

Indicates if the agency's user account is currently activated

boolean

Required

Commissions

Collection of AgentCommissionDTO

None.

Licenses

Collection of AgentLicenseDTO

None.

ErrorsAndOmissions

Collection of AgentErrorAndOmissionDTO

None.

Id

Primary Id

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "CommissionCalcType": "Unknown",
  "Agency1099Type": "Unknown",
  "Reportable1099": true,
  "TaxIdType": "Unknown",
  "TaxId": "sample string 1",
  "IRSControlNumber": "sample string 2",
  "ExemptPayeeCode": "sample string 3",
  "VendorId": "sample string 4",
  "W9Address": {
    "Type": "Unknown",
    "Address1": "sample string 1",
    "Address2": "sample string 2",
    "City": "sample string 3",
    "State": "sample string 4",
    "County": "sample string 5",
    "Country": "sample string 6",
    "Zipcode1": "sample string 7",
    "Zipcode2": "sample string 8",
    "Id": 9
  },
  "LocationAddress": {
    "Type": "Unknown",
    "Address1": "sample string 1",
    "Address2": "sample string 2",
    "City": "sample string 3",
    "State": "sample string 4",
    "County": "sample string 5",
    "Country": "sample string 6",
    "Zipcode1": "sample string 7",
    "Zipcode2": "sample string 8",
    "Id": 9
  },
  "MailingAddress": {
    "Type": "Unknown",
    "Address1": "sample string 1",
    "Address2": "sample string 2",
    "City": "sample string 3",
    "State": "sample string 4",
    "County": "sample string 5",
    "Country": "sample string 6",
    "Zipcode1": "sample string 7",
    "Zipcode2": "sample string 8",
    "Id": 9
  },
  "PayDirect": true,
  "AgencyBill": true,
  "AgencyBillType": "Unknown",
  "ExternalId": "sample string 5",
  "ProducerCode": "sample string 6",
  "FirstName": "sample string 7",
  "LastName": "sample string 8",
  "CommercialName": "sample string 9",
  "Email": "sample string 10",
  "Role": "Unknown",
  "OrganizationIds": [
    1,
    2
  ],
  "ParentAgencyId": 1,
  "IsActive": true,
  "Commissions": [
    {
      "EffectiveDate": "2022-01-20T04:36:30.5175168-10:00",
      "ExpirationDate": "2022-01-20T04:36:30.5175168-10:00",
      "Type": "Unknown",
      "Rate": 1.0,
      "LineOfBusiness": "sample string 1",
      "State": "sample string 2",
      "Country": "sample string 3",
      "CommissionOverrideCalcType": "Unknown",
      "UnderwritingCompanyId": 4,
      "PolicyClassification": "Unknown",
      "NewOrRenewal": "New",
      "Partner": "Unknown",
      "ChannelType": "Unknown",
      "CommissionOverride": true,
      "Id": 6
    },
    {
      "EffectiveDate": "2022-01-20T04:36:30.5175168-10:00",
      "ExpirationDate": "2022-01-20T04:36:30.5175168-10:00",
      "Type": "Unknown",
      "Rate": 1.0,
      "LineOfBusiness": "sample string 1",
      "State": "sample string 2",
      "Country": "sample string 3",
      "CommissionOverrideCalcType": "Unknown",
      "UnderwritingCompanyId": 4,
      "PolicyClassification": "Unknown",
      "NewOrRenewal": "New",
      "Partner": "Unknown",
      "ChannelType": "Unknown",
      "CommissionOverride": true,
      "Id": 6
    }
  ],
  "Licenses": [
    {
      "LicenseNumber": "sample string 1",
      "State": "sample string 2",
      "LicenseTypeId": 3,
      "EffectiveDate": "2022-01-20T04:36:30.5175168-10:00",
      "ExpirationDate": "2022-01-20T04:36:30.5175168-10:00",
      "Id": 4
    },
    {
      "LicenseNumber": "sample string 1",
      "State": "sample string 2",
      "LicenseTypeId": 3,
      "EffectiveDate": "2022-01-20T04:36:30.5175168-10:00",
      "ExpirationDate": "2022-01-20T04:36:30.5175168-10:00",
      "Id": 4
    }
  ],
  "ErrorsAndOmissions": [
    {
      "EffectiveDate": "2022-01-20T04:36:30.5175168-10:00",
      "ExpirationDate": "2022-01-20T04:36:30.5175168-10:00",
      "PolicyNumber": "sample string 1",
      "ErrorAndOmissionsCompanyId": 2,
      "Id": 3
    },
    {
      "EffectiveDate": "2022-01-20T04:36:30.5175168-10:00",
      "ExpirationDate": "2022-01-20T04:36:30.5175168-10:00",
      "PolicyNumber": "sample string 1",
      "ErrorAndOmissionsCompanyId": 2,
      "Id": 3
    }
  ],
  "Id": 11
}

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.