This API inserts the details of a custom payment (which has been collected by using a third-party software) for an invoice into Zenoti.
For example, an organization uses a third-party software to collect guests' payment for an invoice. You can then use this API to insert the collected custom payment from that third-party software into Zenoti. Note: To integrate the required custom payment in your account, you must reach out to your respective Zenoti representative.
This custom payment information for an invoice enables you to display the relevant details in your Zenoti UI, and map it to the respective fields in Reports and Analytics.
You must specify appropriate data for the invoice_id parameter.
Request Body Details
Name
Type
Description
amount
decimal
Total amount of the invoice, including the tip amount.
tip_amount
decimal
Tip amount included in the invoice.
cash_register_id
guid
Unique 32-character ID of the cash register to which the custom invoice payment amount was added.
custom_payment_id
guid
Unique 32-character ID of the custom invoice payment.
additional_data
string
Any additional information on the custom invoice payment.
collected_by_id
guid
Unique 32-character ID of the employee who collected the payment.
Response Details
Name
Type
Description
transaction
object
Object that contains details about various transaction-related elements. For more information, refer to the transaction table below.
error
object
Object that contains error message and error code details. For more information, refer to the error table below.
transaction
Name
Type
Description
payment_option
object
Object that contains details about various payment option-related elements. For more information, refer to the payment_option table below.
total_amount_paid
decimal
Total amount paid by the guest, including the tip amount.
amount_paid
decimal
Amount paid by the guest for the invoice, excluding the tip amount.
tip_amount
decimal
Tip amount paid by the guest.
ssg_amount
decimal
The service charge amount paid by the guest.
fee_amount
decimal
The environment fee amount paid by the guest.
cash_back_amount
decimal
The amount received by the guest as cashback for making the custom payment.
transaction_id
guid
Unique 32-character ID of the guest's transaction.
payment_date
datetime
Date and time on which the guest made the custom invoice payment.
cash_regester_id
guid
Unique 32-character ID of the cash register to which the custom invoice payment amount was added.
payment_option
Name
Type
Description
id
guid
Unique 32-character ID of the payment option used by the guest to make the custom payment.
