Skip to main content
GET
/
invoice
/
{uuid}
Get Invoice Details
curl --request GET \
  --url https://api.dev.uselevers.com/api-service/v1/invoice/{uuid} \
  --header 'Authorization: Bearer <token>'
{
  "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",
  "history": [
    {
      "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "type": "CREATED",
      "user": {
        "firstName": "<string>",
        "lastName": "<string>"
      },
      "createdAt": "2023-11-07T05:31:56Z",
      "data": {},
      "emailTracking": [
        {
          "openedAt": "2023-11-07T05:31:56Z"
        }
      ]
    }
  ],
  "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>",
  "customerRisk": "LOW",
  "daysUntilDue": 123,
  "payment": [
    {
      "amount": 123,
      "date": "2023-12-25",
      "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "reference": "<string>",
      "notes": "<string>",
      "paymentType": "PAYMENT",
      "extPlatformId": "<string>",
      "extInvoiceId": "<string>"
    }
  ]
}

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.

Path Parameters

ParameterTypeRequiredDescription
uuidstring (UUID)YesInvoice UUID

Response

Returns detailed invoice information including:
  • Basic Info: Invoice number, dates, amounts, status
  • Contact: Linked contact details
  • Payments: Array of payment records
  • History: Audit trail of all changes
  • Risk: Risk level and assessment
  • Attachments: Whether files are attached
  • Custom Fields: Any custom fields defined

Authorizations

Authorization
string
header
required

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

Path Parameters

uuid
required

Response

Successful Response

number
string
required
Required string length: 1 - 255
date
string<date>
required

format: 2023-12-31

dueDate
string<date>
required

format: 2023-12-31

total
number
required
uuid
string<uuid>
required
status
enum<string>
required

An enumeration.

Available options:
UNPAID,
PAID
contact
GetContactRespShort · object
required
createdAt
string<date>
required
history
InvoiceHistoryResp · object[]
required
reference
string
notes
string
description
string
totalPaid
number
outstandingAmount
number
remindersEnabled
boolean
default:true
purchaseOrder
string
paidDate
string<date>
preDueEmails
integer
postDueEmails
integer
level
enum<string>

An enumeration.

Available options:
UPCOMING,
DUE,
OVER-DUE,
PAID
risk
enum<string>

An enumeration.

Available options:
LOW,
MEDIUM,
HIGH
attachment
boolean
paymentInstructions
GetApplicationBankResp · object
currencyCode
string
customFields
any[]
extPlatformId
string
customerRisk
enum<string>

An enumeration.

Available options:
LOW,
MEDIUM,
HIGH
daysUntilDue
integer
payment
CreatePaymentRespApiService · object[]