Create a new line item for a debt

post

https://api.ophelos.dev/debts/{debt_id}/line_items

Create a new line item for a debt. The line item will be applied to the debt and the debt balance will be updated.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

debt_id

string

required

ID of the debt

Body Params

Line Item represents a charge or credit applied to a debt. The amount can be positive or negative. The amount is always in the currency of the debt.

The line items that are being charged to the customer, not associated with an invoice.

description

string | null

required

Defaults to Line item description

A description of the line item.

kind

string

enum

required

Defaults to debt

The type of line item that is being charged to the customer.

Show Details

debt	The debt the customer needds to pay.
interest	An interest added to the debt for the customer to pay.
fee	Fee applied the customer needs to pay.
vat	VAT line items for services provided to the customer.
credit	A credit applied to the customer's account. - Should be negative amount
discount	A discount applied to the customer's account. - Should be negative amount
refund	A refund applied to the customer's account.
creditor_refund	A refund applied to the creditor's account.

Allowed:

amount

number

required

The amount of the line item in the currency of the customer.

currency

string

enum

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

transaction_at

date-time

required

The date and time when the line item was created in the system. This field is crucial for tracking the age of the line item and understanding its historical context.

metadata

object

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

Responses

Language

Credentials

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

*/*

201Line Item created successfully.

400Bad Request - The request could not be understood or was missing required parameters.

401Unauthorized - Authentication is needed to get the requested response.

403Forbidden - The client did not have permission to access the requested resource.

404Not Found - The requested resource was not found.

429Rate Limit Exceeded - The rate limit has been exceeded.

500Internal Server Error - An unexpected error occurred on the server.