Acumatica API - Endpoint Default 25 200 001Install

Summary

Retrieve a list of Appointment records from the Acumatica API filtered by various optional criteria.

Inputs

• Actual Duration Filter — Filter results by Actual Duration with operator (Equals, Contains, Starts With) and a string value.
• Actual End Date Filter — Filter results by Actual End Date with operators like Equals, After, On or After, Before, On or Before, and a date-time value.
• Actual End Time Filter — Filter results by Actual End Time using date-time operators and a value.
• Actual Handle Manually Filter — Filter results by Actual Handle Manually boolean value, only Equals operator is supported.
• Actual Service Duration Filter — Filter results by Actual Service Duration with string operators and a value.
• Actual Start Date Filter — Filter results by Actual Start Date with date-time comparison operators and a value.
• Actual Start Time Filter — Filter results by Actual Start Time with date-time comparison operators and a value.
• Appointment Nbr Filter — Filter results by Appointment Number with string operators and a value.
• Appointment Total Filter — Filter results by Appointment Total using numeric comparison operators and a number value.
• Branch Location Filter — Filter results by Branch Location using string comparison operators and a value.
• Confirmed Filter — Filter results where Confirmed equals a boolean value.
• Cost Total Filter — Filter results by Cost Total with numeric comparisons and a number value.
• Customer Filter — Filter results by Customer with string comparison operators and a value.
• Default Project Task Filter — Filter results by Default Project Task with string comparison operators and a value.
• Description Filter — Filter results by Description with string comparison operators and a value.
• Estimated Service Duration Filter — Filter results by Estimated Service Duration with string operators and a value.
• Finished Filter — Filter results where Finished equals a boolean value.
• Hold Filter — Filter results where Hold equals a boolean value.
• Last Modified Date Time Filter — Filter results by Last Modified Date Time using date-time comparison operators and a value.
• Location Filter — Filter results by Location using string comparison operators and a value.
• Optimization Result Filter — Filter results by Optimization Result using string comparison operators and a value.
• Override Filter — Filter results where Override equals a boolean value.
• Profit Filter — Filter results by Profit with numeric comparison operators and a number value.
• Project Filter — Filter results by Project using string comparison operators and a value.
• Scheduled Duration Filter — Filter results by Scheduled Duration using string comparison operators and a value.
• Scheduled End Date Filter — Filter results by Scheduled End Date using date-time comparison operators and a value.
• Scheduled End Time Filter — Filter results by Scheduled End Time using date-time comparison operators and a value.
• Scheduled Handle Manually Filter — Filter results where Scheduled Handle Manually equals a boolean value.
• Scheduled Start Date Filter — Filter results by Scheduled Start Date using date-time comparison operators and a value.
• Scheduled Start Time Filter — Filter results by Scheduled Start Time using date-time comparison operators and a value.
• Service Order Nbr Filter — Filter results by Service Order Number with string comparison operators and a value.
• Service Order Type Filter — Filter results by Service Order Type with string comparison operators and a value.
• Status Filter — Filter results by Status using string comparison operators and a value.
• Tax Total Filter — Filter results by Tax Total with numeric comparison operators and a number value.
• Unreached Customer Filter — Filter results where Unreached Customer equals a boolean value.
• Validatedby Dispatcher Filter — Filter results where Validated by Dispatcher equals a boolean value.
• Waitingfor Purchased Items Filter — Filter results where Waiting for Purchased Items equals a boolean value.
• Workflow Stage Filter — Filter results by Workflow Stage with string comparison operators and a value.
• Custom Filter — Provide an advanced OData $filter expression string applied in addition to above filters.

Output shape

a list of Appointment records matching the filter criteria

The returned data corresponds to the filtered Appointment entities from Acumatica. Filters are combined into an OData $filter query string sent to the API. Empty or default filters are ignored. The custom OData filter string can be used to apply complex or additional filtering beyond the UI-provided filter fields.

Examples

Example 1: Retrieve all appointments with Status starting with 'Open' and scheduled to start on or after a specific date

Set 'Status Filter' to operator 'Starts With' and value 'Open'; Set 'Scheduled Start Date Filter' to operator 'On or After' and a chosen date.

Example 2: Get confirmed appointments with an Appointment Total greater than 1000

Set 'Confirmed Filter' to true; Set 'Appointment Total Filter' operator to 'Greater Than' and value to 1000.

Links

• n8n community nodes installation guide