Repzo API - Client (1.0.0)

Download OpenAPI specification:Download

OpenAPI specification for Repzo Client endpoints.

Find clients

query Parameters

params

object

Query parameters for filtering clients

Responses

Response samples

Content type

application/json

{"data": [{"_id": "string",
"name": "string",
"local_name": "string",
"tags": ["string"
],
"cell_phone": "string",
"city": "string",
"client_code": "string",
"contact_name": "string",
"contact_title": "string",
"contacts": ["string"
],
"country": "string",
"disabled": true,
"formatted_address": "string",
"lat": 0,
"lng": 0,
"location_verified": true,
"phone": "string",
"state": "string",
"zip": "string",
"assigned_to": ["string"
],
"last_location_update": 0,
"credit_limit": 0,
"tax_number": "string",
"sync_id": "string",
"profile_pic": "string",
"logo": "string",
"website": "string",
"email": "string",
"comment": "string",
"parent_client_id": "string",
"target_visit": 0,
"geofencing_radius": 0,
"price_tag": "string",
"status": "string",
"job_category": ["string"
],
"territory": "string",
"sv_priceList": "string",
"customFields": { },
"paymentTerm": "string",
"speciality": ["string"
],
"company_namespace": ["string"
],
"channel": "string",
"isChain": true,
"chain": "string",
"teams": ["string"
],
"payment_type": "cash",
"integration_meta": { },
"integrated_client_balance": 0,
"invoice_balance_limit": 0,
"enable_invoice_balance_limit": true,
"enable_payment_terms_grace_period_days": true,
"is_simplified": true,
"last_login_time": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}
],
"total_result": 0,
"current_count": 0,
"total_pages": 0,
"current_page": 0,
"per_page": 0,
"first_page_url": "string",
"last_page_url": "string",
"next_page_url": "string",
"prev_page_url": "string",
"path": "string"
}

Create a client

Request Body schema: application/json

name required	string Name of the client
local_name	string Localized name of the client
tags	Array of strings Tags associated with the client
cell_phone	string Cell phone number
city	string City
client_code	string Client code
contact_name	string Contact name
contact_title	string Contact title
contacts	Array of strings Associated contacts
country	string Country
disabled	boolean Whether the client is disabled
formatted_address	string Formatted address
lat	number Latitude coordinate
lng	number Longitude coordinate
location_verified	boolean Whether the location is verified
phone	string Phone number
state	string State
zip	string Zip/Postal code
assigned_to	Array of strings Representatives assigned to this client
credit_limit	number Credit limit
tax_number	string Tax number
sync_id	string Sync identifier
profile_pic	string Profile picture URL
logo	string Logo URL
website	string Website URL
email	string Email address
comment	string Comments
parent_client_id	string Parent client ID for hierarchical relationships
target_visit	number Target number of visits
geofencing_radius	number Geofencing radius
price_tag	string Price tag
status	string Status
job_category	Array of strings Job categories
territory	string Territory
sv_priceList	string Price list ID
	object Custom fields
paymentTerm	string Payment term ID
speciality	Array of strings Specialities
company_namespace	Array of strings Company namespaces
channel	string Channel ID
isChain	boolean Whether this is a chain
chain	string Chain ID
teams	Array of strings Teams
payment_type	string Enum: "cash" "credit" Payment type
	object Integration metadata

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"local_name": "string",
"tags": ["string"
],
"cell_phone": "string",
"city": "string",
"client_code": "string",
"contact_name": "string",
"contact_title": "string",
"contacts": ["string"
],
"country": "string",
"disabled": true,
"formatted_address": "string",
"lat": 0,
"lng": 0,
"location_verified": true,
"phone": "string",
"state": "string",
"zip": "string",
"assigned_to": ["string"
],
"credit_limit": 0,
"tax_number": "string",
"sync_id": "string",
"profile_pic": "string",
"logo": "string",
"website": "string",
"email": "string",
"comment": "string",
"parent_client_id": "string",
"target_visit": 0,
"geofencing_radius": 0,
"price_tag": "string",
"status": "string",
"job_category": ["string"
],
"territory": "string",
"sv_priceList": "string",
"customFields": { },
"paymentTerm": "string",
"speciality": ["string"
],
"company_namespace": ["string"
],
"channel": "string",
"isChain": true,
"chain": "string",
"teams": ["string"
],
"payment_type": "cash",
"integration_meta": { }
}

Response samples

Content type

application/json

{"_id": "string",
"name": "string",
"local_name": "string",
"tags": ["string"
],
"cell_phone": "string",
"city": "string",
"client_code": "string",
"contact_name": "string",
"contact_title": "string",
"contacts": ["string"
],
"country": "string",
"disabled": true,
"formatted_address": "string",
"lat": 0,
"lng": 0,
"location_verified": true,
"phone": "string",
"state": "string",
"zip": "string",
"assigned_to": ["string"
],
"last_location_update": 0,
"credit_limit": 0,
"tax_number": "string",
"sync_id": "string",
"profile_pic": "string",
"logo": "string",
"website": "string",
"email": "string",
"comment": "string",
"parent_client_id": "string",
"target_visit": 0,
"geofencing_radius": 0,
"price_tag": "string",
"status": "string",
"job_category": ["string"
],
"territory": "string",
"sv_priceList": "string",
"customFields": { },
"paymentTerm": "string",
"speciality": ["string"
],
"company_namespace": ["string"
],
"channel": "string",
"isChain": true,
"chain": "string",
"teams": ["string"
],
"payment_type": "cash",
"integration_meta": { },
"integrated_client_balance": 0,
"invoice_balance_limit": 0,
"enable_invoice_balance_limit": true,
"enable_payment_terms_grace_period_days": true,
"is_simplified": true,
"last_login_time": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Get a client by ID

path Parameters

required

string

Responses

Response samples

Content type

application/json

{"_id": "string",
"name": "string",
"local_name": "string",
"tags": ["string"
],
"cell_phone": "string",
"city": "string",
"client_code": "string",
"contact_name": "string",
"contact_title": "string",
"contacts": ["string"
],
"country": "string",
"disabled": true,
"formatted_address": "string",
"lat": 0,
"lng": 0,
"location_verified": true,
"phone": "string",
"state": "string",
"zip": "string",
"assigned_to": ["string"
],
"last_location_update": 0,
"credit_limit": 0,
"tax_number": "string",
"sync_id": "string",
"profile_pic": "string",
"logo": "string",
"website": "string",
"email": "string",
"comment": "string",
"parent_client_id": "string",
"target_visit": 0,
"geofencing_radius": 0,
"price_tag": "string",
"status": "string",
"job_category": ["string"
],
"territory": "string",
"sv_priceList": "string",
"customFields": { },
"paymentTerm": "string",
"speciality": ["string"
],
"company_namespace": ["string"
],
"channel": "string",
"isChain": true,
"chain": "string",
"teams": ["string"
],
"payment_type": "cash",
"integration_meta": { },
"integrated_client_balance": 0,
"invoice_balance_limit": 0,
"enable_invoice_balance_limit": true,
"enable_payment_terms_grace_period_days": true,
"is_simplified": true,
"last_login_time": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Update a client

path Parameters

required

string

Request Body schema: application/json

name	string Name of the client
local_name	string Localized name of the client
tags	Array of strings Tags associated with the client
cell_phone	string Cell phone number
city	string City
client_code	string Client code
contact_name	string Contact name
contact_title	string Contact title
contacts	Array of strings Associated contacts
country	string Country
disabled	boolean Whether the client is disabled
formatted_address	string Formatted address
lat	number Latitude coordinate
lng	number Longitude coordinate
location_verified	boolean Whether the location is verified
phone	string Phone number
state	string State
zip	string Zip/Postal code
assigned_to	Array of strings Representatives assigned to this client
credit_limit	number Credit limit
tax_number	string Tax number
sync_id	string Sync identifier
profile_pic	string Profile picture URL
logo	string Logo URL
website	string Website URL
email	string Email address
comment	string Comments
parent_client_id	string Parent client ID for hierarchical relationships
target_visit	number Target number of visits
geofencing_radius	number Geofencing radius
price_tag	string Price tag
status	string Status
job_category	Array of strings Job categories
territory	string Territory
sv_priceList	string Price list ID
	object Custom fields
paymentTerm	string Payment term ID
speciality	Array of strings Specialities
company_namespace	Array of strings Company namespaces
channel	string Channel ID
isChain	boolean Whether this is a chain
chain	string Chain ID
teams	Array of strings Teams
payment_type	string Enum: "cash" "credit" Payment type
	object Integration metadata
_id	string Unique identifier for the client
createdAt	string <date-time> Creation timestamp
updatedAt	string <date-time> Last update timestamp
__v	number Version number

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"local_name": "string",
"tags": ["string"
],
"cell_phone": "string",
"city": "string",
"client_code": "string",
"contact_name": "string",
"contact_title": "string",
"contacts": ["string"
],
"country": "string",
"disabled": true,
"formatted_address": "string",
"lat": 0,
"lng": 0,
"location_verified": true,
"phone": "string",
"state": "string",
"zip": "string",
"assigned_to": ["string"
],
"credit_limit": 0,
"tax_number": "string",
"sync_id": "string",
"profile_pic": "string",
"logo": "string",
"website": "string",
"email": "string",
"comment": "string",
"parent_client_id": "string",
"target_visit": 0,
"geofencing_radius": 0,
"price_tag": "string",
"status": "string",
"job_category": ["string"
],
"territory": "string",
"sv_priceList": "string",
"customFields": { },
"paymentTerm": "string",
"speciality": ["string"
],
"company_namespace": ["string"
],
"channel": "string",
"isChain": true,
"chain": "string",
"teams": ["string"
],
"payment_type": "cash",
"integration_meta": { },
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Response samples

Content type

application/json

{"_id": "string",
"name": "string",
"local_name": "string",
"tags": ["string"
],
"cell_phone": "string",
"city": "string",
"client_code": "string",
"contact_name": "string",
"contact_title": "string",
"contacts": ["string"
],
"country": "string",
"disabled": true,
"formatted_address": "string",
"lat": 0,
"lng": 0,
"location_verified": true,
"phone": "string",
"state": "string",
"zip": "string",
"assigned_to": ["string"
],
"last_location_update": 0,
"credit_limit": 0,
"tax_number": "string",
"sync_id": "string",
"profile_pic": "string",
"logo": "string",
"website": "string",
"email": "string",
"comment": "string",
"parent_client_id": "string",
"target_visit": 0,
"geofencing_radius": 0,
"price_tag": "string",
"status": "string",
"job_category": ["string"
],
"territory": "string",
"sv_priceList": "string",
"customFields": { },
"paymentTerm": "string",
"speciality": ["string"
],
"company_namespace": ["string"
],
"channel": "string",
"isChain": true,
"chain": "string",
"teams": ["string"
],
"payment_type": "cash",
"integration_meta": { },
"integrated_client_balance": 0,
"invoice_balance_limit": 0,
"enable_invoice_balance_limit": true,
"enable_payment_terms_grace_period_days": true,
"is_simplified": true,
"last_login_time": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Remove a client

path Parameters

required

string

Responses

Response samples

Content type

application/json

{"_id": "string",
"name": "string",
"local_name": "string",
"tags": ["string"
],
"cell_phone": "string",
"city": "string",
"client_code": "string",
"contact_name": "string",
"contact_title": "string",
"contacts": ["string"
],
"country": "string",
"disabled": true,
"formatted_address": "string",
"lat": 0,
"lng": 0,
"location_verified": true,
"phone": "string",
"state": "string",
"zip": "string",
"assigned_to": ["string"
],
"last_location_update": 0,
"credit_limit": 0,
"tax_number": "string",
"sync_id": "string",
"profile_pic": "string",
"logo": "string",
"website": "string",
"email": "string",
"comment": "string",
"parent_client_id": "string",
"target_visit": 0,
"geofencing_radius": 0,
"price_tag": "string",
"status": "string",
"job_category": ["string"
],
"territory": "string",
"sv_priceList": "string",
"customFields": { },
"paymentTerm": "string",
"speciality": ["string"
],
"company_namespace": ["string"
],
"channel": "string",
"isChain": true,
"chain": "string",
"teams": ["string"
],
"payment_type": "cash",
"integration_meta": { },
"integrated_client_balance": 0,
"invoice_balance_limit": 0,
"enable_invoice_balance_limit": true,
"enable_payment_terms_grace_period_days": true,
"is_simplified": true,
"last_login_time": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}