> For the complete documentation index, see [llms.txt](https://dev.simplepay.ai/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://dev.simplepay.ai/docs/api-documentation/invoices.md).

# Invoices

## Parameters

### Invoice ID

Id is unique identifier that represents Invoice object for quering details of specific invoice

<figure><img src="/files/e07O0FkAJ35tGlT7NFfP" alt=""><figcaption></figcaption></figure>

### Parent ID

Parent id points to relative invoice that was parent in the chain of invoices. Sometimes we need to make several tranches, thats how we can bind several invoices into chain.

### Client ID

Client id is a identifier of your customer. Its represents a unique UUID v4 that pointers to specific user or customer to whom you direct your invoice. If you have account managment system, you may input user's id in your DB as client\_id to easy bind your user's payments separate from others.

### Total

Amount of funds needed to complete invoice. It's depends on choosen currency in invoice body while creating, to calculate current rates and amount that left to pay.

### Paid

Represents amount of funds to current invoice currency that was already submited as paid in one or several transactions.

### Type

Type of invoice. For now we support "payment" only.

### Status

Status of the invoice represents it's current stage. It may be ACTIVE / SUCCESS / CANCELED.

{% hint style="info" %}
You cannot cancel invoices with SUCCESS statuses.
{% endhint %}

### Created At

Represents timestamp when invoice was created.

### Updated At

Represents timestamp of new transactions appears in the Invoice or invoice status changes.

### Products

See products API section

### Payload

See payload section

## API Refference

{% openapi src="/files/SApvG9srFf5MWD8SciPZ" path="/invoice" method="get" %}
[SimplePay.yaml](https://3504918617-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FXps6Hpvtcnwm326Ywnfb%2Fuploads%2FfAXmAgXli38kPFOqQ60E%2FSimplePay.yaml?alt=media\&token=7bfaa000-cd9e-49a9-bac1-c1d28cf444f8)
{% endopenapi %}

{% openapi src="/files/SApvG9srFf5MWD8SciPZ" path="/invoice" method="post" %}
[SimplePay.yaml](https://3504918617-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FXps6Hpvtcnwm326Ywnfb%2Fuploads%2FfAXmAgXli38kPFOqQ60E%2FSimplePay.yaml?alt=media\&token=7bfaa000-cd9e-49a9-bac1-c1d28cf444f8)
{% endopenapi %}

{% openapi src="/files/SApvG9srFf5MWD8SciPZ" path="/invoice/{id}" method="get" %}
[SimplePay.yaml](https://3504918617-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FXps6Hpvtcnwm326Ywnfb%2Fuploads%2FfAXmAgXli38kPFOqQ60E%2FSimplePay.yaml?alt=media\&token=7bfaa000-cd9e-49a9-bac1-c1d28cf444f8)
{% endopenapi %}

{% openapi src="/files/SApvG9srFf5MWD8SciPZ" path="/invoice/{id}" method="delete" %}
[SimplePay.yaml](https://3504918617-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FXps6Hpvtcnwm326Ywnfb%2Fuploads%2FfAXmAgXli38kPFOqQ60E%2FSimplePay.yaml?alt=media\&token=7bfaa000-cd9e-49a9-bac1-c1d28cf444f8)
{% endopenapi %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://dev.simplepay.ai/docs/api-documentation/invoices.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
