Xero: Retrieves a specific branding theme using a unique branding theme Id

← Accounting operations · Get started

Operation xero.getbrandingtheme

Provider route: GET /api.xro/2.0/BrandingThemes/{BrandingThemeID}. 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"]["getBrandingTheme"]>[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.getBrandingTheme(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_branding_theme(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.BrandingThemeID	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
$	Model	Root	Expand Retrieves all the branding themes — response body

Referenced models: Retrieves all the branding themes — response body

Schemas

Retrieves all the branding themes — response body

Field	Type	Presence	Description and constraints
$	object	Root
BrandingThemes	array	Optional
BrandingThemes[]	Model	Each item	Expand Retrieves all the branding themes — response body — Branding Themes item

Referenced models: Retrieves all the branding themes — response body — Branding Themes item

Retrieves all the branding themes — response body — Branding Themes item

Field	Type	Presence	Description and constraints
$	object	Root
BrandingThemeID	string	Optional	Xero identifier Format: uuid
CreatedDateUTC	string	Optional	UTC timestamp of creation date of branding theme Read only: true
LogoUrl	string	Optional	The location of the image file used as the logo on this branding theme
Name	string	Optional	Name of branding theme
SortOrder	JSON	Optional
SortOrder (anyOf 1)	integer	Alternative	Integer – ranked order of branding theme. The default branding theme has a value of 0
SortOrder (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
Type	string	Optional	Always INVOICE Known values: INVOICE

Policy, approvals and errors

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