XExeroapi
Accounting

Creates allocation for a specific credit note

Changed on
put/CreditNotes/{CreditNoteID}/Allocations

Request

  • Base URL
    https://api.xero.com/api.xro/2.0
  • URL
    https://api.xero.com/api.xro/2.0/CreditNotes/{CreditNoteID}/Allocations
  • 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

CreditNoteIDstring uuid required

Unique identifier for a Credit Note

Query parameters

summarizeErrorsboolean

If false return 200 OK and mix of successfully created objects and any with validation errors

Headers

Idempotency-Keystring

This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Request body

Response

Success - return response of type Allocations array with newly created Allocation for specific Credit Note

Changes

  • de95a0883a4aRevision changes
    • info

      the request optional property /// became not read-only

    • 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