XExeroapi
Accounting

Deletes an Allocation from an overpayment

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

Request

  • Base URL
    https://api.xero.com/api.xro/2.0
  • URL
    https://api.xero.com/api.xro/2.0/Overpayments/{OverpaymentID}/Allocations/{AllocationID}
  • Auth
    OAuth 2
    Authorization code: https://login.xero.com/identity/connect/authorize
    Token URL: https://identity.xero.com/connect/token scopes: accounting.transactions

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

  • de95a0883a4aRevision changes
    • info

      the response optional property / became not read-only for the status

  • 57750919b957Revision changes
    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status