Copy Client API

The Copy Client API enables you to copy a client, including:

• Associated client bespoke fields

• Quote defaults

• Contract defaults

Swagger Documentation

Supplementary Swagger documentation is available here:
https://api.catch-e.com/docs/#/Clients(https://api.catch-e.com/docs/#/Clients)

Permissions

To run this API, the nominated web-services role must be granted permission.

If the API is not actively used, it is recommended to leave permissions disabled for security.

Required Role Access

• Go to Roles / APIs

• Enable: Clients:Create

Note: This API is not configured for external use.
Contact your Account Manager to request access.

HTTP Method

• POST

Endpoint URL

https://api.catch-e.com/fm/clients/{client_id}/copy

Headers

Request Body (JSON)

Response Details

Successful Response (201 Created)

A successful response returns all fields in:

• Client record

• Client defaults

• Packaging defaults

• Embedded related records

Example Response (201)

{
 "bespoke_field_values": [],
 "inclusion_client_exclusions": [],
 "client_defaults": {
 "client_default_id": "100549",
 "client_group_flag": "no",
 "relief_vehicle_flag": "yes",
 "delivery_fee_funded_flag": "no",
 "fuel_on_delivery_funded_flag": "no",
 "supplier_id_financier": "0",
 "policy_owner_type": "driver",
 "supplier_id_insurer": null,
 "residual_margin_rate": 0,
 "residual_margin_rate_commercial": 0,
 "excess_km_rate": 0,
 "establishment_fee": 0,
 "management_fee": 0,
 "maintenance_program_fee": 0,
 "novated_commission_rate": 0.0123,
 "insurance_broker_fee_exempt_flag": "yes",
 "carbon_emission_offset_flag": "yes",
 "roadside_assistance_plan_code": "",
 "accident_management_fee": 0
 },
 "client_id": "100552",
 "client_code": "Test007",
 "name": "Test API-20554"
}

(Full response object is preserved as provided in the system output, including all embedded fields and links.)

Error Responses

403 – Forbidden

{
 "detail": "Forbidden"
}

Meaning:
User does not have permission to run this request.

422 – Unprocessable Entity

{
 "validationMessages": {
 "fields": {
 "notInArray": "Unknown field specified"
 }
 }
}

Meaning:

• Invalid field syntax

• Spaces in field lists may cause errors

• Unknown or unsupported fields were submitted

Summary of Behaviour

• Copies full client structure

• Includes:

  • Bespoke fields

  • Quote defaults

  • Contract defaults

• Returns full newly created client record

• Requires strict permission control

• Not enabled for external API usage