Xero: Updates or creates one or more quotes

← Accounting operations · Get started

Operation xero.updateorcreatequotes

Provider route: POST /api.xro/2.0/Quotes. Alter supplies the connection’s credentials and routing.

Call through Alter

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

import { App } from "@alter-ai/sdk";
import { XeroIntegration } from "@alter-ai/xero";

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

import os
from alter_sdk import App
from alter_sdk_xero import XeroIntegration

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

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
query	object	Optional	Additional keys: not allowed
query.summarizeErrors	boolean	Optional	Default: false
headers	object	Required within parent	Additional keys: not allowed
headers.xero-tenant-id	string	Required within parent
headers.Idempotency-Key	string	Optional
body	Model	Required within parent	Expand Updates a specific quote — request body — body

Referenced models: Updates a specific quote — request body — body

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
$	Model	Root	Expand Retrieves sales quotes — response body

Referenced models: Retrieves sales quotes — response body

Schemas

30 more schemas are linked from the tables above, on the schema pages.

Retrieves sales quotes — response body

Field	Type	Presence	Description and constraints
$	object	Root
Quotes	array	Optional
Quotes[]	Model	Each item	Expand Retrieves sales quotes — response body — Quotes item

Referenced models: Retrieves sales quotes — response body — Quotes item

Updates a specific quote — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
Quotes	array	Optional
Quotes[]	Model	Each item	Expand Updates a specific quote — request body — body Quotes item

Referenced models: Updates a specific quote — request body — body Quotes item

Retrieves sales quotes — response body — Quotes item

Field	Type	Presence	Description and constraints
$	object	Root
BrandingThemeID	string	Optional	See BrandingThemes Format: uuid
Contact	Model	Optional	Expand Creates contacts to a specific contact group — response body — Contacts item
CurrencyCode	Model	Optional	Expand Deletes an Allocation from a Prepayment — response body — Invoice Currency Code
CurrencyRate	JSON	Optional
CurrencyRate (anyOf 1)	number	Alternative	The currency rate for a multicurrency quote Format: double
CurrencyRate (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
Date	string	Optional	Date quote was issued – YYYY-MM-DD. If the Date element is not specified it will default to the current date based on the timezone setting of the organisation
DateString	string	Optional	Date the quote was issued (YYYY-MM-DD)
ExpiryDate	string	Optional	Date the quote expires – YYYY-MM-DD.
ExpiryDateString	string	Optional	Date the quote expires – YYYY-MM-DD.
LineAmountTypes	string	Optional	Line amounts are exclusive of tax by default if you don’t specify this element. See Line Amount Types See Quote Line Amount Types Known values: EXCLUSIVE, INCLUSIVE, NOTAX
LineItems	array	Optional	See LineItems
LineItems[]	Model	Each item	Expand Deletes an Allocation from a Prepayment — response body — Invoice Line Items item
QuoteID	string	Optional	QuoteID GUID is automatically generated and is returned after create or GET. Format: uuid
QuoteNumber	string	Optional	Unique alpha numeric code identifying a quote (Max Length = 255) Maximum length: 255
Reference	string	Optional	Additional reference number Maximum length: 4000
Status	string	Optional	The status of the quote. Known values: DRAFT, SENT, DECLINED, ACCEPTED, INVOICED, DELETED
StatusAttributeString	string	Optional	A string to indicate if a invoice status
SubTotal	JSON	Optional
SubTotal (anyOf 1)	number	Alternative	Total of quote excluding taxes. Format: double Read only: true
SubTotal (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
Summary	string	Optional	Summary text for the quote Maximum length: 3000
Terms	string	Optional	Terms of the quote Maximum length: 4000
Title	string	Optional	Title text for the quote Maximum length: 100
Total	JSON	Optional
Total (anyOf 1)	number	Alternative	Total of Quote tax inclusive (i.e. SubTotal + TotalTax). This will be ignored if it doesn’t equal the sum of the LineAmounts Format: double Read only: true
Total (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
TotalDiscount	JSON	Optional
TotalDiscount (anyOf 1)	number	Alternative	Total of discounts applied on the quote line items Format: double Read only: true
TotalDiscount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
TotalTax	JSON	Optional
TotalTax (anyOf 1)	number	Alternative	Total tax on quote Format: double Read only: true
TotalTax (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
UpdatedDateUTC	string	Optional	Last modified date UTC format Read only: true
ValidationErrors	array	Optional	Displays array of validation error messages from the API
ValidationErrors[]	Model	Each item	Expand Retrieves journals — response body — Warnings item

Referenced models: Deletes an Allocation from a Prepayment — response body — Invoice Currency Code, Creates contacts to a specific contact group — response body — Contacts item, Deletes an Allocation from a Prepayment — response body — Invoice Line Items item, Retrieves journals — response body — Warnings item

Updates a specific quote — request body — body Quotes item

Field	Type	Presence	Description and constraints
$	object	Root
BrandingThemeID	string	Optional	See BrandingThemes Format: uuid
Contact	Model	Optional	Expand Creates contacts to a specific contact group — request body — body Contacts item
CurrencyCode	Model	Optional	Expand Create a new currency for a Xero organisation — request body — body Code
CurrencyRate	number	Optional	The currency rate for a multicurrency quote Format: double
Date	string	Optional	Date quote was issued – YYYY-MM-DD. If the Date element is not specified it will default to the current date based on the timezone setting of the organisation
DateString	string	Optional	Date the quote was issued (YYYY-MM-DD)
ExpiryDate	string	Optional	Date the quote expires – YYYY-MM-DD.
ExpiryDateString	string	Optional	Date the quote expires – YYYY-MM-DD.
LineAmountTypes	string	Optional	Line amounts are exclusive of tax by default if you don’t specify this element. See Line Amount Types See Quote Line Amount Types One of: EXCLUSIVE, INCLUSIVE, NOTAX
LineItems	array	Optional	See LineItems
LineItems[]	Model	Each item	Expand Creates a single payment for invoice or credit notes — request body — body Invoice Line Items item
QuoteID	string	Optional	QuoteID GUID is automatically generated and is returned after create or GET. Format: uuid
QuoteNumber	string	Optional	Unique alpha numeric code identifying a quote (Max Length = 255) Maximum length: 255
Reference	string	Optional	Additional reference number Maximum length: 4000
Status	string	Optional	The status of the quote. One of: DRAFT, SENT, DECLINED, ACCEPTED, INVOICED, DELETED
StatusAttributeString	string	Optional	A string to indicate if a invoice status
SubTotal	number	Optional	Total of quote excluding taxes. Format: double Read only: true
Summary	string	Optional	Summary text for the quote Maximum length: 3000
Terms	string	Optional	Terms of the quote Maximum length: 4000
Title	string	Optional	Title text for the quote Maximum length: 100
Total	number	Optional	Total of Quote tax inclusive (i.e. SubTotal + TotalTax). This will be ignored if it doesn’t equal the sum of the LineAmounts Format: double Read only: true
TotalDiscount	number	Optional	Total of discounts applied on the quote line items Format: double Read only: true
TotalTax	number	Optional	Total tax on quote Format: double Read only: true
UpdatedDateUTC	string	Optional	Last modified date UTC format Read only: true
ValidationErrors	array	Optional	Displays array of validation error messages from the API
ValidationErrors[]	Model	Each item	Expand Retrieves journals — response body — Warnings item

Referenced models: Create a new currency for a Xero organisation — request body — body Code, Creates contacts to a specific contact group — request body — body Contacts item, Creates a single payment for invoice or credit notes — request body — body Invoice Line Items item, Retrieves journals — response body — Warnings item

Deletes an Allocation from a Prepayment — response body — Invoice Currency Code

Field	Type	Presence	Description and constraints
$	string	Root	3 letter alpha code for the currency – see list of currency codes Known values: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BRL, BSD, BTN, BWP, BYN, BYR, BZD, CAD, CDF, CHF, CLF, CLP, CNY, COP, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EEK, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LTL, LVL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MRU, MUR, MVR, MWK, MXN, MXV, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SKK, SLE, SLL, SOS, SRD, STD, STN, SVC, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VEF, VES, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW, ZMK, ZWD

Retrieves journals — response body — Warnings item

Field	Type	Presence	Description and constraints
$	object	Root
Message	string	Optional	Validation error message

Policy, approvals and errors

SDK function policy ID: xero.updateorcreatequotes. Catalog operation: updateOrCreateQuotes. 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