TF Fiscal

Plataforma e integraciones

RPA

9 endpoints

La API de RPA permite registrar prestadores persona física, calcular y emitir recibos de pago a autónomos, obtener el PDF y generar el cierre mensual para la contabilidad. El RPA no es un documento fiscal electrónico: no hay transmisión a la autoridad fiscal, ni firma digital, ni clave de acceso, ni protocolo — y por eso tampoco existe entorno de homologación. La empresa emisora se resuelve por el token, nunca por el cuerpo de la solicitud. Disponible solo para empresas emisoras de NF-e.

EndpointMétodoDescripción
/api/rpa/prestador/savePOSTRegistrar/actualizar prestador
/api/rpa/prestador/get_listPOSTListar prestadores
/api/rpa/previewPOSTCalcular sin emitir
/api/rpa/createPOSTEmitir RPA
/api/rpa/get_listPOSTListar RPA
/api/rpa/get_detailPOSTDetallar RPA
/api/rpa/get_pdfPOSTObtener PDF del RPA
/api/rpa/estornarPOSTRevertir RPA
/api/rpa/report/monthlyPOSTCierre mensual

INSS e IRRF se calculan por período y por persona, no por recibo: el tope del INSS y el tramo progresivo del IRRF consideran todo lo ya pagado al mismo CPF en el mes. Por eso el segundo pago del mes al mismo prestador puede tener una retención mayor que el primero. La tabla de INSS/IRRF la mantiene la plataforma por año calendario — no hay nada que registrar. Mientras los valores de un año nuevo no hayan sido validados por un contador, /preview sigue calculando y /create responde con error, en lugar de emitir un recibo con retención no verificada.

POST/api/rpa/prestador/save

Registrar/actualizar prestador

Crea o actualiza el registro del prestador persona física. El CPF identifica al prestador dentro de la empresa: no se permiten dos registros con el mismo CPF. La persona física no es emisora — no necesita cuenta ni certificado.

Headers obligatorios

HeaderTipoDescripción
tokenstringToken de la empresa emisora
signstringFirma MD5: MD5(token + path + body + timestamp)
timestampstringUnix timestamp en segundos

Body

CampoTipoDescripción
idstringID del registro. Vacío crea; con valor actualiza
cpf *stringCPF del prestador (11 dígitos)
name *stringNombre completo del prestador
nitstringNIT/PIS/PASEP. Sin él la contabilidad no puede declarar en eSocial
qtdDependentesintDependientes para deducción del IRRF (deducción mensual, no por recibo)
ativoboolPrestador activo

* Campo obligatorio.

POST/api/rpa/prestador/get_list

Listar prestadores

Headers obligatorios

HeaderTipoDescripción
tokenstringToken de la empresa emisora
signstringFirma MD5: MD5(token + path + body + timestamp)
timestampstringUnix timestamp en segundos

Body

CampoTipoDescripción
pageintPágina (predeterminado 1)
pageSizeintÍtems por página (predeterminado 20)
keywordstringBúsqueda por nombre o CPF
somenteAtivosboolDevuelve solo prestadores activos
POST/api/rpa/preview

Calcular sin emitir

Calcula la retención sin guardar nada: no crea recibo ni consume numeración. Es el paso recomendado antes de confirmar un pago — en el RPA el prestador recibe menos que el importe acordado, y la emisión no se puede deshacer (la reversión no devuelve el número). El preview nunca se bloquea: si la tabla de un año todavía no fue validada, calcula igualmente y lo señala en avisos, mientras que /create lo rechaza.

Headers obligatorios

HeaderTipoDescripción
tokenstringToken de la empresa emisora
signstringFirma MD5: MD5(token + path + body + timestamp)
timestampstringUnix timestamp en segundos

Body

CampoTipoDescripción
prestadorId *stringID del prestador (devuelto por /prestador/save)
dataPagamento *stringFecha del pago (AAAA-MM-DD). Define el período — régimen de caja
valorBruto *decimalImporte bruto del servicio
outrasDeducoesdecimalPensión alimenticia y similares
baseInssOutrosTomadoresdecimalBase de INSS ya consumida por otros pagadores en el período. Es un total mensual, según el comprobante del prestador — el tope del INSS es de la persona, no del pagador
valorInssOutrosTomadoresdecimalINSS ya retenido por otros pagadores (informativo)

* Campo obligatorio.

POST/api/rpa/create

Emitir RPA

Emite el recibo. El cálculo se rehace en el servidor al guardar, bajo bloqueo por (CPF, período) — el importe devuelto por preview no se acepta como entrada. Exige la tabla del año confirmada.

Headers obligatorios

HeaderTipoDescripción
tokenstringToken de la empresa emisora
signstringFirma MD5: MD5(token + path + body + timestamp)
timestampstringUnix timestamp en segundos

Body

CampoTipoDescripción
prestadorId *stringID del prestador (devuelto por /prestador/save)
dataPagamento *stringFecha del pago (AAAA-MM-DD). Define el período — régimen de caja
valorBruto *decimalImporte bruto del servicio
descricaoServico *stringDescripción del servicio prestado
codigoServicoMunicipalstringCódigo del servicio en el municipio (opcional)
outrasDeducoesdecimalPensión alimenticia y similares
baseInssOutrosTomadoresdecimalBase de INSS ya consumida por otros pagadores en el período. Es un total mensual, según el comprobante del prestador — el tope del INSS es de la persona, no del pagador
serieintSerie del recibo. Si se omite, usa 1

* Campo obligatorio.

POST/api/rpa/get_list

Listar RPA

Headers obligatorios

HeaderTipoDescripción
tokenstringToken de la empresa emisora
signstringFirma MD5: MD5(token + path + body + timestamp)
timestampstringUnix timestamp en segundos

Body

CampoTipoDescripción
pageintPágina (predeterminado 1)
pageSizeintÍtems por página (predeterminado 20)
competenciaintPeríodo en formato AAAAMM
cpfstringCPF del prestador (11 dígitos)
statusstringFiltro: emitido o estornado
POST/api/rpa/get_detail

Detallar RPA

Headers obligatorios

HeaderTipoDescripción
tokenstringToken de la empresa emisora
signstringFirma MD5: MD5(token + path + body + timestamp)
timestampstringUnix timestamp en segundos

Body

CampoTipoDescripción
id *stringID del recibo

* Campo obligatorio.

POST/api/rpa/get_pdf

Obtener PDF del RPA

Devuelve la URL del PDF del recibo. Se genera en la primera llamada y se reutiliza después. El PDF deriva de lo almacenado — incluida la memoria de cálculo congelada — por lo que regerar nunca altera importes.

Headers obligatorios

HeaderTipoDescripción
tokenstringToken de la empresa emisora
signstringFirma MD5: MD5(token + path + body + timestamp)
timestampstringUnix timestamp en segundos

Body

CampoTipoDescripción
id *stringID del recibo
regerarboolFuerza regenerar el PDF en lugar de reutilizar

* Campo obligatorio.

POST/api/rpa/estornar

Revertir RPA

Reversión lógica — no existe cancelación, porque el RPA no se transmite a ningún lugar. El recibo permanece en el listado marcado como revertido, sale de todos los totales del cierre y el número no vuelve a la numeración. Los recibos posteriores del mismo período no se recalculan.

Headers obligatorios

HeaderTipoDescripción
tokenstringToken de la empresa emisora
signstringFirma MD5: MD5(token + path + body + timestamp)
timestampstringUnix timestamp en segundos

Body

CampoTipoDescripción
id *stringID del recibo
motivo *stringMotivo de la reversión (mínimo 5 caracteres)

* Campo obligatorio.

POST/api/rpa/report/monthly

Cierre mensual

Devuelve, por recibo, lo que eSocial exige (CPF, NIT, categoría, bases e importes de cada retención), los totales del período y las alertas que impiden la declaración: temEstorno y prestadoresSemNit. Los recibos revertidos aparecen en itens pero no entran en los totales.

Headers obligatorios

HeaderTipoDescripción
tokenstringToken de la empresa emisora
signstringFirma MD5: MD5(token + path + body + timestamp)
timestampstringUnix timestamp en segundos

Body

CampoTipoDescripción
competencia *intPeríodo en formato AAAAMM

* Campo obligatorio.