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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

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

amount

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.

external_id

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.

id_account

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.

id_customer

string

required

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

Identificador del Customer dueño del documento.

id_origin_invoice

string

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

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_at

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.

type

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

x-account-key

string

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

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

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

201Successful Response

401Faltan las credenciales o son inválidas.

403No tienes acceso a este recurso.

404El Customer, la Account o la Invoice de origen no existe bajo la organización autenticada.

422El cuerpo no pasó la validación: campo faltante, tipo no soportado, monto no positivo o precisión del monto mayor que los decimales de la moneda de la Account. También si la Invoice de origen es de otro Customer u otra Account, o ya está pagada o anulada (TK31702).

429Se superó el límite de peticiones permitidas.