TRANXACT.AI Help

Talent & Contingent Workforce · Clients & Programmes

MSP & VMS Programmes

The managed programmes work arrives through. Under one of these the requisition comes from a portal, the rate is capped by a card, and a fee comes off every invoice before it is paid.

Type REST6 operationsBase path /api/ats/msp-programsPublished as /api/v1/msp-programs

Download specification (OpenAPI 3.1) Screen: MSP & VMS Programmes

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 › MSP & VMS Programmes 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.msp_programs · 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

6 operations. Open one for its parameters, bodies, responses and a sample request.

GET/api/ats/msp-programsList msp & vms programmes

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",
      "code": "COD-000001",
      "name": "Example",
      "vms_vendor": "text",
      "msp_partner": "text",
      "program_manager": "text",
      "supplier_tier": "text",
      "msp_fee_pct": "1250.00",
      "fee_borne_by": "supplier",
      "payment_terms_days": 10,
      "rate_card_governed": true,
      "submission_limit": 10,
      "tenure_limit_months": 10
    }
  ],
  "count": 1
}

Sample request

curl "https://demo.tranxact.ai/api/ats/msp-programs?limit=20" \
  -H "Authorization: Bearer $TOKEN"
GET/api/ats/msp-programs/{id}Read one programme

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",
  "code": "COD-000001",
  "name": "Example",
  "vms_vendor": "text",
  "msp_partner": "text",
  "program_manager": "text",
  "supplier_tier": "text",
  "msp_fee_pct": "1250.00",
  "fee_borne_by": "supplier",
  "payment_terms_days": 10,
  "rate_card_governed": true,
  "submission_limit": 10,
  "tenure_limit_months": 10
}

404 when no record with that id is visible to the caller.

Sample request

curl "https://demo.tranxact.ai/api/ats/msp-programs/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/ats/msp-programsCreate a programme

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
codetextYesCode
nametextYesProgramme name
vms_vendortextNoVMS platform
msp_partnertextNoManaged by
program_managertextNoProgramme manager
supplier_tiertextNoOur supplier tier
msp_fee_pctnumericNoProgramme fee % — What the MSP takes off every invoice. Forget it and every margin figure is overstated by exactly this.
fee_borne_bytextNoFee borne by
Allowed: supplier client
payment_terms_daysintegerNoPayment terms (days)
rate_card_governedbooleanNoRates capped by a card
submission_limitintegerNoSubmissions per requisition
tenure_limit_monthsintegerNoTenure limit (months)
portal_urltextNoPortal
external_reftextNoProgramme id over there
start_datedateNoStarts
end_datedateNoEnds
statustextNoStatus
Allowed: draft active suspended expired terminated
notestextNoNotes

Sample body

{
  "code": "COD-000001",
  "name": "Example",
  "vms_vendor": "text",
  "msp_partner": "text",
  "program_manager": "text",
  "supplier_tier": "text"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "code": "COD-000001",
  "name": "Example",
  "vms_vendor": "text",
  "msp_partner": "text",
  "program_manager": "text",
  "supplier_tier": "text",
  "msp_fee_pct": "1250.00",
  "fee_borne_by": "supplier",
  "payment_terms_days": 10,
  "rate_card_governed": true,
  "submission_limit": 10,
  "tenure_limit_months": 10
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/ats/msp-programs" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"code":"COD-000001","name":"Example","vms_vendor":"text","msp_partner":"text","program_manager":"text","supplier_tier":"text"}'
PUT/api/ats/msp-programs/{id}Change a programme

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
codetextYesCode
nametextYesProgramme name
vms_vendortextNoVMS platform
msp_partnertextNoManaged by
program_managertextNoProgramme manager
supplier_tiertextNoOur supplier tier
msp_fee_pctnumericNoProgramme fee % — What the MSP takes off every invoice. Forget it and every margin figure is overstated by exactly this.
fee_borne_bytextNoFee borne by
Allowed: supplier client
payment_terms_daysintegerNoPayment terms (days)
rate_card_governedbooleanNoRates capped by a card
submission_limitintegerNoSubmissions per requisition
tenure_limit_monthsintegerNoTenure limit (months)
portal_urltextNoPortal
external_reftextNoProgramme id over there
start_datedateNoStarts
end_datedateNoEnds
statustextNoStatus
Allowed: draft active suspended expired terminated
notestextNoNotes

Sample body

{
  "code": "COD-000001",
  "name": "Example"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "code": "COD-000001",
  "name": "Example",
  "vms_vendor": "text",
  "msp_partner": "text",
  "program_manager": "text",
  "supplier_tier": "text",
  "msp_fee_pct": "1250.00",
  "fee_borne_by": "supplier",
  "payment_terms_days": 10,
  "rate_card_governed": true,
  "submission_limit": 10,
  "tenure_limit_months": 10
}

Sample request

curl -X PUT "https://demo.tranxact.ai/api/ats/msp-programs/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"code":"COD-000001","name":"Example"}'
DELETE/api/ats/msp-programs/{id}Delete a programme

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/msp-programs/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/ats/msp-programs/{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/msp-programs/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"overrides":"value","preview":"value","withLines":"value"}'

Data model

Every field of a programme, 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
codetextread, writeCode
nametextread, writeProgramme name
vms_vendortextread, writeVMS platform
msp_partnertextread, writeManaged by
program_managertextread, writeProgramme manager
supplier_tiertextread, writeOur supplier tier
msp_fee_pctnumericread, writeProgramme fee % — What the MSP takes off every invoice. Forget it and every margin figure is overstated by exactly this.
fee_borne_bytextread, writeFee borne by
Allowed: supplier client
payment_terms_daysintegerread, writePayment terms (days)
rate_card_governedbooleanread, writeRates capped by a card
submission_limitintegerread, writeSubmissions per requisition
tenure_limit_monthsintegerread, writeTenure limit (months)
portal_urltextread, writePortal
external_reftextread, writeProgramme id over there
start_datedateread, writeStarts
end_datedateread, writeEnds
statustextread, writeStatus
Allowed: draft active suspended expired terminated
notestextread, writeNotes
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 › MSP & VMS Programmes 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.