create_bank_payment
Destructive
Record a bank payment in Billy to mark an invoice or bill as partially or fully paid, posting a real accounting transaction.
Instructions
Record a bank payment in Billy to mark an invoice or bill as (partially) paid. Creates a bankPayment associated with the subject via 'invoice:' or 'bill:'. For invoices money is deposited (debit); for bills it is withdrawn (credit). WARNING: this posts a real accounting transaction.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| verbose | No | Return the full Billy response. Default false: compact records with key fields only (saves ~90% context) | |
| cashSide | No | Override side: 'debit'=deposit (invoices), 'credit'=withdrawal (bills). Defaults based on subjectType. | |
| entryDate | Yes | Payment date (YYYY-MM-DD) | |
| feeAmount | No | Bank/provider fee (positive, recorded as expense) | |
| subjectId | Yes | ID of the invoice or bill being paid | |
| cashAmount | Yes | Amount deposited/withdrawn in the cash account's currency | |
| subjectType | Yes | What is being paid | |
| feeAccountId | No | Expense account for the fee (required when feeAmount set) | |
| cashAccountId | Yes | Bank account ID (must have isPaymentEnabled=true; see list_accounts) | |
| organizationId | No | Organization ID (auto-resolved when omitted) | |
| cashExchangeRate | No | Exchange rate: 1 subjectCurrency = cashExchangeRate cashAccountCurrency. Required when the cash account's currency differs from the invoice/bill currency. |