# Atualiza as configurações do ERP

Atualiza as configurações do ERP.

Endpoint: PATCH /api/v3/settings/erp
Version: 3.0.0
Security: OAuth2

## Header parameters:

  - `CPlug-Company-Id` (number, required)
    Id da Empresa (Company).

Você pode localizar os IDs das empresas no _endpoint_ de listagem de empresas.
    Example: 12

  - `Idempotency-Key` (string, required)
    UUID aleatório gerado por você. Nós utilizamos esse header para evitar duplicidade de registros, ou seja, caso você não tenha recebido a resposta de alguma requisição e mandar o mesmo UUID, nós não duplicaremos o registro.

## Request fields (application/json):

  - `news` (object, required)
    Representa uma configuração da novidade.

  - `news.is_enabled` (boolean, required)
    Habilita ou desabilita o recebimento das novidades da ConnectPlug.
    Example: true

  - `consumption_sheet` (object, required)
    Representa as configurações da ficha de consumo.

  - `consumption_sheet.is_enabled` (boolean, required)
    Habilita ou desabilita as fichas de consumo de produtos.
    Example: true

  - `consumption_sheet.expiration_settings` (object)
    Representa as configurações gerais de validade das fichas. 
Configuração geral da validades das fichas de consumo. A validade é dada da soma do período 
configurado aqui com a data da venda do produto.

Este campo dever ser enviado caso as fichas de consumo esteja habilitado

  - `consumption_sheet.expiration_settings.period_unit` (string, required)
    Tipo da unidade:

- no_expiration sem validade
- months meses
- days dias
- hours horas
- minutes minutos
    Enum: "no_expiration", "months", "days", "hours", "minutes"

  - `consumption_sheet.expiration_settings.amount` (integer, required)
    Quantidade.
    Example: 15

  - `user_session` (object, required)
    Representa uma configuração da sessão do usuário.

  - `user_session.allow_simultaneous_access` (boolean, required)
    Habilita ou desabilita o acessos simultâneos do mesmo usuário.

Se essa opção estiver habilitada cada usuário só pode acessar em um lugar por vez.

Exemplo: Se um usuário já estiver acessando pelo Computador A e tentar acessar pelo Computador B,
automaticamente o usuário será deslogado do Computador A.

  - `product_category` (object, required)
    Representa uma configuração da categoria do produto.

  - `product_category.is_required_select_product_category` (boolean, required)
    Habilita ou desabilita a obrigação de selecionar uma categoria no cadastro de produtos.
    Example: true

  - `stock` (object, required)
    Representa uma configuração do estoque.

  - `stock.allow_product_value_changes` (boolean, required)
    Habilita ou desabilita a Possibilidade de alteração do valor de venda do 
produto no registro de movimentações de entrada e compra.
    Example: true

  - `stock.recount_settings` (object, required)
    Representa uma configuração da conferência de estoque.

  - `stock.recount_settings.is_restrict_entry_nfe` (boolean, required)
    Habilita ou desabilita a conferência da NF-e de entrada restrita.

Na conferência restrita, ao realizar os lançamentos correspondentes à nota fiscal, 
observa-se a ausência de exibição de determinados itens. Somente são apresentados os 
elementos para os quais a leitura foi efetivamente realizada.
    Example: true

  - `stock.recount_settings.is_partial_entry_nfe` (boolean, required)
    Habilita ou desabilita a entrada parcial na NF-e de entrada.

Permite realizar a entrada do estoque do item da nota fiscal sem a necessidade de finalizar a nota.
    Example: true

  - `stock.recount_settings.can_edit_recounted_item` (boolean)
    Habilita ou desabilita a edição da quantidade de item conferido.

Permite a edição da quantidade de um item já conferido da nota fiscal.
    Example: true

  - `stock.recount_settings.limit_barcode_length` (integer, required)
    Quantidade máxima de caracteres identificado no código de barras.

Solicita-se a definição da quantidade desejada de caracteres para a leitura do código de 
barras durante o processo de conferência. Por exemplo, ao inserir o código 123456789012300000 e 
especificar uma leitura de 13 caracteres, a busca será realizada com base apenas nos primeiros 
13 dígitos (1234567890123). Se o valor for definido como zero, essa regra será ignorada.
    Example: 8

  - `stock.recount_settings.show_nfe_product_amount` (boolean, required)
    Habilita ou desabilita a exibição da quantidade dos produtos na nota.

Disponível apenas no modo leitura rápida.
    Example: true

  - `stock.recount_settings.recount_mode` (string)
    Modo de conferência de produto

- both ambos
- qty_in_nfe Quantidade na NF-e
- qty_separate Quantidade avulsa: Quantidade da NF-e * fator de conversão.
    Enum: "both", "qty_in_nfe", "qty_separate"

  - `stock.recount_settings.damage_record_mode` (string)
    Modo de registro de avaria

- both ambos
- qty_in_nfe Quantidade na NF-e
- qty_separate Quantidade avulsa: Quantidade da NF-e * fator de conversão.
    Enum: "both", "qty_in_nfe", "qty_separate"

  - `supplier` (object)
    Representa uma configuração do fornecedor.

Atenção: Esta configuração só pode ser enviada caso o usuário possuir mais de uma empresa, nesse caso, é obrigatório.

  - `supplier.enable_new_suppliers_for_all_companies` (boolean, required)
    Define se deve disponibilizar os novos fornecedores cadastrados na empresa atual para todas as empresas.
    Example: true

  - `supplier.company_ids` (array)
    Lista de IDs das empresas associadas à configuração do fornecedor.

Obs: Campo obrigatório quando enable_new_suppliers_for_all_companies = false.
    Example: [1,2,3]

  - `carrier` (object)
    Representa uma configuração do fornecedor.

Atenção: Esta configuração só pode ser enviada caso o usuário possuir mais de uma empresa, nesse caso, é obrigatório.

  - `carrier.enable_new_carriers_for_all_companies` (boolean, required)
    Define se deve disponibilizar as novas transportadoras cadastradas na empresa atual para todas as empresas.
    Example: true

  - `customer` (object, required)
    Representa uma configuração de clientes.

  - `customer.required_fields_to_register` (object)
    Representa uma configuração dos campos obrigatório no cadastro de cliente/empresas.

  - `customer.required_fields_to_register.company` (array)
    Tipo de campos obrigatórios da empresa

- address: Endereço
- birthday: Data de Nascimento
- customer_category_id: Categoria
- email: E-mail
- identifier: Identificador
- ie: Inscrição Estadual
- cnpj: CNPJ
- company_name: Razão Social
- main_phone: Telefone Comercial
- mobile_phone: Telefone Celular
    Enum: "address", "birthday", "customer_category_id", "email", "identifier", "ie", "cnpj", "company_name", "main_phone", "mobile_phone"

  - `customer.required_fields_to_register.customer` (array)
    Tipo de campos obrigatórios do cliente

- address: Endereço
- birthday: Data de Nascimento
- cpf: CPF
- customer_category_id: Categoria
- email: E-mail
- gender: Gênero
- identifier: Identificador
- main_phone: Telefone Comercial
- mobile_phone: Telefone Celular
- rg: RG
    Enum: "address", "birthday", "cpf", "customer_category_id", "email", "gender", "identifier", "main_phone", "mobile_phone", "rg"

  - `customer.is_allowed_provide_new_customer_for_all_companies` (boolean)
    Define se deve disponibilizar os novos clientes cadastrados na empresa atual para todas as empresas.
    Example: true

  - `customer.company_ids` (array)
    Lista de IDs das empresas associadas à configuração.
    Example: [1,2,3]

  - `customer.is_enabled_notify_sync_customer` (boolean)
    Notificar os servidores ao cadastrar/atualizar os clientes no PDV 2.0

Ao marcar sempre que houver uma atualização no Cliente será enviado uma atualização para o servidor das empresas selecionadas no compartilhamento.
    Example: true

  - `integration` (object, required)
    Representa uma configuração da novidade.

  - `integration.is_allowed_system_generate_secure_integration_key` (boolean, required)
    Permitir que o sistema gere uma chave de integração mais segura

Se essa opção estiver habilitada a chave de integração será alterada para um modelo mais seguro nas exportações.

Atenção: Muito cuidado ao habilitar essa configuração, pois caso possua produtos integrados com a chave antiga o sistema ira perder referência e cadastrar um novo produto na integração!

Entre em contato com o suporte antes de realizar a alteração
    Example: true

## Response 200 fields (application/json):

  - `data` (object)
    Representa uma configurações do ERP.

  - `data.news` (object, required)
    Representa uma configuração da novidade.

  - `data.news.is_enabled` (boolean, required)
    Habilita ou desabilita o recebimento das novidades da ConnectPlug.
    Example: true

  - `data.consumption_sheet` (object, required)
    Representa as configurações da ficha de consumo.

  - `data.consumption_sheet.is_enabled` (boolean, required)
    Habilita ou desabilita as fichas de consumo de produtos.
    Example: true

  - `data.consumption_sheet.expiration_settings` (object)
    Representa as configurações gerais de validade das fichas. 
Configuração geral da validades das fichas de consumo. A validade é dada da soma do período 
configurado aqui com a data da venda do produto.

Este campo dever ser enviado caso as fichas de consumo esteja habilitado

  - `data.consumption_sheet.expiration_settings.period_unit` (string, required)
    Tipo da unidade:

- no_expiration sem validade
- months meses
- days dias
- hours horas
- minutes minutos
    Enum: "no_expiration", "months", "days", "hours", "minutes"

  - `data.consumption_sheet.expiration_settings.amount` (integer, required)
    Quantidade.
    Example: 15

  - `data.user_session` (object, required)
    Representa uma configuração da sessão do usuário.

  - `data.user_session.allow_simultaneous_access` (boolean, required)
    Habilita ou desabilita o acessos simultâneos do mesmo usuário.

Se essa opção estiver habilitada cada usuário só pode acessar em um lugar por vez.

Exemplo: Se um usuário já estiver acessando pelo Computador A e tentar acessar pelo Computador B,
automaticamente o usuário será deslogado do Computador A.

  - `data.product_category` (object, required)
    Representa uma configuração da categoria do produto.

  - `data.product_category.is_required_select_product_category` (boolean, required)
    Habilita ou desabilita a obrigação de selecionar uma categoria no cadastro de produtos.
    Example: true

  - `data.stock` (object, required)
    Representa uma configuração do estoque.

  - `data.stock.allow_product_value_changes` (boolean, required)
    Habilita ou desabilita a Possibilidade de alteração do valor de venda do 
produto no registro de movimentações de entrada e compra.
    Example: true

  - `data.stock.recount_settings` (object, required)
    Representa uma configuração da conferência de estoque.

  - `data.stock.recount_settings.is_restrict_entry_nfe` (boolean, required)
    Habilita ou desabilita a conferência da NF-e de entrada restrita.

Na conferência restrita, ao realizar os lançamentos correspondentes à nota fiscal, 
observa-se a ausência de exibição de determinados itens. Somente são apresentados os 
elementos para os quais a leitura foi efetivamente realizada.
    Example: true

  - `data.stock.recount_settings.is_partial_entry_nfe` (boolean, required)
    Habilita ou desabilita a entrada parcial na NF-e de entrada.

Permite realizar a entrada do estoque do item da nota fiscal sem a necessidade de finalizar a nota.
    Example: true

  - `data.stock.recount_settings.can_edit_recounted_item` (boolean)
    Habilita ou desabilita a edição da quantidade de item conferido.

Permite a edição da quantidade de um item já conferido da nota fiscal.
    Example: true

  - `data.stock.recount_settings.limit_barcode_length` (integer, required)
    Quantidade máxima de caracteres identificado no código de barras.

Solicita-se a definição da quantidade desejada de caracteres para a leitura do código de 
barras durante o processo de conferência. Por exemplo, ao inserir o código 123456789012300000 e 
especificar uma leitura de 13 caracteres, a busca será realizada com base apenas nos primeiros 
13 dígitos (1234567890123). Se o valor for definido como zero, essa regra será ignorada.
    Example: 8

  - `data.stock.recount_settings.show_nfe_product_amount` (boolean, required)
    Habilita ou desabilita a exibição da quantidade dos produtos na nota.

Disponível apenas no modo leitura rápida.
    Example: true

  - `data.stock.recount_settings.recount_mode` (string)
    Modo de conferência de produto

- both ambos
- qty_in_nfe Quantidade na NF-e
- qty_separate Quantidade avulsa: Quantidade da NF-e * fator de conversão.
    Enum: "both", "qty_in_nfe", "qty_separate"

  - `data.stock.recount_settings.damage_record_mode` (string)
    Modo de registro de avaria

- both ambos
- qty_in_nfe Quantidade na NF-e
- qty_separate Quantidade avulsa: Quantidade da NF-e * fator de conversão.
    Enum: "both", "qty_in_nfe", "qty_separate"

  - `data.supplier` (object)
    Representa uma configuração do fornecedor.

Atenção: Esta configuração só pode ser enviada caso o usuário possuir mais de uma empresa, nesse caso, é obrigatório.

  - `data.supplier.enable_new_suppliers_for_all_companies` (boolean, required)
    Define se deve disponibilizar os novos fornecedores cadastrados na empresa atual para todas as empresas.
    Example: true

  - `data.supplier.companies` (array)
    Lista de empresas associadas à configuração do fornecedor.

  - `data.supplier.companies.id` (integer)
    Identificador único da empresa
    Example: 1234

  - `data.supplier.companies.name` (string)
    Nome fantasia da empresa.
    Example: "CPlug"

  - `data.supplier.companies.company_name` (string,null)
    Razão social da empresa.
    Example: "CPlug Tecnologia da Informação"

  - `data.carrier` (object)
    Representa uma configuração do fornecedor.

Atenção: Esta configuração só pode ser enviada caso o usuário possuir mais de uma empresa, nesse caso, é obrigatório.

  - `data.carrier.enable_new_carriers_for_all_companies` (boolean, required)
    Define se deve disponibilizar as novas transportadoras cadastradas na empresa atual para todas as empresas.
    Example: true

  - `data.customer` (object, required)
    Representa uma configuração de clientes.

  - `data.customer.required_fields_to_register` (object)
    Representa uma configuração dos campos obrigatório no cadastro de cliente/empresas.

  - `data.customer.required_fields_to_register.company` (array)
    Tipo de campos obrigatórios da empresa

- address: Endereço
- birthday: Data de Nascimento
- customer_category_id: Categoria
- email: E-mail
- identifier: Identificador
- ie: Inscrição Estadual
- cnpj: CNPJ
- company_name: Razão Social
- main_phone: Telefone Comercial
- mobile_phone: Telefone Celular
    Enum: "address", "birthday", "customer_category_id", "email", "identifier", "ie", "cnpj", "company_name", "main_phone", "mobile_phone"

  - `data.customer.required_fields_to_register.customer` (array)
    Tipo de campos obrigatórios do cliente

- address: Endereço
- birthday: Data de Nascimento
- cpf: CPF
- customer_category_id: Categoria
- email: E-mail
- gender: Gênero
- identifier: Identificador
- main_phone: Telefone Comercial
- mobile_phone: Telefone Celular
- rg: RG
    Enum: "address", "birthday", "cpf", "customer_category_id", "email", "gender", "identifier", "main_phone", "mobile_phone", "rg"

  - `data.customer.is_allowed_provide_new_customer_for_all_companies` (boolean)
    Define se deve disponibilizar os novos clientes cadastrados na empresa atual para todas as empresas.
    Example: true

  - `data.customer.companies` (array)
    Lista de empresas associadas à configuração.

  - `data.customer.is_enabled_notify_sync_customer` (boolean)
    Notificar os servidores ao cadastrar/atualizar os clientes no PDV 2.0

Ao marcar sempre que houver uma atualização no Cliente será enviado uma atualização para o servidor das empresas selecionadas no compartilhamento.
    Example: true

  - `data.integration` (object, required)
    Representa uma configuração da novidade.

  - `data.integration.is_allowed_system_generate_secure_integration_key` (boolean, required)
    Permitir que o sistema gere uma chave de integração mais segura

Se essa opção estiver habilitada a chave de integração será alterada para um modelo mais seguro nas exportações.

Atenção: Muito cuidado ao habilitar essa configuração, pois caso possua produtos integrados com a chave antiga o sistema ira perder referência e cadastrar um novo produto na integração!

Entre em contato com o suporte antes de realizar a alteração
    Example: true

## Response 400 fields (application/json):

  - `code` (string, required)
    Código de erro.
    Example: "missing_headers"

  - `message` (string)
    Descrição do erro.
    Example: "error message"

  - `meta` (array)
    Dados adicionais sobre o erro.

## Response 422 fields (application/json):

  - `code` (string, required)
    Código de erro.
    Example: "uneditable_entity"

  - `message` (string)
    Descrição do erro.
    Example: "description error"

  - `meta` (array)
    Dados adicionais sobre o erro.

  - `meta.field` (string, required)
    Nome do campo no qual existe um erro de validação.
    Example: "name"

  - `meta.validations` (array)

  - `meta.validations.type` (string, required)
    Tipo da validação aplicada.
    Example: "Required"

  - `meta.validations.value` (array)
    Tipo de valor aplicável (esse campo pode ser vazio).


## Response 401 fields

## Response 404 fields