Xero: Retrieves a specific draft expense claim receipt by using a unique receipt Id

← Accounting operations · Get started

Operation xero.getreceipt

Provider route: GET /api.xro/2.0/Receipts/{ReceiptID}. 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"]["getReceipt"]>[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.getReceipt(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_receipt(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.ReceiptID	string	Required within parent	Format: uuid
query	object	Optional	Additional keys: not allowed
query.unitdp	integer	Optional
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 Updates a specific draft expense claim receipts — response body

Referenced models: Updates a specific draft expense claim receipts — response body

Schemas

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

Updates a specific draft expense claim receipts — response body

Field	Type	Presence	Description and constraints
$	object	Root
Receipts	array	Optional
Receipts[]	Model	Each item	Expand Updates a specific draft expense claim receipts — response body — Receipts item

Referenced models: Updates a specific draft expense claim receipts — response body — Receipts item

Updates a specific draft expense claim receipts — response body — Receipts 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
Contact	Model	Optional	Expand Creates contacts to a specific contact group — response body — Contacts item
Date	string	Optional	Date of receipt – YYYY-MM-DD
HasAttachments	boolean	Optional	boolean to indicate if a receipt 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
LineItems[]	Model	Each item	Expand Deletes an Allocation from a Prepayment — response body — Invoice Line Items item
ReceiptID	string	Optional	Xero generated unique identifier for receipt Format: uuid
ReceiptNumber	string	Optional	Xero generated sequence number for receipt in current claim for a given user Read only: true
Reference	string	Optional	Additional reference number
Status	string	Optional	Current status of receipt – see status types Known values: DRAFT, SUBMITTED, AUTHORISED, DECLINED, VOIDED
SubTotal	JSON	Optional
SubTotal (anyOf 1)	number	Alternative	Total of receipt excluding taxes Format: double
SubTotal (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
Total	JSON	Optional
Total (anyOf 1)	number	Alternative	Total of receipt tax inclusive (i.e. SubTotal + TotalTax) Format: double
Total (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
TotalTax	JSON	Optional
TotalTax (anyOf 1)	number	Alternative	Total tax on receipt Format: double
TotalTax (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
UpdatedDateUTC	string	Optional	Last modified date UTC format Read only: true
Url	string	Optional	URL link to a source document – shown as “Go to [appName]” in the Xero app Read only: true
User	Model	Optional	Expand Retrieves users — response body — Users item
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: Retrieves users — response body — Users item, 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 users — response body — Users item

Field	Type	Presence	Description and constraints
$	object	Root
EmailAddress	string	Optional	Email address of user
FirstName	string	Optional	First name of user
IsSubscriber	boolean	Optional	Boolean to indicate if user is the subscriber
LastName	string	Optional	Last name of user
OrganisationRole	string	Optional	User role that defines permissions in Xero and via API (READONLY, INVOICEONLY, STANDARD, FINANCIALADVISER, etc) Known values: READONLY, INVOICEONLY, STANDARD, FINANCIALADVISER, MANAGEDCLIENT, CASHBOOKCLIENT, UNKNOWN, REMOVED
UpdatedDateUTC	string	Optional	Timestamp of last change to user Read only: true
UserID	string	Optional	Xero identifier Format: uuid

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

Retrieves journals — response body — Warnings item

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

Creates contacts to a specific contact group — response body — Contacts item Batch Payments

Field	Type	Presence	Description and constraints
$	JSON	Root	Bank details for use on a batch payment stored with each contact
BankAccountName	string	Optional	Name of bank for use with Batch Payments
BankAccountNumber	string	Optional	Bank account number for use with Batch Payments
Code	string	Optional	(NZ Only) Optional references for the batch payment transaction. It will also show with the batch payment transaction in the bank reconciliation Find & Match screen. Depending on your individual bank, the detail may also show on the bank statement you import into Xero. Maximum length: 12
Details	string	Optional	(Non-NZ Only) These details are sent to the org’s bank as a reference for the batch payment transaction. They will also show with the batch payment transaction in the bank reconciliation Find & Match screen. Depending on your individual bank, the detail may also show on the bank statement imported into Xero. Maximum field length = 18
Reference	string	Optional	(NZ Only) Optional references for the batch payment transaction. It will also show with the batch payment transaction in the bank reconciliation Find & Match screen. Depending on your individual bank, the detail may also show on the bank statement you import into Xero. Maximum length: 12

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

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

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

Field	Type	Presence	Description and constraints
$	object	Root
AddressLine1	string	Optional	max length = 500 Maximum length: 500
AddressLine2	string	Optional	max length = 500 Maximum length: 500
AddressLine3	string	Optional	max length = 500 Maximum length: 500
AddressLine4	string	Optional	max length = 500 Maximum length: 500
AddressType	string	Optional	define the type of address Known values: POBOX, STREET
AttentionTo	string	Optional	max length = 255 Maximum length: 255
City	string	Optional	max length = 255 Maximum length: 255
Country	string	Optional	max length = 50, [A-Z], [a-z] only Maximum length: 50
PostalCode	string	Optional	max length = 50 Maximum length: 50
Region	string	Optional	max length = 255 Maximum length: 255

Policy, approvals and errors

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