Tax Code Determination

Tax Code Determination - Get Tax Code Determination

HTTP Request

GET /api/tax-code-determinations/{id}

📋 Description: Retrieves the tax code determination for a specified asset within the Nakisa Portfolio Management Suite, facilitating informed decision-making in portfolio and real estate property management.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

Responses

Status

Meaning

Description

Schema

200

OK

OK

TaxCodeDeterminationDto

Example Responses

 1{
 2  "id": 0,
 3  "status": "CREATED",
 4  "displayId": "string",
 5  "erpSystemId": 0,
 6  "erpSystemDisplayId": "string",
 7  "countryId": 0,
 8  "countryDisplayId": "string",
 9  "countryTaxJurisdictionEnabled": true,
10  "forAllCompanies": true,
11  "companyId": 0,
12  "companyDisplayId": "string",
13  "companyName": "string",
14  "forAllAssetClasses": true,
15  "assetClassId": 0,
16  "assetClassDisplayId": "string",
17  "forAllPartners": true,
18  "partnerId": 0,
19  "partnerDisplayId": "string",
20  "partnerName": "string",
21  "taxJurisdictionId": 0,
22  "taxJurisdictionDisplayId": "string",
23  "defaultTaxCodeId": 0,
24  "defaultTaxCodeDisplayId": "string",
25  "defaultExemptionTaxCodeId": 0,
26  "defaultExemptionTaxCodeDisplayId": "string",
27  "defaultExemptionPercentage": 0.1
28}

Tax Code Determination - Update Tax Code Determinations

HTTP Request

PUT /api/tax-code-determinations/{id}

📋 Description: Updates the tax code determination for a specified asset within the Nakisa Portfolio Management Suite, enabling accurate tax analytics and compliance for real estate properties.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

body

body

TaxCodeDeterminationDto

true

Request body containing the updated tax code determination data, including relevant portfolio and asset information, for the specified real estate property.

Body Parameters

 1[
 2  {
 3    "id": 0,
 4    "status": "CREATED",
 5    "displayId": "string",
 6    "erpSystemId": 0,
 7    "erpSystemDisplayId": "string",
 8    "countryId": 0,
 9    "countryDisplayId": "string",
10    "countryTaxJurisdictionEnabled": true,
11    "forAllCompanies": true,
12    "companyId": 0,
13    "companyDisplayId": "string",
14    "companyName": "string",
15    "forAllAssetClasses": true,
16    "assetClassId": 0,
17    "assetClassDisplayId": "string",
18    "forAllPartners": true,
19    "partnerId": 0,
20    "partnerDisplayId": "string",
21    "partnerName": "string",
22    "taxJurisdictionId": 0,
23    "taxJurisdictionDisplayId": "string",
24    "defaultTaxCodeId": 0,
25    "defaultTaxCodeDisplayId": "string",
26    "defaultExemptionTaxCodeId": 0,
27    "defaultExemptionTaxCodeDisplayId": "string",
28    "defaultExemptionPercentage": 0.1
29  }
30]

Responses

Status

Meaning

Description

Schema

200

OK

OK

Inline

Example Responses

 1[
 2  {
 3    "id": 0,
 4    "status": "CREATED",
 5    "displayId": "string",
 6    "erpSystemId": 0,
 7    "erpSystemDisplayId": "string",
 8    "countryId": 0,
 9    "countryDisplayId": "string",
10    "countryTaxJurisdictionEnabled": true,
11    "forAllCompanies": true,
12    "companyId": 0,
13    "companyDisplayId": "string",
14    "companyName": "string",
15    "forAllAssetClasses": true,
16    "assetClassId": 0,
17    "assetClassDisplayId": "string",
18    "forAllPartners": true,
19    "partnerId": 0,
20    "partnerDisplayId": "string",
21    "partnerName": "string",
22    "taxJurisdictionId": 0,
23    "taxJurisdictionDisplayId": "string",
24    "defaultTaxCodeId": 0,
25    "defaultTaxCodeDisplayId": "string",
26    "defaultExemptionTaxCodeId": 0,
27    "defaultExemptionTaxCodeDisplayId": "string",
28    "defaultExemptionPercentage": 0.1
29  }
30]

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[TaxCodeDeterminationDto]

false

none

[Data transfer object representing the determination of tax codes for assets within the Nakisa Portfolio Management Suite, facilitating accurate analytics and compliance in real estate property management.]

» id

integer(int64)

false

none

Unique identifier for the resource

» status

string

false

none

Status of the resource

» displayId

string

true

none

Unique identifier for the display

» erpSystemId

integer(int64)

false

none

Unique identifier for the erp system

» erpSystemDisplayId

string

false

none

Unique identifier for the erp system display

» countryId

integer(int64)

false

none

Unique identifier for the country

» countryDisplayId

string

false

none

Unique identifier for the country display

» countryTaxJurisdictionEnabled

boolean

false

none

Indicates whether this feature is enabled

» forAllCompanies

boolean

false

none

Boolean flag indicating forAllCompanies status

» companyId

integer(int64)

false

none

Unique identifier for the company

» companyDisplayId

string

false

none

Unique identifier for the company display

» companyName

string

false

none

none

» forAllAssetClasses

boolean

false

none

Boolean flag indicating forAllAssetClasses status

» assetClassId

integer(int64)

false

none

Unique identifier for the asset class

» assetClassDisplayId

string

false

none

Unique identifier for the asset class display

» forAllPartners

boolean

false

none

Boolean flag indicating forAllPartners status

» partnerId

integer(int64)

false

none

Unique identifier for the partner

» partnerDisplayId

string

false

none

Unique identifier for the partner display

» partnerName

string

false

none

Name of the partner

» taxJurisdictionId

integer(int64)

false

none

Unique identifier for the tax jurisdiction

» taxJurisdictionDisplayId

string

false

none

Unique identifier for the tax jurisdiction display

» defaultTaxCodeId

integer(int64)

false

none

Unique identifier for the default tax code

» defaultTaxCodeDisplayId

string

false

none

Unique identifier for the default tax code display

» defaultExemptionTaxCodeId

integer(int64)

false

none

Unique identifier for the default exemption tax code

» defaultExemptionTaxCodeDisplayId

string

false

none

Unique identifier for the default exemption tax code display

» defaultExemptionPercentage

number(double)

true

none

Percentage of default exemption

Enumerated Values

Attribute

Value

status

ACTIVE, CREATED, DECOMMISSIONED, DISABLED

Tax Code Determination - Delete Tax Code Determination

HTTP Request

DELETE /api/tax-code-determinations/{id}

📋 Description: Deletes a specified tax code determination from the Nakisa Portfolio Management Suite, ensuring accurate financial analytics and compliance for real estate property assets.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

Responses

Status

Meaning

Description

Schema

204

No Content

No Content

None

Tax Code Determination - Get Tax Code Determinations

HTTP Request

GET /api/tax-code-determinations

📋 Description: Retrieves tax code determinations for assets within the Nakisa Portfolio Management Suite, enabling users to analyze and manage real estate property tax implications effectively.

Responses

Status

Meaning

Description

Schema

200

OK

OK

PageTaxCodeDeterminationDto

Example Responses

 1{
 2  "totalElements": 0,
 3  "totalPages": 0,
 4  "pageable": {
 5    "pageNumber": 0,
 6    "pageSize": 0,
 7    "unpaged": true,
 8    "paged": true,
 9    "offset": 0,
10    "sort": {
11      "sorted": true,
12      "unsorted": true,
13      "empty": true
14    }
15  },
16  "numberOfElements": 0,
17  "size": 0,
18  "content": [
19    {
20      "id": 0,
21      "status": "CREATED",
22      "displayId": "string",
23      "erpSystemId": 0,
24      "erpSystemDisplayId": "string",
25      "countryId": 0,
26      "countryDisplayId": "string",
27      "countryTaxJurisdictionEnabled": true,
28      "forAllCompanies": true,
29      "companyId": 0,
30      "companyDisplayId": "string",
31      "companyName": "string",
32      "forAllAssetClasses": true,
33      "assetClassId": 0,
34      "assetClassDisplayId": "string",
35      "forAllPartners": true,
36      "partnerId": 0,
37      "partnerDisplayId": "string",
38      "partnerName": "string",
39      "taxJurisdictionId": 0,
40      "taxJurisdictionDisplayId": "string",
41      "defaultTaxCodeId": 0,
42      "defaultTaxCodeDisplayId": "string",
43      "defaultExemptionTaxCodeId": 0,
44      "defaultExemptionTaxCodeDisplayId": "string",
45      "defaultExemptionPercentage": 0.1
46    }
47  ],
48  "number": 0,
49  "sort": {
50    "sorted": true,
51    "unsorted": true,
52    "empty": true
53  },
54  "first": true,
55  "last": true,
56  "empty": true
57}

Tax Code Determination - Create Tax Code Determinations

HTTP Request

POST /api/tax-code-determinations

📋 Description: Submits tax code determination requests for assets within the Nakisa Portfolio Management Suite, enabling accurate tax analytics and compliance for real estate properties.

Parameters

Name

In

Type

Required

Description

body

body

TaxCodeDeterminationDto

true

Request body containing the tax code determination data for portfolio and asset analytics within the Nakisa Portfolio Management Suite.

Body Parameters

 1[
 2  {
 3    "id": 0,
 4    "status": "CREATED",
 5    "displayId": "string",
 6    "erpSystemId": 0,
 7    "erpSystemDisplayId": "string",
 8    "countryId": 0,
 9    "countryDisplayId": "string",
10    "countryTaxJurisdictionEnabled": true,
11    "forAllCompanies": true,
12    "companyId": 0,
13    "companyDisplayId": "string",
14    "companyName": "string",
15    "forAllAssetClasses": true,
16    "assetClassId": 0,
17    "assetClassDisplayId": "string",
18    "forAllPartners": true,
19    "partnerId": 0,
20    "partnerDisplayId": "string",
21    "partnerName": "string",
22    "taxJurisdictionId": 0,
23    "taxJurisdictionDisplayId": "string",
24    "defaultTaxCodeId": 0,
25    "defaultTaxCodeDisplayId": "string",
26    "defaultExemptionTaxCodeId": 0,
27    "defaultExemptionTaxCodeDisplayId": "string",
28    "defaultExemptionPercentage": 0.1
29  }
30]

Responses

Status

Meaning

Description

Schema

201

Created

Created

Inline

Example Responses

 1[
 2  {
 3    "id": 0,
 4    "status": "CREATED",
 5    "displayId": "string",
 6    "erpSystemId": 0,
 7    "erpSystemDisplayId": "string",
 8    "countryId": 0,
 9    "countryDisplayId": "string",
10    "countryTaxJurisdictionEnabled": true,
11    "forAllCompanies": true,
12    "companyId": 0,
13    "companyDisplayId": "string",
14    "companyName": "string",
15    "forAllAssetClasses": true,
16    "assetClassId": 0,
17    "assetClassDisplayId": "string",
18    "forAllPartners": true,
19    "partnerId": 0,
20    "partnerDisplayId": "string",
21    "partnerName": "string",
22    "taxJurisdictionId": 0,
23    "taxJurisdictionDisplayId": "string",
24    "defaultTaxCodeId": 0,
25    "defaultTaxCodeDisplayId": "string",
26    "defaultExemptionTaxCodeId": 0,
27    "defaultExemptionTaxCodeDisplayId": "string",
28    "defaultExemptionPercentage": 0.1
29  }
30]

Response Schema

Status Code 201

Name

Type

Required

Restrictions

Description

anonymous

[TaxCodeDeterminationDto]

false

none

[Data transfer object representing the determination of tax codes for assets within the Nakisa Portfolio Management Suite, facilitating accurate analytics and compliance in real estate property management.]

» id

integer(int64)

false

none

Unique identifier for the resource

» status

string

false

none

Status of the resource

» displayId

string

true

none

Unique identifier for the display

» erpSystemId

integer(int64)

false

none

Unique identifier for the erp system

» erpSystemDisplayId

string

false

none

Unique identifier for the erp system display

» countryId

integer(int64)

false

none

Unique identifier for the country

» countryDisplayId

string

false

none

Unique identifier for the country display

» countryTaxJurisdictionEnabled

boolean

false

none

Indicates whether this feature is enabled

» forAllCompanies

boolean

false

none

Boolean flag indicating forAllCompanies status

» companyId

integer(int64)

false

none

Unique identifier for the company

» companyDisplayId

string

false

none

Unique identifier for the company display

» companyName

string

false

none

none

» forAllAssetClasses

boolean

false

none

Boolean flag indicating forAllAssetClasses status

» assetClassId

integer(int64)

false

none

Unique identifier for the asset class

» assetClassDisplayId

string

false

none

Unique identifier for the asset class display

» forAllPartners

boolean

false

none

Boolean flag indicating forAllPartners status

» partnerId

integer(int64)

false

none

Unique identifier for the partner

» partnerDisplayId

string

false

none

Unique identifier for the partner display

» partnerName

string

false

none

Name of the partner

» taxJurisdictionId

integer(int64)

false

none

Unique identifier for the tax jurisdiction

» taxJurisdictionDisplayId

string

false

none

Unique identifier for the tax jurisdiction display

» defaultTaxCodeId

integer(int64)

false

none

Unique identifier for the default tax code

» defaultTaxCodeDisplayId

string

false

none

Unique identifier for the default tax code display

» defaultExemptionTaxCodeId

integer(int64)

false

none

Unique identifier for the default exemption tax code

» defaultExemptionTaxCodeDisplayId

string

false

none

Unique identifier for the default exemption tax code display

» defaultExemptionPercentage

number(double)

true

none

Percentage of default exemption

Enumerated Values

Attribute

Value

status

ACTIVE, CREATED, DECOMMISSIONED, DISABLED

Tax Code Determination - Get Tax Jurisdictions By Determination

HTTP Request

POST /api/tax-code-determinations/tax-jurisdictions

📋 Description: Creates new tax jurisdiction determinations for assets within the Nakisa Portfolio Management Suite, enabling accurate tax code assignments for real estate properties and enhancing portfolio analytics.

Parameters

Name

In

Type

Required

Description

body

body

TaxJurisdictionRequest

true

Request body containing the tax jurisdiction details necessary for determining applicable tax codes within the Nakisa Portfolio Management Suite, relevant to portfolio, asset, and real estate property analytics.

Body Parameters

1{
2  "companyId": 0,
3  "partnerId": 0
4}

Responses

Status

Meaning

Description

Schema

200

OK

OK

TaxJurisdictionResponse

Example Responses

 1{
 2  "determinations": [
 3    {
 4      "id": 0,
 5      "status": "CREATED",
 6      "displayId": "string",
 7      "erpSystemId": 0,
 8      "erpSystemDisplayId": "string",
 9      "countryId": 0,
10      "countryDisplayId": "string",
11      "countryTaxJurisdictionEnabled": true,
12      "forAllCompanies": true,
13      "companyId": 0,
14      "companyDisplayId": "string",
15      "companyName": "string",
16      "forAllAssetClasses": true,
17      "assetClassId": 0,
18      "assetClassDisplayId": "string",
19      "forAllPartners": true,
20      "partnerId": 0,
21      "partnerDisplayId": "string",
22      "partnerName": "string",
23      "taxJurisdictionId": 0,
24      "taxJurisdictionDisplayId": "string",
25      "defaultTaxCodeId": 0,
26      "defaultTaxCodeDisplayId": "string",
27      "defaultExemptionTaxCodeId": 0,
28      "defaultExemptionTaxCodeDisplayId": "string",
29      "defaultExemptionPercentage": 0.1
30    }
31  ]
32}

Tax Code Determination - Search Tax Code Determinations

HTTP Request

POST /api/tax-code-determinations/search

📋 Description: Submits a request to search for tax code determinations related to portfolio and asset analytics within the Nakisa Portfolio Management Suite, enabling users to efficiently identify applicable tax codes for real estate properties.

Parameters

Name

In

Type

Required

Description

body

body

TaxCodeDeterminationDtoFilter

true

Request body containing the criteria for tax code determinations related to portfolio assets and real estate properties, facilitating accurate analytics and compliance.

Body Parameters

 1{
 2  "idIn": [
 3    0
 4  ],
 5  "idEqual": 0,
 6  "idLike": "string",
 7  "createdAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
 8  "createdAtLessThanOrEqual": "2019-08-24T14:15:22Z",
 9  "createdByLike": "string",
10  "createdByEqual": "string",
11  "modifiedAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
12  "modifiedAtLessThanOrEqual": "2019-08-24T14:15:22Z",
13  "modifiedByLike": "string",
14  "modifiedByEqual": "string",
15  "statusEqual": "CREATED",
16  "statusIn": [
17    "CREATED"
18  ],
19  "displayIdIn": [
20    "string"
21  ],
22  "displayIdLike": "string",
23  "erpSystemIdEqual": 0,
24  "erpSystemDisplayIdLike": "string",
25  "companyDisplayIdLike": "string",
26  "partnerDisplayIdLike": "string",
27  "countryIdEqual": 0,
28  "countryDisplayIdLike": "string",
29  "forAllCompaniesEqual": true,
30  "companyIdEqual": 0,
31  "companyNameLike": "string",
32  "forAllAssetClassesEqual": true,
33  "forAllPartnersEqual": true,
34  "partnerIdEqual": 0,
35  "partnerNameLike": "string",
36  "taxJurisdictionIdEqual": 0,
37  "taxJurisdictionDisplayIdLike": "string",
38  "defaultTaxCodeIdEqual": 0,
39  "defaultTaxCodeDisplayIdLike": "string",
40  "defaultExemptionTaxCodeIdEqual": 0,
41  "defaultExemptionTaxCodeDisplayIdLike": "string",
42  "defaultExemptionPercentageLike": "string"
43}

Responses

Status

Meaning

Description

Schema

200

OK

OK

PageTaxCodeDeterminationDto

Example Responses

 1{
 2  "totalElements": 0,
 3  "totalPages": 0,
 4  "pageable": {
 5    "pageNumber": 0,
 6    "pageSize": 0,
 7    "unpaged": true,
 8    "paged": true,
 9    "offset": 0,
10    "sort": {
11      "sorted": true,
12      "unsorted": true,
13      "empty": true
14    }
15  },
16  "numberOfElements": 0,
17  "size": 0,
18  "content": [
19    {
20      "id": 0,
21      "status": "CREATED",
22      "displayId": "string",
23      "erpSystemId": 0,
24      "erpSystemDisplayId": "string",
25      "countryId": 0,
26      "countryDisplayId": "string",
27      "countryTaxJurisdictionEnabled": true,
28      "forAllCompanies": true,
29      "companyId": 0,
30      "companyDisplayId": "string",
31      "companyName": "string",
32      "forAllAssetClasses": true,
33      "assetClassId": 0,
34      "assetClassDisplayId": "string",
35      "forAllPartners": true,
36      "partnerId": 0,
37      "partnerDisplayId": "string",
38      "partnerName": "string",
39      "taxJurisdictionId": 0,
40      "taxJurisdictionDisplayId": "string",
41      "defaultTaxCodeId": 0,
42      "defaultTaxCodeDisplayId": "string",
43      "defaultExemptionTaxCodeId": 0,
44      "defaultExemptionTaxCodeDisplayId": "string",
45      "defaultExemptionPercentage": 0.1
46    }
47  ],
48  "number": 0,
49  "sort": {
50    "sorted": true,
51    "unsorted": true,
52    "empty": true
53  },
54  "first": true,
55  "last": true,
56  "empty": true
57}