ChartfieldValidation

ChartfieldValidation

This API validates the individual chartfields within a chartblock and processes the combo edit validation routine for the supplied chartblock based on the current date or a supplied effective date.

More information: https://it.byu.edu
Contact Info: api@byu.edu

Base URL: /domains/erp/fs/chartfieldvalidation

Version: v1

Default response content-types: application/json
Schemes: https

Summary

Path Operation Description
/* GET
OPTIONS

Paths

GET /*

The chartblock consists of the following parameters: operating_unit, account_field, class_field, journal_source, and effective date. All parameters must be present in the url string; however, only those values desired to be validated should be included. At least one chartblock value must be supplied.

operating_unit

operating unit

query string (8 to 8 chars)
account_field

account_field

query string (4 to 4 chars)
class_field

class_field

query string (5 to 5 chars)
journal_source

journal_source

query string (3 to 3 chars)
effective_date

effective_date

query date (10 to 10 chars)

Uses default content-types: application/json

200 OK

The default response type is JSON. Add an Accept header with value=application/xml to return an XML response.

Example for application/json
{
"chartfieldvalidation": {
"chartblock": {
"account_field": {
"description": "Supplies",
"effective_date": "1900-01-01",
"status": "Active",
"value": "3333"
}
,
"class_field": {
"description": "Unclassified",
"effective_date": "1900-01-01",
"status": "Active",
"value": "00000"
}
,
"combo_edit": {
"status": "Valid"
}
,
"effective_date": "2016-06-24",
"journal_source": {
"description": "My descreptive description",
"effective_date": "2005-10-01",
"status": "Active",
"value": "217"
}
,
"operating_unit": {
"contact": {
"byu_id": "345678901",
"email_address": "mickey_mouse@fsdev.byu.edu",
"name": "Mouse, Mickey",
"net_id": "mmouse",
"phone_number": "4567890123"
}
,
"department": {
"contact": {
"byu_id": "345678901",
"email_address": "mickey_mouse@fsdev.byu.edu",
"name": "Mouse, Mickey",
"net_id": "mmouse",
"phone_number": "4567890123"
}
,
"controller": {
"byu_id": "89012345",
"email_address": "clarabelle_cow@fsdev.byu.edu",
"name": "Cow, Clarabelle",
"net_id": "ccow",
"phone_number": "9012345678"
}
,
"dean": {
"byu_id": "456789012",
"email_address": "pluto@fsdev.byu.edu",
"name": "Dog, Pluto",
"net_id": "dpluto",
"phone_number": "5678901234"
}
,
"description": "My Department",
"liaison": {
"byu_id": "678901234",
"email_address": "daffy_duck@fsdev.byu.edu",
"name": "Duck, Daffy",
"net_id": "duckda",
"phone_number": "7890123456"
}
,
"manager": {
"byu_id": "234567890",
"email_address": "duckd@fsdev.byu.edu",
"name": "Duck, Donald",
"net_id": "duckd",
"phone_number": "3456789012"
}
,
"value": "4422",
"vp": {
"byu_id": "456789012",
"email_address": "pluto@fsdev.byu.edu",
"name": "Dog, Pluto",
"net_id": "dpluto",
"phone_number": "5678901234"
}
}
,
"description": "My Oper Unit",
"effective_date": "2015-03-01",
"manager": {
"byu_id": "234567890",
"email_address": "duckd@fsdev.byu.edu",
"name": "Duck, Donald",
"net_id": "duckd",
"phone_number": "3456789012"
}
,
"status": "Active",
"value": "12345678"
}
,
"status": "Success"
}
}
}

OPTIONS /*

Uses default content-types: application/json

200 OK

Schema definitions

account_field:

value: string
status: string
description: string
effective_date: string

chartblock:

effective_date: string (date)
status: string , x x2208; { Failed , Success }
operating_unit: operating_unit
account_field: account_field
class_field: class_field
journal_source: journal_source
combo_edit: combo_edit

chartfieldvalidation: object

chartfieldvalidation: object
chartblock: chartblock

class_field:

value: string
status: string
description: string
effective_date: string

combo_edit:

status: string

contact: object

byu_id: string
net_id: string
name: string
phone_number: string
email_address: string

controller: object

byu_id: string
net_id: string
name: string
phone_number: string
email_address: string

dean: object

byu_id: string
net_id: string
name: string
phone_number: string
email_address: string

department: object

value: string
description: string
manager: manager
contact: contact
vp: vp
dean: dean
liaison: liaison
controller: controller

FinancialChartblockFault001: object

FinancialChartblockFault001: Missing elements in request

failed_code: string , x x2208; { FinancialChartblockFault001 (default) }
failed_reason: string , x x2208; { Missing elements in request (default) }

FinancialChartblockFault003: object

FinancialChartblockFault003: Operating Unit is not valid

failed_code: string , x x2208; { FinancialChartblockFault003 (default) }
failed_reason: string , x x2208; { Operating Unit is not valid (default) }

FinancialChartblockFault003F: object

FinancialChartblockFault003F: Operating Unit is Frozen

failed_code: string , x x2208; { FinancialChartblockFault003F (default) }
failed_reason: string , x x2208; { Operating Unit is Frozen (default) }

FinancialChartblockFault003S: object

FinancialChartblockFault003S: Operating Unit is Active

failed_code: string , x x2208; { FinancialChartblockFault003S (default) }
failed_reason: string , x x2208; { Operating Unit is Active (default) }

FinancialChartblockFault004: object

FinancialChartblockFault004: Account is not valid

failed_code: string , x x2208; { FinancialChartblockFault004 (default) }
failed_reason: string , x x2208; { Account is not valid (default) }

FinancialChartblockFault004S: object

FinancialChartblockFault004S: Account is not active

failed_code: string , x x2208; { FinancialChartblockFault004S (default) }
failed_reason: string , x x2208; { Account is not active (default) }

FinancialChartblockFault005: object

FinancialChartblockFault005: Class is not valid

failed_code: string , x x2208; { FinancialChartblockFault005 (default) }
failed_reason: string , x x2208; { Class is not valid (default) }

FinancialChartblockFault005S: object

FinancialChartblockFault005S: Class is not active

failed_code: string , x x2208; { FinancialChartblockFault005S (default) }
failed_reason: string , x x2208; { Class is not active (default) }

FinancialChartblockFault008: object

FinancialChartblockFault008: Journal SRC is not valid

failed_code: string , x x2208; { FinancialChartblockFault008 (default) }
failed_reason: string , x x2208; { Journal SRC is not valid (default) }

FinancialChartblockFault008S: object

FinancialChartblockFault008S: Journal SRC is not active

failed_code: string , x x2208; { FinancialChartblockFault008S (default) }
failed_reason: string , x x2208; { Journal SRC is not active (default) }

FinancialChartblockFault009: object

FinancialChartblockFault009: Invalid Effective Date, format should be YYYY-MM-DD

failed_code: string , x x2208; { FinancialChartblockFault009 (default) }
failed_reason: string , x x2208; { Invalid Effective Date, format should be YYYY-MM-DD (default) }

FinancialChartblockFault010: object

FinancialChartblockFault010: Chartblock Failed Combo Edit process

failed_code: string , x x2208; { FinancialChartblockFault010 (default) }
failed_reason: string , x x2208; { Chartblock Failed Combo Edit process (default) }

journal_source:

value: string
status: string
description: string
effective_date: string

liaison: object

byu_id: string
net_id: string
name: string
phone_number: string
email_address: string

manager: object

byu_id: string
net_id: string
name: string
phone_number: string
email_address: string

operating_unit:

value: string
status: string
description: string
effective_date: string
manager: manager
contact: contact
department: department

vp: object

byu_id: string
net_id: string
name: string
phone_number: string
email_address: string
Service Path: 
/domains/erp/fs/chartfieldvalidation
Domain or University API: 
/domains/erp/fs/chartfieldvalidation

Community

 

Don't see your question listed here? Ask!