Xero: Retrieves a specific file associations

← Files operations · Get started

Operation xero.files_getfileassociations

Provider route: GET /files.xro/1.0/Files/{FileId}/Associations. 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["files"]["getFileAssociations"]>[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.files.getFileAssociations(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.files.get_file_associations(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.FileId	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
$	array	Root
$[]	Model	Each item	Expand Creates a new file association — response body

Referenced models: Creates a new file association — response body

Schemas

Creates a new file association — response body

Field	Type	Presence	Description and constraints
$	object	Root
AssociationDateUtc	string	Optional	The date the file was associated with the object (UTC). Note- The AssociationDateUtc element is only returned when using /Associations/{ObjectId} endpoint. Format: date-time
CreatedDateUtc	string	Optional	The date the file was created (UTC). Note- The CreatedDateUtc element is only returned when using /Associations/{ObjectId} endpoint. Format: date-time
FileId	string	Optional	The unique identifier of the file Format: uuid
Name	string	Optional	The name of the associated file. Note- The Name element is only returned when using /Associations/{ObjectId} endpoint.
ObjectGroup	string	Optional	The Object Group that the object is in. These roughly correlate to the endpoints that can be used to retrieve the object via the core accounting API. Known values: Account, BankTransaction, Contact, CreditNote, Invoice, Item, ManualJournal, Overpayment, Payment, Prepayment, Quote, Receipt
ObjectId	string	Optional	The identifier of the object that the file is being associated with (e.g. InvoiceID, BankTransactionID, ContactID) Format: uuid
ObjectType	Model	Optional	Expand Creates a new file association — response body — Object Type
SendWithObject	boolean	Optional	Boolean flag to determines whether the file is sent with the document it is attached to on client facing communications. Note- The SendWithObject element is only returned when using /Associations/{ObjectId} endpoint.
Size	JSON	Optional
Size (anyOf 1)	integer	Alternative	The size of the associated file in bytes. Note- The Size element is only returned when using /Associations/{ObjectId} endpoint.
Size (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Creates a new file association — response body — Object Type

Creates a new file association — response body — Object Type

Field	Type	Presence	Description and constraints
$	string	Root	The Object Type Known values: Unknown, Accpay, AccPayCredit, AccPayPayment, AccRec, AccRecCredit, AccRecPayment, Adjustment, ApCreditPayment, ApOverPayment, ApOverPaymentPayment, ApOverPaymentSourcePayment, ApPrepayment, ApPrepaymentPayment, ApPrepaymentSourcePayment, ArCreditPayment, ArOverPayment, ArOverpaymentPayment, ArOverpaymentSourcePayment, ArPrepayment, ArPrepaymentPayment, ArPrepaymentSourcePayment, CashPaid, CashRec, ExpPayment, ManJournal, PurchaseOrder, Receipt, Transfer, Account, Contact, Business, Employee, Person, User, Org, FixedAsset, PayRun, PriceListItem, Bank, Current, Equity, Expense, Fixed, Liability, Prepayment, Revenue, Sales, Overheads, Depreciatn, OtherIncome, DirectCosts, Currliab, Termliab, NonCurrent, SalesQuote

Policy, approvals and errors

SDK function policy ID: xero.files_getfileassociations. Catalog operation: files.getFileAssociations. 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