Create a business partner

post

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

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Body used to create a business partner. Either partner_id (an existing Person) or a nested partner object with an identifier must be provided so the partner can be resolved or created.

company_id

uuid

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

partner_id

uuid

Id of an existing Person to link as the partner.

name

string

payable_due_days

integer

payable_payment_days

integer

notify_on_payout

boolean

notify_on_scheduled_payout

boolean

partner

object

Nested Person attributes. If identifier is present and no Person with that identifier exists yet, a new Person is created.

business_partner_bank_accounts

array of objects

Bank accounts to register for this business partner.

business_partner_bank_accounts

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

422

Unprocessable Entity — validation failed (e.g. duplicate partner for the company).

Language

Credentials

Bearer

Loading…

Response

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

application/json

201The created business partner.