Skip to main content
POST
/
documents
/
{reference}
/
approve
Approve document
curl --request POST \
  --url https://api.prod.payana.cloud/public/api/v1/documents/{reference}/approve \
  --header 'Content-Type: application/json' \
  --header 'api-key: <api-key>' \
  --data '
{
  "erp_reference": "ERP-2024-001"
}
'
{
  "reference": "aaea7db4-647c-4d92-9f86-89e34a68e1aa",
  "beneficiary": {
    "reference": "616263a5-a677-4ad1-92ca-7e120adad8d4",
    "origin": "fiscal",
    "name": "Proveedor Ejemplo S.A.S",
    "identifier_type": "NIT",
    "identifier_number": "900123456",
    "is_deleted": false,
    "deleted_at": null,
    "contact_information": []
  },
  "document_number": "FC-2024-001",
  "type": "invoice",
  "issue_date": "2024-04-14T10:00:00Z",
  "expiration_date": "2024-04-30T10:00:00Z",
  "fiscal_reference": "e19d3e7867371a12fd53b67a56db087faa871c9797993d9bbf7806ae4e1466ea",
  "amount": 1190000,
  "amount_currency": "COP",
  "approval_status": "approved",
  "payment_status": "pending",
  "file_path": "https://storage.payana.cloud/documents/FC-2024-001.pdf",
  "is_archived": false,
  "purchase_order": "OC-2024-001",
  "tags": [],
  "created_at": "2024-04-14T10:00:00Z",
  "updated_at": "2024-04-14T12:30:00Z"
}

Documentation Index

Fetch the complete documentation index at: https://docs.payana.la/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
api-key
string
header
required

API key provista por Payana.

Path Parameters

​
reference
string
required

Referencia interna del documento en Payana (UUID, ej. aaea7db4-647c-4d92-9f86-89e34a68e1aa).

Body

application/json

Approval payload

Payload opcional para aprobar un documento.

​
erp_reference
string

Referencia del documento en el ERP externo. Si se provee, se almacena junto a la aprobación para trazabilidad.

Response

Document approved

Documento (factura, nota crédito/débito o gasto). Los campos marcados como expandibles se incluyen únicamente cuando se solicitan vía el query param fields.

​
reference
string
required

Referencia interna del documento en Payana (UUID).

​
document_number
string
required

Número del documento (ej. FC-2024-001).

​
type
enum<string>
required

Tipo de documento.

Available options:
invoice,
debit_note,
credit_note,
expense
​
amount
number
required

Monto total del documento.

​
amount_currency
enum<string>
required
Available options:
USD,
COP,
MXN,
EUR
​
approval_status
enum<string>
required

Estado del flujo de aprobación del documento (pendiente, aprobado, rechazado). Distinto de payment_status, que refleja cobro/pago respecto al monto.

Available options:
pending,
in_review,
approved,
rejected
​
payment_status
enum<string>
required

Estado de pago del documento.

Available options:
pending,
partial,
paid
​
is_archived
boolean
required
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
issue_date
string<date-time> | null

Fecha de emisión del documento.

​
expiration_date
string<date-time> | null

Fecha de vencimiento del documento.

​
fiscal_reference
string | null

Referencia fiscal (CUFE en Colombia, UUID del SAT en México).

​
fiscal_metadata
object

Metadata fiscal complementaria proveniente de la DIAN o SAT.

​
file_path
string | null

URL al archivo PDF/XML del documento.

​
purchase_order
string | null

Referencia de orden de compra del comprador extraída del XML fiscal (UBL cac:OrderReference / cbc:ID), cuando está disponible en el documento. Siempre se incluye en el payload base de documentos y en webhooks de documento; es null cuando el XML no trae orden de compra o aún no fue extraída.

​
tags
string[]
​
is_admited
boolean

Indica si el documento fue marcado como admitido (tag de sistema admitido), por ejemplo mediante POST /documents/{reference}/acknowledge. No modifica approval_status.

​
created_by
object

Información sobre cómo y quién creó el documento (origen fiscal automático, usuario manual, legalizaciones, etc.).

​
beneficiary
object

Beneficiario asociado al documento. Expandible vía fields=beneficiaries.

​
payments
object[]

Pagos asociados al documento. Expandible vía fields=payments.

​
support_document
object

Documento soporte asociado. Expandible vía fields=document_supports.

​
invoice_reception_events
object[]

Eventos de recepción de la factura electrónica (acuse, aceptación, rechazo, etc.). Expandible vía fields=invoice_reception_events.

​
payment_receipt_complements
object[]

Complementos de pago (CFDI México). Expandible vía fields=payment_receipt_complements.

​
expenses
object

Detalle de gastos asociados al documento. Expandible vía fields=expenses.

​
logs
object[]

Historial de eventos del documento. Expandible vía fields=logs.

​
erp_document
object

Información del documento en el ERP. Expandible vía fields=erp_document.