List payments by disbursement type

List all payments by disbursement type.

See Search operations with lists to learn about pagination, sorting, and filtering.

Form Data
string
required

Developer key (sent to you when you create a developer account)

string
required

API session ID generated with /Login.json

object
required
Response

Response body
object
integer

Response status.

  • 0: Success response
  • 1: Error response. Only error_code and error_message is returned in response_data.
string

Response status.

  • Success: Success response
  • Error: Error response. Only error_code and error_message is returned in response_data.
object
array of objects
payments
object
string

Object type. Set as SentPay.

string

BILL-generated ID of the SentPay object. The value begins with stp. You can filter with this field.

string

Bill payment processing date in the YYYY-MM-DD format. Funds are withdrawn from the bank account on this date. If processDate is not set, the default value is the next available payment date. You can filter with this field.

number

Total payment amount. You can filter with this field.

string

Payment status. You can filter with this field.

  • 0: Approving
  • 1: Scheduled
  • 2: Paid
  • 3: Canceled
  • 4: Void
  • 5: Escheated (Check only)
string

Payment description automatically generated by BILL

string

BILL-generated payment identification number. You can filter with this field.

string

BILL-generated bill payment confirmation number

string

BILL-generated ID of the vendor. The value begins with 009. You can filter with this field.

boolean

Payment source. You can filter with this field.

  • true: Payment is made with BILL (online)
  • false: Payment is made outside BILL and then recorded in BILL (offline)
boolean

Set as true if the bill payment is eligible for faster payment. You can filter with this field.

See Pay bills using Pay Faster in the BILL Help Center for more information.

string

Payment type. You can filter with this field.

  • 0: Check
  • 1: ACH
  • 2: ACH to Verified national vendor
  • 3: PayPal
  • 4: Other
  • 5: International ePayment
  • 6: American Express
  • 7: Vendor Direct (VCard)
  • 11: Instant Transfer (Wallet)
  • 12: Credit card
string

Check delivery type. You can filter with this field.

  • 0: Standard
  • 1: USPS priority
  • 10: UPS 1 day delivery
  • 11: UPS 2 day delivery
  • 12: UPS 3 day delivery
string

BILL-generated ID of the chart of accounts associated with the bill payment. This is an accounts tracking object. You can filter with this field.

  • Payments made with BILL (online): Automatically set to the BILL money out clearing account (read-only)
  • Payment made outside BILL (offline): You can set the chart of accounts ID
string

Payment reference ID, such as check number, that you can sync with your choice of accounting software. Use this field only for payments made outside BILL. You can filter with this field.

boolean

Set as true if the check is marked as printable when synced with your choice of accounting software. Use this field only for payments made outside BILL. You can filter with this field.

string

Created date and time

string

Updated date and time

string

BILL-generated ID of the user that created the payment. This value begins with 006. You can filter with this field.

string

BILL-generated ID of the bank account used to make the bill payment. If the bankAccountId is not set, the organization’s primary bank account is used. You can filter with this field.

string

This field is available only for select BILL partners

boolean

Set as true if the payment requires approval. You can filter with this field.

string

This field is available only for select BILL partners

string

SentPay source. You can filter with this field.

  • 0: BILL
  • 1: Bill autopay
  • 2: NetSync from online payment
  • 3: NetSync from offline payment
  • 4: eBill autopay
  • 5: eBill
  • 6: Recurring payment
boolean

Set as true if the payment export is enabled to your choice of accounting software. You can filter with this field.

string

Total bill amount paid in local currency. You can filter with this field.

number

Exchange rate for paying an international vendor. This value is required during bill creation and payments to international vendors. You can filter with this field.

string

Payment purpose. You can filter with this field.

string

Remittance email address set for the vendor. You can filter with this field.

string

Requested payment delivery date set by the vendor. The value is in the YYYY-MM-DD format. You can filter with this field.

string

Payment currency information. You can filter with this field.

string

BILL-generated ID of the card account used to make the bill payment

string

BILL-generated ID of the credit account used to make the bill payment

string

Date when the payment funds are held by BILL. Payment funds can be held when the receiver has not accepted the funds in BILL or when the receiver’s bank account has not been set up in BILL.

string

Vendor bank country

string

Vendor address country

string

Payment funding type.

  • 0: Check
  • 1: ACH to Verified national vendor
  • 2: ACH
  • 3: PayPal
  • 4: Credit card
  • 5: International ePayment
  • 6: American Express
  • 7: Vendor Direct (VCard)
  • 8: Real-time payment
  • 9: Instant Transfer (Wallet)
  • 10: Debit card
array of objects
billPays
object
string

Object type. Set as billPay.

string

BILL-generated ID of the billPay object. The value begins with blp.

string

BILL-generated ID of the bill to the paid. The value begins with 00n.

string

Bill payment confirmation number automatically generated by BILL

string

Payment status.

  • 1: Scheduled
  • 2: Paid
  • 3: Canceled
  • 4: Void
number

Total bill payment amount

string

Bill payment description automatically generated by BILL

string

Bill payment processing date in the YYYY-MM-DD format. Funds are withdrawn from the bank account on this date. If processDate is not set, the default value is the next available payment date.

string

Created date and time

string

Updated date and time

string

billPay payment type.

  • 0: Online
  • 1: Other
string

Payment reference ID, such as check number, that you can sync with your choice of accounting software. Use this field only for payment made outside BILL.

boolean

Set as true if the check is marked as printable when synced with your choice of accounting software. Use this field only for payment made outside BILL.

string

BILL-generated ID of the chart of accounts associated with the bill payment. This is an accounts tracking object.

  • Payments made with BILL (online): Automatically set to the BILL money out clearing account (read-only)
  • Payment made outside BILL (offline): You can set the chart of accounts ID
string

BILL-generated ID of the SentPay object. The value begins with stp.

boolean

Set as true if the bill payment export to your choice of accounting software is enabled

array of objects
billCredits
object
string

Object type. Set as BillCredit.

string

BILL-generated ID of the bill credit. The value begins with bcr.

string

BILL-generated ID of the bill to apply vendor credits. The value begins with 00n.

string

BILL-generated ID of the SentPay object. The value begins with stp.

string

BILL-generated ID of the vendor credit. The value begins with vcr.

string

Vendor credit amount

string

Created date and time

string

Updated date and time

array of objects
voidRequests
object
string

Object type. Set as VoidRequestQueue.

string

BILL-generated ID of the voided payment. The value begins with vrq.

string

Void request type.

  • 0: VOID_AND_CREDIT
  • 1: VOID_AND_REISSUE
  • 2: VOID_ONLY
  • 3: VOID_AND_REISSUE_VCARD
string
  • 0: TO_BE_PROCESSED
  • 1: ACCEPTED
  • 2: REJECTED
  • 3: NO_OP
  • 4: ARCHIVED
string

Void request reason description

string

BILL-generated ID of the user that requested a void payment. The value begins with 006.

string

Void payment processing date and time

string

Created date and time

string

Updated date and time

object
object
object
string

Error code (only when response_status is 1)

string

Error message (only when response_status is 1)

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