Analysis Fields (1.0)

Download OpenAPI specification:Download

APIs that allow you to see a summary of analysis fields.

Authentication

XCompleatApiKey

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

Analysis Fields

Analysis Fields

Used to retrieve a list of relevant analysis fields, either for a company, or in relation to a specific transaction.

Specify the tenant and company IDs in the URL. If the company ID is missing or not recognised for this tenant, then HTTP 400 with error code of 2 is returned.

Optionally include a transaction ID, to request analysis fields relevant to a specific transaction. If the transaction ID is not recognised within the tenant and company specified, then an HTTP 400 with error code of 10 is returned.

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 analysis information for. Must be a valid company within the tenant.

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

Optional transaction Id (insert NULL value if unavailable). If provided, must be a valid transaction under the tenant and company specified. If provided, analysis fields linked to the layout for the transaction will be returned, along with information pertaining to whether they are configured at header or line level for that transaction.

If not provided, then all active analysis fields linked to the company are returned.

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 analysis fields 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/{tenantId}/{companyId}/{transactionId}
/api/analysisfields/{tenantId}/{companyId}/{transactionId}

Response samples

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