Sign in

v1

latestOpenAPI 3.0.12026-07-24310590875.6 KB
receivable-payments

Get received payment details

Get details about an existing received payment.

get/v3/receivable-payments/{receivedPaymentId}

Path parameters

receivedPaymentIdstring required

BILL-generated ID of the received payment. The value begins with 0rp.

Example:{{received_payment_id}}

Headers

sessionIdstring nullable

API session ID generated with /v3/login

Example:{{session_id}}
devKeystring nullable

Developer key generated with your BILL developer account

Example:{{developer_key}}

Response

Get received payment details response

idstring

BILL-generated ID of the received payment. The value begins with 0rp.

customerIdstring

BILL-generated ID of the customer. The value begins with 0cu.

descriptionstring

Invoice payment description. This value is included in the check memo or in the bank descriptor for electronic payments.

paymentDatestring date

Received payment date. Funds are withdrawn from the customer bank account on this date.

amountnumber required

Received payment amount. For a payment in an international currency (not USD), this value is in the local currency.

unappliedAmountnumber

Unapplied received payment amount. This value is available for an overpayment, double payment, or customer payment not currently linked to an invoice.

convenienceFeeAmountnumber

Convenience fee charged to the customer

receivablesType'CASH' | 'CHECK' | 'CREDIT_CARD' | 'ACH' | 'PAYPAL' | 'OTHER' | 'WALLET' | 'VIRTUAL_CARD' | 'UNDEFINED'

Received payment disbursement type.

status'PAID' | 'VOID' | 'SCHEDULED' | 'CANCELED' | 'ESCHEATED' | 'UNDEFINED'

Received payment status.

referenceNumberstring

Received payment reference number

onlinePaymentboolean

Information about how the received payment is recorded.

  • true: The payment is received with BILL
  • false: The payment is received outside BILL, and then recorded in BILL
createdTimestring date-time

Received payment created date and time

updatedTimestring date-time

Received payment updated date and time