Xero: Retrieves a specific quote using a unique quote Id

← Accounting operations · Get started

Operation xero.getquote

Provider route: GET /api.xro/2.0/Quotes/{QuoteID}. 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"]["getQuote"]>[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.getQuote(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.get_quote(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.QuoteID	string	Required within parent	Format: uuid
headers	object	Required within parent	Additional keys: not allowed
headers.xero-tenant-id	string	Required within parent

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

17 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

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

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

Deletes an Allocation from a Prepayment — response body — Invoice Line Items item

Field	Type	Presence	Description and constraints
$	object	Root
AccountCode	string	Optional	See Accounts
AccountID	string	Optional	The associated account ID related to this line item Format: uuid
Description	string	Optional	Description needs to be at least 1 char long. A line item with just a description (i.e no unit amount or quantity) can be created by specifying just a <Description> element that contains at least 1 character
DiscountAmount	JSON	Optional
DiscountAmount (anyOf 1)	number	Alternative	Discount amount being applied to a line item. Only supported on ACCREC invoices and quotes. ACCPAY invoices and credit notes in Xero do not support discounts. Format: double
DiscountAmount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
DiscountRate	JSON	Optional
DiscountRate (anyOf 1)	number	Alternative	Percentage discount being applied to a line item (only supported on ACCREC invoices – ACC PAY invoices and credit notes in Xero do not support discounts Format: double
DiscountRate (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
Item	Model	Optional	Expand Deletes an Allocation from a Prepayment — response body — Invoice Line Items item Item
ItemCode	string	Optional	See Items
LineAmount	JSON	Optional
LineAmount (anyOf 1)	number	Alternative	If you wish to omit either the Quantity or UnitAmount you can provide a LineAmount and Xero will calculate the missing amount for you. The line amount reflects the discounted price if either a DiscountRate or DiscountAmount has been used i.e. LineAmount = Quantity * Unit Amount * ((100 - DiscountRate)/100) or LineAmount = (Quantity * UnitAmount) - DiscountAmount Format: double
LineAmount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
LineItemID	string	Optional	LineItem unique ID Format: uuid
Quantity	JSON	Optional
Quantity (anyOf 1)	number	Alternative	LineItem Quantity Format: double
Quantity (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
RepeatingInvoiceID	string	Optional	The Xero identifier for a Repeating Invoice Format: uuid
SalesTaxCodeId	JSON	Optional
SalesTaxCodeId (anyOf 1)	number	Alternative	The ID of the sales tax code
SalesTaxCodeId (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
TaxAmount	JSON	Optional
TaxAmount (anyOf 1)	number	Alternative	The tax amount is auto calculated as a percentage of the line amount (see below) based on the tax rate. This value can be overriden if the calculated <TaxAmount> is not correct. Format: double
TaxAmount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
TaxBreakdown	array	Optional	An array of tax components defined for this line item
TaxBreakdown[]	Model	Each item	Expand Deletes an Allocation from a Prepayment — response body — Invoice Line Items item Tax Breakdown item
TaxType	string	Optional	The tax type from TaxRates
Taxability	string	Optional	The type of taxability Known values: TAXABLE, NON_TAXABLE, EXEMPT, PART_TAXABLE, NOT_APPLICABLE
Tracking	array	Optional	Optional Tracking Category – see Tracking. Any LineItem can have a maximum of 2 <TrackingCategory> elements.
Tracking[]	Model	Each item	Expand Deletes an Allocation from a Prepayment — response body — Invoice Line Items item Tracking item
UnitAmount	JSON	Optional
UnitAmount (anyOf 1)	number	Alternative	LineItem Unit Amount Format: double
UnitAmount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Deletes an Allocation from a Prepayment — response body — Invoice Line Items item Item, Deletes an Allocation from a Prepayment — response body — Invoice Line Items item Tracking item, Deletes an Allocation from a Prepayment — response body — Invoice Line Items item Tax Breakdown item

Policy, approvals and errors

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