v1

latestOpenAPI 3.1.0Proprietary2026-08-06177398877.4 KB

Companies

Update a company

Partially update a company. Only provided fields will be updated.

Omitted fields: Not modified (current value preserved)
Provided fields: Updated to the new value
Null values: Clear the field (set to null) where applicable

patch/companies/{id}

Path parameters

idstring required

Resource ID (UUID) or client key

Request body

namestring

Company legal name

addressLine1string nullable

Primary street address

addressLine2string nullable

Secondary address line

citystring nullable

City name

countrystring nullable

Country code or name

faxstring nullable

Fax number

invoiceOnlyboolean nullable

Whether this company is used only for invoicing purposes

invoiceVerbiagestring nullable

Custom text to include on invoices

primaryContactNamestring nullable

Name of primary contact person

primaryContactEmailstring email nullable

Email address of primary contact

primaryContactPhonestring nullable

Phone number of primary contact

keystring nullable

Client-defined reference identifier

Example request

{
  "name": "Acme Logistics Inc",
  "addressLine1": "123 Main St",
  "addressLine2": "Suite 400",
  "city": "Chicago",
  "country": "USA",
  "fax": "+1-555-0123",
  "invoiceVerbiage": "Please remit payment within 30 days",
  "primaryContactName": "John Smith",
  "primaryContactEmail": "john.smith@acmelogistics.com",
  "primaryContactPhone": "+1-555-0100",
  "key": "ERP-COMPANY-ACME-001"
}

Response

Company updated successfully

object'COMPANY'

Object type identifier

idstring uuid required

Unique company identifier

namestring required

Company legal name

addressLine1string nullable

Primary street address

addressLine2string nullable

Secondary address line (suite, floor, etc.)

citystring nullable

City name

countrystring nullable

Country code or name

faxstring nullable

Fax number

invoiceOnlyboolean nullable

Whether this company is used only for invoicing purposes

invoiceVerbiagestring nullable

Custom text to include on invoices for this company

primaryContactNamestring nullable

Name of primary contact person

primaryContactEmailstring email nullable

Email address of primary contact

primaryContactPhonestring nullable

Phone number of primary contact

keystring nullable

Client-defined reference identifier

createdAtstring date-time required

When the company was created

updatedAtstring date-time required

When the company was last updated

deletedAtstring date-time nullable

When the company was soft deleted (null if active)

Example response

{
  "object": "COMPANY",
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "Acme Logistics Inc",
  "addressLine1": "123 Main St",
  "addressLine2": "Suite 400",
  "city": "Chicago",
  "country": "USA",
  "fax": "+1-555-0123",
  "invoiceVerbiage": "Please remit payment within 30 days",
  "primaryContactName": "John Smith",
  "primaryContactEmail": "john.smith@acmelogistics.com",
  "primaryContactPhone": "+1-555-0100",
  "createdBy": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "key": "ERP-USER-12345",
    "email": "john.doe@example.com",
    "name": "John Doe",
    "phone": "+1-555-123-4567",
    "phoneExt": "123",
    "status": "ACTIVE",
    "avatarId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
    "createdAt": "2025-01-15T10:00:00Z",
    "updatedAt": "2025-01-15T14:30:00Z"
  },
  "key": "ERP-COMPANY-ACME-001",
  "createdAt": "2025-01-15T10:00:00Z",
  "updatedAt": "2025-01-15T14:30:00Z"
}