# AccuLynx API Documentation > Documentation for AccuLynx API ## AccuLynx API Guides: WELCOME - [Getting Started](https://apidocs.acculynx.com/docs/getting-started.md) ## AccuLynx API Guides: API Information - [Rate Limits](https://apidocs.acculynx.com/docs/rate-limits.md) ## AccuLynx API Guides: Webhooks - [Webhooks End User Reference](https://apidocs.acculynx.com/docs/webhooks-end-user-reference.md) - [Endpoints](https://apidocs.acculynx.com/docs/endpoints.md) - [Guidelines](https://apidocs.acculynx.com/docs/guidelines.md) - [Webhooks Listener Documentation](https://apidocs.acculynx.com/docs/webhooks-listener-documentation.md) - [Code Samples](https://apidocs.acculynx.com/docs/code.md) ## API References: AccuLynx API V2 - acculynxCommon - [Get AccuLynx Countries](https://apidocs.acculynx.com/reference/getacculynxcountries.md): Use this endpoint to get a listing of the countries supported by AccuLynx. **Supported includes:** `states`. - [Get an AccuLynx Country](https://apidocs.acculynx.com/reference/getacculynxcountry.md): Use this endpoint to get a specific country. **Supported includes:** `states`. - [Get States](https://apidocs.acculynx.com/reference/getacculynxstates.md): Use this endpoint to get the states supported by AccuLynx for a country. **Supported includes:** `states`. - [Get a Particular State](https://apidocs.acculynx.com/reference/getacculynxstate.md): Use this endpoint to get a specific state within a specific country. - [Get Units of Measure](https://apidocs.acculynx.com/reference/getacculynxunitsofmeasure-1.md): Use this endpoint to get the list of the catalog units of measure. - calendar - [Get Calendars](https://apidocs.acculynx.com/reference/getcalendars.md): Use this endpoint to get a list of calendars for the location. This endpoint will return a paginated response starting from the given record index. - [Get Appointment Details](https://apidocs.acculynx.com/reference/getappointmentbyid.md): Use this endpoint to get the appointment details for a specific calendar event. - [Get Calendar Appointments](https://apidocs.acculynx.com/reference/getappointments.md): Use this endpoint to get a list of appointments for the specified calendar. The request range should not exceed 90 days. - company - [Get Company Settings](https://apidocs.acculynx.com/reference/getcompanysettings.md): Use this endpoint to get a list of settings for the current location. - [Get Document Folders](https://apidocs.acculynx.com/reference/getcompanydocumentfolders.md): Use this endpoint to get the document folders for a company. This endpoint will return a paginated response starting from the given record index. - [Get Company Photo and Video Tags](https://apidocs.acculynx.com/reference/getphotovideotags.md): Use this endpoint to get a list of the photo and video tags for the current location. The response is paginated based on the pageSize and StartIndex query parameters starting from the given record… - [Get Company Active Account Types](https://apidocs.acculynx.com/reference/getactiveaccounttypes.md): Use this endpoint to get a list of 'active' Account Types for the current company. - [Get Company Active Account Type by ID](https://apidocs.acculynx.com/reference/getaccounttypebyid.md): Use this endpoint to get an account type by ID. - [Get Company Countries](https://apidocs.acculynx.com/reference/getcompanysettingslocationsettingscountries.md): Use this endpoint to get a list of countries supported by the current company. This endpoint will return a paginated response starting from the given record index. - [Get Company States](https://apidocs.acculynx.com/reference/getcompanysettingslocationsettingscountriescountryidstates.md): Use this endpoint to get a list of the states supported by the current company. CountryId must be an existing country supported by the current company. This endpoint will return a paginated response… - [Get Insurance Companies](https://apidocs.acculynx.com/reference/getinsurancecompanies.md): Use this endpoint to get a list of insurance companies for the current location. The response is paginated based on the pageSize and StartIndex query parameters and sorted by based on tag name in… - [Get Job Categories of the Company](https://apidocs.acculynx.com/reference/getcompanysettingsjobsettingsjobcategories.md): Use this endpoint to get all the Job Categories for a company. StartIndex starts at 0. Default PageSize is 25. Pagination parameters are optional. Only active job category values are returned. - [Get Trade Types of the Company](https://apidocs.acculynx.com/reference/getcompanysettingsjobsettingstradetypes.md): Use this endpoint to get all the Trade Types for a company. StartIndex starts at 0. Default PageSize is 25. Pagination parameters are optional. This endpoint will return a paginated response starting… - [Get Work Types of a Company](https://apidocs.acculynx.com/reference/getcompanysettingsjobsettingsworktypes.md): Use this endpoint to get all the Work Types for a company. StartIndex starts at 0. Default PageSize is 100. Pagination parameters are optional. Only active work type values are returned. - [Get Active Lead Sources for a Company](https://apidocs.acculynx.com/reference/getactiveleadsources.md): Use this endpoint to get a list of active lead sources for the current location. This will return the complete lead sources list available for the current location. Inactive lead sources won't be… - [Get Company Lead Source by ID](https://apidocs.acculynx.com/reference/getleadsourcebyid.md): Use this endpoint to get a lead source for the current location. This will return a lead source available for the current location. - [Get Company Child Lead Source by ID](https://apidocs.acculynx.com/reference/getleadsourcechildbyid.md): Use this endpoint to get a child lead source for the current location. This will return a child lead source available for the current location. - [Get Milestones](https://apidocs.acculynx.com/reference/getmilestones.md): Get milestones related to company. For including statuses, the company must have enabled custom workflows. **Supported includes:** `status`. - [Get Statuses for a Milestone](https://apidocs.acculynx.com/reference/getstatusesformilestone.md): Get statuses for a milestone. - [Get Custom Field Definitions](https://apidocs.acculynx.com/reference/getcompanysettingscustomfields.md): Use this endpoint to retrieve custom field definitions and the options related to each custom field definition by company. Returns Custom Field Definitions for types "contact" and "job" with only… - contacts - [Get Contacts](https://apidocs.acculynx.com/reference/getcontacts.md): Use this endpoint to get a listing of Contacts. **Supported includes:** `emailAddress`, `phoneNumber`. - [Create Contact](https://apidocs.acculynx.com/reference/postcontacts.md): Use this endpoint to create a new contact. This endpoint is rate limited. Use the `RateLimit-*` response headers to check current limits and remaining quota. - [Get Contact Types](https://apidocs.acculynx.com/reference/getcontacttypes.md): Use this endpoint to get the list of contact types from a company. - [Search Contacts](https://apidocs.acculynx.com/reference/postcontactsearch.md): Use this endpoint to get a list of contacts matching the given search criteria. Contacts are returned if they include a given first name, last name, company name, and contact type. it will filter by… - [Get Contact by ID](https://apidocs.acculynx.com/reference/getcontact.md): Use this endpoint to get details for a specific contact. **Supported includes:** `emailAddress`, `phoneNumber`. - [Get Email Addresses](https://apidocs.acculynx.com/reference/getcontactemailaddresses.md): Use this endpoint to get the list of email addresses for a specific contact. - [Get Email Address](https://apidocs.acculynx.com/reference/getcontactemailaddressbyid.md): Use this endpoint to get the email addresses for a specific emailId associated with a specific contact. - [Get Phone Numbers](https://apidocs.acculynx.com/reference/getcontactphonenumber.md): Use this endpoint to get the list of phone numbers for a specific contact. - [Get Phone Number](https://apidocs.acculynx.com/reference/getcontactphonenumberbyid.md): Use this endpoint to get the phone number for a specific phoneId associated with a specific contact. - [Create Contact Log](https://apidocs.acculynx.com/reference/postcontactlog.md): Use this endpoint to create a new Log for an existing contact. This endpoint is rate limited. Use the `RateLimit-*` response headers to check current limits and remaining quota. - [Get Contact Custom Fields](https://apidocs.acculynx.com/reference/getcontactcustomfields.md): Get a list of all custom fields related to a specific contact by its contact Id. This endpoint will return a paginated response starting from the given record index. StartIndex starts at 0. Default… - [Update Contact Custom Fields](https://apidocs.acculynx.com/reference/putcontactcustomfields.md): Use this endpoint to update multiple custom field values for a contact. The limit of the Custom Field list to update cannot be greater than 120. If the custom field type is Text, the maximum lenght… - [Get Contact Custom Field](https://apidocs.acculynx.com/reference/getcontactcustomfieldbyid.md): Get a custom field object inside a contact provided a custom field id and a valid contact id - [Update Contact Custom Field](https://apidocs.acculynx.com/reference/putcontactcustomfieldbyid.md): Sets a value for the specified custom field in the contact. If the custom field type is Text, the maximum lenght of the text is 500 characters. Any text beyond that limit will be truncated. This… - [Create Email Address](https://apidocs.acculynx.com/reference/postcontactemailaddresses.md): Use this endpoint to add an email address to the list of addresses for a specific contact. This endpoint is rate limited. Use the `RateLimit-*` response headers to check current limits and remaining… - [Get Jobs for a Contact](https://apidocs.acculynx.com/reference/getcontactjobs.md): Retrieves a paginated list of all jobs that the contact is associated with. **Pagination:** - PageStartIndex: Zero-based index of the first record to return (default: 0) - PageSize: Number of… - [Create Phone Number](https://apidocs.acculynx.com/reference/postcontactphonenumber.md): Use this endpoint to add a phone number to the list of phone numbers for a specific contact. This endpoint is rate limited. Use the `RateLimit-*` response headers to check current limits and… - [Create Contact Note](https://apidocs.acculynx.com/reference/postcontactnotes.md): Creates a new note entry associated with a specific contact. **Required Fields:** - `note`: The body text of the note (max 1000 characters). **Behavior:** - Returns 201 with empty body. - Returns… - diagnostics - [Check if the API Server Is Responsive](https://apidocs.acculynx.com/reference/getping.md): Use this endpoint to verify that the API server is responsive. - estimates - [Get Estimates](https://apidocs.acculynx.com/reference/getestimates.md): Use this endpoint to get all estimates for the current location. **Supported includes:** `job`. - [Get Estimate](https://apidocs.acculynx.com/reference/getestimatebyid.md): Use this endpoint to get a specific estimate. **Supported includes:** `job`, `createdBy`, `modifiedBy`, `sections`. - [Get Estimate Sections](https://apidocs.acculynx.com/reference/getestimatesections.md): Use this endpoint to get all sections for the given estimate. **Supported includes:** `createdBy`, `modifiedBy`, `items`. - [Get Estimate Section](https://apidocs.acculynx.com/reference/getestimatesectionbyid.md): Use this endpoint to get a specific estimate section. **Supported includes:** `createdBy`, `modifiedBy`, `items`. - [Get Estimate Section Items](https://apidocs.acculynx.com/reference/getestimatesectionitems.md): Use this endpoint to get all items for the given estimate section. - [Get Estimate Section Item](https://apidocs.acculynx.com/reference/getestimatesectionitem.md): Use this endpoint to get a specific estimate item. - jobs - [Get Jobs](https://apidocs.acculynx.com/reference/getjobs.md): Use this endpoint to get a listing of Jobs. When startDate and endDate are specified, jobs returned will be filtered to the given date range (inclusive). The date field to filter on is given with… - [Get Job External References](https://apidocs.acculynx.com/reference/getjobexternalreferences.md): Use this endpoint to retrieve the external references that link an AccuLynx job to a project in an external system. `source` is required. At least one of `jobId` or `projectId` must also be… - [Create Job External Reference](https://apidocs.acculynx.com/reference/postcreatejobexternalreference.md): Use this endpoint to create a new external reference for a job to an external source and project. This endpoint is rate limited. Use the `RateLimit-*` response headers to check current limits and… - [Get Job by ID](https://apidocs.acculynx.com/reference/getjob.md): Use this endpoint to get details for a specific job. Unassigned leads or jobs will not be returned. **Supported includes:** `contact`, `initialAppointment`. - [Get Job Adjuster](https://apidocs.acculynx.com/reference/getadjusterforjob.md): This endpoint returns the job's insurance adjuster information. - [Get Job Contacts](https://apidocs.acculynx.com/reference/getjobcontacts.md): Use this endpoint to get the list of contacts for a job. **Supported includes:** `contact`. - [Get Job Contact by ID](https://apidocs.acculynx.com/reference/getjobcontact.md): Use this endpoint to get details of a specific job contact. **Supported includes:** `contact`. - [Add Job Document](https://apidocs.acculynx.com/reference/postaddjobdocument.md): Use this endpoint to add a job document for a specific job. Special characters and spaces will be removed from the file name before upload. This endpoint is rate limited. Use the `RateLimit-*`… - [Get Job Estimates](https://apidocs.acculynx.com/reference/getestimatesforjob.md): Use this endpoint to get a list of estimates for the specified job. This endpoint will return a paginated response starting from the given record index. - [Get Job Invoices](https://apidocs.acculynx.com/reference/getinvoicesforjob.md): Use this endpoint to get a list of invoices for the specified job. - [Get Job Financials](https://apidocs.acculynx.com/reference/getfinancialsforjob.md): Use this endpoint to get the Financials for the specified job. **Supported includes:** `worksheet`, `amendments`. - [Get Job Accounting Integration Status](https://apidocs.acculynx.com/reference/getaccountingintegrationssyncchangesforjob.md): Use this endpoint to get status of the accounting integration sync for the specified job. - [Get Job Change History](https://apidocs.acculynx.com/reference/getjobhistory.md): Use this endpoint to get a history of actions performed for a job. **Supported includes:** `createdBy`. When startDate and endDate are specified, actions returned will be filtered to those created… - [Get Job Initial Appointment](https://apidocs.acculynx.com/reference/getinitialappointmentforjob.md): Use this endpoint to get the initial appointment for a job. - [Update Job Initial Appointment](https://apidocs.acculynx.com/reference/putinitialappointmentforjob.md): Use this endpoint to add or modify the initial appointment for a job. All datetimes should be UTC and in ISO 8601 format (suffixed with 'Z'). This endpoint is rate limited. Use the `RateLimit-*`… - [Get Job Insurance](https://apidocs.acculynx.com/reference/getinsuranceforjob.md): This endpoint returns the job's insurance information. - [Update Job Insurance Company](https://apidocs.acculynx.com/reference/putinsurancecompanyforjob.md): This endpoint sets an insurance company to an existing job. It can be set by ID or by name, but not both. The ID should belong to the existing insurance companies. If the name is used it will be… - [Create Job Message](https://apidocs.acculynx.com/reference/postcreatejobmessage.md): Use this endpoint to post a comment to the job's message feed. The comment will be visible in the job's Messages section within the AccuLynx web and mobile applications. This endpoint is rate… - [Create Job Message Reply](https://apidocs.acculynx.com/reference/postreplyjobmessage.md): Use this endpoint to post a reply to an existing comment in the job's message feed. The reply will be visible in the job's Messages section within the AccuLynx web and mobile applications. This… - [Get Job Milestone History](https://apidocs.acculynx.com/reference/getmilestonesforjob.md): Get milestone history for the specified Job. - [Get Job Milestone by ID](https://apidocs.acculynx.com/reference/getjobmilestonebyid.md): Get a single milestone information by id. For including statuses the company must have enabled custom workflows. **Supported includes:** `status`. - [Get Job Milestone Status by ID](https://apidocs.acculynx.com/reference/getjobstatusbyid.md): Get a single status information by ID. - [Get Current Job Milestone](https://apidocs.acculynx.com/reference/getcurrentjobmilestone.md): Get the current milestone information. For including statuses the company must have enabled custom workflows. **Supported includes:** `status`. - [Get Job Payments](https://apidocs.acculynx.com/reference/getpayments.md): Returns all payment records associated with the specified job, organized into three groups: received payments (amounts collected from the customer), paid payments (amounts paid to vendors or… - [Get Job Payments Overview](https://apidocs.acculynx.com/reference/getpaymentsoverviewforjob.md): Use this endpoint to get a high-level overview of financial information for the specified job. - [Create Received Payment](https://apidocs.acculynx.com/reference/postcreatepaymentreceived.md): Use this endpoint to create a new payment received. This endpoint is rate limited. Use the `RateLimit-*` response headers to check current limits and remaining quota. - [Create Paid Payment](https://apidocs.acculynx.com/reference/postcreatepaymentpaid.md): Use this endpoint to create a new payment paid. This endpoint is rate limited. Use the `RateLimit-*` response headers to check current limits and remaining quota. - [Create Additional Job Expense](https://apidocs.acculynx.com/reference/postcreatepaymentadditionalexpense.md): Use this endpoint to create a new payment Additional Job Expenses. This endpoint is rate limited. Use the `RateLimit-*` response headers to check current limits and remaining quota. - [Get Job Representatives](https://apidocs.acculynx.com/reference/getrepresentativesforjob.md): Use this endpoint to get the list of representatives for a Job. This endpoint will return a paginated response starting from the given record index. - [Get Job Company Representative](https://apidocs.acculynx.com/reference/getcompanyrepresentativeforjob.md): Use this endpoint to get the company representative for a job. - [Update Company Representative](https://apidocs.acculynx.com/reference/postcompanyrepresentativeforjob.md): Use this endpoint to update the company representative for a job. This endpoint is rate limited. Use the `RateLimit-*` response headers to check current limits and remaining quota. - [Get Job Sales Owner](https://apidocs.acculynx.com/reference/getsalesownerforjob.md): Use this endpoint to get the sales owner for a job. - [Add or Update Sales Owner](https://apidocs.acculynx.com/reference/postsalesownerforjob.md): Use this endpoint to add or update the sales owner for a job. This endpoint is rate limited. Use the `RateLimit-*` response headers to check current limits and remaining quota. - [Get Job A/R Owner](https://apidocs.acculynx.com/reference/getarownerforjob.md): Use this endpoint to get the A/R representative for a job. - [Add or Update A/R Owner](https://apidocs.acculynx.com/reference/postarownerforjob.md): Use this endpoint to add or update the A/R Owner for a job. This endpoint is rate limited. Use the `RateLimit-*` response headers to check current limits and remaining quota. - [Upload Job Photo or Video](https://apidocs.acculynx.com/reference/postuploadphotoorvideo.md): Use this endpoint to Upload a single Photo or Video for the specified job. Special characters and spaces will be removed from the file name before upload. This endpoint is rate limited. Use the… - [Create Job Manual Measurements](https://apidocs.acculynx.com/reference/postjobmeasurementsupload.md): - Use this endpoint to create one or more manual measurements using a list of measurements entered in a file - The measurements file must contain the measurements information for the measurements to… - [Create Job Measurements Order](https://apidocs.acculynx.com/reference/postjobmeasurementsuploadfiles.md): Use this endpoint to create a measurements order with the external provider Information for a specific job. - The measurement file can be an XML or JSON file. - The file content has to be a valid… - [Get Job Custom Fields](https://apidocs.acculynx.com/reference/getjobcustomfields.md): Get a list of all custom fields related to a specific job by its job Id. This endpoint will return a paginated response starting from the given record index. StartIndex starts at 0. Default PageSize… - [Update Job Custom Fields](https://apidocs.acculynx.com/reference/putjobcustomfields.md): Use this endpoint to update multiple custom field values for a Job. The limit of the Custom Field list to update cannot be greater than 120. If the custom field type is Text, the maximum lenght of… - [Get Job Custom Field by ID](https://apidocs.acculynx.com/reference/getjobcustomfieldbyid.md): Get a custom field object inside a job, provided a custom field ID and a valid job ID - [Update Job Custom Field by ID](https://apidocs.acculynx.com/reference/putjobcustomfieldbyid.md): Sets a value for the specified custom field in the Job. If the custom field type is Text, the maximum lenght of the text is 500 characters. Any text beyond that limit will be truncated. This… - [Update Job Address](https://apidocs.acculynx.com/reference/putjoblocationaddress.md): This endpoint updates the job location address information. This endpoint is rate limited. Use the `RateLimit-*` response headers to check current limits and remaining quota. - [Update Job Adjuster](https://apidocs.acculynx.com/reference/putadjusterforjob.md): This endpoint sets or updates the job adjuster information. This endpoint is rate limited. Use the `RateLimit-*` response headers to check current limits and remaining quota. - [Update Job Insurance](https://apidocs.acculynx.com/reference/putinsuranceinformationforjob.md): This endpoint sets the insurance information for an existing job. - "Insurance company" section: It can be set by ID or by name, but not both. The ID should belong to the existing insurance… - [Update Job Priority](https://apidocs.acculynx.com/reference/putpriorityforjob.md): This endpoint sets the priority for an existing job. This endpoint is rate limited. Use the `RateLimit-*` response headers to check current limits and remaining quota. - [Update Job Category](https://apidocs.acculynx.com/reference/updatejobcategory.md): Allows a user to set a job category for a given job. This endpoint is rate limited. Use the `RateLimit-*` response headers to check current limits and remaining quota. - [Update Job Lead Source](https://apidocs.acculynx.com/reference/updatejobleadsource.md): Updates the lead source for a specified job. The endpoint validates that both job and lead source belong to the company associated with the API key. If the provided lead source ID matches the current… - [Update Job Work Type](https://apidocs.acculynx.com/reference/updatejobworktype.md): Updates work type for a specific job. This endpoint is rate limited. Use the `RateLimit-*` response headers to check current limits and remaining quota. - [Create Job](https://apidocs.acculynx.com/reference/createjob.md): Use this endpoint to create a new job. The job is created in the `Lead` milestone with no assigned representative (Unassigned). The `contact` field is required and links an existing contact as the… - [Search Jobs](https://apidocs.acculynx.com/reference/searchjobs.md): Use this endpoint to get a listing of jobs matching the given search criteria. Jobs are returned if they include a given search term and/or they are near a given set of map coordinates. At least one… - [Update Job Trade Types](https://apidocs.acculynx.com/reference/updatejobtradetypes.md): Updates trade types for a specific job. Trade types passed on the body will replace those already existing on the job. If an empty array is provided, current trade types in the job will be… - leads - [Get Lead History](https://apidocs.acculynx.com/reference/getleadhistory.md): Use this endpoint to get a history of actions performed for a lead. **Supported includes:** `createdBy`. - users - [Get Users](https://apidocs.acculynx.com/reference/getusers.md): Use this endpoint to get the list of users for a company. The status filter can be used to filter users based on status - active, inactive, archived, or deleted. By default, only active users will… - [Get User](https://apidocs.acculynx.com/reference/getuser.md): Use this endpoint to get the details of a specific user. - reports - [Get Report Schedule Runs](https://apidocs.acculynx.com/reference/getreportsbyinstanceinstancerunsbyscheduleid.md): Use this endpoint to get a list of instances for a scheduled report by it's unique identifier. If the scheduled report requested is not available the response will be a Not Found error. If the… - [Get Report Instance by ID](https://apidocs.acculynx.com/reference/getreportbyinstanceid.md): Use this endpoint to get a scheduled report instance by it's instance run unique identifier. If the scheduled report requested is not available the response will be a not found error. If the instance… - [Get Latest Report Instance](https://apidocs.acculynx.com/reference/getreportlatestinstance.md): Use this endpoint to get a scheduled report latest instance. If the scheduled report requested is not available the response will be a Not Found error. If the scheduled report requested hasn't run… - [Get Report Instance Recipients](https://apidocs.acculynx.com/reference/getreportsrecipientsbyinstanceid.md): Use this endpoint to get a list of recipients for a specific instance of a given scheduled report by it's unique identifier. If the scheduled report requested is not available the response will be a… - [Get Report Instance Recipient by ID](https://apidocs.acculynx.com/reference/getreportinstacerecipientbyid.md): Use this endpoint to get a scheduled report recipient data of a given instance by it's recipient unique identifier. If the scheduled report requested is not available the response will be a not found… - invoices - [Get Invoice](https://apidocs.acculynx.com/reference/getinvoicebyid.md): Use this endpoint to get a specific Invoice. - financials - [Get Financials](https://apidocs.acculynx.com/reference/getfinancialsbyfinancialid.md): Use this endpoint to get the Financials for the specified financialID. **Supported includes:** `worksheet`, `amendments`. - [Get Worksheet](https://apidocs.acculynx.com/reference/getworksheetbyid.md): Use this endpoint to get a specific Worksheet by financial ID. - [Create Worksheet Item](https://apidocs.acculynx.com/reference/postworksheetsectionitem.md): Creates a new item in a worksheet using its financial ID. If the worksheet does not exist, it will be created, and the sectionId parameter should be left empty. If the worksheet already exists, you… - [Get Financial Amendments](https://apidocs.acculynx.com/reference/getworksheetamendmentsbyid.md): Use this endpoint to get a specific Financial's Amendments. - [Get Financial Amendment](https://apidocs.acculynx.com/reference/getworksheetamendmentbyid.md): Use this endpoint to get a specific Amendment. - supplements - [Get Supplements](https://apidocs.acculynx.com/reference/getfinancialssupplementsforcompany.md): Use this endpoint to get a list of supplements for the current location. The page start index begins at 0. The default page size is 25. Pagination parameters are optional. **Supported includes:**… - [Get Supplement by ID](https://apidocs.acculynx.com/reference/getsupplementbyid.md): Use this endpoint to get a particular supplement for the current location. - [Get Supplement Items](https://apidocs.acculynx.com/reference/getfinancialssupplementitemcollection.md): Use this endpoint to get a list of items for a specific supplement in the current location. StartIndex starts at 0. The default PageSize is 25. Pagination parameters are optional. **Example:**… - [Get Supplement Notations](https://apidocs.acculynx.com/reference/getfinancialssupplementnotationcollection.md): Use this endpoint to get a list of notations for a specific supplement in the current location. StartIndex starts at 0. The default PageSize is 25. Pagination parameters are optional. **Example:**… ## API References: ACCULYNX WEBHOOKS API - subscriptions - [Get subscriptions](https://apidocs.acculynx.com/reference/getsubscriptions.md): Retrieves all webhook subscriptions for your company. This endpoint returns a paginated list of webhook subscriptions, including: - Subscription status (enabled/disabled) - Consumer URLs where… - [Create Subscription](https://apidocs.acculynx.com/reference/postsubscription.md): Creates a new webhook subscription for your company. You must provide: - A valid consumer URL where webhook events will be sent - A technical contact email for notifications about the subscription -… - [Get subscription](https://apidocs.acculynx.com/reference/getsubscription.md): Retrieves detailed information about a specific subscription. This endpoint returns comprehensive details about the requested subscription: - Creation and last modification dates - Consumer URL… - [Update subscription by id](https://apidocs.acculynx.com/reference/updatesubscription.md): Updates an existing subscription. You can modify: - The technical contact email address - The list of topics this subscription is listening for Note that you cannot update the consumer URL after… - [Delete subscription by id](https://apidocs.acculynx.com/reference/deletesubscription.md): Permanently deletes a subscription. Once deleted: - The subscription will no longer receive any webhook events - The subscription cannot be recovered - Any new events for the topics it was listening… - [Send a test event](https://apidocs.acculynx.com/reference/postsendtestevent.md): Sends a test event to your webhook endpoint. This is extremely useful for: - Verifying your webhook receiver is properly configured - Testing your event handling logic - Confirming connectivity… - topics - [Get topics](https://apidocs.acculynx.com/reference/gettopics.md): Retrieves all available webhook topics you can subscribe to. This endpoint returns a paginated list of all active topics, including: - Topic names that you can use when creating or updating… ## API References: AccuLynx Webhooks - contact_added - [Contact Added Webhook](https://apidocs.acculynx.com/reference/contactadded.md): Triggered when a new contact record is created in the system. **Payload includes:** * Contact's unique identifier * Creation timestamp * Direct API link to access the contact's full details The… - contact_changed - [Contact Changed Webhook](https://apidocs.acculynx.com/reference/contactchanged.md): Triggered when any contact details are modified in the system. **Payload includes:** * Contact's unique identifier * Modification timestamp * Direct API link to access the updated contact's details… - contact.custom-field.status_changed - [Contact Custom Field Status Changed Webhook](https://apidocs.acculynx.com/reference/contactcustomfieldstatuschanged.md): Triggered when a custom field's status is modified for a contact record. **Payload includes:** * Custom field's unique identifier * Updated status value * Modification timestamp * User reference who… - contact.custom-field.value_changed - [Contact Custom Field Value Changed Webhook](https://apidocs.acculynx.com/reference/contactcustomfieldvaluechanged.md): Triggered when a custom field value is modified for a contact record. **Payload includes:** * Custom field's unique identifier * Updated field value * Modification timestamp * User reference who… - job_created - [Job Created Webhook](https://apidocs.acculynx.com/reference/jobcreated.md): Triggered when a new job is created in the system. **Payload includes:** * Full job metadata including creation timestamp * Primary contact details * Location information * Lead source and… - job_updated - [Job Updated Webhook](https://apidocs.acculynx.com/reference/jobupdated.md): Triggered when any job, primary contact, job details are modified. **Payload includes:** * Complete current job state snapshot * Updated contact and location details * Work type and categorization… - job.accounting.integration-status.current_changed - [Job Accounting Integration Status Current Changed Webhook](https://apidocs.acculynx.com/reference/jobaccountingintegrationstatuscurrentchanged.md): Triggered when a job's accounting integration status changes in the system. **Payload includes:** * Current integration status state * Job identifier * Direct API link to access full accounting… - job.appointments.initial_created - [Job Appointments Initial Created Webhook](https://apidocs.acculynx.com/reference/jobinitialappointmentcreated.md): Triggered when an initial appointment is created for a job. **Payload includes:** * Job ID with direct API link * Company representative details * Initial appointment start date * Webhook event… - job.appointments.initial_updated - [Job Appointments Initial Updated Webhook](https://apidocs.acculynx.com/reference/jobinitialappointmentupdated.md): Triggered when an existing initial appointment is updated for a job. **Payload includes:** * Job ID with direct API link * Updated company representative details * Revised initial appointment start… - job.category_changed - [Job Category Changed Webhook](https://apidocs.acculynx.com/reference/jobcategorychanged.md): Triggered when a job's category is modified. **Payload includes:** * Job ID with direct API link * Previous and new category details * Webhook event metadata The event payload contains both… - job.contacts.primary_changed - [Job Contact Primary Changed Webhook](https://apidocs.acculynx.com/reference/jobcontactsprimarychanged.md): Triggered when a job's primary contact is modified. **Payload includes:** * Job ID with direct API link * Contact information with direct API link * Webhook event metadata The event payload… - job.custom-field.status_changed - [Job Custom Field Status Changed Webhook](https://apidocs.acculynx.com/reference/jobcustomfieldstatuschanged.md): Triggered when a job's custom field status is updated in the system. **Payload includes:** * Job's unique identifier * Custom field's system ID * Previous and updated status values * Modification… - job.custom-field.value_changed - [Job Custom Field Value Changed Webhook](https://apidocs.acculynx.com/reference/jobcustomfieldvaluechanged.md): Triggered when a custom field value is updated within a job record. **Payload includes:** * Job's unique identifier * Custom field's system ID * Previous and updated values * Modification timestamp… - job.financials.approvedValue_changed - [Job Financials Approved Value Changed Webhook](https://apidocs.acculynx.com/reference/approvedjobvaluechanged.md): Triggered when a job's approved financial value is modified. **Payload includes:** * Job ID and modification timestamp * New approved value amount * Approver user reference * Direct API links to… - job.invoice_updated - [Job Invoice Updated Webhook](https://apidocs.acculynx.com/reference/invoiceupdated.md): Triggered when an invoice associated with a job is modified. **Payload includes:** * Invoice totals and collection amounts * Update timestamp and modifier information * Direct API links to full… - job.invoice_voided - [Job Invoice Voided Webhook](https://apidocs.acculynx.com/reference/invoicevoided.md): Triggered when an invoice associated with a job is marked as void. **Payload includes:** * Void date and responsible user * Invoice identification details * Direct API links to voided invoice and… - job.milestone.current_changed - [Job Milestone Current Changed Webhook](https://apidocs.acculynx.com/reference/jobmilestonecurrentchanged.md): Triggered when a job's current milestone is updated. **Payload includes:** * New milestone details and activation date * User who changed the milestone * Direct API links to full milestone and job… - job.milestone.status.current_changed - [Job Milestone Status Current Changed Webhook](https://apidocs.acculynx.com/reference/jobmilestonestatuscurrentchanged.md): Triggered when a milestone's current status is updated within a job. **Payload includes:** * Updated status details and transition timestamp * Responsible user for the status change * Workflow… - job.primary.contact_changed - [Job Primary Contact Changed/Added Webhook](https://apidocs.acculynx.com/reference/jobprimarycontactchanged.md): Triggered when the primary contact association changes for a job. **Payload includes:** * Job ID and timestamp * Contact relationship details * Direct API links to job and contact resources… - job.representatives.company_assigned - [Job Representatives Company Assigned Webhook](https://apidocs.acculynx.com/reference/jobrepresentativescompanyassigned.md): Triggered when a company representative is initially assigned to a job. **Payload includes:** * Job ID and assignment timestamp * Representative user details * Direct API links to job and… - job.representatives.company_changed - [Job Representatives Company Changed Webhook](https://apidocs.acculynx.com/reference/jobrepresentativescompanychanged.md): Triggered when an existing company representative assignment is modified for a job. **Payload includes:** * Job ID and modification timestamp * Previous and current representative details * Direct… - job.trade-type_changed - [Job Trade Type Changed Webhook](https://apidocs.acculynx.com/reference/jobtradetypechanged.md): Triggered when a job's trade type classification is modified. **Payload includes:** * Job ID and modification timestamp * Trade type details (system default or custom) * Direct API link to job… - job.work-type_changed - [Job Work Type Changed Webhook](https://apidocs.acculynx.com/reference/jobworktypechanged.md): Triggered when a job's work type classification is modified. **Payload includes:** * Job ID and modification timestamp * Work type details (system default or custom) * Direct API link to job… ## Recipes - [Upload Measurement (Steep and Low Slope)](https://apidocs.acculynx.com/recipes/upload-measurement-copy.md) - [Upload Measurement (Low Slope)](https://apidocs.acculynx.com/recipes/upload-measurement-low-slope.md) - [Upload Measurement (Siding)](https://apidocs.acculynx.com/recipes/upload-measurement-siding.md) - [Upload Measurement (Steep Slope)](https://apidocs.acculynx.com/recipes/upload-measurement.md) ## Changelogs - [New Contact Endpoints and Rate limiting](https://apidocs.acculynx.com/changelog/new-contact-endpoints-and-rate-limiting.md) - [New Job Update Endpoints](https://apidocs.acculynx.com/changelog/update-endpoints-for-job-details.md) - [Custom Fields Release](https://apidocs.acculynx.com/changelog/custom-fields-release.md) - [AccuLynx API V1 Documentation Removed](https://apidocs.acculynx.com/changelog/acculynx-api-v1-documentation-removed.md) - [AccuLynx version 2.2522.0](https://apidocs.acculynx.com/changelog/acculynx-version-225220.md) - [AccuLynx version 2.2506.0](https://apidocs.acculynx.com/changelog/acculynx-version-225060.md) - [AccuLynx version.2.2422.0](https://apidocs.acculynx.com/changelog/appconnection-release-oct-2024.md) - [AppConnections Release](https://apidocs.acculynx.com/changelog/appconnections-release.md)