Skip to main content
PATCH
/
v1
/
admin
/
distribution
/
settlement-runs
/
{id}
Update a settlement run
curl --request PATCH \
  --url https://{operatorDomain}/v1/admin/distribution/settlement-runs/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "channelId": "<string>",
  "contractId": "<string>",
  "status": "<string>",
  "currencyCode": "<string>",
  "periodStart": "2023-12-25",
  "periodEnd": "2023-12-25",
  "statementReference": "<string>",
  "generatedAt": "2023-11-07T05:31:56Z",
  "postedAt": "2023-11-07T05:31:56Z",
  "paidAt": "2023-11-07T05:31:56Z",
  "notes": "<string>",
  "metadata": {}
}
'
{
  "data": {}
}

Authorizations

Authorization
string
header
required

Staff session or API token issued by your Voyant app.

Path Parameters

id
string
required

Body

application/json
channelId
string
required
contractId
string
status
string
currencyCode
string
periodStart
string<date>
periodEnd
string<date>
statementReference
string
generatedAt
string<date-time>
postedAt
string<date-time>
paidAt
string<date-time>
notes
string
metadata
object

Response

200 - application/json

Updated settlement run

data
object