Partner Settlement Report / Partner Settlement Record / Delete

delete

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

Delete a single Partner Settlement Record.

A 409 with errorCode payment_tracking_managed_via_partner_invoice is returned once the settlement report has at least one partner invoice. Deleting would silently move the invoice's computed amountPaid, so corrections are made by registering a reversing payment with a negative paidAmount through POST actions/partner-invoice/v1.0/{partnerInvoice}/register-payment instead.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Responses

204

Success

Language

Credentials

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

401Access token is missing or invalid

403You do not have permission to perform the action

404The record is not found

409The settlement record could not be written because the settlement report has at least one partner invoice. Payments for such a report are tracked by registering them on its partner invoices.

422The payload you provided is invalid

429Too many requests. Please try again later. For more information, please check the rate limit headers X-RateLimit-*