Get charge presets
List charge presets for the authenticated company. A charge preset is a reusable, company-scoped template for a charge or discount line on a sales order, purchase, or invoice. Applying a preset copies its name, type, and amount onto the order's charge line; the line then keeps those values on its own, so editing or deleting the preset never changes charges already applied — only future applications. A charge applied from a preset references it via the charge's charge_preset field.
Results are scoped to your company and ordered oldest-first by creation time. Deleted presets are excluded. The response is paginated — follow the next_page URL to page through the full set.
Required permission: any of settings_permissions_charge_presets, or create/edit permission for orders, purchases, or invoices.
Query parameters
Restrict the result to specific charge presets by ID (the same ID returned as each preset's id). Repeat the bracketed key once per ID. Unknown IDs simply match nothing; an empty list is treated as no filter. At most 200 IDs may be given. A malformed ID is rejected with a 400.
Filter to charge presets by their creation datetime, given as a comma-separated start,end pair of ISO8601 datetimes (inclusive). Either bound may be omitted for an open-ended range: 2022-07-10T00:00:00Z, matches on or after that instant, ,2022-07-10T00:00:00Z matches on or before it.
Filter to charge presets by their last-updated datetime, given as a comma-separated start,end pair of ISO8601 datetimes (inclusive). Either bound may be omitted for an open-ended range.
Page selector. Page size is fixed by the server; paginate by following the next_page URL in each response rather than building page selectors yourself — it is null on the last page. next_page uses page[after]=<cursor>, an opaque token marking where the next page resumes; pass it back exactly as given, and only to the endpoint that issued it. This is seek-based, so every page stays fast no matter how deep you page.
Response
A list of charge presets
Changes
No recorded changes to this endpoint across all 1 revision of this API.