Skip to main content
POST
/
invoice
/
create-update
Create Update Invoice
curl --request POST \
  --url https://api.dev.uselevers.com/api-service/v1/invoice/create-update \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "number": "<string>",
  "date": "2023-12-25",
  "dueDate": "2023-12-25",
  "total": 123,
  "contactUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "reference": "<string>",
  "notes": "<string>",
  "description": "<string>",
  "remindersEnabled": true,
  "purchaseOrder": "<string>",
  "customFields": [
    "<unknown>"
  ],
  "extPlatformId": "<string>",
  "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "outstandingAmount": 123
}
'
{
  "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>"
}

​
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.

​
Use Cases

  • Integration Sync: Ideal for syncing from external systems where you don’t know if an invoice exists
  • Idempotent Operations: Safe to call multiple times with the same data
  • Simplified Workflows: One endpoint handles both create and update

​
Request Body

ParameterTypeRequiredDescription
uuidstring (UUID)NoInvoice UUID (required for updates)
numberstringYesInvoice number
datedateYesInvoice date
dueDatedateYesDue date
totalnumberYesTotal amount
contactUuidstring (UUID)YesContact UUID
outstandingAmountnumberYesOutstanding amount
All other fields from Create/UpdateNo

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
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
​
contactUuid
required
​
reference
string
​
notes
string
​
description
string
​
remindersEnabled
boolean
default:true
​
purchaseOrder
string
​
customFields
any[]
​
extPlatformId
string
​
uuid
​
outstandingAmount
number

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
​
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