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

GET [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

magem 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)

Nome (Name)

Descrição (Description)

Tipo (Type)

Informações Adicionais (Adittional Information)

DtaIniVigenciaData de início de vigência dos dados string($date)Não há
SeqFamiliaCódigo da família a ser pesquisada

integer($int32)

Não há
CodNbmshCódigo NCM a ser pesquisado

string

Não há
CodCestCódigo CEST a ser pesquisado

integer($int32)

Não há
StatusStatus da alteração a ser pesquisado

string

1 - Agendada
2 - Aplicada
3 - Cancelada
4 - Pendente

PagePagina a ser pesquisada

integer($int32)

Não há
PageSizeQuantidade de items na pagina a ser pesquisada

integer($int32)

Não há

Parâmetros do Corpo (Body Parameters)

Não há

Informações para Resposta (Response Information)

Códigos do Recurso (Response Codes)

  • OK (200)
  • BadRequest (400)

Formatos de Resposta (Response Formats)

application/json, text/json

CODE 200 - OK

{
   "hasNext":true,
   "items":[
      {
         "expandables":[
            "string"
         ],
         "seqAlteracaoTrib":0,
         "descricao":"string",
         "dtaIniVigencia":"2024-10-14T18:50:36.008Z",
         "status":"string",
         "usuInclusao":"string",
         "dtaInclusao":"2024-10-14T18:50:36.008Z",
         "usuarioAlteracao":"string",
         "dtaHoraAlteracao":"2024-10-14T18:50:36.008Z",
         "familias":[
            {
               "seqFamilia":0,
               "codNbmsh":"string",
               "aliquotaIpi":0,
               "codCest":0,
               "codNatRec":0,
               "seqNatRec":0,
               "atualizNcmIpi":"string",
               "situacaoNfPis":"string",
               "situacaoNfCofins":"string",
               "situacaoNfPisSai":"string",
               "situacaoNfCofinsSai":"string",
               "situacaoNfIpi":"string",
               "situacaoNfIpiSai":"string",
               "usuarioAlteracao":"string",
               "dtaHoraAlteracao":"2024-10-14T18:50:36.008Z",
               "codTipi":0
            }
         ]
      }
   ]
}


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