CAcardda
Business Partner

Create a business partner

Creates a business partner for the company. Provide either an existing partner_id or a nested partner object with an identifier; when the identifier does not yet match an existing Person, a new Person is created and linked.

Requires the erp_business_partners_manage permission (or company admin).

post/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

Parameters

#/paths/~1v1~1erp~1payouts~1rules/get/parameters/0 (unresolved $ref)

Request body

company_idstring uuid

Company the business partner belongs to. Defaults to the company-id header.

partner_idstring uuid

Id of an existing Person to link as the partner.

namestring
emailstring
payable_due_daysinteger
payable_payment_daysinteger
notify_on_payoutboolean
notify_on_scheduled_payoutboolean

Response

The created business partner.

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.