Rota Consulta Regras Depara

Nessa rota é possível consultar regras depara configuradas para determinado usuário.

⚠️ Observação: serão apagados os registros com status ERRO criados há mais de 1 mês.

• Requisição
  • Método HTTP
  • Endpoint
  • Query string
  • Headers
  • Body
• Resposta
  • Retornos de sucesso
  • Retornos de erro

Requisição

Método HTTP

GET

Endpoint

• Consulta com filtros no queryString:
  https://sped.plugstorage.com.br/api/v2/sped/regrasDePara/

• Consulta por ID:
  https://sped.plugstorage.com.br/api/v2/sped/regrasDePara/:id

Query String

Opção de buscar por parâmetros

Headers

Body

Nenhum.

Resposta

Retornos de sucesso

Status code 200

{
  "sucesso": true,
  "regrasDepara": [
    {
      "status": "CONCLUIDO",
      "tipo": "ICMS",
      "dados": {
      "cfopDe": "5102",
      "cfopPara": "6102",
      "cstDe": "00",
      "cstPara": "20",
      "destinacao": "A",
      "creditoIcms": "1",
      "creditoIcmsSt": "0",
      "st": "1",
      "difal": "0"
    },
    "mensagem": "Regra cadastrada com sucesso",
    "id": "683069114aa4a85266e1ded5"
    }
  ],
  "hashProximaPagina": "683069114aa4a85266e1ded6"
}

Status code 200 - consulta por id:

{
  "regra": {
      "status": "CONCLUIDO",
      "tipo": "ICMS",
      "dados": {
        "cfopDe": "5102",
        "cfopPara": "6102",
        "cstDe": "00",
        "cstPara": "20",
        "destinacao": "A",
        "creditoIcms": "1",
        "creditoIcmsSt": "0",
        "st": "1",
        "difal": "0"
       },
    "mensagem": "Regra cadastrada com sucesso",
    "id": "683069000aa4a00000e1ded5"
  }
}

{
  "regra": {
        "status": "ERRO",
        "tipo": "ICMS",
        "dados": {
            "cfopDe": "5102",
            "cfopPara": "6109",
            "cstDe": "01",
            "cstPara": "20",
            "destinacao": "A",
            "creditoIcms": "1",
            "creditoIcmsSt": "0",
            "st": "1",
            "difal": "0"
        },
        "atualizadoEm": "2025-01-19T12:22:44.548Z",
        "mensagem": {
            "cstDe": "CST de origem inválida!"
        },
        "id": "696e2214fd0037700bdbe000"
    }
}

Retornos de erro

Status code 404

Contador não localizado

{
  "error": true,
  "message": "Nenhum(a) regras depara localizado(a) com os parâmetros informados."
}

Status code 401

Consulte essa documentação para saber os possíveis retornos de erros de autenticação.