Xero: Uploads a File to the inbox

← Files operations · Get started

Operation xero.files_uploadfile

Provider route: POST /files.xro/1.0/Files. 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"]["uploadFile"]>[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.uploadFile(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.upload_file(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
headers	object	Required within parent	Additional keys: not allowed
headers.xero-tenant-id	string	Required within parent
headers.Idempotency-Key	string	Optional
body	object	Required within parent
body.body	string	Required within parent	Format: byte
body.filename	string	Required within parent
body.mimeType	string	Optional
body.name	string	Required within parent	exact name of the file you are uploading

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 Update a file — response body

Referenced models: Update a file — response body

Schemas

Update a file — response body

Field	Type	Presence	Description and constraints
$	object	Root
CreatedDateUtc	string	Optional	Created date in UTC
FolderId	string	Optional	Folder relation object's UUID Format: uuid
Id	string	Optional	File object's UUID Format: uuid
MimeType	string	Optional	MimeType of the file (image/png, image/jpeg, application/pdf, etc..)
Name	string	Optional	File Name
Size	JSON	Optional
Size (anyOf 1)	integer	Alternative	Numeric value in bytes
Size (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
UpdatedDateUtc	string	Optional	Updated date in UTC
User	Model	Optional	Expand Update a file — response body — User

Referenced models: Update a file — response body — User

Update a file — response body — User

Field	Type	Presence	Description and constraints
$	object	Root
FirstName	string	Optional	First name of user
FullName	string	Optional	Last name of user
Id	string	Required within parent	Xero identifier Format: uuid
LastName	string	Optional	Last name of user
Name	string	Optional	Key is Name, but returns Email address of user who created the file

Policy, approvals and errors

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