eedm.ledger-activities.v11.1.0.ledger-activities.json Maven / Gradle / Ivy
{
"title" : "Ledger Activities",
"description" : "The detailed activity that is posted against the ledger.",
"version" : "11.1.0",
"type" : "object",
"properties" : {
"metadata" : {
"$ref" : "resource:/eedm/metadata.json"
},
"id" : {
"title" : "ID",
"description" : "The global identifier of the ledger activity.",
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
},
"title" : {
"title" : "Title",
"description" : "The full name of the ledger activity.",
"type" : "string",
"minLength" : 1
},
"reportingSegment" : {
"title" : "Reporting Segment",
"description" : "The reporting segment with which the ledger activity is associated (e.g. chart, campus, institution, etc.).",
"type" : "string",
"minLength" : 1
},
"ledgerType" : {
"title" : "Ledger Type",
"description" : "The ledger type associated with the activity (general or operating).",
"oneOf" : [ {
"type" : "string",
"enum" : [ "general", "operating" ]
}, {
"type" : "string",
"maxLength" : 0
} ]
},
"ledgerCategory" : {
"title" : "Ledger Category",
"description" : "The ledger category associated with the activity.",
"enum" : [ "originalBudget", "budgetAdjustment", "actuals", "encumbrance", "reservation", "accountedBudget", "temporaryBudget" ],
"type" : "string"
},
"documentType" : {
"title" : "Document Type",
"description" : "The type of financial document associated with the activity.",
"oneOf" : [ {
"type" : "object",
"properties" : {
"id" : {
"title" : "ID",
"description" : "The global identifier for the Document Type.",
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
},
"links" : [ {
"rel" : "self",
"href" : "/financial-document-types/{id}",
"targetSchema" : {
"$ref" : "financial-document-types.json#"
}
} ],
"additionalProperties" : false,
"required" : [ "id" ]
}, {
"type" : "object",
"maxProperties" : 0
} ]
},
"adjustmentType" : {
"title" : "Adjustment Type",
"description" : "The type of adjustment (opening balance or year-end adjustment).",
"oneOf" : [ {
"type" : "string",
"enum" : [ "openingBalance", "yearEndAdjustment" ]
}, {
"type" : "string",
"maxLength" : 0
} ]
},
"period" : {
"title" : "Period",
"description" : "The fiscal period during which the activity is posted to the ledger.",
"type" : "object",
"properties" : {
"id" : {
"title" : "ID",
"description" : "The global identifier for the 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" ]
},
"transactionDate" : {
"title" : "Transaction Date",
"description" : "The date the activity is posted to the account in the ledger.",
"type" : "string",
"format" : "date",
"pattern" : "^(-?(?:[1-9][0-9]*)?[0-9]{4})-(1[0-2]|0[1-9])-(3[0-1]|0[1-9]|[1-2][0-9])$"
},
"enteredOn" : {
"title" : "Entered On",
"description" : "The date the activity occurred.",
"type" : "string",
"format" : "date",
"pattern" : "^(-?(?:[1-9][0-9]*)?[0-9]{4})-(1[0-2]|0[1-9])-(3[0-1]|0[1-9]|[1-2][0-9])$"
},
"accountingString" : {
"title" : "Accounting String",
"description" : "The accounting string associated with the activity.",
"type" : "string",
"minLength" : 1
},
"accountingStringComponentValues" : {
"title" : "Accounting String Component Values",
"description" : "The accounting string component values associated with the activity.",
"type" : "array",
"minItems" : 1,
"items" : {
"title" : "Accounting String Component Values",
"description" : "The accounting string component values associated with the activity.",
"type" : "object",
"properties" : {
"id" : {
"title" : "ID",
"description" : "The global identifier for the Accounting String Component Values.",
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
},
"links" : [ {
"rel" : "self",
"href" : "/accounting-string-component-values/{id}",
"targetSchema" : {
"$ref" : "accounting-string-component-values.json#"
}
} ],
"additionalProperties" : false,
"required" : [ "id" ]
}
},
"referenceDocumentNumber" : {
"title" : "Reference Document Number",
"description" : "The reference document number associated with the activity.",
"type" : "string"
},
"reference" : {
"title" : "Reference",
"description" : "The person, organization, or institution associated with the activity.",
"oneOf" : [ {
"title" : "person",
"description" : "The person associated with the activity.",
"type" : "object",
"properties" : {
"person" : {
"title" : "Person",
"description" : "The person associated with the activity.",
"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 activity.",
"type" : "object",
"properties" : {
"organization" : {
"title" : "Organization",
"description" : "The organization associated with the activity.",
"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" ]
}, {
"title" : "Institution",
"description" : "The institution associated with the activity.",
"type" : "object",
"properties" : {
"institution" : {
"title" : "Institution",
"description" : "The institution associated with the activity.",
"type" : "object",
"properties" : {
"id" : {
"title" : "ID",
"description" : "The global identifier for the Institution.",
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
},
"links" : [ {
"rel" : "self",
"href" : "/educational-institutions/{id}",
"targetSchema" : {
"$ref" : "educational-institutions.json#"
}
} ],
"additionalProperties" : false,
"required" : [ "id" ]
}
},
"additionalProperties" : false,
"required" : [ "institution" ]
}, {
"type" : "object",
"maxProperties" : 0
} ]
},
"type" : {
"title" : "Type",
"description" : "The type of activity.",
"oneOf" : [ {
"type" : "string",
"enum" : [ "credit", "debit" ]
}, {
"type" : "string",
"maxLength" : 0
} ]
},
"amount" : {
"title" : "Amount",
"description" : "The amount associated with the activity.",
"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" ]
},
"status" : {
"title" : "Status",
"description" : "The status associated with the activity (posted or pending posting).",
"oneOf" : [ {
"type" : "string",
"enum" : [ "posted", "pendingPosting" ]
}, {
"type" : "string",
"maxLength" : 0
} ]
},
"billingStatus" : {
"title" : "Billing Status",
"description" : "The billing status of the expenditure activity (billed or unbilled).",
"oneOf" : [ {
"type" : "string",
"enum" : [ "billed", "unbilled" ]
}, {
"type" : "string",
"maxLength" : 0
} ]
},
"grant" : {
"title" : "Grant",
"description" : "The grant with which the activity is associated.",
"oneOf" : [ {
"type" : "object",
"properties" : {
"id" : {
"title" : "ID",
"description" : "The global identifier for the Grant.",
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
},
"links" : [ {
"rel" : "self",
"href" : "/grants/{id}",
"targetSchema" : {
"$ref" : "grants.json#"
}
} ],
"additionalProperties" : false,
"required" : [ "id" ]
}, {
"type" : "object",
"maxProperties" : 0
} ]
}
},
"required" : [ "id", "title", "reportingSegment", "ledgerCategory", "period", "transactionDate", "enteredOn", "accountingString", "accountingStringComponentValues", "amount" ],
"additionalProperties" : false,
"links" : [ {
"rel" : "namedQuery",
"encType" : "application/x-www-form-urlencoded",
"method" : "GET",
"href" : "/ledger-activities?fiscalYear={\"fiscalYear\": {\"id\": $id}}",
"name" : "fiscalYear",
"title" : "Fiscal Year",
"description" : "Filter by fiscal year.",
"schema" : {
"type" : "object",
"properties" : {
"fiscalYear" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
}
}
}
},
"targetSchema" : {
"$ref" : "ledger-activities.json#"
}
}, {
"rel" : "filter",
"encType" : "application/x-www-form-urlencoded",
"method" : "GET",
"href" : "/ledger-activities?criteria={\"period\": {\"id\": $id}}",
"title" : "Period",
"description" : "Filter by fiscal period.",
"schema" : {
"type" : "object",
"properties" : {
"period" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
}
}
}
},
"targetSchema" : {
"$ref" : "ledger-activities.json#"
}
}, {
"rel" : "filter",
"encType" : "application/x-www-form-urlencoded",
"method" : "GET",
"href" : "/ledger-activities?criteria={\"reportingSegment\": {$reportingSegment}}",
"title" : "Reporting Segment",
"description" : "Filter by reporting segment.",
"schema" : {
"type" : "object",
"properties" : {
"reportingSegment" : {
"type" : "object",
"properties" : {
"title" : {
"type" : "string"
}
}
}
}
},
"targetSchema" : {
"$ref" : "ledger-activities.json#"
}
}, {
"rel" : "filter",
"encType" : "application/x-www-form-urlencoded",
"method" : "GET",
"href" : "/ledger-activities?criteria={\"transactionDate\": {$transactionDate}}",
"title" : "Transaction Date",
"description" : "Filter by transaction date.",
"schema" : {
"type" : "object",
"properties" : {
"transactionDate" : {
"type" : "object",
"properties" : {
"title" : {
"type" : "string",
"format" : "date",
"pattern" : "^(-?(?:[1-9][0-9]*)?[0-9]{4})-(1[0-2]|0[1-9])-(3[0-1]|0[1-9]|[1-2][0-9])$"
}
}
}
}
},
"targetSchema" : {
"$ref" : "ledger-activities.json#"
}
} ]
}© 2015 - 2025 Weber Informatics LLC | Privacy Policy