copyClient

Overview

This method creates a new client by copying an existing (source) client. The new client is given the client code you supply.

This method requires the Clients:Create permission to be associated with your role.

Permissions

The permission for this api is stored in [gb_api_permissions]permission as 'Clients:Create'.

Only roles with a stored link to this permission in [gb_role_api_permissions] can run this api.

HTTP Method

Use the HTTP Method 'POST' for consuming this web service.

URL Examples

https://api.demo.catch-e.com/fm/clients/1234/copy https://api.{{environment}}.catch-e.com/fm/clients/1234/copy https://api.test.catch-e.com/fm/clients/1234/copy

Input Fields (Header)

Key	Format	Notes	Mandatory
Audit-User-Id	string	(Optional) User Id to use for audit purposes. Up to 5 digits. Requires the Audit:UserIdOverride permission.	No
Time-Zone	string	(Optional) Client will be processed in the specified timezone. Default `UTC`. Accepts a named time zone (e.g. 'Australia/Sydney') or an offset from UTC (e.g. '+10:00').	No

Path Parameters

Key	Format	Notes	Mandatory
client_id	string	The Source Client Id: the client to copy. A positive whole number, up to 10 digits, with no leading zeros.	Yes

Input Fields (Form Data)

The request body is sent as form data (application/x-www-form-urlencoded).

Key	Format	Notes	Mandatory
client_code	string	The client code for the new (target) client. Up to 64 characters.	Yes

Response Details

Success

201 - Created

Returns the new client. The response contains the same fields as getClient; see that article for the full field list.

{ "_links": { "self": { "href": "https://api.catch-e.loc/fm/clients/5678" } }, "client_id": "5678", "client_code": "ACME-NEW", "name": "Acme Pty Ltd", "client_type": "fleet", "state": "NSW", "contact1_name": "[CONTACT-NAME]", "contact1_email": "[EMAIL]", "billing_interval": "monthly", "payment_method": "eft", "bank_bsb": "[BSB]", "bank_account_number": "[ACCOUNT-NUMBER]", "...": "..." }

The example is shortened. Only a selection of fields is shown.

Error Response Details

Validation Message	Comments
401 - Unauthorized	1. You have not authenticated before running this API or 2. The token_timeout of the current session has passed. You need to authenticate again.

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Unauthorized", "status": 401, "detail": "Unauthorized" }

Validation Message	Comments
403 - Forbidden	- You do not have permissions for this request. - Go to System Roles and enter 'web_services' - Navigate to the Roles / APIs tab to make sure the permission you need to run this API is checked.

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Forbidden", "status": 403, "detail": "Forbidden" }

Validation Message	Comments
406 - Not Acceptable	The Accept header of the request does not match a response format this API supports.

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Not Acceptable", "status": 406, "detail": "Not Acceptable" }

Validation Message	Comments
415 - Unsupported Media Type	The Content-Type of the request is not supported by this API.

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Unsupported Media Type", "status": 415, "detail": "Not Acceptable" }

Validation Message	Comments
422 - Unprocessable Entity	One or more input fields failed validation. The field name and message are returned in `validation_messages`.

{ "warning_messages": {}, "validation_messages": { "fieldName": { "validationExceptionCode": "A textual description of the validation exception" } }, "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Unprocessable Entity", "status": 422, "detail": "Failed Validation" }

Validation Message	Comments
500 - Internal Error	An unexpected error occurred on the server.

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "string", "status": 599, "detail": "string" }

Validation Message	Comments
default - Unexpected Error	Any other unexpected error.

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "string", "status": 599, "detail": "string" }