List business partners

get

https://api.cardda.com/v1/erp/payouts/business_partners

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

_start

integer

≥ 0

If all the transactions where in an array, this would represent the index of the first item returned in the response

_end

integer

≥ 0

If all the transactions where in an array, this would represent the index of the last item returned in the response

_order

string

enum

The order method, which can be ascending or descending

Allowed:

_field

string

The field used to sort, the example illustrates a response that would be sorted by the creation date

name

string

Filter by business partner name. Accepts a plain value or a JSON operator string,
e.g. {"$ilike": "%acme%"}.

Headers

company-id

uuid

required

UUID of the company on whose behalf the request is made. Required for every Pay endpoint.
See The company-id header for details on how to obtain
a value for this header and the error responses to expect when it is missing or invalid.

If the deprecated company_id query parameter is also sent, both values must match;
the API returns 422 Unprocessable Entity when they disagree.

Responses

401

Unauthorized

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

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