---
title: "Create a Partner"
method: POST
path: "/api/v2/partners"
tags: ["Partner"]
---

# Create a Partner

`POST /api/v2/partners`

## Request

- The document declares no server URL.
- Auth: API key in header `client_id` and API key in header `client_secret`

## Request body

- object
  - `name` string, required: Partner name
  - `number` string, required: Partner number or code. Value must be unique per company
  - `type` 'Supplier' | 'supplier' | 'Client' | 'client' | 'Both' | 'both', required: Partner type to classify partners
  - `business_type` 'pt' | 'cv' | 'perorangan' | 'lainnya': Partner business type
  - `email` string: Partner email address
  - `phone` string, required: Partner phone number in E.164 international format
  - `mobile_phone` string: Partner mobile phone number in E.164 international format
  - `address` PartnerAddress
    - `address_line_1` string
    - `address_line_2` string
    - `state` string
    - `city` string
    - `postal_code` string
    - `country` string
  - `notes` string: Partner Note, to help you describe and identify the partner faster
  - `virtual_account` string: Partner's VA Account Number
  - `contacts` object[]: Contact person detail
    - `id` string
    - `name` string, required
    - `email` string, required
    - `phone` string, required
    - `note` string
    - `position` string, required
  - `bank_accounts` object[]: Bank account information
    - `bank_code` string, required: Bank Code (BCA, BNI, etc.)
    - `bank_account_number` string, required
    - `bank_account_name` string
    - `country` string
    - `currency` string
    - `is_bypass` integer
    - `is_default` integer
  - `custom_type` string

## Response `201`

Successful operation

- object
  - `message` string, required
  - `data` Partner
    - `id` string, required
    - `name` string
    - `number` string
    - `type` string
    - `business_type` string
    - `email` string
    - `phone` string
    - `mobile_phone` string
    - `address` PartnerAddress
      - `address_line_1` string
      - `address_line_2` string
      - `state` string
      - `city` string
      - `postal_code` string
      - `country` string
    - `notes` string
    - `virtual_account` string
    - `contacts` PartnerContact[]
      - `id` string
      - `name` string
      - `email` string
      - `phone` string
      - `note` string
      - `position` string
    - `bank_accounts` unknown[]
      - unknown
    - `counter_parties` unknown
    - `payment_method` PartnerPaymentMethod
      - `credit_card` boolean
      - `bank_transfer` boolean
      - `ewallet` boolean
      - `mitra_pembayaran_digital` boolean
      - `qris` boolean
    - `custom_type` string
    - `created_at` string
    - `updated_at` string

## Other responses

- `400`: Bad request
- `default`: Unsuccessful operation

---

[API](https://skmtc.dev/paper/apis/paper-open-api.md) - [All operations](https://skmtc.dev/paper/apis/paper-open-api/llms.txt) - [OpenAPI document](https://skmtc.dev/paper/apis/paper-open-api/revisions/243ba6121589?raw)