Read partner or owner capital schedule
get_partner_capitalRead the partner or owner capital schedule currently on file — Note 3a and Note 3b. THIS RETURNS PEOPLE’S NAMES, along with each person’s profit-sharing ratio and amounts. Call it before save_partner_capital so you can show your user what is on file and what your change would do — that save replaces the whole section, so a schedule you cannot see is a schedule you cannot safely replace. It also returns the total of the capital-account profit-sharing ratios, because Datavrn warns about a total that is not 100% only when at least two rows carry a ratio.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Page size (default 50, max 200). | |
| offset | No | Rows to skip (default 0). | |
| client_id | Yes | The entity (client) id — from list_clients. | |
| period_id | Yes | The reporting period id — from list_periods. | |
| template_id | Yes | The statement template id (e.g. 'schedule3_v1' Division I; see list_snapshots/workspace). | |
| account_kind | No | Limit to one section: 'capital' is Note 3a, 'current' is Note 3b. Omit for both. |