# Atualiza as configurações gerais da NFe Atualiza as configurações fiscais gerais de NFe da empresa. Regras de validação: - Ao menos um objeto deve ser enviado no PATCH - Se is_state_registration_exempt for true, state_registration deve ser vazio ou null - Para remover os xml_authorizeds deve ser enviado um array vazio, se não enviar nada não será atualizado - state_registration_st, além de seguir o mesmo princípio de remoção do xml_authorizeds, não pode enviar estados repetidos - transaction_intermediaries também segue a mesma lógica de remoção do xml_authorizeds - Em payment_settings, se enviar state é obrigatório enviar os dois outros campos. Se state for null ou vazio os outros campos devem ser null ou vazios também, sendo proibido algum valor para eles Endpoint: PATCH /api/v3/tax-settings/general-settings 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 ## Request fields (application/json): - `tributary_settings` (object) Configurações gerais tributárias da empresa para atualização. - `tributary_settings.tax_regime_id` (integer) Regime tributário: - 1: Simples Nacional - 2: Simples Nacional, excesso sublimite de receita bruta - 3: Regime Normal - 4: Simples Nacional - Microempreendedor Individual Example: 1 - `tributary_settings.is_state_registration_exempt` (boolean) Indica se a empresa é isenta de inscrição estadual. Example: true - `tributary_settings.state_registration` (string) Inscrição estadual da empresa. Deve ser vazio ou nulo se for isenta. - `tributary_settings.municipal_registration` (string) Inscrição municipal da empresa. - `tax_settings` (object) Configurações específicas de impostos e tributos para NF-e para atualização. - `tax_settings.nfe_environment` (string) Ambiente da NFe (produção ou homologação). Enum: "production", "homologation" - `tax_settings.end_consumer_operation_default` (string) Operação padrão para consumidor final. Enum: "normal", "end_consumer" - `tax_settings.buyer_presence_indicator_id` (integer) ID do indicador de presença do comprador: - 0: Não se aplica - 1: Operação presencial - 2: Operação não presencial, pela Internet - 3: Operação não presencial, Teleatendimento - 4: NFC-e em operação com entrega em domicílio - 5: Operação presencial, fora do estabelecimento - 9: Operação não presencial, outros - `tax_settings.include_freight_in_pis_calculation` (boolean) Incluir frete no cálculo do PIS. - `tax_settings.include_freight_in_cofins_calculation` (boolean) Incluir frete no cálculo do COFINS. - `tax_settings.include_ipi_in_icms_calculation` (boolean) Incluir IPI no cálculo do ICMS. Example: true - `tax_settings.is_default_customer_icms_taxpayer` (boolean) Cliente padrão é contribuinte do ICMS. Example: true - `tax_settings.credit_calculation_rate` (number) Alíquota aplicável no cálculo do crédito. Example: 12.45 - `tax_settings.pix_payment_code` (string) Código de pagamento PIX: - "17": Pagamento Instantâneo (PIX) - "99": Outros Importante: - Campo permitido apenas para empresas cujo endereço seja de SP e CE. Example: "17" - `authentication_settings` (object) Configurações de autenticação para NFCe (CSC Token) para atualização. - `authentication_settings.csc_token` (string) Token CSC (Código de Segurança do Contribuinte). - `authentication_settings.token_id` (string) ID do token CSC. - `standard_justifications` (object) Textos padrão para justificativas de cancelamento, inutilização e contingência para atualização. - `standard_justifications.unusability` (string) Texto padrão para inutilização de NFe. Example: "Texto padrão para inutilização" - `standard_justifications.cancelation` (string) Texto padrão para cancelamento de NFe. Example: "Texto padrão para cancelamento" - `standard_justifications.contingency` (string) Texto padrão para contingência de NFe. Example: "Texto padrão para contingência" - `access_settings` (object) Configurações de acesso e autorização para NFe para atualização. - `access_settings.allow_accountant_invalidate_invoices` (boolean) Permite ao contador invalidar faturas. Example: true - `access_settings.xml_authorizeds` (array) Lista de pessoas autorizadas a baixar XML da NFe/NFCe. Para remover todos os autorizados, envie um array vazio. Se não enviado, nada será alterado. - `access_settings.xml_authorizeds.type` (string, required) Tipo do documento (CPF ou CNPJ). Enum: "cnpj", "cpf" - `access_settings.xml_authorizeds.identify` (string, required) CPF ou CNPJ da pessoa autorizada. Example: "30398117000136" - `access_settings.shipping_modality_for_pos_id` (integer) ID da modalidade de frete: - 0: Contratação do Frete por conta do Remetente (CIF) - 1: Contratação do Frete por conta do Destinatário (FOB) - 2: Contratação do Frete por conta de Terceiros - 3: Transporte Próprio por conta do Remetente - 4: Transporte Próprio por conta do Destinatário - 9: Sem frete - `nfce_service_fees` (object) Configurações de taxas de serviço para NFCe. - `nfce_service_fees.tax_service_or_waiter_charge` (string) Tipo de taxa de serviço ou garçom. Enum: "tip", "other_expenses" - `product_informations` (object) Configurações de informações adicionais dos produtos. - `product_informations.add_batch` (boolean) Adicionar lote. - `product_informations.add_expiration_date` (boolean) Adicionar data de validade. - `product_informations.add_barcode_in_invoice` (boolean) Adicionar código de barras. Importante: - Se essa opção estiver habilitada, o GTIN será incluído na tag cEAN. O código GTIN deverá ser um valor válido no portal CCG-Cadastro Centralizado de GTIN, caso contrário acontecerá uma rejeição. - `sending_documents` (object) Configurações de envio automático de documentos fiscais. - `sending_documents.is_send_xml_automatically` (boolean) Enviar XML/DANFE ao cliente automaticamente - `state_registration_st` (array) Inscrições estaduais para Substituição Tributária. Para remover todas, envie um array vazio. Não pode conter estados repetidos. Se não enviado, nada será alterado. - `state_registration_st.state` (string, required) Sigla do estado (UF). Example: "MT" - `state_registration_st.state_registration` (string, required) Número da inscrição estadual no estado específico. Example: "123123123" - `transaction_intermediaries` (array) Lista de intermediadores de transação. Para remover todos, envie um array vazio. Se não enviado, nada será alterado. - `transaction_intermediaries.name` (string, required) Nome do intermediador. Example: "João da Silva" - `transaction_intermediaries.document` (string, required) CNPJ do intermediador. Example: "30398117000136" - `transaction_intermediaries.registered_identifier` (string, required) Identificador cadastrado do intermediador. Example: "teste123" - `specific_settings` (object) Configurações específicas para setores da economia. - `specific_settings.enable_gas_fuel_sales` (boolean) Habilitar vendas de combustível. Example: true - `specific_settings.enable_drug_sales` (boolean) Habilitar vendas de medicamentos. Example: true - `calculation_basis` (object) Configurações da base de cálculo. - `calculation_basis.is_conditional_discount` (boolean) Desconto condicional ativo. - true: Desconto condicionado (não reduz base) - false: Desconto incondicionado (reduz base) Example: true - `payment_settings` (object) Configurações de pagamento. - `payment_settings.state` (string, required) UF do CNPJ do estabelecimento. Example: "SC" - `payment_settings.payment_document` (string, required) CNPJ do pagamento Example: "30398117000136" - `payment_settings.beneficiary_document` (string, required) CNPJ do beneficiário Example: "30398117000136" ## Response 200 fields (application/json): - `data` (object) Dados completos das configurações gerais para emissão de NFe/NFCe. - `data.tributary_settings` (object) Configurações gerais tributárias da empresa. - `data.tributary_settings.tax_regime_id` (integer, required) Regime tributário: - 1: Simples Nacional - 2: Simples Nacional, excesso sublimite de receita bruta - 3: Regime Normal - 4: Simples Nacional - Microempreendedor Individual Example: 1 - `data.tributary_settings.is_state_registration_exempt` (boolean, required) Indica se a empresa é isenta de inscrição estadual. Example: true - `data.tributary_settings.state_registration` (string) Inscrição estadual da empresa. Deve ser nulo ou vazio se for isenta. - `data.tributary_settings.municipal_registration` (string) Inscrição municipal da empresa. - `data.tax_settings` (object) Configurações específicas de impostos e tributos para NF-e. - `data.tax_settings.nfe_environment` (string) Ambiente da NFe (produção ou homologação). Enum: "production", "homologation" - `data.tax_settings.final_consumer_operation_default` (string) Indicação da operação com Consumidor Final por padrão Enum: "normal", "end_consumer" - `data.tax_settings.buyer_presence_indicator` (object) Indicador de presença do comprador no estabelecimento (modalidade da venda) - `data.tax_settings.buyer_presence_indicator.id` (integer, required) Código do indicador de presença do comprador no estabelecimento (modalidade da venda): - 0: Não se aplica (por exemplo, para a Nota Fiscal complementar ou de ajuste) - 1: Operação presencial - 2: Operação não presencial, pela Internet - 3: Operação não presencial, Teleatendimento - 4: NFC-e em operação com entrega em domicílio - 5: Operação presencial, fora do estabelecimento - 9: Operação não presencial, outros - `data.tax_settings.buyer_presence_indicator.name` (string, required) Nome descritivo do indicador. Example: "Não se aplica (por exemplo, para a Nota Fiscal complementar ou de ajuste)" - `data.tax_settings.include_freight_in_pis_calculation` (boolean) Inclui frete na base de cálculo de PIS no produto - `data.tax_settings.include_freight_in_cofins_calculation` (boolean) Inclui frete na base de cálculo de COFINS no produto - `data.tax_settings.include_ipi_in_icms_calculation` (boolean) Incluir IPI na base de cálculo Example: true - `data.tax_settings.is_default_customer_icms_taxpayer` (boolean) Cliente padrão é contribuinte de ICMS Example: true - `data.tax_settings.credit_calculation_rate` (number) Alíquota aplicável no cálculo do crédito Example: 12.45 - `data.tax_settings.pix_payment_code` (string) Código de pagamento PIX: - "17": Pagamento Instantâneo (PIX) - "99": Outros Importante: - Campo permitido apenas para empresas cujo endereço seja de SP e CE. Example: "17" - `data.authentication_settings` (object) Configurações de autenticação para NFCe (CSC Token). - `data.authentication_settings.csc_token` (string) Token CSC (Código de Segurança do Contribuinte). - `data.authentication_settings.token_id` (string) ID do token CSC. - `data.standard_justifications` (object) Textos padrão para justificativas de cancelamento, inutilização e contingência. - `data.standard_justifications.unusability` (string) Texto padrão para inutilização de NFe. Example: "Texto padrão para inutilização" - `data.standard_justifications.cancelation` (string) Texto padrão para cancelamento de NFe. Example: "Texto padrão para cancelamento" - `data.standard_justifications.contingency` (string) Texto padrão para contingência de NFe. Example: "Texto padrão para contingência" - `data.access_settings` (object) Configurações de acesso e autorização para NFe. - `data.access_settings.allow_accountant_invalidate_invoices` (boolean) Permite ao contador invalidar faturas. Example: true - `data.access_settings.xml_authorizeds` (array) Lista de pessoas autorizadas a baixar XML da NFe/NFCe. - `data.access_settings.xml_authorizeds.identify` (string, required) CPF ou CNPJ da pessoa autorizada. Example: "30398117000136" - `data.access_settings.xml_authorizeds.type` (string, required) Tipo do documento (CPF ou CNPJ). Enum: "cnpj", "cpf" - `data.access_settings.shipping_modality_for_pos` (object) Modalidade de frete para operações de PDV. - `data.access_settings.shipping_modality_for_pos.id` (integer) Código da modalidade de frete: - 0: Contratação do Frete por conta do Remetente (CIF) - 1: Contratação do Frete por conta do Destinatário (FOB) - 2: Contratação do Frete por conta de Terceiros - 3: Transporte Próprio por conta do Remetente - 4: Transporte Próprio por conta do Destinatário - 9: Sem frete - `data.access_settings.shipping_modality_for_pos.name` (string) Nome descritivo da modalidade. Example: "Contratação do Frete por conta do Remetente (CIF)" - `data.nfce_service_fees` (object) Configurações de taxas de serviço para NFCe. - `data.nfce_service_fees.tax_service_or_waiter_charge` (string) Tipo de taxa de serviço ou garçom. Enum: "tip", "other_expenses" - `data.product_informations` (object) Configurações de informações adicionais dos produtos. - `data.product_informations.add_batch` (boolean) Adicionar lote. - `data.product_informations.add_expiration_date` (boolean) Adicionar data de validade. - `data.product_informations.add_barcode_in_invoice` (boolean) Adicionar código de barras. Importante: - Se essa opção estiver habilitada, o GTIN será incluído na tag cEAN. O código GTIN deverá ser um valor válido no portal CCG-Cadastro Centralizado de GTIN, caso contrário acontecerá uma rejeição. - `data.sending_documents` (object) Configurações de envio automático de documentos fiscais. - `data.sending_documents.is_send_xml_automatically` (boolean) Enviar XML/DANFE ao cliente automaticamente - `data.state_registration_st` (array) Inscrição Estadual do Substituto Tributário. Importante: - Para remover todas, envie um array vazio. - Não pode conter estados repetidos. - `data.state_registration_st.state` (string, required) Sigla do estado (UF). Example: "MT" - `data.state_registration_st.state_registration` (string, required) Número da inscrição estadual no estado específico. Example: "123123123" - `data.transaction_intermediaries` (array) Lista de intermediadores de transação. Importante: - Para remover todos, envie um array vazio. - `data.transaction_intermediaries.name` (string, required) Nome do intermediador. Example: "João da Silva" - `data.transaction_intermediaries.document` (string, required) CNPJ do intermediador. Example: "30398117000136" - `data.transaction_intermediaries.registered_identifier` (string, required) Identificador cadastrado do intermediador. Example: "teste123" - `data.specific_settings` (object) Configurações específicas para setores da economia. - `data.specific_settings.enable_gas_fuel_sales` (boolean) Habilitar vendas de combustível. Example: true - `data.specific_settings.enable_drug_sales` (boolean) Habilitar vendas de medicamentos. Example: true - `data.calculation_basis` (object) Configurações da base de cálculo. - `data.calculation_basis.is_conditional_discount` (boolean) Desconto condicional ativo. - true: Desconto condicionado (não reduz base) - false: Desconto incondicionado (reduz base) Example: true - `data.payment_settings` (array) Configurações de pagamento. Importante: - Para remover as informações envie state como null ou vazio. - Se state estiver presente, payment_document e beneficiary_document devem ser presentes. - `data.payment_settings.state` (string, required) UF do CNPJ do estabelecimento. Example: "SC" - `data.payment_settings.payment_document` (string, required) CNPJ do pagamento Example: "30398117000136" - `data.payment_settings.beneficiary_document` (string, required) CNPJ do beneficiário Example: "30398117000136" ## 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 403 fields ## Response 404 fields