Retrieve AP Manual Cheque by Code
- 04 Jul 2025
- 1 Minute to read
- Print
- DarkLight
Retrieve AP Manual Cheque by Code
- Updated on 04 Jul 2025
- 1 Minute to read
- Print
- DarkLight
Article summary
Did you find this summary helpful?
Thank you for your feedback!
Get
/ap-rest-api/rest/1/manualcheck
Query Standards
Finder
Following row finders are available for data filtering and optimizing request performance.
- Select By Cheque Finder
- By UUID
Select Cheque Finder
Recommended finder parameters. Refer to Query Parameters for example.
| Parameter | Description | Sample |
|---|---|---|
| ChqNumVar | Cheque Number | 1020 |
| CompCodeVar | Company Code | 001 |
| VenCodeVar | Vendor Code | 1159 |
By UUID
This is an optional finder for querying a specific Manual Cheque by its Cheque Number.
| Parameter | Description | Sample |
|---|---|---|
| /VUUID | The VUuid attribute is the Unique row ID | /ap-rest-api/rest/1/manualcheck/1421436 |
Other Query Options
The details of a POSTED cheque begin at "VouChqViewObj" tag
The details of an UNPOSTED cheque begin at "PayamtChqmanViewObj" tag
Payload Details
Link Header and Details -- for paying Vouchers
To link the cheque header with the details, the following two columns
must have the same value when being passed in; ChqSeqNum (header) and
PaChqSeqNum (details) , ChqNum (header) and PaChqNum (details)
Autoposting of Cheque
To complete auto posting of the cheque within CMiC, ensure ChqBchPost is set to Y. Otherwise the cheque will be created in an UNPOSTED state.
Paying Vouchers
To pay vouchers using manual cheques, ensure that ChqVouCode = Y. There
must also be at least one details section; Please see sample code under PayamtChqmanViewObj
Security
HTTP
Type basic
Basic authentication
Query parameters
finder
string
ExampleChequeFinder;ChqNumVar=1020,CompCodeVar=001, VenCodeVar=1159
limit
integer
Example500
offset
integer
Example0
totalResults
boolean
Exampletrue
orderBy
string
ExampleChqSeqNum:desc
Responses
200
OK
Headers
Content-Type
string
Exampleapplication/vnd.oracle.adf.resourcecollection+json
{
"items": [
{
"Chq1099Code": "X",
"ChqAccCode": "10001",
"ChqAmt": 1000,
"ChqBankCompCode": "001",
"ChqBchName": null,
"ChqBchNum": 3397280,
"ChqBchPost": null,
"ChqCompCode": "001",
"ChqCurrCode": "USD",
"ChqCurcFactorNum": 1,
"ChqDate": "2020-05-18",
"ChqDeptCode": "00",
"ChqDesc": "Charity Donation",
"ChqDraftCode": "M",
"ChqJobCode": null,
"ChqJointVenName": null,
"ChqNum": 1020,
"ChqPayeeAddr1": "820 Aladdin Ave",
"ChqPayeeAddr2": null,
"ChqPayeeAddr3": "San Leandro",
"ChqPayeeCountry": "USA",
"ChqPayeeName1": "Ace Supply Co. Inc.",
"ChqPayeeName2": null,
"ChqPayeePostalCode": "94577",
"ChqPayeeRegCode": "CA",
"ChqPostDate": "2020-05-18",
"ChqRecCode": "N",
"ChqSeqNum": 1421436,
"ChqTempBchNum": 3397280,
"ChqVenCode": "1159",
"ChqVouCode": "N",
"ChqRefundFlag": null,
"links": [
{
"rel": "self",
"href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/ap-rest-api/rest/1/manualcheck/1421436",
"name": "manualcheck",
"kind": "item"
},
{
"rel": "canonical",
"href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/ap-rest-api/rest/1/manualcheck/1421436",
"name": "manualcheck",
"kind": "item"
},
{
"rel": "child",
"href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/ap-rest-api/rest/1/manualcheck/1421436/child/VouChqViewObj",
"name": "VouChqViewObj",
"kind": "collection"
},
{
"rel": "child",
"href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/ap-rest-api/rest/1/manualcheck/1421436/child/PayamtChqmanViewObj",
"name": "PayamtChqmanViewObj",
"kind": "collection"
}
]
}
],
"count": 1,
"hasMore": false,
"limit": 25,
"offset": 0,
"links": [
{
"rel": "self",
"href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/ap-rest-api/rest/1/manualcheck",
"name": "manualcheck",
"kind": "collection"
}
]
}object