Consultas de listas de Operación

Reachcore ha creado un API REST para la consulta de listas empleadas en su proceso de certificación de CFDI (listas de Operación). Estas listas son consultadas únicamente para certificación de CFDI en su versión 3.3, por lo que los CFDI de Retenciones e información de Pagos 1.0 no llevan a cabo validaciones sobre estas listas.

Contenido

¿Qué necesito?

  • Tener activado el servicio de consulta de listas de operación en tu cuenta Reachcore.
  • Generar un API Key en tu cuenta Reachcore, ya que se usa para autenticar la solicitud en el API REST. El API Key debe corresponder al ambiente en el que se realiza la solicitud. Para referencia de cómo generar el API Key, consulta el siguiente artículo: Generar API Key para Web Services.

Una de las validaciones que se llevan a cabo en los RFC que se consulten por esta API es que deben cumplir con la estructura definida por Anexo 20 para un RFC, la cual es:

<xs:simpleType name="t_RFC">
  <xs:annotation>
    <xs:documentation>Tipo definido para expresar claves del Registro Federal de Contribuyentes</xs:documentation>
  </xs:annotation>
  <xs:restriction base="xs:string">
    <xs:whiteSpace value="collapse"/>
    <xs:minLength value="12"/>
    <xs:maxLength value="13"/>
    <xs:pattern value="[A-Z&Ñ]{3,4}[0-9]{2}(0[1-9]|1[012])(0[1-9]|[12][0-9]|3[01])[A-Z0-9]{2}[0-9A]"/>
  </xs:restriction>
</xs:simpleType>

Consulta a lista de RFC que pueden Emitir

En este recurso se podrán consultar hasta 100 RFC por solicitud. Para ello, se debe enviar al API REST lo siguiente:

Ambiente URL
Piloto https://oat.reachcore.com/api/rest/listas
A partir del 1 de noviembre


Todas las solicitudes se deberán hacer por el canal de comunicación seguro (https). Las conexiones realizadas por http serán rechazadas.

Verbo HTTP: POST

Encabezado HTTP

Parámetro Valor Uso Descripción
RCApiKey API Key Requerido Autenticación al servicio por medio del API Key generado en la plataforma de Reachcore.
Content-Type application/json Requerido El API Rest solo procesa estructuras JSON, por la cual se debe declarar.

Cuerpo de la solicitud

Solo se acepta la estructura de un JSON en el cuerpo de la solicitud; se debe de enviar un conjunto de hasta 100 RFCs por solicitud como se muestra a continuación:

Ejemplo de solicitud consulta RFC

{
    "rfcs": [
        "EAAM5308094N4",
        "TICJ781231CDO"
    ]
}

Códigos de respuesta

Como respuestá del servicio REST, se obtendrá un código HTTP indicando el resultado de la operación realizada. Todas las repuestás son en formato JSON (application/json)

Código HTTP Subcódigo de error Significado
200 OK - La consulta se realizó correctamente.
400 400-001 Bad request - Alguno de los RFC ingresados en la petición no cumple con la expresión regular que define a un RFC
400 400-002 Bad request - La consulta tiene más de 100 RFC
401 Unauthorized - El API Key no es válido
403 403-001 Forbidden - Su cuenta no tiene los permisos para usar el servicio de consulta. Por favor contacte a MEX-soporte@sovos.com
404 Not found - La URL proporcionada para hacer la consulta no existe
500 Internal Server Error - Error de la plataforma Reachcore


Ejemplo de respuestá con error 400-002

{
    "errors": [
        {
            "Code": "400-002",
            "Message": "El número total de RFCs [179] rebasa el límite permitido [100]."
        }
    ]
}

Ejemplo de respuestá correcta de la consulta RFC

{
    "queryDate": "2019-02-18T12:44:45",
    "results": [
        {
            "rfc": "EAAM5308094N4",
            "allowed": true
        },
        { "rfc": "TICJ781231CDO" }
    ]
}


Descripción de la respuestá exitosa de consulta


Atributo Descripción
queryDate Timestamp con la fecha y hora en que se realizó la consulta. Se regresa en formato yyyy-mm-ddThh:MM:ss
results Arreglo que contiene el resultado de la consulta de los RFC
rfc El RFC consultado
allowed Valor booleano que indica si el RFC consultado puede ser empleado como RFC Emisor. La validación toma en cuenta la información de los CSD cargados en la cuenta Reachcore.


Si un RFC consultado no tiene detalle, significa que no se tiene información acerca del RFC consultado.

Consulta detalles de mis Certificados de Sello Digital

Para conocer detalle sobre los Certificados de Sello Digital que tiene asociado uno (o varios) de mis RFC registrados en Reachcore, se puede realizar una consulta al API de Listas de Operación para solicitar el detalle que Reachcore conoce sobre éstos RFC. En este recurso se podrán consultar hasta 100 RFC por solicitud. Para ello, se debe enviar al API REST lo siguiente:

Ambiente URL
Piloto https://oat.reachcore.com/api/rest/listas/detalle
A partir del 1 de noviembre


Todas las solicitudes se deberán hacer por el canal de comunicación seguro (https). Las conexiones realizadas por http serán rechazadas.

Verbo HTTP: POST

Encabezado HTTP

Parámetro Valor Uso Descripción
RCApiKey API Key Requerido Autenticación al servicio por medio del API Key generado en la plataforma de Reachcore.
Content-Type application/json Requerido El API Rest solo procesa estructuras Json, por la cual se debe declarar.

Cuerpo

Solo se acepta la estructura de un JSON en el cuerpo de la solicitud; se debe de enviar un conjunto de hasta 100 RFC por solicitud, como se muestra a continuación:

Ejemplo de solicitud de consulta de detale de RFC

{
    "rfcs": [
        "&AAR121024Q23",
        "FAVJ770101UN1"
    ]
}

Códigos de respuestá

Como respuestá del servicio REST, se obtendrá un código indicando el resultado de la operación. Todas las repuestás son en formato JSON (application/json)

Código HTTP Subcódigo de error Significado
200 OK - La consulta se realizó correctamente.
400 400-001 Bad request - Alguno de los RFC ingresados en la petición no cumple con la expresión regular que define a un RFC
400 400-002 Bad request - La consulta tiene más de 100 RFC
401 Unauthorized - El API Key no es válido
403 403-001 Forbidden - Su cuenta no tiene los permisos para usar el servicio de consulta. Por favor contacte a MEX-soporte@sovos.com
403 403-002 Forbidden - Alguno de los RFC ingresados no pertenece a los RFC registrados en la cuenta a la que pertenece el API KEY.
404 Not found - La URL proporcionada para hacer la consulta no existe
500 Internal Server Error - Error de la plataforma Reachcore


Ejemplo de respuestá con error 403-002

{
    "errors": [
        {
            "Code": "403-002",
            "Message": "Alguno de los RFC's ingresados no pertenece a los RFC's registrados en la cuenta a la que pertenece el API KEY."
        }
    ]
}

Ejemplo de respuestá correcta de la consulta de detalles

{
  "queryDate": "2019-01-31T12:13:47",
  "results": [
    {
      "rfc": "&AAR121024Q23",
      "allow": false,
      "details": [
        {
           "numeroSerie": "20001000000100005704",
           "fechaInicio": "2012-06-26T23:00:25",
           "fechaFinal": "2019-05-08T12:46:39"
        },
        {
           "numeroSerie": "20001000000100005867",
           "fechaInicio": "2012-07-27T11:02:00",
           "fechaFinal": "2019-05-08T12:46:39"
        },
        {
           "numeroSerie": "40001000000100005811",
           "fechaInicio": "2012-06-26T23:00:25",
           "fechaFinal": "2019-05-08T12:46:39"
        }
      ]
    },
    {
      "rfc": "FAVJ770101UN1",
      "allow": false
    }
  ]
}


Descripción de la respuestá exitosa de consulta


Atributo Descripción
queryDate Timestamp con la fecha y hora en que se realizó la consulta. Se regresa en formato yyyy-mm-ddThh:MM:ss
results Arreglo que contiene el resultado de la consulta de los RFC
rfc El RFC consultado
allowed Valor booleano que indica si el RFC consultado puede ser empleado como RFC Emisor. La validación toma en cuenta la información de los CSD cargados en la cuenta Reachcore.
details Sección con detalles de Certificados de Sello Digital encontrados para el RFC consultado. Los detalles se listan a continuación:
numeroSerie Número de serie del Certificado de Sello Digital asociado al RFC
fechaInicio Timestamp de fecha de inicio de vigencia del CSD en formato yyyy-mm-ddThh:MM:ss
fechaFinal Timestamp de fecha de fin de vigencia del CSD en formato yyyy-mm-ddThh:MM:ss


Este método sólo regresa detalle de información sobre los RFC registrados en tu cuenta Sovos Reachcore. Si consultas el detalle de un RFC que no está en tu cuenta obtendrás un mensaje de error con clave 403-002

Para mayor información o aclaración de dudas relacionadas con está guía, por favor envía un correo a MEX-soporte@sovos.com


Regresar