Crea un CFDi de retención
Parámetros URI
No se tienen parámetros
Atributos de la petición
FolioInt ( string )
Atributo opcional para control interno del contribuyente que expresa el folio del documento que ampara la retención e información de pagos.Permite números y/o letras.
Max length: 20
FechaExp ( string )
Atributo requerido para la expresión de la fecha y hora de expedición del documento de retención e información de pagos. Se expresa en la forma yyyy-mmddThh:mm:ssTZD-6, de acuerdo con la especificación ISO 8601.
Required
Matching regular expression pattern: ^-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T(([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))$
CveRetenc ( string )
Atributo requerido para expresar la clave de la retención e información de pagos de acuerdo al catálogo publicado en internet por el SAT.
Required
Matching regular expression pattern: 0[1-9]|1[0-9]|2[0-6]
DescRetenc ( string )
Atributo opcional que expresa la descripción de la retención e información de pagos en caso de que en el atributo CveRetenc se haya elegido el valor para 'otro tipo de retenciones'.
Max length: 20
Emisor ( Emisor )
Nodo requerido para expresar la información del contribuyente emisor del documento electrónico de retenciones e información de pagos.
Required
Receptor ( Receptor )
Nodo requerido para expresar la información del contribuyente receptor.
Required
Periodo ( Periodo )
Nodo requerido para expresar el periodo que ampara el documento de retenciones e información de pagos.
Required
Totales ( Totales )
Nodo requerido para expresar el total de las retenciones e información de pagos efectuados en el período que ampara el documento.
Required
Complemento ( Complemento )
Nodo opcional donde se incluirá el complemento Timbre Fiscal Digital de manera obligatoria y los nodos complementarios determinados por el SAT, de acuerdo a las disposiciones particulares a un sector o actividad específica.
Id ( string )
Identificador unico de Facturama
CadenaOriginal ( string )
Cadena original de la retencion
IsCanceled ( boolean )
Indica si la retencion esta cancelada
Sello ( string )
Sello Digital del CFDI (solo lectura)
Argumentos de respuesta
RetencionesFolioInt ( string )
Atributo opcional para control interno del contribuyente que expresa el folio del documento que ampara la retención e información de pagos.Permite números y/o letras.
Max length: 20
FechaExp ( string )
Atributo requerido para la expresión de la fecha y hora de expedición del documento de retención e información de pagos. Se expresa en la forma yyyy-mmddThh:mm:ssTZD-6, de acuerdo con la especificación ISO 8601.
Required
Matching regular expression pattern: ^-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T(([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))$
CveRetenc ( string )
Atributo requerido para expresar la clave de la retención e información de pagos de acuerdo al catálogo publicado en internet por el SAT.
Required
Matching regular expression pattern: 0[1-9]|1[0-9]|2[0-6]
DescRetenc ( string )
Atributo opcional que expresa la descripción de la retención e información de pagos en caso de que en el atributo CveRetenc se haya elegido el valor para 'otro tipo de retenciones'.
Max length: 20
Emisor ( Emisor )
Nodo requerido para expresar la información del contribuyente emisor del documento electrónico de retenciones e información de pagos.
Required
Receptor ( Receptor )
Nodo requerido para expresar la información del contribuyente receptor.
Required
Periodo ( Periodo )
Nodo requerido para expresar el periodo que ampara el documento de retenciones e información de pagos.
Required
Totales ( Totales )
Nodo requerido para expresar el total de las retenciones e información de pagos efectuados en el período que ampara el documento.
Required
Complemento ( Complemento )
Nodo opcional donde se incluirá el complemento Timbre Fiscal Digital de manera obligatoria y los nodos complementarios determinados por el SAT, de acuerdo a las disposiciones particulares a un sector o actividad específica.
Id ( string )
Identificador unico de Facturama
CadenaOriginal ( string )
Cadena original de la retencion
IsCanceled ( boolean )
Indica si la retencion esta cancelada
Sello ( string )
Sello Digital del CFDI (solo lectura)
http method:
POST
https://api.facturama.mx/Retenciones
Ejemplo de Petición
application/json, text/json
{ "FolioInt": "sample string 1", "FechaExp": "sample string 2", "CveRetenc": "sample string 3", "DescRetenc": "sample string 4", "Emisor": { "RfcEmisor": "sample string 1", "NomDenRazSocE": "sample string 2", "CurpE": "sample string 3" }, "Receptor": { "Nacionalidad": "sample string 1", "Nacional": { "RfcRecep": "sample string 1", "NomDenRazSocR": "sample string 2", "CurpR": "sample string 3" }, "Extranjero": { "NumRegIdTrib": "sample string 1", "NomDenRazSocR": "sample string 2" } }, "Periodo": { "MesIni": 1, "MesFin": 2, "Ejerc": 3 }, "Totales": { "MontoTotOperacion": 1.0, "MontoTotGrav": 2.0, "MontoTotExent": 3.0, "MontoTotRet": 4.0, "ImpRetenidos": [ { "BaseRet": 1.0, "Impuesto": "sample string 1", "MontoRet": 2.0, "TipoPagoRet": "sample string 3" }, { "BaseRet": 1.0, "Impuesto": "sample string 1", "MontoRet": 2.0, "TipoPagoRet": "sample string 3" } ] }, "Complemento": { "ServiciosPlataformasTecnologicas": { "Servicios": [ { "ImpuestosTrasladadosdelServicio": { "Base": 1.0, "Impuesto": "sample string 2", "TasaCuota": 3.0, "Importe": 4.0 }, "ContribucionGubernamental": { "ImpContrib": 1.0, "EntidadDondePagaLaContribucion": "sample string 2" }, "ComisionDelServicio": { "Base": 1.0, "Porcentaje": 1.0, "Importe": 1.0 }, "FormaPagoServ": "sample string 1", "TipoDeServ": "sample string 2", "SubTipServ": "sample string 3", "RfcTerceroAutorizado": "sample string 4", "FechaServ": "sample string 5", "PrecioServSinIva": 6.0 }, { "ImpuestosTrasladadosdelServicio": { "Base": 1.0, "Impuesto": "sample string 2", "TasaCuota": 3.0, "Importe": 4.0 }, "ContribucionGubernamental": { "ImpContrib": 1.0, "EntidadDondePagaLaContribucion": "sample string 2" }, "ComisionDelServicio": { "Base": 1.0, "Porcentaje": 1.0, "Importe": 1.0 }, "FormaPagoServ": "sample string 1", "TipoDeServ": "sample string 2", "SubTipServ": "sample string 3", "RfcTerceroAutorizado": "sample string 4", "FechaServ": "sample string 5", "PrecioServSinIva": 6.0 } ], "Periodicidad": "sample string 1", "NumServ": 2, "MontToServSIva": 3.0, "TotalIvaTrasladado": 4.0, "TotalIvaRetenido": 5.0, "TotalIsrRetenido": 6.0, "DifIvaEntregadoPrestServ": 7.0, "MonTotalporUsoPlataforma": 8.0, "MonTotalContribucionGubernamental": 1.0 }, "TimbreFiscalDigital": { "Version": "sample string 1", "UUID": "sample string 2", "FechaTimbrado": "2024-12-22T06:23:23.0362664-06:00", "SelloCFD": "sample string 4", "NoCertificadoSAT": "sample string 5", "SelloSAT": "sample string 6", "RfcProvCertif": "sample string 7" }, "Intereses": { "Version": "sample string 1", "SistFinanciero": 0, "RetiroAORESRetInt": 0, "OperFinancDerivad": 0, "MontIntNominal": 2.0, "MontIntReal": 3.0, "Perdida": 4.0 } }, "Id": "sample string 5", "CadenaOriginal": "sample string 6", "IsCanceled": true, "Sello": "sample string 8" }
Ejemplo de Respuesta
application/json, text/json
{ "FolioInt": "sample string 1", "FechaExp": "sample string 2", "CveRetenc": "sample string 3", "DescRetenc": "sample string 4", "Emisor": { "RfcEmisor": "sample string 1", "NomDenRazSocE": "sample string 2", "CurpE": "sample string 3" }, "Receptor": { "Nacionalidad": "sample string 1", "Nacional": { "RfcRecep": "sample string 1", "NomDenRazSocR": "sample string 2", "CurpR": "sample string 3" }, "Extranjero": { "NumRegIdTrib": "sample string 1", "NomDenRazSocR": "sample string 2" } }, "Periodo": { "MesIni": 1, "MesFin": 2, "Ejerc": 3 }, "Totales": { "MontoTotOperacion": 1.0, "MontoTotGrav": 2.0, "MontoTotExent": 3.0, "MontoTotRet": 4.0, "ImpRetenidos": [ { "BaseRet": 1.0, "Impuesto": "sample string 1", "MontoRet": 2.0, "TipoPagoRet": "sample string 3" }, { "BaseRet": 1.0, "Impuesto": "sample string 1", "MontoRet": 2.0, "TipoPagoRet": "sample string 3" } ] }, "Complemento": { "ServiciosPlataformasTecnologicas": { "Servicios": [ { "ImpuestosTrasladadosdelServicio": { "Base": 1.0, "Impuesto": "sample string 2", "TasaCuota": 3.0, "Importe": 4.0 }, "ContribucionGubernamental": { "ImpContrib": 1.0, "EntidadDondePagaLaContribucion": "sample string 2" }, "ComisionDelServicio": { "Base": 1.0, "Porcentaje": 1.0, "Importe": 1.0 }, "FormaPagoServ": "sample string 1", "TipoDeServ": "sample string 2", "SubTipServ": "sample string 3", "RfcTerceroAutorizado": "sample string 4", "FechaServ": "sample string 5", "PrecioServSinIva": 6.0 }, { "ImpuestosTrasladadosdelServicio": { "Base": 1.0, "Impuesto": "sample string 2", "TasaCuota": 3.0, "Importe": 4.0 }, "ContribucionGubernamental": { "ImpContrib": 1.0, "EntidadDondePagaLaContribucion": "sample string 2" }, "ComisionDelServicio": { "Base": 1.0, "Porcentaje": 1.0, "Importe": 1.0 }, "FormaPagoServ": "sample string 1", "TipoDeServ": "sample string 2", "SubTipServ": "sample string 3", "RfcTerceroAutorizado": "sample string 4", "FechaServ": "sample string 5", "PrecioServSinIva": 6.0 } ], "Periodicidad": "sample string 1", "NumServ": 2, "MontToServSIva": 3.0, "TotalIvaTrasladado": 4.0, "TotalIvaRetenido": 5.0, "TotalIsrRetenido": 6.0, "DifIvaEntregadoPrestServ": 7.0, "MonTotalporUsoPlataforma": 8.0, "MonTotalContribucionGubernamental": 1.0 }, "TimbreFiscalDigital": { "Version": "sample string 1", "UUID": "sample string 2", "FechaTimbrado": "2024-12-22T06:23:23.0787388-06:00", "SelloCFD": "sample string 4", "NoCertificadoSAT": "sample string 5", "SelloSAT": "sample string 6", "RfcProvCertif": "sample string 7" }, "Intereses": { "Version": "sample string 1", "SistFinanciero": 0, "RetiroAORESRetInt": 0, "OperFinancDerivad": 0, "MontIntNominal": 2.0, "MontIntReal": 3.0, "Perdida": 4.0 } }, "Id": "sample string 5", "CadenaOriginal": "sample string 6", "IsCanceled": true, "Sello": "sample string 8" }