Documentación para integración con servicios Sovos
Inicio

API para obtener las cuentas relacionadas en el esquema de auto emisión

Esta API REST permite al Autoemisor de un Comprobante conocer información de las cuentas que se le han vinculado en el esquema de auto emisión.

Contenido

¿Qué necesito?

  • Tener activo el servicio de auto-emisió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 como generar el API Key, consulta el siguiente artículo: Generar API Key para Web Services.

Consulta de información de cuentas vinculadas

Para consultar la información de las cuentas que se tienen vinculadas en el esquema de auto-emisión se debe hacer un GET a la siguiente liga (dependiendo del ambiente)

Ambiente URL
Piloto https://oat.reachcore.com/api/api.Selfbilling.External/certificates
Producción https://go.reachcore.com/api/api.Selfbilling.External/certificates


Todas las solicitudes se deberán hacer por httpS. Las conexiones realizadas por http serán rechazadas

Verbo HTTP: GET

Encabezado HTTP

No se esperan parámetros dentro del GET. El único dato que debe viajar en el encabezado es el RCApiKey.

Cuerpo de la petición

El cuerpo de la petición debe estar vacío.

Estructura de respuesta

Los elementos en la respuesta son los siguientes:

Elemento Descripción
requestDate timestamp en formato yyyy-mm-ddThh:MM:ss del momento en que se recibe la petición.
csdCount Cantidad de cuentas vinculadas en el esquema de auto-emisión
TrackingId Identificador de la transacción. En caso de errores se debe proporcionar este identificador a Soporte Reachcore
csds Nodo que agrupa el detalle de las cuentas vinculadas en el esquema de auto-emisión
SerialNumer Número de certificado del CSD asociado al RFC emisor de la cuenta vinculada en el esquema de auto-emisión
taxId RFC emisor de la cuenta vinculada en el esquema de auto-emisión

name *

 Nombre o Razón Social del RFC de la cuenta vinculada en el esquema de auto-emisión.
email correo electrónico del administrador de la cuenta vinculada en el esquema de auto-emisión
validFromDate Fecha inicial de vigencia del CSD en formato yyyy-mm-ddThh:MM:ss
validUntilDate Fecha final de vigencia del CSD en formato yyyy-mm-ddThh:MM:ss
linkedDate Fecha de vinculación de la cuenta en formato yyyy-mm-ddThh:MM:ss

fiscalRegime *

 Régimen Fiscal reportado por el dueño de la cuenta vinculada

postalCode *

 Código Postal reportado por el dueño de la cuenta vinculada


Los elementos name, fiscalRegime y postalCode sólo regresarán valores si el dueño de la cuenta ha proporcionado a Reachcore esa información. Si no hay información para regresar, la respuesta esperada es un valor null.

Ejemplo de respuesta 

{
    "requestDate": "2021-11-11T18:52:47",
    "csdCount": "8",
    "TrackingId": "0006e22f-20f2-4aae-a5c0-4e038fdeb032",
    "csds": [
        {
            "serialNumber": "30001000000400002336",
            "taxId": "XIQB891116QE4",
            "name": null,
            "email": "user_pagent04@mail.com",
            "validFromDate": "2019-05-29T14:52:42",
            "validUntilDate": "2023-05-29T14:52:42",
            "linkedDate": "2019-10-08T18:18:30",
            "fiscalRegime": null,
            "postalCode": "99999"
        },
        {
            "serialNumber": "20001000000300022815",
            "taxId": "LAN7008173R5",
            "name": "CINDEMEX SA DE CV",
            "email": "facturacion@cindemex.io",
            "validFromDate": "2016-10-25T16:52:11",
            "validUntilDate": "2020-10-25T16:52:11",
            "linkedDate": "2018-09-05T19:00:41",
            "fiscalRegime": "624",
            "postalCode": "11111"
        },
        {
            "serialNumber": "30001000000400002442",
            "taxId": "ZUÑ920208KL4",
            "name": null,
            "email": "user_zun@mail.com",
            "validFromDate": "2019-06-17T15:18:06",
            "validUntilDate": "2023-06-17T15:18:06",
            "linkedDate": "2019-10-29T16:25:33",
            "fiscalRegime": null,
            "postalCode": null
        }
    ]
}

Códigos de respuesta

Como respuesta del API REST, se obtendrá un código indicando el resultado de la operación.

Código HTTP Significado Descripción
200 OK La consulta se realizó de manera exitosa
401 Unauthorized El API Key no es válido.
403 Forbidden La cuenta no tiene los permisos para usar el servicio de 'auto emisión'.
404 Not Found La URL solicitada no existe
500 Internal Server Error Error de la plataforma Reachcore


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


Regresar