Update Customer
curl --request PUT \
--url https://connect.withvayu.com/customers/{customerId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"aliases": [],
"contacts": [
{
"name": "<string>",
"email": "<string>",
"title": "<string>",
"phone": "<string>",
"receiveInvoiceEmail": true
}
],
"legalName": "<string>",
"taxIds": [],
"taxId": "<string>",
"cloudProviderSettings": {
"cloudProviderMarketplaceId": "<string>",
"customerIdentifier": "<string>"
},
"externalId": "<string>",
"customerErpId": "<string>",
"address": {
"country": "<string>",
"countryCode": "<string>",
"city": "<string>",
"addressText": "<string>",
"state": "<string>",
"postalCode": "<string>"
},
"shippingAddress": {
"country": "<string>",
"countryCode": "<string>",
"city": "<string>",
"addressText": "<string>",
"state": "<string>",
"postalCode": "<string>"
},
"salesForceAccountId": "<string>",
"externalIntegration": [
{
"type": "Stripe",
"id": "cus_123",
"name": "Acme Inc"
}
],
"customFields": [
{
"vayuCustomFieldName": "<string>",
"fieldPath": "<string>",
"value": "<unknown>"
}
],
"customFieldValues": [
{
"customFieldDefinitionId": "<string>",
"value": "<string>",
"fieldName": "<string>"
}
],
"subsidiary": "<string>",
"totalOutstandingAmount": 123,
"openAmount": 123,
"overdueAmount": 123,
"pendingPaymentAmount": 123,
"paidAmount": 123
}
'import requests
url = "https://connect.withvayu.com/customers/{customerId}"
payload = {
"name": "<string>",
"aliases": [],
"contacts": [
{
"name": "<string>",
"email": "<string>",
"title": "<string>",
"phone": "<string>",
"receiveInvoiceEmail": True
}
],
"legalName": "<string>",
"taxIds": [],
"taxId": "<string>",
"cloudProviderSettings": {
"cloudProviderMarketplaceId": "<string>",
"customerIdentifier": "<string>"
},
"externalId": "<string>",
"customerErpId": "<string>",
"address": {
"country": "<string>",
"countryCode": "<string>",
"city": "<string>",
"addressText": "<string>",
"state": "<string>",
"postalCode": "<string>"
},
"shippingAddress": {
"country": "<string>",
"countryCode": "<string>",
"city": "<string>",
"addressText": "<string>",
"state": "<string>",
"postalCode": "<string>"
},
"salesForceAccountId": "<string>",
"externalIntegration": [
{
"type": "Stripe",
"id": "cus_123",
"name": "Acme Inc"
}
],
"customFields": [
{
"vayuCustomFieldName": "<string>",
"fieldPath": "<string>",
"value": "<unknown>"
}
],
"customFieldValues": [
{
"customFieldDefinitionId": "<string>",
"value": "<string>",
"fieldName": "<string>"
}
],
"subsidiary": "<string>",
"totalOutstandingAmount": 123,
"openAmount": 123,
"overdueAmount": 123,
"pendingPaymentAmount": 123,
"paidAmount": 123
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
aliases: [],
contacts: [
{
name: '<string>',
email: '<string>',
title: '<string>',
phone: '<string>',
receiveInvoiceEmail: true
}
],
legalName: '<string>',
taxIds: [],
taxId: '<string>',
cloudProviderSettings: {cloudProviderMarketplaceId: '<string>', customerIdentifier: '<string>'},
externalId: '<string>',
customerErpId: '<string>',
address: {
country: '<string>',
countryCode: '<string>',
city: '<string>',
addressText: '<string>',
state: '<string>',
postalCode: '<string>'
},
shippingAddress: {
country: '<string>',
countryCode: '<string>',
city: '<string>',
addressText: '<string>',
state: '<string>',
postalCode: '<string>'
},
salesForceAccountId: '<string>',
externalIntegration: [{type: 'Stripe', id: 'cus_123', name: 'Acme Inc'}],
customFields: [{vayuCustomFieldName: '<string>', fieldPath: '<string>', value: '<unknown>'}],
customFieldValues: [
{customFieldDefinitionId: '<string>', value: '<string>', fieldName: '<string>'}
],
subsidiary: '<string>',
totalOutstandingAmount: 123,
openAmount: 123,
overdueAmount: 123,
pendingPaymentAmount: 123,
paidAmount: 123
})
};
fetch('https://connect.withvayu.com/customers/{customerId}', 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/customers/{customerId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'aliases' => [
],
'contacts' => [
[
'name' => '<string>',
'email' => '<string>',
'title' => '<string>',
'phone' => '<string>',
'receiveInvoiceEmail' => true
]
],
'legalName' => '<string>',
'taxIds' => [
],
'taxId' => '<string>',
'cloudProviderSettings' => [
'cloudProviderMarketplaceId' => '<string>',
'customerIdentifier' => '<string>'
],
'externalId' => '<string>',
'customerErpId' => '<string>',
'address' => [
'country' => '<string>',
'countryCode' => '<string>',
'city' => '<string>',
'addressText' => '<string>',
'state' => '<string>',
'postalCode' => '<string>'
],
'shippingAddress' => [
'country' => '<string>',
'countryCode' => '<string>',
'city' => '<string>',
'addressText' => '<string>',
'state' => '<string>',
'postalCode' => '<string>'
],
'salesForceAccountId' => '<string>',
'externalIntegration' => [
[
'type' => 'Stripe',
'id' => 'cus_123',
'name' => 'Acme Inc'
]
],
'customFields' => [
[
'vayuCustomFieldName' => '<string>',
'fieldPath' => '<string>',
'value' => '<unknown>'
]
],
'customFieldValues' => [
[
'customFieldDefinitionId' => '<string>',
'value' => '<string>',
'fieldName' => '<string>'
]
],
'subsidiary' => '<string>',
'totalOutstandingAmount' => 123,
'openAmount' => 123,
'overdueAmount' => 123,
'pendingPaymentAmount' => 123,
'paidAmount' => 123
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://connect.withvayu.com/customers/{customerId}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"aliases\": [],\n \"contacts\": [\n {\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"title\": \"<string>\",\n \"phone\": \"<string>\",\n \"receiveInvoiceEmail\": true\n }\n ],\n \"legalName\": \"<string>\",\n \"taxIds\": [],\n \"taxId\": \"<string>\",\n \"cloudProviderSettings\": {\n \"cloudProviderMarketplaceId\": \"<string>\",\n \"customerIdentifier\": \"<string>\"\n },\n \"externalId\": \"<string>\",\n \"customerErpId\": \"<string>\",\n \"address\": {\n \"country\": \"<string>\",\n \"countryCode\": \"<string>\",\n \"city\": \"<string>\",\n \"addressText\": \"<string>\",\n \"state\": \"<string>\",\n \"postalCode\": \"<string>\"\n },\n \"shippingAddress\": {\n \"country\": \"<string>\",\n \"countryCode\": \"<string>\",\n \"city\": \"<string>\",\n \"addressText\": \"<string>\",\n \"state\": \"<string>\",\n \"postalCode\": \"<string>\"\n },\n \"salesForceAccountId\": \"<string>\",\n \"externalIntegration\": [\n {\n \"type\": \"Stripe\",\n \"id\": \"cus_123\",\n \"name\": \"Acme Inc\"\n }\n ],\n \"customFields\": [\n {\n \"vayuCustomFieldName\": \"<string>\",\n \"fieldPath\": \"<string>\",\n \"value\": \"<unknown>\"\n }\n ],\n \"customFieldValues\": [\n {\n \"customFieldDefinitionId\": \"<string>\",\n \"value\": \"<string>\",\n \"fieldName\": \"<string>\"\n }\n ],\n \"subsidiary\": \"<string>\",\n \"totalOutstandingAmount\": 123,\n \"openAmount\": 123,\n \"overdueAmount\": 123,\n \"pendingPaymentAmount\": 123,\n \"paidAmount\": 123\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://connect.withvayu.com/customers/{customerId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"aliases\": [],\n \"contacts\": [\n {\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"title\": \"<string>\",\n \"phone\": \"<string>\",\n \"receiveInvoiceEmail\": true\n }\n ],\n \"legalName\": \"<string>\",\n \"taxIds\": [],\n \"taxId\": \"<string>\",\n \"cloudProviderSettings\": {\n \"cloudProviderMarketplaceId\": \"<string>\",\n \"customerIdentifier\": \"<string>\"\n },\n \"externalId\": \"<string>\",\n \"customerErpId\": \"<string>\",\n \"address\": {\n \"country\": \"<string>\",\n \"countryCode\": \"<string>\",\n \"city\": \"<string>\",\n \"addressText\": \"<string>\",\n \"state\": \"<string>\",\n \"postalCode\": \"<string>\"\n },\n \"shippingAddress\": {\n \"country\": \"<string>\",\n \"countryCode\": \"<string>\",\n \"city\": \"<string>\",\n \"addressText\": \"<string>\",\n \"state\": \"<string>\",\n \"postalCode\": \"<string>\"\n },\n \"salesForceAccountId\": \"<string>\",\n \"externalIntegration\": [\n {\n \"type\": \"Stripe\",\n \"id\": \"cus_123\",\n \"name\": \"Acme Inc\"\n }\n ],\n \"customFields\": [\n {\n \"vayuCustomFieldName\": \"<string>\",\n \"fieldPath\": \"<string>\",\n \"value\": \"<unknown>\"\n }\n ],\n \"customFieldValues\": [\n {\n \"customFieldDefinitionId\": \"<string>\",\n \"value\": \"<string>\",\n \"fieldName\": \"<string>\"\n }\n ],\n \"subsidiary\": \"<string>\",\n \"totalOutstandingAmount\": 123,\n \"openAmount\": 123,\n \"overdueAmount\": 123,\n \"pendingPaymentAmount\": 123,\n \"paidAmount\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://connect.withvayu.com/customers/{customerId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"aliases\": [],\n \"contacts\": [\n {\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"title\": \"<string>\",\n \"phone\": \"<string>\",\n \"receiveInvoiceEmail\": true\n }\n ],\n \"legalName\": \"<string>\",\n \"taxIds\": [],\n \"taxId\": \"<string>\",\n \"cloudProviderSettings\": {\n \"cloudProviderMarketplaceId\": \"<string>\",\n \"customerIdentifier\": \"<string>\"\n },\n \"externalId\": \"<string>\",\n \"customerErpId\": \"<string>\",\n \"address\": {\n \"country\": \"<string>\",\n \"countryCode\": \"<string>\",\n \"city\": \"<string>\",\n \"addressText\": \"<string>\",\n \"state\": \"<string>\",\n \"postalCode\": \"<string>\"\n },\n \"shippingAddress\": {\n \"country\": \"<string>\",\n \"countryCode\": \"<string>\",\n \"city\": \"<string>\",\n \"addressText\": \"<string>\",\n \"state\": \"<string>\",\n \"postalCode\": \"<string>\"\n },\n \"salesForceAccountId\": \"<string>\",\n \"externalIntegration\": [\n {\n \"type\": \"Stripe\",\n \"id\": \"cus_123\",\n \"name\": \"Acme Inc\"\n }\n ],\n \"customFields\": [\n {\n \"vayuCustomFieldName\": \"<string>\",\n \"fieldPath\": \"<string>\",\n \"value\": \"<unknown>\"\n }\n ],\n \"customFieldValues\": [\n {\n \"customFieldDefinitionId\": \"<string>\",\n \"value\": \"<string>\",\n \"fieldName\": \"<string>\"\n }\n ],\n \"subsidiary\": \"<string>\",\n \"totalOutstandingAmount\": 123,\n \"openAmount\": 123,\n \"overdueAmount\": 123,\n \"pendingPaymentAmount\": 123,\n \"paidAmount\": 123\n}"
response = http.request(request)
puts response.read_body{
"customer": {
"name": "<string>",
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"aliases": [],
"contacts": [
{
"name": "<string>",
"email": "<string>",
"title": "<string>",
"phone": "<string>",
"receiveInvoiceEmail": true
}
],
"source": "Stripe",
"legalName": "<string>",
"taxIds": [],
"status": "Active",
"taxId": "<string>",
"cloudProviderSettings": {
"cloudProvider": "AWS",
"cloudProviderMarketplaceId": "<string>",
"customerIdentifier": "<string>"
},
"externalId": "<string>",
"customerErpId": "<string>",
"address": {
"country": "<string>",
"countryCode": "<string>",
"city": "<string>",
"addressText": "<string>",
"state": "<string>",
"postalCode": "<string>"
},
"shippingAddress": {
"country": "<string>",
"countryCode": "<string>",
"city": "<string>",
"addressText": "<string>",
"state": "<string>",
"postalCode": "<string>"
},
"salesForceAccountId": "<string>",
"externalIntegration": [
{
"type": "Stripe",
"id": "cus_123",
"name": "Acme Inc"
}
],
"dueDays": "END_OF_MONTH",
"currency": "USD",
"customFields": [
{
"vayuCustomFieldName": "<string>",
"valueType": "String",
"integrationSource": "NetSuite",
"integrationEntityType": "Account",
"fieldPath": "<string>",
"value": "<unknown>"
}
],
"customFieldValues": [
{
"customFieldDefinitionId": "<string>",
"value": "<string>",
"fieldName": "<string>"
}
],
"subsidiary": "<string>",
"totalOutstandingAmount": 123,
"openAmount": 123,
"overdueAmount": 123,
"pendingPaymentAmount": 123,
"paidAmount": 123
}
}{
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"requiredScope": "<string>",
"param": "<string>",
"params": [
{
"param": "<string>",
"message": "<string>"
}
]
}{
"type": "authentication_error",
"code": "authentication_failed",
"message": "<string>",
"requiredScope": "<string>"
}{
"type": "invalid_request_error",
"code": "resource_not_found",
"message": "<string>",
"requiredScope": "<string>"
}{
"type": "rate_limit_error",
"code": "rate_limit_exceeded",
"message": "<string>",
"requiredScope": "<string>"
}{
"type": "api_error",
"code": "internal_error",
"message": "<string>",
"requiredScope": "<string>"
}Customers
Update Customer
Update a Customer by id.
PUT
/
customers
/
{customerId}
Update Customer
curl --request PUT \
--url https://connect.withvayu.com/customers/{customerId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"aliases": [],
"contacts": [
{
"name": "<string>",
"email": "<string>",
"title": "<string>",
"phone": "<string>",
"receiveInvoiceEmail": true
}
],
"legalName": "<string>",
"taxIds": [],
"taxId": "<string>",
"cloudProviderSettings": {
"cloudProviderMarketplaceId": "<string>",
"customerIdentifier": "<string>"
},
"externalId": "<string>",
"customerErpId": "<string>",
"address": {
"country": "<string>",
"countryCode": "<string>",
"city": "<string>",
"addressText": "<string>",
"state": "<string>",
"postalCode": "<string>"
},
"shippingAddress": {
"country": "<string>",
"countryCode": "<string>",
"city": "<string>",
"addressText": "<string>",
"state": "<string>",
"postalCode": "<string>"
},
"salesForceAccountId": "<string>",
"externalIntegration": [
{
"type": "Stripe",
"id": "cus_123",
"name": "Acme Inc"
}
],
"customFields": [
{
"vayuCustomFieldName": "<string>",
"fieldPath": "<string>",
"value": "<unknown>"
}
],
"customFieldValues": [
{
"customFieldDefinitionId": "<string>",
"value": "<string>",
"fieldName": "<string>"
}
],
"subsidiary": "<string>",
"totalOutstandingAmount": 123,
"openAmount": 123,
"overdueAmount": 123,
"pendingPaymentAmount": 123,
"paidAmount": 123
}
'import requests
url = "https://connect.withvayu.com/customers/{customerId}"
payload = {
"name": "<string>",
"aliases": [],
"contacts": [
{
"name": "<string>",
"email": "<string>",
"title": "<string>",
"phone": "<string>",
"receiveInvoiceEmail": True
}
],
"legalName": "<string>",
"taxIds": [],
"taxId": "<string>",
"cloudProviderSettings": {
"cloudProviderMarketplaceId": "<string>",
"customerIdentifier": "<string>"
},
"externalId": "<string>",
"customerErpId": "<string>",
"address": {
"country": "<string>",
"countryCode": "<string>",
"city": "<string>",
"addressText": "<string>",
"state": "<string>",
"postalCode": "<string>"
},
"shippingAddress": {
"country": "<string>",
"countryCode": "<string>",
"city": "<string>",
"addressText": "<string>",
"state": "<string>",
"postalCode": "<string>"
},
"salesForceAccountId": "<string>",
"externalIntegration": [
{
"type": "Stripe",
"id": "cus_123",
"name": "Acme Inc"
}
],
"customFields": [
{
"vayuCustomFieldName": "<string>",
"fieldPath": "<string>",
"value": "<unknown>"
}
],
"customFieldValues": [
{
"customFieldDefinitionId": "<string>",
"value": "<string>",
"fieldName": "<string>"
}
],
"subsidiary": "<string>",
"totalOutstandingAmount": 123,
"openAmount": 123,
"overdueAmount": 123,
"pendingPaymentAmount": 123,
"paidAmount": 123
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
aliases: [],
contacts: [
{
name: '<string>',
email: '<string>',
title: '<string>',
phone: '<string>',
receiveInvoiceEmail: true
}
],
legalName: '<string>',
taxIds: [],
taxId: '<string>',
cloudProviderSettings: {cloudProviderMarketplaceId: '<string>', customerIdentifier: '<string>'},
externalId: '<string>',
customerErpId: '<string>',
address: {
country: '<string>',
countryCode: '<string>',
city: '<string>',
addressText: '<string>',
state: '<string>',
postalCode: '<string>'
},
shippingAddress: {
country: '<string>',
countryCode: '<string>',
city: '<string>',
addressText: '<string>',
state: '<string>',
postalCode: '<string>'
},
salesForceAccountId: '<string>',
externalIntegration: [{type: 'Stripe', id: 'cus_123', name: 'Acme Inc'}],
customFields: [{vayuCustomFieldName: '<string>', fieldPath: '<string>', value: '<unknown>'}],
customFieldValues: [
{customFieldDefinitionId: '<string>', value: '<string>', fieldName: '<string>'}
],
subsidiary: '<string>',
totalOutstandingAmount: 123,
openAmount: 123,
overdueAmount: 123,
pendingPaymentAmount: 123,
paidAmount: 123
})
};
fetch('https://connect.withvayu.com/customers/{customerId}', 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/customers/{customerId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'aliases' => [
],
'contacts' => [
[
'name' => '<string>',
'email' => '<string>',
'title' => '<string>',
'phone' => '<string>',
'receiveInvoiceEmail' => true
]
],
'legalName' => '<string>',
'taxIds' => [
],
'taxId' => '<string>',
'cloudProviderSettings' => [
'cloudProviderMarketplaceId' => '<string>',
'customerIdentifier' => '<string>'
],
'externalId' => '<string>',
'customerErpId' => '<string>',
'address' => [
'country' => '<string>',
'countryCode' => '<string>',
'city' => '<string>',
'addressText' => '<string>',
'state' => '<string>',
'postalCode' => '<string>'
],
'shippingAddress' => [
'country' => '<string>',
'countryCode' => '<string>',
'city' => '<string>',
'addressText' => '<string>',
'state' => '<string>',
'postalCode' => '<string>'
],
'salesForceAccountId' => '<string>',
'externalIntegration' => [
[
'type' => 'Stripe',
'id' => 'cus_123',
'name' => 'Acme Inc'
]
],
'customFields' => [
[
'vayuCustomFieldName' => '<string>',
'fieldPath' => '<string>',
'value' => '<unknown>'
]
],
'customFieldValues' => [
[
'customFieldDefinitionId' => '<string>',
'value' => '<string>',
'fieldName' => '<string>'
]
],
'subsidiary' => '<string>',
'totalOutstandingAmount' => 123,
'openAmount' => 123,
'overdueAmount' => 123,
'pendingPaymentAmount' => 123,
'paidAmount' => 123
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://connect.withvayu.com/customers/{customerId}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"aliases\": [],\n \"contacts\": [\n {\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"title\": \"<string>\",\n \"phone\": \"<string>\",\n \"receiveInvoiceEmail\": true\n }\n ],\n \"legalName\": \"<string>\",\n \"taxIds\": [],\n \"taxId\": \"<string>\",\n \"cloudProviderSettings\": {\n \"cloudProviderMarketplaceId\": \"<string>\",\n \"customerIdentifier\": \"<string>\"\n },\n \"externalId\": \"<string>\",\n \"customerErpId\": \"<string>\",\n \"address\": {\n \"country\": \"<string>\",\n \"countryCode\": \"<string>\",\n \"city\": \"<string>\",\n \"addressText\": \"<string>\",\n \"state\": \"<string>\",\n \"postalCode\": \"<string>\"\n },\n \"shippingAddress\": {\n \"country\": \"<string>\",\n \"countryCode\": \"<string>\",\n \"city\": \"<string>\",\n \"addressText\": \"<string>\",\n \"state\": \"<string>\",\n \"postalCode\": \"<string>\"\n },\n \"salesForceAccountId\": \"<string>\",\n \"externalIntegration\": [\n {\n \"type\": \"Stripe\",\n \"id\": \"cus_123\",\n \"name\": \"Acme Inc\"\n }\n ],\n \"customFields\": [\n {\n \"vayuCustomFieldName\": \"<string>\",\n \"fieldPath\": \"<string>\",\n \"value\": \"<unknown>\"\n }\n ],\n \"customFieldValues\": [\n {\n \"customFieldDefinitionId\": \"<string>\",\n \"value\": \"<string>\",\n \"fieldName\": \"<string>\"\n }\n ],\n \"subsidiary\": \"<string>\",\n \"totalOutstandingAmount\": 123,\n \"openAmount\": 123,\n \"overdueAmount\": 123,\n \"pendingPaymentAmount\": 123,\n \"paidAmount\": 123\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://connect.withvayu.com/customers/{customerId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"aliases\": [],\n \"contacts\": [\n {\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"title\": \"<string>\",\n \"phone\": \"<string>\",\n \"receiveInvoiceEmail\": true\n }\n ],\n \"legalName\": \"<string>\",\n \"taxIds\": [],\n \"taxId\": \"<string>\",\n \"cloudProviderSettings\": {\n \"cloudProviderMarketplaceId\": \"<string>\",\n \"customerIdentifier\": \"<string>\"\n },\n \"externalId\": \"<string>\",\n \"customerErpId\": \"<string>\",\n \"address\": {\n \"country\": \"<string>\",\n \"countryCode\": \"<string>\",\n \"city\": \"<string>\",\n \"addressText\": \"<string>\",\n \"state\": \"<string>\",\n \"postalCode\": \"<string>\"\n },\n \"shippingAddress\": {\n \"country\": \"<string>\",\n \"countryCode\": \"<string>\",\n \"city\": \"<string>\",\n \"addressText\": \"<string>\",\n \"state\": \"<string>\",\n \"postalCode\": \"<string>\"\n },\n \"salesForceAccountId\": \"<string>\",\n \"externalIntegration\": [\n {\n \"type\": \"Stripe\",\n \"id\": \"cus_123\",\n \"name\": \"Acme Inc\"\n }\n ],\n \"customFields\": [\n {\n \"vayuCustomFieldName\": \"<string>\",\n \"fieldPath\": \"<string>\",\n \"value\": \"<unknown>\"\n }\n ],\n \"customFieldValues\": [\n {\n \"customFieldDefinitionId\": \"<string>\",\n \"value\": \"<string>\",\n \"fieldName\": \"<string>\"\n }\n ],\n \"subsidiary\": \"<string>\",\n \"totalOutstandingAmount\": 123,\n \"openAmount\": 123,\n \"overdueAmount\": 123,\n \"pendingPaymentAmount\": 123,\n \"paidAmount\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://connect.withvayu.com/customers/{customerId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"aliases\": [],\n \"contacts\": [\n {\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"title\": \"<string>\",\n \"phone\": \"<string>\",\n \"receiveInvoiceEmail\": true\n }\n ],\n \"legalName\": \"<string>\",\n \"taxIds\": [],\n \"taxId\": \"<string>\",\n \"cloudProviderSettings\": {\n \"cloudProviderMarketplaceId\": \"<string>\",\n \"customerIdentifier\": \"<string>\"\n },\n \"externalId\": \"<string>\",\n \"customerErpId\": \"<string>\",\n \"address\": {\n \"country\": \"<string>\",\n \"countryCode\": \"<string>\",\n \"city\": \"<string>\",\n \"addressText\": \"<string>\",\n \"state\": \"<string>\",\n \"postalCode\": \"<string>\"\n },\n \"shippingAddress\": {\n \"country\": \"<string>\",\n \"countryCode\": \"<string>\",\n \"city\": \"<string>\",\n \"addressText\": \"<string>\",\n \"state\": \"<string>\",\n \"postalCode\": \"<string>\"\n },\n \"salesForceAccountId\": \"<string>\",\n \"externalIntegration\": [\n {\n \"type\": \"Stripe\",\n \"id\": \"cus_123\",\n \"name\": \"Acme Inc\"\n }\n ],\n \"customFields\": [\n {\n \"vayuCustomFieldName\": \"<string>\",\n \"fieldPath\": \"<string>\",\n \"value\": \"<unknown>\"\n }\n ],\n \"customFieldValues\": [\n {\n \"customFieldDefinitionId\": \"<string>\",\n \"value\": \"<string>\",\n \"fieldName\": \"<string>\"\n }\n ],\n \"subsidiary\": \"<string>\",\n \"totalOutstandingAmount\": 123,\n \"openAmount\": 123,\n \"overdueAmount\": 123,\n \"pendingPaymentAmount\": 123,\n \"paidAmount\": 123\n}"
response = http.request(request)
puts response.read_body{
"customer": {
"name": "<string>",
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"aliases": [],
"contacts": [
{
"name": "<string>",
"email": "<string>",
"title": "<string>",
"phone": "<string>",
"receiveInvoiceEmail": true
}
],
"source": "Stripe",
"legalName": "<string>",
"taxIds": [],
"status": "Active",
"taxId": "<string>",
"cloudProviderSettings": {
"cloudProvider": "AWS",
"cloudProviderMarketplaceId": "<string>",
"customerIdentifier": "<string>"
},
"externalId": "<string>",
"customerErpId": "<string>",
"address": {
"country": "<string>",
"countryCode": "<string>",
"city": "<string>",
"addressText": "<string>",
"state": "<string>",
"postalCode": "<string>"
},
"shippingAddress": {
"country": "<string>",
"countryCode": "<string>",
"city": "<string>",
"addressText": "<string>",
"state": "<string>",
"postalCode": "<string>"
},
"salesForceAccountId": "<string>",
"externalIntegration": [
{
"type": "Stripe",
"id": "cus_123",
"name": "Acme Inc"
}
],
"dueDays": "END_OF_MONTH",
"currency": "USD",
"customFields": [
{
"vayuCustomFieldName": "<string>",
"valueType": "String",
"integrationSource": "NetSuite",
"integrationEntityType": "Account",
"fieldPath": "<string>",
"value": "<unknown>"
}
],
"customFieldValues": [
{
"customFieldDefinitionId": "<string>",
"value": "<string>",
"fieldName": "<string>"
}
],
"subsidiary": "<string>",
"totalOutstandingAmount": 123,
"openAmount": 123,
"overdueAmount": 123,
"pendingPaymentAmount": 123,
"paidAmount": 123
}
}{
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"requiredScope": "<string>",
"param": "<string>",
"params": [
{
"param": "<string>",
"message": "<string>"
}
]
}{
"type": "authentication_error",
"code": "authentication_failed",
"message": "<string>",
"requiredScope": "<string>"
}{
"type": "invalid_request_error",
"code": "resource_not_found",
"message": "<string>",
"requiredScope": "<string>"
}{
"type": "rate_limit_error",
"code": "rate_limit_exceeded",
"message": "<string>",
"requiredScope": "<string>"
}{
"type": "api_error",
"code": "internal_error",
"message": "<string>",
"requiredScope": "<string>"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Pattern:
^[0-9a-fA-F]{24}$Body
application/json
The name of the customer
Minimum string length:
1The aliases of the customer used to match events to the customer.
The contacts of the customer. Contact marked as primary is the target for invoice sharing.
Show child attributes
Show child attributes
The source of the customer
Available options:
Stripe, VayuEventsApi, Api, Vayu, Salesforce, HubSpot, ContractExtraction The legal name of the customer
The tax IDs of the customer
The lifecycle status of the customer. Defaults to Active when omitted on creation.
Available options:
Active, Inactive, Suspended, Trial The tax ID of the customer (deprecated, use taxIds instead)
Cloud provider settings for the customer
Show child attributes
Show child attributes
The external ID of the customer
The ID of the customer in the ERP system
The address of the customer
Show child attributes
Show child attributes
The shipping address of the customer
Show child attributes
Show child attributes
The ID of the customer in the Salesforce system
External integration links for the customer. Each entry links the customer to an external provider entity by its id. Stripe entries are saved on the customer; other providers are linked via the integration registry.
Show child attributes
Show child attributes
Example:
[
{
"type": "Stripe",
"id": "cus_123",
"name": "Acme Inc"
}
]
The due days of the customer
Available options:
END_OF_MONTH, SAME_DAY, 15_DAYS, 30_DAYS, 45_DAYS, 60_DAYS, 90_DAYS, 180_DAYS The billing currency of the customer
Available options:
USD, EUR, GBP, ILS, CAD, AUD, COP, BRL, ARS, INR, MXN, CHF Custom fields from CRM systems (Salesforce, HubSpot, etc.)
Show child attributes
Show child attributes
The stored custom field values associated with the customer. Read-only: ignored on create and update requests; values are set via customFields.
Show child attributes
Show child attributes
The name of the subsidiary of the customer
Total outstanding amount across all unpaid invoices (in USD)
Total amount of invoices with no billing status set (in USD)
Total amount of overdue invoices (in USD)
Total amount of invoices pending payment (in USD)
Total amount of paid invoices (in USD)
Response
RequestSuccess
Show child attributes
Show child attributes