Acumatica API - Endpoint Default 24 200 001 icon

Acumatica API - Endpoint Default 24 200 001

Interact with Acumatica Endpoint Default/24.200.001

Actions478

Appointment → Get List

AI-generated

Summary

Retrieves a paginated list of Acumatica appointment records filtered by customizable criteria using OData syntax.

Inputs

  • ActualDurationFilter — Filter by Actual Duration (string). Supports: Equals, Contains, Starts With.
  • ActualEndDateFilter — Filter by Actual End Date. Supports: Equals, After, On or After, Before, On or Before.
  • ActualEndTimeFilter — Filter by Actual End Time. Supports: Equals, After, On or After, Before, On or Before.
  • ActualStartDateFilter — Filter by Actual Start Date. Supports: Equals, After, On or After, Before, On or Before.
  • ActualStartTimeFilter — Filter by Actual Start Time. Supports: Equals, After, On or After, Before, On or Before.
  • AppointmentNbrFilter — Filter by Appointment Number. Supports: Equals, Contains, Starts With.
  • AppointmentTotalFilter — Filter by Appointment Total (number). Supports: Equals, Greater Than, Greater Than or Equal, Less Than, Less Than or Equal.
  • BranchLocationFilter — Filter by Branch Location. Supports: Equals, Contains, Starts With.
  • ConfirmedFilter — Filter by Confirmed status (boolean).
  • CostTotalFilter — Filter by Cost Total (number). Supports: Equals, Greater Than, Greater Than or Equal, Less Than, Less Than or Equal.
  • CustomerFilter — Filter by Customer. Supports: Equals, Contains, Starts With.
  • DefaultProjectTaskFilter — Filter by Default Project Task. Supports: Equals, Contains, Starts With.
  • DescriptionFilter — Filter by Description. Supports: Equals, Contains, Starts With.
  • EstimatedServiceDurationFilter — Filter by Estimated Service Duration (string). Supports: Equals, Contains, Starts With.
  • FinishedFilter — Filter by Finished status (boolean).
  • HoldFilter — Filter by Hold status (boolean).
  • LastModifiedDateTimeFilter — Filter by Last Modified Date Time. Supports: Equals, After, On or After, Before, On or Before.
  • LocationFilter — Filter by Location. Supports: Equals, Contains, Starts With.
  • OptimizationResultFilter — Filter by Optimization Result. Supports: Equals, Contains, Starts With.
  • OverrideFilter — Filter by Override status (boolean).
  • ProfitFilter — Filter by Profit (number). Supports: Equals, Greater Than, Greater Than or Equal, Less Than, Less Than or Equal.
  • ProjectFilter — Filter by Project. Supports: Equals, Contains, Starts With.
  • ScheduledDurationFilter — Filter by Scheduled Duration (string). Supports: Equals, Contains, Starts With.
  • ScheduledEndDateFilter — Filter by Scheduled End Date. Supports: Equals, After, On or After, Before, On or Before.
  • ScheduledEndTimeFilter — Filter by Scheduled End Time. Supports: Equals, After, On or After, Before, On or Before.
  • ScheduledStartDateFilter — Filter by Scheduled Start Date. Supports: Equals, After, On or After, Before, On or Before.
  • ScheduledStartTimeFilter — Filter by Scheduled Start Time. Supports: Equals, After, On or After, Before, On or Before.
  • ServiceOrderNbrFilter — Filter by Service Order Number. Supports: Equals, Contains, Starts With.
  • ServiceOrderTypeFilter — Filter by Service Order Type. Supports: Equals, Contains, Starts With.
  • StatusFilter — Filter by Status. Supports: Equals, Contains, Starts With.
  • TaxTotalFilter — Filter by Tax Total (number). Supports: Equals, Greater Than, Greater Than or Equal, Less Than, Less Than or Equal.
  • UnreachedCustomerFilter — Filter by Unreached Customer status (boolean).
  • ValidatedbyDispatcherFilter — Filter by Validated by Dispatcher status (boolean).
  • WaitingforPurchasedItemsFilter — Filter by Waiting for Purchased Items status (boolean).
  • WorkflowStageFilter — Filter by Workflow Stage. Supports: Equals, Contains, Starts With.
  • customFilter — Advanced OData $filter expression (e.g. CustomerID/value eq 'CUST001'). Applied in addition to any filter fields above.

Output shape

a list of items, each containing the full Acumatica appointment record data.

The node implements pagination using the Acumatica API response format (max results per page). Use the 'Return All' option in the node settings to fetch all matching records.

Examples

Example 1: Fetch all confirmed appointments for a specific customer.

Set CustomerFilter to contain the customer name (e.g., 'CUST001') and ConfirmedFilter to true.

Example 2: Find appointments scheduled after a specific date.

Set ScheduledStartDateFilter operator to 'On or After' and provide the date in the Value field.

Example 3: Retrieve appointments with a total value exceeding a threshold.

Set AppointmentTotalFilter operator to 'Greater Than' and enter the numeric threshold.

Links

Discussion