TRtrytoku
Adjustment Documents

Obtener documento de ajuste

Changed on

Devuelve un documento de ajuste a partir de su identificador público, incluyendo su estado: available si todavía se puede aplicar como saldo a favor, used si ya se aplicó en un pago exitoso y void si está anulado.

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

get/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.

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.

status'available' | 'used' | 'void' required

Derived, not stored: void > used > available.

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