Add/Update Orden de compra

Usa esto cuando an orden de compra esté lista en tu sistema y quieras que el cliente la reciba y la pague, o cuando cambie.


The following endpoint can be used to add or update a orden de compra within the Hyfin application. When a orden de compra is added to Hyfin, a payment request will be automatically generated and the customer will be notified via text message, email or both, as described under Who gets notified below.

If you choose to omit the customer info, a payment link will be provided in the API response. The payment link can be used on a self-checkout system or kiosk.

If the customer is viewing the orden de compra on their device and the orden de compra is updated, a message will display letting the customer know the orden de compra has been updated and the new version of the orden de compra will automatically be displayed on the customers device.

Quién recibe notificaciones

Cada cliente está bajo un solo control de notificaciones, determinado a partir del sitio y del cliente. Nunca se almacena y no se puede establecer directamente.

  • Control por contacto : cada dirección de correo electrónico y número de teléfono de los contactos del cliente tiene su propia do_not_contact marca, y esa marca es lo único que detiene los mensajes automáticos hacia ella. Este es el control para los clientes creados en la app, para todos los clientes de un sitio de QuickBooks que no asigna métodos de pago a notificaciones, y para las integraciones en la API v4.
  • Control por cliente : las notification_options del cliente (una opción para cada uno: correo electrónico, mensaje de texto y WhatsApp) deciden para cada dirección de cada contacto. Si falta una opción, se notifica. Este es el control para todos los clientes de un sitio de QuickBooks que asigna métodos de pago a notificaciones, y para los clientes cuya integración definió esas opciones en una versión anterior a la 4.0.

En esta versión:

  • Una escritura de cliente con cualquier notification_options.notify_* valor coloca al cliente bajo control por cliente, incluido un cliente creado en la app. Para un cliente que ya está bajo control por cliente, una opción que omita conserva su elección almacenada. Para un cliente que esta escritura pasa a control por cliente, una opción que omita toma el valor predeterminado del sitio para clientes nuevos, y queda activada cuando el sitio no tiene ninguno. Un valor omitido, nulo o vacío de notification_options no cambia nada. En un sitio de QuickBooks que no asigna métodos de pago, las opciones se ignoran y el cliente permanece bajo control por contacto.
  • En una escritura de Orden de compra, los notification_options.notify_* valores se convierten en los destinatarios de esa Orden de compra cuando se escribe: un canal establecido en false queda desactivado para la Orden de compra, y cada uno de los demás canales se completa con los contactos del cliente en ese momento. Un canal establecido en true prevalece sobre una opción de control por cliente en false para esa Orden de compra, pero nunca llega a una dirección marcada como no contactar bajo control por contacto. Una actualización que omita los valores conserva los destinatarios que la Orden de compra ya tiene.

Punto Final

The following endpoint can be used to add or update a orden de compra. You must replace the {base_url} and {site_id} variable with the site id that was provided when the site was created.

POST
{base_url}/api/v3.1/site/{site_id}/invoice/addUpdate

Solicitud
Campo
Tipo
Descripción
external_id
String
Tu propio id para esta orden de compra, desde tu software. Envía de nuevo el mismo external_id para actualizar esta orden de compra en lugar de agregar una nueva. Usamos este valor para hacer la coincidencia, pero no evitamos duplicados, así que manténgalo único dentro del sitio.
invoice_number
String
El número asignado desde el sistema de origen y que se muestra al cliente en la orden de compra. Dos orden de compra de un sitio pueden compartir un número, y un pago aplicado por número se asigna a la primera coincidencia encontrada, así que manténgalo único dentro del sitio.
totals
Los montos totales de orden de compra. Cuando se proporcionan lines, total se valida contra ellas y debe ser igual a la suma de cada lines[].total, más tax, menos discounts. Una solicitud cuyos totales no concuerden es rechazada. Si omite lines, no se realiza esta verificación.
customer
Una referencia al registro del cliente.
invoice_term_name
String
El nombre de un plazo de orden de compra configurado para el sitio, como Net 30. Cuando se envía, la fecha de vencimiento se calcula a partir del plazo y la fecha de la orden de compra, y reemplaza cualquier due_date que envíe. Un nombre que no coincide con ningún plazo se rechaza con Invoice term "" not found. Cuando se omite en una orden de compra nueva, se usa el plazo de orden de compra del cliente si lo tiene.
lines
Una lista de elementos de línea en la orden de compra. Requerido si no se pasa la description.
description
String
Una breve descripción de los productos/servicios en la orden de compra. Requerido si no se pasan las lines.
invoice_date
Date
La fecha de la orden de compra. Si se establece en el futuro, la orden de compra no se envía por mensaje de texto ni por correo electrónico al cliente hasta esa fecha. Si se deja en blanco, se usa la fecha de hoy. Una fecha sin hora. Si se envía una hora o zona horaria con ella, se descarta, no se convierte, por lo que la fecha permanece tal como se escribió. Format = YYYY-MM-DD
customer_memo
String
Una nota presentada al cliente en la parte inferior de la orden de compra.
internal_memo
String
Un memo agregado en la parte inferior de la orden de compra. Solo visible para el personal interno, nunca se muestra a los clientes.
active
Boolean
Esta bandera representa si el registro orden de compra está activo y disponible para ser utilizado o no.
Default = true
payments
Una lista de pagos realizados en la orden de compra.
webhook_url
String
La URL a la que se envía una publicación cuando se realizan ciertas acciones en orden de compra. Se envía un webhook cuando un pago alcanza un nuevo estado, y cuando un mensaje de texto, correo electrónico o mensaje de WhatsApp se envía, se entrega, se lee, se retrasa o falla, o cuando el cliente hace clic en el enlace de pago.
attachments
String [ ]
Una lista de URL de adjuntos.
options
Opciones para configurar en la orden de compra.
			
{
  "external_id": "439772921",
  "invoice_number": "12345",
  "description": "Merchandise Bundle",
  "totals": {
    "total": 45.99
  },
  "customer": {
    "external_id": "39772634",
    "first_name": "John",
    "last_name": "Doe",
    "mobile_phone": "111-222-3333",
    "email": "johndoe@abc.com"
  },
  "options": {
    "tipping_enabled": false
  },
  "webhook_url": "https://yourcompany.com/webhook"
}


		
Respuesta
Campo
Tipo
Descripción
success
Boolean
Whether the record was added or updated successfully.
action
String
Informs whether the record was added or updated. Will only be returned if success is true.
One of added, updated
_id
String
The id we assign to the record.
id
String
The same id as _id, kept for backwards compatibility. Not returned on 4.0 and later.
errors
String [ ]
A list of errors. Will only be returned if success is false.
link
String
La página de pago para el cliente de la orden de compra. Se devuelve en cada alta o actualización exitosa, para que usted mismo pueda enviársela al cliente.
missing_customer
Boolean
Indica si orden de compra hace referencia a un cliente que aún no se ha sincronizado, por lo que el cliente se asociará cuando llegue.
			
{
  "success": true,
  "action": "added",
  "_id": "60f720d248f143332af022e0",
  "id": "60f720d248f143332af022e0",
  "link": "https://site.url/KA39T1A45JL",
  "missing_customer": false
}


		

Ver también