Skip to content

Company

A Company represents the top-level organization in the TreasuryPath system.

Company Object

{
  "id": "Z2lkOi8vd2FsbGV0LWFwcC9Db21wYW55LzE",
  "name": "Acme Corporation",
  "country": "US",
  "default_currency": "USD",
  "created_at": "2025-01-15T10:30:00Z",
  "updated_at": "2025-01-15T10:30:00Z"
}

Attributes

Attribute Type Description
id string Unique identifier for the company
name string Company name
country string ISO 3166-1 alpha-2 two-letter country code (e.g., "US", "GB")
default_currency string ISO 4217 three-letter currency code (e.g., "USD", "EUR")
created_at string ISO 8601 timestamp when the company was created
updated_at string ISO 8601 timestamp when the company was last updated

Available Operations

  • List Companies - Returns all companies accessible within your workspace
  • Create Company - Create a new company in your workspace
  • Get Company - Retrieve details of a specific company by ID
  • Update Company - Update company details (subject to restrictions below)
  • Delete Company - Remove a company (subject to restrictions below)

Update and Delete Restrictions

  • Only companies created through the API are eligible for deletion
  • Companies with multi-currency accounts enabled cannot be updated or deleted if the multi-currency feature application is in any status other than CREATED

For detailed API endpoints and request/response examples, see the Companies API Reference.