TRtrytoku
Adjustment Documents

Actualizar documento de ajuste

Changed on

Actualiza un documento de ajuste. is_void controla su disponibilidad al momento del cobro (los documentos anulados se excluyen y no pueden aplicarse como saldo a favor); metadata reemplaza la metadata libre almacenada. Ambos campos son opcionales: omite un campo para dejarlo sin cambios y envía metadata={} para vaciarla. La llamada es idempotente: fijar un campo a su valor actual no tiene efecto y devuelve el documento sin cambios.

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

patch/adjustment-documents/{id_adjustment_document}

Request

  • Base URL
    https://api.trytoku.com
  • URL
    https://api.trytoku.com/adjustment-documents/{id_adjustment_document}
  • Auth
    API key in header x-api-key

Path parameters

id_adjustment_documentstring required

Identificador público del documento de ajuste (ad_...).

Example:ad_00000000000000000000000000000000

Headers

x-account-keystring

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

Request body

is_voidboolean

Envía true para anular el documento (se excluirá de la disponibilidad al momento del cobro) o false para restaurar un documento previamente anulado. Omítelo para dejarlo sin cambios.

issued_atstring date-time

Fija la fecha y hora de emisión (UTC) cuando se envía. Omítelo para dejarlo sin cambios.

metadataobject

Reemplaza la metadata libre almacenada cuando se envía. Omítelo para dejarlo sin cambios; envía {} para vaciarla.

Example request

{
  "is_void": true,
  "issued_at": "2026-07-13T00:00:00Z",
  "metadata": {
    "documento": "https://example.com/nc/123.pdf",
    "motivo": "Devolución parcial"
  }
}

Response

Successful Response

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