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

Request Body

ParameterTypeRequiredDescription
uuidstring (UUID)YesInvoice UUID to update
numberstringNoInvoice number
datedateNoInvoice date
dueDatedateNoDue date
totalnumberNoTotal amount (min: 0)
contactUuidstring (UUID)NoContact UUID
referencestringNoReference number
notesstringNoNotes
descriptionstringNoDescription
remindersEnabledbooleanNoEnable reminders
purchaseOrderstringNoPurchase order
customFieldsarrayNoCustom fields
extPlatformIdstringNoExternal platform ID

Authorizations

Authorization
string
header
required

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

Body

application/json
uuid
number
string
Required string length: 1 - 255
reference
string
Required string length: 1 - 255
notes
string
Required string length: 1 - 255
description
string
Required string length: 1 - 255
date
string<date>

format: 2023-12-31

dueDate
string<date>

format: 2023-12-31

total
number
contactUuid
remindersEnabled
boolean
purchaseOrder
string
customFields
any[]
extPlatformId
string

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