---
title: "Get business partner summary"
method: GET
path: "/v1/erp/payouts/business_partners/{id}/summary"
tags: ["Business Partner"]
---

# Get business partner summary

`GET /v1/erp/payouts/business_partners/{id}/summary`

## Request

- Base URL: `https://api.cardda.com`
- URL: `https://api.cardda.com/v1/erp/payouts/business_partners/{id}/summary`
- Auth: HTTP bearer

Returns aggregate counters and amounts for the business partner (number of payables and
bank transactions, and paid / due / overdue totals).

Requires the `erp_business_partners_view` or `erp_business_partners_manage` permission
(or company admin).

## Parameters

- `#/paths/~1v1~1erp~1payouts~1rules/get/parameters/0` (unresolved $ref)
- `#/paths/~1v1~1erp~1payouts~1rules~1%7Bid%7D/get/parameters/1` (unresolved $ref)

## Response `200`

Business partner summary.

- BusinessPartnerSummary: Aggregated activity counters and amounts for a business partner.
  - `bank_transactions` integer: Number of bank transactions linked to this partner's payables.
  - `payables` integer: Number of payables associated with this partner.
  - `transactions` integer: Card transactions count. Currently always 0 (not yet supported).
  - `amount_paid` integer: Total amount already paid across the partner's payables.
  - `amount_due` integer: Total amount still owed across the partner's payables.
  - `amount_overdue` integer: Total amount past its due date.

## Other responses

- `401`: Unauthorized
- `404`: Business partner not found

---

[API](https://skmtc.dev/cardda/apis/banking-api.md) - [All operations](https://skmtc.dev/cardda/apis/banking-api/llms.txt) - [OpenAPI document](https://skmtc.dev/cardda/apis/banking-api/revisions/ff1aeb3fda8b?raw)