eedm.vendors.v11.0.vendors.json Maven / Gradle / Ivy
{
"title" : "Vendors",
"description" : "A person or organization who offers products or services to an institution.",
"type" : "object",
"properties" : {
"metadata" : {
"$ref" : "resource:/eedm/metadata.json"
},
"id" : {
"title" : "ID",
"description" : "The global identifier of the vendor.",
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
},
"types" : {
"title" : "Types",
"description" : "The type(s) of vendor, i.e. Procurement, eProcurement, or Travel.",
"type" : "array",
"items" : {
"enum" : [ "procurement", "eProcurement", "travel" ],
"type" : "string"
}
},
"vendorDetail" : {
"title" : "Vendor Detail",
"description" : "The person or organization acting as the vendor.",
"oneOf" : [ {
"title" : "organization",
"description" : "Detail information of the organization acting as the vendor.",
"type" : "object",
"properties" : {
"organization" : {
"title" : "Organization",
"description" : "Detail information of the organization acting as the vendor.",
"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" : "person",
"description" : "Detail information of the person acting as the vendor.",
"type" : "object",
"properties" : {
"person" : {
"title" : "Person",
"description" : "Detail information of the person acting as the vendor.",
"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" : "institution",
"description" : "Detail information of the educational institution acting as the vendor.",
"type" : "object",
"properties" : {
"institution" : {
"title" : "Institution",
"description" : "Detail information of the educational institution acting as the vendor.",
"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" ]
} ]
},
"relatedVendors" : {
"title" : "Related Vendors",
"description" : "The vendor(s) assigned to receive payment for this vendor or the parent vendor.",
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"title" : "Type",
"description" : "The type of related vendor.",
"enum" : [ "paymentVendor", "parentVendor" ],
"type" : "string"
},
"vendor" : {
"title" : "Vendor",
"description" : "The related vendor.",
"type" : "object",
"properties" : {
"id" : {
"title" : "ID",
"description" : "The global identifier for the Vendor.",
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
},
"links" : [ {
"rel" : "self",
"href" : "/vendors/{id}",
"targetSchema" : {
"$ref" : "vendors.json#"
}
} ],
"additionalProperties" : false,
"required" : [ "id" ]
}
},
"additionalProperties" : false,
"required" : [ "type", "vendor" ]
}
},
"classifications" : {
"title" : "Classifications",
"description" : "The vendor's classification (E.g. federal contract, small business, etc. )",
"type" : "array",
"items" : {
"title" : "Classifications",
"description" : "The vendor's classification (E.g. federal contract, small business, etc. )",
"type" : "object",
"properties" : {
"id" : {
"title" : "ID",
"description" : "The global identifier for the Classifications.",
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
},
"links" : [ {
"rel" : "self",
"href" : "/vendor-classifications/{id}",
"targetSchema" : {
"$ref" : "vendor-classifications.json#"
}
} ],
"additionalProperties" : false,
"required" : [ "id" ]
}
},
"paymentTerms" : {
"title" : "Payment Terms",
"description" : "The payment terms and conditions that may be applied to the vendor.",
"type" : "array",
"items" : {
"title" : "Payment Terms",
"description" : "The payment terms and conditions that may be applied to the vendor.",
"type" : "object",
"properties" : {
"id" : {
"title" : "ID",
"description" : "The global identifier for the Payment Terms.",
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
},
"links" : [ {
"rel" : "self",
"href" : "/vendor-payment-terms/{id}",
"targetSchema" : {
"$ref" : "vendor-payment-terms.json#"
}
} ],
"additionalProperties" : false,
"required" : [ "id" ]
}
},
"paymentSources" : {
"title" : "Payment Sources",
"description" : "The accounts payable sources associated with the vendor.",
"type" : "array",
"items" : {
"title" : "Payment Sources",
"description" : "The accounts payable sources associated with the vendor.",
"type" : "object",
"properties" : {
"id" : {
"title" : "ID",
"description" : "The global identifier for the Payment Sources.",
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
},
"links" : [ {
"rel" : "self",
"href" : "/accounts-payable-sources/{id}",
"targetSchema" : {
"$ref" : "accounts-payable-sources.json#"
}
} ],
"additionalProperties" : false,
"required" : [ "id" ]
}
},
"statuses" : {
"title" : "Statuses",
"description" : "The statuses (active, approved, stop payment) that apply to the vendor.",
"type" : "array",
"items" : {
"enum" : [ "active", "holdPayment", "approved" ],
"type" : "string"
}
},
"vendorHoldReasons" : {
"title" : "Vendor Hold Reasons",
"description" : "The reasons the vendor has been placed on hold.",
"type" : "array",
"items" : {
"title" : "Vendor Hold Reasons",
"description" : "The reasons the vendor has been placed on hold.",
"type" : "object",
"properties" : {
"id" : {
"title" : "ID",
"description" : "The global identifier for the Vendor Hold Reasons.",
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
},
"links" : [ {
"rel" : "self",
"href" : "/vendor-hold-reasons/{id}",
"targetSchema" : {
"$ref" : "vendor-hold-reasons.json#"
}
} ],
"additionalProperties" : false,
"required" : [ "id" ]
}
},
"startOn" : {
"title" : "Start On",
"description" : "The first date when the vendor was active/registered.",
"oneOf" : [ {
"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])$"
}, {
"type" : "string",
"maxLength" : 0
} ]
},
"endOn" : {
"title" : "End On",
"description" : "The last date when the vendor was active.",
"oneOf" : [ {
"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])$"
}, {
"type" : "string",
"maxLength" : 0
} ]
},
"defaultCurrency" : {
"title" : "Default Currency",
"description" : "The default currency for the vendor.",
"oneOf" : [ {
"type" : "string",
"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",
"maxLength" : 0
} ]
},
"comment" : {
"title" : "Comment",
"description" : "Comment generated regarding the vendor.",
"type" : "string"
}
},
"required" : [ "id", "vendorDetail" ],
"additionalProperties" : false,
"links" : [ {
"rel" : "filter",
"encType" : "application/x-www-form-urlencoded",
"method" : "GET",
"href" : "/vendors/",
"schema" : {
"type" : "object",
"properties" : {
"vendorDetail" : {
"description" : "Filter for the person or organization acting as the vendor.",
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
},
"classifications" : {
"description" : "The vendor's classification (E.g. federal contract, small business, etc.)",
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
},
"statuses" : {
"description" : "The statuses (active, approved, stop payment) that apply to the vendor.",
"type" : "array",
"items" : {
"enum" : [ "active", "holdPayment", "approved" ]
}
},
"relatedReference" : {
"description" : "The vendor assigned to receive payment for this vendor or the parent vendor.",
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"description" : "The type of the related vendor.",
"enum" : [ "paymentVendor", "parentVendor" ]
}
}
}
}
}
}
}, {
"rel" : "vendorType",
"encType" : "application/x-www-form-urlencoded",
"method" : "GET",
"href" : "/vendors?vendorType={\"vendorType\": $vendorType}",
"title" : "Vendor Type",
"description" : "Indicates whether a vendor is of the type eProcurement or travel",
"schema" : {
"type" : "object",
"properties" : {
"vendorType" : {
"type" : "object",
"properties" : {
"vendorType" : {
"enum" : [ "eProcurement", "travel" ]
}
}
}
}
},
"targetSchema" : {
"$ref" : "vendors.json#"
}
} ]
}© 2015 - 2025 Weber Informatics LLC | Privacy Policy