SYSTEM_REQUEST

PAGINADO DE COMPROBANTES EMITIDOS

Esta transacción en conjunto con el método "OBTENER_LISTA_DOCUMENTOS_EMITIDOS" te permitirá obtener información importante de los comprobantes que especifiques a través de los filtros que tenemos disponibles, con esta funcionalidad podrás realizar un paginado de los comprobantes emitidos.

Para obtenerlos, debe realizar la llamada de la siguiente forma:

Request URL: https://api.mysuitetest.com/JsonServiceCall

Valores:

{

"jsonData": "string",

"token": "string",

"transactionName": "string"

}

Tome en cuenta los siguientes campos:

jsonData son los datos en forma de objeto JSON que conforman la materia prima para elaborar la búsqueda. Debe estar en Base64.
transactionName debe indicar la transacción que desea ocupar. En este caso SYSTEM_REQUEST
token valor obtenido de la transacción AUTHENTICATE.

El valor suministrado en el parámetro jsonData es la serialización (formato java), de una clase que contiene las propiedades method, ResponseFormat, Page, PageSize, Order y Filters.

Definición de las propiedades:

method: valor fijo OBTENER_LISTA_DOCUMENTOS_EMITIDOS

ResponseFormat: Indica el formato que se desea como respuesta (valores posibles: JSON y XML); obligatorio.

Page: Indica la página que se quiere recuperar.

PageSize: Indica la cantidad de líneas por página.

Order: los campos que se pueden utilizar (de manera única o combinados, separados por coma) son: Tipo, Tipo_MS, RFC_Receptor, Razon_Receptor, Serie, Folio, Fecha_Emision y Monto; cada campo utilizado puede tener asociado el modificador ASC o DESC. Parámetro opcional, en caso de no especificarse se asume Fecha_Emision DESC.

Filters: pueden existir 14 criterios de filtrado; a continuación los enumero, así como el valor a especificar en el atributo Name.

Ejemplo de valor para el parámetro jsonData (se muestra en varias líneas para que se entienda mejor, debe especificarse en una sola):

{

"method": "OBTENER_LISTA_DOCUMENTOS_EMITIDOS",

"ResponseFormat": "JSON",

"Page": "1",

"PageSize": "3",

"Order": "Fecha_Emision DESC",

"Filters": "PEZpbHRlcnM+PEZpbHRlciBOYW1lPSJUaXBvIiBPcGVyPSI9IiBWYWx1ZTE9IjciIFZhbHVlMiA9IiIgLz48L0ZpbHRlcnM+"

}

Como se había aclarado previamente, el valor de la propiedad Filters se especifica codificado Base64. El valor de la propiedad Filters del ejemplo anterior, decodificado, es este (se muestra en varias líneas, para que se entienda mejor):

<Filters>

<Filter Name="Tipo" Oper="=" Value1="7" Value2 ="" />

</Filters>

Pueden existir 14 criterios de filtrado; a continuación se enumeran, así como el valor a especificar en el atributo Name para cada uno:

Fecha de emisión: especificar el valor Fecha_Emision en el atributo Name (no es case sensitive). El formato a especificar es el entendido por MySql: yyyy-mm-hh HH:MM:ss (ej.: 2019-06-10 00:00:00).

Tipo de comprobante: especificar el valor Tipo en el atributo Name (no es case sensitive). Este criterio de filtrado permite indicar que se recuperen, de una vez, varios tipos de comprobantes (ej.: Ingresos y Pagos); para ellos se mezclará en un solo valor numérico, los bits de cada tipo. El valor 7 (111) indicaría que se buscarían documentos cuyo tipo tengan valores 1, 2 y 4. Este criterio de filtrado solo acepta Oper =.

Tipo de comprobante MySuite: especificar el valor Tipo_MS en el atributo Name (no es case sensitive). Este criterio de filtrado permite indicar que se recuperen, de una vez, varios tipos de comprobantes (ej.: Factura y Nota de cargo); para ellos se mezclará en un solo valor numérico, los bits de cada tipo. El valor 7 (111) indicaría que se buscarían documentos cuyo tipo tengan valores 1, 2 y 4. Este criterio de filtrado solo acepta Oper =.

Moneda: especificar el valor Moneda en el atributo Name (no es case sensitive).

RFC Receptor: especificar el valor RFC_Receptor en el atributo Name (no es case sensitive).

Razon Social Receptor: especificar el valor Razon_Receptor en el atributo Name (no es case sensitive).

Serie: especificar el valor Serie en el atributo Name (no es case sensitive).

Folio: especificar el valor Folio en el atributo Name (no es case sensitive).

Monto: especificar el valor Monto en el atributo Name (no es case sensitive).

Estado del documento: especificar el valor Estado_Documento en el atributo Name (no es case sensitive).

Cancelable: especificar el valor Cancelable en el atributo Name (no es case sensitive).

Estado de cancelación: especificar el valor Estado_Cancelacion en el atributo Name (no es case sensitive).

Sucursal: especificar el valor Sucursal en el atributo Name (no es case sensitive).

País Receptor: especificar el valor Pais_Receptor en el atributo Name (no es case sensitive).

Los valores posibles para el atributo Oper son (no es case sensitive): <=, < >, >=, =, BETWEEN y LIKE, en formato xml, los caracteres "<" y ">" son especiales y deben ser sustituidos ( < por < y > por > ). Los operadores no pueden ser utilizados en cualquier filtro; por ejemplo: LIKE sólo tiene sentido si el campo que se está filtrando es de tipo cadena de caracteres.

Value1 es el valor con el cual se va a comparar el operador Oper con el campo especificado en Name; en el caso de Oper con valor LIKE los % deben ser especificados.

Value2 siempre es vacío (pero obligatorio), mientras el valor de Oper no sea < > ; en este caso se necesita un segundo valor de comparación.

SOLICITUD

A continuación se muestra la manera en que debe realizarse la solicitud:

{

"jsonData": "ewogICJtZXRob2QiOiAiT0JURU5FUl9MSVNUQV9ET0NVTUVOVE9TX0VNSVRJRE9TIiwKICAiUmVzcG9uc2VGb3JtYXQiOiAiSlNPTiIsCiAgIlBhZ2VTaXplIjogIjMiLAogICJPcmRlciI6ICJGZWNoYV9FbWlzaW9uIERFU0MiLAogICJGaWx0ZXJzIjogIlBFWnBiSFJsY25NK1BFWnBiSFJsY2lCT1lXMWxQU0pVYVhCdklpQlBjR1Z5UFNJOUlpQldZV3gxWlRFOUlqY2lJRlpoYkhWbE1pQTlJaUlnTHo0OEwwWnBiSFJsY25NKyIKfQ==",

"token": "wA/jci7o5wxlQu5r19BZsJOIE+TV82o3mfh2dezakoLGC8vhDMRMZJ8u92VOQcpRvHx9xRdSiZGA=",

"transactionName": "SYSTEM_REQUEST"

}

RESPUESTA

La respuesta recibida, vendrá de la siguiente forma:

{

"result": true,

"payload": "Base64 de la estructura donde se contiene la información de los CFDI´s",

"token": "wAw+TV82o3my6PYF70KLwFeTQwg0Lq+mxDzom7O7JwosRoVVQR7bXE=",

"errorMsg": "",

"errorCode": 0

}

result, errorMsg y errorCode tienen la misma explicación en todas las transacciones como lo descrito en Authenticate

El valor devuelto en payload puede tener dos formatos diferentes (en dependencia de lo especificado en la propiedad ResponseFormat).

Ejemplo de valor devuelto en payload, formato JSON (aunque se muestra plano, y en varias líneas, el valor de payload viene codificado Base64):

{

"PageSize":3,

"LinesCount":12941,

"PagesCount":4314,

"Lines":

"[

{

\"SKind\":1,

\"RCountryCode\":\"MX\",

\"RTaxId\":\"NIFA690408448\",

\"RName\":\"ALBERTO-5 . NIÑO FLORES\",

\"SCountryCode\":\"MX\",

\"STaxId\":\"JES900109Q90\",

\"SName\":\"TIENDA PRUEBAS\",

\"Batch\":\"CA\",

\"Serial\":\"22799\",

\"Sucursal\":\"MONTES\",

\"IssuedTimeStamp\":\"\\/Date(1593022207000)\\/\",

\"Dtotal\":3397.000000,

\"Cancelado\":0,

\"DocumentGUID\":\"4c6e304b-9969-4ab0-acb9-420e1b12fd54\",

\"InternalID\":\"FA003842-5320580105007333\",

\"DCurrency\":\"MXN\",

\"Year\":\"2020\",

\"estado_EnrolledTimeStamp\":null,

\"EsCancelable\":null,

\"Estado\":\"Vigente\",

\"EstatusCancelacion\":null,

\"async_Id\":null,

\"async_Uuid\":null,

\"DConvFactor\":1.000000},

{

\"SKind\":2,

\"RCountryCode\":\"MX\",

\"RTaxId\":\"XAXX010101000\",

\"RName\":\"VENTAS DIRECTAS C.S.C.\",

\"SCountryCode\":\"MX\",

\"STaxId\":\"JES900109Q90\",

\"SName\":\"LEVI STRAUSS DE MEXICO, S.A. DE C.V.\",

\"Batch\":\"CMA\",

\"Serial\":\"0004782\",

\"Sucursal\":\"LEVISTRAUSS\",

\"IssuedTimeStamp\":\"\\/Date(1593021363000)\\/\",

\"Dtotal\":1190.000000,

\"Cancelado\":0,

\"DocumentGUID\":\"6c5f4183-3f9d-4ffa-ac06-758e1d92fe90\",

\"InternalID\":\"4782\",

\"DCurrency\":\"MXN\",

\"Year\":\"2020\",

\"estado_EnrolledTimeStamp\":null,

\"EsCancelable\":null,

\"Estado\":\"Vigente\",

\"EstatusCancelacion\":null,

\"async_Id\":null,

\"async_Uuid\":null,

\"DConvFactor\":1.000000},

{

\"SKind\":1,

\"RCountryCode\":\"MX\",

\"RTaxId\":\"XAXX010101000\",

\"RName\":\"VENTAS DIRECTAS C.S.C.\",

\"SCountryCode\":\"MX\",

\"STaxId\":\"JES900109Q90\",

\"SName\":\"LEVI STRAUSS DE MEXICO, S.A. DE C.V.\",

\"Batch\":\"FMA\",

\"Serial\":\"0009584\",

\"Sucursal\":\"LEVIS1\",

\"IssuedTimeStamp\":\"\\/Date(1593021322000)\\/\",

\"Dtotal\":14041.790000,

\"Cancelado\":0,

\"DocumentGUID\":\"fa5e0fd0-7b01-4ac7-abe1-d494f9211c32\",

\"InternalID\":\"9584\",

\"DCurrency\":\"MXN\",

\"Year\":\"2020\",

\"estado_EnrolledTimeStamp\":null,

\"EsCancelable\":null,

\"Estado\":\"Vigente\",

\"EstatusCancelacion\":null,

\"async_Id\":null,

\"async_Uuid\":null,

\"DConvFactor\":1.000000}

]"

}

Las columnas que devuelve el listado son las siguientes:

SKind, RCountryCode, RTaxId, RName, SCountryCode, STaxId, SName, Batch, Serial, Sucursal, IssuedTimeStamp, DTotal, Cancelado, DocumentGUID, InternalID, DCurrency, Year, estado_EnrolledTimeStamp, EsCancelable, Estado, EstatusCancelacion, async_Id, async_Uuid y DConvFactor.

Si el parámetro ResponseFormat hubiera tenido valor XML, el valor devuelto en payload para la misma solicitud previa hubiera sido este (aunque se muestra plano, y en varias líneas, recuerda siempre que el valor de payload viene codificado Base64):

A pesar de que existe un parámetro de entrada PageSize que indica la cantidad de registros por página que se desean recuperar la transacción devuelve la información PageSize; esto porque existe un máximo de 500 registros que se pueden devolver, si el valor indicado en el parámetro PageSize es mayor que 500, entonces este se fija en dicho valor, por eso la respuesta aclara con qué tamaño de página fue recuperada toda la información. Siempre que el parámetro PageSize sea menor o igual a 500, lo devuelto en PageSize tendrá el mismo valor.

Es importante que en todas las transacciones que se ejecuten, recupere dentro de la respuesta el token que se devuelve ya que, para mantener la continuidad de la autenticación se necesita en la próxima llamada de cualquier transacción utilizar el último token devuelto.

En caso que en errorCode se devuelva 101 significa que la vida del token expiró, por tanto deberá autenticarse nuevamente y obtener un token nuevo con la función Authenticate.

En caso que en errorCode se devuelva 102 significa que el token es inválido, es decir, que al momento de desencriptar y parsear los valores que esta llamada incluye como información de autenticación falla.

_______________________________________________________________________________________________________

PAGINADO DE COMPROBANTES RECIBIDOS

Esta transacción en conjunto con el método "OBTENER_LISTA_DOCUMENTOS_RECIBIDOS" te permitirá obtener información importante de los comprobantes que especifiques a través de los filtros que tenemos disponibles, con esta funcionalidad podrás realizar un paginado de los comprobantes recibidos.

Para obtenerlos, debe realizar la llamada de la siguiente forma:

Request URL: https://api.mysuitetest.com/JsonServiceCall

Valores:

{

"jsonData": "string",

"token": "string",

"transactionName": "string"

}

Tome en cuenta los siguientes campos:

jsonData son los datos en forma de objeto JSON que conforman la materia prima para elaborar la búsqueda. Debe estar en Base64.
transactionName debe indicar la transacción que desea ocupar. En este caso SYSTEM_REQUEST
token valor obtenido de la transacción AUTHENTICATE.

El valor suministrado en el parámetro jsonData es la serialización (formato java), de una clase que contiene las propiedades method, ResponseFormat, Page, PageSize, Order y Filters.

Definición de las propiedades:

method: valor fijo OBTENER_LISTA_DOCUMENTOS_RECIBIDOS

ResponseFormat: Indica el formato que se desea como respuesta (valores posibles: JSON y XML); obligatorio.

Page: Indica la página que se quiere recuperar.

PageSize: Indica la cantidad de líneas por página.

Order: los campos que se pueden utilizar (de manera única o combinados, separados por coma), son: Tipo, RFC_Emisor, Razon_Emisor, Serie, Folio, Fecha_Emision, Monto y Fecha_Recepcion; cada campo utilizado puede tener asociado el modificador ASC o DESC. Parámetro opcional, en caso de no especificarse se asume Fecha_Recepcion DESC.

Filters: pueden existir 14 criterios de filtrado; a continuación los enumero, así como el valor a especificar en el atributo Name.

Ejemplo de valor para el parámetro jsonData (se muestra en varias líneas para que se entienda mejor, debe especificarse en una sola):

{

"method": "OBTENER_LISTA_DOCUMENTOS_RECIBIDOS",

"ResponseFormat": "JSON",

"Page": "1",

"PageSize": "3",

"Order": "Fecha_Emision DESC",

"Filters": "PEZpbHRlcnM+PEZpbHRlciBOYW1lPSJUaXBvIiBPcGVyPSI9IiBWYWx1ZTE9IjciIFZhbHVlMiA9IiIgLz48L0ZpbHRlcnM+"

}

<Filters>

<Filter Name="Tipo" Oper="=" Value1="7" Value2 ="" />

</Filters>

Pueden existir 14 criterios de filtrado; a continuación se enumeran, así como el valor a especificar en el atributo Name para cada uno:

Moneda: especificar el valor Moneda en el atributo Name (no es case sensitive).

Serie: especificar el valor Serie en el atributo Name (no es case sensitive).

Folio: especificar el valor Folio en el atributo Name (no es case sensitive).

Fecha de recepción: especificar el valor Fecha_Recepcion en el atributo Name (no es case sensitive). El formato a especificar es el entendido por MySql: yyyy-mm-hh HH:MM:ss (ej.: 2019-06-10 00:00:00).

Monto: especificar el valor Monto en el atributo Name (no es case sensitive).

Leído: especificar el valor Leido en el atributo Name (no es case sensitive). Valores posibles 0 o 1 en Value1 y Oper =.

Con observaciones: especificar el valor Con_Observaciones en el atributo Name (no es case sensitive). Valores posibles 0 o 1 en Value1 y Oper =.

RFC Emisor: especificar el valor RFC_Emisor en el atributo Name (no es case sensitive).

Razon Social Emisor: especificar el valor Razon_Emisor en el atributo Name (no es case sensitive).

Estado del documento: especificar el valor Estado_Documento en el atributo Name (no es case sensitive).

Cancelable: especificar el valor Cancelable en el atributo Name (no es case sensitive).

Estado de cancelación: especificar el valor Estado_Cancelacion en el atributo Name (no es case sensitive).

Value1 es el valor con el cual se va a comparar el operador Oper con el campo especificado en Name; en el caso de Oper con valor LIKE los % deben ser especificados.

Value2 siempre es vacío (pero obligatorio), mientras el valor de Oper no sea < > ; en este caso se necesita un segundo valor de comparación.

SOLICITUD

A continuación se muestra la manera en que debe realizarse la solicitud:

{

"jsonData": "ewogICJtZXRob2QiOiAiT0JURU5FUl9MSVNUQV9ET0NVTUVOVE9TX1JFQ0lCSURPUyIsCiAgIlJlc3BvbnNlRm9ybWF0IjogIkpTT04iLAogICJQYWdlIjogIjEiLAogICJQYWdlU2l6ZSI6ICIzIiwKICAiT3JkZXIiOiAiRmVjaGFfRW1pc2lvbiBERVNDIiwKICAiRmlsdGVycyI6ICJQRVpwYkhSbGNuTStQRVpwYkhSbGNpQk9ZVzFsUFNKVWFYQnZJaUJQY0dWeVBTSTlJaUJXWVd4MVpURTlJamNpSUZaaGJIVmxNaUE5SWlJZ0x6NDhMMFpwYkhSbGNuTSsiCn0=",

"token": "wAw8LzeFYnhlw2QcwxlQu5r19BZsJOIE+TV82o3mfh2dezakoLGC8vhDMRMZJzV7JHjqAXexjrXvimsjuEc=",

"transactionName": "SYSTEM_REQUEST"

}

RESPUESTA

La respuesta recibida, vendrá de la siguiente forma:

{

"result": true,

"payload": "Base64 de la estructura donde se contiene la información de los CFDI´s",

"token": "wAw+TV82o3my6PYF70KLwFeTQwg0Lq+mxDzom7O7JwosRoVVQR7bXE=",

"errorMsg": "",

"errorCode": 0

}

result, errorMsg y errorCode tienen la misma explicación en todas las transacciones como lo descrito en Authenticate

El valor devuelto en payload puede tener dos formatos diferentes (en dependencia de lo especificado en la propiedad ResponseFormat).

Ejemplo de valor devuelto en payload, formato JSON (aunque se muestra plano, y en varias líneas, el valor de payload viene codificado Base64):

{

"PageSize":3,

"LinesCount":81,

"PagesCount":27,

"Lines":

"[

{

\"Kind\":1,

\"RTaxId\":\"JES900109Q90\",

\"RName\":\"EMPRESA PRUEBAS A.C.\",

\"STaxId\":\"JES900109Q90\",

\"SName\":\"EMPRESA DE PRUEBAS SA DE CV\",

\"Batch\":\"ABB\",

\"Serial\":\"862\",

\"IssuedTimeStamp\":\"\\/Date(1592499192000)\\/\",

\"DTotal\":232.000000,

\"Pagado\":0,

\"PaidTimeStamp\":null,

\"Cancelado\":0,

\"DocumentGUID\":\"539fd147-f068-4331-9c88-66806d7f6e15\",

\"DCurrency\":\"MXN\",

\"Id\":1628,

\"RErrorCount\":0,

\"DeletedTimeStamp\":null,

\"EnrolledTimeStamp\":\"\\/Date(1592866539000)\\/\",

\"EstatusTimeStamp\":null,

\"EsCancelable\":null,

\"Estado\":\"Vigente\",

\"EstatusCancelacion\":null,

\"Leido\":0},

{

\"Kind\":1,

\"RTaxId\":\"JES900109Q90\",

\"RName\":\"EMPRESA DE PRUEBA\",

\"STaxId\":\"URU070122S28\",

\"SName\":\"RFC DE PRUEBA URU070122S28\",

\"Batch\":\"\",

\"Serial\":\"1\",

\"IssuedTimeStamp\":\"\\/Date(1591139876000)\\/\",

\"DTotal\":953.330000,

\"Pagado\":0,

\"PaidTimeStamp\":null,

\"Cancelado\":0,

\"DocumentGUID\":\"d9d0dadd-2282-412d-a2ad-69cfbc2b5e28\",

\"DCurrency\":\"MXN\",

\"Id\":1625,

\"RErrorCount\":0,

\"DeletedTimeStamp\":null,

\"EnrolledTimeStamp\":\"\\/Date(1591140686000)\\/\",

\"EstatusTimeStamp\":null,

\"EsCancelable\":null,

\"Estado\":\"Vigente\",

\"EstatusCancelacion\":null,

\"Leido\":0},

{

\"Kind\":1,

\"RTaxId\":\"JES900109Q90\",

\"RName\":\"Mi Cliente / Mi Receptor\",

\"STaxId\":\"JES900109Q90\",

\"SName\":\"LONJA MARINA Y PERECEDEROS SA DE CV\",

\"Batch\":\"UDT\",

\"Serial\":\"003\",

\"IssuedTimeStamp\":\"\\/Date(1586235600000)\\/\",

\"DTotal\":1474.200000,

\"Pagado\":0,

\"PaidTimeStamp\":null,

\"Cancelado\":0,

\"DocumentGUID\":\"83b1cc02-1d5d-4faa-9983-204137b67888\",

\"DCurrency\":\"MXN\",

\"Id\":1624,

\"RErrorCount\":0,

\"DeletedTimeStamp\":null,

\"EnrolledTimeStamp\":\"\\/Date(1586295719000)\\/\",

\"EstatusTimeStamp\":\"\\/Date(1590081373000)\\/\",

\"EsCancelable\":\"Cancelable con aceptación\",

\"Estado\":\"Vigente\",

\"EstatusCancelacion\":\"\",

\"Leido\":0

}

]"

}

Las columnas que devuelve el listado son las siguientes:

Kind, RTaxId, RName, STaxId, SName, Batch, Serial, IssuedTimeStamp, DTotal, Pagado, PaidTimeStamp, Cancelado, DocumentGUID, DCurrency, Id, RErrorCount, DeletedTimeStamp, EnrolledTimeStamp, EstatusTimeStamp, EsCancelable, Estado, EstatusCancelacion y Leido.

En caso que en errorCode se devuelva 101 significa que la vida del token expiró, por tanto deberá autenticarse nuevamente y obtener un token nuevo con la función Authenticate.

Related Articles
SYSTEM_REQUEST
PAGINADO DE COMPROBANTES EMITIDOS Esta transacción en conjunto con el método "OBTENER_LISTA_DOCUMENTOS_EMITIDOS" te permitirá obtener información importante de los comprobantes que especifiques a través de los filtros que tenemos disponibles, con ...
NUEVO ESQUEMA DE CANCELACIÓN 2022 CLIENTES ENDPOINT
Solicitud de Cancelación <soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ws="http://www.fact.com.mx/schema/ws"> <soap:Header/> <soap:Body> <ws:JsonServiceCall> <ws:jsonData>{ "motivo": "02", "emisor": "JES900109Q90", ...
GET_DOCUMENT_RETENCIONES
En MYSuite podrás utilizar este método que te ayudara a obtener la representación gráfica de un comprobante de retenciones conforme lo marca el Anexo 20 vigente y/o el XML del CFDI de Retención emitido. SOLICITUD <soapenv:Envelope ...
CANCELAR_RETENCION_SINGLE_MYSUITE
Para ocupar la nueva transacción correspondiente al servicio de cancelación del SAT, revisar nueva transacción "CANCELAR_RETENCION_SINGLE_MYSUITE_3" que se encuentra en el siguiente enlace: ...
RECEPCIÓN
En MYSuite podrás utilizar este método que no solamente te ayudará a revisar y validar la conformación de un CFDI como lo estipula el Anexo 20 vigente, indicándote si el CFDI cumple con lo que la autoridad fiscal dispone, también te permitirá que el ...

SYSTEM_REQUEST

SYSTEM_REQUEST

Related Articles

SYSTEM_REQUEST

NUEVO ESQUEMA DE CANCELACIÓN 2022 CLIENTES ENDPOINT

GET_DOCUMENT_RETENCIONES

CANCELAR_RETENCION_SINGLE_MYSUITE

RECEPCIÓN