Skip to content

Journal Transactions RESTful API Web Service

Brian Wharton edited this page Jul 15, 2015 · 3 revisions

##Journal Transactions RESTful API Web Service

Payloads

Payment Entry

Retrieve an existing Journal Transactions screen

  • Description: Retrieves an existing Journal Transactions screen based on the batNbr passed
  • Endpoint: /api/generalLedger/screen/{batNbr}
  • HTTP Method: GET
  • Request PayLoad: No Payload
  • Response PayLoad: JournalTransactions.Screen
  • Online Help: Help

Retrieve an existing Journal Transactions batch

  • Description: Retrieves an existing Journal Transactions batch based on the batNbr passed
  • Endpoint: /api/generalLedger/batch/{batNbr}
  • HTTP Method: GET
  • Request PayLoad: No Payload
  • Response PayLoad: Batch
  • Online Help: Help

PV Lookups

PV Lookups are a way to retrieve lists of values used to fill in various fields. Each field in the PV lookup is right wildcarded. Meaning you can put a partial word in and the system will use the left most characters for a partial word search.

Retrieve Batches

  • Description: Retrieves a list of Journal Transactions batches based on the batNbr passed
  • Endpoint: /api/pvLookup/batchs?batNbr={batNbr}
  • HTTP Method: GET
  • Request PayLoad: No Payload
  • Response PayLoad: Batch
  • Online Help: Help

Retrieve GLTrans

  • Description: Retrieves a list of Journal Transactions GLTrans based on the batNbr and lineNbr passed
  • Endpoint: /api/pvLookup/batchs?batNbr={batNbr}&lineNbr={lineNbr}
  • HTTP Method: GET
  • Request PayLoad: No Payload
  • Response PayLoad: GLTrans
  • Online Help: Help

Retrieve AcctXrefs

  • Description: Retrieves a list of Journal Transactions AcctXref based on the acct passed
  • Endpoint: /api/pvLookup/batchs?batNbr={batNbr}&lineNbr={lineNbr}
  • HTTP Method: GET
  • Request PayLoad: No Payload
  • Response PayLoad: AcctXref
  • Online Help: Help

Retrieve projects

  • Description: Retrieves a list of Journal Transactions projects based on the projectID passed
  • Endpoint: /api/pvLookup/batchs?projectID={projectID}
  • HTTP Method: GET
  • Request PayLoad: No Payload
  • Response PayLoad: PJPROJ
  • Online Help: Help

Retrieve tasks

  • Description: Retrieves a list of Journal Transactions tasks based on the projectID and entityID passed
  • Endpoint: /api/pvLookup/tasks?projectID={projectID}&entityID={entityID}
  • HTTP Method: GET
  • Request PayLoad: No Payload
  • Response PayLoad: PJPENT
  • Online Help: Help

Retrieve subXrefs

  • Description: Retrieves a list of Journal Transactions subXrefs based on the sub passed
  • Endpoint: /api/pvLookup/tasks?sub={sub}
  • HTTP Method: GET
  • Request PayLoad: No Payload
  • Response PayLoad: SubXref
  • Online Help: Help

Retrieve employees

  • Description: Retrieves a list of Journal Transactions employees based on the sub passed
  • Endpoint: /api/pvLookup/employees?employee={employee}
  • HTTP Method: GET
  • Request PayLoad: No Payload
  • Response PayLoad: PJEMPLOY
  • Online Help: Help

Retrieve laborClasses

  • Description: Retrieves a list of Journal Transactions employees based on the codeValue passed
  • Endpoint: /api/pvLookup/laborClasses?codeValue={codeValue}
  • HTTP Method: GET
  • Request PayLoad: No Payload
  • Response PayLoad: PJCODE
  • Online Help: Help
Clone this wiki locally