Skip to content

Category plans

Category management: planning spend and strategy for a purchasing category, including one-page reports.

Base path
/categorymanagement

Endpoints

19 endpoints

Method

Standard Operations

7
  • GET /categorymanagement List category plans (with search, filters and paging).
  • POST /categorymanagement Create a new category plan.
  • PATCH /categorymanagement/bulk Update several category plans at once.
  • GET /categorymanagement/{id} Open a single category plan.
  • PUT /categorymanagement/{id} Replace a category plan's details in full.
  • PATCH /categorymanagement/{id} Edit a category plan.
  • DELETE /categorymanagement/{id} Delete a category plan.

Additional Operations

12
  • DELETE /categorymanagement/{entityId}/tags/{tagId} Remove a tag from a category plan.
  • GET /categorymanagement/{id}/tags See the tags on a category plan.
  • POST /categorymanagement/{id}/tags Add a tag to a category plan.
  • POST /categorymanagement/sendCollabRequest Invite a colleague to collaborate on a category plan.
  • POST /categorymanagement/export Download category plans as a spreadsheet (can be re-imported elsewhere).
  • GET /categorymanagement/getDataToDesignReport Get the data fields available when designing a category report.
  • POST /categorymanagement/getOnePagerDataForReport/{entity}/{id} Gather the data for a one-page report on a record.
  • POST /categorymanagement/postReportTemplate Save a new report template design.
  • GET /categorymanagement/getMRTFilePath Find where a report template file is stored.
  • POST /categorymanagement/obtainMRTFileFromS3 Fetch a stored report template file.
  • PATCH /categorymanagement/patchReportTemplate/{id} Update a report template design.
  • GET /categorymanagement/getCollabRequestDetails Show the details of a collaboration invitation.