Xero: Deletes an Allocation from an overpayment

← Accounting operations · Get started

Operation xero.deleteoverpaymentallocations

Provider route: DELETE /api.xro/2.0/Overpayments/{OverpaymentID}/Allocations/{AllocationID}. 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"]["deleteOverpaymentAllocations"]>[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.deleteOverpaymentAllocations(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.delete_overpayment_allocations(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.OverpaymentID	string	Required within parent	Format: uuid
path.AllocationID	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 Deletes an Allocation from a Prepayment — response body

Referenced models: Deletes an Allocation from a Prepayment — response body

Schemas

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

Deletes an Allocation from a Prepayment — response body

Field	Type	Presence	Description and constraints
$	object	Root
AllocationID	string	Optional	Xero generated unique identifier Format: uuid
Amount	JSON	Required within parent
Amount (anyOf 1)	number	Alternative	the amount being applied to the invoice Format: double
Amount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
CreditNote	Model	Optional	Expand Deletes an Allocation from a Prepayment — response body — Credit Note
Date	string	Required within parent	the date the allocation is applied YYYY-MM-DD.
Invoice	Model	Required within parent	Expand Deletes an Allocation from a Prepayment — response body — Invoice
IsDeleted	boolean	Optional	A flag that returns true when the allocation is succesfully deleted Read only: true
Overpayment	Model	Optional	Expand Deletes an Allocation from a Prepayment — response body — Overpayment
Prepayment	Model	Optional	Expand Deletes an Allocation from a Prepayment — response body — Prepayment
StatusAttributeString	string	Optional	A string to indicate if a invoice status
ValidationErrors	array	Optional	Displays array of validation error messages from the API
ValidationErrors[]	Model	Each item	Expand Retrieves journals — response body — Warnings item

Referenced models: Deletes an Allocation from a Prepayment — response body — Credit Note, Deletes an Allocation from a Prepayment — response body — Invoice, Deletes an Allocation from a Prepayment — response body — Overpayment, Deletes an Allocation from a Prepayment — response body — Prepayment, Retrieves journals — response body — Warnings item

Deletes an Allocation from a Prepayment — response body — Credit Note

Field	Type	Presence	Description and constraints
$	object	Root
Allocations	array	Optional	See Allocations
Allocations[]	Model	Each item	Expand Deletes an Allocation from a Prepayment — response body
AppliedAmount	JSON	Optional
AppliedAmount (anyOf 1)	number	Alternative	The amount of applied to an invoice Format: double
AppliedAmount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
BrandingThemeID	string	Optional	See BrandingThemes Format: uuid
CISDeduction	JSON	Optional
CISDeduction (anyOf 1)	number	Alternative	CIS deduction for UK contractors Format: double Read only: true
CISDeduction (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
CISRate	JSON	Optional
CISRate (anyOf 1)	number	Alternative	CIS Deduction rate for the organisation Format: double Read only: true
CISRate (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
Contact	Model	Optional	Expand Creates contacts to a specific contact group — response body — Contacts item
CreditNoteID	string	Optional	Xero generated unique identifier Format: uuid
CreditNoteNumber	string	Optional	ACCRECCREDIT – Unique alpha numeric code identifying credit note (when missing will auto-generate from your Organisation Invoice Settings)
CurrencyCode	Model	Optional	Expand Deletes an Allocation from a Prepayment — response body — Invoice Currency Code The specified currency code
CurrencyRate	JSON	Optional
CurrencyRate (anyOf 1)	number	Alternative	The currency rate for a multicurrency invoice. If no rate is specified, the XE.com day rate is used Format: double
CurrencyRate (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
Date	string	Optional	The date the credit note is issued YYYY-MM-DD. If the Date element is not specified then it will default to the current date based on the timezone setting of the organisation
DueDate	string	Optional	Date invoice is due – YYYY-MM-DD
FullyPaidOnDate	string	Optional	Date when credit note was fully paid(UTC format)
HasAttachments	boolean	Optional	boolean to indicate if a credit note has an attachment Default: false
HasErrors	boolean	Optional	A boolean to indicate if a credit note has an validation errors Default: false
InvoiceAddresses	array	Optional	An array of addresses used to auto calculate sales tax
InvoiceAddresses[]	Model	Each item	Expand Deletes an Allocation from a Prepayment — response body — Invoice Invoice Addresses item
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 Invoice Line Items
LineItems[]	Model	Each item	Expand Deletes an Allocation from a Prepayment — response body — Invoice Line Items item
Payments	array	Optional	See Payments
Payments[]	Model	Each item	Expand Retrieves payments for invoices and credit notes — response body — Payments item
Reference	string	Optional	ACCRECCREDIT only – additional reference number
RemainingCredit	JSON	Optional
RemainingCredit (anyOf 1)	number	Alternative	The remaining credit balance on the Credit Note Format: double
RemainingCredit (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
SentToContact	boolean	Optional	Boolean to set whether the credit note in the Xero app should be marked as “sent”. This can be set only on credit notes that have been approved
Status	string	Optional	See Credit Note Status Codes Known values: DRAFT, SUBMITTED, DELETED, AUTHORISED, PAID, VOIDED
StatusAttributeString	string	Optional	A string to indicate if a invoice status
SubTotal	JSON	Optional
SubTotal (anyOf 1)	number	Alternative	The subtotal of the credit note 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	The total of the Credit Note(subtotal + total tax) Format: double
Total (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
TotalTax	JSON	Optional
TotalTax (anyOf 1)	number	Alternative	The total tax on the credit note Format: double
TotalTax (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
Type	string	Optional	See Credit Note Types Known values: ACCPAYCREDIT, ACCRECCREDIT
UpdatedDateUTC	string	Optional	UTC timestamp of last update to the credit note Read only: true
UpdatedDateUTCString	string	Optional	UTC ISO-8601 formatted timestamp of last update to the credit note Read only: true
ValidationErrors	array	Optional	Displays array of validation error messages from the API
ValidationErrors[]	Model	Each item	Expand Retrieves journals — response body — Warnings item
Warnings	array	Optional	Displays array of warning messages from the API
Warnings[]	Model	Each item	Expand Retrieves journals — response body — Warnings item

Referenced models: Deletes an Allocation from a Prepayment — response body — Invoice Currency Code, Deletes an Allocation from a Prepayment — response body, Creates contacts to a specific contact group — response body — Contacts item, Deletes an Allocation from a Prepayment — response body — Invoice Invoice Addresses item, Deletes an Allocation from a Prepayment — response body — Invoice Line Items item, Retrieves payments for invoices and credit notes — response body — Payments item, Retrieves journals — response body — Warnings item

Retrieves journals — response body — Warnings item

Field	Type	Presence	Description and constraints
$	object	Root
Message	string	Optional	Validation error message

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

Policy, approvals and errors

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