Xero: Retrieves a specific repeating invoice by using a unique repeating invoice Id

← Accounting operations · Get started

Operation xero.getrepeatinginvoice

Provider route: GET /api.xro/2.0/RepeatingInvoices/{RepeatingInvoiceID}. 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"]["getRepeatingInvoice"]>[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.getRepeatingInvoice(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_repeating_invoice(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.RepeatingInvoiceID	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 repeating invoices — response body

Referenced models: Retrieves repeating invoices — response body

Schemas

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

Retrieves repeating invoices — response body

Field	Type	Presence	Description and constraints
$	object	Root
RepeatingInvoices	array	Optional
RepeatingInvoices[]	Model	Each item	Expand Retrieves repeating invoices — response body — Repeating Invoices item

Referenced models: Retrieves repeating invoices — response body — Repeating Invoices item

Retrieves repeating invoices — response body — Repeating Invoices item

Field	Type	Presence	Description and constraints
$	object	Root
ApprovedForSending	boolean	Optional	Boolean to indicate whether the invoice has been approved for sending Default: false
Attachments	array	Optional	Displays array of attachments from the API
Attachments[]	Model	Each item	Expand create Contact Attachment By File Name — response body — Attachments item
BrandingThemeID	string	Optional	See BrandingThemes Format: uuid
Contact	Model	Optional	Expand Creates contacts to a specific contact group — response body — Contacts item
CurrencyCode	Model	Optional	Expand Deletes an Allocation from a Prepayment — response body — Invoice Currency Code
HasAttachments	boolean	Optional	Boolean to indicate if an invoice has an attachment Default: false Read only: true
ID	string	Optional	Xero generated unique identifier for repeating invoice template Format: uuid
IncludePDF	boolean	Optional	Boolean to indicate whether to include PDF attachment Default: false
LineAmountTypes	string	Optional	Line amounts are exclusive of tax by default if you don’t specify this element. See Line Amount Types Known values: Exclusive, Inclusive, NoTax
LineItems	array	Optional	See LineItems
LineItems[]	Model	Each item	Expand Deletes an Allocation from a Prepayment — response body — Invoice Line Items item
MarkAsSent	boolean	Optional	Boolean to indicate whether the invoice in the Xero app displays as "sent" Default: false
Reference	string	Optional	ACCREC only – additional reference number
RepeatingInvoiceID	string	Optional	Xero generated unique identifier for repeating invoice template Format: uuid
Schedule	Model	Optional	Expand Retrieves repeating invoices — response body — Repeating Invoices item Schedule
SendCopy	boolean	Optional	Boolean to indicate whether a copy is sent to sender's email Default: false
Status	string	Optional	One of the following - DRAFT or AUTHORISED – See Invoice Status Codes Known values: DRAFT, AUTHORISED, DELETED
SubTotal	JSON	Optional
SubTotal (anyOf 1)	number	Alternative	Total of invoice excluding taxes Format: double
SubTotal (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
Total	JSON	Optional
Total (anyOf 1)	number	Alternative	Total of Invoice tax inclusive (i.e. SubTotal + TotalTax) Format: double
Total (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
TotalTax	JSON	Optional
TotalTax (anyOf 1)	number	Alternative	Total tax on invoice Format: double
TotalTax (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
Type	string	Optional	See Invoice Types Known values: ACCPAY, ACCREC

Referenced models: Deletes an Allocation from a Prepayment — response body — Invoice Currency Code, create Contact Attachment By File Name — response body — Attachments item, Creates contacts to a specific contact group — response body — Contacts item, Deletes an Allocation from a Prepayment — response body — Invoice Line Items item, Retrieves repeating invoices — response body — Repeating Invoices item Schedule

Deletes an Allocation from a Prepayment — response body — Invoice Currency Code

Field	Type	Presence	Description and constraints
$	string	Root	3 letter alpha code for the currency – see list of currency codes Known values: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BRL, BSD, BTN, BWP, BYN, BYR, BZD, CAD, CDF, CHF, CLF, CLP, CNY, COP, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EEK, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LTL, LVL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MRU, MUR, MVR, MWK, MXN, MXV, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SKK, SLE, SLL, SOS, SRD, STD, STN, SVC, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VEF, VES, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW, ZMK, ZWD

create Contact Attachment By File Name — response body — Attachments item

Field	Type	Presence	Description and constraints
$	object	Root
AttachmentID	string	Optional	Unique ID for the file Format: uuid
ContentLength	JSON	Optional
ContentLength (anyOf 1)	integer	Alternative	Length of the file content
ContentLength (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
FileName	string	Optional	Name of the file
IncludeOnline	boolean	Optional	Include the file with the online invoice
MimeType	string	Optional	Type of file
Url	string	Optional	URL to the file on xero.com

Retrieves repeating invoices — response body — Repeating Invoices item Schedule

Field	Type	Presence	Description and constraints
$	object	Root
DueDate	JSON	Optional
DueDate (anyOf 1)	integer	Alternative	Integer used with due date type e.g 20 (of following month), 31 (of current month)
DueDate (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
DueDateType	string	Optional	the payment terms Known values: DAYSAFTERBILLDATE, DAYSAFTERBILLMONTH, DAYSAFTERINVOICEDATE, DAYSAFTERINVOICEMONTH, OFCURRENTMONTH, OFFOLLOWINGMONTH
EndDate	string	Optional	Invoice end date – only returned if the template has an end date set
NextScheduledDate	string	Optional	The calendar date of the next invoice in the schedule to be generated
Period	JSON	Optional
Period (anyOf 1)	integer	Alternative	Integer used with the unit e.g. 1 (every 1 week), 2 (every 2 months)
Period (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
StartDate	string	Optional	Date the first invoice of the current version of the repeating schedule was generated (changes when repeating invoice is edited)
Unit	string	Optional	One of the following - WEEKLY or MONTHLY Known values: WEEKLY, MONTHLY

Creates contacts to a specific contact group — response body — Contacts item Batch Payments

Field	Type	Presence	Description and constraints
$	JSON	Root	Bank details for use on a batch payment stored with each contact
BankAccountName	string	Optional	Name of bank for use with Batch Payments
BankAccountNumber	string	Optional	Bank account number for use with Batch Payments
Code	string	Optional	(NZ Only) Optional references for the batch payment transaction. It will also show with the batch payment transaction in the bank reconciliation Find & Match screen. Depending on your individual bank, the detail may also show on the bank statement you import into Xero. Maximum length: 12
Details	string	Optional	(Non-NZ Only) These details are sent to the org’s bank as a reference for the batch payment transaction. They will also show with the batch payment transaction in the bank reconciliation Find & Match screen. Depending on your individual bank, the detail may also show on the bank statement imported into Xero. Maximum field length = 18
Reference	string	Optional	(NZ Only) Optional references for the batch payment transaction. It will also show with the batch payment transaction in the bank reconciliation Find & Match screen. Depending on your individual bank, the detail may also show on the bank statement you import into Xero. Maximum length: 12

Creates contacts to a specific contact group — response body — Contacts item Contact Persons item

Field	Type	Presence	Description and constraints
$	object	Root
EmailAddress	string	Optional	Email address of person
FirstName	string	Optional	First name of person
IncludeInEmails	boolean	Optional	boolean to indicate whether contact should be included on emails with invoices etc.
LastName	string	Optional	Last name of person

Creates contacts to a specific contact group — response body — Contacts item Balances

Field	Type	Presence	Description and constraints
$	object	Root	The raw AccountsReceivable(sales invoices) and AccountsPayable(bills) outstanding and overdue amounts, not converted to base currency (read only)
AccountsPayable	Model	Optional	Expand Creates contacts to a specific contact group — response body — Contacts item Balances Accounts Payable
AccountsReceivable	Model	Optional	Expand Creates contacts to a specific contact group — response body — Contacts item Balances Accounts Payable

Referenced models: Creates contacts to a specific contact group — response body — Contacts item Balances Accounts Payable

Policy, approvals and errors

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