--- title: "Update company details" method: PATCH path: "/onboarding/v2/companies/{id}" --- # Update company details `PATCH /onboarding/v2/companies/{id}` Used to update details for an existing onboarded company. Only the fields listed here are available to update ## Path parameters - `id` string, required ## Request body - OnboardingCompanyPatch - `address` OnboardingAddress - `address_line_1` string — The primary street address, including street name and house/building number. Validations: - Length between 0 and 450 - `address_line_2` string — Additional address details, such as apartment, suite, or floor number. Validations: - Length between 0 and 450 - `canton` string — A territorial division, commonly used in countries like Switzerland. Validations: - Length between 0 and 100 - `city` string — The municipality or urban area where the company is located. Validations: - Length between 0 and 100 - `city_code` string — A numerical or alphanumerical code representing the city. Validations: - Length between 0 and 20 - `country_code` string, required — Address country where the entity is registered. Country code must be in ISO 3166-1 two-letter format. Validations: - Required property - Exact length: 2 - `district` string — A smaller administrative unit within a province, state, or region. Validations: - Length between 0 and 100 - `neighbourhood` string — A specific area or locality within a city or town. Validations: - Length between 0 and 100 - `number` string — The specific number of the building or property on the street. Validations: - Length between 0 and 20 - `postal_code` string — The code used by postal services to identify specific delivery areas. Validations: - Length between 0 and 100 - `prefix` string — An optional element that comes before the street name. Validations: - Length between 0 and 20 - `province` string — The administrative division within a country, larger than a region or district. Validations: - Length between 0 and 100 - `region` string — A broader geographical area, often grouping multiple provinces or states. Validations: - Length between 0 and 100 - `state` string — A major administrative division within a country. Validations: - Length between 0 and 100 - `suffix` string — An optional element that comes after the street name. Validations: - Length between 0 and 20 - `company_number` string - `contact_details` OnboardingContactDetails - `certified_email` string — Certified email address used for official or legal communications, often required in specific jurisdictions. - `email` string — Primary email address for contacting the company. Validations: - Length between 0 and 250 - Must be a valid email address. - `phone_number` string — Primary phone number for reaching the company. Validations: - Length between 0 and 250 - `website` string — Official website URL of the company. Validations: - Length between 0 and 250 - `documents_reception_context` DocumentsReceptionContext - `reception_enabled` boolean — Indicates whether document reception is enabled. - `legal_name` string - `logo` string — url of the logo to be used in invoice documents for this company - `meta` OnboardingCompanyMetaPatch - `language_code` string - `transaction_purposes` string[] — Workflow operations this company may be used for (e.g. ta_notification, document_generation). - `tax_credentials` OnboardingTaxCredentialsRequest - `certificate_base64` string — Base64-encoded string representing the certificate issued by the Tax Authority, used for authentication. - `certificate_password` string, required — Password used to unlock the certificate for authentication purposes. Validations: - Must not be empty when no certificate private key is provided. - Length between 0 and 250 - `certificate_private_key_base64` string, required — Base64-encoded private key corresponding to the certificate, required for secure authentication. Validations: - Must not be empty when no certificate password is provided. - `certificate_type` string — Specifies the type or format of the certificate, such as PKCS#12 or X.509. Validations: - Length between 0 and 50 - `password` string — Password associated with the provided username for authentication. Validations: - Length between 0 and 2048 - `pin` string — Personal Identification Number (PIN) required for additional security during authentication. Validations: - Length between 0 and 2048 - `username` string — Username used to authenticate with the Tax Authority. Validations: - Length between 0 and 100 - `tax_information` OnboardingTaxInformation - `activity_code` string — Code representing the business activity of the entity. - `additional_tax_numbers` OnboardingTaxNumberCountrySpecific[] — Additional tax numbers used by the business entity in domestic or foreign operations. Validations: - The provided additional tax number items must not contain conflicting business models for the same country and/or subdivision code. Each business model can only appear once per country or subdivision code. - `business_model` string[] — Specifies the business model under which the company operates, such as B2B (Business-to-Business) or B2C (Business-to-Consumer). Validations: - Must be empty or contain one or more of the following values: B2B, B2C - `country_code` string, required — ISO 3166-1 two-letter country code representing the country where the tax number is registered. Validations: - Country code must be uppercase ISO 3166-1 alpha-2. - Required property - `country_subdivision_code` string — Code representing a specific subdivision within the country, such as a state or province. Validations: - Exact length: 2 - `tax_number` string, required — The specific tax identification number assigned to the company for the specified country. Validations: - Length between 0 and 50 - Required property - `type` string — Indicates the type of tax number. Currently unsupported for onboarding. Validations: - This field is only supported in specific use cases, refer to country-specific integration guides in the Fonoa dashboard. - `authorization_code` string — Code provided by tax authorities to authorize tax-related activities. - `billing_file_number` string — Unique number assigned to the company’s billing file. - `cash_vat_scheme` boolean — Indicates whether the company is under the cash VAT scheme. - `device_id` string — Identifier for the device used in tax reporting or invoicing systems. - `document_type` string — Type of tax-related document issued or managed by the company. - `eac_code` string — Economic Activity Code representing the nature of business activities. - `point_of_sale` string — Code representing the company’s point of sale location or terminal. - `regime` string — The tax regime under which the company operates. Validations: - Length between 0 and 10 - `tax_code` string — Tax code that complements the tax number. - `tax_number` string — Tax identification number of the company. Validations: - Length between 0 and 50 - `template_configuration` OnboardingTemplateConfiguration - `color` string, required — The hexadecimal color value used for the invoice - example: 293d62 Validations: - Required property - Invalid HEX color format provided. - `font` string, required — The font used for the invoice. Some of the supported fonts include Abhaya Libre, Helvetica World, Hind, Lora, Open Sans, Rubik, among others. If you wish to have your own font please reach out to Fonoa support. Validations: - Required property - `logo_placement` string, required — Where on the invoice your logo will be placed - left or right Validations: - Required property - Values allowed are (letter case matters): left, right ## Response `200` Ok - company was updated successfully. - ApiResponseWrapperCompanyResponse - `data` OnboardingCompanyResponse - `activations` OnboardingActivationResponse[] - `status` string — Represents the current activation status. Valid values include: `ACTIVATION_PENDING`, `ACTIVE`, `DEACTIVATION_PENDING`, and `FAILED`. - `transaction_purpose` string — Indicates the purpose of the transaction associated with this activation. Possible values are `ta_notification` and `document_exchange`. - `url` string — A direct URL that the user should visit to complete or verify the activation process. - `address` OnboardingAddress - `address_line_1` string — The primary street address, including street name and house/building number. Validations: - Length between 0 and 450 - `address_line_2` string — Additional address details, such as apartment, suite, or floor number. Validations: - Length between 0 and 450 - `canton` string — A territorial division, commonly used in countries like Switzerland. Validations: - Length between 0 and 100 - `city` string — The municipality or urban area where the company is located. Validations: - Length between 0 and 100 - `city_code` string — A numerical or alphanumerical code representing the city. Validations: - Length between 0 and 20 - `country_code` string, required — Address country where the entity is registered. Country code must be in ISO 3166-1 two-letter format. Validations: - Required property - Exact length: 2 - `district` string — A smaller administrative unit within a province, state, or region. Validations: - Length between 0 and 100 - `neighbourhood` string — A specific area or locality within a city or town. Validations: - Length between 0 and 100 - `number` string — The specific number of the building or property on the street. Validations: - Length between 0 and 20 - `postal_code` string — The code used by postal services to identify specific delivery areas. Validations: - Length between 0 and 100 - `prefix` string — An optional element that comes before the street name. Validations: - Length between 0 and 20 - `province` string — The administrative division within a country, larger than a region or district. Validations: - Length between 0 and 100 - `region` string — A broader geographical area, often grouping multiple provinces or states. Validations: - Length between 0 and 100 - `state` string — A major administrative division within a country. Validations: - Length between 0 and 100 - `suffix` string — An optional element that comes after the street name. Validations: - Length between 0 and 20 - `company_number` string — Company’s local identification number, usually identical to TIN. - `contact_details` OnboardingContactDetails - `certified_email` string — Certified email address used for official or legal communications, often required in specific jurisdictions. - `email` string — Primary email address for contacting the company. Validations: - Length between 0 and 250 - Must be a valid email address. - `phone_number` string — Primary phone number for reaching the company. Validations: - Length between 0 and 250 - `website` string — Official website URL of the company. Validations: - Length between 0 and 250 - `created_at` string — The date at which the company was successfully onboarded. - `documents_reception_context` DocumentsReceptionContext - `reception_enabled` boolean — Indicates whether document reception is enabled. - `establishment_date` string — The date when the company was established or business activity started. Establishment Date should be in ISO8601 standard. - `id` string — The Fonoa identifier for the company. - `legal_form` string — Legal form of the company, complementing legal_name. e.g. SARL AU CAPITAL DE 50 000 EUROS. - `legal_name` string — The legal name of the onboarded entity. - `logo` string — url of the logo to be used in invoice documents for this company - `meta` OnboardingMeta - `country_code` string, required — Specifies the country of the entity that needs to be onboarded. Country code must be in ISO 3166-1 two-letter format (e.g, us, de, fr, etc.) Validations: - Required property - Length ({{.actual}}) must be {{.max}} characters long. - Country code must be ISO 3166-1 alpha-2. - `external_id` string — An additional reference identifier you can provide - typically, the identifier used in your own system. Used for idempotency and available in the Fonoa dashboard - `language_code` string — Specifies the language of the entity that needs to be onboarded. Language code must be in ISO 639-1 two-letter format (e.g, en, de, fr, etc.) - `transaction_purposes` string[] — Workflow operations this company may be used for (e.g. ta_notification, document_generation). Validations: - Must contain one or more of: document_generation, ta_notification, data_access, record_to_report - `webhook` string - `registration_place` string — Official register and place where the company is recorded, e.g. RCS Paris (FR), Amtsgericht München (DE). - `representative_email` string - `representative_name` string - `tax_credentials` OnboardingTaxCredentialsResponse - `certificate_type` string - `issuer` string - `owner` string - `username` string - `valid_from` string - `valid_to` string - `verified` boolean - `tax_information` OnboardingTaxInformation - `activity_code` string — Code representing the business activity of the entity. - `additional_tax_numbers` OnboardingTaxNumberCountrySpecific[] — Additional tax numbers used by the business entity in domestic or foreign operations. Validations: - The provided additional tax number items must not contain conflicting business models for the same country and/or subdivision code. Each business model can only appear once per country or subdivision code. - `business_model` string[] — Specifies the business model under which the company operates, such as B2B (Business-to-Business) or B2C (Business-to-Consumer). Validations: - Must be empty or contain one or more of the following values: B2B, B2C - `country_code` string, required — ISO 3166-1 two-letter country code representing the country where the tax number is registered. Validations: - Country code must be uppercase ISO 3166-1 alpha-2. - Required property - `country_subdivision_code` string — Code representing a specific subdivision within the country, such as a state or province. Validations: - Exact length: 2 - `tax_number` string, required — The specific tax identification number assigned to the company for the specified country. Validations: - Length between 0 and 50 - Required property - `type` string — Indicates the type of tax number. Currently unsupported for onboarding. Validations: - This field is only supported in specific use cases, refer to country-specific integration guides in the Fonoa dashboard. - `authorization_code` string — Code provided by tax authorities to authorize tax-related activities. - `billing_file_number` string — Unique number assigned to the company’s billing file. - `cash_vat_scheme` boolean — Indicates whether the company is under the cash VAT scheme. - `device_id` string — Identifier for the device used in tax reporting or invoicing systems. - `document_type` string — Type of tax-related document issued or managed by the company. - `eac_code` string — Economic Activity Code representing the nature of business activities. - `point_of_sale` string — Code representing the company’s point of sale location or terminal. - `regime` string — The tax regime under which the company operates. Validations: - Length between 0 and 10 - `tax_code` string — Tax code that complements the tax number. - `tax_number` string — Tax identification number of the company. Validations: - Length between 0 and 50 - `template_configuration` OnboardingTemplateConfiguration - `color` string, required — The hexadecimal color value used for the invoice - example: 293d62 Validations: - Required property - Invalid HEX color format provided. - `font` string, required — The font used for the invoice. Some of the supported fonts include Abhaya Libre, Helvetica World, Hind, Lora, Open Sans, Rubik, among others. If you wish to have your own font please reach out to Fonoa support. Validations: - Required property - `logo_placement` string, required — Where on the invoice your logo will be placed - left or right Validations: - Required property - Values allowed are (letter case matters): left, right - `trade_name` string - `transactions_summary_totals` TransactionsSummary[] — Summary of transactions processed for the company within the provided reporting_date period. Available when filtering for Account Payable companies. - `count` integer — Number of successfully processed transactions. - `currency_code` string — The currency code used for the amounts, in ISO 4217 format (e.g., USD, EUR). - `total_amount` number — Represents the invoice total, i.e. the absolute value of the total_net_amount + total_tax_amount - `total_net_amount` number — Total amount excl. Tax. Represents the sum of all 'Net Total amounts per item'. - `total_tax_amount` number — The absolute value of the Tax amount. Sum of all `tax_breakdown[].amount` - `updated_at` string — The date at which the company was last updated through a PATCH request. Returns `null` if no updates were performed. - `errors` ErrorResponse[] — List of errors for request. Returns `null` if it is successful. - `code` string — Code describing the error. - `doc_link` string — The link for the error documentation. Follow it to gather more details about the error - `field` string — A validation error can specify the field that generated that error. - `message` string — Detailed message containing information on how to resolve the error. - `type` string — Type of error: validation, tax_authority, warning, general, unknown. - `message` string - `status` string — The status of the request. ## Other responses - `400` — Bad customer request - the required field 'id' was not provided. - `401` — Authentication failed - missing or incorrect subscription key. - `404` — Company with the provided 'id' was not found. - `429` — Too many requests were sent for a short period of time. Try again a bit later. - `5XX` — Internal server error. Its not you, its us! We are experiencing a rare and unexpected system disruption. Retry again later. The message field of the response will contain more information for the cause. Feel free to contact us. --- [API](https://skmtc.net/fonoa/apis/fonoa-api.md) · [All operations](https://skmtc.net/fonoa/apis/fonoa-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/fonoa/fonoa-api/versions/cf0ebc843a3f/schema)