v2

latestSwagger 2.02026-08-04108164321.0 KB
Company

Updates an existing company record. Only fields listed in the FieldsToUpdate array will be modified.

put/api/Company

Request body

CompanyIDinteger

The ID of the company to update. Required.

FieldsToUpdatestring[]

A list of field names that should be updated. Only the fields named here will be changed.

CompanyNamestring

The new name for the company.

BillingAddressLinestring

The updated street address line for the company's billing address.

BillingAddressCitystring

The updated city for the company's billing address.

BillingAddressStatestring

The updated state or province for the company's billing address.

BillingAddressPostCodestring

The updated postcode or ZIP code for the company's billing address.

BillingCountryCodestring

The updated ISO 2-letter country code for the company's billing address.

BillingAddressstring

The updated full formatted billing address string. If set, overrides the individual address fields.

Phonestring

The company's updated primary phone number.

Faxstring

The company's updated fax number.

websitestring

The company's updated website URL.

TaxNumberstring

The company's updated tax registration number.

Commentsstring

Updated internal notes or comments about the company.

SendWebhooksboolean

If true, fires the company_updated webhook event to any subscribed endpoints. Defaults to false to preserve existing integration behaviour.

Response

Returns the updated company details.

CompanyIDinteger

The unique identifier of the company.

CompanyNamestring

The display name of the company.

BillingAddressLinestring

The first line of the company's billing address (street address).

BillingAddressCitystring

The city of the company's billing address.

BillingAddressStatestring

The state or province of the company's billing address.

BillingAddressPostCodestring

The postcode or ZIP code of the company's billing address.

BillingCountryCodestring

The ISO 2-letter country code for the company's billing address.

BillingAddressstring

The full formatted billing address string. If set, overrides the individual address fields.

Phonestring

The company's primary phone number.

Faxstring

The company's fax number.

websitestring

The company's website URL.

TaxNumberstring

The company's tax registration number.

Commentsstring

Internal notes or comments about the company.

CurrencyCodestring

The default currency code used for invoices and transactions with this company.

DefaultTradingTermIDFKinteger

The ID of the default trading terms applied to invoices for this company.

DateCreatedstring date-time

The UTC date and time when the company record was created.

DateUpdatedstring date-time

The UTC date and time when the company record was last updated.

ViewCompanyURLstring

URL to view this company in the Avaza web application.