Business Partner

Get business partner summary

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

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

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

Business partner summary.

bank_transactionsinteger

Number of bank transactions linked to this partner's payables.

payablesinteger

Number of payables associated with this partner.

transactionsinteger

Card transactions count. Currently always 0 (not yet supported).

amount_paidinteger

Total amount already paid across the partner's payables.

amount_dueinteger

Total amount still owed across the partner's payables.

amount_overdueinteger

Total amount past its due date.

Changes

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