TRANXACT.AI Help

Accounting · Product Costing

Activity Rates

What one hour of that activity costs, from that cost center. The PLANNED rate charges orders all year; the ACTUAL rate is only knowable afterwards, and the difference is what actual costing settles.

Type REST6 operationsBase path /api/accounting/activity-ratesPublished as /api/v1/activity-rates

Download specification (OpenAPI 3.1) Screen: Activity Rates

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 › Activity Rates 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.activity_rates · 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/activity-ratesList activity rates

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",
      "cost_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "activity_type_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "fiscal_year": 10,
      "period_code": "PER-000001",
      "version": "plan",
      "fixed_rate": "1250.00",
      "variable_rate": "1250.00",
      "total_rate": "1250.00",
      "currency": "USD",
      "capacity_quantity": "12.0000",
      "planned_quantity": "12.0000",
      "actual_quantity": "12.0000"
    }
  ],
  "count": 1
}

Sample request

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

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",
  "cost_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "activity_type_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "fiscal_year": 10,
  "period_code": "PER-000001",
  "version": "plan",
  "fixed_rate": "1250.00",
  "variable_rate": "1250.00",
  "total_rate": "1250.00",
  "currency": "USD",
  "capacity_quantity": "12.0000",
  "planned_quantity": "12.0000",
  "actual_quantity": "12.0000"
}

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

Sample request

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

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
cost_center_iduuidYesCost center
activity_type_iduuidYesActivity
fiscal_yearintegerYesFiscal year
period_codetextNoPeriod (blank = the whole year)
versiontextNoVersion
Allowed: plan actual forecast simulation
fixed_ratenumericNoFixed rate — Split because under-absorbed FIXED cost is a capacity problem and variable cost is an efficiency one.
variable_ratenumericNoVariable rate
currencytextNoCurrency
capacity_quantitynumericNoCapacity — The gap between capacity and plan is idle capacity, and its cost must not be absorbed into a product.
planned_quantitynumericNoPlanned quantity
actual_quantitynumericNoActual quantity
planned_costnumericNoPlanned cost
actual_costnumericNoActual cost
valid_fromdateNoFrom
valid_todateNoTo
is_lockedbooleanNoLocked
notestextNoNotes

Sample body

{
  "cost_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "activity_type_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "fiscal_year": 10,
  "period_code": "PER-000001",
  "version": "plan",
  "fixed_rate": "1250.00",
  "variable_rate": "1250.00"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "cost_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "activity_type_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "fiscal_year": 10,
  "period_code": "PER-000001",
  "version": "plan",
  "fixed_rate": "1250.00",
  "variable_rate": "1250.00",
  "total_rate": "1250.00",
  "currency": "USD",
  "capacity_quantity": "12.0000",
  "planned_quantity": "12.0000",
  "actual_quantity": "12.0000"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/accounting/activity-rates" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"cost_center_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","activity_type_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","fiscal_year":10,"period_code":"PER-000001","version":"plan","fixed_rate":"1250.00","variable_rate":"1250.00"}'
PUT/api/accounting/activity-rates/{id}Change a activity rate

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
cost_center_iduuidYesCost center
activity_type_iduuidYesActivity
fiscal_yearintegerYesFiscal year
period_codetextNoPeriod (blank = the whole year)
versiontextNoVersion
Allowed: plan actual forecast simulation
fixed_ratenumericNoFixed rate — Split because under-absorbed FIXED cost is a capacity problem and variable cost is an efficiency one.
variable_ratenumericNoVariable rate
currencytextNoCurrency
capacity_quantitynumericNoCapacity — The gap between capacity and plan is idle capacity, and its cost must not be absorbed into a product.
planned_quantitynumericNoPlanned quantity
actual_quantitynumericNoActual quantity
planned_costnumericNoPlanned cost
actual_costnumericNoActual cost
valid_fromdateNoFrom
valid_todateNoTo
is_lockedbooleanNoLocked
notestextNoNotes

Sample body

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

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "cost_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "activity_type_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "fiscal_year": 10,
  "period_code": "PER-000001",
  "version": "plan",
  "fixed_rate": "1250.00",
  "variable_rate": "1250.00",
  "total_rate": "1250.00",
  "currency": "USD",
  "capacity_quantity": "12.0000",
  "planned_quantity": "12.0000",
  "actual_quantity": "12.0000"
}

Sample request

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

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/activity-rates/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/accounting/activity-rates/{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/activity-rates/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 activity rate, 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
cost_center_iduuidread, writeCost center
activity_type_iduuidread, writeActivity
fiscal_yearintegerread, writeFiscal year
period_codetextread, writePeriod (blank = the whole year)
versiontextread, writeVersion
Allowed: plan actual forecast simulation
fixed_ratenumericread, writeFixed rate — Split because under-absorbed FIXED cost is a capacity problem and variable cost is an efficiency one.
variable_ratenumericread, writeVariable rate
total_ratenumericread onlyTotal rate
currencytextread, writeCurrency
capacity_quantitynumericread, writeCapacity — The gap between capacity and plan is idle capacity, and its cost must not be absorbed into a product.
planned_quantitynumericread, writePlanned quantity
actual_quantitynumericread, writeActual quantity
planned_costnumericread, writePlanned cost
actual_costnumericread, writeActual cost
valid_fromdateread, writeFrom
valid_todateread, writeTo
is_lockedbooleanread, writeLocked
notestextread, writeNotes
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_attimestamp with time zoneread onlyCreated at
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 › Activity Rates 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.