Raise a dispute against a statement
curl --request POST \
--url https://api.royalti.io/statements/users/{tenantUserId}/{periodStart}/{periodEnd}/disputes \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"category": "<string>",
"contestedAmount": 123,
"description": "<string>",
"referenceLine": "<string>"
}
'import requests
url = "https://api.royalti.io/statements/users/{tenantUserId}/{periodStart}/{periodEnd}/disputes"
payload = {
"category": "<string>",
"contestedAmount": 123,
"description": "<string>",
"referenceLine": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
category: '<string>',
contestedAmount: 123,
description: '<string>',
referenceLine: '<string>'
})
};
fetch('https://api.royalti.io/statements/users/{tenantUserId}/{periodStart}/{periodEnd}/disputes', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.royalti.io/statements/users/{tenantUserId}/{periodStart}/{periodEnd}/disputes",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'category' => '<string>',
'contestedAmount' => 123,
'description' => '<string>',
'referenceLine' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.royalti.io/statements/users/{tenantUserId}/{periodStart}/{periodEnd}/disputes"
payload := strings.NewReader("{\n \"category\": \"<string>\",\n \"contestedAmount\": 123,\n \"description\": \"<string>\",\n \"referenceLine\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.royalti.io/statements/users/{tenantUserId}/{periodStart}/{periodEnd}/disputes")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"category\": \"<string>\",\n \"contestedAmount\": 123,\n \"description\": \"<string>\",\n \"referenceLine\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.royalti.io/statements/users/{tenantUserId}/{periodStart}/{periodEnd}/disputes")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"category\": \"<string>\",\n \"contestedAmount\": 123,\n \"description\": \"<string>\",\n \"referenceLine\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"status": "success",
"message": "<string>",
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"TenantUserId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"periodStart": "2023-11-07T05:31:56Z",
"periodEnd": "2023-11-07T05:31:56Z",
"periodGrain": "monthly",
"status": "draft",
"closedReason": "paid_full",
"flags": {
"onHold": true,
"disputed": true
},
"gross": "<string>",
"net": "<string>",
"paidAmount": "<string>",
"priorBalance": "<string>",
"reportingCurrency": "USD",
"frozenAt": "2023-11-07T05:31:56Z",
"lastCalculatedAt": "2023-11-07T05:31:56Z",
"readFrom": "table",
"ok": true
}
}{
"status": "error",
"message": "Unauthorized"
}{
"status": "error",
"message": "Resource not found"
}Statements
Raise a dispute against a statement
Raise dispute
POST
/
statements
/
users
/
{tenantUserId}
/
{periodStart}
/
{periodEnd}
/
disputes
Raise a dispute against a statement
curl --request POST \
--url https://api.royalti.io/statements/users/{tenantUserId}/{periodStart}/{periodEnd}/disputes \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"category": "<string>",
"contestedAmount": 123,
"description": "<string>",
"referenceLine": "<string>"
}
'import requests
url = "https://api.royalti.io/statements/users/{tenantUserId}/{periodStart}/{periodEnd}/disputes"
payload = {
"category": "<string>",
"contestedAmount": 123,
"description": "<string>",
"referenceLine": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
category: '<string>',
contestedAmount: 123,
description: '<string>',
referenceLine: '<string>'
})
};
fetch('https://api.royalti.io/statements/users/{tenantUserId}/{periodStart}/{periodEnd}/disputes', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.royalti.io/statements/users/{tenantUserId}/{periodStart}/{periodEnd}/disputes",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'category' => '<string>',
'contestedAmount' => 123,
'description' => '<string>',
'referenceLine' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.royalti.io/statements/users/{tenantUserId}/{periodStart}/{periodEnd}/disputes"
payload := strings.NewReader("{\n \"category\": \"<string>\",\n \"contestedAmount\": 123,\n \"description\": \"<string>\",\n \"referenceLine\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.royalti.io/statements/users/{tenantUserId}/{periodStart}/{periodEnd}/disputes")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"category\": \"<string>\",\n \"contestedAmount\": 123,\n \"description\": \"<string>\",\n \"referenceLine\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.royalti.io/statements/users/{tenantUserId}/{periodStart}/{periodEnd}/disputes")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"category\": \"<string>\",\n \"contestedAmount\": 123,\n \"description\": \"<string>\",\n \"referenceLine\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"status": "success",
"message": "<string>",
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"TenantUserId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"periodStart": "2023-11-07T05:31:56Z",
"periodEnd": "2023-11-07T05:31:56Z",
"periodGrain": "monthly",
"status": "draft",
"closedReason": "paid_full",
"flags": {
"onHold": true,
"disputed": true
},
"gross": "<string>",
"net": "<string>",
"paidAmount": "<string>",
"priorBalance": "<string>",
"reportingCurrency": "USD",
"frozenAt": "2023-11-07T05:31:56Z",
"lastCalculatedAt": "2023-11-07T05:31:56Z",
"readFrom": "table",
"ok": true
}
}{
"status": "error",
"message": "Unauthorized"
}{
"status": "error",
"message": "Resource not found"
}Description
Raise dispute Raises a dispute against the active Statement for(tenantUserId, periodStart..periodEnd). Requires the statement to
be finalized or closed. Unlike the other lifecycle mutations,
this is self-or-admin rather than admin-only: a member may dispute
their own statement, admins may dispute any.
Authorization:
- Required role:
useror higher
Code Examples
const response = await fetch('https://api.royalti.io/statements/users/example-id/example-id/example-id/disputes', {
method: 'POST',
headers: {
'Content-Type': 'application/json'
},
body: JSON.stringify({
"category": "sample-category",
"contestedAmount": 1,
"referenceLine": "sample-referenceLine",
"description": "sample-description"
})
});
const data = await response.json();
console.log(data);
import requests
response = requests.post(
'https://api.royalti.io/statements/users/example-id/example-id/example-id/disputes',
json={"category":"sample-category","contestedAmount":1,"referenceLine":"sample-referenceLine","description":"sample-description"}
)
data = response.json()
print(data)
curl -X POST https://api.royalti.io/statements/users/example-id/example-id/example-id/disputes \
-H "Content-Type: application/json" \
-d '{"category":"sample-category","contestedAmount":1,"referenceLine":"sample-referenceLine","description":"sample-description"}'
Authorizations
JWT Authorization header using the Bearer scheme. Format: "Bearer {token}"
Path Parameters
Body
application/json
Response
Dispute raised.
Every statements response wraps the payload in { status, message, data }.
data carries the per-endpoint payload PLUS the per-tenant feature flag.
Available options:
success, error Response payload shared by the ITEM 2 lifecycle mutations (finalize,
payments, adjustments, hold, resume, void, disputes): the updated
Statement row, shaped via the same shapeForClient mapper as
StatementRosterRow, plus ok: true. The underlying Sequelize row
carries additional endpoint-specific detail (e.g. statusHistory)
not exhaustively modeled here — treat this as the roster-row core.
Show child attributes
Show child attributes