AccuLynx

AccuLynx integration (Productivity, Marketing). Imported from open-connector.

API key12 toolshttps://api.acculynx.com

GET

acculynx_get_company_settings

Get the current AccuLynx company settings for the connected location.

/company-settings

GET

acculynx_list_contact_types

List the contact types configured for the current AccuLynx company.

/contacts/contact-types

2 parameters

Param	Type	Required	Description
pageSize	integer	optional	The number of items to return per page.
pageStartIndex	integer	optional	The zero-based index of the first item to return.

GET

acculynx_list_lead_sources

List the active lead sources configured for the current AccuLynx company.

/company-settings/leads/lead-sources

2 parameters

Param	Type	Required	Description
pageSize	integer	optional	The number of items to return per page.
recordStartIndex	integer	optional	The zero-based index of the first item to return.

GET

acculynx_list_job_categories

List the active AccuLynx job categories configured for the company.

/company-settings/job-file-settings/job-categories

2 parameters

Param	Type	Required	Description
pageSize	integer	optional	The number of items to return per page.
recordStartIndex	integer	optional	The zero-based index of the first item to return.

GET

acculynx_list_trade_types

List the active AccuLynx trade types configured for the company.

/company-settings/job-file-settings/trade-types

2 parameters

Param	Type	Required	Description
pageSize	integer	optional	The number of items to return per page.
recordStartIndex	integer	optional	The zero-based index of the first item to return.

GET

acculynx_list_work_types

List the active AccuLynx work types configured for the company.

/company-settings/job-file-settings/work-types

2 parameters

Param	Type	Required	Description
pageSize	integer	optional	The number of items to return per page.
recordStartIndex	integer	optional	The zero-based index of the first item to return.

POST

acculynx_create_contact

Create one new contact in AccuLynx.

/contacts

12 parameters

Param	Type	Required	Description
contactTypeIds	array	required	The contact type identifiers assigned to the contact.
firstName	string	optional	The contact first name.
lastName	string	optional	The contact last name.
crossReference	string	optional	The external cross-reference stored on the contact.
companyName	string	optional	The contact company name.
companyJobTitle	string	optional	The contact job title.
note	string	optional	A note stored on the contact.
phoneNumbers	array	optional	The phone numbers to create on the contact.
emailAddresses	array	optional	The email addresses to create on the contact.
mailingAddress	object	optional	A contact address.
billingAddress	object	optional	A contact address.
billingAddressSameAsMailingAddress	boolean	optional	Whether the billing address should match the mailing address.

POST

acculynx_create_job

Create one new job in the AccuLynx Lead milestone.

/jobs

8 parameters

Param	Type	Required	Description
contact	object	required	The contact reference used by a job.
leadSource	object	optional	The lead source reference used by a job.
locationAddress	object	optional	The job location address.
priority	string	optional	The priority assigned to the job.
jobCategory	object	optional	The job category reference.
workType	object	optional	The work type reference.
tradeTypes	array	optional	The trade types assigned to the job.
notes	string	optional	A note stored on the newly created job.

GET

acculynx_list_calendars

List the calendars available in the current AccuLynx location.

/calendars

2 parameters

Param	Type	Required	Description
pageSize	integer	optional	The number of items to return per page.
recordStartIndex	integer	optional	The zero-based index of the first item to return.

GET

acculynx_list_calendar_appointments

List appointment summaries for one AccuLynx calendar within a date range.

/calendars/{calendarId}/appointments

5 parameters

Param	Type	Required	Description
calendarId	string	required	The unique identifier of the calendar.
pageSize	integer	optional	The number of items to return per page.
pageStartIndex	integer	optional	The zero-based index of the first item to return.
startDate	string	required	The inclusive start date in YYYY-MM-DD format.
endDate	string	required	The inclusive end date in YYYY-MM-DD format.

GET

acculynx_get_initial_appointment

Get the initial appointment for one AccuLynx job.

/jobs/{jobId}/initial-appointment

1 parameter

Param	Type	Required	Description
jobId	string	required	The unique identifier of the job.

PUT

acculynx_upsert_initial_appointment

Add or update the initial appointment for one AccuLynx job.

/api/v2/jobs/{jobId}/initial-appointment

4 parameters

Param	Type	Required	Description
jobId	string	required	The unique identifier of the job.
startDate	string	required	The appointment start datetime in UTC ISO 8601 format.
endDate	string	optional	The appointment end datetime in UTC ISO 8601 format.
notes	string	optional	The notes stored on the initial appointment.