> ## Documentation Index
> Fetch the complete documentation index at: https://developer.usetyms.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Create contact



## OpenAPI

````yaml /openapi/adam-v1.json post /create/contact
openapi: 3.0.3
info:
  title: Tyms Developer API
  version: 1.0.0
  description: >-
    REST API for Tyms — the AI-Native Accounting Platform for small and
    medium-sized businesses across service, consulting, retail, and
    manufacturing. Paths are appended to the server URL.


    **Business key** (`tyms_sk_...`): all routes except partner distributor
    routes and OAuth authorization steps that document their own auth. **Partner
    key** (`adam_partner_sk_...` or equivalent): `POST /register-business`, `GET
    /referred-businesses`, billing status, and seat/credit grants on referred
    businesses. **OAuth**: integration apps use `tyms_pk_...` / `tyms_sk_...`
    plus user Bearer tokens — see the OAuth guide.


    Financial reports match what you see in the Tyms app. AI create endpoints
    accept optional attachment objects (`name`, `file`, `type`) — see the
    Attachments page in this docs site.
servers:
  - url: https://staging-api.usetyms.com/v1/adam
    description: Sandbox (pre-production). Request credentials at developer@usetyms.com.
  - url: https://api.usetyms.com/v1/adam
    description: Production
security:
  - apiKey: []
tags:
  - name: Partners
    description: >-
      Referral partner (distributor) flows — partner API key only. Register
      businesses, list referrals, read billing, and grant Plus seats or AI
      credits from partner holding.
  - name: Authentication
    description: Validate a business Developer API key.
  - name: OAuth
    description: >-
      Third-party integration authorization — connect Tyms users to your app
      without sharing their business secret keys.
  - name: Chart of accounts
    description: COA and bank-linked accounts.
  - name: Invoices
    description: Invoice CRUD and payments.
  - name: Bills
    description: Bill CRUD and payments.
  - name: Expenses
    description: Expense CRUD.
  - name: Income
    description: Income record CRUD.
  - name: Journals
    description: Journal entry CRUD.
  - name: Contacts
    description: Contact CRUD.
  - name: Banks
    description: Bank accounts.
  - name: Bank transactions
    description: Statement lines and AI-assisted upload.
  - name: Reports
    description: Financial statements (aligned with in-app reports).
paths:
  /create/contact:
    post:
      tags:
        - Contacts
      summary: Create contact
      operationId: createContactManual
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ManualContactCreate'
            examples:
              default:
                value:
                  name: Acme Supplies Ltd
                  type: vendor
                  business_name: Acme Supplies Limited
                  email: billing@acmesupplies.example
                  phone: '+2348012345678'
                  address: 12 Industrial Avenue, Lagos
                  tax_id: RC-123456
                  country: NG
                  contact_number: VND-0091
                  payment_terms: 14
                  receivable_account: Accounts Receivable
                  payable_account: Accounts Payable
                  opening_balance: 0
      responses:
        '200':
          description: Contact created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AdamSuccessResponse'
              example:
                status: success
                message: Contacts imported successfully
                data:
                  imported: 1
                  contacts:
                    - uuid: v8e7d6c5b4a3418290f0e9d8c7b6a5947
                      name: Acme Supplies Ltd
                      type: vendor
        '400':
          description: Validation error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    ManualContactCreate:
      type: object
      required:
        - name
      example:
        name: Acme Supplies Ltd
        type: vendor
        business_name: Acme Supplies Limited
        email: billing@acmesupplies.example
        phone: '+2348012345678'
        address: 12 Industrial Avenue, Lagos
        tax_id: RC-123456
        country: NG
        contact_number: VND-0091
        payment_terms: 14
        receivable_account: Accounts Receivable
        payable_account: Accounts Payable
        opening_balance: 0
      properties:
        name:
          type: string
          description: Contact display name.
        type:
          type: string
          enum:
            - customer
            - vendor
            - both
        email:
          type: string
          description: Used to match existing contacts.
        phone:
          type: string
        business_name:
          type: string
        address:
          type: string
        tax_id:
          type: string
        country:
          type: string
        contact_number:
          type: string
        payment_terms:
          type: number
        receivable_account:
          type: string
        payable_account:
          type: string
        opening_balance:
          type: number
        opening_balance_date:
          type: string
          format: date
        opening_balance_exchange_rate:
          type: number
    AdamSuccessResponse:
      type: object
      required:
        - status
        - message
      properties:
        status:
          type: string
          example: success
        message:
          type: string
        data:
          description: >-
            Single resource, array of resources, statement sections, or async
            job metadata — see each operation's example.
        meta:
          type: object
          additionalProperties: true
          description: >-
            Pagination (`page`, `limit`, `total`) and/or report range (`from`,
            `to`). Cash flow may include `previous_period_end`.
    ErrorResponse:
      type: object
      properties:
        status:
          type: string
          example: failed
        message:
          type: string
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: X-API-Key
      description: >-
        Business secret `tyms_sk_...` for business-scoped routes. Partner secret
        for register-business and referred-business distributor routes.
      x-default: your_tyms_sk_or_partner_key

````