Payers
Payers overview
Payers
Payers overview
API reference for managing invoice payers
Overview
Payers are entities responsible for invoice payments. The Payers API enables managing:
- Payer information
- Customer associations
- Contact details
- Payment preferences
Core Concepts
Payer Properties
| Field | Description | Required |
|---|---|---|
customer_id | Associated customer | Yes |
email | Contact email | Yes |
name | Payer name | No |
company | Company name | No |
country | ISO3 country code | No |
Metadata Options
| Field | Description |
|---|---|
department | Department name |
cost_center | Cost center code |
payment_terms | Payment terms |
credit_limit | Credit limit |
Validation Rules
Country Code
- Must be ISO 3166-1 alpha-3
- Pattern:
^[A-Z]{3}$ - Must be active country
Contact Rules
- Valid email format
- Valid customer reference
- Unique email per customer
Security Requirements
- Customer-scoped access
- Role-based permissions
- Audit logging
- Data validation
See individual endpoint documentation for detailed request/response formats and examples.