Subsidiaries
Subsidiaries API
Create a new subsidiary
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
curl -X POST "http://localhost:18080/api/v1/subsidiaries" \ -H "Content-Type: application/json" \ -d '{ "id": "string", "isRoot": true, "name": "string", "subsidiaries": [ "string" ] }'{
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"billingInfo": {
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"bank": "string",
"bic": "string",
"cocNumber": "string",
"contacts": [
{
"department": "string",
"email": "string",
"firstName": "string",
"id": "string",
"lastName": "string",
"phone": "string"
}
],
"email": "string",
"iban": "string",
"phone": "string",
"type": "COMPANY",
"vatNumber": "string"
},
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"id": "string",
"isRoot": true,
"name": "string",
"parentId": "string",
"phone": "string",
"root": true,
"subsidiaries": [
{
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"billingInfo": {
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"bank": "string",
"bic": "string",
"cocNumber": "string",
"contacts": [
{
"department": "string",
"email": "string",
"firstName": "string",
"id": "string",
"lastName": "string",
"phone": "string"
}
],
"email": "string",
"iban": "string",
"phone": "string",
"type": "COMPANY",
"vatNumber": "string"
},
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"id": "string",
"isRoot": true,
"name": "string",
"parentId": "string",
"phone": "string",
"root": true,
"subsidiaries": [],
"tenantId": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string"
}
],
"tenantId": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Delete by list of ids in current tenant
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
curl -X DELETE "http://localhost:18080/api/v1/subsidiaries" \ -H "Content-Type: application/json" \ -d '[ "string" ]'{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Backfill parentId field for existing subsidiaries (admin only)
In: header
Response Body
application/json
application/json
application/json
application/json
curl -X POST "http://localhost:18080/api/v1/subsidiaries/backfill-parent-ids"{
"property1": 0,
"property2": 0
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Find by list of ids in current tenant
In: header
Query Parameters
Response Body
application/json
application/json
application/json
application/json
curl -X GET "http://localhost:18080/api/v1/subsidiaries/find?ids=string"[
{
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"billingInfo": {
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"bank": "string",
"bic": "string",
"cocNumber": "string",
"contacts": [
{
"department": "string",
"email": "string",
"firstName": "string",
"id": "string",
"lastName": "string",
"phone": "string"
}
],
"email": "string",
"iban": "string",
"phone": "string",
"type": "COMPANY",
"vatNumber": "string"
},
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"id": "string",
"isRoot": true,
"name": "string",
"parentId": "string",
"phone": "string",
"root": true,
"subsidiaries": [
{}
],
"tenantId": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string"
}
]{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Find all for current tenant
In: header
Response Body
application/json
application/json
application/json
application/json
curl -X GET "http://localhost:18080/api/v1/subsidiaries/find-all"[
{
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"billingInfo": {
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"bank": "string",
"bic": "string",
"cocNumber": "string",
"contacts": [
{
"department": "string",
"email": "string",
"firstName": "string",
"id": "string",
"lastName": "string",
"phone": "string"
}
],
"email": "string",
"iban": "string",
"phone": "string",
"type": "COMPANY",
"vatNumber": "string"
},
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"id": "string",
"isRoot": true,
"name": "string",
"parentId": "string",
"phone": "string",
"root": true,
"subsidiaries": [
{}
],
"tenantId": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string"
}
]{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Find by id in current tenant
In: header
Path Parameters
Response Body
application/json
application/json
application/json
application/json
curl -X GET "http://localhost:18080/api/v1/subsidiaries/find/string"{
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"billingInfo": {
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"bank": "string",
"bic": "string",
"cocNumber": "string",
"contacts": [
{
"department": "string",
"email": "string",
"firstName": "string",
"id": "string",
"lastName": "string",
"phone": "string"
}
],
"email": "string",
"iban": "string",
"phone": "string",
"type": "COMPANY",
"vatNumber": "string"
},
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"id": "string",
"isRoot": true,
"name": "string",
"parentId": "string",
"phone": "string",
"root": true,
"subsidiaries": [
{
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"billingInfo": {
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"bank": "string",
"bic": "string",
"cocNumber": "string",
"contacts": [
{
"department": "string",
"email": "string",
"firstName": "string",
"id": "string",
"lastName": "string",
"phone": "string"
}
],
"email": "string",
"iban": "string",
"phone": "string",
"type": "COMPANY",
"vatNumber": "string"
},
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"id": "string",
"isRoot": true,
"name": "string",
"parentId": "string",
"phone": "string",
"root": true,
"subsidiaries": [],
"tenantId": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string"
}
],
"tenantId": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Find nearest subsidiary by coordinates
In: header
Query Parameters
doubledoubleResponse Body
application/json
application/json
application/json
application/json
curl -X GET "http://localhost:18080/api/v1/subsidiaries/nearest?lat=0.1&lon=0.1"{
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"billingInfo": {
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"bank": "string",
"bic": "string",
"cocNumber": "string",
"contacts": [
{
"department": "string",
"email": "string",
"firstName": "string",
"id": "string",
"lastName": "string",
"phone": "string"
}
],
"email": "string",
"iban": "string",
"phone": "string",
"type": "COMPANY",
"vatNumber": "string"
},
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"id": "string",
"isRoot": true,
"name": "string",
"parentId": "string",
"phone": "string",
"root": true,
"subsidiaries": [
{
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"billingInfo": {
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"bank": "string",
"bic": "string",
"cocNumber": "string",
"contacts": [
{
"department": "string",
"email": "string",
"firstName": "string",
"id": "string",
"lastName": "string",
"phone": "string"
}
],
"email": "string",
"iban": "string",
"phone": "string",
"type": "COMPANY",
"vatNumber": "string"
},
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"id": "string",
"isRoot": true,
"name": "string",
"parentId": "string",
"phone": "string",
"root": true,
"subsidiaries": [],
"tenantId": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string"
}
],
"tenantId": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Get page by page number and size with optional sorting based on field to sortBy and direction
In: header
Query Parameters
int32int32"ASC" | "DESC"Response Body
application/json
application/json
application/json
application/json
curl -X GET "http://localhost:18080/api/v1/subsidiaries/page"{
"content": [
{
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"billingInfo": {
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"bank": "string",
"bic": "string",
"cocNumber": "string",
"contacts": [
{
"department": "string",
"email": "string",
"firstName": "string",
"id": "string",
"lastName": "string",
"phone": "string"
}
],
"email": "string",
"iban": "string",
"phone": "string",
"type": "COMPANY",
"vatNumber": "string"
},
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"id": "string",
"isRoot": true,
"name": "string",
"parentId": "string",
"phone": "string",
"root": true,
"subsidiaries": [
{}
],
"tenantId": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string"
}
],
"empty": true,
"first": true,
"last": true,
"number": 0,
"numberOfElements": 0,
"pageable": {
"offset": 0,
"pageNumber": 0,
"pageSize": 0,
"paged": true,
"sort": {
"empty": true,
"sorted": true,
"unsorted": true
},
"unpaged": true
},
"size": 0,
"sort": {
"empty": true,
"sorted": true,
"unsorted": true
},
"totalElements": 0,
"totalPages": 0
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Get root subsidiary
In: header
Response Body
application/json
application/json
application/json
application/json
curl -X GET "http://localhost:18080/api/v1/subsidiaries/root"{
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"billingInfo": {
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"bank": "string",
"bic": "string",
"cocNumber": "string",
"contacts": [
{
"department": "string",
"email": "string",
"firstName": "string",
"id": "string",
"lastName": "string",
"phone": "string"
}
],
"email": "string",
"iban": "string",
"phone": "string",
"type": "COMPANY",
"vatNumber": "string"
},
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"id": "string",
"isRoot": true,
"name": "string",
"parentId": "string",
"phone": "string",
"root": true,
"subsidiaries": [
{
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"billingInfo": {
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"bank": "string",
"bic": "string",
"cocNumber": "string",
"contacts": [
{
"department": "string",
"email": "string",
"firstName": "string",
"id": "string",
"lastName": "string",
"phone": "string"
}
],
"email": "string",
"iban": "string",
"phone": "string",
"type": "COMPANY",
"vatNumber": "string"
},
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"id": "string",
"isRoot": true,
"name": "string",
"parentId": "string",
"phone": "string",
"root": true,
"subsidiaries": [],
"tenantId": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string"
}
],
"tenantId": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Delete by id in current tenant
In: header
Path Parameters
Response Body
application/json
application/json
application/json
curl -X DELETE "http://localhost:18080/api/v1/subsidiaries/string"{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Update a subsidiary
In: header
Path Parameters
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
curl -X PUT "http://localhost:18080/api/v1/subsidiaries/string" \ -H "Content-Type: application/json" \ -d '{ "id": "string", "isRoot": true, "name": "string", "subsidiaries": [ "string" ] }'{
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"billingInfo": {
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"bank": "string",
"bic": "string",
"cocNumber": "string",
"contacts": [
{
"department": "string",
"email": "string",
"firstName": "string",
"id": "string",
"lastName": "string",
"phone": "string"
}
],
"email": "string",
"iban": "string",
"phone": "string",
"type": "COMPANY",
"vatNumber": "string"
},
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"id": "string",
"isRoot": true,
"name": "string",
"parentId": "string",
"phone": "string",
"root": true,
"subsidiaries": [
{
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"billingInfo": {
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"bank": "string",
"bic": "string",
"cocNumber": "string",
"contacts": [
{
"department": "string",
"email": "string",
"firstName": "string",
"id": "string",
"lastName": "string",
"phone": "string"
}
],
"email": "string",
"iban": "string",
"phone": "string",
"type": "COMPANY",
"vatNumber": "string"
},
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"id": "string",
"isRoot": true,
"name": "string",
"parentId": "string",
"phone": "string",
"root": true,
"subsidiaries": [],
"tenantId": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string"
}
],
"tenantId": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Add child to parent subsidiary
In: header
Path Parameters
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
curl -X POST "http://localhost:18080/api/v1/subsidiaries/string/add-child" \ -H "Content-Type: application/json" \ -d '{ "id": "string", "isRoot": true, "name": "string", "subsidiaries": [ "string" ] }'{
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"billingInfo": {
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"bank": "string",
"bic": "string",
"cocNumber": "string",
"contacts": [
{
"department": "string",
"email": "string",
"firstName": "string",
"id": "string",
"lastName": "string",
"phone": "string"
}
],
"email": "string",
"iban": "string",
"phone": "string",
"type": "COMPANY",
"vatNumber": "string"
},
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"id": "string",
"isRoot": true,
"name": "string",
"parentId": "string",
"phone": "string",
"root": true,
"subsidiaries": [
{
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"billingInfo": {
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"bank": "string",
"bic": "string",
"cocNumber": "string",
"contacts": [
{
"department": "string",
"email": "string",
"firstName": "string",
"id": "string",
"lastName": "string",
"phone": "string"
}
],
"email": "string",
"iban": "string",
"phone": "string",
"type": "COMPANY",
"vatNumber": "string"
},
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"id": "string",
"isRoot": true,
"name": "string",
"parentId": "string",
"phone": "string",
"root": true,
"subsidiaries": [],
"tenantId": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string"
}
],
"tenantId": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}