Save the payout setup
save_payout_setupSave the payout setup the user chose, by QuickBooks ids from get_payout_setup. It is checked first (the holding account must be a Bank account, each tax code must charge the platform's rates, the start date cannot be inside closed books) and waits for the user to confirm it on the Caribooks Payouts page; nothing is booked before that.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| mode | Yes | each_sale or payout_summary, as the user chose. | |
| items | Yes | Stripe product id → QuickBooks item id. | |
| company | No | The connected QuickBooks company (name, realm id, or connection id). Optional when only one company is connected. | |
| customers | No | Stripe customer id → QuickBooks customer id, for customers email and name do not match. | |
| tax_codes | Yes | Stripe tax combination key (from get_payout_setup) → QuickBooks tax code id. | |
| vendor_id | Yes | The vendor on fee expenses, usually Stripe. | |
| start_date | Yes | The first day booked, YYYY-MM-DD. | |
| fee_account_id | Yes | The expense account for Stripe's fees. | |
| bank_account_id | Yes | The bank account Stripe pays out to. | |
| default_item_id | No | The item for a sale with no Stripe invoice to read products from. | |
| fee_tax_code_id | Yes | The purchase tax code for Stripe's own fees that Stripe charges sales tax on, so it is claimed back; null to book them whole. | |
| exempt_tax_code_id | Yes | The tax code for card processing fees, which carry no sales tax (e.g. Exempt); null when the company has no sales tax. | |
| holding_account_id | Yes | The Bank account that stands for the Stripe balance. |