TRANXACT.AI Help

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.

Type REST10 operationsBase path /api/ats/clientsPublished as /api/v1/clients

Download specification (OpenAPI 3.1) Screen: Staffing Clients

Overview

PackageTalent & Contingent Workforce
AuthenticationBearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key
AuthorizationThe 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.
Tableats.clients · kept per company (and organisational unit where it has one)
RecordCreated, changed and (where the screen allows) deleted; key id
RulesThe 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

NameDescriptionExample
limitRows per page (50 by default, at most 200)limit=100
offsetRows to skipoffset=200
qFree-text search over the search columnsq=acme
sortcolumn:asc or column:desc, several separated by commassort=created_at:desc
filterA JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sortedfilter={"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

NameTypeDescription
idstring (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.

FieldTypeRequiredDescription
location_iduuidNoOffice
nametextYesName
name_localtextNoLocal name
account_iduuidNoCRM account — Links the staffing client to the sales account, so the pipeline and the receivable are the same customer.
client_typetextNoType
msp_program_iduuidNoProgramme
industrytextNoIndustry
websitetextNoWebsite
owner_user_iduuidNoAccount manager
currencytextNoCurrency
payment_terms_daysintegerNoPayment terms (days) — Empty (with no term either): the linked CRM customer’s agreed payment terms; with no customer, 30 days.
credit_limitnumericNoCredit limit — Empty: the linked CRM customer’s credit limit.
default_markup_pctnumericNoDefault markup %
po_requiredbooleanNoPO number required on every invoice — With this on, an invoice cannot be posted without the client’s own purchase order number.
timesheet_approvaltextNoTimesheets approved by
Allowed: client_manager vms auto none
invoice_frequencytextNoInvoice frequency
Allowed: weekly biweekly semimonthly monthly milestone
billing_addresstextNoBilling address — Empty: the linked CRM customer’s invoicing (bill-to) address. Fill it only to bill this client elsewhere.
billing_emailtextNoBilling email — Empty: the linked CRM customer’s invoicing e-mail.
msa_signed_ondateNoMSA signed
msa_expires_ondateNoMSA expires
statustextNoStatus
Allowed: prospect active on_hold dormant blacklisted closed
notestextNoNotes
is_activebooleanNoActive

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

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

Only the fields to change; fields left out keep their value.

FieldTypeRequiredDescription
location_iduuidNoOffice
nametextYesName
name_localtextNoLocal name
account_iduuidNoCRM account — Links the staffing client to the sales account, so the pipeline and the receivable are the same customer.
client_typetextNoType
msp_program_iduuidNoProgramme
industrytextNoIndustry
websitetextNoWebsite
owner_user_iduuidNoAccount manager
currencytextNoCurrency
payment_terms_daysintegerNoPayment terms (days) — Empty (with no term either): the linked CRM customer’s agreed payment terms; with no customer, 30 days.
credit_limitnumericNoCredit limit — Empty: the linked CRM customer’s credit limit.
default_markup_pctnumericNoDefault markup %
po_requiredbooleanNoPO number required on every invoice — With this on, an invoice cannot be posted without the client’s own purchase order number.
timesheet_approvaltextNoTimesheets approved by
Allowed: client_manager vms auto none
invoice_frequencytextNoInvoice frequency
Allowed: weekly biweekly semimonthly monthly milestone
billing_addresstextNoBilling address — Empty: the linked CRM customer’s invoicing (bill-to) address. Fill it only to bill this client elsewhere.
billing_emailtextNoBilling email — Empty: the linked CRM customer’s invoicing e-mail.
msa_signed_ondateNoMSA signed
msa_expires_ondateNoMSA expires
statustextNoStatus
Allowed: prospect active on_hold dormant blacklisted closed
notestextNoNotes
is_activebooleanNoActive

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

NameTypeDescription
idstring (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

NameTypeDescription
idstring (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, withLines

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/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

NameTypeDescription
parentIdstring (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

NameTypeDescription
parentIdstring (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

NameTypeDescription
parentIdstring (uuid)The record's parentId, as a list returns it.
lineIdstring (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

NameTypeDescription
parentIdstring (uuid)The record's parentId, as a list returns it.
lineIdstring (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.

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
org_unit_iduuidread onlyOrg unit id
location_iduuidread, writeOffice
client_notextread onlyClient no
nametextread, writeName
name_localtextread, writeLocal name
account_iduuidread, writeCRM account — Links the staffing client to the sales account, so the pipeline and the receivable are the same customer.
client_typetextread, writeType
msp_program_iduuidread, writeProgramme
industrytextread, writeIndustry
websitetextread, writeWebsite
owner_user_iduuidread, writeAccount manager
currencytextread, writeCurrency
payment_terms_daysintegerread, writePayment terms (days) — Empty (with no term either): the linked CRM customer’s agreed payment terms; with no customer, 30 days.
credit_limitnumericread, writeCredit limit — Empty: the linked CRM customer’s credit limit.
default_markup_pctnumericread, writeDefault markup %
po_requiredbooleanread, writePO number required on every invoice — With this on, an invoice cannot be posted without the client’s own purchase order number.
timesheet_approvaltextread, writeTimesheets approved by
Allowed: client_manager vms auto none
invoice_frequencytextread, writeInvoice frequency
Allowed: weekly biweekly semimonthly monthly milestone
billing_addresstextread, writeBilling address — Empty: the linked CRM customer’s invoicing (bill-to) address. Fill it only to bill this client elsewhere.
billing_emailtextread, writeBilling email — Empty: the linked CRM customer’s invoicing e-mail.
msa_signed_ondateread, writeMSA signed
msa_expires_ondateread, writeMSA expires
statustextread, writeStatus
Allowed: prospect active on_hold dormant blacklisted closed
notestextread, writeNotes
is_activebooleanread, writeActive
created_attimestamp with time zoneread onlyCreated at
created_byuuidread onlyCreated by
updated_attimestamp with time zoneread onlyUpdated at
updated_byuuidread onlyUpdated by
xf_text_1textread onlyXf text 1
xf_text_2textread onlyXf text 2
xf_text_3textread onlyXf text 3
xf_text_4textread onlyXf text 4
xf_text_5textread onlyXf text 5
xf_num_1numericread onlyXf num 1
xf_num_2numericread onlyXf num 2
xf_num_3numericread onlyXf num 3
xf_date_1dateread onlyXf date 1
xf_date_2dateread onlyXf date 2

Errors

StatusMeaning
400The request could not be read: a filter that is not JSON, a bad parameter
401No credential, or it is wrong, revoked or expired
403The caller's roles do not hold Talent & Contingent Workforce › Staffing Clients for this verb, or the address or origin is not allowed
404No record with that id is visible to the caller
409A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else
422Refused 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.