Xero: Retrieves a specific purchase order using purchase order number

← Accounting operations · Get started

Operation xero.getpurchaseorderbynumber

Provider route: GET /api.xro/2.0/PurchaseOrders/{PurchaseOrderNumber}. 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"]["getPurchaseOrderByNumber"]>[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.getPurchaseOrderByNumber(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_purchase_order_by_number(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.PurchaseOrderNumber	string	Required within parent
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 purchase orders — response body

Referenced models: Retrieves purchase orders — response body

Schemas

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

Retrieves purchase orders — response body

Field	Type	Presence	Description and constraints
$	object	Root
PurchaseOrders	array	Optional
PurchaseOrders[]	Model	Each item	Expand Retrieves purchase orders — response body — Purchase Orders item
Warnings	array	Optional	Displays array of warning messages from the API
Warnings[]	Model	Each item	Expand Retrieves journals — response body — Warnings item
pagination	Model	Optional	Expand Retrieves prepayments — response body — pagination

Referenced models: Retrieves prepayments — response body — pagination, Retrieves purchase orders — response body — Purchase Orders item, Retrieves journals — response body — Warnings item

Retrieves prepayments — response body — pagination

Field	Type	Presence	Description and constraints
$	object	Root
itemCount	JSON	Optional
itemCount (anyOf 1)	integer	Alternative
itemCount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
page	JSON	Optional
page (anyOf 1)	integer	Alternative
page (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
pageCount	JSON	Optional
pageCount (anyOf 1)	integer	Alternative
pageCount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
pageSize	JSON	Optional
pageSize (anyOf 1)	integer	Alternative
pageSize (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Retrieves purchase orders — response body — Purchase Orders item

Field	Type	Presence	Description and constraints
$	object	Root
Attachments	array	Optional	Displays array of attachments from the API
Attachments[]	Model	Each item	Expand create Contact Attachment By File Name — response body — Attachments item
AttentionTo	string	Optional	The person that the delivery is going to
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 purchase order. If no rate is specified, the XE.com day rate is used. Format: double
CurrencyRate (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
Date	string	Optional	Date purchase order was issued – YYYY-MM-DD. If the Date element is not specified then it will default to the current date based on the timezone setting of the organisation
DeliveryAddress	string	Optional	The address the goods are to be delivered to
DeliveryDate	string	Optional	Date the goods are to be delivered – YYYY-MM-DD
DeliveryInstructions	string	Optional	A free text feild for instructions (500 characters max)
ExpectedArrivalDate	string	Optional	The date the goods are expected to arrive.
HasAttachments	boolean	Optional	boolean to indicate if a purchase order has an attachment Default: false Read only: true
LineAmountTypes	string	Optional	Line amounts are exclusive of tax by default if you don’t specify this element. See 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
PurchaseOrderID	string	Optional	Xero generated unique identifier for purchase order Format: uuid
PurchaseOrderNumber	string	Optional	Unique alpha numeric code identifying purchase order (when missing will auto-generate from your Organisation Invoice Settings)
Reference	string	Optional	Additional reference number
SentToContact	boolean	Optional	Boolean to set whether the purchase order should be marked as “sent”. This can be set only on purchase orders that have been approved or billed
Status	string	Optional	See Purchase Order Status Codes Known values: DRAFT, SUBMITTED, AUTHORISED, BILLED, DELETED
StatusAttributeString	string	Optional	A string to indicate if a invoice status
SubTotal	JSON	Optional
SubTotal (anyOf 1)	number	Alternative	Total of purchase order excluding taxes Format: double Read only: true
SubTotal (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
Telephone	string	Optional	The phone number for the person accepting the delivery
Total	JSON	Optional
Total (anyOf 1)	number	Alternative	Total of Purchase Order tax inclusive (i.e. SubTotal + TotalTax) 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 purchase order 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 purchase order 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
Warnings	array	Optional	Displays array of warning messages from the API
Warnings[]	Model	Each item	Expand Retrieves journals — response body — Warnings item

Referenced models: Deletes an Allocation from a Prepayment — response body — Invoice Currency Code, create Contact Attachment By File Name — response body — Attachments item, 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

Retrieves journals — response body — Warnings item

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

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

create Contact Attachment By File Name — response body — Attachments item

Field	Type	Presence	Description and constraints
$	object	Root
AttachmentID	string	Optional	Unique ID for the file Format: uuid
ContentLength	JSON	Optional
ContentLength (anyOf 1)	integer	Alternative	Length of the file content
ContentLength (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
FileName	string	Optional	Name of the file
IncludeOnline	boolean	Optional	Include the file with the online invoice
MimeType	string	Optional	Type of file
Url	string	Optional	URL to the file on xero.com

Creates contacts to a specific contact group — response body — Contacts item Contact Persons item

Field	Type	Presence	Description and constraints
$	object	Root
EmailAddress	string	Optional	Email address of person
FirstName	string	Optional	First name of person
IncludeInEmails	boolean	Optional	boolean to indicate whether contact should be included on emails with invoices etc.
LastName	string	Optional	Last name of person

Policy, approvals and errors

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