eedm.student-payments.v11.1.0.student-payments.json Maven / Gradle / Ivy
{
"title" : "Student Payments",
"description" : "Details of payments made by students.",
"version" : "11.1.0",
"type" : "object",
"properties" : {
"metadata" : {
"$ref" : "resource:/eedm/metadata.json"
},
"id" : {
"title" : "ID",
"description" : "The global identifier of the student payment.",
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
},
"student" : {
"title" : "Student",
"description" : "The person (student) who made the payment.",
"type" : "object",
"properties" : {
"id" : {
"title" : "ID",
"description" : "The global identifier for the Student.",
"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" ]
},
"fundingSource" : {
"title" : "Funding Source",
"description" : "The accounting code of the funding source associated with the student payment.",
"type" : "object",
"properties" : {
"id" : {
"title" : "ID",
"description" : "The global identifier for the Funding Source.",
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
},
"links" : [ {
"rel" : "self",
"href" : "/accounting-codes/{id}",
"targetSchema" : {
"$ref" : "accounting-codes.json#"
}
} ],
"additionalProperties" : false,
"required" : [ "id" ]
},
"fundingDestination" : {
"title" : "Funding Destination",
"description" : "The accounting code of the funding destination associated with the student payment.",
"oneOf" : [ {
"type" : "object",
"properties" : {
"id" : {
"title" : "ID",
"description" : "The global identifier for the Funding Destination.",
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
},
"links" : [ {
"rel" : "self",
"href" : "/accounting-codes/{id}",
"targetSchema" : {
"$ref" : "accounting-codes.json#"
}
} ],
"additionalProperties" : false,
"required" : [ "id" ]
}, {
"type" : "object",
"maxProperties" : 0
} ]
},
"academicPeriod" : {
"title" : "Academic Period",
"description" : "The academic period to which the payment is attached.",
"oneOf" : [ {
"type" : "object",
"properties" : {
"id" : {
"title" : "ID",
"description" : "The global identifier for the Academic Period.",
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
},
"links" : [ {
"rel" : "self",
"href" : "/academic-periods/{id}",
"targetSchema" : {
"$ref" : "academic-periods.json#"
}
} ],
"additionalProperties" : false,
"required" : [ "id" ]
}, {
"type" : "object",
"maxProperties" : 0
} ]
},
"paymentType" : {
"title" : "Payment Type",
"description" : "The type of the payment.",
"enum" : [ "deposit", "sponsor", "payroll", "cash" ],
"type" : "string"
},
"paidOn" : {
"title" : "paid On",
"description" : "The date when the payment was made.",
"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])?$"
},
"amount" : {
"title" : "Amount",
"description" : "The amount of the payment.",
"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" ]
},
"reportingDetail" : {
"title" : "Reporting Detail",
"description" : "Attributes specific to the transaction when identified for tax reporting only.",
"oneOf" : [ {
"type" : "object",
"properties" : {
"usage" : {
"title" : "Usage",
"description" : "The usage associated with the payment (i.e. tax reporting only).",
"enum" : [ "taxReportingOnly" ],
"type" : "string"
},
"originatedOn" : {
"title" : "Originated On",
"description" : "The date the payment originated for consideration in tax report generation.",
"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])?$"
}
},
"additionalProperties" : false,
"required" : [ "usage", "originatedOn" ]
}, {
"type" : "object",
"maxProperties" : 0
} ]
},
"overrideDescription" : {
"title" : "Override Description",
"description" : "The override description associated with the payment.",
"type" : "string"
},
"comments" : {
"title" : "Comments",
"description" : "The comments associated with the payment.",
"type" : "array",
"items" : {
"type" : "string"
}
}
},
"required" : [ "id", "student", "fundingSource", "paymentType", "paidOn", "amount" ],
"additionalProperties" : false,
"links" : [ {
"rel" : "filter",
"encType" : "application/x-www-form-urlencoded",
"method" : "GET",
"href" : "/student-payments?criteria={\"student\": {\"id\": $id}}",
"title" : "Student",
"description" : "The person (student) who made the payment.",
"schema" : {
"type" : "object",
"properties" : {
"student" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
}
}
}
},
"targetSchema" : {
"$ref" : "student-payments.json#"
}
}, {
"rel" : "filter",
"encType" : "application/x-www-form-urlencoded",
"method" : "GET",
"href" : "/student-payments?criteria={\"fundingSource\": {\"id\": $id}}",
"title" : "Funding Source",
"description" : "The accounting code of the funding source associated with the student payment.",
"schema" : {
"type" : "object",
"properties" : {
"fundingSource" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
}
}
}
},
"targetSchema" : {
"$ref" : "student-payments.json#"
}
}, {
"rel" : "filter",
"encType" : "application/x-www-form-urlencoded",
"method" : "GET",
"href" : "/student-payments?criteria={\"fundingDestination\": {\"id\": $id}}",
"title" : "Funding Destination",
"description" : "The accounting code of the funding destination associated with the student payment.",
"schema" : {
"type" : "object",
"properties" : {
"fundingDestination" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
}
}
}
},
"targetSchema" : {
"$ref" : "student-payments.json#"
}
}, {
"rel" : "filter",
"encType" : "application/x-www-form-urlencoded",
"method" : "GET",
"href" : "/student-payments?criteria={\"academicPeriod\": {\"id\": $id}}",
"title" : "Academic Period",
"description" : "The academic period to which the payment is attached.",
"schema" : {
"type" : "object",
"properties" : {
"academicPeriod" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
}
}
}
},
"targetSchema" : {
"$ref" : "student-payments.json#"
}
}, {
"rel" : "filter",
"encType" : "application/x-www-form-urlencoded",
"method" : "GET",
"href" : "/student-payments?criteria={\"paymentType\": $paymentType}",
"title" : "Payment Type",
"description" : "The type of the payment.",
"schema" : {
"type" : "object",
"properties" : {
"paymentType" : {
"type" : "string",
"enum" : [ "deposit", "sponsor", "payroll", "cash" ]
}
}
},
"targetSchema" : {
"$ref" : "student-payments.json#"
}
}, {
"rel" : "filter",
"encType" : "application/x-www-form-urlencoded",
"method" : "GET",
"href" : "/student-payments?criteria={\"reportingDetail\":{\"usage\":$usage}}",
"title" : "Usage",
"description" : "The usage associated with the payment (i.e. tax reporting only).",
"schema" : {
"type" : "object",
"properties" : {
"reportingDetail" : {
"type" : "object",
"properties" : {
"usage" : {
"enum" : [ "taxReportingOnly" ],
"type" : "string"
}
}
}
}
},
"targetSchema" : {
"$ref" : "student-payments.json#"
}
} ]
}© 2015 - 2025 Weber Informatics LLC | Privacy Policy