API Reference
  1. Ophelos API
  2. Debt Management

Update a specific debt

put
https://api.ophelos.dev/debts/

Update a specific debt based on its unique identifier. This operation allows you to update the details of a specific debt.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

ID of the debt

Body Params

Debt to update

Accept nested customer and organisation objects.

string
length between 1 and 255
^org_[a-zA-Z0-9]+$

The unique identifier of the organisation that the debt is associated with.

organisation
required
string
length between 1 and 255
^cus_[a-zA-Z0-9]+$

The unique identifier of an existing customer that will be associated with the debt.

string
length between 1 and 255
^com_[a-zA-Z0-9]+$

The unique identifier of the company that the debt is associated with.

customer
required

The customer object represents a customer in the system. It contains information about the customer, such as their name, date of birth, and contact details.

Note: The full_name field is required if first_name is not provided. The first_name field is required if full_name is not provided.

string
length between 1 and 255
^ori_[a-zA-Z0-9]+$

The unique identifier of the originator that the debt is associated with.

originator
object
string
required
length between 1 and 255

The unique customer facing account number the customer will use to associate with the account.

string
enum
Defaults to managed

The type of debt that is being created.

Allowed:
string
enum
length between 3 and 3
^[A-Z]{3,3}$
Defaults to GBP

The currency in which the debt is denominated. Currency information is critical for financial reporting, risk assessment, and ensuring appropriate handling in multinational operations.

tags
array of strings

A list of tags that can be used to categorize and filter debts. Note this is distructive and will replace all existing tags.

tags
configurations
object

Optional configurations that define the behaviour of the debt case. When provided during creation, these configurations override the defaults defined in the parent organisation, tenant, and market.

metadata
object

A set of key-value pairs that you can attach to a debt object. It can be useful for storing additional information about the debt in a structured format.

Responses

Updated 2 months ago

Did this page help you?
Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
*/*

Updated 2 months ago

Did this page help you?