# Listar los sobres recibidos

`GET /v1/companies/{companyRut}/inSobres`

**Bandeja de recepción: sobres recibidos.**

**Acceso:** restringida. Requiere sesión, y sólo opera sobre el RUT de tu propia empresa: pedir otro RUT responde `403 FORBIDDEN`.

Ver [Filtrado](/filtrado-y-webhooks) para filtrar los resultados. El estado del sobre se filtra con sobreStatus=['BS'|'AS'].

## OpenAPI

```json
{
  "openapi": "3.0.3",
  "info": {
    "title": "pymo Gateway API",
    "version": "1.0.0",
    "description": "API del gateway de facturación electrónica (CFE) de pymo. Los métodos y las rutas salen del código del servicio, así que la referencia refleja lo que la API hace hoy."
  },
  "servers": [
    {
      "url": "https://gatewaytest.pymo.uy",
      "description": "Homologación: emite contra la ePrueba de DGI. Es donde se integra."
    },
    {
      "url": "https://gateway.pymo.uy",
      "description": "Producción: los comprobantes son fiscales y no se pueden borrar."
    }
  ],
  "security": [
    {
      "sessionCookie": []
    }
  ],
  "paths": {
    "/v1/companies/{companyRut}/inSobres": {
      "get": {
        "operationId": "get_v1_companies_companyRut_inSobres",
        "summary": "Listar los sobres recibidos",
        "description": "**Bandeja de recepción: sobres recibidos.**\n\n**Acceso:** restringida. Requiere sesión, y sólo opera sobre el RUT de tu propia empresa: pedir otro RUT responde `403 FORBIDDEN`.\n\nVer [Filtrado](/filtrado-y-webhooks) para filtrar los resultados. El estado del sobre se filtra con sobreStatus=['BS'|'AS'].",
        "tags": [
          "5 Recepción"
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/CompanyRut"
          }
        ],
        "responses": {
          "200": {
            "description": "Éxito",
            "content": {
              "text/plain": {
                "examples": {
                  "Exito": {
                    "value": "{\n     \"payload\": {\n       \"receivedSobres\": [\n           {\n               \"sobre\": {\n                   \"EnvioCFE_entreEmpresas\": {\n                       \"Caratula\": {\n                           \"RutReceptor\": \"219999990008\",\n                           \"RUCEmisor\": \"219999990008\",\n                           \"Idemisor\": \"0\",\n                           \"CantCFE\": \"1\",\n                           \"Fecha\": \"2018-05-25T16:35:26.000Z\",\n                           \"X509Certificate\": \"...\"\n                       },\n                       \"CFE_Adenda\": [\n                           {\n                               \"cfeStatus\": \"PENDING_REVISION\",\n                               \"cfeErrors\": [],\n                               \"_id\": \"5b083bb5471a6f26fae1a6ce\",\n                               \"CFE\": { ... }\n                               },\n                               \"Adenda\": \"...\"\n                           }\n                       ]\n                   }\n               },\n               \"sobreStatus\": \"AS\",\n               \"sobreErrors\": [],\n               \"IDRespuestaSobreAckHistory\": [\n                   {\n                       \"createdAt\": \"2018-05-25T16:37:10.018Z\",\n                       \"_id\": \"5b083bb6471a6f26fae1a6cf\",\n                       \"IDRespuesta\": 1\n                   }\n               ],\n               \"IDRespuestaCfesAckHistory\": [ {\n                       \"createdAt\": \"2018-05-25T16:37:10.063Z\",\n                       \"_id\": \"5b083bb6471a6f26fae1a6d0\",\n                       \"IDRespuesta\": 1\n                   }\n               ],\n               \"IDReceptor\": 4501227611,\n               \"_id\": \"5b083bb5471a6f26fae1a6cd\",\n               \"company\": \"5b07a2b1471a6f26fae1a664\",\n               \"NomArch\": \"Sob_219999830019_20180426_2.xml\",\n               \"createdAt\": \"2018-05-25T16:37:09.855Z\",\n               \"updatedAt\": \"2018-05-25T17:31:08.534Z\",\n               \"__v\": 16,\n               \"eReceiverEmail\": \"info-test@mefactura.uy\",\n               \"lastSobreIDRespuesta\": 1,\n               \"lastCfeIDRespuesta\": 14,\n               \"NomArchSobreAck\": \"M_1_Sob_219999990008_20180525_0.xml\",\n               \"NomArchCfesAck\": \"ME_14_Sob_219999990008_20180525_0.xml\",\n               \"cfesQuantity\": 1,\n               \"CantResponden\": 0,\n               \"CantCFEAceptados\": 0,\n               \"CantCFERechazados\": 0,\n               \"CantCFCAceptados\": 0,\n               \"CantCFCObservados\": 0,\n               \"CantOtrosRechazados\": 0,\n               \"sobreAckToken\": \"5b083bb5471a6f26fae1a6cd\",\n               \"id\": \"5b083bb5471a6f26fae1a6cd\"\n           }\n       ]\n     },\n     \"status\": \"SUCCESS\" \n   }"
                  }
                }
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Respuesta"
                }
              }
            }
          },
          "401": {
            "description": "Sesión no iniciada o vencida (`UNAUTHORIZED`)",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RespuestaError"
                },
                "examples": {
                  "No_autorizado": {
                    "value": {
                      "payload": {},
                      "message": {
                        "code": "UNAUTHORIZED",
                        "value": "Debe iniciar sesión."
                      },
                      "status": "FAIL"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "La sesión existe pero no alcanza este recurso (`FORBIDDEN`)",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RespuestaError"
                },
                "examples": {
                  "Prohibido": {
                    "value": {
                      "payload": {},
                      "message": {
                        "code": "FORBIDDEN",
                        "value": "No tiene permisos para realizar esta acción."
                      },
                      "status": "FAIL"
                    }
                  }
                }
              }
            }
          }
        },
        "x-acceso": "restringida-por-rut"
      }
    }
  },
  "components": {
    "schemas": {
      "Respuesta": {
        "type": "object",
        "required": [
          "payload",
          "status"
        ],
        "description": "Envoltorio común a todas las respuestas. **`status` no se deduce del código HTTP**: hay al menos nueve lugares en el gateway que responden `HTTP 200` con `status: \"FAIL\"` (por ejemplo `CFE_NOT_FOUND` y `DGI_COMPANY_NOT_READY_YET`). Un cliente tiene que leer `status`, no el código.",
        "properties": {
          "payload": {
            "description": "Los datos de la respuesta. `{}` cuando el endpoint no devuelve nada.",
            "oneOf": [
              {
                "type": "object"
              },
              {
                "type": "array",
                "items": {}
              }
            ]
          },
          "message": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Mensaje"
              }
            ],
            "description": "Presente cuando la operación tiene algo que decir. Las lecturas simples responden sólo `payload` y `status`."
          },
          "status": {
            "$ref": "#/components/schemas/Estado"
          }
        }
      },
      "RespuestaError": {
        "allOf": [
          {
            "$ref": "#/components/schemas/Respuesta"
          }
        ],
        "description": "El mismo envoltorio, con `status: \"FAIL\"` y `payload` normalmente vacío."
      },
      "Mensaje": {
        "type": "object",
        "required": [
          "code",
          "value"
        ],
        "description": "Código estable y su texto en español. **El código es el contrato, el texto no**: `value` sale de una tabla de traducciones y puede reescribirse sin aviso, así que un cliente ramifica por `code`.",
        "properties": {
          "code": {
            "type": "string",
            "example": "DGI_CFES_RECEIVE_SUCCESS"
          },
          "value": {
            "type": "string",
            "example": "Cfes recibidos correctamente."
          }
        }
      },
      "Estado": {
        "type": "string",
        "enum": [
          "SUCCESS",
          "FAIL"
        ],
        "description": "De las 82 claves de mensaje del gateway, 29 son `SUCCESS` y 53 `FAIL`. Es lo que hay que mirar para saber si la llamada funcionó."
      }
    },
    "securitySchemes": {
      "sessionCookie": {
        "type": "apiKey",
        "in": "cookie",
        "name": "connect.sid",
        "description": "Sesión por cookie de `POST /v1/login`, válida 1 hora. Ver [Autenticación](/autenticacion)."
      }
    },
    "parameters": {
      "CompanyRut": {
        "name": "companyRut",
        "in": "path",
        "required": true,
        "schema": {
          "type": "string",
          "example": "219999990008",
          "default": "219999990008"
        },
        "example": "219999990008"
      }
    }
  }
}
```