API Endpoints

Endpoint para emitir un Recibo de Pago Electrónico (REP)

post
https://sandbox-api.alanube.co/cri/v1/payment-receipts

Este endpoint permite emitir un recibo electrónico al Ministerio de Hacienda

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Objeto con la información del comprobante de pago

Objeto con la información para crear un recibo electronico de pago

currency
object

Moneda aplicable al Recibo Electrónico de Pago. Si no se incluye, se utilizará CRC(Colones) como moneda predeterminada.

idDoc
object
required

Objeto que contiene información necesaria para identificar un documento.

sender
object

Objeto que contiene la información del emisor del documento.

receiver
object
required

Objeto que contiene la información del receptor del Recibo Electrónico de Pago (REP).

referenceDocuments
array of objects
required
length between 1 and 10

Información de referencia, se deberá asociar cada factura o documento que se esté afectando con la emisión del Recibo Electrónico de Pago (REP).

referenceDocuments*
string
^[0-9A-HJKMNP-TV-Z]{26}$

Id registrado por la API E-providers, en caso que la Factura Electrónica haya sido emitido a través de E-providers solo se necesita este dato para identificar el documento. En caso de que no se especifique, se deberá enviar toda la información del objeto.

string
enum

Tipo de documento de referencia para identificación interna. Obligatorio cuando se envíe el id del documento para determinar el tipo de documento referenciado.

  • FE: Factura Electrónica
  • RP: Recibo Electrónico de Pago
Allowed:
string
enum
^[0-9]{2}$

Tipo de documento de referencia. Se debe colocar el código correspondiente de la tabla de Tipo de Documento Referencia de Hacienda.

  • 01: Factura Electrónica
  • 07: Recibo Electrónico de Pago
Allowed:
string
length ≤ 50

Clave numérica del comprobante electrónico o consecutivo del documento de referencia.

date-time

Fecha de emisión del documento de referencia. No debe superar una antigüedad de 10 años.

string
enum
^[0-9]{2}$

Código de referencia. Consultar códigos en la tabla Tipo de referencia.

Allowed:
string
length between 3 and 180

Razón de referencia. Obligatoria cuando typeDoc es diferente a 13.

saleCondition
object
required
paymentMethod
array of objects
required
length between 1 and 4

Medios de pago del Recibo Electrónico de Pago (REP), contiene los montos desglosados por cada medio de pago utilizado. Se pueden utilizar hasta 4 tipos de medios de pago. Si se envía un solo objeto, no será necesario enviar el elemento "amountPaymentMethod".

paymentMethod*
string
enum
required

Medio de pago del Recibo Electrónico de Pago (REP). Este elemento aceptará una de las siguientes opciones:
"01" - Efectivo
"02" - Tarjeta
"03" - Cheque
"04" - Transferencia - depósito bancario
"05" - Recaudado por terceros
"06" - SINPE MOVIL
"07" - Plataforma Digital
"99" - Otros. Al utilizar la opción "99", se deberá enviar la descripción del medio de pago en el elemento "otherPaymentMethodDetails".

string
length ≤ 100
^[a-zA-Z0-9 ]*$

Descripción del medio de pago utilizado por el cliente en el Recibo Electrónico de Pago (REP). Este campo es obligatorio si el valor de "id" es "99".

string
^\d+(\.\d{1,5})?$

Detalla el monto correspondiente al medio de pago indicado en el elemento "id". Este campo se vuelve obligatorio cuando se utiliza más de un medio de pago en el Recibo Electrónico de Pago (REP).

itemDetails
array of objects
required
length between 1 and 100

Detalles de los items

itemDetails*

Cada línea de detalle agregada en el Recibo Electrónico de Pago (REP) representa el pago de un comprobante a crédito en las ventas de servicios prestados al Estado y en las ventas a crédito en IVA hasta 90 días (Artículo 27, LIVA). Se debe enviar una línea por cada tarifa.

string
required
length between 3 and 200

Se debe detallar el pago al comprobante original, indicando al menos el número de la cuota.

string
required
^[0-9]+([.])?([0-9]+)?$

Campo editable, corresponde al monto del pago a registrar en el Recibo de Pago Electrónico para el cálculo del IVA respectivo.

taxes
array of objects
length between 1 and 1000

Array de objetos con los detalles de los impuestos aplicados. Se pueden utilizar para una misma línea la cantidad de códigos de impuestos que se requieran para cada pago realizado.

taxes
string
enum
required

Código del impuesto. Se debe colocar el código que corresponda de la tabla de 'Código del Impuesto' de Hacienda.

string
enum

Código de la tarifa del impuesto. Se debe colocar el código que corresponda de la tabla de 'Tarifa Impuesto Valor Agregado' de Hacienda. Se convierte en obligatorio cuando en el elemento code se utilice el código 01 o 07.

string

Descripción detallada del impuesto cobrado cuando en el elemento 'code' se utiliza el código 99 - Otros.

string
required
^[0-9]+([.])?([0-9]+)?$

Tarifa del impuesto. Este campo es de condición obligatoria, cuando el producto/servicio este gravado con algún impuesto.

string
enum

Factor del impuesto. Este campo es de condición obligatoria, cuando el producto/servicio posea un factor para su cálculo. Cuando en el código de impuesto se defina IVA Bienes Usados se deberá utilizar este campo con el factor establecido por el Ministerio de Hacienda.

Allowed:
string
required
^[0-9]{1,13}([.][0-9]{1,5})?$

Monto del impuesto. Este campo será de condición obligatoria, cuando el producto/servicio este gravado con algún impuesto. Es un número decimal compuesto por 13 enteros y 5 decimales.

string
required
^[0-9]+([.])?([0-9]+)?$

Total por línea de detalle. Será la sumatoria del campo subTotal + amount (del objeto taxes).

Responses

Updated about 2 months ago

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 2 months ago