Sign in

v1

latestOpenAPI 3.0.12026-07-24310590875.6 KB
bills

Record AP payment

Record an offline AP payment made to a vendor.

An offline payment is a payment made outside the BILL system. BILL simply applies the recorded payment amount to one or more bills for the vendor. BILL does not process the payment or transfer funds to the vendor when you record an AP payment with this endpoint.

Use POST /v3/payments to create a payment with the BILL system. When you pay with POST /v3/payments, BILL processes the payment and transfers funds from your BILL organization funding account to the vendor.

post/v3/bills/record-payment

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}}

Request body

vendorIdstring required

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

processDatestring date required

Payment process date. The value is in the yyyy-MM-dd format.

toPrintCheckboolean required

Set as true to set the payment check as printable in your accounting system. Use this field only for check payments.

descriptionstring

Payment description

syncReferencestring

Payment reference ID in your accounting system. Set this field with payment information, such as check number.

allowExportboolean

Set as true to sync the bill payment with your accounting system

Example request

{
  "vendorId": "{{vendor_id}}",
  "processDate": "2026-12-20",
  "toPrintCheck": false,
  "payments": [
    {
      "billId": "{{bill_id}}",
      "amount": 70
    }
  ]
}

Response

Record AP payment response

idstring

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

vendorIdstring

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

billIdstring

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

descriptionstring

Payment description

processDatestring date

Payment process date. The value is in the yyyy-MM-dd format.

amountnumber

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

transactionNumberstring

BILL-generated alphanumeric payment identification value

confirmationNumberstring

BILL-generated bill payment confirmation value

status'APPROVING' | 'SCHEDULED' | 'PAID' | 'CANCELLED' | 'VOID' | 'ESCHEATED' | 'UNDEFINED'

Payment status.

exchangeRatenumber

Exchange rate for the payment in an international currency (not USD)

fundingAmountnumber

Payment amount in USD

onlinePaymentboolean

Payment source.

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

This field is set as false for the Record AP payment operation.

disbursementType'CHECK' | 'ACH' | 'RPPS' | 'PAYPAL' | 'OFFLINE' | 'INTERNATIONAL_E_PAYMENT' | 'AMEX' | 'VIRTUAL_CARD' | 'WALLET' | 'CREDIT_CARD' | 'UNDEFINED'

Disbursement type. This field is set as OFFLINE for the Record AP payment operation.

remittanceEmailstring

Remittance email address set for the vendor

createdTimestring date-time

Payment created date and time

updatedTimestring date-time

Payment updated date and time

createdBystring

BILL-generated ID of the user that created the payment. The value begins with 006.

disbursementStatus'SCHEDULE' | 'DONE' | 'FAILED' | 'VOID' | 'HOLD' | 'FXHOLD' | 'ESCHEATED' | 'UNDEFINED'

Payment disbursement status. This field is set as DONE for the Record AP payment operation.

singleStatus'DISBURSEMENT_FAILED_ACTION_NEEDED' | 'DISBURSEMENT_FAILED_VENDOR_BANK_REJECTED' | 'FUNDING_FAILED_ACTION_NEEDED' | 'EXPIRING' | 'FUNDS_ESCHEATED' | 'CANCELED' | 'FUNDING_FAILED_VOIDED' | 'VOIDED' | 'CLEARED' | 'DELIVERED' | 'DISBURSEMENT_ON_HOLD' | 'VOID_PENDING' | 'SENT' | 'DISBURSEMENT_ON_HOLD_PAYER_IN_REVIEW' | 'PROCESSED' | 'FUNDING_STARTED' | 'FUNDING_ON_HOLD' | 'WAITING_ON_APPROVAL' | 'SCHEDULED' | 'READY_TO_FUND' | 'CANCELLATION_IN_PROGRESS' | 'UNDEFINED' | 'PARTIALLY_CLAIMED' | 'PAID_OFFLINE'

Unified payment status. This field provides BILL payment lifecycle updates based on the status and disbursementStatus values in the response.

This field is set as PAID_OFFLINE for the Record AP payment operation.

toPrintCheckboolean

Set as true to set the payment check as printable in your accounting system. Use this field only for check payments.

syncReferencestring

Payment reference ID in your accounting system. Set this field with payment information, such as check number.

allowExportboolean

Set as true to sync the bill payment with your accounting system