API Reference
  1. Ophelos API
  2. Invoice Management

Create a new invoice for a debt

post
https://api.ophelos.dev/debts//invoices

Create a new invoice for a given debt. Line items will increase the outstanding amount the customer is required to pay.

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

ID of the debt

Query Params
expand[]
array of strings

Specify fields to expand in the response.

Supported values: line_items

expand[]
Allowed:
Body Params

The invoice that the debt is associated with.

The invoices that the debt is associated with.

string | null

The description of the invoice.

string
enum
Defaults to issued

The status of the invoice.

Allowed:
date

Must be on or after 1980-01-01.

date

The date when the invoice was issued.

string | null

The reference of the invoice.

line_items
array of objects
length between 1 and 25

The line items that are being charged to the customer.

line_items
metadata
object

A set of key-value pairs that you can attach to a invoice 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?