Pay bills

Record payments against one or more bills or invoices, posting a Bill Payment journal entry per bill against the chosen register account. Retrieve the payable line items from /api/bills/pay/details, set each line's payment amount, then post the payments here. A payment cannot exceed the bill's remaining balance.

Required permission: Full Write Accounting

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Details of which bills are being paid

account
object | null
required

The register (bank) account the payments are paid from (payables) or deposited to (receivables). Provide the id.

bills
array of objects | null
required

The bills to pay and the amount to apply to each line item.

bills*
method
object | null

The payment method. Provide the id or code of an accounting payment method: apm_cash, apm_check, or apm_credit_card.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses
200

OK

401

Authentication is required, or the Ocs-Api-Key header is missing or invalid.

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json