Skip to main content
POST
Record a manual payment for an invoice

Headers

Version
enum<string>
required

API Version

Available options:
2021-07-28

Path Parameters

invoiceId
string
required

Invoice Id

Example:

"6578278e879ad2646715ba9c"

Body

application/json
altId
string
required

location Id / company Id based on altType

Example:

"6578278e879ad2646715ba9c"

altType
enum<string>
required

Alt Type

Available options:
location
Example:

"location"

mode
enum<string>
required

manual payment method

Available options:
cash,
card,
cheque,
bank_transfer,
other
Example:

"card"

card
object
required
cheque
object
required
notes
string
required

Any note to be recorded with the transaction

Example:

"This was a direct payment"

amount
number

Amount to be paid against the invoice.

Example:

999

meta
object
paymentScheduleIds
string[]

Payment Schedule Ids to be recorded against the invoice.

Example:
fulfilledAt
string

Updated At to be recorded against the invoice.

Example:

"2025-03-19T05:03:00.000Z"

Response

Successful response

success
boolean
required

status

Example:

true

invoice
object
required
Last modified on March 8, 2026