v1

latestSwagger 2.02026-07-13107162315.5 KB
Company

Creates a new customer company record in Avaza.

post/api/Company

Request body

CompanyNamestring required

The name of the company. Required.

CurrencyCodestring

The default currency code for this company. Defaults to the account's default currency if not provided.

BillingAddressLinestring

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

BillingAddressCitystring

The city for the company's billing address.

BillingAddressStatestring

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

BillingAddressPostCodestring

The postcode or ZIP code for 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.

SendWebhooksboolean

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

Response

Returns the created company with assigned Company ID.

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.