HomeGuidesAPI ReferenceChangelog
Terms of Use
API Reference

Partner Settlement Report / Partner Settlement Record / Update

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 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.

string
enum

Direction of the payment between the operator and the partner. Required when creating a record for an operator that pays partners on collected revenue only (as recorded when the report was generated); a create without it returns 422. Optional for other operators; when omitted on update the stored direction is kept. Omitted in responses when the record has no direction.

Allowed values:

  • received - Received from the partner.
  • paid - Paid to the partner.

For an operator that pays partners on collected revenue only, a directed record counts toward that direction's total and the payment status of the settlement report, and a record that would take the direction's total below zero is refused with a 409.

Allowed:
Responses

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