AccuLynx is a cloud-based business management platform built for roofing and exterior contractors. It centralizes jobs, contacts, estimates, financials, invoicing, payments, and scheduling in a single system. The AccuLynx REST API exposes this data so you can move job, contact, estimate, and financial records in and out of AccuLynx programmatically.
Power end-to-end data operations for your AccuLynx API with Nexla. Our bi-directional AccuLynx connector is purpose-built for AccuLynx, making it simple to ingest data, sync it across systems, and deliver it anywhere — all with no coding required. Nexla turns API-sourced data into ready-to-use, reusable data products and makes it easy to send data to AccuLynx or any other destination. With comprehensive monitoring, lineage tracking, and access controls, Nexla keeps your AccuLynx workflows fast, secure, and fully governed.
Features
Type: API
SourceDestination
Seamless API Integration: Connect to any endpoint as source or destination without coding, with automatic data product creation
Visual Composition & Chaining: Build complex integrations using visual templates, chain API calls, and compose workflows with data validation and filtering
API Proxy: Expose curated slices of your data securely with a secure and customizable API proxy that validates and transforms data on the fly
Request optimization with intelligent batching, retry, and caching to minimize API calls and costs
Before creating an AccuLynx credential in Nexla, you need an API Key from your AccuLynx account. AccuLynx authenticates every API request with an API Key sent as a Bearer token in the Authorization header. API Keys are scoped to a single location, so each location within a company that you want to connect requires its own key.
API Keys can only be created by a Location or Company Administrator. To generate one:
Sign in to AccuLynx at https://my.acculynx.com with an account that has administrator privileges.
Open Account Settings, then navigate to Add-On Features and Integrations > API Keys. You can also go directly to https://my.acculynx.com/apikeys.
Click Create Key to generate a new API Key for the current location.
Enter a descriptive name for the key (for example, "Nexla Integration") so it can be identified later.
Copy the generated API Key and store it securely. Treat it like a password, since anyone who holds it can read or modify your company data.
warning
If you manage multiple locations, generate a separate API Key for each location you intend to connect, as a key only grants access to the location it was created under.
If you are a software vendor building a productized integration with AccuLynx rather than connecting your own company's data, AccuLynx additionally requires approval through their Partnership Application before granting integrator access. For complete details, see the AccuLynx API documentation and the AccuLynx authentication guide.
Your AccuLynx API Key, generated by your company administrator at https://my.acculynx.com/apikeys. Third-party integrators must additionally request access via AccuLynx's integrator access form.
After selecting the AccuLynx data source or destination type, click the Add Credential tile to open the Add New Credential overlay.
Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.
Enter your AccuLynx API Key in the API Key field. This is the key you generated in Prerequisites. Nexla sends it as a Bearer token in the Authorization header on every request to the AccuLynx API.
Because the API Key grants full access to the location's data, keep it confidential. If a key is compromised, revoke it in your AccuLynx API Keys settings and generate a replacement.
Click the Save button at the bottom of the overlay. The newly added credential will now appear in a tile on the Authenticate screen during data source or destination creation.
To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Select the AccuLynx connector tile, then select the credential that will be used to connect to AccuLynx, and click Next; or, create a new AccuLynx credential for use in this flow.
Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common AccuLynx endpoints. Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below. Endpoints that operate on a specific record require you to supply the relevant identifier (such as a Job, Contact, Estimate, Financials, Supplement, or Calendar ID) when configuring the source.
[Rest API] Get Jobs
Get a listing of Jobs.
This endpoint retrieves jobs for the location associated with your API Key. Results are paginated automatically, so Nexla fetches subsequent pages until all records have been ingested.
[Rest API] Get Lead History
Get a history of actions performed for a lead.
Provide the LeadId of the lead whose history you want to ingest. Results are paginated automatically.
[Rest API] Get Contacts
Get a listing of Contacts.
This endpoint retrieves contacts for the location associated with your API Key. Results are paginated automatically.
[Rest API] Get Webhook Subscriptions
Get all available webhook subscriptions for the company.
This endpoint lists the webhook subscriptions configured for the company. Results are paginated automatically.
[Rest API] Get Estimates
Get all estimates for the current location.
This endpoint retrieves estimates for the location associated with your API Key. Results are paginated automatically.
[Rest API] Get Users
Get a listing of users.
This endpoint retrieves users for the location associated with your API Key. Results are paginated automatically.
[Rest API] Get Job History
Get a history of actions performed for a job.
Provide the JobId of the job whose history you want to ingest. Results are paginated automatically.
[Rest API] Get Job Milestone History
Get milestone history for the specified Job.
Provide the JobId of the job whose milestone history you want to ingest. Results are paginated automatically.
[Rest API] Get Job Contacts
Get the list of contacts for a job.
Provide the JobId of the job whose contacts you want to ingest. Results are paginated automatically.
[Rest API] Get Estimates for Job
Get a list of estimates for the specified job.
Provide the JobId of the job whose estimates you want to ingest. Results are paginated automatically.
[Rest API] Get Financials for Job
Get the Financials for the specified job.
Provide the JobId of the job whose financials you want to ingest. This endpoint returns a single financials object for the job.
[Rest API] Get Invoices for Job
Get a list of invoices for the specified job.
Provide the JobId of the job whose invoices you want to ingest. Results are paginated automatically.
[Rest API] Get Job Payments
Get payments information for the specified job.
Provide the JobId of the job whose payments you want to ingest. This endpoint returns the payments object for the job.
[Rest API] Get Job Representatives
Get the list of representatives for a Job.
Provide the JobId of the job whose representatives you want to ingest. Results are paginated automatically.
[Rest API] Get Job Custom Fields
Get all the custom fields related to a specific job.
Provide the JobId of the job whose custom fields you want to ingest. Results are paginated automatically.
[Rest API] Get Job Insurance Information
Get the job's insurance information.
Provide the JobId of the job whose insurance information you want to ingest. This endpoint returns a single insurance object for the job.
[Rest API] Get Job Adjuster Information
Get the job's insurance adjuster information.
Provide the JobId of the job whose adjuster information you want to ingest. This endpoint returns a single adjuster object for the job.
[Rest API] Get Job Initial Appointment
Get the initial appointment for a job.
Provide the JobId of the job whose initial appointment you want to ingest. This endpoint returns a single appointment object for the job.
[Rest API] Get Contact Custom Fields
Get a list of all custom fields for a specific contact.
Provide the ContactId of the contact whose custom fields you want to ingest. Results are paginated automatically.
[Rest API] Get Contact Email Addresses
Get the list of email addresses for a specific contact.
Provide the ContactId of the contact whose email addresses you want to ingest. Results are paginated automatically.
[Rest API] Get Contact Phone Numbers
Get the list of phone numbers for a specific contact.
Provide the ContactId of the contact whose phone numbers you want to ingest. Results are paginated automatically.
[Rest API] Get Contact Types
Get the list of contact types from a company.
This endpoint lists the contact types defined for the company. Results are paginated automatically.
[Rest API] Get Estimate Sections
Get all sections for the given estimate.
Provide the EstimateId of the estimate whose sections you want to ingest. Results are paginated automatically.
[Rest API] Get Estimate Section Items
Get all items for the given estimate section.
Provide both the EstimateId and the EstimateSectionId to scope the request to a specific section's items. Results are paginated automatically.
[Rest API] Get Worksheet
Get a specific Worksheet by financialId.
Provide the FinancialsId of the financials record whose worksheet you want to ingest. This endpoint returns a single worksheet object.
[Rest API] Get Financial Amendments
Get a specific Financial's Amendments.
Provide the FinancialsId of the financials record whose amendments you want to ingest. Results are paginated automatically.
[Rest API] Get Supplements
Get financial supplements for the company.
This endpoint lists the financial supplements for the company. Results are paginated automatically.
[Rest API] Get Supplement Items
Get items for a specific supplement.
Provide the SupplementId of the supplement whose items you want to ingest. Results are paginated automatically.
[Rest API] Get Calendars
Get a list of calendars for the location.
This endpoint lists the calendars for the location associated with your API Key. Results are paginated automatically.
[Rest API] Get Calendar Appointments
Get a list of appointments for the specified calendar.
Provide the CalendarId along with a Start Date and End Date (in YYYY-MM-DD format). The date range must not exceed 90 days. Results are paginated automatically.
Once the selected endpoint template has been configured, click the Test button to the right of the endpoint selection menu to retrieve a sample of the data that will be fetched. Sample data will be displayed in the Endpoint Test Result panel on the right, allowing you to verify that the source is configured correctly before saving.
AccuLynx data sources can also be manually configured to ingest data from any valid AccuLynx API endpoint, including endpoints not covered by the pre-built templates, chained API calls, or custom request parameters. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, endpoint URL, date/time and lookup macros, path to data, metadata, and request headers.
Once all of the relevant settings have been configured, click the Create button in the upper right corner of the screen to save and create the new AccuLynx data source. Nexla will now begin ingesting data from the configured endpoint and will organize any data that it finds into one or more Nexsets.
Click the + icon on the Nexset that will be sent to the AccuLynx destination, and select the Send to Destination option from the menu. Select the AccuLynx connector from the list of available destination connectors, then select the credential that will be used to connect to AccuLynx, and click Next; or, create a new AccuLynx credential for use in this flow.
Nexla provides pre-built templates that can be used to rapidly configure destinations to send data to common AccuLynx endpoints. Select the endpoint to which data will be sent from the Endpoint pulldown menu. Then, click on the template in the list below to expand it, and follow the instructions to configure additional endpoint settings. Endpoints that act on a specific record require you to supply the relevant identifier (such as a Job, Contact, Custom Field, Financials, Message, or Subscription ID).
[Rest API] Create Contact
Create a new contact.
Each record from your Nexset is sent as a JSON request body to create a new contact in AccuLynx.
[Rest API] Update Contact Custom Fields
Set multiple custom field values for a contact.
Provide the ContactId to target. Each record from your Nexset is sent as a JSON request body containing the custom field values to set.
[Rest API] Update Contact Custom Field
Set a value for a specific custom field for a contact.
Provide the ContactId and the CustomFieldId to target. Each record from your Nexset is sent as a JSON request body containing the value to set.
[Rest API] Create Contact Log
Create a new log entry for an existing contact.
Provide the ContactId to target. Each record from your Nexset is sent as a JSON request body describing the log entry.
[Rest API] Create Worksheet Item
Create a new item in a worksheet using its financial ID.
Provide the FinancialsId to target. Each record from your Nexset is sent as a JSON request body describing the worksheet item.
[Rest API] Create Job
Create a new job.
Each record from your Nexset is sent as a JSON request body to create a new job in AccuLynx.
[Rest API] Create Job External Reference
Create a new external reference for a job.
Each record from your Nexset is sent as a JSON request body to create a new external reference for a job.
[Rest API] Update Job Address
Update the location address for a job.
Provide the JobId to target. Each record from your Nexset is sent as a JSON request body containing the updated address.
[Rest API] Update Job Adjuster
Update the insurance adjuster information for a job.
Provide the JobId to target. Each record from your Nexset is sent as a JSON request body containing the updated adjuster information.
[Rest API] Update Job Custom Fields
Set multiple custom field values for a job.
Provide the JobId to target. Each record from your Nexset is sent as a JSON request body containing the custom field values to set.
[Rest API] Update Job Custom Field
Set a value for a specific custom field for a job.
Provide the JobId and the CustomFieldId to target. Each record from your Nexset is sent as a JSON request body containing the value to set.
[Rest API] Add Job Document
Add a job document for a specific job.
Provide the JobId to target. Each record from your Nexset is sent as a JSON request body describing the document to add.
[Rest API] Delete Job Initial Appointment
Remove the initial appointment assigned to an existing job.
Provide the JobId to target. This endpoint removes the initial appointment currently assigned to the job.
[Rest API] Update Job Initial Appointment
Set the initial appointment for a job.
Provide the JobId to target. Each record from your Nexset is sent as a JSON request body describing the initial appointment.
[Rest API] Update Job Insurance
Update the job's insurance information.
Provide the JobId to target. Each record from your Nexset is sent as a JSON request body containing the updated insurance information.
[Rest API] Update Job Insurance Company
Update the insurance company for a job.
Provide the JobId to target. Each record from your Nexset is sent as a JSON request body containing the updated insurance company.
[Rest API] Update Job Categories
Update the job categories for a job.
Provide the JobId to target. Each record from your Nexset is sent as a JSON request body containing the job categories to set.
[Rest API] Update Job Lead Source
Update the lead source for a job.
Provide the JobId to target. Each record from your Nexset is sent as a JSON request body containing the updated lead source.
[Rest API] Upload Job Measurements
Upload measurements for a job.
Provide the JobId to target. Each record from your Nexset is sent as a JSON request body containing the measurements to upload.
[Rest API] Upload Job Measurement Files
Upload measurement files for a job.
Provide the JobId to target. Each record from your Nexset is sent as a JSON request body referencing the measurement files to upload.
[Rest API] Create Job Message
Create a job message.
Provide the JobId to target. Each record from your Nexset is sent as a JSON request body containing the message.
[Rest API] Reply to Job Message
Reply to a job message.
Provide the JobId and the MessageId to target. Each record from your Nexset is sent as a JSON request body containing the reply.
[Rest API] Create Payment Expense
Create an additional expense payment for a job.
Provide the JobId to target. Each record from your Nexset is sent as a JSON request body describing the expense payment.
[Rest API] Create Payment Paid
Record a paid payment for a job.
Provide the JobId to target. Each record from your Nexset is sent as a JSON request body describing the paid payment.
[Rest API] Create Payment Received
Record a received payment for a job.
Provide the JobId to target. Each record from your Nexset is sent as a JSON request body describing the received payment.
[Rest API] Upload Job Photo or Video
Upload a photo or video for a job.
Provide the JobId to target. Each record from your Nexset is sent as a JSON request body referencing the photo or video to upload.
[Rest API] Update Job Priority
Update the priority for a job.
Provide the JobId to target. Each record from your Nexset is sent as a JSON request body containing the updated priority.
[Rest API] Delete A/R Owner
Remove the A/R owner from a job.
Provide the JobId to target. This endpoint removes the accounts-receivable owner currently assigned to the job.
[Rest API] Set A/R Owner
Add or update the A/R Owner for a job.
Provide the JobId to target. Each record from your Nexset is sent as a JSON request body identifying the accounts-receivable owner.
[Rest API] Set Company Representative
Update the company representative for a job.
Provide the JobId to target. Each record from your Nexset is sent as a JSON request body identifying the company representative.
[Rest API] Delete Sales Owner
Remove the sales owner from a job.
Provide the JobId to target. This endpoint removes the sales owner currently assigned to the job.
[Rest API] Set Sales Owner
Add or update the sales owner for a job.
Provide the JobId to target. Each record from your Nexset is sent as a JSON request body identifying the sales owner.
[Rest API] Update Job Trade Types
Update the trade types for a job.
Provide the JobId to target. Each record from your Nexset is sent as a JSON request body containing the trade types to set.
[Rest API] Update Job Work Type
Update the work type for a job.
Provide the JobId to target. Each record from your Nexset is sent as a JSON request body containing the updated work type.
[Rest API] Create Webhook Subscription
Create a webhook subscription for a set of topics.
Each record from your Nexset is sent as a JSON request body describing the webhook subscription and the topics to subscribe to.
[Rest API] Delete Webhook Subscription
Delete an active webhook subscription.
Provide the SubscriptionId to target. This endpoint deletes the specified webhook subscription.
[Rest API] Update Webhook Subscription
Update an existing webhook subscription.
Provide the SubscriptionId to target. Each record from your Nexset is sent as a JSON request body containing the updated subscription settings.
[Rest API] Send Webhook Test Event
Send a non-persisted test event to a webhook listener.
Provide the SubscriptionId to target. This endpoint sends a test event to the subscription's listener without persisting it.
AccuLynx destinations can also be manually configured to send data to any valid AccuLynx API endpoint. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, data format, endpoint URL, request headers, attribute exclusions, record batching, and response webhooks.
AccuLynx APIs expect JSON in the request body for create and update operations. For endpoints that act on a specific record, include the relevant identifier (such as the job or contact ID) in the endpoint URL.
Once all endpoint settings have been configured, click the Done button in the upper right corner of the screen to save and create the destination. To send the data to the configured AccuLynx endpoint, open the destination resource menu, and select Activate.
The Nexset data will not be sent to the AccuLynx endpoint until the destination is activated. Destinations can be activated immediately or at a later time, providing full control over data movement.
