TRANXACT.AI Help

Accounting · Finance Intelligence

Narratives

The generated text and the edited one, both kept — the difference between them is the most useful feedback there is, and a narrative rewritten entirely was not worth generating.

Type REST6 operationsBase path /api/accounting/finance-narrativesPublished as /api/v1/finance-narratives

Download specification (OpenAPI 3.1) Screen: Narratives

Overview

PackageAccounting
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 Accounting › Narratives 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.
Tableacct.finance_narratives · 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/accounting/finance-narrativesList narratives

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",
      "narrative_type": "variance",
      "period_code": "PER-000001",
      "subject_type": "text",
      "subject_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "subject_ref": "text",
      "title": "Example",
      "generated_text": "text",
      "final_text": "text",
      "source_figures": {},
      "model": "text",
      "model_version": "text",
      "status": "draft"
    }
  ],
  "count": 1
}

Sample request

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

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",
  "narrative_type": "variance",
  "period_code": "PER-000001",
  "subject_type": "text",
  "subject_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "subject_ref": "text",
  "title": "Example",
  "generated_text": "text",
  "final_text": "text",
  "source_figures": {},
  "model": "text",
  "model_version": "text",
  "status": "draft"
}

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

Sample request

curl "https://demo.tranxact.ai/api/accounting/finance-narratives/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/accounting/finance-narrativesCreate a narrative

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
narrative_typetextNoType
Allowed: variance close_summary cash_commentary management_report flux_analysis board_note audit_response
period_codetextNoPeriod
subject_typetextNoSubject type
subject_iduuidNoSubject id
subject_reftextNoAbout
titletextNoTitle
generated_texttextNoGenerated
final_texttextNoFinal
source_figuresjsonbNoFigures it was written from — Kept so a narrative can be re-checked against the numbers it claims to describe.
modeltextNoModel
model_versiontextNoModel version
edited_byuuidNoEdited by
edit_distance_pctnumericNoEdit distance pct

Sample body

{
  "narrative_type": "variance",
  "period_code": "PER-000001",
  "subject_type": "text",
  "subject_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "narrative_type": "variance",
  "period_code": "PER-000001",
  "subject_type": "text",
  "subject_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "subject_ref": "text",
  "title": "Example",
  "generated_text": "text",
  "final_text": "text",
  "source_figures": {},
  "model": "text",
  "model_version": "text",
  "status": "draft"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/accounting/finance-narratives" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"narrative_type":"variance","period_code":"PER-000001","subject_type":"text","subject_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'
PUT/api/accounting/finance-narratives/{id}Change a narrative

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
narrative_typetextNoType
Allowed: variance close_summary cash_commentary management_report flux_analysis board_note audit_response
period_codetextNoPeriod
subject_typetextNoSubject type
subject_iduuidNoSubject id
subject_reftextNoAbout
titletextNoTitle
generated_texttextNoGenerated
final_texttextNoFinal
source_figuresjsonbNoFigures it was written from — Kept so a narrative can be re-checked against the numbers it claims to describe.
modeltextNoModel
model_versiontextNoModel version
edited_byuuidNoEdited by
edit_distance_pctnumericNoEdit distance pct

Sample body

{
  "narrative_type": "variance",
  "period_code": "PER-000001"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "narrative_type": "variance",
  "period_code": "PER-000001",
  "subject_type": "text",
  "subject_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "subject_ref": "text",
  "title": "Example",
  "generated_text": "text",
  "final_text": "text",
  "source_figures": {},
  "model": "text",
  "model_version": "text",
  "status": "draft"
}

Sample request

curl -X PUT "https://demo.tranxact.ai/api/accounting/finance-narratives/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"narrative_type":"variance","period_code":"PER-000001"}'
DELETE/api/accounting/finance-narratives/{id}Delete a narrative

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/accounting/finance-narratives/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/accounting/finance-narratives/{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/accounting/finance-narratives/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 narrative, 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
narrative_typetextread, writeType
Allowed: variance close_summary cash_commentary management_report flux_analysis board_note audit_response
period_codetextread, writePeriod
subject_typetextread, writeSubject type
subject_iduuidread, writeSubject id
subject_reftextread, writeAbout
titletextread, writeTitle
generated_texttextread, writeGenerated
final_texttextread, writeFinal
source_figuresjsonbread, writeFigures it was written from — Kept so a narrative can be re-checked against the numbers it claims to describe.
modeltextread, writeModel
model_versiontextread, writeModel version
statustextread onlyStatus
edited_byuuidread, writeEdited by
approved_byuuidread onlyApproved by
approved_attimestamp with time zoneread onlyApproved at
edit_distance_pctnumericread, writeEdit distance pct
created_attimestamp with time zoneread onlyCreated at
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
created_byuuidread onlyCreated by
updated_attimestamp with time zoneread onlyUpdated at
updated_byuuidread onlyUpdated by

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 Accounting › Narratives 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.