AccuLynx version.2.2422.0
New Endpoints Released!
New Jobs Endpoints
Get Insurance Companies
- Customers can consume the endpoint to get a list of Insurance Companies corresponding to the Company configured in the Company Settings.
GET /api/v2/company-settings/job-file-settings/insurance-companies
Set Job Insurance Company
- Customers can consume the endpoint to assign an Insurance Company to an existing Job in AccuLynx, Job ID is required for this action.
PUT /api/v2/jobs/{jobId}/insurance/insurance-company
Create Job
- Customers can consume the endpoint to create a job in AccuLynx with basic info. The only thing required to create a job is the contactId of an already existing contact.
POST /api/v2/jobs/Createjob
Financial Endpoint Updates
Job Accounting Integration Sync Status Changes
- Customers can consume the endpoint to check the status of the accounting integration status.
GET /api/v2/jobs/{jobId}/accounting/integration-status
New Webhooks Released!
Jobs
Change to Approved Job Value
- Customers can subscribe to this webhook to be notified of changes to the Approved Job Value of an existing Job in AccuLynx.
WEBHOOK job.financials.approved-value_changed
Change to Status
- Customers can subscribe to this webhook to be notified of changes to the Statuses of an existing Job in an Elite AccuLynx account that has custom workflows enabled.
WEBHOOK job.milestone.status.current_changed
Job Contact Details changed
- Customers can subscribe to this webhook to be notified of changes to the Contact Details on an existing Job in AccuLynx.
WEBHOOK contact_changed
Job Milestone changed
- Customers can subscribe to this webhook to be notified of changes to the Milestone on an existing Job in AccuLynx.
WEBHOOK job.milestone.current_changed
Job Created
- Customers can subscribe to this webhook to be notified when a new Job is created in AccuLynx.
WEBHOOK job_created
Job Updated
- Customers can subscribe to this webhook to be notified when an existing Job is updated in AccuLynx.
WEBHOOK job_updated
Financials
Invoice Updates
- Customers can subscribe to this webhook to be notified when an existing Invoice is updated in AccuLynx.
WEBHOOK invoice_updated
Invoice Voided
- Customers can subscribe to this webhook to be notified when an existing Invoices is voided in AccuLynx.
WEBHOOK invoice_voided
Job Accounting Integration Sync Status Changes
- Customers can subscribe to this webhook to be notified when a financial status is changed in AccuLynx.
WEBHOOK sync_status_changed
Improvements to existing Endpoints
Get milestones for a job
- Customers can consume the endpoint to get milestone progress details including who made the change and the date of the milestone change, for an existing Job in AccuLynx.
GET /api/v2/jobs/{jobId}/milestones/
Get a single milestone for a job by milestone ID
- Customers can consume the endpoint to get the current milestone & status for an active and existing Job, by milestone ID, in an Elite AccuLynx account that has custom workflows enabled.
GET /api/v2/jobs/{jobId}/milestones/{milestoneId}
Get the current milestone for a job
- Customers can consume this endpoint to get the current milestone & status (as supported by account type) for an active and existing Job in AccuLynx.
GET /jobs/{jobId}/milestones/current
Get the list of active jobs for a location
- Customers can consume this endpoint to get a list of active and existing Jobs in AccuLynx. This endpoint now includes the Job Priority.
GET /jobs
Get an active job by its JobID
- Customers can consume this endpoint to get an active Job in AccuLynx. This endpoint now includes the Job Priority.
GET /jobs/{jobId}
Improvements to existing Webhooks!
Jobs
Job Milestone Status Changed
- Customers can subscribe to this webhook to be notified when a job changes its status inside a given milestone.
WEBHOOK /api/v2/jobs/{jobId}/milestones/{milestoneId}/status/{statusId}
Introduction to Webhook Subscription
Subscribing to webhooks is a straightforward process that allows you to receive real-time notifications from AccuLynx whenever specific events occur. This integration enhances your application’s capabilities by automating data exchange and keeping your information up to date without manual intervention.
Basic Steps to Subscribe to a Webhook:
- Register an Endpoint: Create a URL on your server that will accept incoming webhook notifications.
- Use your Api Key to create a subscription using the API, and provide your registered URL.
- Choose Events: Select the types of events you wish to receive notifications for.
- Handle Notifications: Implement logic to process the incoming notifications on your server.
- Test Your Implementation: Ensure your system correctly handles webhook events and responds as expected.
- Monitor and Adjust: Keep an eye on your implementation for any errors and make necessary adjustments.
For more detailed instructions and guidelines on subscribing to webhooks, please refer to the full Documentation: