TRANXACT.AI Help

Accounting · Product Costing

Material Ledger

What an item ACTUALLY cost in a period, once every purchase price difference and production variance is rolled back in. The only honest answer to "what did the goods we sold in March cost us".

Type REST6 operationsBase path /api/accounting/material-ledgerPublished as /api/v1/material-ledger

Download specification (OpenAPI 3.1) Screen: Material Ledger

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 › Material Ledger 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.material_ledger · 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/material-ledgerList material ledger

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",
      "item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "period_code": "PER-000001",
      "currency": "USD",
      "valuation_class": "text",
      "opening_quantity": "12.0000",
      "opening_value": "1250.00",
      "receipts_quantity": "12.0000",
      "receipts_value": "1250.00",
      "issues_quantity": "12.0000",
      "issues_value": "1250.00",
      "closing_quantity": "12.0000"
    }
  ],
  "count": 1
}

Sample request

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

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",
  "item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "period_code": "PER-000001",
  "currency": "USD",
  "valuation_class": "text",
  "opening_quantity": "12.0000",
  "opening_value": "1250.00",
  "receipts_quantity": "12.0000",
  "receipts_value": "1250.00",
  "issues_quantity": "12.0000",
  "issues_value": "1250.00",
  "closing_quantity": "12.0000"
}

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

Sample request

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

Request body

The record as JSON. Fields marked Yes are required.

No body.

Sample body

{}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "period_code": "PER-000001",
  "currency": "USD",
  "valuation_class": "text",
  "opening_quantity": "12.0000",
  "opening_value": "1250.00",
  "receipts_quantity": "12.0000",
  "receipts_value": "1250.00",
  "issues_quantity": "12.0000",
  "issues_value": "1250.00",
  "closing_quantity": "12.0000"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/accounting/material-ledger" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{}'
PUT/api/accounting/material-ledger/{id}Change a material ledger row

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.

No body.

Sample body

{}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "period_code": "PER-000001",
  "currency": "USD",
  "valuation_class": "text",
  "opening_quantity": "12.0000",
  "opening_value": "1250.00",
  "receipts_quantity": "12.0000",
  "receipts_value": "1250.00",
  "issues_quantity": "12.0000",
  "issues_value": "1250.00",
  "closing_quantity": "12.0000"
}

Sample request

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

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/material-ledger/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/accounting/material-ledger/{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/material-ledger/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 material ledger row, 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
item_iduuidread onlyItem id
warehouse_iduuidread onlyWarehouse id
period_codetextread onlyPeriod code
currencytextread onlyCurrency
valuation_classtextread onlyValuation class
opening_quantitynumericread onlyOpening quantity
opening_valuenumericread onlyOpening value
receipts_quantitynumericread onlyReceipts quantity
receipts_valuenumericread onlyReceipts value
issues_quantitynumericread onlyIssues quantity
issues_valuenumericread onlyIssues value
closing_quantitynumericread onlyClosing quantity
closing_valuenumericread onlyClosing value
standard_pricenumericread onlyStandard price
price_differencenumericread onlyPrice difference
exchange_differencenumericread onlyExchange difference
production_variancenumericread onlyProduction variance
periodic_unit_pricenumericread onlyPeriodic unit price
consumed_differencenumericread onlyConsumed difference
stock_differencenumericread onlyStock difference
statustextread onlyStatus
run_iduuidread onlyRun id
journal_iduuidread onlyJournal id
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 › Material Ledger 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.