Accounting

Allows you to create an Allocation for prepayments

put/Prepayments/{PrepaymentID}/Allocations

Path parameters

PrepaymentIDstring uuid required

Unique identifier for a PrePayment

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 of Allocation for all Prepayment

Changes

Changed in 4 of the 58 revisions of this API.22

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

Full history