Rota Consultar Saldo do SPED

Nessa rota é possível consultar o saldo do SPED.

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

Requisição

Método HTTP

GET

Endpoints

• Consulta geral:
  https://app.plugstorage.com.br/api/v2/sped/saldo/

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

Query string (Opção de consulta geral)

Headers

Body

Nenhum.

Exemplos

Consulta geral:

GET https://app.plugstorage.com.br/api/v2/sped/saldo/c69914d9-8425-4f91-b61b-d4fb8032d418?token=9999999999999999token

Consulta por ID:

GET https://app.plugstorage.com.br/api/v2/sped/saldo/?token=9999999999999999token&ano=2025&mes=04&tipo=contribuicoes

Resposta

Retorno de sucesso

Status code 200

Saldo fiscal.

{
  "data": [
    {
      "tipo": "ICMS-ST",
      "valor": "100.00",
      "estado": "SP",
      "status": "SUCESSO",
      "mensagem": "Saldo estadual de ICMS-ST adicionado com sucesso"
    },
    {
      "tipo": "ICMS",
      "valor": "100.00",
      "estado": null,
      "status": "SUCESSO",
      "mensagem": "Saldo estadual de ICMS adicionado com sucesso"
    },
    {
      "tipo": "IPI",
      "valor": "100.00",
      "estado": null,
      "status": "SUCESSO",
      "mensagem": "Saldo estadual de IPI adicionado com sucesso"
    }
  ]
}

Saldo contribuições.

{
  "data": [
    {
      "tipo": "PIS",
      "cnpjPJ": "99999999999999",
      "credito": {
        "ano": "2025",
        "mes": "05",
        "origem": "01",
        "codigo": "01",
        "valor": "100.00",
        "valorDesconto": "20.00"
      },
      "status": "SUCESSO",
      "mensagem": "Saldo federal de PIS adicionado com sucesso"
    }
  ]
}

Retornos de erro

Status code 400

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

{
  "error": true,
  "message": "Nenhum(a) saldo contribuicoes 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.