Xero: Retrieve reports for 1099

← Accounting operations · Get started

Operation xero.getreporttenninetynine

Provider route: GET /api.xro/2.0/Reports/TenNinetyNine. 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"]["getReportTenNinetyNine"]>[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.getReportTenNinetyNine(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_report_ten_ninety_nine(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
query	object	Optional	Additional keys: not allowed
query.reportYear	string	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 Retrieve reports for 1099 — response body

Referenced models: Retrieve reports for 1099 — response body

Schemas

Retrieve reports for 1099 — response body

Field	Type	Presence	Description and constraints
$	object	Root
Reports	array	Optional
Reports[]	Model	Each item	Expand Retrieve reports for 1099 — response body — Reports item

Referenced models: Retrieve reports for 1099 — response body — Reports item

Retrieve reports for 1099 — response body — Reports item

Field	Type	Presence	Description and constraints
$	JSON	Root
Contacts	array	Optional
Contacts[]	Model	Each item	Expand Retrieve reports for 1099 — response body — Reports item Contacts item
ReportDate	string	Optional	Date of report
ReportName	string	Optional	See Prepayment Types
ReportTitle	string	Optional	See Prepayment Types
ReportType	string	Optional	See Prepayment Types Known values: AgedPayablesByContact
UpdatedDateUTC	string	Optional	Updated Date Read only: true

Referenced models: Retrieve reports for 1099 — response body — Reports item Contacts item

Retrieve reports for 1099 — response body — Reports item Contacts item

Field	Type	Presence	Description and constraints
$	JSON	Root
Box1	JSON	Optional
Box1 (anyOf 1)	number	Alternative	Box 1 on 1099 Form Format: double
Box1 (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
Box10	JSON	Optional
Box10 (anyOf 1)	number	Alternative	Box 10 on 1099 Form Format: double
Box10 (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
Box11	JSON	Optional
Box11 (anyOf 1)	number	Alternative	Box 11 on 1099 Form Format: double
Box11 (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
Box13	JSON	Optional
Box13 (anyOf 1)	number	Alternative	Box 13 on 1099 Form Format: double
Box13 (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
Box14	JSON	Optional
Box14 (anyOf 1)	number	Alternative	Box 14 on 1099 Form Format: double
Box14 (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
Box2	JSON	Optional
Box2 (anyOf 1)	number	Alternative	Box 2 on 1099 Form Format: double
Box2 (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
Box3	JSON	Optional
Box3 (anyOf 1)	number	Alternative	Box 3 on 1099 Form Format: double
Box3 (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
Box4	JSON	Optional
Box4 (anyOf 1)	number	Alternative	Box 4 on 1099 Form Format: double
Box4 (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
Box5	JSON	Optional
Box5 (anyOf 1)	number	Alternative	Box 5 on 1099 Form Format: double
Box5 (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
Box6	JSON	Optional
Box6 (anyOf 1)	number	Alternative	Box 6 on 1099 Form Format: double
Box6 (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
Box7	JSON	Optional
Box7 (anyOf 1)	number	Alternative	Box 7 on 1099 Form Format: double
Box7 (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
Box8	JSON	Optional
Box8 (anyOf 1)	number	Alternative	Box 8 on 1099 Form Format: double
Box8 (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
Box9	JSON	Optional
Box9 (anyOf 1)	number	Alternative	Box 9 on 1099 Form Format: double
Box9 (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
BusinessName	string	Optional	Contact business name
City	string	Optional	Contact city on 1099 Form
ContactId	string	Optional	Contact contact id Format: uuid
Email	string	Optional	Contact email on 1099 Form
FederalTaxClassification	string	Optional	Contact federal tax classification Known values: SOLE_PROPRIETOR, PARTNERSHIP, TRUST_OR_ESTATE, NONPROFIT, C_CORP, S_CORP, OTHER
FederalTaxIDType	string	Optional	Contact Fed Tax ID type
LegalName	string	Optional	Contact legal name
Name	string	Optional	Contact name on 1099 Form
State	string	Optional	Contact State on 1099 Form
StreetAddress	string	Optional	Contact address on 1099 Form
TaxID	string	Optional	Contact tax id on 1099 Form
Zip	string	Optional	Contact zip on 1099 Form

Policy, approvals and errors

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