Update a specific invoice

put

https://api.ophelos.dev/debts/{debt_id}/invoices/{id}

Update a specific invoice for a given debt based on its unique identifier. This operation allows you to update the details of a specific invoice and add line items to the invoice.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

debt_id

string

required

ID of the debt

string

required

ID of the invoice

Query Params

expand[]

array of strings

Specify fields to expand in the response.

expand[]

Allowed:

Body Params

Invoice to update

The invoices that the debt is associated with.

description

string | null

The description of the invoice.

status

string

enum

Defaults to issued

The status of the invoice.

Allowed:

due_on

date

Must be on or after 1980-01-01.

invoiced_on

date

The date when the invoice was issued.

reference

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

200Debt updated 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.