Skip to main content
POST
/
customers
Create Customer
curl --request POST \
  --url https://connect.withvayu.com/customers \
  --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": {
    "cloudProvider": "AWS",
    "cloudProviderMarketplaceId": "<string>",
    "customerIdentifier": "<string>"
  },
  "externalId": "<string>",
  "customerErpId": "<string>",
  "address": {
    "country": "<string>",
    "city": "<string>",
    "addressText": "<string>",
    "state": "<string>",
    "postalCode": "<string>"
  },
  "salesForceAccountId": "<string>",
  "customFields": [
    {
      "vayuCustomFieldName": "<string>",
      "fieldPath": "<string>",
      "value": "<unknown>"
    }
  ],
  "subsidiary": "<string>",
  "totalOutstandingAmount": 123,
  "openAmount": 123,
  "overdueAmount": 123,
  "pendingPaymentAmount": 123,
  "paidAmount": 123
}
'
import requests

url = "https://connect.withvayu.com/customers"

payload = {
    "name": "<string>",
    "aliases": [],
    "contacts": [
        {
            "name": "<string>",
            "email": "<string>",
            "title": "<string>",
            "phone": "<string>",
            "receiveInvoiceEmail": True
        }
    ],
    "legalName": "<string>",
    "taxIds": [],
    "taxId": "<string>",
    "cloudProviderSettings": {
        "cloudProvider": "AWS",
        "cloudProviderMarketplaceId": "<string>",
        "customerIdentifier": "<string>"
    },
    "externalId": "<string>",
    "customerErpId": "<string>",
    "address": {
        "country": "<string>",
        "city": "<string>",
        "addressText": "<string>",
        "state": "<string>",
        "postalCode": "<string>"
    },
    "salesForceAccountId": "<string>",
    "customFields": [
        {
            "vayuCustomFieldName": "<string>",
            "fieldPath": "<string>",
            "value": "<unknown>"
        }
    ],
    "subsidiary": "<string>",
    "totalOutstandingAmount": 123,
    "openAmount": 123,
    "overdueAmount": 123,
    "pendingPaymentAmount": 123,
    "paidAmount": 123
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  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: {
      cloudProvider: 'AWS',
      cloudProviderMarketplaceId: '<string>',
      customerIdentifier: '<string>'
    },
    externalId: '<string>',
    customerErpId: '<string>',
    address: {
      country: '<string>',
      city: '<string>',
      addressText: '<string>',
      state: '<string>',
      postalCode: '<string>'
    },
    salesForceAccountId: '<string>',
    customFields: [{vayuCustomFieldName: '<string>', fieldPath: '<string>', value: '<unknown>'}],
    subsidiary: '<string>',
    totalOutstandingAmount: 123,
    openAmount: 123,
    overdueAmount: 123,
    pendingPaymentAmount: 123,
    paidAmount: 123
  })
};

fetch('https://connect.withvayu.com/customers', 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",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'aliases' => [
        
    ],
    'contacts' => [
        [
                'name' => '<string>',
                'email' => '<string>',
                'title' => '<string>',
                'phone' => '<string>',
                'receiveInvoiceEmail' => true
        ]
    ],
    'legalName' => '<string>',
    'taxIds' => [
        
    ],
    'taxId' => '<string>',
    'cloudProviderSettings' => [
        'cloudProvider' => 'AWS',
        'cloudProviderMarketplaceId' => '<string>',
        'customerIdentifier' => '<string>'
    ],
    'externalId' => '<string>',
    'customerErpId' => '<string>',
    'address' => [
        'country' => '<string>',
        'city' => '<string>',
        'addressText' => '<string>',
        'state' => '<string>',
        'postalCode' => '<string>'
    ],
    'salesForceAccountId' => '<string>',
    'customFields' => [
        [
                'vayuCustomFieldName' => '<string>',
                'fieldPath' => '<string>',
                'value' => '<unknown>'
        ]
    ],
    '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"

	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    \"cloudProvider\": \"AWS\",\n    \"cloudProviderMarketplaceId\": \"<string>\",\n    \"customerIdentifier\": \"<string>\"\n  },\n  \"externalId\": \"<string>\",\n  \"customerErpId\": \"<string>\",\n  \"address\": {\n    \"country\": \"<string>\",\n    \"city\": \"<string>\",\n    \"addressText\": \"<string>\",\n    \"state\": \"<string>\",\n    \"postalCode\": \"<string>\"\n  },\n  \"salesForceAccountId\": \"<string>\",\n  \"customFields\": [\n    {\n      \"vayuCustomFieldName\": \"<string>\",\n      \"fieldPath\": \"<string>\",\n      \"value\": \"<unknown>\"\n    }\n  ],\n  \"subsidiary\": \"<string>\",\n  \"totalOutstandingAmount\": 123,\n  \"openAmount\": 123,\n  \"overdueAmount\": 123,\n  \"pendingPaymentAmount\": 123,\n  \"paidAmount\": 123\n}")

	req, _ := http.NewRequest("POST", 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.post("https://connect.withvayu.com/customers")
  .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    \"cloudProvider\": \"AWS\",\n    \"cloudProviderMarketplaceId\": \"<string>\",\n    \"customerIdentifier\": \"<string>\"\n  },\n  \"externalId\": \"<string>\",\n  \"customerErpId\": \"<string>\",\n  \"address\": {\n    \"country\": \"<string>\",\n    \"city\": \"<string>\",\n    \"addressText\": \"<string>\",\n    \"state\": \"<string>\",\n    \"postalCode\": \"<string>\"\n  },\n  \"salesForceAccountId\": \"<string>\",\n  \"customFields\": [\n    {\n      \"vayuCustomFieldName\": \"<string>\",\n      \"fieldPath\": \"<string>\",\n      \"value\": \"<unknown>\"\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")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.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    \"cloudProvider\": \"AWS\",\n    \"cloudProviderMarketplaceId\": \"<string>\",\n    \"customerIdentifier\": \"<string>\"\n  },\n  \"externalId\": \"<string>\",\n  \"customerErpId\": \"<string>\",\n  \"address\": {\n    \"country\": \"<string>\",\n    \"city\": \"<string>\",\n    \"addressText\": \"<string>\",\n    \"state\": \"<string>\",\n    \"postalCode\": \"<string>\"\n  },\n  \"salesForceAccountId\": \"<string>\",\n  \"customFields\": [\n    {\n      \"vayuCustomFieldName\": \"<string>\",\n      \"fieldPath\": \"<string>\",\n      \"value\": \"<unknown>\"\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
      }
    ],
    "legalName": "<string>",
    "taxIds": [],
    "taxId": "<string>",
    "cloudProviderSettings": {
      "cloudProvider": "AWS",
      "cloudProviderMarketplaceId": "<string>",
      "customerIdentifier": "<string>"
    },
    "externalId": "<string>",
    "customerErpId": "<string>",
    "address": {
      "country": "<string>",
      "city": "<string>",
      "addressText": "<string>",
      "state": "<string>",
      "postalCode": "<string>"
    },
    "salesForceAccountId": "<string>",
    "customFields": [
      {
        "vayuCustomFieldName": "<string>",
        "fieldPath": "<string>",
        "value": "<unknown>"
      }
    ],
    "subsidiary": "<string>",
    "totalOutstandingAmount": 123,
    "openAmount": 123,
    "overdueAmount": 123,
    "pendingPaymentAmount": 123,
    "paidAmount": 123
  }
}
{
  "type": "invalid_request_error",
  "code": "<string>",
  "message": "<string>",
  "param": "<string>",
  "params": [
    {
      "param": "<string>",
      "message": "<string>"
    }
  ]
}
{
  "type": "authentication_error",
  "code": "authentication_failed",
  "message": "<string>"
}
{
  "type": "rate_limit_error",
  "code": "rate_limit_exceeded",
  "message": "<string>"
}
{
  "type": "api_error",
  "code": "internal_error",
  "message": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
name
string
required

The name of the customer

​
aliases
string[] | null

The aliases of the customer used to match events to the customer.

​
contacts
object[] | null

The contacts of the customer. Contact marked as primary is the target for invoice sharing.

​
source
enum<string> | null

The source of the customer

Available options:
Stripe,
VayuEventsApi,
Api,
Salesforce,
HubSpot
​
legalName
string | null

The legal name of the customer

​
taxIds
string[] | null

The tax IDs of the customer

​
taxId
string | null
deprecated

The tax ID of the customer (deprecated, use taxIds instead)

​
cloudProviderSettings
object | null

Cloud provider settings for the customer

​
externalId
string

The external ID of the customer

​
customerErpId
string | null

The ID of the customer in the ERP system

​
address
object | null

The address of the customer

​
salesForceAccountId
string | null

The ID of the customer in the Salesforce system

​
dueDays
enum<string> | null

The due days of the customer

Available options:
END_OF_MONTH,
SAME_DAY,
15_DAYS,
30_DAYS,
45_DAYS,
60_DAYS,
90_DAYS
​
currency
enum<string> | null

The billing currency of the customer

Available options:
USD,
EUR,
GBP,
ILS,
CAD,
AUD,
COP,
BRL
​
customFields
object[] | null

Custom fields from CRM systems (Salesforce, HubSpot, etc.)

​
subsidiary
string | null

The name of the subsidiary of the customer

​
totalOutstandingAmount
number

Total outstanding amount across all unpaid invoices (in USD)

​
openAmount
number

Total amount of invoices with no billing status set (in USD)

​
overdueAmount
number

Total amount of overdue invoices (in USD)

​
pendingPaymentAmount
number

Total amount of invoices pending payment (in USD)

​
paidAmount
number

Total amount of paid invoices (in USD)

Response

RequestSuccess

​
customer
object
required