Skip to main content
Examples below use the production base URL (https://api.usetyms.com/v1/adam). For pre-production testing, use https://staging-api.usetyms.com/v1/adam with sandbox keys — see Environments. Email developer@usetyms.com to request sandbox access.

Zapier Integration

Setup

  1. Create a Zapier App: Use the HTTP Request action
  2. Authentication: Configure API key in Zapier’s authentication settings
  3. Triggers: Use webhooks or polling to detect new records
  4. Actions: Create records using POST endpoints with AI prompts

Example: Create Invoice Trigger

Make (Integromat) Integration

Setup

  1. HTTP Module: Configure with base URL https://api.usetyms.com/v1/adam
  2. Authentication: Add API key header (X-API-Key)
  3. Data Mapping: Map your data to API request format
  4. Error Handling: Handle API errors appropriately

Example: HTTP Request Configuration

  • Method: POST
  • URL: https://api.usetyms.com/v1/adam/invoices
  • Headers:
    • X-API-Key: Your API key
    • Content-Type: application/json
  • Body:

cURL Examples

Create Invoice

Update Invoice Payment

Get Contacts

JavaScript/Node.js Example

Python Example

Important Notes

  • Dates: Use ISO 8601 (YYYY-MM-DD) in structured JSON where an endpoint requires a date field.
  • Amounts: In structured JSON, use numeric amounts without currency symbols.
  • Timezone: Defaults are documented in Concepts; validated business profile includes timezone.
  • AI creates: Invoice, bill, expense, income, journal, contact, chart-of-accounts, and POST /bank-transactions/upload all use natural-language prompt (bank upload requires it — not a raw transactions[] bulk JSON importer). See Create bank transactions (AI).
  • Partners: New businesses are provisioned with Register business; day-to-day calls use each business’s tyms_sk_....
  • UUID resolution: Updates and deletes accept uuid or source_uuid where documented (Overview).