TRANXACT.AI Help

Accounting · Projects & Portfolios

Portfolios

The envelope. A portfolio whose approved projects exceed its budget is the situation portfolio management exists to prevent, and it is invisible unless the envelope is a number.

Type REST7 operationsBase path /api/accounting/portfoliosPublished as /api/v1/portfolios

Download specification (OpenAPI 3.1) Screen: Portfolios

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 › Portfolios 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.portfolios · 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/accounting/portfoliosList portfolios

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",
      "parent_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "portfolio_type": "investment",
      "owner_employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "sponsor_employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "currency": "USD",
      "fiscal_year": 10,
      "budget_amount": "1250.00",
      "approved_amount": "1250.00",
      "strategic_weight": "1250.00",
      "financial_weight": "1250.00"
    }
  ],
  "count": 1
}

Sample request

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

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",
  "parent_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "portfolio_type": "investment",
  "owner_employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "sponsor_employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "currency": "USD",
  "fiscal_year": 10,
  "budget_amount": "1250.00",
  "approved_amount": "1250.00",
  "strategic_weight": "1250.00",
  "financial_weight": "1250.00"
}

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

Sample request

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

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
codetextYesCode
nametextYesName
parent_iduuidNoParent portfolio
portfolio_typetextNoType
Allowed: investment product capital transformation maintenance research it other
owner_employee_iduuidNoOwner
sponsor_employee_iduuidNoSponsor
currencytextNoCurrency
fiscal_yearintegerNoFiscal year
budget_amountnumericNoInvestment envelope
approved_amountnumericNoApproved to date
strategic_weightnumericNoStrategic weight
financial_weightnumericNoFinancial weight
risk_weightnumericNoRisk weight
capacity_weightnumericNoCapacity weight
statustextNoStatus
Allowed: draft active on_hold closed archived
descriptiontextNoDescription

Sample body

{
  "code": "COD-000001",
  "name": "Example",
  "parent_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "portfolio_type": "investment",
  "owner_employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "sponsor_employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "code": "COD-000001",
  "name": "Example",
  "parent_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "portfolio_type": "investment",
  "owner_employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "sponsor_employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "currency": "USD",
  "fiscal_year": 10,
  "budget_amount": "1250.00",
  "approved_amount": "1250.00",
  "strategic_weight": "1250.00",
  "financial_weight": "1250.00"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/accounting/portfolios" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"code":"COD-000001","name":"Example","parent_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","portfolio_type":"investment","owner_employee_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","sponsor_employee_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'
PUT/api/accounting/portfolios/{id}Change a portfolio

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
nametextYesName
parent_iduuidNoParent portfolio
portfolio_typetextNoType
Allowed: investment product capital transformation maintenance research it other
owner_employee_iduuidNoOwner
sponsor_employee_iduuidNoSponsor
currencytextNoCurrency
fiscal_yearintegerNoFiscal year
budget_amountnumericNoInvestment envelope
approved_amountnumericNoApproved to date
strategic_weightnumericNoStrategic weight
financial_weightnumericNoFinancial weight
risk_weightnumericNoRisk weight
capacity_weightnumericNoCapacity weight
statustextNoStatus
Allowed: draft active on_hold closed archived
descriptiontextNoDescription

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",
  "parent_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "portfolio_type": "investment",
  "owner_employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "sponsor_employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "currency": "USD",
  "fiscal_year": 10,
  "budget_amount": "1250.00",
  "approved_amount": "1250.00",
  "strategic_weight": "1250.00",
  "financial_weight": "1250.00"
}

Sample request

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

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

Path parameters

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

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/accounting/portfolios/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/board" \
  -H "Authorization: Bearer $TOKEN"

Data model

Every field of a portfolio, 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, writeName
parent_iduuidread, writeParent portfolio
portfolio_typetextread, writeType
Allowed: investment product capital transformation maintenance research it other
owner_employee_iduuidread, writeOwner
sponsor_employee_iduuidread, writeSponsor
currencytextread, writeCurrency
fiscal_yearintegerread, writeFiscal year
budget_amountnumericread, writeInvestment envelope
approved_amountnumericread, writeApproved to date
strategic_weightnumericread, writeStrategic weight
financial_weightnumericread, writeFinancial weight
risk_weightnumericread, writeRisk weight
capacity_weightnumericread, writeCapacity weight
statustextread, writeStatus
Allowed: draft active on_hold closed archived
descriptiontextread, writeDescription
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 › Portfolios 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.