Talent & Contingent Workforce · Clients & Programmes
Staffing Clients
The buying organizations. A client bought through an MSP is governed by that programme rather than by whatever was agreed with the hiring manager.
/api/ats/clientsPublished as /api/v1/clientsDownload specification (OpenAPI 3.1) Screen: Staffing Clients
Overview
| Package | Talent & Contingent Workforce |
|---|---|
| Authentication | Bearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key |
| Authorization | The caller's roles must hold Talent & Contingent Workforce › Staffing Clients on the Roles screen: display for GET, add for POST, change for PUT, delete for DELETE; an action needs the grant of the button that runs it on the screen. |
| Table | ats.clients · kept per company (and organisational unit where it has one) |
| Record | Created, changed and (where the screen allows) deleted; key id |
| Rules | The same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail. |
API reference
10 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/ats/clientsList staffing clients
Query parameters
| Name | Description | Example |
|---|---|---|
limit | Rows per page (50 by default, at most 200) | limit=100 |
offset | Rows to skip | offset=200 |
q | Free-text search over the search columns | q=acme |
sort | column:asc or column:desc, several separated by commas | sort=created_at:desc |
filter | A JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sorted | filter={"col":"status","op":"eq","value":"open"} |
<field>=<value> | Shorthand for "field is value" |
Response 200
{
"rows": [
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"client_no": "CLI-000001",
"name": "Example",
"name_local": "Example",
"account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"client_type": "text",
"msp_program_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"industry": "text",
"website": "https://example.com",
"owner_user_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"currency": "USD",
"payment_terms_days": 10
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/ats/clients?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/ats/clients/{id}Read one clients
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"client_no": "CLI-000001",
"name": "Example",
"name_local": "Example",
"account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"client_type": "text",
"msp_program_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"industry": "text",
"website": "https://example.com",
"owner_user_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"currency": "USD",
"payment_terms_days": 10
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/ats/clients/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/ats/clientsCreate a clients
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
location_id | uuid | No | Office |
name | text | Yes | Name |
name_local | text | No | Local name |
account_id | uuid | No | CRM account — Links the staffing client to the sales account, so the pipeline and the receivable are the same customer. |
client_type | text | No | Type |
msp_program_id | uuid | No | Programme |
industry | text | No | Industry |
website | text | No | Website |
owner_user_id | uuid | No | Account manager |
currency | text | No | Currency |
payment_terms_days | integer | No | Payment terms (days) — Empty (with no term either): the linked CRM customer’s agreed payment terms; with no customer, 30 days. |
credit_limit | numeric | No | Credit limit — Empty: the linked CRM customer’s credit limit. |
default_markup_pct | numeric | No | Default markup % |
po_required | boolean | No | PO number required on every invoice — With this on, an invoice cannot be posted without the client’s own purchase order number. |
timesheet_approval | text | No | Timesheets approved by Allowed: client_manager vms auto none |
invoice_frequency | text | No | Invoice frequency Allowed: weekly biweekly semimonthly monthly milestone |
billing_address | text | No | Billing address — Empty: the linked CRM customer’s invoicing (bill-to) address. Fill it only to bill this client elsewhere. |
billing_email | text | No | Billing email — Empty: the linked CRM customer’s invoicing e-mail. |
msa_signed_on | date | No | MSA signed |
msa_expires_on | date | No | MSA expires |
status | text | No | Status Allowed: prospect active on_hold dormant blacklisted closed |
notes | text | No | Notes |
is_active | boolean | No | Active |
Sample body
{
"name": "Example",
"location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"name_local": "Example",
"account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"client_type": "text"
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"client_no": "CLI-000001",
"name": "Example",
"name_local": "Example",
"account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"client_type": "text",
"msp_program_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"industry": "text",
"website": "https://example.com",
"owner_user_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"currency": "USD",
"payment_terms_days": 10
}Sample request
curl -X POST "https://demo.tranxact.ai/api/ats/clients" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"name":"Example","location_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","name_local":"Example","account_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","client_type":"text"}'PUT/api/ats/clients/{id}Change a clients
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
Only the fields to change; fields left out keep their value.
| Field | Type | Required | Description |
|---|---|---|---|
location_id | uuid | No | Office |
name | text | Yes | Name |
name_local | text | No | Local name |
account_id | uuid | No | CRM account — Links the staffing client to the sales account, so the pipeline and the receivable are the same customer. |
client_type | text | No | Type |
msp_program_id | uuid | No | Programme |
industry | text | No | Industry |
website | text | No | Website |
owner_user_id | uuid | No | Account manager |
currency | text | No | Currency |
payment_terms_days | integer | No | Payment terms (days) — Empty (with no term either): the linked CRM customer’s agreed payment terms; with no customer, 30 days. |
credit_limit | numeric | No | Credit limit — Empty: the linked CRM customer’s credit limit. |
default_markup_pct | numeric | No | Default markup % |
po_required | boolean | No | PO number required on every invoice — With this on, an invoice cannot be posted without the client’s own purchase order number. |
timesheet_approval | text | No | Timesheets approved by Allowed: client_manager vms auto none |
invoice_frequency | text | No | Invoice frequency Allowed: weekly biweekly semimonthly monthly milestone |
billing_address | text | No | Billing address — Empty: the linked CRM customer’s invoicing (bill-to) address. Fill it only to bill this client elsewhere. |
billing_email | text | No | Billing email — Empty: the linked CRM customer’s invoicing e-mail. |
msa_signed_on | date | No | MSA signed |
msa_expires_on | date | No | MSA expires |
status | text | No | Status Allowed: prospect active on_hold dormant blacklisted closed |
notes | text | No | Notes |
is_active | boolean | No | Active |
Sample body
{
"name": "Example",
"location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"client_no": "CLI-000001",
"name": "Example",
"name_local": "Example",
"account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"client_type": "text",
"msp_program_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"industry": "text",
"website": "https://example.com",
"owner_user_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"currency": "USD",
"payment_terms_days": 10
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/ats/clients/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"name":"Example","location_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'DELETE/api/ats/clients/{id}Delete a clients
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response 200
{ "deleted": true }Many documents are cancelled or reversed instead; the API refuses a delete the screen would refuse.
Sample request
curl -X DELETE "https://demo.tranxact.ai/api/ats/clients/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/ats/clients/{id}/copyCopy
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
The keys this action reads (* = required; "one of" lists the only values):
overrides, preview, withLinesResponse
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/ats/clients/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"overrides":"value","preview":"value","withLines":"value"}'GET/api/ats/clients/{parentId}/contactsContacts
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/ats/clients/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/contacts" \
-H "Authorization: Bearer $TOKEN"POST/api/ats/clients/{parentId}/contactsContacts
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/ats/clients/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/contacts" \
-H "Authorization: Bearer $TOKEN"PUT/api/ats/clients/{parentId}/contacts/{lineId}Contacts
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
lineId | string (uuid) | The record's lineId, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X PUT "https://demo.tranxact.ai/api/ats/clients/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/contacts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"DELETE/api/ats/clients/{parentId}/contacts/{lineId}Contacts
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
lineId | string (uuid) | The record's lineId, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X DELETE "https://demo.tranxact.ai/api/ats/clients/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/contacts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"Data model
Every field of a clients, as the API returns it. Field names are the JSON keys; any of them can be filtered and sorted on a list.
| Field | Type | Access | Description |
|---|---|---|---|
id | uuid | read only | Id |
org_id | uuid | read only | Org id |
org_unit_id | uuid | read only | Org unit id |
location_id | uuid | read, write | Office |
client_no | text | read only | Client no |
name | text | read, write | Name |
name_local | text | read, write | Local name |
account_id | uuid | read, write | CRM account — Links the staffing client to the sales account, so the pipeline and the receivable are the same customer. |
client_type | text | read, write | Type |
msp_program_id | uuid | read, write | Programme |
industry | text | read, write | Industry |
website | text | read, write | Website |
owner_user_id | uuid | read, write | Account manager |
currency | text | read, write | Currency |
payment_terms_days | integer | read, write | Payment terms (days) — Empty (with no term either): the linked CRM customer’s agreed payment terms; with no customer, 30 days. |
credit_limit | numeric | read, write | Credit limit — Empty: the linked CRM customer’s credit limit. |
default_markup_pct | numeric | read, write | Default markup % |
po_required | boolean | read, write | PO number required on every invoice — With this on, an invoice cannot be posted without the client’s own purchase order number. |
timesheet_approval | text | read, write | Timesheets approved by Allowed: client_manager vms auto none |
invoice_frequency | text | read, write | Invoice frequency Allowed: weekly biweekly semimonthly monthly milestone |
billing_address | text | read, write | Billing address — Empty: the linked CRM customer’s invoicing (bill-to) address. Fill it only to bill this client elsewhere. |
billing_email | text | read, write | Billing email — Empty: the linked CRM customer’s invoicing e-mail. |
msa_signed_on | date | read, write | MSA signed |
msa_expires_on | date | read, write | MSA expires |
status | text | read, write | Status Allowed: prospect active on_hold dormant blacklisted closed |
notes | text | read, write | Notes |
is_active | boolean | read, write | Active |
created_at | timestamp with time zone | read only | Created at |
created_by | uuid | read only | Created by |
updated_at | timestamp with time zone | read only | Updated at |
updated_by | uuid | read only | Updated by |
xf_text_1 | text | read only | Xf text 1 |
xf_text_2 | text | read only | Xf text 2 |
xf_text_3 | text | read only | Xf text 3 |
xf_text_4 | text | read only | Xf text 4 |
xf_text_5 | text | read only | Xf text 5 |
xf_num_1 | numeric | read only | Xf num 1 |
xf_num_2 | numeric | read only | Xf num 2 |
xf_num_3 | numeric | read only | Xf num 3 |
xf_date_1 | date | read only | Xf date 1 |
xf_date_2 | date | read only | Xf date 2 |
Errors
| Status | Meaning |
|---|---|
| 400 | The request could not be read: a filter that is not JSON, a bad parameter |
| 401 | No credential, or it is wrong, revoked or expired |
| 403 | The caller's roles do not hold Talent & Contingent Workforce › Staffing Clients for this verb, or the address or origin is not allowed |
| 404 | No record with that id is visible to the caller |
| 409 | A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else |
| 422 | Refused by the same validation as the screen; the error names the field and why |
Every error is JSON: {"error": "a sentence saying what was wrong"}, with field where it applies.