Skip to main content
GET
/
v1
/
crm
/
residuals
/
{residualId}
/
overrides
/
{overrideId}
Get a Residual Override
curl --request GET \
  --url https://api.example.com/v1/crm/residuals/{residualId}/overrides/{overrideId} \
  --header 'Authorization: Bearer <token>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "period": "<string>",
  "description": "<string>",
  "amount": 123,
  "isoResidualId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Authorizations

​
Authorization
string
header
required

Enter token in following format: Bearer

Path Parameters

​
residualId
string
required
​
overrideId
string
required

Response

The residual override record.

​
id
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
​
period
string | null
required
​
description
string | null
required
​
amount
number | null
required
​
isoResidualId
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$