Skip to main content
GET
/
invoice
Get Invoices
curl --request GET \
  --url https://api.dev.uselevers.com/api-service/v1/invoice \
  --header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "number": "<string>",
      "date": "2023-12-25",
      "dueDate": "2023-12-25",
      "total": 123,
      "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "status": "UNPAID",
      "contact": {
        "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "firstName": "<string>",
        "lastName": "<string>",
        "phoneNumber": "<string>",
        "email": "<string>"
      },
      "createdAt": "2023-12-25",
      "reference": "<string>",
      "notes": "<string>",
      "description": "<string>",
      "totalPaid": 123,
      "outstandingAmount": 123,
      "remindersEnabled": true,
      "purchaseOrder": "<string>",
      "paidDate": "2023-12-25",
      "preDueEmails": 123,
      "postDueEmails": 123,
      "level": "UPCOMING",
      "risk": "LOW",
      "attachment": true,
      "paymentInstructions": {
        "bankName": "<string>",
        "iban": "<string>",
        "accountNumber": "<string>",
        "bankCompanyName": "<string>"
      },
      "currencyCode": "<string>",
      "customFields": [
        "<unknown>"
      ],
      "extPlatformId": "<string>"
    }
  ],
  "total": 1,
  "page": 2,
  "size": 2,
  "pages": 1
}

​
Authorization

All endpoints require Bearer token authentication.
HeaderTypeRequiredDescription
AuthorizationstringYesBearer authentication header of the form Bearer <token>

​
Getting Your API Key

See the Quickstart guide for instructions on obtaining your API credentials.

​
Query Parameters

ParameterTypeRequiredDescription
pageintegerNoPage number (default: 1, min: 1)
sizeintegerNoItems per page (default: 50, min: 1, max: 100)
invoice-uuidstring (UUID)NoFilter by invoice UUID
contact-uuidstring (UUID)NoFilter by contact UUID
numberstringNoFilter by invoice number
date-fromdateNoFilter by invoice date from
date-todateNoFilter by invoice date to
due-date-fromdateNoFilter by due date from
due-date-todateNoFilter by due date to
amount-fromnumberNoFilter by minimum amount
amount-tonumberNoFilter by maximum amount
riskstringNoFilter by risk type (LOW, MEDIUM, HIGH)
paid_statusstringNoFilter by paid status (UNPAID, PAID, PARTIALLY_PAID)

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
invoice-uuid
​
contact-uuid
​
number
string
​
date-from
string<date>
​
date-to
string<date>
​
due-date-from
string<date>
​
due-date-to
string<date>
​
amount-from
number
​
amount-to
number
​
risk
enum<string>

An enumeration.

Available options:
LOW,
MEDIUM,
HIGH
​
paid_status
enum<string>

An enumeration.

Available options:
UNPAID,
PAID,
PARTIALLY_PAID
​
created-at-from
string<date>
​
created-at-to
string<date>
​
page
integer
default:1
Required range: x >= 1
​
size
integer
default:50
Required range: 1 <= x <= 100

Response

Successful Response

​
items
GetInvoiceResp · object[]
required
​
total
integer
Required range: x >= 0
​
page
integer
Required range: x >= 1
​
size
integer
Required range: x >= 1
​
pages
integer
Required range: x >= 0