OnPrintShop icon

OnPrintShop

Interact with OnPrintShop API

Actions218

Complete API → Account Summary

AI-generated

Summary

Retrieve customer account summary information from the OnPrintShop API, optionally filtered by store ID and paginated using limit and offset parameters.

Inputs

  • Safe Mode — Boolean to block mutations in Complete API calls.
  • Limit — Optional maximum number of account summary records to return (integer).
  • Offset — Optional number of records to skip before starting to return results (integer).
  • Storeid — Optional store ID to filter the account summaries (integer).
  • Return Fields Mode — Option to return all fields or a custom selection.
  • Return Fields — Specific account summary fields to return when using custom selection mode.

Output shape

An object containing account summary records and summary totals.

The response includes an array accountSummary with fields like amount, comments, date_added, department_id, duedate, id, paymethod, storeid, term_title, type, plus overall totals such as totalAccountSummary, remainingInvoiceAmount, and remainingPaidLimit. Pagination is supported via limit and offset parameters.

Examples

Example 1: Retrieve a paginated list of account summaries filtered for a specific store.

Set 'Storeid' to filter, specify 'Limit' and 'Offset' to paginate, and choose 'Return Fields Mode' as 'All Fields' or 'Custom Selection' to get relevant fields.

Links

Discussion