Skip to main content
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"
}'
{
  "result": "OK",
  "data": {
    "contractorId": 4527
  }
}

Authorizations

Authorization
string
header
required

OpenApi Key created within Altera.app for a certain company

Body

application/json
contractorRegion
enum<string>
required
Available options:
POLAND,
EU,
OUTSIDE_OF_EU
Example:

"POLAND"

country
string
required

Two letter country code according to ISO 3166-1 alfa-2

contractorType
enum<string>
required
Available options:
COMPANY,
PRIVATE_PERSON
Example:

"PRIVATE_PERSON"

contractorName
string
required
contractorId
integer

Identifier used if we wish to update an already existing contractor

street
string
houseNumber
string
flatNumber
string
city
string
postCode
string
taxIdentificationNumber
string
email
string
areaNumber
string
phoneNumber
string

Response

200 - application/json

OK

result
string
default:OK
Example:

"OK"

data
object