ReceivedPay – Developer Support

About ReceivedPay

This returns details on invoice receipts received through Bill.com (UI or API). Receipts are tracked with RecordARPayment. When properly authorized, ChargeCustomer can be used.

Received payments can be applied against Invoices or unapplied (the amount becomes a credit to be used on open invoices).

The Response can contain zero or more InvoicePays (array of InvoicePay objects) applied against invoices.

Example

Request

<API_URL_EndPoint>/Crud/Read/ReceivedPay.json

data={
   "id" : "0rp01RTDBUIJNBHL4y6y"
}

Response

{
   "response_status" : 0,
   "response_message" : "Success",
   "response_data" : {
      "entity" : "ReceivedPay",
      "id" : "0rp01RTDBUIJNBHL4y6y",
      "createdTime" : "2016-11-19T23:07:20.000+0000",
      "updatedTime" : "2016-11-19T23:07:21.000+0000",
      "customerId" : "0cu01IYYXIMNXSPN4fyw",
      "status" : "0",
      "paymentDate" : "2016-11-19",
      "depositToAccountId" : "0ca01DDWAORSGOYX5hr5",
      "isOnline" : false,
      "paymentType" : "1",
      "amount" : 200.00,
      "description" : "Various Ring Washers",
      "refNumber" : "123",
      "convFeeAmount" : 0.00,
      "rPConvFee" : [ {
   } ],
   "invoicePays" : [ {
      "entity" : "InvoicePay",
      "id" : "0ip01PGWBYQUSCOA3exu",
      "invoiceId" : "00e01FUAUQZTMXTS5wx0",
      "amount" : 100.00,
      "description" : "Brass Ring Washers",
      "createdTime" : "2016-11-19T23:07:21.000+0000",
      "updatedTime" : "2016-11-19T23:07:21.000+0000"
      } ]
   "invoicePays" : [ {
      "entity" : "InvoicePay",
      "id" : "0ip01PGWBIJOLCOA2xyz",
      "invoiceId" : "00e01XUAUQZTMRJI2vv7",
      "amount" : 100.00,
      "description" : "Rubber Ring Washers",
      "createdTime" : "2016-11-19T23:07:22.000+0000",
      "updatedTime" : "2016-11-19T23:07:22.000+0000"
      } ]
   }
}

Resources

Parameters