Corrigo: Create quote or estimate item

← Quote or estimate item operations · Get started

Operation corrigo.base_quoteorestimateitem_create

Provider route: POST /v1/base/QuoteOrEstimateItem. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/corrigo with npm, or alter-sdk-corrigo with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { CorrigoIntegration } from "@alter-ai/corrigo";

async function execute(input: Parameters<CorrigoIntegration["quoteOrEstimateItem"]["create"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new CorrigoIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.quoteOrEstimateItem.create(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_corrigo import CorrigoIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = CorrigoIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.quote_or_estimate_item.create(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
body	object	Required within parent	Additional keys: not allowed
body.requestId	JSON	Optional
body.requestId (anyOf 1)	string	Alternative
body.requestId (anyOf 2)	null	Alternative
body.properties	JSON	Optional
body.properties (anyOf 1)	array	Alternative
body.properties (anyOf 1)[]	string	Each item
body.properties (anyOf 2)	null	Alternative
body.entity	Model	Required within parent	Expand Create quote or estimate item — request body — body entity

Referenced models: Create quote or estimate item — request body — body entity

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	JSON	Root

Schemas

Create quote or estimate item — request body — body entity

Field	Type	Presence	Description and constraints
$	object	Root
id	integer	Optional	Format: int32
isNew	boolean	Optional	Read only: true
limitMultipleEntitiesNumberBehaviour	boolean	Optional
performDeletion	boolean	Optional
properties	JSON	Optional
properties (anyOf 1)	array	Alternative
properties (anyOf 1)[]	JSON	Each item
properties (anyOf 1)[] (anyOf 1)	object	Alternative	A Corrigo PropertyTreeNode.
properties (anyOf 1)[] (anyOf 2)	null	Alternative
properties (anyOf 2)	null	Alternative
concurrencyId	integer	Optional	Format: int32
amount	JSON	Optional
amount (anyOf 1)	object	Alternative	A Corrigo MoneyValue.
amount (anyOf 2)	null	Alternative
currencyTypeId	Model	Optional	Expand Create rcs action — request body — body entity money Id
description	JSON	Optional
description (anyOf 1)	string	Alternative
description (anyOf 2)	null	Alternative
invoiceItem	JSON	Optional
invoiceItem (anyOf 1)	object	Alternative	A Corrigo InvoiceDictionaryItem.
invoiceItem (anyOf 2)	null	Alternative
isFlagged	boolean	Optional
parentId	integer	Optional	Format: int32
parentTypeId	Model	Optional	Expand Create actor — request body — body entity type Id
quantity	number	Optional	Format: double
rate	JSON	Optional
rate (anyOf 1)	object	Alternative	A Corrigo MoneyValue.
rate (anyOf 2)	null	Alternative
taxCode	JSON	Optional
taxCode (anyOf 1)	object	Alternative	A Corrigo TaxCode.
taxCode (anyOf 2)	null	Alternative
workOrderId	integer	Optional	Format: int32

Referenced models: Create actor — request body — body entity type Id, Create rcs action — request body — body entity money Id

Create actor — request body — body entity type Id

Field	Type	Presence	Description and constraints
$	string	Root	One of: Unknown, Employee, Occupancy, CorrigoNet, Resident, CommLease, CommLeaseSpace, Property, Portfolio, LeaseGroup, LeaseUser, Supplier, Asset, WO, Org, Warranty, WOPrintout, Team, CompanyProp, Landmark, Provider, ReportTimeSet, TenantCoi, Model, Theme, CustomerInvoice, Payment, MhLocation, MhProduct, PmRmTemplate, Document, WoProxy, Proposal, PlWoItem, Insurance, InvTemplate, ReportSubscription, Requestor, ProcTemplateStep, Procedure, MhOrder, AssetSystem, WorkTemplate, WtWoProxy, Incident, Visit, DutyType, Estimate, Quote, WoActionLog, ProcedureTemplate, WoRequiredDoc, WoSchedule, Rounds, RoundsSchedule, RoundsStep, Specialty, ReceiptStorageRecord, MhTransaction, MhConsumptionRequest, AlertSend Format: int32

Create rcs action — request body — body entity money Id

Field	Type	Presence	Description and constraints
$	string	Root	One of: Unknown, SAR, BGN, TWD, CZK, DKK, EUR, USD, ILS, HUF, JPY, KRW, PLN, BRL, RON, RUB, HRK, SEK, THB, TRY, PKR, IDR, VND, AMD, MKD, ZAR, INR, MYR, KZT, KES, KHR, MMK, LKR, PHP, NGN, CNY, CHF, GBP, MXN, NOK, BND, BDT, EGP, HKD, AUD, SGD, CAD, DZD, MOP, NZD, CRC, BAM, MAD, TND, OMR, VES, COP, PEN, JOD, ARS, LBP, KWD, CLP, AED, UYU, BHD, QAR, RSD, AZN, UZS, VUV, FJD, PGK, TOP, CFP, SBD, WST, MUR, BMD Format: int32

Policy, approvals and errors

SDK function policy ID: corrigo.base_quoteorestimateitem_create. Catalog operation: base.QuoteOrEstimateItem.create. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Official provider source