Create a Payment

Records a new payment received against an invoice or outstanding balance.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Supported Apps

AppApp IDRemarks
Xeroxero
Zohobookszohobook
Microsoft Dynamics 365microsoft-dynamics-365pass any unique dummy value in code in metaData.
Sage IntacctsageIntacctpaymentMethod key needs to be passed in metaData for creating payment.
QuickbooksquickbooksPass payType in metaData, allowed values are [CreditCard, Check][CreditCard, Check]
French companies pass PaymentRefNum
NetsuitenetsuiteFor deposited payments pass key "depositedTo" in metaData with corresponding bank account id.
Freshbooksfreshbooks
  • type* key should be passed in metaData Possible values are - [Cash, Check, ACH, Bank Transfer, 2Checkout, Credit Card, Debit, PayPal, AMEX, DINERS, DISCOVER, JCB, MASTERCARD, VISA]
Sage 200 Standardsage200contactId, accountId, amount, paymentLinkedTo, date, exchangeRate are honored fields.
Odoo Accounting OnlineodooaccountId, exchangeRate, linkedInvoices are not honored.
currency expects currencyId as input, which can be obtained using List Currencies.
Body Params
string
required
string
required
double
required
string
required
string
enum
required
Allowed:
date
string
string
string
linkedInvoices
array of objects
required

Required in case of both single and multiple linked invoices

linkedInvoices*
string

JSON formatted key value pair to support additional fields input.

Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json