Home TOTVS Varejo Supermercados

Árvore de páginas

Objetivo

Método para realizar o agendamento para atualização dos dados fiscais da família.

Chamada

POST [URLAPI]/TributacaoAPI/api/v1/Agendamento/atualiza/dados-fiscais-familia

Permissionamento

Antes de prosseguir, certifique-se de que o usuário, utilizado para autenticação de uso na API, está com as devidas permissões no Sistema/Módulo/Aplicações e na empresa desejada.

Para isso, acesse o módulo SegurançaWeb > Permissões > Associação de Permissão Usuário / Grupo >  Sistemas/Módulo/Aplicações > Comercial Web > API Tributação > API Tributação


Imagem 01 - Configurações de Sistemas/Módulos/Aplicações

Assuntos Relacionados

Para saber mais sobre permissionamentos acesse Permissões - Segurança Web.

Informações para Requisição (Request Information)

Parâmetros URI (URI Parameters)

Não há.

Parâmetros do Corpo (Body Parameters)

Nome (Name)

Descrição (Description)

Tipo (Type)

Informações Adicionais (Adittional Information)

descricaoDescrição do lote de alteraçõesvarchar2(35)obrigatório
dtainivigenciaData de início de vigência dos dados informadosdateobrigatório.
seqfamiliaCódigo da família a ser alteradaintegerobrigatório
codnbmshCódigo NCMvarchar2(10)opcional
aliquotaipiAlíquota IPI padrão de Entradasnumber(4,2)opcional
codcestCódigo CESTnumber(7)opcional

codnatrec

Código Natureza da Receitanumber(5)opcional

atualizncmipi

Indicador se atualiza Alíquota de IPI conforme NCMvarchar2(1)opcional

situacaonfpis

Situação Tributária de PIS - Operações de Entradavarchar2(2)opcional

situacaonfcofins

Situação Tributária de COFINS - Operações de Entradavarchar2(2)opcional

situacaonfpissai

Situação Tributária de PIS - Operações de Saídavarchar2(2)opcional

situacaonfcofinssai

Situação Tributária de COFINS - Operações de Saídavarchar2(2)opcional

situacaonfipi

Situação Tributária de IPI - Operações de Entradavarchar2(2)opcional

situacaonfipisai

Situação Tributária de IPI - Operações de Saídavarchar2(2)opcional

codtipi

Código Tabela TIPInumber(3)opcional



{
  "descricao": "string",
  "dtaIniVigencia": "2024-10-10T12:30:31.856Z",
  "familias": [
    {
      "seqFamilia": 0,
      "codNbmsh": "string",
      "aliquotaIpi": 99.99,
      "codCest": 9999999,
      "codNatRec": 99999,
      "atualizNcmIpi": "s",
      "situacaoNfPis": "st",
      "situacaoNfCofins": "st",
      "situacaoNfPisSai": "st",
      "situacaoNfCofinsSai": "st",
      "situacaoNfIpi": "st",
      "situacaoNfIpiSai": "st",
      "codTipi": 999
    }
  ]
}

Informações para Resposta (Response Information)

Códigos do Recurso (Response Codes)

  • OK (201)
  • BadRequest (400)

Formatos de Resposta (Response Formats)

application/json, text/json

CODE 201 - CREATED

{
  "seqAlteracaoTrib": 0,
  "descricao": "string",
  "dtaIniVigencia": "2024-10-10T12:32:03.364Z",
  "status": "string",
  "usuInclusao": "string",
  "dtaInclusao": "2024-10-10T12:32:03.364Z"
}

application/json, text/json

CODE 400 - BAD

{
  "code": "string",
  "message": "string",
  "detailedMessage": "string",
  "helpUrl": "string",
  "details": [
    {
      "guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "notificationType": 0,
      "code": "string",
      "message": "string",
      "detailedMessage": "string",
      "status": 0
    }
  ]
}
  • Sem rótulos