Add/modify contractor
curl --request POST \
--url https://api.altera.co/company/contractors \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"contractorId": 4527,
"contractorRegion": "POLAND",
"country": "PL",
"contractorType": "COMPANY",
"contractorName": "Apple Computer, Inc.",
"street": "Rejsi Manor",
"houseNumber": "465",
"flatNumber": "42",
"city": "Menahga",
"postCode": "58-261",
"taxIdentificationNumber": "8958666780",
"email": "spend@different.com",
"areaNumber": "",
"phoneNumber": "337507196"
}
'import requests
url = "https://api.altera.co/company/contractors"
payload = {
"contractorId": 4527,
"contractorRegion": "POLAND",
"country": "PL",
"contractorType": "COMPANY",
"contractorName": "Apple Computer, Inc.",
"street": "Rejsi Manor",
"houseNumber": "465",
"flatNumber": "42",
"city": "Menahga",
"postCode": "58-261",
"taxIdentificationNumber": "8958666780",
"email": "spend@different.com",
"areaNumber": "",
"phoneNumber": "337507196"
}
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({
contractorId: 4527,
contractorRegion: 'POLAND',
country: 'PL',
contractorType: 'COMPANY',
contractorName: 'Apple Computer, Inc.',
street: 'Rejsi Manor',
houseNumber: '465',
flatNumber: '42',
city: 'Menahga',
postCode: '58-261',
taxIdentificationNumber: '8958666780',
email: 'spend@different.com',
areaNumber: '',
phoneNumber: '337507196'
})
};
fetch('https://api.altera.co/company/contractors', 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.altera.co/company/contractors",
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([
'contractorId' => 4527,
'contractorRegion' => 'POLAND',
'country' => 'PL',
'contractorType' => 'COMPANY',
'contractorName' => 'Apple Computer, Inc.',
'street' => 'Rejsi Manor',
'houseNumber' => '465',
'flatNumber' => '42',
'city' => 'Menahga',
'postCode' => '58-261',
'taxIdentificationNumber' => '8958666780',
'email' => 'spend@different.com',
'areaNumber' => '',
'phoneNumber' => '337507196'
]),
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.altera.co/company/contractors"
payload := strings.NewReader("{\n \"contractorId\": 4527,\n \"contractorRegion\": \"POLAND\",\n \"country\": \"PL\",\n \"contractorType\": \"COMPANY\",\n \"contractorName\": \"Apple Computer, Inc.\",\n \"street\": \"Rejsi Manor\",\n \"houseNumber\": \"465\",\n \"flatNumber\": \"42\",\n \"city\": \"Menahga\",\n \"postCode\": \"58-261\",\n \"taxIdentificationNumber\": \"8958666780\",\n \"email\": \"spend@different.com\",\n \"areaNumber\": \"\",\n \"phoneNumber\": \"337507196\"\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.altera.co/company/contractors")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"contractorId\": 4527,\n \"contractorRegion\": \"POLAND\",\n \"country\": \"PL\",\n \"contractorType\": \"COMPANY\",\n \"contractorName\": \"Apple Computer, Inc.\",\n \"street\": \"Rejsi Manor\",\n \"houseNumber\": \"465\",\n \"flatNumber\": \"42\",\n \"city\": \"Menahga\",\n \"postCode\": \"58-261\",\n \"taxIdentificationNumber\": \"8958666780\",\n \"email\": \"spend@different.com\",\n \"areaNumber\": \"\",\n \"phoneNumber\": \"337507196\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.altera.co/company/contractors")
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 \"contractorId\": 4527,\n \"contractorRegion\": \"POLAND\",\n \"country\": \"PL\",\n \"contractorType\": \"COMPANY\",\n \"contractorName\": \"Apple Computer, Inc.\",\n \"street\": \"Rejsi Manor\",\n \"houseNumber\": \"465\",\n \"flatNumber\": \"42\",\n \"city\": \"Menahga\",\n \"postCode\": \"58-261\",\n \"taxIdentificationNumber\": \"8958666780\",\n \"email\": \"spend@different.com\",\n \"areaNumber\": \"\",\n \"phoneNumber\": \"337507196\"\n}"
response = http.request(request)
puts response.read_body{
"result": "OK",
"data": {
"contractorId": 4527
}
}Configuration
Add/modify contractor
This endpoint provides the means for adding/updating contractor data for later use in the system
POST
/
company
/
contractors
Add/modify contractor
curl --request POST \
--url https://api.altera.co/company/contractors \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"contractorId": 4527,
"contractorRegion": "POLAND",
"country": "PL",
"contractorType": "COMPANY",
"contractorName": "Apple Computer, Inc.",
"street": "Rejsi Manor",
"houseNumber": "465",
"flatNumber": "42",
"city": "Menahga",
"postCode": "58-261",
"taxIdentificationNumber": "8958666780",
"email": "spend@different.com",
"areaNumber": "",
"phoneNumber": "337507196"
}
'import requests
url = "https://api.altera.co/company/contractors"
payload = {
"contractorId": 4527,
"contractorRegion": "POLAND",
"country": "PL",
"contractorType": "COMPANY",
"contractorName": "Apple Computer, Inc.",
"street": "Rejsi Manor",
"houseNumber": "465",
"flatNumber": "42",
"city": "Menahga",
"postCode": "58-261",
"taxIdentificationNumber": "8958666780",
"email": "spend@different.com",
"areaNumber": "",
"phoneNumber": "337507196"
}
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({
contractorId: 4527,
contractorRegion: 'POLAND',
country: 'PL',
contractorType: 'COMPANY',
contractorName: 'Apple Computer, Inc.',
street: 'Rejsi Manor',
houseNumber: '465',
flatNumber: '42',
city: 'Menahga',
postCode: '58-261',
taxIdentificationNumber: '8958666780',
email: 'spend@different.com',
areaNumber: '',
phoneNumber: '337507196'
})
};
fetch('https://api.altera.co/company/contractors', 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.altera.co/company/contractors",
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([
'contractorId' => 4527,
'contractorRegion' => 'POLAND',
'country' => 'PL',
'contractorType' => 'COMPANY',
'contractorName' => 'Apple Computer, Inc.',
'street' => 'Rejsi Manor',
'houseNumber' => '465',
'flatNumber' => '42',
'city' => 'Menahga',
'postCode' => '58-261',
'taxIdentificationNumber' => '8958666780',
'email' => 'spend@different.com',
'areaNumber' => '',
'phoneNumber' => '337507196'
]),
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.altera.co/company/contractors"
payload := strings.NewReader("{\n \"contractorId\": 4527,\n \"contractorRegion\": \"POLAND\",\n \"country\": \"PL\",\n \"contractorType\": \"COMPANY\",\n \"contractorName\": \"Apple Computer, Inc.\",\n \"street\": \"Rejsi Manor\",\n \"houseNumber\": \"465\",\n \"flatNumber\": \"42\",\n \"city\": \"Menahga\",\n \"postCode\": \"58-261\",\n \"taxIdentificationNumber\": \"8958666780\",\n \"email\": \"spend@different.com\",\n \"areaNumber\": \"\",\n \"phoneNumber\": \"337507196\"\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.altera.co/company/contractors")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"contractorId\": 4527,\n \"contractorRegion\": \"POLAND\",\n \"country\": \"PL\",\n \"contractorType\": \"COMPANY\",\n \"contractorName\": \"Apple Computer, Inc.\",\n \"street\": \"Rejsi Manor\",\n \"houseNumber\": \"465\",\n \"flatNumber\": \"42\",\n \"city\": \"Menahga\",\n \"postCode\": \"58-261\",\n \"taxIdentificationNumber\": \"8958666780\",\n \"email\": \"spend@different.com\",\n \"areaNumber\": \"\",\n \"phoneNumber\": \"337507196\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.altera.co/company/contractors")
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 \"contractorId\": 4527,\n \"contractorRegion\": \"POLAND\",\n \"country\": \"PL\",\n \"contractorType\": \"COMPANY\",\n \"contractorName\": \"Apple Computer, Inc.\",\n \"street\": \"Rejsi Manor\",\n \"houseNumber\": \"465\",\n \"flatNumber\": \"42\",\n \"city\": \"Menahga\",\n \"postCode\": \"58-261\",\n \"taxIdentificationNumber\": \"8958666780\",\n \"email\": \"spend@different.com\",\n \"areaNumber\": \"\",\n \"phoneNumber\": \"337507196\"\n}"
response = http.request(request)
puts response.read_body{
"result": "OK",
"data": {
"contractorId": 4527
}
}Authorizations
OpenApi Key created within Altera.app for a certain company
Body
application/json
Available options:
POLAND, EU, OUTSIDE_OF_EU Example:
"POLAND"
Two letter country code according to ISO 3166-1 alfa-2
Available options:
COMPANY, PRIVATE_PERSON Example:
"PRIVATE_PERSON"
Identifier used if we wish to update an already existing contractor
Was this page helpful?
⌘I

