Saltar al contenido principal
POST
cURL

Autorizaciones

Authorization
string
header
requerido

Para tus propios scripts e integraciones de servidor a servidor. Crea una clave en la app en Configuración > Acceso > Claves de API y cópiala entonces, porque se muestra una sola vez. Envíala como Authorization: Bearer <key>. La clave actúa como el miembro que la creó, en la organización en la que se creó. Una llamada necesita el permiso del miembro y uno de los alcances de la clave, como inventory:read o sales:write. Una clave con * tiene todos los alcances.

Parámetros de ruta

invoice
string
requerido

El ID de la factura, un UUID.

Cuerpo

application/json

Un pago hecho fuera de StockShift, registrado contra una factura emitida.

amount
string
requerido

El monto pagado, mayor que cero, al centavo y no más que el saldo pendiente.

Pattern: ^(?!0+(\.0+)?$)\d{1,18}(\.\d{1,2})?$
paid_on
string<date> | null

La fecha en que se hizo el pago, como YYYY-MM-DD. Hoy si se omite.

method
string | null

Cómo se pagó, como Transferencia bancaria, hasta 64 caracteres.

Maximum string length: 64
reference
string | null

Una referencia del pago, como el número de un cheque o de una transacción, de hasta 128 caracteres.

Maximum string length: 128

Respuesta

SalesInvoiceResource

data
SalesInvoiceResource · object
requerido

Una factura a un cliente por un pedido de venta, con sus líneas, pagos y notas de crédito. Hay una nota de crédito por cada devolución de bienes que facturó, y una más cuando se anula. Los importes son decimales exactos en la moneda de la organización.