Skip to main content
GET
/
v1
/
invoices
List invoices
curl --request GET \
  --url https://api.useaira.com/v1/invoices/ \
  --header 'X-API-KEY: <api-key>'
{
  "items": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "customer": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "externalId": "<string>"
      },
      "billingAccount": {
        "businessName": "<string>",
        "taxId": "<string>",
        "taxIdType": "cnpj"
      },
      "invoiceNumber": "<string>",
      "invoiceDate": "2023-12-25",
      "dueDate": "2023-12-25",
      "totalAmount": 123,
      "status": "open"
    }
  ],
  "hasMore": true
}

Authorizations

​
X-API-KEY
string
header
required

API Key Authentication.

Query Parameters

​
search
string
​
customerIds[]
string<uuid>[]
​
status[]
enum<string>[]
Available options:
open,
in_review,
issued,
synced,
pending,
paid,
overdue,
canceled,
failed
​
invoiceDate.gte
string<date>
​
invoiceDate.lte
string<date>
​
offset
number
default:0
Required range: x >= 0
​
limit
number
default:100
required
Required range: 1 <= x <= 100

Response

200 - application/json

Default Response

​
items
object[]
required

A list of items.

​
hasMore
boolean
required

Indicates if there are more items to fetch.