Vayu docs

Introduction

The best way to get a sense of how easy Vayu is to use is to explore the platform's user guide. 

Quickstart

Vayu API Review

Pagination

Dry run ingestion

Sending events

Browsing events

Adding a Customer

Customer Overview

Create a hierarchy between entities and associate child entities

Subsidiaries & Related Entities

Plans holds the pricing, commercials, and terms defined for the customers.

Create Plan

Contract Managing

Plan Templates and Customer Contracts

Pricing & Product Line Items

Base Amount and Commitment

Assign Plan to Customer

Real-time Invoice

Monthly Closure & Invoice Automation

List Customers

Create Customer

Get Customer

Update Customer

Delete Customer

Get Product

Update Product

Delete Product

List Products

Create Product

Get Plan

Delete Plan

List Plans

Update Plan

Get Contract

Delete Contract

List Contracts

Create Contract

Update Contract

Revise contract

Get Invoice

List Invoices

Create Invoice

Update Invoice

Delete Invoice

Use this endpoint to share an invoice with a customer or third party.

Share invoices

Approve invoice

Get Measurement

List Measurements

Create Measurement

Update Measurement

Delete Measurement

This endpoint is designed to acquire a temporary access token.
    Submit the auth token in the request body to obtain a new access token.
    Use this new token for subsequent API calls. Token is set to expire every hour.

Login by obtaining a new access token

Use this endpoint to send an array of events for processing. Make sure to comply with the request schema for each event. NOTE: this is a dry run and will not result in actual storage of the events.

Submit a batch of events for testing

Fetch events occurring within a specified timestamp range. An optional event name can be provided to further filter the events.

Query events by timestamp period and optional event name

Use this endpoint to send an array of events for processing and storage. Make sure to comply with the request schema for each event.

Submit a batch of events for ingestion

Use this endpoint to get a specific event using its reference ID.

Get event by refId

Use this endpoint to remove a specific event using its reference ID.

Delete an event by refId

Use this endpoint to get the products usage report.

Get products usage report

Get commitment report 

This endpoint is used to sync invoices to NetSuite.

Sync invoices to NetSuite

This endpoint is used to export sales order to NetSuite.

Export sales order to NetSuite

This endpoint is used to retrieve the credit ledger entries for a specific customer.

Retrieve credit ledger entries for customer.

This endpoint is used to grant credits to a customer.
    Submit the credit amount and customer ID in the request body to grant the credits.
    The granted credits will be added to the customer's account.

Grant credits to a customer credit ledger

This endpoint is used to deduct credits from the specified customer account. 
    Submit the credit amount and customer ID in the request body to deduct the credits. 
    The deducted credits will be subtracted from the customer's account.

Deduct credits from customer credit ledger

Use this endpoint to subscribe to webhooks and receive event notifications.

API Documentation

API Reference

SDK

TypeScript

Python

Golang