Skip to content
RemindCash

Créditos por cobrar

Lista, leído, crea y actualiza proyectos de crédito, con el objeto por cobrar y todas las esferas aceptadas.

Situación de la API pública

La API v1 utiliza las teclas de portador con un sistema operativo y requiere un período de plan activo. Los puntos finales de facturación y borrado no envían mensajes de clientes. Ejemplos usan los marcadores de posición — nunca pegan una clave real en código compartido.

Puntos finales

Método Camino Ámbito
GET /v1/receivables receivables:read
GET /v1/receivables/{id} receivables:read
POST /v1/receivables receivables:write
PATCH /v1/receivables/{id} receivables:write

Los pagos y los cambios de estado se describen en Pista de pago.

El objeto por cobrar

Campo Tipo Descripción
id entero ID receptible dentro de su empresa.
customer_id entero El cliente a quien pertenece este crédito.
amount_minor entero Cantidad adeudada en unidades menores.
paid_minor entero Total registrado como pagado, en unidades menores.
currency cuerda EUR, GBP, TRY o USD.
due_date cuerda Fecha de vencimiento local, YYYY-MM-DD.
status cuerda Véase statuses.
external_reference cuerda o nula Su propia referencia, única dentro de su empresa.
description cuerda o nula Texto libre, hasta 2.000 caracteres.
version cuerda Fingerprint utilizado para actualizaciones seguras.

Lista de cuentas por cobrar

Los resultados son ordenados por id y paginados (ver Pagination).

BASH
curl "https://api.remindcash.com/v1/receivables?per_page=25" \
  --header "Authorization: Bearer $REMINDCASH_API_KEY"
JSON
{
    "data": [
        {
            "id": 1,
            "customer_id": 1,
            "amount_minor": 125000,
            "paid_minor": 0,
            "currency": "USD",
            "due_date": "2026-10-15",
            "status": "draft",
            "external_reference": "INV-1042",
            "description": "Website redesign",
            "version": "4e6fea39ae2fab8ccb843657f081d276513739a71787c060a007b65e3acbbbc1"
        }
    ],
    "meta": { "current_page": 1, "per_page": 25, "total": 1 },
    "request_id": "762e599f-c42c-4c49-84fb-9a2f56a3f923"
}

Recuperar un crédito por cobrar

BASH
curl https://api.remindcash.com/v1/receivables/1 \
  --header "Authorization: Bearer $REMINDCASH_API_KEY"

Un ID desconocido —o que pertenece a otra empresa— devuelve 404 not_found.

Crear un proyecto de crédito

POST /v1/receivables crea un crédito por cobrar en el estado draft. Requiere un encabezado Idempotency-Key y devuelve 201 Created.

Campo Necesidades Reglas
customer Uno de customer o customer_id Objeto con display_name (requerido, max 160) y por lo menos uno de email o phone_e164. Opcional preferred_locale (en, tr) e IANA timezone.
customer_id Uno de customer o customer_id Un cliente existente en su empresa.
amount Sí. Positivo cadena decimal, hasta dos decimales.
currency Sí. EUR, GBP, TRY o USD.
due_date Sí. YYYY-MM-DD.
external_reference No. Max 160 caracteres. Una referencia ya usada en su empresa devuelve 409 conflict.
description No. Max 2.000 caracteres.

phone_e164 debe estar en formato E.164, por ejemplo +14155550100. Los campos como status o tenant_id son rechazados.

BASH
curl https://api.remindcash.com/v1/receivables \
  --request POST \
  --header "Authorization: Bearer $REMINDCASH_API_KEY" \
  --header "Idempotency-Key: create-inv-1042-0001" \
  --header "Content-Type: application/json" \
  --data '{
    "customer": { "display_name": "Studio North", "email": "billing@studionorth.example" },
    "amount": "1250.00",
    "currency": "USD",
    "due_date": "2026-10-15",
    "external_reference": "INV-1042"
  }'

Los nuevos clientes crearon de esta manera todavía necesitan su contacto verificado y el permiso grabado en la aplicación antes de que se pueda enviar cualquier recordatorio.

Actualizar un proyecto de crédito

PATCH /v1/receivables/{id} cambia un borrador. expected_version (el version por última vez leí) más al menos un campo para cambiar: customer_id, amount, currency, due_date, external_reference o description.

BASH
curl https://api.remindcash.com/v1/receivables/1 \
  --request PATCH \
  --header "Authorization: Bearer $REMINDCASH_API_KEY" \
  --header "Idempotency-Key: update-inv-1042-0001" \
  --header "Content-Type: application/json" \
  --data '{
    "expected_version": "4e6fea39ae2fab8ccb843657f081d276513739a71787c060a007b65e3acbbbc1",
    "due_date": "2026-10-20"
  }'

La respuesta contiene el crédito actualizado y su nuevo version. La actualización devuelve 409 conflict cuando:

  • expected_version ya no coincide (alguien lo cambió primero),
  • el crédito ya no es un proyecto,
  • es una ocurrencia de una recurriendo serie,
  • un pago existe e intenta cambiar el cliente, la cantidad o la moneda.