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"
}
'

import requests

url = "https://api.prod.payana.cloud/public/api/v1/documents/{reference}/approve"

payload = { "erp_reference": "ERP-2024-001" }
headers = {
    "api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({erp_reference: 'ERP-2024-001'})
};

fetch('https://api.prod.payana.cloud/public/api/v1/documents/{reference}/approve', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.prod.payana.cloud/public/api/v1/documents/{reference}/approve",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'erp_reference' => 'ERP-2024-001'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.prod.payana.cloud/public/api/v1/documents/{reference}/approve"

	payload := strings.NewReader("{\n  \"erp_reference\": \"ERP-2024-001\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.prod.payana.cloud/public/api/v1/documents/{reference}/approve")
  .header("api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"erp_reference\": \"ERP-2024-001\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.prod.payana.cloud/public/api/v1/documents/{reference}/approve")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"erp_reference\": \"ERP-2024-001\"\n}"

response = http.request(request)
puts response.read_body

{
  "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"
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "The request contains invalid data",
    "details": {
      "amount": [
        "Amount must be greater than 0"
      ],
      "beneficiary_id": [
        "Beneficiary does not exist"
      ]
    }
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "The request contains invalid data",
    "details": {
      "amount": [
        "Amount must be greater than 0"
      ],
      "beneficiary_id": [
        "Beneficiary does not exist"
      ]
    }
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "The request contains invalid data",
    "details": {
      "amount": [
        "Amount must be greater than 0"
      ],
      "beneficiary_id": [
        "Beneficiary does not exist"
      ]
    }
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "The request contains invalid data",
    "details": {
      "amount": [
        "Amount must be greater than 0"
      ],
      "beneficiary_id": [
        "Beneficiary does not exist"
      ]
    }
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "The request contains invalid data",
    "details": {
      "amount": [
        "Amount must be greater than 0"
      ],
      "beneficiary_id": [
        "Beneficiary does not exist"
      ]
    }
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "The request contains invalid data",
    "details": {
      "amount": [
        "Amount must be greater than 0"
      ],
      "beneficiary_id": [
        "Beneficiary does not exist"
      ]
    }
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "The request contains invalid data",
    "details": {
      "amount": [
        "Amount must be greater than 0"
      ],
      "beneficiary_id": [
        "Beneficiary does not exist"
      ]
    }
  }
}

Documentos

Approve Document

Marca un documento como aprobado. Llamar este endpoint después de recibir el webhook document.created para indicar que el documento fue revisado y aprobado en el ERP.

El path {reference} acepta la referencia interna de Payana (UUID) o la referencia fiscal del documento (fiscal_reference: CUFE en Colombia, UUID del CFDI en México). Podés aprobar con el identificador que recibiste del XML o del webhook sin resolver antes el UUID de Payana.

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"
}
'

import requests

url = "https://api.prod.payana.cloud/public/api/v1/documents/{reference}/approve"

payload = { "erp_reference": "ERP-2024-001" }
headers = {
    "api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({erp_reference: 'ERP-2024-001'})
};

fetch('https://api.prod.payana.cloud/public/api/v1/documents/{reference}/approve', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.prod.payana.cloud/public/api/v1/documents/{reference}/approve",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'erp_reference' => 'ERP-2024-001'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.prod.payana.cloud/public/api/v1/documents/{reference}/approve"

	payload := strings.NewReader("{\n  \"erp_reference\": \"ERP-2024-001\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.prod.payana.cloud/public/api/v1/documents/{reference}/approve")
  .header("api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"erp_reference\": \"ERP-2024-001\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.prod.payana.cloud/public/api/v1/documents/{reference}/approve")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"erp_reference\": \"ERP-2024-001\"\n}"

response = http.request(request)
puts response.read_body

{
  "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"
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "The request contains invalid data",
    "details": {
      "amount": [
        "Amount must be greater than 0"
      ],
      "beneficiary_id": [
        "Beneficiary does not exist"
      ]
    }
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "The request contains invalid data",
    "details": {
      "amount": [
        "Amount must be greater than 0"
      ],
      "beneficiary_id": [
        "Beneficiary does not exist"
      ]
    }
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "The request contains invalid data",
    "details": {
      "amount": [
        "Amount must be greater than 0"
      ],
      "beneficiary_id": [
        "Beneficiary does not exist"
      ]
    }
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "The request contains invalid data",
    "details": {
      "amount": [
        "Amount must be greater than 0"
      ],
      "beneficiary_id": [
        "Beneficiary does not exist"
      ]
    }
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "The request contains invalid data",
    "details": {
      "amount": [
        "Amount must be greater than 0"
      ],
      "beneficiary_id": [
        "Beneficiary does not exist"
      ]
    }
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "The request contains invalid data",
    "details": {
      "amount": [
        "Amount must be greater than 0"
      ],
      "beneficiary_id": [
        "Beneficiary does not exist"
      ]
    }
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "The request contains invalid data",
    "details": {
      "amount": [
        "Amount must be greater than 0"
      ],
      "beneficiary_id": [
        "Beneficiary does not exist"
      ]
    }
  }
}

El path {reference} acepta la referencia interna de Payana (UUID) o el CUFE / referencia fiscal del documento. Si recibiste el webhook document.created con fiscal_reference, puedes aprobar directamente con ese valor sin consultar antes GET /documents.

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) o referencia fiscal (CUFE de 96 caracteres hex en Colombia; UUID del SAT en México).

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 | null

Metadata fiscal complementaria proveniente de la DIAN o SAT.

Show child attributes

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.