TRANXACT.AI Help

Accounting · Fund Accounting

Grant Claims

A reimbursement claim to the grantor for what the grant has spent to the end of the period, less what was claimed before. Approved by a second person, it raises the grantor’s invoice in the grant’s fund, ready to post.

Type REST10 operationsBase path /api/accounting/grant-claimsPublished as /api/v1/grant-claims

Download specification (OpenAPI 3.1) Screen: Grant Claims

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 › Grant Claims 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.grant_claims · 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/accounting/grant-claimsList grant claims

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",
      "claim_no": "CLA-000001",
      "grant_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "customer_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "claim_date": "2026-10-30",
      "period_from": "2026-10-30",
      "period_to": "2026-10-30",
      "amount": "1250.00",
      "revenue_account_no": "REV-000001",
      "expended_to_date": "1250.00",
      "claimed_before": "1250.00",
      "status": "draft",
      "ar_invoice_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
    }
  ],
  "count": 1
}

Sample request

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

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",
  "claim_no": "CLA-000001",
  "grant_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "customer_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "claim_date": "2026-10-30",
  "period_from": "2026-10-30",
  "period_to": "2026-10-30",
  "amount": "1250.00",
  "revenue_account_no": "REV-000001",
  "expended_to_date": "1250.00",
  "claimed_before": "1250.00",
  "status": "draft",
  "ar_invoice_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/accounting/grant-claims/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/accounting/grant-claimsCreate a grant claim

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
claim_notextNoClaim no
grant_iduuidYesGrant
customer_account_iduuidYesGrantor (customer account invoiced)
claim_datedateNoClaim date
period_fromdateYesCosts from
period_todateYesCosts to
amountnumericNoAmount claimed — Leave empty to claim everything claimable when it is submitted.
revenue_account_notextNoGrant revenue account — Blank: the chart’s revenue account.
notestextNoNotes

Sample body

{
  "grant_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "customer_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "period_from": "2026-10-30",
  "period_to": "2026-10-30",
  "claim_no": "CLA-000001",
  "claim_date": "2026-10-30",
  "amount": "1250.00",
  "revenue_account_no": "REV-000001"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "claim_no": "CLA-000001",
  "grant_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "customer_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "claim_date": "2026-10-30",
  "period_from": "2026-10-30",
  "period_to": "2026-10-30",
  "amount": "1250.00",
  "revenue_account_no": "REV-000001",
  "expended_to_date": "1250.00",
  "claimed_before": "1250.00",
  "status": "draft",
  "ar_invoice_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/accounting/grant-claims" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"grant_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","customer_account_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","period_from":"2026-10-30","period_to":"2026-10-30","claim_no":"CLA-000001","claim_date":"2026-10-30","amount":"1250.00","revenue_account_no":"REV-000001"}'
PUT/api/accounting/grant-claims/{id}Change a grant claim

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
claim_notextNoClaim no
grant_iduuidYesGrant
customer_account_iduuidYesGrantor (customer account invoiced)
claim_datedateNoClaim date
period_fromdateYesCosts from
period_todateYesCosts to
amountnumericNoAmount claimed — Leave empty to claim everything claimable when it is submitted.
revenue_account_notextNoGrant revenue account — Blank: the chart’s revenue account.
notestextNoNotes

Sample body

{
  "grant_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "customer_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "claim_no": "CLA-000001",
  "grant_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "customer_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "claim_date": "2026-10-30",
  "period_from": "2026-10-30",
  "period_to": "2026-10-30",
  "amount": "1250.00",
  "revenue_account_no": "REV-000001",
  "expended_to_date": "1250.00",
  "claimed_before": "1250.00",
  "status": "draft",
  "ar_invoice_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

Sample request

curl -X PUT "https://demo.tranxact.ai/api/accounting/grant-claims/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"grant_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","customer_account_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'
DELETE/api/accounting/grant-claims/{id}Delete a grant claim

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

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/accounting/grant-claims/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/submit" \
  -H "Authorization: Bearer $TOKEN"
POST/api/accounting/grant-claims/{id}/rejectReject

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):

note, reason

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/grant-claims/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/reject" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"note":"value","reason":"value"}'
POST/api/accounting/grant-claims/{id}/cancelCancel

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/accounting/grant-claims/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/cancel" \
  -H "Authorization: Bearer $TOKEN"
POST/api/accounting/grant-claims/{id}/approveApprove

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/accounting/grant-claims/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/approve" \
  -H "Authorization: Bearer $TOKEN"

Data model

Every field of a grant claim, 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
claim_notextread, writeClaim no
grant_iduuidread, writeGrant
customer_account_iduuidread, writeGrantor (customer account invoiced)
claim_datedateread, writeClaim date
period_fromdateread, writeCosts from
period_todateread, writeCosts to
amountnumericread, writeAmount claimed — Leave empty to claim everything claimable when it is submitted.
revenue_account_notextread, writeGrant revenue account — Blank: the chart’s revenue account.
expended_to_datenumericread onlyExpended to date
claimed_beforenumericread onlyClaimed before
statustextread onlyStatus
ar_invoice_iduuidread onlyAr invoice id
notestextread, writeNotes
submitted_byuuidread onlySubmitted by
submitted_attimestamp with time zoneread onlySubmitted at
decided_byuuidread onlyDecided by
decided_attimestamp with time zoneread onlyDecided at
decision_notetextread onlyDecision note
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 Accounting › Grant Claims 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.