Tax Codes (1.0)

Download OpenAPI specification:Download

APIs that allow you to to get, create and maintain tax codes.

Authentication

XCompleatApiKey

Security Scheme Type API Key
Header parameter name: x-api-compleat-key

Tax Codes

Tax Codes

Used to retrieve all tax codes within a given company.

Authorizations:
path Parameters
tenantId
required
string <guid>
Example: d025eedc-5ea0-4de8-be9f-f8873545add9

Id of the tenant to retrieve information for. The account requesting the data must have access to this tenant Id.

companyId
required
string <guid>
Example: 8d4bb975-eade-42fd-a064-bf448e493c1e

Id of the company to retrieve tax codes for. Must be a valid company within the tenant.

pageNumber
required
integer >= 1
Example: 1

Page number. The API call will return a page of data (page size is 100 records).

userId
required
string <guid>
Example: 0a722409-9907-4353-afaa-e6bdf5521bb5

Optional user Id (if you are not using this field include a NULL value). Optional, but must be provided if the transaction id is provided. If provided, used to filter records based on those available to the user and transaction only.

transactionId
required
string <guid>
Example: 0a722409-9907-4353-afaa-e6bdf5521bb5

Optional transaction Id (if you are not using this field include a NULL value). Optional, but must be provided if the user id is provided. If provided, used to filter records based on those available to the user and transaction only.

header Parameters
x-api-version
required
integer
Value: 1
Example: 1

Indicates the version of this API to be used.

x-api-compleat-key
required
string <guid>
Example: d025eedc-5ea0-4de8-be9f-f8873545add9

The header containing compleat api key.

Responses

200

Successful response. A list of tax codes will be returned.

400

Bad request. Incorrect data has been provided.

401

Unauthorized. The secure credentials passed do not allow access to this resource.

500

An internal error has occurred.

get/api/analysisfields/taxcodes/{tenantId}/{companyId}/{pageNumber}/{userId}/{transactionId}
/api/analysisfields/taxcodes/{tenantId}/{companyId}/{pageNumber}/{userId}/{transactionId}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{}

Tax Codes

Used to refresh the tax codes in a company with a complete new set of values, or append values to a previous new post.

Authorizations:
path Parameters
tenantId
required
string <guid>
Example: d025eedc-5ea0-4de8-be9f-f8873545add9

Id of the tenant to post tax codes into. The account requesting the data must have access to this tenant Id.

companyId
required
string <guid>
Example: 8d4bb975-eade-42fd-a064-bf448e493c1e

Id of the company to post tax codes into. Must be a valid company within the tenant.

header Parameters
x-api-version
required
integer
Value: 1
Example: 1

Indicates the version of this API to be used.

x-api-compleat-key
required
string <guid>
Example: d025eedc-5ea0-4de8-be9f-f8873545add9

The header containing compleat api key.

Request Body schema: application/json
Codes
required
Array of objects

The list of tax codes to post into the system

ContinuationToken
string <guid>

Optional continuation token. If provided and is recognised by iCompleat, codes are upserted into the tax code list. If not provided or not recognised, then the list provided replaces any tax codes for the company.

Responses

200

Ok - codes have been added to the company.

400

Bad request. Incorrect data has been provided.

401

Unauthorized. The secure credentials passed do not allow access to this resource.

500

An internal error has occurred.

post/api/analysisfields/taxcodes/{tenantId}/{companyId}
/api/analysisfields/taxcodes/{tenantId}/{companyId}

Request samples

Content type
application/json
Example

This will wipe any tax codes for the company, and apply the list provided as a fresh set

Copy
Expand all Collapse all
{
  • "Codes":
    [
    ]
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{}

Tax Codes

Used to add a single tax code to an existing company, or update a single tax code. A code and name is provided. If the code exists, then it is updated with the new name. If the code does not exist, it is added.

Authorizations:
path Parameters
tenantId
required
string <guid>
Example: d025eedc-5ea0-4de8-be9f-f8873545add9

Id of the tenant to post tax codes into. The account requesting the data must have access to this tenant Id.

companyId
required
string <guid>
Example: 8d4bb975-eade-42fd-a064-bf448e493c1e

Id of the company to post tax codes into. Must be a valid company within the tenant.

header Parameters
x-api-version
required
integer
Value: 1
Example: 1

Indicates the version of this API to be used.

x-api-compleat-key
required
string <guid>
Example: d025eedc-5ea0-4de8-be9f-f8873545add9

The header containing compleat api key.

Request Body schema: application/json
Code
required
string

The code of the tax code to add or update

Name
required
string

The descriptive name of the tax code to add/update

Rate
required
number [ 0 .. 100 ]

The tax rate percentage to apply, in a range from 0 to 100.

Responses

200

Ok - the code has been added/updated.

400

Bad request. Incorrect data has been provided.

401

Unauthorized. The secure credentials passed do not allow access to this resource.

500

An internal error has occurred.

patch/api/analysisfields/taxcodes/{tenantId}/{companyId}
/api/analysisfields/taxcodes/{tenantId}/{companyId}

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "Code": "C0",
  • "Name": "Tax exempt",
  • "Rate": 0
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{}

Tax Codes

Used to remove a specific tax code.

Authorizations:
path Parameters
tenantId
required
string <guid>
Example: d025eedc-5ea0-4de8-be9f-f8873545add9

Id of the tenant to post tax codes into. The account requesting the data must have access to this tenant Id.

companyId
required
string <guid>
Example: 8d4bb975-eade-42fd-a064-bf448e493c1e

Id of the company to post tax codes into. Must be a valid company within the tenant.

code
required
string
Example: C0

The code of the tax code to delete.

header Parameters
x-api-version
required
integer
Value: 1
Example: 1

Indicates the version of this API to be used.

x-api-compleat-key
required
string <guid>
Example: d025eedc-5ea0-4de8-be9f-f8873545add9

The header containing compleat api key.

Responses

200

Ok - the code has been deleted.

400

Bad request. Incorrect data has been provided.

401

Unauthorized. The secure credentials passed do not allow access to this resource.

500

An internal error has occurred.

delete/api/analysisfields/taxcodes/{tenantId}/{companyId}/{code}
/api/analysisfields/taxcodes/{tenantId}/{companyId}/{code}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{}