Treli API
Docs
Soporte
  1. Cobros
  • Introducción
  • Autenticación
  • Errores
  • Suscripciones
    • Suscripción
    • Crear suscripción
      POST
    • Actualizar suscripción
      POST
    • Cancelar suscripción
      POST
    • Obtener suscripción
      GET
    • Eliminar descuento
      DELETE
    • Pausar suscripción
      POST
    • Reanudar suscripción
      POST
  • Items de suscripción
    • Obtener item de suscripción
      GET
    • Eliminar item de suscripción
      DELETE
    • Actualizar item de suscripción
      POST
    • Crear item de suscripción
      POST
  • Clientes
    • Cliente
    • Crear cliente
      POST
    • Actualizar cliente
      POST
    • Obtener cliente
      GET
  • Cobros
    • Cobro
    • Crear cobro
      POST
    • Registrar cobro parcial
      POST
    • Enviar notificación de cobro
      POST
    • Anular cobro
      POST
    • Marcar como incobrable
      POST
    • Pagar un cobro
      POST
    • Obtener un cobro
      GET
  • Facturas
    • Cargar factura
    • Obtener factura
  • Eventos
    • Evento
    • Tipos de eventos
  1. Cobros

Registrar cobro parcial

Developing
POST
/v1/collections/{id}/partial_payment
Permite modificar el valor total del cobro, por un valor menor, definiendo un cobro parcial. Válido únicamente para cobros con type=invoice y collection_method=collect.
Útil cuando tienes un cobro de tipo factura, y el cliente pago o va a realizar el pago por un monto inferior.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.treli.co/v1/collections//partial_payment' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic Og==' \
--data-raw '{
    "amount": "string",
    "create_collection_with_balance": true,
    "days_until_due": 0,
    "collection_rule_id": "string"
}'
Response Response Example
{
    "id": "col_zdhBDP4k3JiRHNQ4RBUHyHgu",
    "items": [
        {
            "id": "si_d7d2UrHwSG5A5YkYF7vfZmFf",
            "name": "Nombre del producto",
            "unit_price": "20000.00",
            "quantity": 1,
            "subtotal": "20000.00",
            "total": "20000.00",
            "product": {
                "id": "prod_GYzZ5BXNRu6DxqQcEPJNoeCk",
                "name": "Nombre del producto",
                "description": "string",
                "status": "active",
                "product_merchant_id": null,
                "product_invoicing_id": null,
                "product_shopify_id": null,
                "product_woocommerce_id": null,
                "created_date": "2024-11-15 16:44:50",
                "image": "http://example.com",
                "is_test": false,
                "invoice_settings": {
                    "invoice_tax_id": "12345",
                    "invoice_tax_percentage": "19"
                }
            },
            "price": {
                "id": "price_zUI6hNgEkX8sOLIUjnB9JpaQ",
                "unit_price": "20000.00",
                "pricing_model": "standard",
                "currency": "COP",
                "billing_period": "day",
                "billing_interval": 1,
                "type": "recurring",
                "pricing_tiers": null,
                "ntp_pricing": null,
                "created_date": "2024-11-15 16:44:50",
                "active": true,
                "is_test": false,
                "product_id": "prod_GYzZ5BXNRu6DxqQcEPJNoeCk"
            }
        }
    ],
    "discounts": [
        {
            "id": "sd_aYbDFQaOd7TmBl0I58D5ax8l",
            "code": "10OFF",
            "amount": "10000.00",
            "percent": "10.00"
        }
    ],
    "description": "Cobro de factura",
    "subtotal": "string",
    "total": "string",
    "status": "pending",
    "currency": "COP",
    "created_date": "2024-11-15 16:44:50",
    "paid_date": "2019-08-24T14:15:22Z",
    "voided_at_date": "2019-08-24T14:15:22Z",
    "due_date": "2019-08-24T14:15:22Z",
    "collection_method": "charge",
    "collection_rule_id": "string",
    "type": "invoice",
    "is_test": false,
    "tag": "string",
    "source": "string",
    "meta_data": {},
    "payment_settings": null,
    "invoice_settings": {
        "invoice_document_id": "string",
        "invoice_cost_center": "string"
    },
    "invoice_retentions": {
        "reteica": "string",
        "retefte": "string"
    },
    "collection_attempts": 0,
    "collecting": true,
    "next_collection_attempt_date": "2019-08-24T14:15:22Z",
    "payment_method_gateway": "string",
    "payment_method_type": "string",
    "paid_out_of_band": true,
    "out_of_band_proof": "http://example.com",
    "customer": "string",
    "billing_address": {
        "address_1": "string",
        "address_2": null,
        "city": "string",
        "state": "string",
        "postcode": null,
        "country": "string"
    },
    "subscription": "string",
    "invoice": "string",
    "invoice_number": "string",
    "checkout_url": "string"
}

Request

Authorization
Send your HTTP requests with an
Authorization
header that contains the word Basic followed by a space and a base64-encoded string username:password
Example:
Authorization: Basic *****************
Path Params
id
string 
required
ID del cobro
Body Params application/json
amount
string 
required
El valor total del cobro parcial, representado como una cadena flotante con dos decimales.
create_collection_with_balance
boolean 
optional
Controla si deseas crear un nuevo cobro con el saldo pendiente. Por ejemplo, si el total del cobro son 100,000yregistraruncobroparcialpor40,000, si create_collection_with_balance=true, se generará un nuevo cobro, asociado a la misma factura, por $60,000.
days_until_due
integer 
optional
Si create_collection_with_balance=true, define el número de días desde la creación del nuevo cobro hasta su vencimiento.
collection_rule_id
string 
optional
Si create_collection_with_balance=true, define el ID de la regla de cobro que definirá el comportamiento del nuevo cobro. La regla de cobro debe estar creada previamente en tu cuenta de Treli.
Examples

Responses

🟢200Success
application/json
Body
id
string 
read-onlyrequired
Identificador único del objeto.
Example:
col_zdhBDP4k3JiRHNQ4RBUHyHgu
items
array[object (Items) {8}] 
optional
Lista de items del cobro, cada uno con un precio adjunto. Únicamente requerido y permitido si type=one_time.
id
string 
read-onlyrequired
Identificador único del objeto.
Example:
si_d7d2UrHwSG5A5YkYF7vfZmFf
name
string 
read-onlyrequired
Nombre del producto del producto, al momento de asociarlo a la suscripción.
Example:
Nombre del producto
unit_price
string 
optional
Precio unitario a cobrar del item. Al asociar un precio a un object, si no se define, se utiliza el precio unitario configurado en el precio.
Example:
20000.00
quantity
integer 
required
Cantidad a cobrar del item.
>= 1
Example:
1
subtotal
string 
read-onlyoptional
Subtotal a cobrar del item antes, antes de descuentos.
Example:
20000.00
total
string 
read-onlyoptional
Total a cobrar del item, despues de descuentos.
Example:
20000.00
product
object (Producto) 
read-onlyoptional
Producto asociado al item.
price
object (Precio) 
read-onlyoptional
Precio asociado al item.
discounts
array [object {4}] 
optional
Lista de descuentos del cobro, cada uno con un cupon adjunto. Únicamente requerido y permitido si type=one_time.
id
string 
read-onlyrequired
Identificador único del objeto.
Example:
sd_aYbDFQaOd7TmBl0I58D5ax8l
code
string 
required
Código del cupon de descuento. Debe estar previamente creado en Treli.
Example:
10OFF
amount
string 
read-onlyrequired
Valor en dinero del descuento, representado como una cadena flotante con dos decimales.
Example:
10000.00
percent
string  | null 
read-onlyoptional
Valor en porcentaje del descuento, representado como una cadena flotante con dos decimales. Únicamente aplica si el cupón type=percent
Example:
10.00
description
string 
read-onlyrequired
Descripción del cobro. Se define automáticamente según el ´type´ del cobro.
Example:
Cobro de factura
subtotal
string  | null 
read-onlyrequired
Subtotal del cobro, antes de descuentos e impuestos, representado como una cadena flotante con dos decimales. null para los cobros de tipo factura (type=invoice)
total
string 
optional
Valor total a cobrar del cobro, antes de descuentos e impuestos, representado como una cadena flotante con dos decimales. Únicamente puedes especificar el total para cobros de type=invoice, de lo contrario, se calcula automáticamente según los items del cobro.
status
enum<string> 
read-onlyrequired
Un cobro que aún no haya sido pagado y aún no haya vencido, tendrá estado pending.
Despúes del due_date del cobro, tendrá estado past_due.
Un cobro puede pasar a estado uncollectible, despúes de past_due si sigue sin pagarse en una fecha límite posterior (según tu configuración de reintentos y recordatorios).
Allowed values:
pendingpaidpast_dueuncollectiblevoided
currency
enum<string> 
required
Código de moneda ISO de tres letras, en mayúsculas.
>= 3 characters<= 3 characters
Allowed values:
COPUSDBRLMXNPENARSCLP
Example:
COP
created_date
string <date-time>
read-onlyrequired
Fecha en la cual se creó el objeto.
Example:
2024-11-15 16:44:50
paid_date
string <date-time> | null 
read-onlyoptional
Fecha en la cual se pagó el cobro.
voided_at_date
string <date-time> | null 
read-onlyoptional
Fecha en la cual se anuló el cobro.
due_date
string <date-time> | null 
read-onlyoptional
Fecha de vencimiento del cobro.
collection_method
enum<string> 
required
Define como se cobrará el cobro.
Allowed values:
chargecollect
collection_rule_id
string  | null 
optional
El ID de la regla de cobro que definirá el comportamiento del cobro. La regla de cobro debe estar creada previamente en tu cuenta de Treli. Válido solo para cobros concollection_method=collect.
type
enum<string> 
required
El tipo de cobro. invoice y one_time son los únicos tipos de cobro que pueden ser especificados al momento de crear un cobro.
Para los cobros asociados a suscripciones, el tipo es definido automáticamente (subscription_creation y subscription_renewal)
Allowed values:
invoicesubscription_creationsubscription_renewalone_time
is_test
boolean 
read-onlyrequired
Tiene el valor false si el objeto existe en modo en producción o el valor true si el objeto existe en modo de prueba
Example:
false
tag
string  | null 
optional
Etiqueta asociada a la suscripción.
source
string 
required
Fuente por la cual se genero la suscripción
meta_data
object  | null 
optional
Conjunto de pares clave-valor que se pueden asociar a un objeto. Esto puede ser útil para almacenar información adicional sobre el objeto en un formato estructurado. Las claves se pueden eliminar publicando un valor vacío en los metadatos.
payment_settings
null 
optional
invoice_settings
object 
optional
Objeto con ajustes de facturación especificos para el cobro, distintos a los definidos en la configuración general de facturación. Unicamente disponible si haces uso de la automatización contable en Treli para la generación automática de facturas.
invoice_document_id
string 
required
invoice_cost_center
string 
required
invoice_retentions
object 
required
reteica
string 
required
retefte
string 
required
collection_attempts
integer 
read-onlyrequired
Número de intentos de cobro realizados para este cobro, según la configuración de recordatorios y reintentos. Solo los reintentos automáticos incrementan el recuento. En otras palabras, los intentos de pago manuales no afectan el programa de reintentos.
Para collection_method=charge, si se devuelve un error con un código de no reintentable o se han sobrepasado la cantidad de reintentos permitidos al método de pago, el cobro ya no podrá reintentarse a menos que se obtenga un nuevo método de pago. Los reintentos se seguirán programando y el número de intentos seguirá incrementándose, pero solo se ejecutarán si se obtiene un nuevo método de pago.
collecting
boolean 
required
Controla si Treli debe realizar reintentos automaticos de cobro. Cuando finalizan los reintentos programados según la configuración de recordatorios y reintentos, el valor pasa a false.
next_collection_attempt_date
string <date-time> | null 
read-onlyoptional
Una fecha en el futuro en la que se realizará el próximo reintento de cobro, según la configuración de recordatorios y reintentos.
payment_method_gateway
string 
read-onlyoptional
Pasarela de pago asociada a el método de pago utilizado en el cobro.
payment_method_type
string 
read-onlyoptional
Tipo de método de pago utilizado en el cobro.
paid_out_of_band
boolean 
required
Booleano que representa si un cobro se marcó como pagado por fuera de Treli.
out_of_band_proof
string <uri> | null 
optional
URL del soporte de pago. Válido solo para cobros conpaid_out_of_vand=true.
customer
string 
required
Identificación del cliente asociado al cobro.
billing_address
object 
read-onlyoptional
Dirección de facturación del cobro. Se define automáticamente al crear el cobro, según la dirección de facturación del cliente.
address_1
string 
required
address_2
null 
required
city
string 
required
state
string 
required
postcode
null 
required
country
string 
required
subscription
string  | null 
read-onlyoptional
ID de la suscripción asociada al cobro. Únicamente si collection_type=subscription_creation o collection_type=subscription_renewal
invoice
string  | null 
read-onlyoptional
ID de la factura asociada al cobro. Cobros contype=invoice siempre van a tener una factura asociada.
Cobros contype=one_time, subscription_renewal y subscription_creation tendrán una factura asociada si haces uso de la automatización contable en Treli para la generación automática de facturas.
invoice_number
string  | null 
read-onlyoptional
Número de la factura asociada al cobro. Cobros detype=invoice siempre van a tener una factura asociada.
Cobros contype=one_time, subscription_renewal y subscription_creation tendrán una factura asociada si haces uso de la automatización contable en Treli para la generación automática de facturas.
checkout_url
string 
read-onlyrequired
URL en la cual tu cliente puede realizar el pago del cobro.
Previous
Crear cobro
Next
Enviar notificación de cobro
Built with