Flujo de documentos

Ver el flujo de un documento

Devuelve todos los documentos vinculados a uno, desde el pedido o la orden de compra hasta entregas, facturas, notas de crédito, recibos, órdenes de pago y movimientos de stock, con el estado de cada uno y lo que queda pendiente. Un documento de un módulo que el usuario no ve aparece oculto y el recorrido se corta ahí.

GET/api/v1/document-flow/of

Permiso: document-flow.view
Empresa: Opera sobre la empresa activa
Tipo: Lectura: no cambia nada
Respuesta: JSON

Encabezados

Cookietextorequerido
La cookie de sesión del usuario de la integración (__Secure-erp.session_token). Cuando esté la clave API, va en Authorization: Bearer. Ver Autenticación.
X-Expected-Companyuuidrequerido
La empresa sobre la que operás. Si no coincide con la de la credencial, responde 409. Ver Empresa activa.

Parámetros de la consulta

kindopciónrequerido
Valores: sales-order delivery-note sales-document receipt receipt-method purchase-order goods-receipt supplier-invoice payment-order payment-method stock-movement
iduuidrequerido

Respuesta

200 con este JSON.

focustextorequerido
nodeslista de uno derequerido
Una de 3 formas
Forma 1
- nodeconstanterequerido
  Valores: document
- kindopciónrequerido
  Valores: sales-order delivery-note sales-document receipt receipt-method purchase-order goods-receipt supplier-invoice payment-order payment-method stock-movement
- idtextorequerido
- labeltextorequerido
- numbertextorequerido
- legalcualquierarequerido
- partycualquierarequerido
- datecualquierarequerido
- amountobjetorequeridoadmite null
  Campos (2)
  valuetextorequerido
  currencytextorequerido
- stageopciónrequerido
  Valores: purchase-order goods-receipt supplier-invoice payment sales-order delivery invoice collection value movement
- progressopciónrequeridoadmite null
  Valores: pending partial complete
- statusopciónrequerido
  Valores: active draft voided
- badgecualquierarequerido
- quantityobjetorequeridoadmite null
  Campos (2)
  valuetextorequerido
  unittextorequerido
- dueDatecualquierarequerido
- drawercualquierarequerido
- warehousecualquierarequerido
- positionslista de enterorequerido
- distanceenterorequerido
- entryobjetorequeridoadmite null
  Campos (2)
  idtextorequerido
  numbertextorequerido
Forma 2
- nodeconstanterequerido
  Valores: hidden
- kindopciónrequerido
  Valores: sales-order delivery-note sales-document receipt receipt-method purchase-order goods-receipt supplier-invoice payment-order payment-method stock-movement
- idtextorequerido
- stageopciónrequerido
  Valores: purchase-order goods-receipt supplier-invoice payment sales-order delivery invoice collection value movement
- moduletextorequerido
- positionslista de enterorequerido
- distanceenterorequerido
Forma 3
- nodeconstanterequerido
  Valores: pending
- idtextorequerido
- stageopciónrequerido
  Valores: purchase-order goods-receipt supplier-invoice payment sales-order delivery invoice collection value movement
- labeltextorequerido
- positionslista de enterorequerido
- quantityobjetorequeridoadmite null
  Campos (2)
  valuetextorequerido
  unittextorequerido
- amountobjetorequeridoadmite null
  Campos (2)
  valuetextorequerido
  currencytextorequerido
- distanceenterorequerido
linkslista de objetorequerido
Campos de cada elemento (2)
- fromtextorequerido
- totextorequerido
positionslista de enterorequerido
truncatedsí o norequerido

Errores

Un rechazo responde application/problem+json con un code estable. Los más comunes en esta operación:

`401`	Falta la credencial o venció.
`403`	La credencial no tiene el permiso `document-flow.view`.
`409`	La empresa activa no es la de `X-Expected-Company`.
`422`	Datos inválidos o una regla de negocio rota, con el detalle por campo.
`503`	Sistema ocupado: reintentá después de `Retry-After` segundos.

La lista completa está en Errores.

curl
TypeScript

curl "$ERP_URL/api/v1/document-flow/of?kind=sales-order&id=3f2a9c1e-5b7d-4e8a-9c21-7d4e5f6a8b90" \
  -b sesion.txt \
  -H "X-Expected-Company: $ERP_EMPRESA"

const respuesta = await fetch(`${process.env.ERP_URL}/api/v1/document-flow/of?kind=sales-order&id=3f2a9c1e-5b7d-4e8a-9c21-7d4e5f6a8b90`, {
  headers: {
    Cookie: process.env.ERP_SESION!,
    "X-Expected-Company": process.env.ERP_EMPRESA!,
  },
});
if (!respuesta.ok) throw new Error((await respuesta.json()).title);
const datos = await respuesta.json();

{
  "focus": "texto",
  "nodes": [
    {
      "node": "document",
      "kind": "sales-order",
      "id": "texto",
      "label": "texto",
      "number": "texto",
      "legal": null,
      "party": null,
      "date": null,
      "amount": {
        "value": "texto",
        "currency": "texto"
      },
      "stage": "purchase-order",
      "progress": "pending",
      "status": "active",
      "badge": null,
      "quantity": {
        "value": "texto",
        "unit": "texto"
      },
      "dueDate": null,
      "drawer": null,
      "warehouse": null,
      "positions": [
        1
      ],
      "distance": 1,
      "entry": {
        "id": "texto",
        "number": "texto"
      }
    }
  ],
  "links": [
    {
      "from": "texto",
      "to": "texto"
    }
  ],
  "positions": [
    1
  ],
  "truncated": false
}