Authentication endpoints for obtaining access tokens and managing API keys.
Aiwyn API (1.0.0)
The Aiwyn API provides programmatic access to our comprehensive suite of financial automation tools. Build powerful integrations and automate your accounting workflows with our RESTful APIs.
- 🔐 Secure Authentication - Industry-standard OAuth 2.0 and API key authentication
- 📊 Real-time Data - Access up-to-date financial information
- 🚀 High Performance - Low latency, high throughput API infrastructure
- 📚 Comprehensive Coverage - Full access to clients, engagements, expenses, and more
- 🛠️ Developer-Friendly - Extensive documentation, SDKs, and code examples
Request
Project engagement tracking with comprehensive workflow management
This endpoint delivers complete project engagement management including:
- Client engagement tracking with date-based filtering
- Multi-level staff assignment management (partner and manager roles)
- Project status workflow tracking and reporting
- Template-driven engagement naming and standardization
- Date range analysis for project timeline management
Project Management Capabilities:
- Start and end date tracking for project lifecycles
- Status-based workflow management (ACTIVE, COMPLETED, ON_HOLD, EXECUTED, etc.)
- Staff assignment tracking at partner and manager levels
- Client relationship management for engagement context
Workflow Features:
- Template-based engagement creation for consistency
- Status progression tracking for project milestones
- Staff allocation and responsibility assignment
- Client-specific engagement history and analysis
Business Intelligence:
- Engagement duration analysis and reporting
- Staff utilization and assignment tracking
- Client engagement patterns and history
- Project status distribution and workflow analysis
Filtering and Analysis:
- Client-specific engagement retrieval
- Status-based workflow filtering
- Date range queries for period analysis
- Staff assignment reporting and allocation
Real Example:
curl --location 'https://{{host}}/v1/engagements' \
--header 'Authorization: bearer {{token}} \
--header 'Content-Type: application/json' \
--data '{
"pageSize": 25,
"page": 0
}'Filter by engagement status
- Mock serverhttps://api.doc.aiwyn.ai/_mock/bundle/gql/v1/engagements
- Staging Environment (Test Data)https://demo.api.aiwyn.ai/gql/v1/engagements
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://api.doc.aiwyn.ai/_mock/bundle/gql/v1/engagements \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"pageSize": 25,
"page": 0
}'{ "deid_engagement": [ { … }, { … } ], "deid_engagement_aggregate": { "aggregate": { … } } }
Request
Search Engagements with Dynamic Filters
This endpoint allows you to search engagements using dynamic filters, enabling flexible querying based on various criteria.
Features:
- Supports multiple filter conditions
- Pagination for large result sets
- Sorting options for results
Example Usage:
curl --location 'https://{{host}}/v1/engagements/search' \
--data '{
"pageSize": 1,
"where": {
"_and": [
{
"_or": [
{
"name": {
"_ilike": "%review%"
}
},
{
"engagementNameTemplate": {
"_ilike": "%tax%"
}
}
]
},
{
"status": {
"_in": ["ACTIVE", "EXECUTED"]
}
},
{
"createdAt": {
"_gte": "1900-01-01T00:00:00Z"
}
},
{
"partnerStaffId": {
"_in": [
5,
6,
7,
8
]
}
}
]
},
"orderBy": [
{
"name": "asc"
},
{
"createdAt": "desc"
}
]
}'GraphQL-style where clause for complex filtering
- Mock serverhttps://api.doc.aiwyn.ai/_mock/bundle/gql/v1/engagements/search
- Staging Environment (Test Data)https://demo.api.aiwyn.ai/gql/v1/engagements/search
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://api.doc.aiwyn.ai/_mock/bundle/gql/v1/engagements/search \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"limit": 1,
"where": {
"_and": [
{
"_or": [
{
"name": {
"_ilike": "%review%"
}
},
{
"engagementNameTemplate": {
"_ilike": "%tax%"
}
}
]
},
{
"status": {
"_in": [
"ACTIVE",
"EXECUTED"
]
}
},
{
"createdAt": {
"_gte": "1900-01-01T00:00:00Z"
}
},
{
"partnerStaffId": {
"_in": [
5,
6,
7,
8
]
}
}
]
},
"orderBy": [
{
"name": "asc"
},
{
"createdAt": "desc"
}
]
}'{ "engagements": [ { … } ], "totalCount": 100 }
Request
Retrieve a specific engagement by its unique identifier
This endpoint provides detailed engagement information including:
- Complete engagement details and scope
- Engagement status and lifecycle information
- Client relationship and contact details
- Project portfolio and deliverables
- Team assignments and resource allocation
- Financial terms and billing arrangements
Engagement Management Features:
- Engagement lifecycle tracking
- Client relationship management
- Project portfolio oversight
- Team resource allocation
- Financial terms and billing setup
Engagement Details Include:
- Engagement name and description
- Engagement status and type
- Client and contact information
- Project portfolio details
- Team assignments
- Financial terms and billing
Business Applications:
- Engagement status monitoring
- Client relationship management
- Project portfolio analysis
- Resource allocation planning
- Financial performance tracking
Real Example:
curl --location 'https://{{host}}/v1/engagement/34567' \
--header 'Authorization: bearer {{token}}' \
--header 'Content-Type: application/json'Response Example:
{
"id": 34567,
"name": "Annual Audit Engagement 2024",
"description": "Comprehensive annual audit engagement including financial statements, tax preparation, and compliance review",
"status": "ACTIVE",
"type": "AUDIT",
"clientId": 789,
"clientName": "Acme Corporation",
"clientEmail": "finance@acme.com",
"clientPhone": "+1-555-0123",
"startDate": "2024-01-01T00:00:00Z",
"endDate": "2024-12-31T23:59:59Z",
"estimatedValue": 50000.00,
"currency": "USD",
"projects": [
{
"id": 67890,
"name": "Q4 Financial Audit",
"status": "IN_PROGRESS",
"budget": 25000.00
},
{
"id": 67891,
"name": "Tax Preparation",
"status": "PLANNING",
"budget": 15000.00
}
],
"teamMembers": [
{
"staffId": 123,
"name": "John Smith",
"role": "ENGAGEMENT_PARTNER",
"allocation": 0.3
},
{
"staffId": 124,
"name": "Jane Doe",
"role": "SENIOR_MANAGER",
"allocation": 0.8
}
],
"billingTerms": {
"billingFrequency": "MONTHLY",
"paymentTerms": "NET_30",
"rateType": "HOURLY",
"defaultRate": 250.00
},
"notes": "Annual engagement with quarterly reviews and monthly billing",
"createdAt": "2023-12-15T10:00:00Z",
"updatedAt": "2024-11-20T14:30:00Z"
}- Mock serverhttps://api.doc.aiwyn.ai/_mock/bundle/gql/v1/engagement/{id}
- Staging Environment (Test Data)https://demo.api.aiwyn.ai/gql/v1/engagement/{id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
https://api.doc.aiwyn.ai/_mock/bundle/gql/v1/engagement/34567 \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'Engagement details retrieved successfully
Detailed engagement description
Engagement status
Engagement type
Additional notes or terms
{ "id": 34567, "name": "Annual Audit Engagement 2024", "description": "Comprehensive annual audit engagement including financial statements, tax preparation, and compliance review", "status": "ACTIVE", "type": "AUDIT", "clientId": 789, "clientName": "Acme Corporation", "clientEmail": "finance@acme.com", "clientPhone": "+1-555-0123", "startDate": "2024-01-01T00:00:00Z", "endDate": "2024-12-31T23:59:59Z", "estimatedValue": 50000, "currency": "USD", "projects": [ { … } ], "teamMembers": [ { … } ], "billingTerms": { "billingFrequency": "MONTHLY", "paymentTerms": "NET_30", "rateType": "HOURLY", "defaultRate": 250 }, "notes": "Annual engagement with quarterly reviews and monthly billing", "createdAt": "2023-12-15T10:00:00Z", "updatedAt": "2024-11-20T14:30:00Z" }