Accounting · Profitability
Contribution Margin
The ladder, cut by whatever you ask for. Rows that reverse between gross margin and full margin are the finding this module exists to produce.
/api/accounting/profitabilityDownload specification (OpenAPI 3.1) Screen: Contribution Margin
Overview
| Package | Accounting |
|---|---|
| Authentication | Bearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key |
| Authorization | The caller's roles must hold Accounting › Contribution Margin 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. |
| Rules | The same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail. |
API reference
3 operations. Open one for its parameters, bodies, responses and a sample request.
POST/api/accounting/profitability/deriveDerive
Request body
The keys this action reads (* = required; "one of" lists the only values):
accountId, itemId, profitCenterId, costCenterId, orgUnitId, salesEmployeeId, channel, extraResponse
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/profitability/derive" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"accountId":"value","itemId":"value","profitCenterId":"value","costCenterId":"value","orgUnitId":"value","salesEmployeeId":"value"}'POST/api/accounting/profitability/postPost
Request body
The keys this action reads (* = required; "one of" lists the only values):
segmentId*, periodCode, version, recordType, sourceType, sourceId, sourceRef; version one of actual|plan|forecast|simulation|prior_year; recordType one of billing|order|allocation|settlement|direct|accrual|plan|statistical; lines: [{ valueField, postingDate, amount, quantity, uom, currency }]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/profitability/post" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"segmentId":"value","periodCode":"value","version":"value","recordType":"value","sourceType":"value","sourceId":"value"}'GET/api/accounting/profitability/reportReport
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/accounting/profitability/report" \
-H "Authorization: Bearer $TOKEN"Errors
| Status | Meaning |
|---|---|
| 400 | The request could not be read: a filter that is not JSON, a bad parameter |
| 401 | No credential, or it is wrong, revoked or expired |
| 403 | The caller's roles do not hold Accounting › Contribution Margin for this verb, or the address or origin is not allowed |
| 404 | No record with that id is visible to the caller |
| 409 | A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else |
| 422 | Refused 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.