InvoiceVersion: v3

Record a manual payment for an invoice

POST/invoices/{invoiceId}/record-payment

API to record manual payment for an invoice by invoice id

Authorizations

Authorizationstringheaderrequired

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

Scope:invoices.write

Auth methods:OAuthPrivate Integration

Token types:Sub-Account TokenAgency Token

Request

Headers

Versionstringrequired

API Version

Available optionsv3

Path Parameters

invoiceIdstringrequired

Invoice Id

Example:6578278e879ad2646715ba9c

Body

application/json

altIdstringrequired

location Id / company Id based on altType

Example:6578278e879ad2646715ba9c

altTypestringrequired

Alt Type

Available optionslocation

Example:location

modestringrequired

manual payment method

Available optionscashcardchequebank_transferother

Example:card

cardobjectrequired

chequeobjectrequired

notesstringrequired

Any note to be recorded with the transaction

Example:This was a direct payment

amountnumber

Amount to be paid against the invoice.

Example:999

metaobject

paymentScheduleIdsstring[]

Payment Schedule Ids to be recorded against the invoice.

Example:["6578278e879ad2646715ba9c"]

fulfilledAtstring

Updated At to be recorded against the invoice.

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

Response

application/json

Successful response

successbooleanrequired

status

Example:true

invoiceobjectrequired