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

Used to retrieve all tax codes within a given company.

Authorizations:

XCompleatApiKey

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

Response samples

200
400
401
500

Content type

application/json

{"TaxCodes": [{"Code": "C0",
"Name": "Tax exempt",
"Rate": 0
},
{"Code": "C5",
"Name": "Lower rate tax",
"Rate": 5
},
{"Code": "C20",
"Name": "Standard 20% tax rate",
"Rate": 20
}
],
"MetaData": {"RequestUrl": "https://[route]/api/analysisfields/taxcodes/e3bac1c0-f570-4ea6-af0b-b1817870e745/0a722409-9907-4353-afaa-e6bdf5521bb5/2/64b1f08f-6ed2-44db-94d0-eeaa47eed557/8d15d5d8-c044-4de8-9cf8-d9f20ec37990",
"Version": 1,
"DateCreated": "2018-08-08T11:43:01.5753381Z"
}
}

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:

XCompleatApiKey

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

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

Request samples

Payload

Content type

application/json

Example

Without continuation token

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

{"Codes": [{"Code": "C0",
"Name": "Tax exempt",
"Rate": 0
},
{"Code": "C5",
"Name": "Lower rate tax",
"Rate": 5
},
{"Code": "C20",
"Name": "Standard 20% tax rate",
"Rate": 20
}
]
}

Response samples

200
400
401
500

Content type

application/json

{"ContinuationToken": "25527ccb-d5fb-4b54-b4f0-738f99d06d17",
"MetaData": {"RequestUrl": "https://[route]/api/analysisfields/taxcodes/e3bac1c0-f570-4ea6-af0b-b1817870e745/ef200b8c-1903-4e2d-8bfd-00befd4cd983",
"Version": 1,
"DateCreated": "2018-08-08T11:43:01.5753381Z"
}
}

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:

XCompleatApiKey

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

Request samples

Payload

Content type

application/json

{"Code": "C0",
"Name": "Tax exempt",
"Rate": 0
}

Response samples

200
400
401
500

Content type

application/json

{"Result": "Tax Code [C0] matched and updated.",
"MetaData": {"RequestUrl": "https://[route]/api/analysisfields/taxcodes/e3bac1c0-f570-4ea6-af0b-b1817870e745/ef200b8c-1903-4e2d-8bfd-00befd4cd983",
"Version": 1,
"DateCreated": "2018-08-08T11:43:01.5753381Z"
}
}

Tax Codes

Used to remove all tax codes for a company.

Authorizations:

XCompleatApiKey

path Parameters

tenantId required	string <guid> Example: d025eedc-5ea0-4de8-be9f-f8873545add9 Id of the tenant to delete tax codes 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 delete tax codes for. 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.

Responses

Response samples

200
400
401
500

Content type

application/json

{"Result": "Tax Codes have been deleted.",
"MetaData": {"RequestUrl": "https://[route]/api/analysisfields/taxcodes/e3bac1c0-f570-4ea6-af0b-b1817870e745/ef200b8c-1903-4e2d-8bfd-00befd4cd983",
"Version": 1,
"DateCreated": "2018-08-08T11:43:01.5753381Z"
}
}

Tax Codes

Used to remove a specific tax code.

Authorizations:

XCompleatApiKey

path Parameters

tenantId required	string <guid> Example: d025eedc-5ea0-4de8-be9f-f8873545add9 Id of the tenant to delete tax codes 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 delete tax codes for. 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

Response samples

200
400
401
500

Content type

application/json

{"Result": "Tax Code [C0] has been deleted.",
"MetaData": {"RequestUrl": "https://[route]/api/analysisfields/taxcodes/e3bac1c0-f570-4ea6-af0b-b1817870e745/ef200b8c-1903-4e2d-8bfd-00befd4cd983/C0",
"Version": 1,
"DateCreated": "2018-08-08T11:43:01.5753381Z"
}
}