eedm.general-ledger-transactions.v12.2.0.general-ledger-transactions.json Maven / Gradle / Ivy
{
"title" : "General Ledger Transactions",
"description" : "The details of transactions to be entered into the general ledger.",
"version" : "12.2.0",
"type" : "object",
"properties" : {
"metadata" : {
"$ref" : "resource:/eedm/metadata.json"
},
"id" : {
"title" : "ID",
"description" : "The global identifier of the general ledger transaction.",
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
},
"processMode" : {
"title" : "Process Mode",
"description" : "An indicator that specifies if the authoritative source should just validate the accounting string or if it should post/update a general ledger transaction.",
"enum" : [ "updateImmediate", "validate", "updateBatch" ],
"type" : "string"
},
"submittedBy" : {
"title" : "Submitted By",
"description" : "The person submitting the general ledger transactions.",
"oneOf" : [ {
"type" : "object",
"properties" : {
"id" : {
"title" : "ID",
"description" : "The global identifier for the Submitted By.",
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
},
"links" : [ {
"rel" : "self",
"href" : "/persons/{id}",
"targetSchema" : {
"$ref" : "persons.json#"
}
} ],
"additionalProperties" : false,
"required" : [ "id" ]
}, {
"type" : "object",
"maxProperties" : 0
} ]
},
"comment" : {
"title" : "Comment",
"description" : "The comment associated with the transaction.",
"type" : "string"
},
"transactions" : {
"title" : "Transactions",
"description" : "A list of associated general ledger transactions.",
"type" : "array",
"minItems" : 1,
"items" : {
"type" : "object",
"properties" : {
"type" : {
"title" : "Type",
"description" : "The type of the general ledger transaction (e.g. journal entry, encumbrance, budget).",
"enum" : [ "approvedBudget", "contingentBudget", "approvedBudgetAdjustment", "temporaryBudget", "temporaryBudgetAdjustment", "encumbranceOpenBalance", "generalEncumbranceCreate", "generalEncumbranceAdjust", "generalEncumbranceLiquidation", "generalEncumbranceClose", "payrollEncumbranceCreate", "payrollEncumbranceAdjust", "payrollEncumbranceLiquidation", "payrollEncumbranceClose", "travelEncumbranceCreate", "travelEncumbranceAdjust", "travelEncumbranceClose", "donation", "donationEndowed", "pledge", "pledgeEndowed", "financialAidTransmittal", "studentCharge", "studentInvoice", "studentPayment", "grantCharge", "grantInvoice", "grantPayment", "otherCharge", "otherInvoice", "otherPayment", "paymentAllocation", "depositAllocation", "miscCashReceipt", "cashDisbursement", "purchaseCardCharge", "miscGeneralLedgerTransaction", "purchaseJournal", "travelAdvance", "travelExpense", "yearEndCloseEntry", "payroll", "payrollWithLiquidation", "actualOpenBalance" ],
"type" : "string"
},
"referenceNumber" : {
"title" : "Reference Number",
"description" : "A source reference number/document number for the transaction.",
"type" : "string"
},
"transactionNumber" : {
"title" : "Transaction Number",
"description" : "A sequential number associated with the transaction.",
"type" : "string"
},
"ledgerDate" : {
"title" : "Ledger Date",
"description" : "The date the transaction is credited/debited to the account in the general ledger (i.e. posting date).",
"type" : "string",
"format" : "date-time",
"pattern" : "^(-?(?:[1-9][0-9]*)?[0-9]{4})-(1[0-2]|0[1-9])-(3[0-1]|0[1-9]|[1-2][0-9])T(2[0-3]|[0-1][0-9]):([0-5][0-9]):([0-5][0-9])(\\.[0-9]+)?(Z|[+-](?:2[0-3]|[0-1][0-9]):[0-5][0-9])?$"
},
"transactionTypeReferenceDate" : {
"title" : "Transaction Type Reference Date",
"description" : "A supplementary date assigned to the transaction based on the transaction type.",
"oneOf" : [ {
"type" : "string",
"format" : "date-time",
"pattern" : "^(-?(?:[1-9][0-9]*)?[0-9]{4})-(1[0-2]|0[1-9])-(3[0-1]|0[1-9]|[1-2][0-9])T(2[0-3]|[0-1][0-9]):([0-5][0-9]):([0-5][0-9])(\\.[0-9]+)?(Z|[+-](?:2[0-3]|[0-1][0-9]):[0-5][0-9])?$"
}, {
"type" : "string",
"maxLength" : 0
} ]
},
"externalBatchReference" : {
"title" : "External Batch Reference",
"description" : "An external reference number that identifies the transaction as being included in a specified batch.",
"type" : "string"
},
"reference" : {
"title" : "Reference",
"description" : "The person or organization associated with the transaction.",
"oneOf" : [ {
"title" : "Person",
"description" : "The person associated with the transaction.",
"type" : "object",
"properties" : {
"person" : {
"title" : "Person",
"description" : "The person associated with the transaction.",
"type" : "object",
"properties" : {
"id" : {
"title" : "ID",
"description" : "The global identifier for the Person.",
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
},
"links" : [ {
"rel" : "self",
"href" : "/persons/{id}",
"targetSchema" : {
"$ref" : "persons.json#"
}
} ],
"additionalProperties" : false,
"required" : [ "id" ]
}
},
"additionalProperties" : false,
"required" : [ "person" ]
}, {
"title" : "Organization",
"description" : "The organization associated with the transaction.",
"type" : "object",
"properties" : {
"organization" : {
"title" : "Organization",
"description" : "The organization associated with the transaction.",
"type" : "object",
"properties" : {
"id" : {
"title" : "ID",
"description" : "The global identifier for the Organization.",
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
},
"links" : [ {
"rel" : "self",
"href" : "/organizations/{id}",
"targetSchema" : {
"$ref" : "organizations.json#"
}
} ],
"additionalProperties" : false,
"required" : [ "id" ]
}
},
"additionalProperties" : false,
"required" : [ "organization" ]
}, {
"type" : "object",
"maxProperties" : 0
} ]
},
"transactionDetailLines" : {
"title" : "Transaction Detail Lines",
"description" : "The detailed accounting lines associated with the transaction.",
"type" : "array",
"minItems" : 1,
"items" : {
"type" : "object",
"properties" : {
"sequenceNumber" : {
"title" : "Sequence Number",
"description" : "An optional tracking number for the detailed accounting line.",
"oneOf" : [ {
"type" : "number"
}, {
"type" : "null"
} ]
},
"accountingString" : {
"title" : "Accounting String",
"description" : "The accounting string associated with the transaction detail line.",
"type" : "string",
"minLength" : 1
},
"description" : {
"title" : "Description",
"description" : "The description of the detailed accounting line.",
"type" : "string",
"minLength" : 1
},
"type" : {
"title" : "Type",
"description" : "The type of detailed accounting line (credit/debit).",
"enum" : [ "credit", "debit" ],
"type" : "string"
},
"amount" : {
"title" : "Amount",
"description" : "The amount of the credit or debit.",
"format" : "currency",
"type" : "object",
"properties" : {
"value" : {
"title" : "Value",
"description" : "The monetary value",
"type" : "number"
},
"currency" : {
"title" : "Currency",
"description" : "The ISO 4217 currency code",
"enum" : [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWL" ],
"type" : "string"
}
},
"additionalProperties" : false,
"required" : [ "value", "currency" ]
},
"budgetOverride" : {
"title" : "Budget Override",
"description" : "An indication if the budget was overridden or not.",
"oneOf" : [ {
"type" : "string",
"enum" : [ "override", "noOverride" ]
}, {
"type" : "string",
"maxLength" : 0
} ]
},
"submittedBy" : {
"title" : "Submitted By",
"description" : "The person submitting the general ledger transaction.",
"oneOf" : [ {
"type" : "object",
"properties" : {
"id" : {
"title" : "ID",
"description" : "The global identifier for the Submitted By.",
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
},
"links" : [ {
"rel" : "self",
"href" : "/persons/{id}",
"targetSchema" : {
"$ref" : "persons.json#"
}
} ],
"additionalProperties" : false,
"required" : [ "id" ]
}, {
"type" : "object",
"maxProperties" : 0
} ]
},
"budgetPeriod" : {
"title" : "Budget Period",
"description" : "The budget period associated with the transaction.",
"oneOf" : [ {
"type" : "object",
"properties" : {
"id" : {
"title" : "ID",
"description" : "The global identifier for the Budget Period.",
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
},
"links" : [ {
"rel" : "self",
"href" : "/fiscal-periods/{id}",
"targetSchema" : {
"$ref" : "fiscal-periods.json#"
}
} ],
"additionalProperties" : false,
"required" : [ "id" ]
}, {
"type" : "object",
"maxProperties" : 0
} ]
},
"giftUnits" : {
"title" : "Gift Units",
"description" : "The number of gift units associated with the transaction.",
"oneOf" : [ {
"type" : "number"
}, {
"type" : "null"
} ]
},
"encumbrance" : {
"title" : "Encumbrance",
"description" : "The encumbrance associated with this transaction.",
"type" : "object",
"properties" : {
"number" : {
"title" : "Number",
"description" : "The encumbrance number.",
"type" : "string"
},
"lineItemNumber" : {
"title" : "Line Item Number",
"description" : "The line item number.",
"oneOf" : [ {
"type" : "number"
}, {
"type" : "null"
} ]
},
"sequenceNumber" : {
"title" : "Sequence Number",
"description" : "The sequence number of the accounting string.",
"oneOf" : [ {
"type" : "number"
}, {
"type" : "null"
} ]
},
"adjustmentType" : {
"title" : "Adjustment Type",
"description" : "The adjustment type for the encumbrance.",
"oneOf" : [ {
"type" : "string",
"enum" : [ "partial", "total", "adjustment" ]
}, {
"type" : "string",
"maxLength" : 0
} ]
},
"commitmentType" : {
"title" : "Commitment Type",
"description" : "The type of commitment (committed or uncommitted)",
"oneOf" : [ {
"type" : "string",
"enum" : [ "committed", "uncommitted" ]
}, {
"type" : "string",
"maxLength" : 0
} ]
}
},
"additionalProperties" : false
}
},
"additionalProperties" : false,
"required" : [ "accountingString", "description", "type", "amount" ]
}
}
},
"additionalProperties" : false,
"required" : [ "type", "ledgerDate", "transactionDetailLines" ]
}
}
},
"required" : [ "id", "processMode", "transactions" ],
"additionalProperties" : false,
"links" : [ {
"rel" : "filter",
"encType" : "application/x-www-form-urlencoded",
"method" : "GET",
"href" : "/general-ledger-transactions?criteria={\"transactions\":[{\"referenceNumber\": {$referenceNumber}}]}",
"title" : "Reference Number",
"description" : "A source reference number/document number for the transaction detail line.",
"schema" : {
"type" : "object",
"properties" : {
"transactions" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"referenceNumber" : {
"type" : "string"
}
}
}
}
}
},
"targetSchema" : {
"$ref" : "general-ledger-transactions.json#"
}
}, {
"rel" : "filter",
"encType" : "application/x-www-form-urlencoded",
"method" : "GET",
"href" : "/general-ledger-transactions?criteria={\"transactions\":[{\"externalBatchReference\": {externalBatchReference}}]}",
"title" : "Reference Number",
"description" : "An external reference number that identifies the transaction as being included in a specified batch.",
"schema" : {
"type" : "object",
"properties" : {
"transactions" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"externalBatchReference" : {
"type" : "string"
}
}
}
}
}
},
"targetSchema" : {
"$ref" : "general-ledger-transactions.json#"
}
} ]
}© 2015 - 2025 Weber Informatics LLC | Privacy Policy