Developers
Ingresar a la plataforma

Listar workflows de aprobación

GET/api/public/v1/purchase-approval-workflows

Devuelve una página de los workflows de aprobación de las transacciones de la empresa. Admite filtros por estado (status, statusByConfig) y rango de fechas, y paginado. La respuesta usa el formato HAL.

Autorización

apiKeyScheme
X-API-KEY<token>

En: header

Parámetros de consulta

statusByConfig?string

Estado del flujo de aprobación agrupado según la configuración de la empresa.

Valor en

  • "SUBMITTED"
  • "PENDING_SUBMISSION"
  • "IN_PROCESS"
  • "READY_AUDITING"
  • "AUTHORIZED"
  • "UNAUTHORIZED"
dateFrom?string

Fecha desde la cual filtrar por fecha del flujo de aprobación.

Formatodate-time
dateTo?string

Fecha hasta la cual filtrar por fecha del flujo de aprobación.

Formatodate-time
page?integer

Número de página a consultar, comenzando en 0.

Formatoint32
size?integer

Cantidad de resultados por página.

Formatoint32
sort?array<>

Criterios de ordenamiento de los resultados.

Criterios de ordenamiento, enviados como sort[0].property y sort[0].direction (ASC o DESC). Sin ordenamiento explícito, el orden de los resultados no está garantizado.

property?string
direction?string

Valor en

  • "ASC"
  • "DESC"
status?string

Estado del flujo de aprobación por el cual filtrar.

Valor en

  • "PENDING"
  • "SUBMITTED"
  • "AUTHORIZED"
  • "UNAUTHORIZED"
  • "PARTIAL_AUTHORIZED"
  • "PENDING_SUBMISSION"
  • "EXEMPTED"
  • "INFORMATION_REQUIRED"

Cuerpo de la respuesta

application/vnd.hal+json

application/json

application/json

curl -X GET "https://example.com/api/public/v1/purchase-approval-workflows?dateFrom=2024-11-13T16%3A51%3A00.000Z&dateTo=2024-11-13T16%3A51%3A00.000Z"
{  "_embedded": {    "PurchaseApprovalWorkflow": [      {        "purchaseUniqueCode": "0590843e-1d92-4d51-82c6-4a22a6b8be82",        "purchaseCreatedDate": "2019-08-24T14:15:22Z",        "description": "string",        "sellerName": "string",        "amount": 2358,        "summaryStatus": "string",        "payerPersonName": "string",        "invoiceFile": true,        "digitalInvoiceFile": true,        "ticketAttached": true,        "purchasePaymentDate": "2019-08-24T14:15:22Z",        "purchaseApprovalWorkflowStatus": {          "uniqueCode": "string",          "status": "PENDING",          "auditAllowed": true,          "auditResetAllowed": true,          "statusByConfig": "SUBMITTED",          "auditPolicyStatus": "string",          "auditPolicyRuleCode": "string",          "auditPolicyRuleDescription": "string",          "payerSupervisorCode": "string",          "approvalLevel": 0,          "requiredCustomFieldsComplete": true,          "requiredCategoryFieldsComplete": true,          "version": 0        },        "paymentBank": "string",        "foreignCurrencyCode": "USD",        "foreignAmount": 2358,        "isPersonal": true,        "missingFilesReason": "string",        "involvesPoliticallyExposed": true,        "politicallyExposedPersonName": "string",        "notes": "string",        "accountTypeNumber": "string",        "accountNumber": "string",        "payment": {          "status": "string",          "legalStatus": "string",          "mode": "string",          "payerCompanyLegalId": "string",          "payerCompanyName": "string",          "payerPersonCode": "string",          "payerFullName": "string",          "date": "2019-08-24T14:15:22Z",          "channel": "string",          "locationType": "string",          "ticketAttached": true        },        "currency": {          "code": "MXN"        },        "countryCode": "MX",        "budgetName": "string",        "expenseCategory": {          "code": "string",          "description": "string"        },        "costCenterCode": "string",        "companyCode": "string"      }    ]  },  "_links": {    "property1": {      "href": "string",      "hreflang": "string",      "title": "string",      "type": "string",      "deprecation": "string",      "profile": "string",      "name": "string",      "templated": true    },    "property2": {      "href": "string",      "hreflang": "string",      "title": "string",      "type": "string",      "deprecation": "string",      "profile": "string",      "name": "string",      "templated": true    }  },  "page": {    "size": 0,    "totalElements": 0,    "totalPages": 0,    "number": 0  }}