iotoms Docs

Get posting rules and event catalog

GET
/api/v1/accounting/posting-rules

Returns how each business event, such as a sale or goods receipt, is turned into a balanced journal entry, plus the catalog of amounts and account splits each event type allows.

Authorization

BearerAuth
headerAuthorizationBearer <JWT>

Header Parameters

X-TenantID*string

Your merchant's tenant code — the value typed in the Domain field on the iotoms login screen. See Concepts.

Response Body

OK

*/*
  1. response
status*string

Outcome of the call: SUCCESS when the request worked, ERROR when it did not.

message*string

Short human-readable message describing the result, for logs or display; do not parse it.

data?

The merchant's saved posting rules plus the catalog of event types they can be written for.

Example Request
curl -X GET 'https://beta.iotoms.com/api/v1/accounting/posting-rules' \  -H 'X-TenantID: your-tenant-code'
Example Response
{  "status": "string",  "message": "string",  "data": {    "rules": [      {        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "eventType": "string",        "name": "string",        "active": true,        "lines": [          {            "direction": "DEBIT",            "accountId": "3d07c219-0a88-45be-9cfc-91e9d095a1e9",            "accountCode": "string",            "accountName": "string",            "amountSource": "GRAND_TOTAL"          }        ],        "createdAt": "2019-08-24T14:15:22Z",        "updatedAt": "2019-08-24T14:15:22Z"      }    ],    "catalog": [      {        "eventType": "string",        "description": "string",        "sourceSystem": "string",        "allowedSources": [          "GRAND_TOTAL"        ],        "debitPartitions": [          [            "GRAND_TOTAL"          ]        ],        "creditPartitions": [          [            "GRAND_TOTAL"          ]        ]      }    ]  }}