Flujo de documentos

Buscar un documento

Encuentra los documentos de la empresa activa que nombra un texto: un número comercial con prefijo (PED-4, FAC-12, REC-3, OP-7, OC-2, RCP-5, FPR-1, ENT-9, SAL-4, AS-231), un número interno, un número legal con o sin letra, un CAE de 14 dígitos o un número de cheque. Sólo devuelve lo que el usuario puede ver.

GET/api/v1/document-flow/search

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

texttextorequerido
de 1 a 100 caracteres

Respuesta

200 con este JSON.

querytextorequerido
resultslista de objetorequerido
Campos de cada elemento (10)
- 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
- statusopciónrequerido
  Valores: active draft voided
- entryobjetorequeridoadmite null
  Campos (2)
  - idtextorequerido
  - numbertextorequerido

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/search?text=texto" \
  -b sesion.txt \
  -H "X-Expected-Company: $ERP_EMPRESA"

const respuesta = await fetch(`${process.env.ERP_URL}/api/v1/document-flow/search?text=texto`, {
  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();

{
  "query": "texto",
  "results": [
    {
      "kind": "sales-order",
      "id": "texto",
      "label": "texto",
      "number": "texto",
      "legal": null,
      "party": null,
      "date": null,
      "amount": {
        "value": "texto",
        "currency": "texto"
      },
      "status": "active",
      "entry": {
        "id": "texto",
        "number": "texto"
      }
    }
  ]
}