All Downloads are FREE. Search and download functionalities are using the official Maven repository.

eedm.purchasing-arrangements.v13.0.purchasing-arrangements.json Maven / Gradle / Ivy

{
  "title" : "Purchasing Arrangements",
  "description" : "Agreements established with vendors for the purchasing of commodities.",
  "type" : "object",
  "properties" : {
    "metadata" : {
      "$ref" : "resource:/eedm/metadata.json"
    },
    "id" : {
      "title" : "ID",
      "description" : "The global identifier of the purchasing arrangement.",
      "type" : "string",
      "format" : "guid",
      "pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
    },
    "arrangementNumber" : {
      "title" : "Arrangement Number",
      "description" : "The number associated with the purchasing arrangement assigned by the finance system.",
      "type" : "string"
    },
    "referenceNumber" : {
      "title" : "Reference Number",
      "description" : "A reference number specified for the purchasing arrangement by an external system.",
      "type" : "string"
    },
    "vendor" : {
      "title" : "Vendor",
      "description" : "The vendor associated with the purchasing arrangement.",
      "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" ]
    },
    "startOn" : {
      "title" : "Start On",
      "description" : "The first date when the arrangement is available.",
      "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])?$"
    },
    "endOn" : {
      "title" : "End On",
      "description" : "The last date when the arrangement is available.",
      "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])?$"
    },
    "status" : {
      "title" : "Status",
      "description" : "The status of the arrangement.",
      "oneOf" : [ {
        "type" : "string",
        "enum" : [ "active", "suspended" ]
      }, {
        "type" : "string",
        "maxLength" : 0
      } ]
    },
    "buyer" : {
      "title" : "Buyer",
      "description" : "The purchasing agent assigned to the arrangement.",
      "oneOf" : [ {
        "type" : "object",
        "properties" : {
          "id" : {
            "title" : "ID",
            "description" : "The global identifier for the Buyer.",
            "type" : "string",
            "format" : "guid",
            "pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
          }
        },
        "links" : [ {
          "rel" : "self",
          "href" : "/buyers/{id}",
          "targetSchema" : {
            "$ref" : "buyers.json#"
          }
        } ],
        "additionalProperties" : false,
        "required" : [ "id" ]
      }, {
        "type" : "object",
        "maxProperties" : 0
      } ]
    },
    "paymentTerms" : {
      "title" : "Payment Terms",
      "description" : "The payment terms and conditions applicable to the arrangement.",
      "oneOf" : [ {
        "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" ]
      }, {
        "type" : "object",
        "maxProperties" : 0
      } ]
    },
    "additionalAmount" : {
      "title" : "Additional Amount",
      "description" : "Additional charges or discounts such as freight, etc.",
      "oneOf" : [ {
        "type" : "object",
        "format" : "currency",
        "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" ]
      }, {
        "type" : "object",
        "maxProperties" : 0
      } ]
    },
    "taxes" : {
      "title" : "Taxes",
      "description" : "The tax codes applicable to the arrangement.",
      "type" : "array",
      "items" : {
        "title" : "Taxes",
        "description" : "The tax codes applicable to the arrangement.",
        "type" : "object",
        "properties" : {
          "id" : {
            "title" : "ID",
            "description" : "The global identifier for the Taxes.",
            "type" : "string",
            "format" : "guid",
            "pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
          }
        },
        "links" : [ {
          "rel" : "self",
          "href" : "/commerce-tax-codes/{id}",
          "targetSchema" : {
            "$ref" : "commerce-tax-codes.json#"
          }
        } ],
        "additionalProperties" : false,
        "required" : [ "id" ]
      }
    },
    "classification" : {
      "title" : "Classification",
      "description" : "A user defined classification of the arrangement.",
      "oneOf" : [ {
        "type" : "object",
        "properties" : {
          "id" : {
            "title" : "ID",
            "description" : "The global identifier for the Classification.",
            "type" : "string",
            "format" : "guid",
            "pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
          }
        },
        "links" : [ {
          "rel" : "self",
          "href" : "/purchase-classifications/{id}",
          "targetSchema" : {
            "$ref" : "purchase-classifications.json#"
          }
        } ],
        "additionalProperties" : false,
        "required" : [ "id" ]
      }, {
        "type" : "object",
        "maxProperties" : 0
      } ]
    },
    "comments" : {
      "title" : "Comments",
      "description" : "The comments associated with the arrangement.",
      "type" : "array",
      "items" : {
        "type" : "object",
        "properties" : {
          "comment" : {
            "title" : "Comment",
            "description" : "A comment associated with the arrangement.",
            "type" : "string",
            "minLength" : 1
          },
          "type" : {
            "title" : "Type",
            "description" : "An indication of whether the comment is printed or not printed.",
            "enum" : [ "printed", "notPrinted" ],
            "type" : "string"
          }
        },
        "additionalProperties" : false,
        "required" : [ "comment", "type" ]
      }
    },
    "fulfillment" : {
      "title" : "Fulfillment",
      "description" : "An indication if the merchandise will be supplied from inventory or will need to be purchased.",
      "oneOf" : [ {
        "type" : "string",
        "enum" : [ "fromInventory", "externalPurchase" ]
      }, {
        "type" : "string",
        "maxLength" : 0
      } ]
    },
    "shipTo" : {
      "title" : "Ship To",
      "description" : "The destination for the purchased item(s).",
      "oneOf" : [ {
        "type" : "object",
        "properties" : {
          "id" : {
            "title" : "ID",
            "description" : "The global identifier for the Ship To.",
            "type" : "string",
            "format" : "guid",
            "pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
          }
        },
        "links" : [ {
          "rel" : "self",
          "href" : "/ship-to-destinations/{id}",
          "targetSchema" : {
            "$ref" : "ship-to-destinations.json#"
          }
        } ],
        "additionalProperties" : false,
        "required" : [ "id" ]
      }, {
        "type" : "object",
        "maxProperties" : 0
      } ]
    },
    "freeOnBoard" : {
      "title" : "Free On Board",
      "description" : "The free on board (FOB) type specified for the arrangement.",
      "oneOf" : [ {
        "type" : "object",
        "properties" : {
          "id" : {
            "title" : "ID",
            "description" : "The global identifier for the Free On Board.",
            "type" : "string",
            "format" : "guid",
            "pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
          }
        },
        "links" : [ {
          "rel" : "self",
          "href" : "/free-on-board-types/{id}",
          "targetSchema" : {
            "$ref" : "free-on-board-types.json#"
          }
        } ],
        "additionalProperties" : false,
        "required" : [ "id" ]
      }, {
        "type" : "object",
        "maxProperties" : 0
      } ]
    },
    "lineItems" : {
      "title" : "Line Items",
      "description" : "The line items associated with purchasing arrangements.",
      "type" : "array",
      "minItems" : 1,
      "items" : {
        "type" : "object",
        "properties" : {
          "lineItemNumber" : {
            "title" : "Line Item Number",
            "description" : "A system generated number to identify the line item. User specified values will be overwritten.",
            "type" : "string"
          },
          "description" : {
            "title" : "Description",
            "description" : "The description of the commodity specified by the line item.",
            "type" : "string",
            "minLength" : 1
          },
          "commodityCode" : {
            "title" : "Commodity Code",
            "description" : "The commodity code associated with the line item.",
            "oneOf" : [ {
              "type" : "object",
              "properties" : {
                "id" : {
                  "title" : "ID",
                  "description" : "The global identifier for the Commodity Code.",
                  "type" : "string",
                  "format" : "guid",
                  "pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
                }
              },
              "links" : [ {
                "rel" : "self",
                "href" : "/commodity-codes/{id}",
                "targetSchema" : {
                  "$ref" : "commodity-codes.json#"
                }
              } ],
              "additionalProperties" : false,
              "required" : [ "id" ]
            }, {
              "type" : "object",
              "maxProperties" : 0
            } ]
          },
          "quantity" : {
            "title" : "Quantity",
            "description" : "The quantity of the line item.",
            "type" : "number"
          },
          "unitOfMeasure" : {
            "title" : "Unit Of Measure",
            "description" : "The unit of measure type for the line item.",
            "type" : "object",
            "properties" : {
              "id" : {
                "title" : "ID",
                "description" : "The global identifier for the Unit Of Measure.",
                "type" : "string",
                "format" : "guid",
                "pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
              }
            },
            "links" : [ {
              "rel" : "self",
              "href" : "/commodity-unit-types/{id}",
              "targetSchema" : {
                "$ref" : "commodity-unit-types.json#"
              }
            } ],
            "additionalProperties" : false,
            "required" : [ "id" ]
          },
          "unitPrice" : {
            "title" : "Unit Price",
            "description" : "The unit price of the line item.",
            "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" ]
          },
          "comments" : {
            "title" : "Comments",
            "description" : "The comments associated with the line item.",
            "type" : "array",
            "items" : {
              "type" : "object",
              "properties" : {
                "comment" : {
                  "title" : "Comment",
                  "description" : "A comment associated with the line item.",
                  "type" : "string",
                  "minLength" : 1
                },
                "type" : {
                  "title" : "Type",
                  "description" : "An indication of whether the comment is printed or not printed.",
                  "enum" : [ "printed", "notPrinted" ],
                  "type" : "string"
                }
              },
              "additionalProperties" : false,
              "required" : [ "comment", "type" ]
            }
          }
        },
        "additionalProperties" : false,
        "required" : [ "description", "quantity", "unitOfMeasure", "unitPrice" ]
      }
    }
  },
  "required" : [ "id", "vendor", "startOn", "endOn", "lineItems" ],
  "additionalProperties" : false
}




© 2015 - 2025 Weber Informatics LLC | Privacy Policy