Conceptos
Empresas y llaves, estado de cuentas por cobrar, cantidades en unidades menores, fechas y versiones locales.
Empresas
Cada clave de API pertenece exactamente a una empresa. Una clave sólo puede ver y cambiar los registros de esa empresa. Pedir un ID que pertenece a otra empresa devuelve 404 not_found, por lo que los registros de otras compañías no pueden ser descubiertos.
Situaciónes recebibles
| Situación | Significado |
|---|---|
draft |
Creado pero no activo. No se planean ni envían recordatorios. |
active |
Los recordatorios siguen el horario de la empresa. |
partially_paid |
Parte de la suma se registró como pagada; los recordatorios utilizan la cantidad restante. |
paid |
Los futuros recordatorios paran. |
paused |
Los recordatorios están en espera hasta que se reanuden. |
disputed |
El cliente discute la cantidad; no se envían recordatorios. |
cancelled |
Cerrado sin pago. No se envían recordatorios. |
Cuantía
Enviar cantidades como strings con hasta dos lugares decimales, por ejemplo "1250.00". Se acepta un coma como separador decimal ("1250,50"). Los importes deben ser positivos.
Respuestas devuelven entero unidades menores: amount_minor: 125000 1.250.00. Las monedas compatibles son EUR, GBP, TRY y USD. RemindCash nunca se convierte entre monedas.
Fechas y tiempos
due_datees un fecha del calendario local enYYYY-MM-DDformato, no un timetamp.- Instantes tales como
recorded_atosubmitted_atson los sellos ISO 8601 en UTC. - Los tiempos de envío de recordatorios se calculan en la zona horaria de la empresa (o del cliente) de la IANA, incluyendo cambios de ahorro de luz.
Versiones
Cada respuesta por cobrar incluye un version — una huella dactilar de 64 caracteres de su estado actual. Pase como expected_version cuando actualice un proyecto. Si el crédito cambió mientras tanto, la actualización es rechazado con 409 conflict en lugar de sobreescribir datos más recientes.
Recordatorios y seguridad
Las llamadas de API nunca envían recordatorios. El envío es decidido por el motor de recordatorio después de la activación en la aplicación. Antes de que cada envío vuelva a comprobar el estado de crédito, la cantidad pagada, la exclusión del cliente, el plan y la preparación del canal, por lo que no se recuerda el crédito por cobrar marcado o pausado.