Xero: Updates a specific expense claims

← Accounting operations · Get started

Operation xero.updateexpenseclaim

Provider route: POST /api.xro/2.0/ExpenseClaims/{ExpenseClaimID}. 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"]["updateExpenseClaim"]>[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.updateExpenseClaim(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_expense_claim(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.ExpenseClaimID	string	Required within parent	Format: uuid
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 Creates expense claims — request body — body

Referenced models: Creates expense claims — 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 Creates expense claims — response body

Referenced models: Creates expense claims — response body

Schemas

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

Creates expense claims — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
ExpenseClaims	array	Optional
ExpenseClaims[]	Model	Each item	Expand Creates expense claims — request body — body Expense Claims item

Referenced models: Creates expense claims — request body — body Expense Claims item

Creates expense claims — response body

Field	Type	Presence	Description and constraints
$	object	Root
ExpenseClaims	array	Optional
ExpenseClaims[]	Model	Each item	Expand Creates expense claims — response body — Expense Claims item

Referenced models: Creates expense claims — response body — Expense Claims item

Creates expense claims — request body — body Expense Claims item

Field	Type	Presence	Description and constraints
$	object	Root
AmountDue	number	Optional	The amount due to be paid for an expense claim Format: double Read only: true
AmountPaid	number	Optional	The amount still to pay for an expense claim Format: double Read only: true
ExpenseClaimID	string	Optional	Xero generated unique identifier for an expense claim Format: uuid
PaymentDueDate	string	Optional	The date when the expense claim is due to be paid YYYY-MM-DD Read only: true
Payments	array	Optional	See Payments
Payments[]	Model	Each item	Expand Creates a single payment for invoice or credit notes — request body — body
ReceiptID	string	Optional	The Xero identifier for the Receipt e.g. e59a2c7f-1306-4078-a0f3-73537afcbba9 Format: uuid
Receipts	array	Optional
Receipts[]	Model	Each item	Expand Updates a specific draft expense claim receipts — request body — body Receipts item
ReportingDate	string	Optional	The date the expense claim will be reported in Xero YYYY-MM-DD Read only: true
Status	string	Optional	Current status of an expense claim – see status types One of: SUBMITTED, AUTHORISED, PAID, VOIDED, DELETED
Total	number	Optional	The total of an expense claim being paid Format: double Read only: true
UpdatedDateUTC	string	Optional	Last modified date UTC format Read only: true
User	Model	Optional	Expand Updates a specific draft expense claim receipts — request body — body Receipts item User

Referenced models: Updates a specific draft expense claim receipts — request body — body Receipts item User, Creates a single payment for invoice or credit notes — request body — body, Updates a specific draft expense claim receipts — request body — body Receipts item

Creates expense claims — response body — Expense Claims item

Field	Type	Presence	Description and constraints
$	object	Root
AmountDue	JSON	Optional
AmountDue (anyOf 1)	number	Alternative	The amount due to be paid for an expense claim Format: double Read only: true
AmountDue (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
AmountPaid	JSON	Optional
AmountPaid (anyOf 1)	number	Alternative	The amount still to pay for an expense claim Format: double Read only: true
AmountPaid (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
ExpenseClaimID	string	Optional	Xero generated unique identifier for an expense claim Format: uuid
PaymentDueDate	string	Optional	The date when the expense claim is due to be paid YYYY-MM-DD Read only: true
Payments	array	Optional	See Payments
Payments[]	Model	Each item	Expand Retrieves payments for invoices and credit notes — response body — Payments item
ReceiptID	string	Optional	The Xero identifier for the Receipt e.g. e59a2c7f-1306-4078-a0f3-73537afcbba9 Format: uuid
Receipts	array	Optional
Receipts[]	Model	Each item	Expand Updates a specific draft expense claim receipts — response body — Receipts item
ReportingDate	string	Optional	The date the expense claim will be reported in Xero YYYY-MM-DD Read only: true
Status	string	Optional	Current status of an expense claim – see status types Known values: SUBMITTED, AUTHORISED, PAID, VOIDED, DELETED
Total	JSON	Optional
Total (anyOf 1)	number	Alternative	The total of an expense claim being paid Format: double Read only: true
Total (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
UpdatedDateUTC	string	Optional	Last modified date UTC format Read only: true
User	Model	Optional	Expand Retrieves users — response body — Users item

Referenced models: Retrieves users — response body — Users item, Retrieves payments for invoices and credit notes — response body — Payments item, Updates a specific draft expense claim receipts — response body — Receipts item

Updates a specific draft expense claim receipts — request body — body Receipts item User

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) One of: 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

Updates a specific draft expense claim receipts — request body — 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 Creates a single payment for invoice or credit notes — request body — body Invoice Attachments item
Contact	Model	Optional	Expand Creates contacts to a specific contact group — request body — 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 One of: Exclusive, Inclusive, NoTax
LineItems	array	Optional
LineItems[]	Model	Each item	Expand Creates a single payment for invoice or credit notes — request body — 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 One of: DRAFT, SUBMITTED, AUTHORISED, DECLINED, VOIDED
SubTotal	number	Optional	Total of receipt excluding taxes Format: double
Total	number	Optional	Total of receipt tax inclusive (i.e. SubTotal + TotalTax) Format: double
TotalTax	number	Optional	Total tax on receipt Format: double
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 Updates a specific draft expense claim receipts — request body — body Receipts item User
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: Updates a specific draft expense claim receipts — request body — body Receipts item User, Creates a single payment for invoice or credit notes — request body — body Invoice Attachments item, 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

Policy, approvals and errors

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