Adjustment summaries

Adjustment summaries are collections of similar transactions grouped together for streamlined processing in Accounts Payable.

List adjustment summaries

get/objects/accounts-payable/adjustment-summary

Returns a collection with a key, ID, and link for each adjustment summary. This operation is mostly for use in testing; use the query service to find objects that meet certain criteria and to specify properties that are returned.

SecurityOAuth2
Responses
200

OK

400

Bad Request

Request samples
Response samples
application/json
{
  • "ia::result": [
    • {
      • "key": "13",
      • "id": "13",
      • "href": "/objects/accounts-payable/adjustment-summary/13"
      },
    • {
      • "key": "26",
      • "id": "26",
      • "href": "/objects/accounts-payable/adjustment-summary/26"
      },
    • {
      • "key": "20",
      • "id": "20",
      • "href": "/objects/accounts-payable/adjustment-summary/20"
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}

Get an adjustment summary

get/objects/accounts-payable/adjustment-summary/{key}

Returns detailed information for a specified adjustment summary.

SecurityOAuth2
Request
path Parameters
key
required
string

System-assigned key for the adjustment summary.

Example: 99
Responses
200

OK

400

Bad Request

Request samples
Response samples
application/json
{
  • "ia::result": {
    • "key": "13",
    • "id": "13",
    • "name": "Adjustments: 2019/01/18 Batch",
    • "glPostingDate": "2019-01-18",
    • "status": "active",
    • "recordType": "apAdjustments",
    • "totalAmount": "43.00",
    • "state": "open",
    • "parent": {
      • "key": "null",
      • "id": "null"
      },
    • "preventGLPosting": false,
    • "bankAccountId": {
      • "key": "null",
      • "id": "null"
      },
    • "summaryCreationType": "system",
    • "isQuickPaymentSummary": false,
    • "href": "/objects/accounts-payable/adjustment-summary/13"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}