Skip to main content
POST
Create contact

Authorizations

X-API-Key
string
header
default:your_tyms_sk_or_partner_key
required

Business secret tyms_sk_... for business-scoped routes. Partner secret for register-business and referred-business distributor routes.

Body

application/json
name
string
required

Contact display name.

type
enum<string>
Available options:
customer,
vendor,
both
email
string

Used to match existing contacts.

phone
string
business_name
string
address
string
tax_id
string
country
string
contact_number
string
payment_terms
number
receivable_account
string
payable_account
string
opening_balance
number
opening_balance_date
string<date>
opening_balance_exchange_rate
number

Response

Contact created

status
string
required
Example:

"success"

message
string
required
data
any

Single resource, array of resources, statement sections, or async job metadata — see each operation's example.

meta
object

Pagination (page, limit, total) and/or report range (from, to). Cash flow may include previous_period_end.