Accounting

Updates a specific batch payment for invoices and credit notes

post/BatchPayments/{BatchPaymentID}

Path parameters

BatchPaymentIDstring uuid required

Unique identifier for BatchPayment

Headers

Idempotency-Keystring

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

Request body

Statusstring required

The status of the batch payment.

Response

Success - return response of type BatchPayments array for updated BatchPayment

Changes

Changed in 6 of the 58 revisions of this API.69

Jul 13, 202657750919b95712See the full diff
- ○
  added the optional property BatchPayments/items/Payments/items/CreditNote/UpdatedDateUTCString to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property BatchPayments/items/Payments/items/Invoice/CreditNotes/items/UpdatedDateUTCString to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property BatchPayments/items/Payments/items/Invoice/Overpayments/items/UpdatedDateUTCString to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property BatchPayments/items/Payments/items/Invoice/Prepayments/items/Allocations/items/CreditNote/UpdatedDateUTCString to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property BatchPayments/items/Payments/items/Invoice/Prepayments/items/Allocations/items/Overpayment/UpdatedDateUTCString to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property BatchPayments/items/Payments/items/Invoice/Prepayments/items/UpdatedDateUTCString to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property BatchPayments/items/Payments/items/Invoice/UpdatedDateUTCString to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property BatchPayments/items/Payments/items/Overpayment/UpdatedDateUTCString to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property BatchPayments/items/Payments/items/Prepayment/Allocations/items/CreditNote/UpdatedDateUTCString to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property BatchPayments/items/Payments/items/Prepayment/Allocations/items/Overpayment/UpdatedDateUTCString to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property BatchPayments/items/Payments/items/Prepayment/UpdatedDateUTCString to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property BatchPayments/items/Payments/items/UpdatedDateUTCString to the response with the 200 status
  response-optional-property-added
Apr 27, 2026204d69534a172See the full diff
- ○
  added the optional property BatchPayments/items/Payments/items/Invoice/Prepayments/items/BrandingThemeID to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property BatchPayments/items/Payments/items/Prepayment/BrandingThemeID to the response with the 200 status
  response-optional-property-added
Mar 26, 2026f96650a7d52e2See the full diff
- ○
  added the optional property BatchPayments/items/Payments/items/Invoice/Prepayments/items/InvoiceNumber to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property BatchPayments/items/Payments/items/Prepayment/InvoiceNumber to the response with the 200 status
  response-optional-property-added
Jan 16, 2026e742d918b2484See the full diff
- ○
  added the optional property BatchPayments/items/Payments/items/Invoice/Overpayments/items/Reference to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property BatchPayments/items/Payments/items/Invoice/Prepayments/items/Allocations/items/Overpayment/Reference to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property BatchPayments/items/Payments/items/Overpayment/Reference to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property BatchPayments/items/Payments/items/Prepayment/Allocations/items/Overpayment/Reference to the response with the 200 status
  response-optional-property-added
Sep 15, 2025ab9dba3c874611See the full diff
- ○
  added the optional property BatchPayments/items/Payments/items/CreditNote/Contact/TaxNumberType to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property BatchPayments/items/Payments/items/Invoice/Contact/TaxNumberType to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property BatchPayments/items/Payments/items/Invoice/CreditNotes/items/Contact/TaxNumberType to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property BatchPayments/items/Payments/items/Invoice/Overpayments/items/Contact/TaxNumberType to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property BatchPayments/items/Payments/items/Invoice/Prepayments/items/Allocations/items/CreditNote/Contact/TaxNumberType to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property BatchPayments/items/Payments/items/Invoice/Prepayments/items/Allocations/items/Overpayment/Contact/TaxNumberType to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property BatchPayments/items/Payments/items/Invoice/Prepayments/items/Contact/TaxNumberType to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property BatchPayments/items/Payments/items/Overpayment/Contact/TaxNumberType to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property BatchPayments/items/Payments/items/Prepayment/Allocations/items/CreditNote/Contact/TaxNumberType to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property BatchPayments/items/Payments/items/Prepayment/Allocations/items/Overpayment/Contact/TaxNumberType to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property BatchPayments/items/Payments/items/Prepayment/Contact/TaxNumberType to the response with the 200 status
  response-optional-property-added
Sep 16, 20243aad5a420f7638See the full diff
- ○
  added the optional property BatchPayments/items/Payments/items/CreditNote/InvoiceAddresses to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property BatchPayments/items/Payments/items/CreditNote/LineItems/items/SalesTaxCodeId to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property BatchPayments/items/Payments/items/CreditNote/LineItems/items/TaxBreakdown to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property BatchPayments/items/Payments/items/CreditNote/LineItems/items/Taxability to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property BatchPayments/items/Payments/items/Invoice/CreditNotes/items/InvoiceAddresses to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property BatchPayments/items/Payments/items/Invoice/CreditNotes/items/LineItems/items/SalesTaxCodeId to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property BatchPayments/items/Payments/items/Invoice/CreditNotes/items/LineItems/items/TaxBreakdown to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property BatchPayments/items/Payments/items/Invoice/CreditNotes/items/LineItems/items/Taxability to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property BatchPayments/items/Payments/items/Invoice/InvoiceAddresses to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property BatchPayments/items/Payments/items/Invoice/LineItems/items/SalesTaxCodeId to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property BatchPayments/items/Payments/items/Invoice/LineItems/items/TaxBreakdown to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property BatchPayments/items/Payments/items/Invoice/LineItems/items/Taxability to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property BatchPayments/items/Payments/items/Invoice/Overpayments/items/LineItems/items/SalesTaxCodeId to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property BatchPayments/items/Payments/items/Invoice/Overpayments/items/LineItems/items/TaxBreakdown to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property BatchPayments/items/Payments/items/Invoice/Overpayments/items/LineItems/items/Taxability to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property BatchPayments/items/Payments/items/Invoice/Prepayments/items/Allocations/items/CreditNote/InvoiceAddresses to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property BatchPayments/items/Payments/items/Invoice/Prepayments/items/Allocations/items/CreditNote/LineItems/items/SalesTaxCodeId to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property BatchPayments/items/Payments/items/Invoice/Prepayments/items/Allocations/items/CreditNote/LineItems/items/TaxBreakdown to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property BatchPayments/items/Payments/items/Invoice/Prepayments/items/Allocations/items/CreditNote/LineItems/items/Taxability to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property BatchPayments/items/Payments/items/Invoice/Prepayments/items/Allocations/items/Overpayment/LineItems/items/SalesTaxCodeId to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property BatchPayments/items/Payments/items/Invoice/Prepayments/items/Allocations/items/Overpayment/LineItems/items/TaxBreakdown to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property BatchPayments/items/Payments/items/Invoice/Prepayments/items/Allocations/items/Overpayment/LineItems/items/Taxability to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property BatchPayments/items/Payments/items/Invoice/Prepayments/items/LineItems/items/SalesTaxCodeId to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property BatchPayments/items/Payments/items/Invoice/Prepayments/items/LineItems/items/TaxBreakdown to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property BatchPayments/items/Payments/items/Invoice/Prepayments/items/LineItems/items/Taxability to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property BatchPayments/items/Payments/items/Overpayment/LineItems/items/SalesTaxCodeId to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property BatchPayments/items/Payments/items/Overpayment/LineItems/items/TaxBreakdown to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property BatchPayments/items/Payments/items/Overpayment/LineItems/items/Taxability to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property BatchPayments/items/Payments/items/Prepayment/Allocations/items/CreditNote/InvoiceAddresses to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property BatchPayments/items/Payments/items/Prepayment/Allocations/items/CreditNote/LineItems/items/SalesTaxCodeId to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property BatchPayments/items/Payments/items/Prepayment/Allocations/items/CreditNote/LineItems/items/TaxBreakdown to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property BatchPayments/items/Payments/items/Prepayment/Allocations/items/CreditNote/LineItems/items/Taxability to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property BatchPayments/items/Payments/items/Prepayment/Allocations/items/Overpayment/LineItems/items/SalesTaxCodeId to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property BatchPayments/items/Payments/items/Prepayment/Allocations/items/Overpayment/LineItems/items/TaxBreakdown to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property BatchPayments/items/Payments/items/Prepayment/Allocations/items/Overpayment/LineItems/items/Taxability to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property BatchPayments/items/Payments/items/Prepayment/LineItems/items/SalesTaxCodeId to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property BatchPayments/items/Payments/items/Prepayment/LineItems/items/TaxBreakdown to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property BatchPayments/items/Payments/items/Prepayment/LineItems/items/Taxability to the response with the 200 status
  response-optional-property-added

Full history