CAcardda
Business Partner

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

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

Query parameters

namestring

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

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

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

idstring uuid required
company_idstring uuid required
partner_idstring uuid required

The id of the underlying Person (partner) record shared across companies.

namestring

Display name of the business partner for this company.

emailstring
payable_due_daysinteger nullable

Default number of days used to compute the due date of new payables.

payable_payment_daysinteger nullable

Default number of days used to compute the payment date of new payables.

notify_on_payoutboolean
notify_on_scheduled_payoutboolean
created_atstring date-time
updated_atstring date-time

Changes

No recorded changes to this operation across all 1 revision of this API.