Assessment Tax

Get Assessment Tax

HTTP Request

GET /api/assessment-tax/{assessmentTaxId}

📋 Description: Retrieves detailed information about a specific assessment tax based on the provided assessmentTaxId, enabling users to access relevant tax data for informed decision-making.

Parameters

Name

In

Type

Required

Description

assessmentTaxId

path

integer(int64)

true

Unique identifier for the assessment tax

Responses

Status

Meaning

Description

Schema

200

OK

OK

AssessmentTaxDto

Example Responses

  1{
  2  "createdBy": "string",
  3  "lastModifiedBy": "string",
  4  "createdDate": "2019-08-24T14:15:22Z",
  5  "lastModifiedDate": "2019-08-24T14:15:22Z",
  6  "archived": true,
  7  "externalId": "string",
  8  "id": 0,
  9  "referenceNumber": "string",
 10  "billingDate": "2019-08-24",
 11  "taxTypeId": 0,
 12  "taxPeriodStartDate": "2019-08-24",
 13  "taxPeriodEndDate": "2019-08-24",
 14  "taxableAssessment": 0,
 15  "totalTaxes": 0,
 16  "taxRate": 0,
 17  "firstPaymentDate": "2019-08-24",
 18  "taxBillVersionId": 0,
 19  "taxStatusId": 0,
 20  "taxType": {
 21    "createdBy": "string",
 22    "lastModifiedBy": "string",
 23    "createdDate": "2019-08-24T14:15:22Z",
 24    "lastModifiedDate": "2019-08-24T14:15:22Z",
 25    "archived": true,
 26    "externalId": "string",
 27    "id": 0,
 28    "priority": 0,
 29    "internalId": 0,
 30    "pickListCode": "string",
 31    "pickListLabel": "string",
 32    "label": "string",
 33    "cultureId": 0,
 34    "labelDtos": [
 35      {
 36        "createdBy": "string",
 37        "lastModifiedBy": "string",
 38        "createdDate": "2019-08-24T14:15:22Z",
 39        "lastModifiedDate": "2019-08-24T14:15:22Z",
 40        "archived": true,
 41        "externalId": "string",
 42        "id": 0,
 43        "cultureId": 0,
 44        "value": "string"
 45      }
 46    ]
 47  },
 48  "taxBillVersion": {
 49    "createdBy": "string",
 50    "lastModifiedBy": "string",
 51    "createdDate": "2019-08-24T14:15:22Z",
 52    "lastModifiedDate": "2019-08-24T14:15:22Z",
 53    "archived": true,
 54    "externalId": "string",
 55    "id": 0,
 56    "priority": 0,
 57    "internalId": 0,
 58    "pickListCode": "string",
 59    "pickListLabel": "string",
 60    "label": "string",
 61    "cultureId": 0,
 62    "labelDtos": [
 63      {
 64        "createdBy": "string",
 65        "lastModifiedBy": "string",
 66        "createdDate": "2019-08-24T14:15:22Z",
 67        "lastModifiedDate": "2019-08-24T14:15:22Z",
 68        "archived": true,
 69        "externalId": "string",
 70        "id": 0,
 71        "cultureId": 0,
 72        "value": "string"
 73      }
 74    ]
 75  },
 76  "taxStatus": {
 77    "createdBy": "string",
 78    "lastModifiedBy": "string",
 79    "createdDate": "2019-08-24T14:15:22Z",
 80    "lastModifiedDate": "2019-08-24T14:15:22Z",
 81    "archived": true,
 82    "externalId": "string",
 83    "id": 0,
 84    "priority": 0,
 85    "internalId": 0,
 86    "pickListCode": "string",
 87    "pickListLabel": "string",
 88    "label": "string",
 89    "cultureId": 0,
 90    "labelDtos": [
 91      {
 92        "createdBy": "string",
 93        "lastModifiedBy": "string",
 94        "createdDate": "2019-08-24T14:15:22Z",
 95        "lastModifiedDate": "2019-08-24T14:15:22Z",
 96        "archived": true,
 97        "externalId": "string",
 98        "id": 0,
 99        "cultureId": 0,
100        "value": "string"
101      }
102    ]
103  }
104}

Update Assessment Tax

HTTP Request

PUT /api/assessment-tax/{assessmentTaxId}

📋 Description: Updates the details of a specific assessment tax record identified by the provided assessmentTaxId, ensuring that the latest information is accurately reflected in the system. This operation is essential for maintaining compliance and accuracy in financial assessments.

Parameters

Name

In

Type

Required

Description

assessmentTaxId

path

integer(int64)

true

Unique identifier for the assessment tax

body

body

AssessmentTaxDto

true

Request body containing the updated assessment tax details, including applicable rates and relevant metadata for the specified assessmentTaxId.

Body Parameters

  1{
  2  "createdBy": "string",
  3  "lastModifiedBy": "string",
  4  "createdDate": "2019-08-24T14:15:22Z",
  5  "lastModifiedDate": "2019-08-24T14:15:22Z",
  6  "archived": true,
  7  "externalId": "string",
  8  "id": 0,
  9  "referenceNumber": "string",
 10  "billingDate": "2019-08-24",
 11  "taxTypeId": 0,
 12  "taxPeriodStartDate": "2019-08-24",
 13  "taxPeriodEndDate": "2019-08-24",
 14  "taxableAssessment": 0,
 15  "totalTaxes": 0,
 16  "taxRate": 0,
 17  "firstPaymentDate": "2019-08-24",
 18  "taxBillVersionId": 0,
 19  "taxStatusId": 0,
 20  "taxType": {
 21    "createdBy": "string",
 22    "lastModifiedBy": "string",
 23    "createdDate": "2019-08-24T14:15:22Z",
 24    "lastModifiedDate": "2019-08-24T14:15:22Z",
 25    "archived": true,
 26    "externalId": "string",
 27    "id": 0,
 28    "priority": 0,
 29    "internalId": 0,
 30    "pickListCode": "string",
 31    "pickListLabel": "string",
 32    "label": "string",
 33    "cultureId": 0,
 34    "labelDtos": [
 35      {
 36        "createdBy": "string",
 37        "lastModifiedBy": "string",
 38        "createdDate": "2019-08-24T14:15:22Z",
 39        "lastModifiedDate": "2019-08-24T14:15:22Z",
 40        "archived": true,
 41        "externalId": "string",
 42        "id": 0,
 43        "cultureId": 0,
 44        "value": "string"
 45      }
 46    ]
 47  },
 48  "taxBillVersion": {
 49    "createdBy": "string",
 50    "lastModifiedBy": "string",
 51    "createdDate": "2019-08-24T14:15:22Z",
 52    "lastModifiedDate": "2019-08-24T14:15:22Z",
 53    "archived": true,
 54    "externalId": "string",
 55    "id": 0,
 56    "priority": 0,
 57    "internalId": 0,
 58    "pickListCode": "string",
 59    "pickListLabel": "string",
 60    "label": "string",
 61    "cultureId": 0,
 62    "labelDtos": [
 63      {
 64        "createdBy": "string",
 65        "lastModifiedBy": "string",
 66        "createdDate": "2019-08-24T14:15:22Z",
 67        "lastModifiedDate": "2019-08-24T14:15:22Z",
 68        "archived": true,
 69        "externalId": "string",
 70        "id": 0,
 71        "cultureId": 0,
 72        "value": "string"
 73      }
 74    ]
 75  },
 76  "taxStatus": {
 77    "createdBy": "string",
 78    "lastModifiedBy": "string",
 79    "createdDate": "2019-08-24T14:15:22Z",
 80    "lastModifiedDate": "2019-08-24T14:15:22Z",
 81    "archived": true,
 82    "externalId": "string",
 83    "id": 0,
 84    "priority": 0,
 85    "internalId": 0,
 86    "pickListCode": "string",
 87    "pickListLabel": "string",
 88    "label": "string",
 89    "cultureId": 0,
 90    "labelDtos": [
 91      {
 92        "createdBy": "string",
 93        "lastModifiedBy": "string",
 94        "createdDate": "2019-08-24T14:15:22Z",
 95        "lastModifiedDate": "2019-08-24T14:15:22Z",
 96        "archived": true,
 97        "externalId": "string",
 98        "id": 0,
 99        "cultureId": 0,
100        "value": "string"
101      }
102    ]
103  }
104}

Responses

Status

Meaning

Description

Schema

200

OK

OK

AssessmentTaxDto

Example Responses

  1{
  2  "createdBy": "string",
  3  "lastModifiedBy": "string",
  4  "createdDate": "2019-08-24T14:15:22Z",
  5  "lastModifiedDate": "2019-08-24T14:15:22Z",
  6  "archived": true,
  7  "externalId": "string",
  8  "id": 0,
  9  "referenceNumber": "string",
 10  "billingDate": "2019-08-24",
 11  "taxTypeId": 0,
 12  "taxPeriodStartDate": "2019-08-24",
 13  "taxPeriodEndDate": "2019-08-24",
 14  "taxableAssessment": 0,
 15  "totalTaxes": 0,
 16  "taxRate": 0,
 17  "firstPaymentDate": "2019-08-24",
 18  "taxBillVersionId": 0,
 19  "taxStatusId": 0,
 20  "taxType": {
 21    "createdBy": "string",
 22    "lastModifiedBy": "string",
 23    "createdDate": "2019-08-24T14:15:22Z",
 24    "lastModifiedDate": "2019-08-24T14:15:22Z",
 25    "archived": true,
 26    "externalId": "string",
 27    "id": 0,
 28    "priority": 0,
 29    "internalId": 0,
 30    "pickListCode": "string",
 31    "pickListLabel": "string",
 32    "label": "string",
 33    "cultureId": 0,
 34    "labelDtos": [
 35      {
 36        "createdBy": "string",
 37        "lastModifiedBy": "string",
 38        "createdDate": "2019-08-24T14:15:22Z",
 39        "lastModifiedDate": "2019-08-24T14:15:22Z",
 40        "archived": true,
 41        "externalId": "string",
 42        "id": 0,
 43        "cultureId": 0,
 44        "value": "string"
 45      }
 46    ]
 47  },
 48  "taxBillVersion": {
 49    "createdBy": "string",
 50    "lastModifiedBy": "string",
 51    "createdDate": "2019-08-24T14:15:22Z",
 52    "lastModifiedDate": "2019-08-24T14:15:22Z",
 53    "archived": true,
 54    "externalId": "string",
 55    "id": 0,
 56    "priority": 0,
 57    "internalId": 0,
 58    "pickListCode": "string",
 59    "pickListLabel": "string",
 60    "label": "string",
 61    "cultureId": 0,
 62    "labelDtos": [
 63      {
 64        "createdBy": "string",
 65        "lastModifiedBy": "string",
 66        "createdDate": "2019-08-24T14:15:22Z",
 67        "lastModifiedDate": "2019-08-24T14:15:22Z",
 68        "archived": true,
 69        "externalId": "string",
 70        "id": 0,
 71        "cultureId": 0,
 72        "value": "string"
 73      }
 74    ]
 75  },
 76  "taxStatus": {
 77    "createdBy": "string",
 78    "lastModifiedBy": "string",
 79    "createdDate": "2019-08-24T14:15:22Z",
 80    "lastModifiedDate": "2019-08-24T14:15:22Z",
 81    "archived": true,
 82    "externalId": "string",
 83    "id": 0,
 84    "priority": 0,
 85    "internalId": 0,
 86    "pickListCode": "string",
 87    "pickListLabel": "string",
 88    "label": "string",
 89    "cultureId": 0,
 90    "labelDtos": [
 91      {
 92        "createdBy": "string",
 93        "lastModifiedBy": "string",
 94        "createdDate": "2019-08-24T14:15:22Z",
 95        "lastModifiedDate": "2019-08-24T14:15:22Z",
 96        "archived": true,
 97        "externalId": "string",
 98        "id": 0,
 99        "cultureId": 0,
100        "value": "string"
101      }
102    ]
103  }
104}

Delete Assessment Tax

HTTP Request

DELETE /api/assessment-tax/{assessmentTaxId}

📋 Description: Deletes a specified assessment tax record identified by the unique assessmentTaxId, ensuring the removal of outdated or incorrect tax information from the system.

Parameters

Name

In

Type

Required

Description

assessmentTaxId

path

integer(int64)

true

Unique identifier for the assessment tax

Responses

Status

Meaning

Description

Schema

204

No Content

No Content

None

Archive Assessment Tax

HTTP Request

POST /api/assessment-tax/{id}/archive

📋 Description: Archives the specified assessment tax record, identified by the unique ID, to streamline data management and maintain compliance with regulatory requirements.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

Responses

Status

Meaning

Description

Schema

200

OK

OK

AssessmentTaxDto

Example Responses

  1{
  2  "createdBy": "string",
  3  "lastModifiedBy": "string",
  4  "createdDate": "2019-08-24T14:15:22Z",
  5  "lastModifiedDate": "2019-08-24T14:15:22Z",
  6  "archived": true,
  7  "externalId": "string",
  8  "id": 0,
  9  "referenceNumber": "string",
 10  "billingDate": "2019-08-24",
 11  "taxTypeId": 0,
 12  "taxPeriodStartDate": "2019-08-24",
 13  "taxPeriodEndDate": "2019-08-24",
 14  "taxableAssessment": 0,
 15  "totalTaxes": 0,
 16  "taxRate": 0,
 17  "firstPaymentDate": "2019-08-24",
 18  "taxBillVersionId": 0,
 19  "taxStatusId": 0,
 20  "taxType": {
 21    "createdBy": "string",
 22    "lastModifiedBy": "string",
 23    "createdDate": "2019-08-24T14:15:22Z",
 24    "lastModifiedDate": "2019-08-24T14:15:22Z",
 25    "archived": true,
 26    "externalId": "string",
 27    "id": 0,
 28    "priority": 0,
 29    "internalId": 0,
 30    "pickListCode": "string",
 31    "pickListLabel": "string",
 32    "label": "string",
 33    "cultureId": 0,
 34    "labelDtos": [
 35      {
 36        "createdBy": "string",
 37        "lastModifiedBy": "string",
 38        "createdDate": "2019-08-24T14:15:22Z",
 39        "lastModifiedDate": "2019-08-24T14:15:22Z",
 40        "archived": true,
 41        "externalId": "string",
 42        "id": 0,
 43        "cultureId": 0,
 44        "value": "string"
 45      }
 46    ]
 47  },
 48  "taxBillVersion": {
 49    "createdBy": "string",
 50    "lastModifiedBy": "string",
 51    "createdDate": "2019-08-24T14:15:22Z",
 52    "lastModifiedDate": "2019-08-24T14:15:22Z",
 53    "archived": true,
 54    "externalId": "string",
 55    "id": 0,
 56    "priority": 0,
 57    "internalId": 0,
 58    "pickListCode": "string",
 59    "pickListLabel": "string",
 60    "label": "string",
 61    "cultureId": 0,
 62    "labelDtos": [
 63      {
 64        "createdBy": "string",
 65        "lastModifiedBy": "string",
 66        "createdDate": "2019-08-24T14:15:22Z",
 67        "lastModifiedDate": "2019-08-24T14:15:22Z",
 68        "archived": true,
 69        "externalId": "string",
 70        "id": 0,
 71        "cultureId": 0,
 72        "value": "string"
 73      }
 74    ]
 75  },
 76  "taxStatus": {
 77    "createdBy": "string",
 78    "lastModifiedBy": "string",
 79    "createdDate": "2019-08-24T14:15:22Z",
 80    "lastModifiedDate": "2019-08-24T14:15:22Z",
 81    "archived": true,
 82    "externalId": "string",
 83    "id": 0,
 84    "priority": 0,
 85    "internalId": 0,
 86    "pickListCode": "string",
 87    "pickListLabel": "string",
 88    "label": "string",
 89    "cultureId": 0,
 90    "labelDtos": [
 91      {
 92        "createdBy": "string",
 93        "lastModifiedBy": "string",
 94        "createdDate": "2019-08-24T14:15:22Z",
 95        "lastModifiedDate": "2019-08-24T14:15:22Z",
 96        "archived": true,
 97        "externalId": "string",
 98        "id": 0,
 99        "cultureId": 0,
100        "value": "string"
101      }
102    ]
103  }
104}