Accounting

Deletes an Allocation from an overpayment

delete/Overpayments/{OverpaymentID}/Allocations/{AllocationID}

Path parameters

OverpaymentIDstring uuid required

Unique identifier for a Overpayment

AllocationIDstring uuid required

Unique identifier for Allocation object

Response

Success - return response of type Allocation with the isDeleted flag as true

AllocationIDstring uuid

Xero generated unique identifier

Amountnumber double required

the amount being applied to the invoice

Datestring required

the date the allocation is applied YYYY-MM-DD.

IsDeletedboolean

A flag that returns true when the allocation is succesfully deleted

StatusAttributeStringstring

A string to indicate if a invoice status

Changes

Changed in 4 of the 57 revisions of this API.12

Jul 13, 202657750919b9572See the full diff
- ○
  added the optional property CreditNote/UpdatedDateUTCString to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property Overpayment/UpdatedDateUTCString to the response with the 200 status
  response-optional-property-added
Jan 16, 2026e742d918b2481See the full diff
- ○
  added the optional property Overpayment/Reference to the response with the 200 status
  response-optional-property-added
Sep 15, 2025ab9dba3c87462See the full diff
- ○
  added the optional property CreditNote/Contact/TaxNumberType to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property Overpayment/Contact/TaxNumberType to the response with the 200 status
  response-optional-property-added
Sep 16, 20243aad5a420f767See the full diff
- ○
  added the optional property CreditNote/InvoiceAddresses to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property CreditNote/LineItems/items/SalesTaxCodeId to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property CreditNote/LineItems/items/TaxBreakdown to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property CreditNote/LineItems/items/Taxability to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property Overpayment/LineItems/items/SalesTaxCodeId to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property Overpayment/LineItems/items/TaxBreakdown to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property Overpayment/LineItems/items/Taxability to the response with the 200 status
  response-optional-property-added

Full history