Skip to main content

Procurement API

The Procurement API manages procurement calendar computation and retrieval. GET fetches existing calendars with filters and KPIs; POST computes procurement windows for all active accounts based on their fiscal year data.

GET /api/procurement/calendar

Returns procurement calendars with account details, filterable by territory, segment, or upcoming budget windows. Auth: Requires authenticated session. Scoped to organization.

Query Parameters

Response

The response includes:
  • calendars — Array of procurement calendar records joined with account data
  • kpis — Summary metrics for the filtered result set
  • total — Total number of calendars returned

Response Fields: kpis

Response Fields: calendars[]

Each calendar record includes:

POST /api/procurement/calendar

Computes and upserts procurement calendars for all active accounts in the organization. Auth: Requires authenticated session. Scoped to organization.

Request Body

No body required.

Response

Computation Flow

  1. Fetch all active accounts with fiscal year data
  2. Fetch existing calendars for upsert logic
  3. Fetch open renewal opportunities for alignment assessment
  4. For each account:
    • Compute procurement window from fiscal year end
    • Assess renewal alignment if a renewal date exists
    • Upsert calendar record

Side Effects

  • Creates or updates procurement calendar records for every active account
  • Alignment is assessed against open renewal-type opportunities
See the Procurement Intelligence data model page for full details on procurement windows, alignment logic, and risk identification.