About RecordARPayment
Payment records are automatically created for payments made through Bill.com. This API creates an Accounts Receivable (AR) payment record to account for payments received outside of Bill.com
Received funds can be applied to specific invoice(s) or unapplied.
Example
In the nested invoicePays array, the invoiceId and amount are required parameters.
Request
<API_URL_EndPoint>/RecordARPayment.json
data={
"customerId" : "0cu01SJNFOKKIFSMC50w",
"paymentDate" : "2016-11-28",
"paymentType" : "0",
"amount" : 75.30,
"depositToAccountId" : "0ca01LSSKQOBGAXS2ydl",
"description" : "Check received",
"refNumber" : "735",
"invoicePays" : [ {
"invoiceId" : "00e01OQYKIJEMXHObzdd",
"amount" : 56.50
} ]
}Response
{
"response_status" : 0,
"response_message" : "Success",
"response_data" : {
"entity" : "ReceivedPay",
"id" : "0rp01NJKZJHDFTSZ9n3x",
"createdTime" : "2016-11-28T05:11:38.644+0000",
"updatedTime" : "2016-11-28T05:11:38.914+0000",
"customerId" : "0cu01SJNFOKKIFSMC50w",
"status" : "0",
"paymentDate" : "2016-11-28",
"depositToAccountId" : "0ca01LSSKQOBGAXS2ydl",
"isOnline" : false,
"paymentType" : "0",
"amount" : 75.30,
"description" : "Check received",
"refNumber" : "735",
"convFeeAmount" : 0.00,
"payToBankAccountId" : "bac01VUMZHGMDPMOU8l0",
"rPConvFee" : [ {
} ],
"invoicePays" : [ {
"entity" : "InvoicePay",
"id" : "0ip01LFLKWUTTMAN4n8p",
"invoiceId" : "00e01OQYKIJEMXHObzdd",
"amount" : 56.50,
"createdTime" : "2016-11-28T05:11:45.000+0000",
"updatedTime" : "2016-11-28T05:11:45.000+0000"
} ]
}
}Resources
Parameters
Request parameters
| Field Name | Description | Required? |
|---|---|---|
| customerId | The system generated ID of the customer who is making the payment. | Yes |
| paymentDate | The date the payment was made. | Yes |
| paymentType | The form of payment: [0 Cash], [1 Check], [2 CreditCard], [3 ACH], [4 PayPal, [5 Other] | Yes |
| amount | The amount of the payment. | Yes |
| depositToAccountId | The account where the payment is to be deposited. | No |
| description | A description of the payment. | No |
| refNumber | The payment reference or invoice number. | No |
| invoicePays | Array (list) of invoices being paid. | No |
InvoicePays array parameters
| Field Name | Description | Required? |
|---|---|---|
| invoiceId | The system generated ID of the invoice being paid. | Yes |
| amount | Amount of the payment on the invoice. | Yes |