Create Vendor | Papertracc Docs

curl -X POST https://api.papertracc.com/v1/profiles/vendors \
     -H "Authorization: Bearer <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "type": "BUSINESS",
  "display_name": "Global Softworks",
  "email": "billing@globalsoft.dev",
  "phone": "+2348011112222",
  "first_name": "Amaka",
  "last_name": "Okafor",
  "company_name": "Global Softworks LLC",
  "currency_code": "NGN",
  "billing_address": {
    "city": "Lagos",
    "name": "Office",
    "state": "Lagos",
    "country": "Nigeria",
    "address_one": "12 Marina Road",
    "phone": "+2348012345678",
    "post_code": "100001",
    "country_code": "NG"
  },
  "shipping_address": {
    "city": "Lagos",
    "name": "Warehouse",
    "state": "Lagos",
    "country": "Nigeria",
    "address_one": "18 Warehouse Road",
    "phone": "+2348012345678",
    "post_code": "100001",
    "country_code": "NG"
  }
}'

{
  "data": {
    "accounts": [
      {
        "account_name": "John Doe",
        "account_number": "1234567890",
        "bank": "Spruce Bank",
        "code": "044",
        "currency_code": "NGN",
        "is_default": true,
        "vat_id": "78c68f6d-d734-4822-9a6c-73f517a0e5c1"
      }
    ],
    "billing_address": {
      "address_one": "12 Marina Road",
      "city": "Lagos",
      "country": "Nigeria",
      "country_code": "NG",
      "name": "Office",
      "phone": "+2348012345678",
      "post_code": "100001",
      "state": "Lagos"
    },
    "company_name": "Acme Corp",
    "contact_id": "64595845-34ec-482c-b0fe-ae617a0f8335",
    "created_at": "2026-06-18T10:00:00Z",
    "display_name": "Global Softworks",
    "email": "john@example.com",
    "first_name": "John",
    "id": "0cb2d1a5-2f50-43a1-8c3f-df06f998ef51",
    "last_name": "Doe",
    "payment_term_id": null,
    "phone": "+2348012345678",
    "project_id": "spruce-demo",
    "shipping_address": {
      "address_one": "12 Marina Road",
      "city": "Lagos",
      "country": "Nigeria",
      "country_code": "NG",
      "name": "Office",
      "phone": "+2348012345678",
      "post_code": "100001",
      "state": "Lagos"
    },
    "type": "BUSINESS"
  },
  "status": true,
  "message": "Successfully created vendor"
}

Creates a vendor profile. payment_term_id sets the payment term used by default on this vendor’s bills.

Requires the can_create_vendor_profile permission on the key owner’s role.

Keys: secret key only.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

identitystring

The identity for the active workspace.

Request

This endpoint expects an object.

typeenumRequired

Allowed values:

display_namestringRequired

dedupe_modeenumOptionalDefaults to skip

How to handle a record matching one already in the workspace. skip (default) leaves the existing record untouched and answers 409 with it. overwrite updates the existing record and answers 200. add creates a separate record regardless of the match.

Allowed values:

emailstringOptionalformat: "email"

phonestringOptional

first_namestringOptional

last_namestringOptional

company_namestringOptional

currency_codestringOptional

payment_term_idstringOptionalformat: "uuid"

Default payment term for this vendor. Applied to new bills that name no term or due date.

billing_addressobjectOptional

shipping_addressobjectOptional

Response

The request used dedupe_mode: overwrite and updated the vendor it matched.

dataobject

The existing vendor the request matched.

statusboolean

messagestring

Errors

401

Unauthorized Error

402

Payment Required Error

403

Forbidden Error

409

Conflict Error