TRtrytoku
Adjustment Documents

Registrar nota de crédito o factura de proveedor

Changed on

Registra un documento de ajuste que la organización puede aplicar como saldo a favor al momento del cobro. Es idempotente por (organización, external_id): reenviar el mismo par devuelve el documento original con HTTP 200; la primera llamada responde HTTP 201. La moneda del documento se deriva de la Account asociada y no debe enviarse en el cuerpo de la petición. Si se envía id_origin_invoice, el documento solo se puede aplicar al pagar esa Invoice.

Límite de tasa: 20 solicitudes por segundo. Al superarlo, la API responde 429. Ver Límites de tasa.

post/adjustment-documents

Request

  • Base URL
    https://api.trytoku.com
  • URL
    https://api.trytoku.com/adjustment-documents
  • 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

amountnumber required

Monto positivo en la moneda de la Account. La precisión decimal debe coincidir con currency.decimals de la Account asociada (por ejemplo, 0 para CLP, 2 para USD, 4 para UF). La moneda no se acepta aquí — se deriva de id_account.

external_idstring required

Identificador único de este documento de ajuste definido por la organización. Junto con la organización autenticada forma la clave de idempotencia: enviar el mismo par dos veces devuelve el documento original.

id_accountstring required

Identificador de la Account contra la que se aplica el documento. Determina la moneda y debe pertenecer a la organización autenticada.

id_customerstring required

Identificador del Customer dueño del documento.

id_origin_invoicestring

Identificador opcional de la Invoice a la que se liga el documento. Si se envía, el documento solo se puede aplicar al pagar esa Invoice, que debe ser del mismo Customer y la misma Account y no estar pagada ni anulada. Si se omite, el documento se puede aplicar al pagar cualquier Invoice del mismo Customer y Account. No se puede cambiar después: para ligarlo a otra Invoice, anula el documento y registra uno nuevo con otro external_id.

issued_atstring date-time

Fecha y hora opcional (UTC) que representa cuándo se emitió el documento, a diferencia de cuándo se registró en Toku. Omítelo para dejarlo sin definir.

metadataobject

Metadata de pares clave/valor de formato libre que se muestra al Customer en el detalle del cobro. Los valores que sean URLs se muestran como enlaces. Por defecto está vacía.

type'credit_note' | 'supplier_invoice' required

An enumeration.

Example request

{
  "amount": 15000,
  "external_id": "NC-2026-00123",
  "id_account": "acc_00000000000000000000000000000000",
  "id_customer": "cus_2LA_3hWXZR7NlI5kV-c8cShQ2IGvj8oV",
  "id_origin_invoice": "in_00000000000000000000000000000000",
  "issued_at": "2026-07-13T00:00:00Z",
  "metadata": {
    "documento": "https://example.com/nc/123.pdf",
    "motivo": "Devolución parcial"
  }
}

Response

Reintento idempotente: se devuelve sin cambios el documento existente para ese par (organización, external_id).

amountnumber required

Monto del documento en la moneda de la Account.

created_atstring date-time required

Fecha y hora de registro en UTC.

external_idstring required

Identificador definido por la organización.

idstring required

Identificador del documento de ajuste.

id_accountstring required

Identificador de la Account.

id_customerstring required

Identificador del Customer.

id_origin_invoicestring

Identificador de la Invoice a la que está ligado el documento, que solo se puede aplicar al pagar esa Invoice. null si se puede aplicar al pagar cualquier Invoice del mismo Customer y Account.

is_voidboolean

Indica si el documento está anulado. Los documentos anulados se excluyen de la disponibilidad al momento del cobro.

issued_atstring date-time

Fecha y hora de emisión del documento (UTC), distinta de la de registro. null si no está definida.

metadataobject

Metadata de pares clave/valor de formato libre asociada al documento.

type'credit_note' | 'supplier_invoice' required

An enumeration.

Example response

{
  "amount": 15000,
  "external_id": "NC-2026-00123",
  "id": "ad_00000000000000000000000000000000",
  "id_account": "acc_00000000000000000000000000000000",
  "id_customer": "cus_2LA_3hWXZR7NlI5kV-c8cShQ2IGvj8oV",
  "id_origin_invoice": "in_00000000000000000000000000000000"
}

Changes