Rota consulta Sped

Nessa rota é possível consultar os dados do Sped.

• 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://app.plugstorage.com.br/api/v2/sped/

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

Query String

Opção de buscar por parâmetros

Headers

Body

Nenhum.

Exemplos
 

https://app.plugstorage.com.br/api/v2/sped/?token=1234Token&ano=2005&mes=09&tipo=fiscal

https://app.plugstorage.com.br/api/v2/sped/12319828301923?token=1234Token

Resposta

Retornos de sucesso

Status code 200

Sped com status fechado e arquivo gerado

{
 "sped": {
        "id": "68c046fc53fd3b5cd86b3092",
        "cnpj": "08787726000128",
        "mes": "12",
        "ano": "2028",
        "tipo": "fiscal",
        "status": "FECHADO",
        "txtContent":"|0000|018|0|01012024|31012024|0109 SUAGENCIA MARKETING E COMUNICAO INTEGRADA 
                 LTDA|04309786000184||SP|144233925115|3550308|42021987||A|1|\r\n|0001|0|\r\n
                 |0005|0109 - SUAGENCIA MARKETING E COMUNICAÇÃO INTEGRADA LTDA|05638030|R DR MARTINS DE
                 OLIVEIRA|293||JARDIM LONDRINA|11 45047000|||\r\n|0100|OSWALDO RENZI JUNIOR|30630080879|
                 1SP226548||08674270|RUA PRESIDENTE NEREU RAMOS|64||JARDIM SANTA HELENA|||
                 contabilsz@solutta.com|3552502|\r\n|0150|01863445000168|LIU JIAPEI PRESENTES 
                 EPP|1058|01863445000168||114720605119|3550308||RUA CLIMACO BARBOSA|600||"
  }
}

Sped com status fechado e arquivo ainda não gerado

{
  "sped": {
     "cnpj":"82997337000180",
     "spedId":"67890407d427f2cae243bc39",
     "mes":"12","ano":"2024",
     "tipo":"fiscal",
     "status":"FECHADO",
     "message":"Arquivo SPED não localizado."
  }
}

Sped com outros status 

{
    "sped": {
        "id": "68c044c0000d0b5cd86b0000",
        "cnpj": "08787726000128",
        "mes": "11",
        "ano": "2028",
        "tipo": "fiscal",
        "message": "Não foi possível processar o sped, por favor, tente novamente.",
        "status": "ERRO"
    }
}

Retornos de erro

Status code 404

Sped não localizado

{
   "error":true,
   "message":"Sped não localizado com os parâmetros informados."
}

Status code 400

{
    "error": true,
    "message": "Parâmetro 'tipo' deve ser 'fiscal' ou 'contribuicoes'."
}

Status code 401

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