Skip to main content
POST
/
invoice
/
{uuid}
/
payment
Create Payment
curl --request POST \
  --url https://api.dev.uselevers.com/api-service/v1/invoice/{uuid}/payment \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount": 123,
  "date": "2023-12-25",
  "reference": "<string>",
  "notes": "<string>",
  "paymentType": "PAYMENT",
  "extPlatformId": "<string>",
  "extInvoiceId": "<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)YesInvoice UUID

Request Body

ParameterTypeRequiredDescription
amountnumberYesPayment amount
datedateYesPayment date (format: YYYY-MM-DD)
referencestringNoPayment reference
notesstringNoPayment notes
paymentTypestringNoType: PAYMENT, CREDIT_MEMO, OTHER_PAYMENT, JOURNAL_ENTRY

Authorizations

Authorization
string
header
required

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

Path Parameters

uuid
required

Body

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

format: 2023-12-31

reference
string
notes
string
paymentType
enum<string>

An enumeration.

Available options:
PAYMENT,
CREDIT_MEMO,
OTHER_PAYMENT,
JOURNAL_ENTRY
extPlatformId
string
extInvoiceId
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