Account Codes (1.0)

Download OpenAPI specification:Download

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

Account Codes

Used to retrieve all account 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 account 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).

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

{"AccountCodes": [{"Code": "7602",
"Name": "Accountancy Fees [7602]"
},
{"Code": "2109",
"Name": "Accruals [2109]"
},
{"Code": "7009",
"Name": "Adjustments [7009]"
},
{"Code": "6201",
"Name": "Advertising [6201]"
},
{"Code": "7601",
"Name": "Audit Fees [7601]"
}
],
"MetaData": {"RequestUrl": "https://[route]/api/analysisfields/accountcodes/e3bac1c0-f570-4ea6-af0b-b1817870e745/0a722409-9907-4353-afaa-e6bdf5521bb5/2",
"Version": 1,
"DateCreated": "2018-08-08T11:43:01.5753381Z"
}
}

Account Codes

Used to retrieve all account codes within a given company for a user

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 account 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 User Id used to filter records based on those available to the user 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

{"AccountCodes": [{"Code": "7602",
"Name": "Accountancy Fees [7602]"
},
{"Code": "2109",
"Name": "Accruals [2109]"
},
{"Code": "7009",
"Name": "Adjustments [7009]"
},
{"Code": "6201",
"Name": "Advertising [6201]"
},
{"Code": "7601",
"Name": "Audit Fees [7601]"
}
],
"MetaData": {"RequestUrl": "https://[route]/api/analysisfields/accountcodes/e3bac1c0-f570-4ea6-af0b-b1817870e745/0a722409-9907-4353-afaa-e6bdf5521bb5/2/64b1f08f-6ed2-44db-94d0-eeaa47eed557",
"Version": 1,
"DateCreated": "2018-08-08T11:43:01.5753381Z"
}
}

Account Codes

Used to retrieve all account codes within a given company for a user and transaction

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 account 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 User Id used to filter records based on those available to the user only.
transactionId required	string <guid> Example: 0a722409-9907-4353-afaa-e6bdf5521bb5 Transaction Id 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

{"AccountCodes": [{"Code": "7602",
"Name": "Accountancy Fees [7602]"
},
{"Code": "2109",
"Name": "Accruals [2109]"
},
{"Code": "7009",
"Name": "Adjustments [7009]"
},
{"Code": "6201",
"Name": "Advertising [6201]"
},
{"Code": "7601",
"Name": "Audit Fees [7601]"
}
],
"MetaData": {"RequestUrl": "https://[route]/api/analysisfields/accountcodes/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"
}
}

Account Codes

Used to refresh the account 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 account 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 account 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 account codes to post into the system
ContinuationToken	string <guid> Optional continuation token. If provided and is recognised by iCompleat, codes are upserted into the account code list. If not provided or not recognised, then the list provided replaces any account codes for the company.

Responses

Request samples

Payload

Content type

application/json

Example

Without continuation token

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

{"Codes": [{"Code": "7602",
"Name": "Accountancy Fees [7602]"
},
{"Code": "2109",
"Name": "Accruals [2109]"
},
{"Code": "7009",
"Name": "Adjustments [7009]"
}
]
}

Response samples

200
400
401
500

Content type

application/json

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

Account Codes

Used to add a single account code to an existing company, or update a single account 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 account 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 account codes into. Must be a valid company within the tenant.

header Parameters

x-api-compleat-key required	string <guid> Example: d025eedc-5ea0-4de8-be9f-f8873545add9 The header containing compleat api key.
x-api-version required	integer Value: 1 Example: 1 Indicates the version of this API to be used.

Request Body schema: application/json

Code required	string The code of the account code to add or update
Name required	string The descriptive name of the account code to add/update

Responses

Request samples

Payload

Content type

application/json

{"Code": "4417",
"Name": "Hardware and peripherals"
}

Response samples

200
400
401
500

Content type

application/json

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

Account Codes

Used to remove all account codes for a company.

Authorizations:

XCompleatApiKey

path Parameters

tenantId required	string <guid> Example: d025eedc-5ea0-4de8-be9f-f8873545add9 Id of the tenant to delete account 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 account 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": "Account code [4417] has been deleted.",
"MetaData": {"RequestUrl": "https://[route]/api/analysisfields/accountcodes/e3bac1c0-f570-4ea6-af0b-b1817870e745/ef200b8c-1903-4e2d-8bfd-00befd4cd983",
"Version": 1,
"DateCreated": "2018-08-08T11:43:01.5753381Z"
}
}

Account Codes

Used to remove a specific account code.

Authorizations:

XCompleatApiKey

path Parameters

tenantId required	string <guid> Example: d025eedc-5ea0-4de8-be9f-f8873545add9 Id of the tenant to post account 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 account codes into. Must be a valid company within the tenant.
code required	string Example: 4417 The code of the account 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": "Account code [4417] has been deleted.",
"MetaData": {"RequestUrl": "https://[route]/api/analysisfields/accountcodes/e3bac1c0-f570-4ea6-af0b-b1817870e745/ef200b8c-1903-4e2d-8bfd-00befd4cd983/4417",
"Version": 1,
"DateCreated": "2018-08-08T11:43:01.5753381Z"
}
}