Producers

Manage insurance producers (agents/brokers) and their commission structures.

Create Producer

Creates a new producer record.

Endpoint: POST /v1/producers

Use Cases:

Onboard new agents/brokers
Set up commission structures
Configure payout preferences

Request Body:

Field	Type	Required	Description
`producer_name`	string	Yes	Producer/agent name
`contact_name`	string	No	Primary contact name
`contact_email`	string	No	Contact email
`contact_phone`	string	No	Contact phone
`external_account_id`	string	No	Bank account for payouts
`recurrence_payout_enabled`	boolean	No	Enable automatic payouts
`recurrence_payout_day`	integer	No	Day of month for payouts (1-28)
`transfer_speed`	string	No	Payout speed (default: `ach`)
`minimal_monthly_threshold`	number/string	No	Minimum amount for payout
`memo`	string	No	Notes (max 250 chars)
`company_name_on_invoices`	string	No	Company name to display on invoices
`company_email_on_invoices`	string	No	Company email to display on invoices
`company_phone_on_invoices`	string	No	Company phone to display on invoices
`notifications_email_enabled`	boolean	No	Enable email notifications
`notifications_email_template`	string	No	Email notification template

Example:

curl -X POST "https://api.advancehq.com/v1/producers" \
  -H "Authorization: Bearer your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "producer_name": "Smith Insurance Agency",
    "contact_name": "Jane Smith",
    "contact_email": "[email protected]",
    "contact_phone": "555-234-5678",
    "recurrence_payout_enabled": true,
    "recurrence_payout_day": 15,
    "minimal_monthly_threshold": "100.00"
  }'

Response:

{
  "producer_id": "prod_abc123def456",
  "producer_name": "Smith Insurance Agency",
  "contact_info": {
    "name": "Jane Smith",
    "email": "[email protected]",
    "phone": "555-234-5678"
  },
  "recurrence_payout_enabled": true,
  "recurrence_payout_day": 15,
  "minimal_monthly_threshold": "100.00",
  "company_name_on_invoices": null,
  "company_email_on_invoices": null,
  "company_phone_on_invoices": null,
  "memo": null
}

List All Producers

Retrieves all producer records.

Endpoint: GET /v1/producers

Example:

curl -X GET "https://api.advancehq.com/v1/producers" \
  -H "Authorization: Bearer your_api_key"

Get Producer by ID

Retrieves a specific producer record.

Endpoint: GET /v1/producers/{producer_id}

Example:

curl -X GET "https://api.advancehq.com/v1/producers/prod_abc123" \
  -H "Authorization: Bearer your_api_key"

Update Producer

Updates an existing producer record.

Endpoint: PUT /v1/producers/{producer_id}

Example:

curl -X PUT "https://api.advancehq.com/v1/producers/prod_abc123" \
  -H "Authorization: Bearer your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "contact_email": "[email protected]",
    "recurrence_payout_day": 1
  }'