Sign in
latestOpenAPI 3.0.32026-08-084947174.1 KB

f9302ec2ef8a

Companies

Edit Company

patch/companies/{id}

Path parameters

idstring uuid required

Resource UUID

Request body

account_idstring required

Account id to associate the company with

legal_namestring required

Legal name of the company

formation_datestring date

Company formation date (YYYY-MM-DD)

fiscal_year_endstring

Fiscal year end in MM/DD format

emailstring

Company email address

phonestring

Company phone number

toll_free_phonestring

Company toll-free phone number

faxstring

Company fax number

no_faxboolean

Whether the company has no fax number

websitestring

Company website URL

no_websiteboolean

Whether the company has no website

missionstring

Company mission statement

purpose_statementstring

Company purpose statement

primary_product_or_servicestring

Primary product or service of the company

einstring

Employer Identification Number

Example request

{
  "domicile": {
    "id": "123e4567-e89b-12d3-a456-426614174000"
  },
  "principal_address": {
    "administrative_area": {
      "id": "123e4567-e89b-12d3-a456-426614174000"
    },
    "country": {
      "id": "123e4567-e89b-12d3-a456-426614174000"
    }
  },
  "mailing_address": {
    "administrative_area": {
      "id": "123e4567-e89b-12d3-a456-426614174000"
    },
    "country": {
      "id": "123e4567-e89b-12d3-a456-426614174000"
    }
  }
}

Response

Updated

Example response

{
  "data": {
    "domicile": {
      "id": "123e4567-e89b-12d3-a456-426614174000"
    },
    "principal_address": {
      "administrative_area": {
        "id": "123e4567-e89b-12d3-a456-426614174000"
      },
      "country": {
        "id": "123e4567-e89b-12d3-a456-426614174000"
      }
    },
    "mailing_address": {
      "administrative_area": {
        "id": "123e4567-e89b-12d3-a456-426614174000"
      },
      "country": {
        "id": "123e4567-e89b-12d3-a456-426614174000"
      }
    }
  }
}