curl --request POST \
--url https://api.paytsoftware.com/v1/administrations \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"administration": {
"city": "<string>",
"commercial_registration_number": "<string>",
"contact_name": "<string>",
"country_code": "<string>",
"email_address": "<string>",
"house_number": "<string>",
"name": "<string>",
"postal_code": "<string>",
"street_name": "<string>",
"sender_email_address": "<string>",
"bank_account_bic": "<string>",
"bank_account_name": "<string>",
"bank_account_number": "<string>",
"currency_code": "EUR",
"timezone": "Europe/Amsterdam",
"vat_number": "<string>"
}
}
'import requests
url = "https://api.paytsoftware.com/v1/administrations"
payload = { "administration": {
"city": "<string>",
"commercial_registration_number": "<string>",
"contact_name": "<string>",
"country_code": "<string>",
"email_address": "<string>",
"house_number": "<string>",
"name": "<string>",
"postal_code": "<string>",
"street_name": "<string>",
"sender_email_address": "<string>",
"bank_account_bic": "<string>",
"bank_account_name": "<string>",
"bank_account_number": "<string>",
"currency_code": "EUR",
"timezone": "Europe/Amsterdam",
"vat_number": "<string>"
} }
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({
administration: {
city: '<string>',
commercial_registration_number: '<string>',
contact_name: '<string>',
country_code: '<string>',
email_address: '<string>',
house_number: '<string>',
name: '<string>',
postal_code: '<string>',
street_name: '<string>',
sender_email_address: '<string>',
bank_account_bic: '<string>',
bank_account_name: '<string>',
bank_account_number: '<string>',
currency_code: 'EUR',
timezone: 'Europe/Amsterdam',
vat_number: '<string>'
}
})
};
fetch('https://api.paytsoftware.com/v1/administrations', 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.paytsoftware.com/v1/administrations",
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([
'administration' => [
'city' => '<string>',
'commercial_registration_number' => '<string>',
'contact_name' => '<string>',
'country_code' => '<string>',
'email_address' => '<string>',
'house_number' => '<string>',
'name' => '<string>',
'postal_code' => '<string>',
'street_name' => '<string>',
'sender_email_address' => '<string>',
'bank_account_bic' => '<string>',
'bank_account_name' => '<string>',
'bank_account_number' => '<string>',
'currency_code' => 'EUR',
'timezone' => 'Europe/Amsterdam',
'vat_number' => '<string>'
]
]),
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://api.paytsoftware.com/v1/administrations"
payload := strings.NewReader("{\n \"administration\": {\n \"city\": \"<string>\",\n \"commercial_registration_number\": \"<string>\",\n \"contact_name\": \"<string>\",\n \"country_code\": \"<string>\",\n \"email_address\": \"<string>\",\n \"house_number\": \"<string>\",\n \"name\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"street_name\": \"<string>\",\n \"sender_email_address\": \"<string>\",\n \"bank_account_bic\": \"<string>\",\n \"bank_account_name\": \"<string>\",\n \"bank_account_number\": \"<string>\",\n \"currency_code\": \"EUR\",\n \"timezone\": \"Europe/Amsterdam\",\n \"vat_number\": \"<string>\"\n }\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://api.paytsoftware.com/v1/administrations")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"administration\": {\n \"city\": \"<string>\",\n \"commercial_registration_number\": \"<string>\",\n \"contact_name\": \"<string>\",\n \"country_code\": \"<string>\",\n \"email_address\": \"<string>\",\n \"house_number\": \"<string>\",\n \"name\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"street_name\": \"<string>\",\n \"sender_email_address\": \"<string>\",\n \"bank_account_bic\": \"<string>\",\n \"bank_account_name\": \"<string>\",\n \"bank_account_number\": \"<string>\",\n \"currency_code\": \"EUR\",\n \"timezone\": \"Europe/Amsterdam\",\n \"vat_number\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.paytsoftware.com/v1/administrations")
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 \"administration\": {\n \"city\": \"<string>\",\n \"commercial_registration_number\": \"<string>\",\n \"contact_name\": \"<string>\",\n \"country_code\": \"<string>\",\n \"email_address\": \"<string>\",\n \"house_number\": \"<string>\",\n \"name\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"street_name\": \"<string>\",\n \"sender_email_address\": \"<string>\",\n \"bank_account_bic\": \"<string>\",\n \"bank_account_name\": \"<string>\",\n \"bank_account_number\": \"<string>\",\n \"currency_code\": \"EUR\",\n \"timezone\": \"Europe/Amsterdam\",\n \"vat_number\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"name": "<string>",
"email_address": "<string>",
"contact_name": "<string>",
"commercial_registration_number": "<string>",
"country_code": "<string>",
"city": "<string>",
"house_number": "<string>",
"internal_name": "<string>",
"street_name": "<string>",
"postal_code": "<string>",
"timezone": "<string>",
"currency_code": "<string>",
"administration_url": "<string>",
"bank_account_name": "<string>",
"bank_account_number": "<string>",
"bank_account_bic": "<string>",
"vat_number": "<string>",
"import_origin_identifier": "<string>",
"last_successful_import_at": "2023-11-07T05:31:56Z",
"paused_at": "2023-11-07T05:31:56Z",
"reminding_paused_at": "2023-11-07T05:31:56Z"
}{
"code": "<string>",
"message": "<string>"
}{
"code": "<string>",
"message": "<string>"
}{
"code": "<string>",
"message": "<string>"
}Creates an administration
Creates an administration
curl --request POST \
--url https://api.paytsoftware.com/v1/administrations \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"administration": {
"city": "<string>",
"commercial_registration_number": "<string>",
"contact_name": "<string>",
"country_code": "<string>",
"email_address": "<string>",
"house_number": "<string>",
"name": "<string>",
"postal_code": "<string>",
"street_name": "<string>",
"sender_email_address": "<string>",
"bank_account_bic": "<string>",
"bank_account_name": "<string>",
"bank_account_number": "<string>",
"currency_code": "EUR",
"timezone": "Europe/Amsterdam",
"vat_number": "<string>"
}
}
'import requests
url = "https://api.paytsoftware.com/v1/administrations"
payload = { "administration": {
"city": "<string>",
"commercial_registration_number": "<string>",
"contact_name": "<string>",
"country_code": "<string>",
"email_address": "<string>",
"house_number": "<string>",
"name": "<string>",
"postal_code": "<string>",
"street_name": "<string>",
"sender_email_address": "<string>",
"bank_account_bic": "<string>",
"bank_account_name": "<string>",
"bank_account_number": "<string>",
"currency_code": "EUR",
"timezone": "Europe/Amsterdam",
"vat_number": "<string>"
} }
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({
administration: {
city: '<string>',
commercial_registration_number: '<string>',
contact_name: '<string>',
country_code: '<string>',
email_address: '<string>',
house_number: '<string>',
name: '<string>',
postal_code: '<string>',
street_name: '<string>',
sender_email_address: '<string>',
bank_account_bic: '<string>',
bank_account_name: '<string>',
bank_account_number: '<string>',
currency_code: 'EUR',
timezone: 'Europe/Amsterdam',
vat_number: '<string>'
}
})
};
fetch('https://api.paytsoftware.com/v1/administrations', 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.paytsoftware.com/v1/administrations",
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([
'administration' => [
'city' => '<string>',
'commercial_registration_number' => '<string>',
'contact_name' => '<string>',
'country_code' => '<string>',
'email_address' => '<string>',
'house_number' => '<string>',
'name' => '<string>',
'postal_code' => '<string>',
'street_name' => '<string>',
'sender_email_address' => '<string>',
'bank_account_bic' => '<string>',
'bank_account_name' => '<string>',
'bank_account_number' => '<string>',
'currency_code' => 'EUR',
'timezone' => 'Europe/Amsterdam',
'vat_number' => '<string>'
]
]),
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://api.paytsoftware.com/v1/administrations"
payload := strings.NewReader("{\n \"administration\": {\n \"city\": \"<string>\",\n \"commercial_registration_number\": \"<string>\",\n \"contact_name\": \"<string>\",\n \"country_code\": \"<string>\",\n \"email_address\": \"<string>\",\n \"house_number\": \"<string>\",\n \"name\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"street_name\": \"<string>\",\n \"sender_email_address\": \"<string>\",\n \"bank_account_bic\": \"<string>\",\n \"bank_account_name\": \"<string>\",\n \"bank_account_number\": \"<string>\",\n \"currency_code\": \"EUR\",\n \"timezone\": \"Europe/Amsterdam\",\n \"vat_number\": \"<string>\"\n }\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://api.paytsoftware.com/v1/administrations")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"administration\": {\n \"city\": \"<string>\",\n \"commercial_registration_number\": \"<string>\",\n \"contact_name\": \"<string>\",\n \"country_code\": \"<string>\",\n \"email_address\": \"<string>\",\n \"house_number\": \"<string>\",\n \"name\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"street_name\": \"<string>\",\n \"sender_email_address\": \"<string>\",\n \"bank_account_bic\": \"<string>\",\n \"bank_account_name\": \"<string>\",\n \"bank_account_number\": \"<string>\",\n \"currency_code\": \"EUR\",\n \"timezone\": \"Europe/Amsterdam\",\n \"vat_number\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.paytsoftware.com/v1/administrations")
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 \"administration\": {\n \"city\": \"<string>\",\n \"commercial_registration_number\": \"<string>\",\n \"contact_name\": \"<string>\",\n \"country_code\": \"<string>\",\n \"email_address\": \"<string>\",\n \"house_number\": \"<string>\",\n \"name\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"street_name\": \"<string>\",\n \"sender_email_address\": \"<string>\",\n \"bank_account_bic\": \"<string>\",\n \"bank_account_name\": \"<string>\",\n \"bank_account_number\": \"<string>\",\n \"currency_code\": \"EUR\",\n \"timezone\": \"Europe/Amsterdam\",\n \"vat_number\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"name": "<string>",
"email_address": "<string>",
"contact_name": "<string>",
"commercial_registration_number": "<string>",
"country_code": "<string>",
"city": "<string>",
"house_number": "<string>",
"internal_name": "<string>",
"street_name": "<string>",
"postal_code": "<string>",
"timezone": "<string>",
"currency_code": "<string>",
"administration_url": "<string>",
"bank_account_name": "<string>",
"bank_account_number": "<string>",
"bank_account_bic": "<string>",
"vat_number": "<string>",
"import_origin_identifier": "<string>",
"last_successful_import_at": "2023-11-07T05:31:56Z",
"paused_at": "2023-11-07T05:31:56Z",
"reminding_paused_at": "2023-11-07T05:31:56Z"
}{
"code": "<string>",
"message": "<string>"
}{
"code": "<string>",
"message": "<string>"
}{
"code": "<string>",
"message": "<string>"
}Authorizations
OAuth2 access token or static API token. See Authorization for how to obtain one.
Body
Response
Administration created
CustomerApi_V1_AdministrationEntity model
Unique identifier
Name
Status
active, inactive, deleted, implementation Email address of the administration
The name of the contact person for this administration
Offical national commercial registration number
ISO 3166 Alpha-2 country code, Part of the administration address
Part of the administration address
Part of the administration address
Internal name
Part of the administration address
Part of the administration address
Timezone in which the administration primarily operates, canonical tz name
The accounting or reporting currency, ISO 4217
The url to the administration in the Payt interface
Name of the bank account holder
Number of the bank account
BIC of the bank
VAT number of the administration
The identifier which is used for importing from origin (request with the 'fields' parameter)
Timestamp of the last successful import (request with the 'fields' parameter)
Timestamp at which the administration was paused
Timestamp at which sending reminders for the administration was paused
Was this page helpful?