Skip to main content
PUT
/
invoice
/
payment
/
{uuid}
Update Payment
curl --request PUT \
  --url https://api.dev.uselevers.com/api-service/v1/invoice/payment/{uuid} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount": 123,
  "date": "2023-12-25",
  "reference": "<string>",
  "notes": "<string>"
}
'
{
  "amount": 123,
  "date": "2023-12-25",
  "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "reference": "<string>",
  "notes": "<string>",
  "onlinePaymentId": 123,
  "paymentType": "PAYMENT"
}

​
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)YesPayment UUID

​
Request Body

ParameterTypeRequiredDescription
amountnumberNoPayment amount
datedateNoPayment date
referencestringNoPayment reference
notesstringNoPayment notes

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
uuid
string<uuid>
required

Body

application/json
​
amount
number
​
date
string<date>

format: 2023-12-31

​
reference
string
​
notes
string

Response

Successful Response

​
amount
number
required
​
date
string<date>
required

format: 2023-12-31

​
uuid
string<uuid>
required
​
reference
string
​
notes
string
​
onlinePaymentId
integer
​
paymentType
enum<string>

An enumeration.

Available options:
PAYMENT,
CREDIT_MEMO,
OTHER_PAYMENT,
JOURNAL_ENTRY