New Custom Fields Endpoints in Public API V2

1. Get a Single Contact Custom Field Value

Endpoint: GET /api/v2/contacts/{contactId}/custom-fields/{customFieldId}

Purpose: Retrieve the value(s) of a specific custom field for a given contact by providing the contact ID and custom field ID.

Capabilities:

• Provides access to data in specified custom field for a specified contact.
• Supports various custom field types (text, numbers, dates, selection, boolean).

2. Set a Single Contact Custom Field Value

Endpoint: PUT /api/v2/contacts/{contactId}/custom-fields/{customFieldId}/

Purpose: Set or update the value(s) of a specific custom field associated with a contact.

Capabilities:

• Creates or updates data for a specified custom field for a specified contact.
• Additionally ensures the custom field exists, is active, and the value conforms to the defined format.
• Supports various custom field types (text, numbers, dates, selection, boolean).

3. Get All Contact Custom Fields

Endpoint: GET /api/v2/contacts/{contactId}/custom-fields

Purpose: Retrieve a list of all custom fields associated with a specific contact by providing the contact ID.

Capabilities:

• Provides access to data in all active custom fields for a specified contact.
• Supports various custom field types (text, numbers, dates, selection, boolean).

4. Get a Single Job Custom Field Value

Endpoint**: GET /api/v2/jobs/{jobId}/custom-fields/{customFieldId}

Purpose: Retrieve the value(s) of a specific custom field associated with a job by providing the job ID and custom field ID.

Capabilities:

• Provides access to data in specified custom field for a specified job.
• Supports various custom field types (text, numbers, dates, selection, boolean)

5. Set a Single Job Custom Field Value

Endpoint: PUT /api/v2/jobs/{jobId}/custom-fields/{customFieldId}/

Purpose: Set or update the value(s) of a specific custom field associated with a job.

Capabilities:

• Creates or updates data for a specified custom field for a specified job.
• Additionally ensures the custom field exists, is active, and the value conforms to the defined format.
• Supports various custom field types (text, numbers, dates, selection, boolean)

6. Get All Job Custom Fields

Endpoint: GET /api/v2/jobs/{jobId}/custom-fields

Purpose: Retrieve a list of all custom fields associated with a specific job by providing the job ID.

Capabilities:

• Provides access to data in all active custom fields for a specified job.
• Supports various custom field types (text, numbers, dates, selection, boolean)

7. Get Custom Fields Definitions

Endpoint: GET /api/v2/company-settings/custom-fields/

Purpose: Retrieve all active custom field definitions and their associated field options for a company.

Capabilities:

• Provides access to all active custom field definitions and their associated options within a location.
• Supports filtering by AccuLynx object type (e.g., jobs, contacts) and includes pagination for large datasets.

---

New Webhooks for Custom Fields

1. Contact Custom Field Status Changed

Webhook Name: contact.custom-field.status_changed

Purpose: Notifies subscribers whenever the status of a custom field associated with a contact changes.

Capabilities:

• Provides real-time updates when the status of a contact custom field changes (e.g., from active to inactive), eliminating the need for manual monitoring and enabling immediate downstream actions.
• Includes information such as the custom field ID, field label, new status, and the user who made the modification

2. Contact Custom Field Value Updated

Webhook Name: contact.custom-field.value_changed

Purpose: Notifies subscribers whenever a custom field value for a contact is updated.

Capabilities:

• Provides real-time updates when a contact custom field is populated or its value changes, enabling automated workflows and downstream actions based on those updates.
• Includes detailed information such as the contact ID, custom field ID, updated value(s), the user who made the modification, and the timestamp of the change.

3. Job Custom Field Status Changed

Webhook Name: job.custom-field.status_changed

Purpose: Notifies subscribers whenever the status of a custom field associated with a job changes.

Capabilities:

• Provides real-time updates when the status of a job custom field changes (e.g., from active to inactive), eliminating the need for manual monitoring and enabling immediate downstream actions.
• Includes detailed information such as the custom field ID, label, new status, and the user who made the modification.

4. Job Custom Field Value Updated

Webhook Name: job.custom-field.value_changed

Purpose: Notifies subscribers whenever a custom field value for a job is updated.

Capabilities:

• Provides real-time updates when a job custom field is populated or its value changes, enabling automated workflows and downstream actions based on those updates.
• Includes detailed information such as the contact ID, custom field ID, updated value(s), the user who made the modification, and the timestamp of the change

AccuLynx Public API V1 Documentation has been removed.
V1 provided the capability of creating new leads in AccuLynx.

This can be achieved in V2 using the Create Job endpoint. Also, V2 provides several endpoints to perform different actions in a job, like assigning it, setting an initial appointment, etc.

V1 endpoints are still functional; nevertheless, we encourage all our customers to switch to V2 endpoints.

New Endpoints Released

Call Log for Contact ID:

POST /api/v2/contacts/{contactId}/logs/

This endpoint allows users to create a log entry for a specific contact by its ID. The log can include details such as the type of communication (e.g., phone call, SMS, email), the date of the interaction, and an optional description.

Updated Endpoints

Financial Endpoints:

GET /api/v2/invoices/{invoiceId}

GET /api/v2/financials/{financialId}/worksheet

GET /api/v2/financials/{financialId}/amendments/{amendmentId}

These endpoints allow users to retrieve detailed information about a specific invoice by its ID. By adding the TradeID property to the items collection in the response, the API provides more granular and accurate data at the item level, enabling better analysis and reporting.

Get Contacts Endpoints:

GET /api/v2/contacts

GET /api/v2/contacts/{contactId}

GET /api/v2/contacts/{contactId}/phone-numbers

GET /api/v2/contacts/{contactId}/phone-numbers/{phoneId}

These endpoints allow users to retrieve contact information, including SMS Opt-Out details for phone numbers associated with each contact. By adding SMS Opt-Out as part of the contact resource, users can ensure consistency and usability when managing communication preferences.

Payments Endpoint:

GET /api/v2/jobs/{jobId}/payments

This endpoint allows users to retrieve payment details for a specific job, including any associated convenience fees. By adding convenience fees to the payment data, users can access a more comprehensive view of job-related financial transactions.

New Zapier Actions

Milestone Trigger Pull a list of unassigned leads from Zapier.

Create Contact Create new contacts in AccuLynx directly from your Zapier workflows.

Create Job Automate the creation of jobs in AccuLynx.

Find Job Category Search and retrieve job categories from AccuLynx.

Find Lead Source Locate and use lead sources from AccuLynx.

Find Trade Types Retrieve trade types from AccuLynx.

Find Work Types Search for work types in AccuLynx. Search Contact Find existing contacts in AccuLynx.

New Endpoints Released

New Financial Endpoints

Get Supplements

• Get Job Supplements.GET /api/v2/supplements/

Get Supplements Items

• Get the items of a given supplement.GET /api/v2/supplements/{supplementId}/items

Get Supplements by ID

• Get a single Supplement by its ID.GET /api/v2/supplements/{supplementId}

Get Supplements Notations

• Get The notations for a given supplement.GET /api/v2/supplements/{supplementId}/notations

Updated Endpoint for Unassigned Leads

Get Jobs List

• Add the capability of returning unassigned leads in the get jobs list endpoint.GET /api/v2/jobs?assignment=unassigned

New Measurements Endpoint

Add Measurement Files

• New endpoint to handle creating measurements both for XML and JSON files.GET /api/v2/jobs/{jobId}/measurements/files

New Webhooks Released

Trade Type Changed

• Triggered when the trade type of a job is changed.WEBHOOK job.trade-type_changed

Initial Appointment Updated

• Triggered when the initial appointment of a job is changed.WEBHOOK job.appointments.initial_updated

Initial Appointment Created

• Triggered when the initial appointment of a job is created.WEBHOOK job.appointments.initial_created

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 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:

1. Register an Endpoint: Create a URL on your server that will accept incoming webhook notifications.
2. Use your Api Key to create a subscription using the API, and provide your registered URL.
3. Choose Events: Select the types of events you wish to receive notifications for.
4. Handle Notifications: Implement logic to process the incoming notifications on your server.
5. Test Your Implementation: Ensure your system correctly handles webhook events and responds as expected.
6. 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:

Webhooks End User Reference

New Endpoints added

Contacts

Create Contact

• User can easily add contact information

Search Contacts

• User can quickly find and access relevant contact information, saving time and improving productivity in managing and interacting with contacts.

Contact Types List

• User can easily access and retrieve a comprehensive list of contact types, allowing for accurate categorization and organization of contacts. Contact types are used to create a contact

Company

Get Company Photo and Video Tags

• User can easily access and retrieve a comprehensive list of tags that can be applied when uploading photos or videos

Get Company Active Account Types

• User can easily access and retrieve a comprehensive list of active account types. Account types are needed when creating a payment.

Get Company Account Type by Id

• User can easily access and retrieve specific account type details when creating a payment. Account types are needed when creating a payment

Get Company Countries

• User can easily access and reference the list of countries

Get Company States

• User can easily access and reference the list of states

Get Job Categories of the company

• User can easily access and retrieve a comprehensive list of job categories, enabling efficient categorization and organization of jobs, improved search and filtering capabilities, and streamlined project management and reporting processes within the company.

Get Trade Types of the company

• User can easily access and retrieve a comprehensive list of trade types. Trade types are now supported when creating leads.

Get Work Types of a company

• User can easily access and retrieve a comprehensive list of work types, allowing for accurate classification and organization of tasks, improved workflow management, and enhanced reporting and analysis capabilities within the company.

Get Active Lead Sources for a company

• User can easily access and retrieve a comprehensive list of available lead sources specific to the current location. They can get lead sources with a reference to the parent if it's a child or get references to its children if it's a parent.

Get Company Lead Source by Id

• User can easily access and retrieve a targeted lead source that is available and relevant to the current location. They get a lead source with a reference to its children if it's a parent.

Get Company Child Lead Source by Id

• Get a lead source with a reference to its parent

Jobs

Create a job message

• User can easily add and track job-related communication and updates as comments within the system. They can create a thread in a given job.

Reply to a job message

• User can easily add a comment in response to a specific message within the job record.

Post Add JobDocument

• User can easily attach and manage relevant documents directly within the job record, ensuring easy access to important information, improving collaboration and communication, and streamlining document management processes for increased efficiency and productivity.

Post Upload a photo or video to a job

• User can easily attach visual media to the job record, improving communication and collaboration while streamlining project management.

Get a single milestone for a job by milestone Id

• User can easily access specific milestone details, enabling efficient tracking, monitoring, and reporting of project progress, leading to improved project management and informed decision-making.

Get the current milestone for a job

• The user can access real-time updates on the current milestone, enabling accurate tracking of project progress, improved decision-making, and effective communication among team members, ultimately streamlining project management and ensuring timely completion of tasks.

Post Create Payment Paid

• User can easily record and track payment transactions, ensuring accurate financial records, enhanced transparency, and improved financial management for the company.

Post Create Payment Received

• User can easily record and track payment receipts, ensuring accurate financial records and improved cash flow management.

Post Create Payment Additional Job Expenses

• User can easily record and track additional expenses related to a specific job, ensuring accurate financial records, and improved cost management.

Get Job Payments

• User can easily access and retrieve comprehensive payment details, including transaction history, payment amounts, and dates, facilitating accurate financial tracking

Job change history

• User can easily access and review a comprehensive log of all past actions related to the job, enabling improved visibility, accountability, and transparency in project management, facilitating effective communication, tracking changes, and ensuring accurate documentation for enhanced collaboration and decision-making

Get Financials by JobId

• User can understand the Approved Job Value, totals from Financial Worksheet and Amendments, as well as the option to include all the Financial Worksheet and Amendments.

Get Invoices by JobId

• User can understand the Approved Job Value, totals from Financial Worksheet and Amendments, as well as the option to include all the Financial Worksheet and Amendments.

Financials

Get Financials by Financial Id

• User can easily access and retrieve comprehensive financial information related to the job, including costs, expenses, payments, and profitability metrics

Get Financial Worksheet by Financial Id

• User can get the Financial Worksheet information for a given Job (FinancialId).

Get Financial Amendments by Financial Id

• User can get the Amendments for a given Job (FinancialId).

Get Financial Amendment by Amendment Id

• User can get the Amendment by its ID.

Invoices

Get Invoice by Id

• User can get the invoice by its ID