v1

latestOpenAPI 3.0.12026-07-24310590875.6 KB

invoices

Record AR payment

Record an offline AR payment received from a customer.

An offline payment is a payment that you receive outside the BILL system. BILL simply applies the recorded payment amount to one or more invoices for the customer. Any recorded unapplied amount is an overpayment and is available as a customer credit in the BILL system.

See Recording an AR payment in the Guides section for more information, sample requests, and responses.

post/v3/invoices/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

customerIdstring

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

paymentDatestring date required

Invoice payment date. The value is in the yyyy-MM-dd format.

Payment type

amountnumber required

Payment amount

descriptionstring

Payment description

Example request

{
  "amount": "100",
  "customerId": "{{customer_id}}",
  "invoices": [
    {
      "amount": "50",
      "id": "{{invoice_id}}"
    }
  ],
  "paymentDate": "2026-12-20",
  "paymentType": "CREDIT_CARD",
  "description": "Accepted credit card payment in store"
}

Response

Record AR payment 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.

Record AR payment type.

paymentDatestring date

Invoice payment date. The value is in the yyyy-MM-dd format.

amountnumber

Payment amount

unappliedAmountnumber

Unapplied payment amount

Payment status.

descriptionstring

Payment description