Home TOTVS Varejo Supermercados

Árvore de páginas

Objetivo

Método que permite consultar as pautas de ICMS que estão ativas.

Chamada

GET [URLAPI]/CadastrosEstruturaisAPI/api/v1/Tributacao/pauta-imposto-icms

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

Parâmetros URI (URI Parameters)

Nome (Name)Descrição (Description)Tipo (Type)Informações Adicionais (Adittional Information)
IdPautaIcms

Identificador da Pauta de ICMS

array[integer]

Não há.
ExpandPropriedade que expande os camposstringNão há.
DataAlteracaodata da alteraçãostring($date-time)não há
FieldsCamposstringNão há.
OrderOrdenação dos camposstringNão há.
PageNúmero da Página

integer($int32)

Não há.
PageSizeTamanho da Página

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 - SUCCESS


Nome (Name)Descrição (Description)Tipo (Type)Informações Adicionais (Adittional Information)

idPautaIcms

Identificador da Pauta de ICMS

integer($int64)Não há.

descricaoDescriçãostringNão há.

observacaoObservaçãostringNão há.

statusStatus da PautastringNão há.

dataAlteracao

Data de alteração

stringNão há.

usuarioAlteracao

Usuário de alteração

stringNão há.
pautaIcmsUfLogidPautaIcmsUfLogIdentificador da Pauta de ICMS por UFinteger($int64)Não há.

idPautaIcmsIdentificador da Pauta de ICMSinteger($int64)Não há.

idRegTributacaoIdentificador do Regime de Tributaçãointeger($int64)Não há.

ufOrigemUF de OrigemstringNão há.

ufDestinoUF de DestinostringNão há.

dataInicioData de iníciostringNão há.

dataFimData finalstringNão há.

vlrBaseIcmsValor da Base de ICMSnumber($double)Não há.

dataAlteracaoData da Alteraçãostring($date-time)Não há.

usuarioAlteracaoUsuário da AlteraçãostringNão há.

tipCalcPautaIcmsTipo de Cálculo da Pauta de ICMSstringNão há.
{
  "hasNext": true,
  "items": [
    {
      "expandables": [
        "string"
      ],
      "idPautaIcms": 0,
      "descricao": "string",
      "observacao": "string",
      "status": "string",
      "dataAlteracao": "2020-12-15T20:13:08.174Z",
      "usuarioAlteracao": "string",
      "pautaIcmsUfLog": [
        {
          "expandables": [
            "string"
          ],
          "idPautaIcmsUfLog": 0,
          "idPautaIcms": 0,
          "idRegTributacao": 0,
          "ufOrigem": "string",
          "ufDestino": "string",
          "dataInicio": "2020-12-15T20:13:08.174Z",
          "dataFim": "2020-12-15T20:13:08.174Z",
          "vlrBaseIcms": 0,
          "dataAlteracao": "2020-12-15T20:13:08.174Z",
          "usuarioAlteracao": "string",
          "tipCalcPautaIcms": "string"
        }
      ]
    }
  ]
}

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
    }
  ]
}