Campaigns

Asociar Invoices a Campaign

Changed on

Asocia deudas (Invoices) ya cargadas en Toku a una campaña ya creada.

Se usa después de crear la campaña, para definir qué deudas se van a cobrar en sus envíos. Cada deuda se identifica con product_id acompañado de due_date o de invoice_external_id; product_id siempre es obligatorio.

La operación es parcial: las deudas que no se encuentran no interrumpen al resto, y la respuesta informa cuántas quedaron asociadas (success), cuántas venían repetidas en la lista (duplicates) y cuántas no se encontraron (not_found), con el detalle de estas últimas en errors_detail.invoice_not_found. Reenviar la misma lista no duplica asociaciones.

post/campaigns/invoices

Request

  • Base URL
    https://api.trytoku.com
  • URL
    https://api.trytoku.com/campaigns/invoices
  • Auth
    API key in header x-api-key

Headers

x-account-keystring

Llave de API de una Account, para operar sobre esa Account en lugar de la principal.

Request body

id_campaignstring required

Identificador público de la campaña a la que se asocian las deudas.

Example request

{
  "id_campaign": "cam_bMMbOmVpAlsgRxl5H461TtHv929Xn2_T",
  "invoices": [
    {
      "due_date": "2021-01-15",
      "product_id": "9897af7987d9245d"
    }
  ]
}

Response

Resumen de cuántas deudas quedaron asociadas y cuáles no.

duplicatesinteger

Cantidad de entradas repetidas dentro de la lista enviada; se procesan una sola vez.

errorinteger

Cantidad de deudas que fallaron por otro motivo. Siempre 0 en esta operación.

format_errorinteger

Cantidad de deudas mal formateadas. Siempre 0 en esta operación.

not_foundinteger

Cantidad de deudas que no se encontraron en la organización.

successinteger

Cantidad de deudas encontradas que quedaron asociadas a la campaña.

Example response

{
  "errors_detail": {
    "invoice_is_void": [
      {
        "due_date": "2021-01-15",
        "product_id": "9897af7987d9245d"
      }
    ],
    "invoice_not_found": [
      {
        "due_date": "2021-01-15",
        "product_id": "9897af7987d9245d"
      }
    ]
  }
}

Changes