Skip to content
  • There are no suggestions because the search field is empty.

List of API Endpoints

Overview

The Vividly API allows you to view, create, and update your data programmatically.

Our API documentation includes authentication, available endpoints, request and response examples, and implementation details.

View the documentation here: https://portal.govividly.com/api.html#description/introduction

Note: You must be logged into the Vividly portal to access the technical documentation. If you're unable to access the documentation, please reach out to support via live chat or email.

List of API Endpoints

Deductions Reconciliation

  • Bulk Upsert ERP Transactions (POST)

  • List Invoice Lines (GET)

  • List Invoice Lines for an Invoice (GET)

  • List Transactions​ (GET)

  • List Invoices for a Transaction​ (GET)


Export

  • List Export Jobs (GET)
  • Get Export Job (GET)
  • Create an Export (POST)

Pricing

  • List pricing data with filters (GET)
  • Upload pricing data (POST)

Products

  • List products with filters and pagination (GET)
  • Update a product by ID (PATCH)
  • Create multiple products in bulk (POST)
  • Update multiple products in bulk (PATCH)
  • Create a new product (POST)

Promotions

  • List Promotion Lines (GET)
  • Export promotions (GET)

Revenue

  • List revenue records (GET)
  • Bulk Delete revenue records (POST)

Settlement Reports

  • List settlement reports (GET)

Spend

  • Export spend (GET)