Home TOTVS Varejo Supermercados

Árvore de páginas

Objetivo

Consultar os NCMs cadastrados.

Chamada

GET [URLAPI]/CadastrosEstruturaisAPI/api/v1/Ncm

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

Parâmetros URI (URI Parameters)

Nome (Name)

Descrição (Description)

Tipo (Type)

Informações Adicionais (Adittional Information)

codNcmCódigo do NCMStringNão há.

Fields

CamposStringNão há.
OrderOrdenaçãoStringNão há.
PagePá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)

  • Success (200)
  • BadRequest (400)

Formatos de Resposta (Response Formats)

application/json, text/json

CODE 200 - SUCCESS

{
  "hasNext": true,
  "items": [
    {
      "codNcm": "string",
      "descricao": "string",
      "descReduzida": "string",
      "perImpostoImport": 0,
      "aliquotaIpi": 0,
      "indControlePf": "string",
      "codTabGenero": "string",
      "codTipiNcm": 0,
      "indPermExcecao": "string",
      "status": "string",
      "dtaInicioVigencia": "2021-07-14T12:45:49.286Z",
      "dtaFimVigencia": "2021-07-14T12:45:49.286Z",
      "usuarioAlteracao": "string",
      "indSubIcmsDifDi": "string",
      "dtaAlteracao": "2021-07-14T12:45:49.286Z"
    }
  ]
}

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