MEmeow
Bill Pay

Get Bill Pay Settings

Returns how bill pay is configured for your entity: whether it is on, which account bills are funded from by default, and how many dashboard approvals a bill needs before it pays.

get/billpay/settings

Request

Headers

x-entity-idstring uuid

Optional entity_id to scope requests to a specific entity.

Response

Successful Response

is_enabledboolean required

Whether bill pay is turned on for this entity. Bills can be drafted before it is, but nothing pays out until it is, and the rest of the bill pay endpoints reject the entity while it is false.

default_account_idstring nullable

The saved default account, in the same id format returned by GET /accounts. A bill you create without an account_id is funded from it. If it is closed, the bill is funded from the entity's next open account instead. For a key restricted to one account, this is that account.

approval_mode'AUTO_APPROVAL' | 'ONE_ADMIN_APPROVAL' | 'ALL_ADMINS_APPROVAL'
class_enabledboolean

Whether your accounting settings collect a QuickBooks Class on each bill line. Send class_external_id on a line mapping only while this is true.

class_requiredboolean

Whether every line must name a Class before the bill can sync. While this is true, POST /bills/{bill_id}/accounting-mappings rejects a mapping that leaves any line without one.

Changes

No recorded changes to this operation across all 1 revision of this API.