TRANXACT.AI Help

Student Lifecycle · Completion

Transcript Management

Requests for the academic record. A transcript hold stops issue until it is cleared.

Type REST7 operationsBase path /api/slcm/transcriptsPublished as /api/v1/transcripts

Download specification (OpenAPI 3.1) Screen: Transcript Management

Overview

PackageStudent Lifecycle
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 Student Lifecycle › Transcript Management 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.
Tableslcm.transcript_requests · 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

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

GET/api/slcm/transcriptsList transcript management

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",
      "request_no": "REQ-000001",
      "student_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "transcript_type": "official",
      "requested_at": "2026-10-30T09:00:00Z",
      "delivery_method": "electronic",
      "recipient": "text",
      "recipient_email": "someone@example.com",
      "fee_amount": "1250.00",
      "status": "draft",
      "issued_at": "2026-10-30T09:00:00Z",
      "issued_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "hold_reason": "text",
      "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
    }
  ],
  "count": 1
}

Sample request

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

Path parameters

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

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "request_no": "REQ-000001",
  "student_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "transcript_type": "official",
  "requested_at": "2026-10-30T09:00:00Z",
  "delivery_method": "electronic",
  "recipient": "text",
  "recipient_email": "someone@example.com",
  "fee_amount": "1250.00",
  "status": "draft",
  "issued_at": "2026-10-30T09:00:00Z",
  "issued_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "hold_reason": "text",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

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

Sample request

curl "https://demo.tranxact.ai/api/slcm/transcripts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/slcm/transcriptsCreate a transcripts

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
student_iduuidYesStudent
transcript_typetextNoType
Allowed: official unofficial partial enrollment_verification
delivery_methodtextNoDelivery
Allowed: electronic mail pickup third_party
recipienttextNoRecipient
recipient_emailtextNoRecipient email
fee_amountnumericNoFee
statustextNoStatus

Sample body

{
  "student_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "transcript_type": "official",
  "delivery_method": "electronic",
  "recipient": "text",
  "recipient_email": "someone@example.com"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "request_no": "REQ-000001",
  "student_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "transcript_type": "official",
  "requested_at": "2026-10-30T09:00:00Z",
  "delivery_method": "electronic",
  "recipient": "text",
  "recipient_email": "someone@example.com",
  "fee_amount": "1250.00",
  "status": "draft",
  "issued_at": "2026-10-30T09:00:00Z",
  "issued_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "hold_reason": "text",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/slcm/transcripts" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"student_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","transcript_type":"official","delivery_method":"electronic","recipient":"text","recipient_email":"someone@example.com"}'
PUT/api/slcm/transcripts/{id}Change a transcripts

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
student_iduuidYesStudent
transcript_typetextNoType
Allowed: official unofficial partial enrollment_verification
delivery_methodtextNoDelivery
Allowed: electronic mail pickup third_party
recipienttextNoRecipient
recipient_emailtextNoRecipient email
fee_amountnumericNoFee
statustextNoStatus

Sample body

{
  "student_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "transcript_type": "official"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "request_no": "REQ-000001",
  "student_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "transcript_type": "official",
  "requested_at": "2026-10-30T09:00:00Z",
  "delivery_method": "electronic",
  "recipient": "text",
  "recipient_email": "someone@example.com",
  "fee_amount": "1250.00",
  "status": "draft",
  "issued_at": "2026-10-30T09:00:00Z",
  "issued_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "hold_reason": "text",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

Sample request

curl -X PUT "https://demo.tranxact.ai/api/slcm/transcripts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"student_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","transcript_type":"official"}'
DELETE/api/slcm/transcripts/{id}Delete a transcripts

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

Path parameters

NameTypeDescription
idstring (uuid)The record's id, 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/slcm/transcripts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/issue" \
  -H "Authorization: Bearer $TOKEN"

Data model

Every field of a transcripts, 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
request_notextread onlyRequest no
student_iduuidread, writeStudent
transcript_typetextread, writeType
Allowed: official unofficial partial enrollment_verification
requested_attimestamp with time zoneread onlyRequested at
delivery_methodtextread, writeDelivery
Allowed: electronic mail pickup third_party
recipienttextread, writeRecipient
recipient_emailtextread, writeRecipient email
fee_amountnumericread, writeFee
statustextread, writeStatus
issued_attimestamp with time zoneread onlyIssued at
issued_byuuidread onlyIssued by
hold_reasontextread onlyHold reason
org_unit_iduuidread onlyOrg unit id
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 Student Lifecycle › Transcript Management 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.