HomeGuíasAPI ReferenceChangelog
Log In
API Reference
  1. Recursos secundarios
  2. Adjustment Documents

Registrar nota de crédito o factura de proveedor

post
https://api.trytoku.com/adjustment-documents

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.

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

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Subclass of BaseModel that allows public aliases for fields. _aliases defines aliases in the way "external": "internal"

number
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.

string
required
length between 1 and 256

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.

string
required
^acc_[a-zA-Z0-9_\-]{32}$

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

string
required
^cus_[a-zA-Z0-9_\-]{32}$

Identificador del Customer dueño del documento.

string
^in_[a-zA-Z0-9_\-]{32}$

Identificador opcional de la Invoice que originó este documento de ajuste. Solo sirve como referencia de auditoría — no se usa para resolver el Customer ni la Account.

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.

metadata
object

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.

enum
required

Categoría del documento. credit_note = un crédito emitido al Customer; supplier_invoice = una factura de proveedor a descontar al momento del cobro. Se pueden agregar nuevas categorías sin necesidad de un nuevo endpoint.

Allowed:
Headers
string

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

date

Versión del API para esta petición, como cualquier fecha YYYY-MM-DD. Fija el contrato de la respuesta; si se omite, se deriva de la fecha de creación de la organización.

Responses

Updated 5 days ago

Did this page help you?
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 5 days ago

Did this page help you?