API Catalog

Create a AP Cheque

06 Jan 2025
2 Minutes to read

Print
Dark
Light

Create a AP Cheque

Updated on 06 Jan 2025
2 Minutes to read

Print
Dark
Light

Article summary

Did you find this summary helpful?

Thank you for your feedback

Post

/ap-rest-api/rest/1/apcheque

Create Cheques

Security

HTTP

Type basic

Basic authentication

Header parameters

Content-Type

string

Exampleapplication/vnd.oracle.adf.resourceItem+json

Body parameters

object

Example{ "ChqCompCode": "001", "ChqSeqNum": 188722.0, "ChqNum": 112.0, "ChqDate": "2016-08-31", "ChqDeptCode": "00", "ChqAccCode": "10001", "ChqAmt": 2385.0, "ChqCurcFactorNum": 1.0, "ChqDraftCode": "C", "ChqVenCode": "0212", "ChqCurrCode": "USD", "ChqBankCompCode": "001", "ChqGlFactorNum": 1.0, "ChqPayeeFlag": "Y", "ChqPospayExcludeFlag": "N", "ChqPospayFlag": "N", "ChqPospayVoidFlag": "N", "ChqDesc": null }

ChqAccCode

string

Bank Account Code

💻 UI Fieldname: ChqAccCode

Max length16

ChqPospayVoidFlag

string

If you will be utilizing Positive Pay – Set this field to 'N' – indicates the check needs to be included in the next positive pay file as a voided check

💻 UI Fieldname: ChqPospayVoidFlag

Max length1

ChqBankCompCode

string

Bank Company Code

💻 UI Fieldname: ChqBankCompCode

Max length8

ChqDate

string

Check Date

💻 UI Fieldname: ChqDate

ChqGlFactorNum

number

This is the conversion factor from chq currency to GL currency. Set this to 1 for data conversion

💻 UI Fieldname: ChqGlFactorNum

Max length2216

ChqVenCode

string

Vendor Code

💻 UI Fieldname: ChqVenCode

Max length8

ChqPayeeFlag

string

Indicates a 2nd party payee on the check

💻 UI Fieldname: ChqPayeeFlag

Max length1

ChqCurcFactorNum

number

Currency Exchange Factor

💻 UI Fieldname: ChqCurcFactorNum

Max length2216

ChqDesc

string

Check Description (only for manual checks)

💻 UI Fieldname: ChqDesc

Max length60

ChqDraftCode

string

Check Type (M-Manual, C-System Generated)

💻 UI Fieldname: ChqDraftCode

Max length1

ChqPospayExcludeFlag

string

Only applicable if using Positive pay. Set this field to 'N' – this indicates that the check has not been manually excluded from the positive pay file

💻 UI Fieldname: ChqPospayExcludeFlag

Max length1

ChqDeptCode

string

Bank Department Code

💻 UI Fieldname: ChqDeptCode

Max length6

ChqPospayFlag

string

If you will be utilizing Positive Pay – then this field should be set to 'Y' – indicates the check has been included in the positive pay file

💻 UI Fieldname: ChqPospayFlag

Max length1

ChqCurrCode

string

Currency Code

💻 UI Fieldname: ChqCurrCode

Max length3

ChqNum

number

Check Number

💻 UI Fieldname: ChqNum

Max length2211

ChqCompCode

string

Source Company Code

💻 UI Fieldname: ChqCompCode

Max length8

ChqSeqNum

number

Check Sequence Number

💻 UI Fieldname: ChqSeqNum

Max length2211

ChqAmt

number

Check Amount

💻 UI Fieldname: ChqAmt

Max length2218

Responses

201

Created

Headers

Content-Type

string

Exampleapplication/vnd.oracle.adf.resourceitem+json

{
  "Chq1099Code": null,
  "ChqAccCode": "10001",
  "ChqAmt": 2385,
  "ChqBankCompCode": "001",
  "ChqBchNum": 4461212,
  "ChqCompCode": "001",
  "ChqCurcFactorNum": 1,
  "ChqCurrCode": "USD",
  "ChqDate": "2016-08-31",
  "ChqDeptCode": "00",
  "ChqDesc": null,
  "ChqDraftCode": "C",
  "ChqFuncFactorNum": null,
  "ChqGlFactorNum": 1,
  "ChqHandleCode": null,
  "ChqIuCreateDate": null,
  "ChqIuUpdateDate": null,
  "ChqJobCode": null,
  "ChqNum": 112,
  "ChqPayeeFlag": "Y",
  "ChqPayeeSeq": null,
  "ChqPospayCreateDate": null,
  "ChqPospayExcludeFlag": "N",
  "ChqPospayFileName": null,
  "ChqPospayFlag": "N",
  "ChqPospayVoidFlag": "N",
  "ChqPostDate": null,
  "ChqPrintFlag": null,
  "ChqRecDate": null,
  "ChqRefCode": null,
  "ChqRefDesc": null,
  "ChqRegRepFlag": null,
  "ChqRelDate": null,
  "ChqRevCode": null,
  "ChqRevDate": null,
  "ChqScContCode": null,
  "ChqSeqNum": 1829209,
  "ChqVenAddCode": null,
  "ChqVenCode": "0212",
  "ChqVoidVouFlag": null,
  "ChqVouCode": null,
  "ChqWBchNum": null,
  "ChqBchName": null,
  "links": [
    {
      "rel": "self",
      "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/ap-rest-api/rest/1/apcheque/1829209",
      "name": "apcheque",
      "kind": "item"
    },
    {
      "rel": "canonical",
      "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/ap-rest-api/rest/1/apcheque/1829209",
      "name": "apcheque",
      "kind": "item"
    }
  ]
}

object

What's Next

Retrieve AP Cheque by Code

Create a AP Cheque

Create Cheques

What's Next

Contact Us