Atualizar dados da Empresa

Esse endpoint permite realizar atualizações de dados cadastrais de uma determinada Empresa cadastrada para o Originador.

Parâmetros da URL

  • business_id:ID (uuid) da Empresa a ter os dados atualizados.

Parâmetros da Requisição

  • id (string uuid): Identificador único do cadastro da Empresa.
  • taxpayer_id (string): O nº do CNPJ da empresa.
  • legal_name (string): A razão social da empresa.
  • name (string): O nome fantasia da empresa.
  • email_address(string): Campo do e-mail para contato com a Empresa.
  • foundation_date(string): Data de abertura/registro da Empresa na Receita Federal.
  • phone(objeto): Objeto contendo o número do telefone para contato com a empresa.
    • area_code(string): Campo do código da área (DDD).
    • country_code(string): Código Internacional para identificação do país (DDI).
    • number(string): Número do telefone, somente os números.
    • formatted_number(string): Número do telefone formatado.
  • incorporation_type(string): Regime legal da Empresa cadastrado na Receita Federal.
  • tax_regime(string): Regime tributário da Empresa.
  • industry_classification(string): Classificação para a área de atuação da Empresa (CNAE).
  • address(objeto): Objeto contendo os dados do endereço da Empresa.
    • street_name(string): Nome do logradouro do endereço.
    • street_number(integer): Númeração do endereço.
    • extra_info(string): Campo de dados adicionais, complemento, do Endereço.
    • district(string): Bairro do endereço.
    • city(string): Cidade do endereço.
    • postal_code (string): Código de CEP para o endereço.
    • state_code(string): Sigla para identificação do estado/uf.
    • country_code(string): Código do país.
  • pix (object): Objeto contendo os dados de uma chave PIX.
    • key (string): Chave PIX.
    • key_type (string): Tipo da chave PIX.
  • external_bank_account (object): Objeto contendo os dados bancários.
    • bank_code (string): Código do banco.
    • bank_account (string): Número da conta
    • bank_account_digit (string): Dígito do número da conta.
    • bank_branch (string): Número da agência.
    • bank_account_type (string): Tipo da conta bancária.
    • ispb_code (string): Código da Instituição recebedora no Sistema de Pagamentos Instantâneo.
  • billing_address(objeto): Objeto contendo os dados do endereço da Empresa para cobrança.
    • street_name(string): Nome do logradouro do endereço.
    • street_number(integer): Númeração do endereço.
    • extra_info(string): Campo para dados adicionais, complemento, do Endereço.
    • district(string): Bairro do endereço.
    • city(string): Cidade do endereço.
    • postal_code (string): Código de CEP para o endereço.
    • state_code(string): Sigla para identificação do estado/uf.
    • country_code(string): Código do país.
  • share_capital(float): Capital social da eEmpresa.
  • monthly_revenue(float): Faturamento mensal estimado para a Empresa.
  • employer(boolean): Campo booleano que indica se essa empresa deve suportar ou não o cadastro de colaboradores vinculados a ela.
  • custom_variables(objeto): Objeto contendo valores de variáveis personalizadas, no formato de "chave e valor".
  • created_at : Data e hora que o registro da Empresa foi criado.
  • version : Identificador da versão do cadastro da Empresa.

Resposta

Se a requisição for aceita e processada com sucesso, a resposta inclui um código 200 e um objeto Json contendo os detalhes dos dados da empresa atualizada, no seguinte formato:

Exemplo:

{ "id": "", "legal_name": "", "taxpayer_id": "", "phone": { "country_code": "", "area_code": "", "number": "", "formatted_number": "" }, "incorporation_type": "", "tax_regime": "", "industry_classification": "", "name": "", "email_address": "", "foundation_date": "", "address": { "street_name": "", "street_number": 0, "postal_code": "", "district": "", "city": "", "state_code": "", "country_code": "", "extra_info": null }, "pix": { "key": "", "key_type": "" }, "external_bank_account": { "bank_code": "", "bank_account": "", "bank_account_digit": "", "bank_branch": "", "bank_account_type": null, "ispb_code": null }, "custom_variables": {}, "created_at": "", "updated_at": "", "version": 0, "billing_address": { "street_name": "", "street_number": 0, "postal_code": "", "district": "", "city": "", "state_code": "", "country_code": "", "extra_info": "" }, "share_capital": 0, "monthly_revenue": 0, "employer": true }
Log in to see full request history
timestatususer agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Body Params
Headers
string
string
Responses

Language
URL
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/plain
English
Powered by Localize
Português (Brasil)