iVvy Developer API
Home
Support
System Status
Login
Search…
API Documentation
Getting Started
Contacts & Companies
Event
Venue
Partner
Invoice
Get Invoice List
Get Invoice
Get Options
Add Payment
Account
CRM
Development Reference
Powered By
GitBook
Add Payment
post
[PlatformAddress]/api/1.0
/invoice?action=AddPayment
Add Payment
Example Request
1
Example: Add Payment to an invoice
Copied!
1
{
2
"invoiceId": "156",
3
"paidDate": "2018-07-24 00:00:00",
4
"amountPaid": 10,
5
"paymentMethod": 8,
6
"receiptNum": "123",
7
"feePercentage": 10
8
}
Copied!
paymentMethod
0 = Unknown 1 = Credit Card 2 = BPay 3 = Direct Deposit 4 = PayPal 5 = Cheque 6 = Cash 8 = Accounts Receivable 9 = EFTPOS 10 = WriteOff 11 = Point of Sale 12 = Wire Transfer 13 = Custom
cardType
0 = Unknown 1 = Visa 2 = Master Card 3 = Amex 4 = Diners
Returns
Property
Description
success
Whether or not the payment was added to the invoice
id
The unique identifier of the payment
Throws
Code
Description
24235
The request is empty
24236
Invalid payment method
24237
Cannot use "gateway" or "paymentId" to make the invoice payment
24238
Unable to find invoice
24239
The payment details are invalid
24240
An unknown error has occurred
Previous
Get Options
Next
Account
Last modified
8mo ago
Copy link
Contents
post
Add Payment
Example Request
paymentMethod
cardType
Returns
Throws