HomeGuidesAPI ReferenceChangelog
Terms of Use
API Reference
Terms of Use

Partner Settlement Report / Partner Settlement Record / Update

put deprecated
https://{tenantUrl}/public-api/resources/partner-settlement-reports/v1.0//records/

This endpoint is deprecated. Use the v1.1 equivalent instead.

Update a single Partner Settlement Record.

Covers payment records only. A settlement record created when a partial credit note is issued against a partner invoice returns 404, although that invoice's amountPaid counts it.

A 409 with errorCode payment_tracking_managed_via_partner_invoice is returned once the settlement report has at least one partner invoice. Records linked to an invoice are immutable history — correct a wrong entry by registering a reversing payment with a negative paidAmount through POST actions/partner-invoice/v1.0/{partnerInvoice}/register-payment.

A 409 with errorCode records_immutable_for_collected_revenue_only_operator is returned when the settlement report's operator pays partners on collected revenue only: its settlement records cannot be changed. Correct a wrong entry by creating a record with a negative paidAmount instead.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required
integer
required
Body Params
date
required

Date the payment was made.

number
required

Amount recorded as paid, in the settlement report's currency. Negative values record a reversing entry.

string
required

Free-text note on the settlement record.

Responses

Updated 5 months ago

Did this page help you?
Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 5 months ago

Did this page help you?