Get contract by integration id
curl --request GET \
--url https://connect.withvayu.com/contracts/integration/{integrationType}/{integrationId} \
--header 'Authorization: Bearer <token>'import requests
url = "https://connect.withvayu.com/contracts/integration/{integrationType}/{integrationId}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://connect.withvayu.com/contracts/integration/{integrationType}/{integrationId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://connect.withvayu.com/contracts/integration/{integrationType}/{integrationId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://connect.withvayu.com/contracts/integration/{integrationType}/{integrationId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://connect.withvayu.com/contracts/integration/{integrationType}/{integrationId}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://connect.withvayu.com/contracts/integration/{integrationType}/{integrationId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"contract": {
"startDate": "2023-11-07T05:31:56Z",
"customerId": "<string>",
"name": "<string>",
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"salesForceOpportunityId": "<string>",
"endDate": "2023-11-07T05:31:56Z",
"signatureDate": "2023-11-07T05:31:56Z",
"products": [
{
"displayName": "<string>",
"scheduling": {
"duration": {
"unit": "MONTH",
"value": 500
},
"billingDay": 1
},
"pricing": {
"type": "ONE_TIME",
"price": 1,
"discount": {
"name": "<string>",
"amount": 1,
"recurring": 2
},
"isCreditPurchase": true
},
"description": "<string>",
"catalogProductId": "<string>",
"productErpId": "<string>",
"nsClass": "<string>",
"nsClassId": "<string>",
"commitment": {
"units": 1,
"price": 1,
"type": "UNITS",
"scheduling": {
"duration": {
"unit": "MONTH",
"value": 500
},
"billingDay": 1
},
"overageStrategy": "IGNORE"
},
"isCalendarAligned": true,
"cloudProviderSettings": {
"cloudProvider": "AWS",
"cloudProviderMarketplaceId": "<string>",
"dimension": "<string>"
}
}
],
"productGroups": [
{
"displayName": "<string>",
"products": [
{
"displayName": "<string>",
"scheduling": {
"duration": {
"unit": "MONTH",
"value": 500
},
"billingDay": 1
},
"pricing": {
"type": "ONE_TIME",
"price": 1,
"discount": {
"name": "<string>",
"amount": 1,
"recurring": 2
},
"isCreditPurchase": true
},
"description": "<string>",
"catalogProductId": "<string>",
"productErpId": "<string>",
"nsClass": "<string>",
"nsClassId": "<string>",
"commitment": {
"units": 1,
"price": 1,
"type": "UNITS",
"scheduling": {
"duration": {
"unit": "MONTH",
"value": 500
},
"billingDay": 1
},
"overageStrategy": "IGNORE"
},
"isCalendarAligned": true,
"cloudProviderSettings": {
"cloudProvider": "AWS",
"cloudProviderMarketplaceId": "<string>",
"dimension": "<string>"
}
}
],
"description": "<string>",
"productErpId": "<string>",
"nsClass": "<string>",
"nsClassId": "<string>",
"baseAmount": 123,
"commitment": {
"units": 1,
"price": 1,
"type": "UNITS",
"scheduling": {
"duration": {
"unit": "MONTH",
"value": 500
},
"billingDay": 1
},
"overageStrategy": "IGNORE"
},
"isCalendarAligned": true
}
],
"accountManager": "<string>",
"shouldProRateInvoices": true,
"autoRenewContract": true,
"customFields": [
{
"vayuCustomFieldName": "<string>",
"fieldPath": "<string>",
"value": "<unknown>"
}
],
"customFieldValues": [
{
"customFieldDefinitionId": "<string>",
"value": "<string>",
"fieldName": "<string>"
}
],
"purchaseOrder": "<string>"
}
}{
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"params": [
{
"param": "<string>",
"message": "<string>"
}
]
}{
"type": "authentication_error",
"code": "authentication_failed",
"message": "<string>"
}{
"type": "invalid_request_error",
"code": "resource_not_found",
"message": "<string>"
}{
"type": "rate_limit_error",
"code": "rate_limit_exceeded",
"message": "<string>"
}{
"type": "api_error",
"code": "internal_error",
"message": "<string>"
}Contracts
Get contract by integration id
Use this endpoint to get a specific contract using its integration provider and identifier.
GET
/
contracts
/
integration
/
{integrationType}
/
{integrationId}
Get contract by integration id
curl --request GET \
--url https://connect.withvayu.com/contracts/integration/{integrationType}/{integrationId} \
--header 'Authorization: Bearer <token>'import requests
url = "https://connect.withvayu.com/contracts/integration/{integrationType}/{integrationId}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://connect.withvayu.com/contracts/integration/{integrationType}/{integrationId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://connect.withvayu.com/contracts/integration/{integrationType}/{integrationId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://connect.withvayu.com/contracts/integration/{integrationType}/{integrationId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://connect.withvayu.com/contracts/integration/{integrationType}/{integrationId}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://connect.withvayu.com/contracts/integration/{integrationType}/{integrationId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"contract": {
"startDate": "2023-11-07T05:31:56Z",
"customerId": "<string>",
"name": "<string>",
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"salesForceOpportunityId": "<string>",
"endDate": "2023-11-07T05:31:56Z",
"signatureDate": "2023-11-07T05:31:56Z",
"products": [
{
"displayName": "<string>",
"scheduling": {
"duration": {
"unit": "MONTH",
"value": 500
},
"billingDay": 1
},
"pricing": {
"type": "ONE_TIME",
"price": 1,
"discount": {
"name": "<string>",
"amount": 1,
"recurring": 2
},
"isCreditPurchase": true
},
"description": "<string>",
"catalogProductId": "<string>",
"productErpId": "<string>",
"nsClass": "<string>",
"nsClassId": "<string>",
"commitment": {
"units": 1,
"price": 1,
"type": "UNITS",
"scheduling": {
"duration": {
"unit": "MONTH",
"value": 500
},
"billingDay": 1
},
"overageStrategy": "IGNORE"
},
"isCalendarAligned": true,
"cloudProviderSettings": {
"cloudProvider": "AWS",
"cloudProviderMarketplaceId": "<string>",
"dimension": "<string>"
}
}
],
"productGroups": [
{
"displayName": "<string>",
"products": [
{
"displayName": "<string>",
"scheduling": {
"duration": {
"unit": "MONTH",
"value": 500
},
"billingDay": 1
},
"pricing": {
"type": "ONE_TIME",
"price": 1,
"discount": {
"name": "<string>",
"amount": 1,
"recurring": 2
},
"isCreditPurchase": true
},
"description": "<string>",
"catalogProductId": "<string>",
"productErpId": "<string>",
"nsClass": "<string>",
"nsClassId": "<string>",
"commitment": {
"units": 1,
"price": 1,
"type": "UNITS",
"scheduling": {
"duration": {
"unit": "MONTH",
"value": 500
},
"billingDay": 1
},
"overageStrategy": "IGNORE"
},
"isCalendarAligned": true,
"cloudProviderSettings": {
"cloudProvider": "AWS",
"cloudProviderMarketplaceId": "<string>",
"dimension": "<string>"
}
}
],
"description": "<string>",
"productErpId": "<string>",
"nsClass": "<string>",
"nsClassId": "<string>",
"baseAmount": 123,
"commitment": {
"units": 1,
"price": 1,
"type": "UNITS",
"scheduling": {
"duration": {
"unit": "MONTH",
"value": 500
},
"billingDay": 1
},
"overageStrategy": "IGNORE"
},
"isCalendarAligned": true
}
],
"accountManager": "<string>",
"shouldProRateInvoices": true,
"autoRenewContract": true,
"customFields": [
{
"vayuCustomFieldName": "<string>",
"fieldPath": "<string>",
"value": "<unknown>"
}
],
"customFieldValues": [
{
"customFieldDefinitionId": "<string>",
"value": "<string>",
"fieldName": "<string>"
}
],
"purchaseOrder": "<string>"
}
}{
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"params": [
{
"param": "<string>",
"message": "<string>"
}
]
}{
"type": "authentication_error",
"code": "authentication_failed",
"message": "<string>"
}{
"type": "invalid_request_error",
"code": "resource_not_found",
"message": "<string>"
}{
"type": "rate_limit_error",
"code": "rate_limit_exceeded",
"message": "<string>"
}{
"type": "api_error",
"code": "internal_error",
"message": "<string>"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Available options:
Hubspot, Stripe, NetSuite, Salesforce, QuickBooks, Slack, S3, Vayu, Morning, Anrok, Snowflake, Connact, Xero Response
Response contains the contract matching the provided integration id
Show child attributes
Show child attributes
⌘I
