FOfonoa
Onboarding

Update a company

This Company update endpoint allows you to modify companies previously onboarded.

This endpoint replaces all the existing company details with the new ones provided in the request body.

The following fields are not allowed to be updated:

  • tax_credentials: Use the PATCH endpoint to update tax credentials.
  • meta.external_id: This field is immutable and cannot be updated.
put/onboarding/v2/companies/{id}

Request

  • The document declares no server URL.
  • Auth
    API key in header Ocp-Apim-Subscription-Key

Path parameters

idstring required

The identifier of the company

Request body

company_numberstring required

Company’s local identification number, usually identical to TIN.

Validations:

  • Required property
  • Length between 1 and 50
establishment_datestring

The date when the company was established or business activity started. Establishment Date should be in ISO8601 standard.

legal_formstring

Legal form of the company, complementing legal_name. e.g. SARL AU CAPITAL DE 50 000 EUROS.

Validations:

  • This field is only supported in specific use cases, refer to country-specific integration guides in the Fonoa dashboard.
legal_namestring required

The company's legal name.

Validations:

  • Required property
  • Length between 1 and 450
logostring

url of the logo to be used in invoice documents for this company

registration_placestring

Official register and place where the company is recorded, e.g. RCS Paris (FR), Amtsgericht München (DE).

Validations:

  • This field is only supported in specific use cases, refer to country-specific integration guides in the Fonoa dashboard.
representative_emailstring
representative_namestring
trade_namestring

Validations:

  • Length between 0 and 450

Example request

{
  "address": {
    "address_line_1": "123 Main Street",
    "address_line_2": "Suite 400",
    "canton": "Zürich",
    "city": "San Francisco",
    "city_code": "SF123",
    "country_code": "US",
    "district": "Financial District",
    "neighbourhood": "Downtown",
    "number": "123",
    "postal_code": "94105",
    "prefix": "North",
    "province": "Ontario",
    "region": "Midwest",
    "state": "California",
    "suffix": "Avenue"
  },
  "company_number": "123456789",
  "contact_details": {
    "attention_to": "John Doe",
    "certified_email": "certified@company.com",
    "email": "contact@company.com",
    "phone_number": "+1-800-123-4567",
    "website": "https://www.company.com"
  },
  "establishment_address": {
    "address_line_1": "123 Main Street",
    "address_line_2": "Suite 400",
    "canton": "Zürich",
    "city": "San Francisco",
    "city_code": "SF123",
    "country_code": "US",
    "district": "Financial District",
    "neighbourhood": "Downtown",
    "number": "123",
    "postal_code": "94105",
    "prefix": "North",
    "province": "Ontario",
    "region": "Midwest",
    "state": "California",
    "suffix": "Avenue"
  },
  "legal_name": "Fonoa Inc.",
  "tax_credentials": {
    "certificate_base64": "MIIDdzCCAl+gAwIBAgIEbFJ...",
    "certificate_password": "securePassword123",
    "certificate_private_key_base64": "MIIEvQIBADANBgkqhkiG9w0B...",
    "certificate_type": "pkcs12",
    "password": "Pa$$w0rdSecure!",
    "pin": "1234",
    "username": "tax_user_001"
  },
  "tax_information": {
    "activity_code": "ACT-200",
    "additional_tax_numbers": [
      {
        "country_code": "US",
        "country_subdivision_code": "CA",
        "tax_number": "123456789"
      }
    ],
    "authorization_code": "AUTH-987654",
    "billing_file_number": "BFN-00123",
    "device_id": "DEVICE-456789",
    "distribution_address": "someone@email.com",
    "document_type": "INVOICE",
    "eac_code": "6201",
    "point_of_sale": "POS-1001",
    "regime": "VAT",
    "reporting_mandate": "TICKETBAI",
    "tax_code": "TX-001",
    "tax_number": "123456789"
  }
}

Response

Ok - company was updated successfully.

messagestring
statusstring

The status of the request.

Example response

{
  "data": {
    "address": {
      "address_line_1": "123 Main Street",
      "address_line_2": "Suite 400",
      "canton": "Zürich",
      "city": "San Francisco",
      "city_code": "SF123",
      "country_code": "US",
      "district": "Financial District",
      "neighbourhood": "Downtown",
      "number": "123",
      "postal_code": "94105",
      "prefix": "North",
      "province": "Ontario",
      "region": "Midwest",
      "state": "California",
      "suffix": "Avenue"
    },
    "contact_details": {
      "attention_to": "John Doe",
      "certified_email": "certified@company.com",
      "email": "contact@company.com",
      "phone_number": "+1-800-123-4567",
      "website": "https://www.company.com"
    },
    "establishment_address": {
      "address_line_1": "123 Main Street",
      "address_line_2": "Suite 400",
      "canton": "Zürich",
      "city": "San Francisco",
      "city_code": "SF123",
      "country_code": "US",
      "district": "Financial District",
      "neighbourhood": "Downtown",
      "number": "123",
      "postal_code": "94105",
      "prefix": "North",
      "province": "Ontario",
      "region": "Midwest",
      "state": "California",
      "suffix": "Avenue"
    },
    "tax_information": {
      "activity_code": "ACT-200",
      "additional_tax_numbers": [
        {
          "country_code": "US",
          "country_subdivision_code": "CA",
          "tax_number": "123456789"
        }
      ],
      "authorization_code": "AUTH-987654",
      "billing_file_number": "BFN-00123",
      "device_id": "DEVICE-456789",
      "distribution_address": "someone@email.com",
      "document_type": "INVOICE",
      "eac_code": "6201",
      "point_of_sale": "POS-1001",
      "regime": "VAT",
      "reporting_mandate": "TICKETBAI",
      "tax_code": "TX-001",
      "tax_number": "123456789"
    }
  },
  "errors": [
    {
      "type": "validation"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.