Create customer

curl --request POST \
  --url https://api.useaira.com/v1/customers/ \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "externalId": "705faf65-9c8b-4053-8c0b-2021281ce83f",
  "name": "Acme Inc.",
  "parentCustomerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "customFields": {
    "customField1": "value1",
    "customField2": [
      "value2",
      "value3"
    ]
  },
  "type": "individual"
}
'

import requests

url = "https://api.useaira.com/v1/customers/"

payload = {
    "externalId": "705faf65-9c8b-4053-8c0b-2021281ce83f",
    "name": "Acme Inc.",
    "parentCustomerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "customFields": {
        "customField1": "value1",
        "customField2": ["value2", "value3"]
    },
    "type": "individual"
}
headers = {
    "X-API-KEY": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    externalId: '705faf65-9c8b-4053-8c0b-2021281ce83f',
    name: 'Acme Inc.',
    parentCustomerId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    customFields: {customField1: 'value1', customField2: ['value2', 'value3']},
    type: 'individual'
  })
};

fetch('https://api.useaira.com/v1/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://api.useaira.com/v1/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([
    'externalId' => '705faf65-9c8b-4053-8c0b-2021281ce83f',
    'name' => 'Acme Inc.',
    'parentCustomerId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'customFields' => [
        'customField1' => 'value1',
        'customField2' => [
                'value2',
                'value3'
        ]
    ],
    'type' => 'individual'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-KEY: <api-key>"
  ],
]);

$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://api.useaira.com/v1/customers/"

	payload := strings.NewReader("{\n  \"externalId\": \"705faf65-9c8b-4053-8c0b-2021281ce83f\",\n  \"name\": \"Acme Inc.\",\n  \"parentCustomerId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"customFields\": {\n    \"customField1\": \"value1\",\n    \"customField2\": [\n      \"value2\",\n      \"value3\"\n    ]\n  },\n  \"type\": \"individual\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-KEY", "<api-key>")
	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://api.useaira.com/v1/customers/")
  .header("X-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"externalId\": \"705faf65-9c8b-4053-8c0b-2021281ce83f\",\n  \"name\": \"Acme Inc.\",\n  \"parentCustomerId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"customFields\": {\n    \"customField1\": \"value1\",\n    \"customField2\": [\n      \"value2\",\n      \"value3\"\n    ]\n  },\n  \"type\": \"individual\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.useaira.com/v1/customers/")

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

request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"externalId\": \"705faf65-9c8b-4053-8c0b-2021281ce83f\",\n  \"name\": \"Acme Inc.\",\n  \"parentCustomerId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"customFields\": {\n    \"customField1\": \"value1\",\n    \"customField2\": [\n      \"value2\",\n      \"value3\"\n    ]\n  },\n  \"type\": \"individual\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "externalId": "705faf65-9c8b-4053-8c0b-2021281ce83f",
  "name": "Acme Inc.",
  "type": "individual",
  "invoicePrefix": "ACMEI",
  "parentCustomerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "archivedAt": "2023-11-07T05:31:56Z",
  "customFields": {
    "customField1": "value1",
    "customField2": [
      "value2",
      "value3"
    ]
  }
}

{
  "message": "<string>",
  "code": "<string>",
  "details": {},
  "causations": [
    {
      "message": "<string>",
      "code": "<string>",
      "details": {}
    }
  ]
}

POST

customers

Create customer

curl --request POST \
  --url https://api.useaira.com/v1/customers/ \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "externalId": "705faf65-9c8b-4053-8c0b-2021281ce83f",
  "name": "Acme Inc.",
  "parentCustomerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "customFields": {
    "customField1": "value1",
    "customField2": [
      "value2",
      "value3"
    ]
  },
  "type": "individual"
}
'

import requests

url = "https://api.useaira.com/v1/customers/"

payload = {
    "externalId": "705faf65-9c8b-4053-8c0b-2021281ce83f",
    "name": "Acme Inc.",
    "parentCustomerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "customFields": {
        "customField1": "value1",
        "customField2": ["value2", "value3"]
    },
    "type": "individual"
}
headers = {
    "X-API-KEY": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    externalId: '705faf65-9c8b-4053-8c0b-2021281ce83f',
    name: 'Acme Inc.',
    parentCustomerId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    customFields: {customField1: 'value1', customField2: ['value2', 'value3']},
    type: 'individual'
  })
};

fetch('https://api.useaira.com/v1/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://api.useaira.com/v1/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([
    'externalId' => '705faf65-9c8b-4053-8c0b-2021281ce83f',
    'name' => 'Acme Inc.',
    'parentCustomerId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'customFields' => [
        'customField1' => 'value1',
        'customField2' => [
                'value2',
                'value3'
        ]
    ],
    'type' => 'individual'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-KEY: <api-key>"
  ],
]);

$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://api.useaira.com/v1/customers/"

	payload := strings.NewReader("{\n  \"externalId\": \"705faf65-9c8b-4053-8c0b-2021281ce83f\",\n  \"name\": \"Acme Inc.\",\n  \"parentCustomerId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"customFields\": {\n    \"customField1\": \"value1\",\n    \"customField2\": [\n      \"value2\",\n      \"value3\"\n    ]\n  },\n  \"type\": \"individual\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-KEY", "<api-key>")
	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://api.useaira.com/v1/customers/")
  .header("X-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"externalId\": \"705faf65-9c8b-4053-8c0b-2021281ce83f\",\n  \"name\": \"Acme Inc.\",\n  \"parentCustomerId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"customFields\": {\n    \"customField1\": \"value1\",\n    \"customField2\": [\n      \"value2\",\n      \"value3\"\n    ]\n  },\n  \"type\": \"individual\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.useaira.com/v1/customers/")

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

request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"externalId\": \"705faf65-9c8b-4053-8c0b-2021281ce83f\",\n  \"name\": \"Acme Inc.\",\n  \"parentCustomerId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"customFields\": {\n    \"customField1\": \"value1\",\n    \"customField2\": [\n      \"value2\",\n      \"value3\"\n    ]\n  },\n  \"type\": \"individual\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "externalId": "705faf65-9c8b-4053-8c0b-2021281ce83f",
  "name": "Acme Inc.",
  "type": "individual",
  "invoicePrefix": "ACMEI",
  "parentCustomerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "archivedAt": "2023-11-07T05:31:56Z",
  "customFields": {
    "customField1": "value1",
    "customField2": [
      "value2",
      "value3"
    ]
  }
}

{
  "message": "<string>",
  "code": "<string>",
  "details": {},
  "causations": [
    {
      "message": "<string>",
      "code": "<string>",
      "details": {}
    }
  ]
}

Authorizations

X-API-KEY

string

header

required

API Key Authentication.

Headers

override-tax-id-uniqueness

boolean

default:false

When true, accepts a tax ID that another payment account holds.

Body

application/json

Schema representing a customer.

externalId

string

required

An optional external identifier of the customer from the external system, used throughout the system to identify the customer.

Pattern: ^[a-zA-Z0-9_-]+$

Example:

"705faf65-9c8b-4053-8c0b-2021281ce83f"

name

string

required

The name of the customer.

Example:

"Acme Inc."

parentCustomerId

null | string<uuid>

Parent customer ID when customer is a subsidiary.

customFields

object

Custom fields that can be associated with the entity. The fields must be previously created in the system before they can be used.

Show child attributes

Example:

{
  "customField1": "value1",
  "customField2": ["value2", "value3"]
}

type

enum<string>

default:individual

Customer type in organizations hierarchy.

Available options:

individual,

organization,

subsidiary

Example:

"individual"

paymentAccount

object

Optional payment account to create together with the customer. When provided, a legal entity is created and linked to the customer in the same transaction.

Show child attributes

Response

Schema representing a customer.

string<uuid>

required

The unique identifier of the customer in our system.

externalId

string

required

An optional external identifier of the customer from the external system, used throughout the system to identify the customer.

Pattern: ^[a-zA-Z0-9_-]+$

Example:

"705faf65-9c8b-4053-8c0b-2021281ce83f"

name

string

required

The name of the customer.

Example:

"Acme Inc."

type

enum<string>

required

Customer type in organizations hierarchy.

Available options:

individual,

organization,

subsidiary

Example:

"individual"

invoicePrefix

string

The prefix of the customer's invoices. This is generated by the system and cannot be updated.

Example:

"ACMEI"

parentCustomerId

null | string<uuid>

Parent customer ID when customer is a subsidiary.

archivedAt

null | string<date-time>

Archive timestamp for customers that were archived.

customFields

object

Custom fields that can be associated with the entity. The fields must be previously created in the system before they can be used.

Show child attributes

Example:

{
  "customField1": "value1",
  "customField2": ["value2", "value3"]
}