---
title: "List business partners"
method: GET
path: "/v1/erp/payouts/business_partners"
tags: ["Business Partner"]
---

# List business partners

`GET /v1/erp/payouts/business_partners`

## Request

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

Returns a paginated list of the company's business partners (vendors/suppliers).
Each entry embeds its underlying `partner` (Person) and `company`.

Requires the `erp_business_partners_view` or `erp_business_partners_manage` permission
(company admins always have access).

## Query parameters

- `name` string

## Parameters

- `#/paths/~1v1~1erp~1payouts~1rules/get/parameters/0` (unresolved $ref)
- `#/paths/~1v1~1erp~1payouts~1rules/get/parameters/1` (unresolved $ref)
- `#/paths/~1v1~1erp~1payouts~1rules/get/parameters/2` (unresolved $ref)
- `#/paths/~1v1~1erp~1payouts~1rules/get/parameters/3` (unresolved $ref)
- `#/paths/~1v1~1erp~1payouts~1rules/get/parameters/4` (unresolved $ref)

## Response `200`

Paginated list of business partners the user has access to (default 25 per page).

- BusinessPartner[]
  - `id` string, uuid, required
  - `company_id` string, uuid, required
  - `partner_id` string, uuid, required: The id of the underlying Person (partner) record shared across companies.
  - `name` string: Display name of the business partner for this company.
  - `email` string
  - `payable_due_days` integer, nullable: Default number of days used to compute the due date of new payables.
  - `payable_payment_days` integer, nullable: Default number of days used to compute the payment date of new payables.
  - `notify_on_payout` boolean
  - `notify_on_scheduled_payout` boolean
  - `created_at` string, date-time
  - `updated_at` string, date-time
  - `partner` object: The underlying Person record. Included in the `index` and `show` responses.
    - `id` string, uuid
    - `identifier` string: The RUT (or other tax identifier) of the partner.
    - `name` string
    - `country` string
  - `company` object: The company that owns this business partner relationship.
    - `id` string, uuid
    - `identifier` string
    - `name` string
  - `business_partner_bank_accounts` object[]: Bank accounts registered for this business partner. Only included in the `show` response. Each entry embeds its `bank_account`, the associated `bank_recipients`, and the `bank_recipient_ids` computed field.
    - `id` string, uuid
    - `bank_account_id` string, uuid
    - `name` string
    - `alias` string
    - `email` string
    - `default` boolean
    - `bank_recipient_ids` string[]

## Other responses

- `401`: Unauthorized

---

[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)