Acumatica API - Endpoint Default 24 200 001 icon

Acumatica API - Endpoint Default 24 200 001

Interact with Acumatica Endpoint Default/24.200.001

Actions478

Opportunity → Insert/Update

AI-generated

Summary

Insert or update an Opportunity record in Acumatica by specifying detailed fields including activities, address, attributes, contact information, discounts, products, relations, tax details, note ID, and additional fields for comprehensive data representation.

Inputs

  • Activities — Collection of activities related to the opportunity, each with properties like Billable, Overtime, Category, Cost Code, Created/Modified DateTime, Owner, Project, Status, Summary, Time Spent, Type, and Workgroup ID.
  • Address — The physical address associated with the opportunity, including lines 1 and 2, city, country, postal code, state, and a validated flag.
  • Attributes — List of custom attributes for the opportunity, each with attribute ID, description, active status, required flag, value, and optional reference note ID.
  • Contact Information — Detailed contact info such as attention, company name, emails, faxes, multiple phone numbers with types, name fields, position, title, and website.
  • Discounts — Multiple discount entries each specifying discountable amount and quantity, discount amount and percent, discount code, free item and quantity, line number, manual discount flag, skip discount flag, sequence ID, and type.
  • Products — List of products related to the opportunity, each including amount, discounts, discount codes and sequences, pricing, inventory ID, quantity, subitem, tax category, description, unit price, UOM, warehouse, and flags to skip line discounts or indicate free items.
  • Relations — Collection of relations tied to the opportunity with fields like account, contact ID, display name, roles, emails, primary flag, document links, types, and related metadata.
  • Tax Details — Multiple tax detail entries each containing flags for VAT inclusion, line number, pending VAT, reverse VAT, statistical VAT, taxable amount, tax amount, tax ID, tax rate, and tax type.
  • Note ID — Note identifier associated with the opportunity record.
  • Additional Fields — Additional optional fields such as amount, branch, business account, class ID, converted lead info, currency, details, estimation date, location, manual amount flag, opportunity ID, override flag, owner info, parent account, project, reason, source, source campaign, stage, status, subject, tax zone, totals, workgroup info, and last modified date time.

Output shape

a single updated or inserted Opportunity record object as returned by the Acumatica API

Returns the complete Opportunity object after the insert or update operation. The user should provide at least the identifying details for an update or the necessary data for an insert. Optional fields are ignored if left empty. The operation cleans empty or default values before sending to prevent API errors.

Examples

Example 1: Create a new Opportunity with some required fields and related contact information.

Set key Opportunity fields like Subject, Status, and Amount, and provide Contact Information including Company Name and Email.

Example 2: Update an existing Opportunity by specifying its Opportunity ID and modifying products and discounts.

Provide OpportunityID in Additional Fields, set updated Products list with quantities and pricing, and specify Discounts as needed.

Links

Discussion