Acumatica API - Endpoint Default 23 200 001 icon

Acumatica API - Endpoint Default 23 200 001

Interact with Acumatica Endpoint Default/23.200.001

Actions478

Appointment → Insert/Update

AI-generated

Summary

Upserts an Acumatica Appointment record by building a value-wrapped request body from field collections and dispatching it via the Acumatica API.

Inputs

  • Attributes — Attribute groupings, each containing an optional RefNoteID and a Required/Value pair.
  • Details — Detail lines covering account, actual/billable amounts and quantities, status, and logistics fields (appointment nbr, branch, component, cost code, etc.).
  • FinancialSettings — Billing configuration: customer, billing cycle, location, salesperson, and tax calculation mode.
  • Logs — Time-tracking and status logs including start/end dates and times, durations, billable/time-tracking flags, labor items, and cost codes.
  • OtherInformation — Batch number, document type, reference numbers, issue reference, recurrence description, and source schedule/contract IDs.
  • Prepayments — Payment applications: amount, method, status, currency, reference numbers, and source appointment number.
  • Profitability — Profitability tracking: actual/estimated amounts and quantities, billable amounts and quantities, extensions, descriptions, inventory IDs, line references, profit and percent, and staff assignments.
  • ResourceEquipment — Equipment associations: appointment number, comments, descriptions, equipment ID, and service order type.
  • Staff — Staff assignments: cost codes, descriptions, detail line refs, earning types, inventory IDs, labor items, line numbers, line refs, primary/route driver flags, projects, project tasks, service order types, staff members, staff types, and time-tracking flags.
  • TaxDetails — VAT and tax calculations: inclusion in VAT exempt total, pending/reverse/statistical VAT flags, record ID, service order type, taxable and tax amounts, tax ID, tax rate, and tax type.
  • Totals — Summary totals: actual, appointment billable and total, billable labor, billable, estimated, line, prepayment applied/received/remaining, service order billable unpaid/total/unpaid balance, tax total, and VAT exempt/taxable totals.
  • additionalFields — Free-form additional fields for the appointment record (status, hold, confirmed, workflow stage, location, optimization result, override, profit, project, scheduled durations/dates/times, etc.).

Output shape

The Acumatica API response for the upsert operation, typically including the appointment record's ID and updated field values. The node strips default/empty values prior to request to prevent 400 validation errors.

All primitive field values are wrapped in Acumatica's { value: x } format before transmission. The request is sent to the Acumatica entity endpoint for Appointments.

Examples

Example 1: Create a new Appointment with minimal required details.

Populate the Details collection with account, appointment nbr, and status; leave other collections at their empty defaults. The node will strip empty values and send a focused request.

Example 2: Update an existing Appointment by ID.

Provide the appointment's unique identifier via the appropriate field collection, populate the desired update fields (e.g., Actual Amount in Details, Status in Additional Fields). The node will wrap values and dispatch a PUT-style upsert request.

Links

Discussion