Journal
Processes and returns process status of Journal Entry.
Base URL: /domains/erp/fs/journals/v1
Version: v1
Summary
| Path | Operation | Description |
|---|---|---|
| /* | POST | Posts journal entry to the database |
| /jrnl | GET | Returns process status on specific journal entry |
| /jrnls | GET | Returns all cleared journals in specified month |
Paths
Posts journal and lines to the staging tables for further process
journal and line information
- journal: object
-
- lines: object[]
-
object - amount: string
-
Monetary Amount
"100.00" - journal_line: string
-
Line number for the journal line
"1" - class_fld: string
-
Class
"00000" - journal_line_date: string
-
Date asssociated with the line entry
"07012018" - line_description: string
-
Description
"journal line purchase" - account: string
-
Account
"1234" - operating_unit: string
-
Operating Unit
"12345678"
- header: object
-
- business_unit: string
-
Business, usually 'BYU'
"BYU" - ledger_group: string
-
Ledger group of journal
"BUDGETS" - source: string
-
Source of Journal submission
"123" - journal_date: string
-
The date associated with the journal_id
"07012018" - description: string
-
Description of journal entry
"my journal" - journal_id: string
-
The id of the journal entry
"AAA123456"
- 200 OK
-
Success
- validation_response: string[]
-
string "Status of journal entry"
- 400 Bad Request
-
Invalid
- validation_response: string[]
-
string "Invalid journal entry"
Returns status of specified journal entry and date
| journal_id | Returns status journal that matches the journal_id | query | string | |
| journal_date | Correlates with specified journal_id | query | date , must match yyyy-MM-dd |
- 200 OK
-
Success
- validation_response: string[]
-
string "Status of journal entry"
- 400 Bad Request
-
Incorrect date format
- validation_response: string[]
-
string "Invalid date. Please format date as yyyy-mm-dd"
- 404 Not Found
-
Journal not found
- validation_response: string[]
-
string "A journal with that ID (0123456789) and date (01011990) was not found."
Returns all cleared journals in specified month
| journal_date | Date with month and year of desired journals, day does not matter | query | date , must match yyyy-MM-dd |
- 200 OK
-
Success
- items: object
-
Example for application/json{
"journals": {
"journal": {
"header": {
"business_unit": "BYU",
"description": "journal 111",
"journal_date": "01011990",
"journal_id": "journal111",
"ledger_group": "example@gmail.com",
"source": "123"
},
"lines": {
"amount": "25.00",
"class_fld": "12345",
"journal_line": "1",
"journal_line_date": "01011990",
"line_description": "journal line",
"operating_unit": "12345678"
}
}
}
} - 400 Bad Request
-
Incorrect date format
- validation_response: string[]
-
string "Invalid date. Please format date as yyyy-mm-dd"
- 404 Not Found
-
Journal not found
- validation_response: string[]
-
string "A journal with that ID (0123456789) and date(01011990) not found."
