Custom Fields (1.0)

Download OpenAPI specification:Download

APIs that allow you to to get, create and maintain custom fields.

Custom Fields

Used to retrieve all custom fields within a given company. Note that only active custom fields are returned in the list.

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 custom fields 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

{"CustomFields": [{"Id": "string",
"Name": "string"
}
],
"MetaData": {"RequestUrl": "string",
"Version": 1,
"DateCreated": "2019-08-24"
}
}

Custom Field

Used to retrieve all details on a specific custom field 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 custom fields for. Must be a valid company within the tenant.
customFieldId required	string <guid> Example: 939e8c95-e1c7-4090-97a7-22435ffb23be Id of a specific custom field to retrieve information for.

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

{"CustomField": {"Id": "939e8c95-e1c7-4090-97a7-22435ffb23be",
"Name": "Example custom field 1",
"Active": true,
"Type": "List",
"Mandatory": true,
"Values": [{"Code": "V1",
"Name": "Value 1"
},
{"Code": "V2",
"Name": "Value 2"
},
{"Code": "V3",
"Name": "Value 3"
}
]
},
"MetaData": {"RequestUrl": "https://[route]/api/customfield/e3bac1c0-f570-4ea6-af0b-b1817870e745/0a722409-9907-4353-afaa-e6bdf5521bb5/939e8c95-e1c7-4090-97a7-22435ffb23be",
"Version": 1,
"DateCreated": "2018-08-08T11:43:01.5753381Z"
}
}

Custom Field

Used to refresh the list of options in a custom field 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 custom fields 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 custom fields into. Must be a valid company within the tenant.
customFieldId required	string <guid> Example: 939e8c95-e1c7-4090-97a7-22435ffb23be Id of a specific custom field to update list information for.

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 (CustomFieldListItem)
ContinuationToken	string <guid> Optional continuation token. If provided and is recognised by iCompleat, custom fields are upserted into the custom field list. If not provided or not recognised, then the list provided replaces any custom field list item values for the specified custom field and company.

Responses

Request samples

Payload

Content type

application/json

Example

Without continuation token

This will wipe any custom field list itemss for the custom field, and apply the list provided as a fresh set

{"CustomFieldListItems": [{"Code": "L1",
"Name": "Example custom field list item 1"
},
{"Code": "L2",
"Name": "Example custom field list item 2"
},
{"Code": "L3",
"Name": "Example custom field list item 3"
}
]
}

Response samples

200
400
401
500

Content type

application/json

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

Custom Field

Used to add a single custom field list item to an existing custom field, or update a single custom field list item. A code and name is to be provided. If the code exists, then the name in the existing record is replaced with the new name provided. If the code does not exist, the record 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.
customFieldId required	string <guid> Example: 939e8c95-e1c7-4090-97a7-22435ffb23be Id of a specific custom field to update list information for.

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 [ 1 .. 20 ] characters A unique code for each custom field list item
name required	string [ 1 .. 200 ] characters A descriptive name for each custom field list item

Responses

Request samples

Payload

Content type

application/json

{"Code": "L1",
"Name": "Example custom field list item 1"
}

Response samples

200
400
401
500

Content type

application/json

{"Result": "Custom field list item [L1] matched and updated.",
"MetaData": {"RequestUrl": "https://[route]/api/customfield/e3bac1c0-f570-4ea6-af0b-b1817870e745/ef200b8c-1903-4e2d-8bfd-00befd4cd983/ebb81efe-9c1b-4776-b2d5-a71dc0412d2e",
"Version": 1,
"DateCreated": "2018-08-08T11:43:01.5753381Z"
}
}

Custom Field

Used to remove a specific custom field list item.

Authorizations:

XCompleatApiKey

path Parameters

tenantId required	string <guid> Example: d025eedc-5ea0-4de8-be9f-f8873545add9 Id of the tenant to update the custom field 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 update the custom field for. Must be a valid company within the tenant.
customFieldId required	string <guid> Example: 939e8c95-e1c7-4090-97a7-22435ffb23be Id of a specific custom field to update list information for.
code required	string Example: L1 The code of the custom field list item 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": "Custom field list item [L1] has been deleted.",
"MetaData": {"RequestUrl": "https://[route]/api/customfield/e3bac1c0-f570-4ea6-af0b-b1817870e745/ef200b8c-1903-4e2d-8bfd-00befd4cd983/ebb81efe-9c1b-4776-b2d5-a71dc0412d2e/L1",
"Version": 1,
"DateCreated": "2018-08-08T11:43:01.5753381Z"
}
}