Posting summaries

This object provides information about a transaction definition after it posts to the general ledger, including the journal entry record number.

List posting summaries

get/objects/inventory-control/posting-summary

Returns a collection with a key, ID, and link for each posting summary.

SecurityOAuth2
Responses
200

OK

400

Bad Request

Request samples 
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "key": "13",
      • "id": "13",
      • "href": "/objects/inventory-control/posting-summary/13"
      },
    • {
      • "key": "16",
      • "id": "16",
      • "href": "/objects/inventory-control/posting-summary/16"
      },
    • {
      • "key": "17",
      • "id": "17",
      • "href": "/objects/inventory-control/posting-summary/17"
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "start": 1,
    • "pageSize": 100
    }
}
Get a posting summary
get/objects/inventory-control/posting-summary/{key}
Returns detailed information for a specified posting summary.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned unique key for the posting summary.


 
 Example:  37
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "key": "617",
    • "journalEntry": {
      • "id": "1090",
      • "key": "1090",
      • "href": "/objects/general-ledger/journal-entry/1090"
      },
    • "doctype": "SYS-Warehouse Transfer In",
    • "title": "SYS-Warehouse Transfer In: 2023/03/15 Batch",
    • "href": "/objects/inventory-control/posting-summary/617"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Query posting summaries
post/services/core/query
Use the query service to find posting summaries that meet certain criteria and to specify the properties that are returned.


SecurityOAuth2 
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "ia::error": {
      • "code": "invalidRequest",
      • "message": "A POST request requires a payload",
      • "errorId": "REST-1028",
      • "additionalInfo": {
        },
      • "supportId": "Kxi78%7EZuyXBDEGVHD2UmO1phYXDQAAAAo"
      }
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 0,
    • "totalError": 1
    }
}