Adjustment Documents

Listar documentos de ajuste

Changed on

Devuelve una lista paginada de los documentos de ajuste de la organización, del más reciente al más antiguo. Se usa para recorrer o conciliar los documentos registrados, por ejemplo todos los de un Customer con customer_id. Incluye los documentos anulados, con status=void. Los filtros son opcionales y se combinan con AND. La paginación es por cursor: reenvía el next_cursor de la respuesta para avanzar de página; es null en la última página.

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

get/adjustment-documents

Request

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

Query parameters

page_sizeinteger

Cantidad máxima de elementos por página (entre 1 y 100).

Example:50
next_cursorstring

Cursor de la página siguiente. Envía el next_cursor devuelto en la respuesta anterior para continuar; omítelo en la primera llamada.

customer_idstring

Filtra por el identificador público del Customer (cus_...).

Example:cus_2LA_3hWXZR7NlI5kV-c8cShQ2IGvj8oV
account_idstring

Filtra por el identificador público de la Account (acc_...).

Example:acc_00000000000000000000000000000000
invoice_idstring

Filtra por el identificador público de la Invoice de origen (in_...).

Example:in_00000000000000000000000000000000
type'credit_note' | 'supplier_invoice'

An enumeration.

Filtra por categoría del documento: credit_note o supplier_invoice.

statusAdjustmentDocumentStatus[]

Filtra por estado del documento: available, used o void. Puede repetirse para incluir varios estados, hasta 3 veces.

external_idstring

Filtra por el identificador definido por la organización (1 a 256 caracteres).

Example:NC-2026-00123
issued_at_fromstring date-time

Devuelve solo los documentos emitidos desde esta fecha y hora (inclusive), en formato ISO 8601 con hora; una fecha sola se rechaza. Sin zona horaria se interpreta como UTC.

Example:2026-01-01T00:00:00Z
issued_at_tostring date-time

Devuelve solo los documentos emitidos hasta esta fecha y hora (inclusive), en formato ISO 8601 con hora; una fecha sola se rechaza. Sin zona horaria se interpreta como UTC. No puede ser anterior a issued_at_from.

Example:2026-03-31T23:59:59Z

Headers

x-account-keystring

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

Response

Successful Response

next_cursorstring

Cursor para pedir la página siguiente. null si no hay más resultados.

Example response

{
  "items": [
    {
      "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"
    }
  ],
  "next_cursor": "eyJpZCI6ICJhZF8wMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMCIsICJjcmVhdGVkX2F0IjogIjIwMjYtMDctMTNUMTU6MDQ6MDUifQ"
}

Changes