Create a new customer
curl --request POST \
--url https://api.spirii.com/v2/customers \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "John Smith",
"country": "DK",
"contactDetails": {
"name": "John Smith",
"email": "john.smith@email.com",
"phone": "+11 22 33 44"
},
"ownerId": 234,
"externalId": "CU-12345",
"payoutInformation": {
"iban": "DK5000400440116243",
"swiftCode": "ROYCCAT2XXX",
"bankAccountHolderName": "John Smith",
"bankRegistrationNumber": "1234",
"bankAccount": "1234567890"
},
"billingDetails": {
"address": "Street Avenue, 123",
"city": "Copenhagen",
"zipCode": "2300",
"invoiceFormat": "Email",
"gln": "0799439112768",
"invoiceEmail": "john.smith@email.com",
"vatNumber": "87687766",
"address2": "Apt. 4B"
},
"financialSetup": {
"language": "EN",
"currency": "EUR"
},
"billingSettings": {
"companyCarReimbursementMethod": "MANUAL",
"cpmsRevenueSharingRate": 0.15,
"cpmsRevenueSharingCurrency": "EUR",
"cpmsRevenueSharingEnabled": true
},
"receiptSettings": {
"customText": "<string>"
},
"isTaxableDealer": false
}
'import requests
url = "https://api.spirii.com/v2/customers"
payload = {
"name": "John Smith",
"country": "DK",
"contactDetails": {
"name": "John Smith",
"email": "john.smith@email.com",
"phone": "+11 22 33 44"
},
"ownerId": 234,
"externalId": "CU-12345",
"payoutInformation": {
"iban": "DK5000400440116243",
"swiftCode": "ROYCCAT2XXX",
"bankAccountHolderName": "John Smith",
"bankRegistrationNumber": "1234",
"bankAccount": "1234567890"
},
"billingDetails": {
"address": "Street Avenue, 123",
"city": "Copenhagen",
"zipCode": "2300",
"invoiceFormat": "Email",
"gln": "0799439112768",
"invoiceEmail": "john.smith@email.com",
"vatNumber": "87687766",
"address2": "Apt. 4B"
},
"financialSetup": {
"language": "EN",
"currency": "EUR"
},
"billingSettings": {
"companyCarReimbursementMethod": "MANUAL",
"cpmsRevenueSharingRate": 0.15,
"cpmsRevenueSharingCurrency": "EUR",
"cpmsRevenueSharingEnabled": True
},
"receiptSettings": { "customText": "<string>" },
"isTaxableDealer": False
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'John Smith',
country: 'DK',
contactDetails: {name: 'John Smith', email: 'john.smith@email.com', phone: '+11 22 33 44'},
ownerId: 234,
externalId: 'CU-12345',
payoutInformation: {
iban: 'DK5000400440116243',
swiftCode: 'ROYCCAT2XXX',
bankAccountHolderName: 'John Smith',
bankRegistrationNumber: '1234',
bankAccount: '1234567890'
},
billingDetails: {
address: 'Street Avenue, 123',
city: 'Copenhagen',
zipCode: '2300',
invoiceFormat: 'Email',
gln: '0799439112768',
invoiceEmail: 'john.smith@email.com',
vatNumber: '87687766',
address2: 'Apt. 4B'
},
financialSetup: {language: 'EN', currency: 'EUR'},
billingSettings: {
companyCarReimbursementMethod: 'MANUAL',
cpmsRevenueSharingRate: 0.15,
cpmsRevenueSharingCurrency: 'EUR',
cpmsRevenueSharingEnabled: true
},
receiptSettings: {customText: '<string>'},
isTaxableDealer: false
})
};
fetch('https://api.spirii.com/v2/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.spirii.com/v2/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' => 'John Smith',
'country' => 'DK',
'contactDetails' => [
'name' => 'John Smith',
'email' => 'john.smith@email.com',
'phone' => '+11 22 33 44'
],
'ownerId' => 234,
'externalId' => 'CU-12345',
'payoutInformation' => [
'iban' => 'DK5000400440116243',
'swiftCode' => 'ROYCCAT2XXX',
'bankAccountHolderName' => 'John Smith',
'bankRegistrationNumber' => '1234',
'bankAccount' => '1234567890'
],
'billingDetails' => [
'address' => 'Street Avenue, 123',
'city' => 'Copenhagen',
'zipCode' => '2300',
'invoiceFormat' => 'Email',
'gln' => '0799439112768',
'invoiceEmail' => 'john.smith@email.com',
'vatNumber' => '87687766',
'address2' => 'Apt. 4B'
],
'financialSetup' => [
'language' => 'EN',
'currency' => 'EUR'
],
'billingSettings' => [
'companyCarReimbursementMethod' => 'MANUAL',
'cpmsRevenueSharingRate' => 0.15,
'cpmsRevenueSharingCurrency' => 'EUR',
'cpmsRevenueSharingEnabled' => true
],
'receiptSettings' => [
'customText' => '<string>'
],
'isTaxableDealer' => false
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"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://api.spirii.com/v2/customers"
payload := strings.NewReader("{\n \"name\": \"John Smith\",\n \"country\": \"DK\",\n \"contactDetails\": {\n \"name\": \"John Smith\",\n \"email\": \"john.smith@email.com\",\n \"phone\": \"+11 22 33 44\"\n },\n \"ownerId\": 234,\n \"externalId\": \"CU-12345\",\n \"payoutInformation\": {\n \"iban\": \"DK5000400440116243\",\n \"swiftCode\": \"ROYCCAT2XXX\",\n \"bankAccountHolderName\": \"John Smith\",\n \"bankRegistrationNumber\": \"1234\",\n \"bankAccount\": \"1234567890\"\n },\n \"billingDetails\": {\n \"address\": \"Street Avenue, 123\",\n \"city\": \"Copenhagen\",\n \"zipCode\": \"2300\",\n \"invoiceFormat\": \"Email\",\n \"gln\": \"0799439112768\",\n \"invoiceEmail\": \"john.smith@email.com\",\n \"vatNumber\": \"87687766\",\n \"address2\": \"Apt. 4B\"\n },\n \"financialSetup\": {\n \"language\": \"EN\",\n \"currency\": \"EUR\"\n },\n \"billingSettings\": {\n \"companyCarReimbursementMethod\": \"MANUAL\",\n \"cpmsRevenueSharingRate\": 0.15,\n \"cpmsRevenueSharingCurrency\": \"EUR\",\n \"cpmsRevenueSharingEnabled\": true\n },\n \"receiptSettings\": {\n \"customText\": \"<string>\"\n },\n \"isTaxableDealer\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<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.spirii.com/v2/customers")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"John Smith\",\n \"country\": \"DK\",\n \"contactDetails\": {\n \"name\": \"John Smith\",\n \"email\": \"john.smith@email.com\",\n \"phone\": \"+11 22 33 44\"\n },\n \"ownerId\": 234,\n \"externalId\": \"CU-12345\",\n \"payoutInformation\": {\n \"iban\": \"DK5000400440116243\",\n \"swiftCode\": \"ROYCCAT2XXX\",\n \"bankAccountHolderName\": \"John Smith\",\n \"bankRegistrationNumber\": \"1234\",\n \"bankAccount\": \"1234567890\"\n },\n \"billingDetails\": {\n \"address\": \"Street Avenue, 123\",\n \"city\": \"Copenhagen\",\n \"zipCode\": \"2300\",\n \"invoiceFormat\": \"Email\",\n \"gln\": \"0799439112768\",\n \"invoiceEmail\": \"john.smith@email.com\",\n \"vatNumber\": \"87687766\",\n \"address2\": \"Apt. 4B\"\n },\n \"financialSetup\": {\n \"language\": \"EN\",\n \"currency\": \"EUR\"\n },\n \"billingSettings\": {\n \"companyCarReimbursementMethod\": \"MANUAL\",\n \"cpmsRevenueSharingRate\": 0.15,\n \"cpmsRevenueSharingCurrency\": \"EUR\",\n \"cpmsRevenueSharingEnabled\": true\n },\n \"receiptSettings\": {\n \"customText\": \"<string>\"\n },\n \"isTaxableDealer\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.spirii.com/v2/customers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"John Smith\",\n \"country\": \"DK\",\n \"contactDetails\": {\n \"name\": \"John Smith\",\n \"email\": \"john.smith@email.com\",\n \"phone\": \"+11 22 33 44\"\n },\n \"ownerId\": 234,\n \"externalId\": \"CU-12345\",\n \"payoutInformation\": {\n \"iban\": \"DK5000400440116243\",\n \"swiftCode\": \"ROYCCAT2XXX\",\n \"bankAccountHolderName\": \"John Smith\",\n \"bankRegistrationNumber\": \"1234\",\n \"bankAccount\": \"1234567890\"\n },\n \"billingDetails\": {\n \"address\": \"Street Avenue, 123\",\n \"city\": \"Copenhagen\",\n \"zipCode\": \"2300\",\n \"invoiceFormat\": \"Email\",\n \"gln\": \"0799439112768\",\n \"invoiceEmail\": \"john.smith@email.com\",\n \"vatNumber\": \"87687766\",\n \"address2\": \"Apt. 4B\"\n },\n \"financialSetup\": {\n \"language\": \"EN\",\n \"currency\": \"EUR\"\n },\n \"billingSettings\": {\n \"companyCarReimbursementMethod\": \"MANUAL\",\n \"cpmsRevenueSharingRate\": 0.15,\n \"cpmsRevenueSharingCurrency\": \"EUR\",\n \"cpmsRevenueSharingEnabled\": true\n },\n \"receiptSettings\": {\n \"customText\": \"<string>\"\n },\n \"isTaxableDealer\": false\n}"
response = http.request(request)
puts response.read_body{
"name": "John Smith",
"contactDetails": {
"name": "John Smith",
"email": "john.smith@email.com",
"phone": "+11 22 33 44"
},
"billingDetails": {
"paymentMethod": "Invoice",
"invoiceFormat": "Email",
"gln": "0799439112768",
"invoiceEmail": "john.smith@email.com",
"vatNumber": "87687766",
"address": "Street Avenue, 123",
"address2": "Apt. 4B",
"city": "Copenhagen",
"zipCode": "2300"
},
"id": 123,
"type": "Private",
"cpo": {
"id": 123,
"name": "Charge Point Operator Inc."
},
"locations": [
1,
2,
3
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"externalId": "CU-12345",
"country": "DK",
"payoutInformation": {
"iban": "DK5000400440116243",
"swiftCode": "ROYCCAT2XXX",
"bankAccountHolderName": "John Smith",
"bankRegistrationNumber": "1234",
"bankAccount": "1234567890"
},
"financialSetup": {
"language": "EN",
"currency": "EUR",
"paymentTerms": "2 Days"
},
"billingSettings": {
"companyCarReimbursementMethod": "MANUAL",
"companyCarKYCStatus": "InProgress",
"chargeKeyDocumentAggregation": "customer",
"chargeKeyLineAggregation": "key_and_location",
"cpmsRevenueSharingUnit": "currency",
"cpmsRevenueSharingRate": 0.15,
"cpmsRevenueSharingCurrency": "EUR",
"cpmsRevenueSharingEnabled": true
},
"receiptSettings": {
"customText": "<string>"
},
"isTaxableDealer": false,
"owner": {
"id": 234,
"name": "Company Inc."
}
}Create a new customer
Creates a new customer record in the system.
POST
/
v2
/
customers
Create a new customer
curl --request POST \
--url https://api.spirii.com/v2/customers \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "John Smith",
"country": "DK",
"contactDetails": {
"name": "John Smith",
"email": "john.smith@email.com",
"phone": "+11 22 33 44"
},
"ownerId": 234,
"externalId": "CU-12345",
"payoutInformation": {
"iban": "DK5000400440116243",
"swiftCode": "ROYCCAT2XXX",
"bankAccountHolderName": "John Smith",
"bankRegistrationNumber": "1234",
"bankAccount": "1234567890"
},
"billingDetails": {
"address": "Street Avenue, 123",
"city": "Copenhagen",
"zipCode": "2300",
"invoiceFormat": "Email",
"gln": "0799439112768",
"invoiceEmail": "john.smith@email.com",
"vatNumber": "87687766",
"address2": "Apt. 4B"
},
"financialSetup": {
"language": "EN",
"currency": "EUR"
},
"billingSettings": {
"companyCarReimbursementMethod": "MANUAL",
"cpmsRevenueSharingRate": 0.15,
"cpmsRevenueSharingCurrency": "EUR",
"cpmsRevenueSharingEnabled": true
},
"receiptSettings": {
"customText": "<string>"
},
"isTaxableDealer": false
}
'import requests
url = "https://api.spirii.com/v2/customers"
payload = {
"name": "John Smith",
"country": "DK",
"contactDetails": {
"name": "John Smith",
"email": "john.smith@email.com",
"phone": "+11 22 33 44"
},
"ownerId": 234,
"externalId": "CU-12345",
"payoutInformation": {
"iban": "DK5000400440116243",
"swiftCode": "ROYCCAT2XXX",
"bankAccountHolderName": "John Smith",
"bankRegistrationNumber": "1234",
"bankAccount": "1234567890"
},
"billingDetails": {
"address": "Street Avenue, 123",
"city": "Copenhagen",
"zipCode": "2300",
"invoiceFormat": "Email",
"gln": "0799439112768",
"invoiceEmail": "john.smith@email.com",
"vatNumber": "87687766",
"address2": "Apt. 4B"
},
"financialSetup": {
"language": "EN",
"currency": "EUR"
},
"billingSettings": {
"companyCarReimbursementMethod": "MANUAL",
"cpmsRevenueSharingRate": 0.15,
"cpmsRevenueSharingCurrency": "EUR",
"cpmsRevenueSharingEnabled": True
},
"receiptSettings": { "customText": "<string>" },
"isTaxableDealer": False
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'John Smith',
country: 'DK',
contactDetails: {name: 'John Smith', email: 'john.smith@email.com', phone: '+11 22 33 44'},
ownerId: 234,
externalId: 'CU-12345',
payoutInformation: {
iban: 'DK5000400440116243',
swiftCode: 'ROYCCAT2XXX',
bankAccountHolderName: 'John Smith',
bankRegistrationNumber: '1234',
bankAccount: '1234567890'
},
billingDetails: {
address: 'Street Avenue, 123',
city: 'Copenhagen',
zipCode: '2300',
invoiceFormat: 'Email',
gln: '0799439112768',
invoiceEmail: 'john.smith@email.com',
vatNumber: '87687766',
address2: 'Apt. 4B'
},
financialSetup: {language: 'EN', currency: 'EUR'},
billingSettings: {
companyCarReimbursementMethod: 'MANUAL',
cpmsRevenueSharingRate: 0.15,
cpmsRevenueSharingCurrency: 'EUR',
cpmsRevenueSharingEnabled: true
},
receiptSettings: {customText: '<string>'},
isTaxableDealer: false
})
};
fetch('https://api.spirii.com/v2/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.spirii.com/v2/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' => 'John Smith',
'country' => 'DK',
'contactDetails' => [
'name' => 'John Smith',
'email' => 'john.smith@email.com',
'phone' => '+11 22 33 44'
],
'ownerId' => 234,
'externalId' => 'CU-12345',
'payoutInformation' => [
'iban' => 'DK5000400440116243',
'swiftCode' => 'ROYCCAT2XXX',
'bankAccountHolderName' => 'John Smith',
'bankRegistrationNumber' => '1234',
'bankAccount' => '1234567890'
],
'billingDetails' => [
'address' => 'Street Avenue, 123',
'city' => 'Copenhagen',
'zipCode' => '2300',
'invoiceFormat' => 'Email',
'gln' => '0799439112768',
'invoiceEmail' => 'john.smith@email.com',
'vatNumber' => '87687766',
'address2' => 'Apt. 4B'
],
'financialSetup' => [
'language' => 'EN',
'currency' => 'EUR'
],
'billingSettings' => [
'companyCarReimbursementMethod' => 'MANUAL',
'cpmsRevenueSharingRate' => 0.15,
'cpmsRevenueSharingCurrency' => 'EUR',
'cpmsRevenueSharingEnabled' => true
],
'receiptSettings' => [
'customText' => '<string>'
],
'isTaxableDealer' => false
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"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://api.spirii.com/v2/customers"
payload := strings.NewReader("{\n \"name\": \"John Smith\",\n \"country\": \"DK\",\n \"contactDetails\": {\n \"name\": \"John Smith\",\n \"email\": \"john.smith@email.com\",\n \"phone\": \"+11 22 33 44\"\n },\n \"ownerId\": 234,\n \"externalId\": \"CU-12345\",\n \"payoutInformation\": {\n \"iban\": \"DK5000400440116243\",\n \"swiftCode\": \"ROYCCAT2XXX\",\n \"bankAccountHolderName\": \"John Smith\",\n \"bankRegistrationNumber\": \"1234\",\n \"bankAccount\": \"1234567890\"\n },\n \"billingDetails\": {\n \"address\": \"Street Avenue, 123\",\n \"city\": \"Copenhagen\",\n \"zipCode\": \"2300\",\n \"invoiceFormat\": \"Email\",\n \"gln\": \"0799439112768\",\n \"invoiceEmail\": \"john.smith@email.com\",\n \"vatNumber\": \"87687766\",\n \"address2\": \"Apt. 4B\"\n },\n \"financialSetup\": {\n \"language\": \"EN\",\n \"currency\": \"EUR\"\n },\n \"billingSettings\": {\n \"companyCarReimbursementMethod\": \"MANUAL\",\n \"cpmsRevenueSharingRate\": 0.15,\n \"cpmsRevenueSharingCurrency\": \"EUR\",\n \"cpmsRevenueSharingEnabled\": true\n },\n \"receiptSettings\": {\n \"customText\": \"<string>\"\n },\n \"isTaxableDealer\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<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.spirii.com/v2/customers")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"John Smith\",\n \"country\": \"DK\",\n \"contactDetails\": {\n \"name\": \"John Smith\",\n \"email\": \"john.smith@email.com\",\n \"phone\": \"+11 22 33 44\"\n },\n \"ownerId\": 234,\n \"externalId\": \"CU-12345\",\n \"payoutInformation\": {\n \"iban\": \"DK5000400440116243\",\n \"swiftCode\": \"ROYCCAT2XXX\",\n \"bankAccountHolderName\": \"John Smith\",\n \"bankRegistrationNumber\": \"1234\",\n \"bankAccount\": \"1234567890\"\n },\n \"billingDetails\": {\n \"address\": \"Street Avenue, 123\",\n \"city\": \"Copenhagen\",\n \"zipCode\": \"2300\",\n \"invoiceFormat\": \"Email\",\n \"gln\": \"0799439112768\",\n \"invoiceEmail\": \"john.smith@email.com\",\n \"vatNumber\": \"87687766\",\n \"address2\": \"Apt. 4B\"\n },\n \"financialSetup\": {\n \"language\": \"EN\",\n \"currency\": \"EUR\"\n },\n \"billingSettings\": {\n \"companyCarReimbursementMethod\": \"MANUAL\",\n \"cpmsRevenueSharingRate\": 0.15,\n \"cpmsRevenueSharingCurrency\": \"EUR\",\n \"cpmsRevenueSharingEnabled\": true\n },\n \"receiptSettings\": {\n \"customText\": \"<string>\"\n },\n \"isTaxableDealer\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.spirii.com/v2/customers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"John Smith\",\n \"country\": \"DK\",\n \"contactDetails\": {\n \"name\": \"John Smith\",\n \"email\": \"john.smith@email.com\",\n \"phone\": \"+11 22 33 44\"\n },\n \"ownerId\": 234,\n \"externalId\": \"CU-12345\",\n \"payoutInformation\": {\n \"iban\": \"DK5000400440116243\",\n \"swiftCode\": \"ROYCCAT2XXX\",\n \"bankAccountHolderName\": \"John Smith\",\n \"bankRegistrationNumber\": \"1234\",\n \"bankAccount\": \"1234567890\"\n },\n \"billingDetails\": {\n \"address\": \"Street Avenue, 123\",\n \"city\": \"Copenhagen\",\n \"zipCode\": \"2300\",\n \"invoiceFormat\": \"Email\",\n \"gln\": \"0799439112768\",\n \"invoiceEmail\": \"john.smith@email.com\",\n \"vatNumber\": \"87687766\",\n \"address2\": \"Apt. 4B\"\n },\n \"financialSetup\": {\n \"language\": \"EN\",\n \"currency\": \"EUR\"\n },\n \"billingSettings\": {\n \"companyCarReimbursementMethod\": \"MANUAL\",\n \"cpmsRevenueSharingRate\": 0.15,\n \"cpmsRevenueSharingCurrency\": \"EUR\",\n \"cpmsRevenueSharingEnabled\": true\n },\n \"receiptSettings\": {\n \"customText\": \"<string>\"\n },\n \"isTaxableDealer\": false\n}"
response = http.request(request)
puts response.read_body{
"name": "John Smith",
"contactDetails": {
"name": "John Smith",
"email": "john.smith@email.com",
"phone": "+11 22 33 44"
},
"billingDetails": {
"paymentMethod": "Invoice",
"invoiceFormat": "Email",
"gln": "0799439112768",
"invoiceEmail": "john.smith@email.com",
"vatNumber": "87687766",
"address": "Street Avenue, 123",
"address2": "Apt. 4B",
"city": "Copenhagen",
"zipCode": "2300"
},
"id": 123,
"type": "Private",
"cpo": {
"id": 123,
"name": "Charge Point Operator Inc."
},
"locations": [
1,
2,
3
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"externalId": "CU-12345",
"country": "DK",
"payoutInformation": {
"iban": "DK5000400440116243",
"swiftCode": "ROYCCAT2XXX",
"bankAccountHolderName": "John Smith",
"bankRegistrationNumber": "1234",
"bankAccount": "1234567890"
},
"financialSetup": {
"language": "EN",
"currency": "EUR",
"paymentTerms": "2 Days"
},
"billingSettings": {
"companyCarReimbursementMethod": "MANUAL",
"companyCarKYCStatus": "InProgress",
"chargeKeyDocumentAggregation": "customer",
"chargeKeyLineAggregation": "key_and_location",
"cpmsRevenueSharingUnit": "currency",
"cpmsRevenueSharingRate": 0.15,
"cpmsRevenueSharingCurrency": "EUR",
"cpmsRevenueSharingEnabled": true
},
"receiptSettings": {
"customText": "<string>"
},
"isTaxableDealer": false,
"owner": {
"id": 234,
"name": "Company Inc."
}
}Authorizations
Authorization: Bearer <SPIRII_API_KEY>
Body
application/json
The customer to be created.
The complete name of the customer.
Maximum string length:
80Example:
"John Smith"
The country of the billing address.
Required string length:
2Example:
"DK"
The contact details of the person who can be contacted regarding any concerns about this customer.
Show child attributes
Show child attributes
The unique identifier of the owner also known as the parent customer.
Example:
234
The type of customer. You can create private, business or CPOSubsidiary customers.
Available options:
Private, Business, CPOSubsidiary The string identifier of the customer from the external system.
Maximum string length:
40Example:
"CU-12345"
The payout information of the customer. It's important to pass this information if you use Spirii financial services. This ensures correct invoicing.
Show child attributes
Show child attributes
The billing details of the customer. It's important to pass this information if you use Spirii financial services.
Show child attributes
Show child attributes
This financial setup ensures the customer receives accurate invoices in the correct language and currency, and on time.
Show child attributes
Show child attributes
The billing settings of the customer.
Show child attributes
Show child attributes
The receipt settings of the customer.
Show child attributes
Show child attributes
Whether the customer is registered as a taxable dealer. Used for tax handling. Manageable by Spirii admins only.
Example:
false
Response
The complete name of the customer.
Maximum string length:
80Example:
"John Smith"
The contact details of the person who can be contacted regarding any concerns about this customer.
Show child attributes
Show child attributes
The billing details of the customer. It's important to pass this information if you use Spirii financial services.
Show child attributes
Show child attributes
The unique identifier of the customer.
Example:
123
The type of customer. You can create private and business customers.
Available options:
Private, Business, CPO, CPOSubsidiary The CPO of the customer.
Show child attributes
Show child attributes
The location IDs associated with the customer.
Example:
[1, 2, 3]
The creation date of the customer.
The last update date of the customer.
This field can be used as a reference to your own system, e.g. an internal customer number.
Maximum string length:
40Example:
"CU-12345"
The country of the billing address.
Required string length:
2Example:
"DK"
The payout information of the customer. It's important to pass this information if you use Spirii financial services. This ensures correct invoicing.
Show child attributes
Show child attributes
This financial setup ensures the customer receives accurate invoices in the correct language and currency, and on time.
Show child attributes
Show child attributes
The billing settings of the customer.
Show child attributes
Show child attributes
The receipt settings of the customer.
Show child attributes
Show child attributes
Whether the customer is registered as a taxable dealer. Used for tax handling. Manageable by Spirii admins only.
Example:
false
The owner of the customer.
Show child attributes
Show child attributes
Was this page helpful?