org.oasis-open.ubl.schemas.maindoc.UBL-Order-2.1.json Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of tradeshift-ubl-jsonschema
UBL is designed to provide a universally understood and recognized commercial syntax for legally binding business documents and to operate within a standard business framework such as ISO 15000 (ebXML) to provide a complete, standards-based infrastructure that can extend the benefits of existing EDI systems to businesses of all sizes. UBL is freely available to everyone without legal encumbrance or licensing fees.
The newest version!
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "json-schema/maindoc/UBL-Order-2.1.json",
  "description": "\n  Library:           OASIS Universal Business Language (UBL) 2.1 OS\n                     http://docs.oasis-open.org/ubl/os-UBL-2.1/\n  Release Date:      04 November 2013\n  Module:            json-schema/maindoc/UBL-Order-2.1.json\n  Generated on:      2017-01-06 03:20z\n  Copyright (c) OASIS Open 2016. All Rights Reserved.\n\n\n  OASIS takes no position regarding the validity or scope of any \n  intellectual property or other rights that might be claimed to pertain \n  to the implementation or use of the technology described in this \n  document or the extent to which any license under such rights \n  might or might not be available; neither does it represent that it has \n  made any effort to identify any such rights. Information on OASIS's \n  procedures with respect to rights in OASIS specifications can be \n  found at the OASIS website. Copies of claims of rights made \n  available for publication and any assurances of licenses to be made \n  available, or the result of an attempt made to obtain a general \n  license or permission for the use of such proprietary rights by \n  implementors or users of this specification, can be obtained from \n  the OASIS Executive Director.\n\n  OASIS invites any interested party to bring to its attention any \n  copyrights, patents or patent applications, or other proprietary \n  rights which may cover technology that may be required to \n  implement this specification. Please address the information to the \n  OASIS Executive Director.\n  \n  This document and translations of it may be copied and furnished to \n  others, and derivative works that comment on or otherwise explain \n  it or assist in its implementation may be prepared, copied, \n  published and distributed, in whole or in part, without restriction of \n  any kind, provided that the above copyright notice and this \n  paragraph are included on all such copies and derivative works. \n  However, this document itself may not be modified in any way, \n  such as by removing the copyright notice or references to OASIS, \n  except as needed for the purpose of developing OASIS \n  specifications, in which case the procedures for copyrights defined \n  in the OASIS Intellectual Property Rights document must be \n  followed, or as required to translate it into languages other than \n  English. \n\n  The limited permissions granted above are perpetual and will not be \n  revoked by OASIS or its successors or assigns. \n\n  This document and the information contained herein is provided on \n  an \"AS IS\" basis and OASIS DISCLAIMS ALL WARRANTIES, \n  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY \n  WARRANTY THAT THE USE OF THE INFORMATION HEREIN \n  WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED \n  WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A \n  PARTICULAR PURPOSE.    \n",
  "required": [
    "Order"
    ],
  "properties": {
    "_D": {
      "description": "Document ABIE XML namespace string",
      "type": "string"
      },
    "_S": {
      "description": "Library ABIE XML namespace string (for ASBIEs)",
      "type": "string"
      },
    "_B": {
      "description": "BBIE XML namespace string",
      "type": "string"
      },
    "_E": {
      "description": "Extension scaffolding XML namespace string",
      "type": "string"
      },
    "Order": {
      "description": "A document used to order goods and services.",
      "items": {
        "$ref": "#/definitions/Order"
        },
      "maxItems": 1,
      "minItems": 1,
      "type": "array"
      }
    },
  "additionalProperties": false,
  "type": "object",
  "definitions": {
    "Order": {
      "title": "Order. Details",
      "description": "A document used to order goods and services.",
      "required": [
        "ID",
        "IssueDate",
        "BuyerCustomerParty",
        "SellerSupplierParty",
        "OrderLine"
        ],
      "properties": {

        "UBLExtensions": {
          "title": "UBLExtensions",
          "description": "An optional set of extensions to the committee model",
          "items": { 
            "$ref": "../common/UBL-CommonExtensionComponents-2.1.json#/definitions/UBLExtensions" },
          "maxItems": 1,
          "minItems": 1,
          "additionalProperties": false,
          "type": "array"
          },

        "UBLVersionID": {
          "title": "Order. UBL Version Identifier. Identifier",
          "description": "Identifies the earliest version of the UBL 2 schema for this document type that defines all of the elements that might be encountered in the current instance.",
          "items": {
            "$ref": "../common/UBL-CommonBasicComponents-2.1.json#/definitions/UBLVersionID"
            },
          "maxItems": 1,
          "minItems": 1,
          "additionalProperties": false,
          "type": "array"
          },
        "CustomizationID": {
          "title": "Order. Customization Identifier. Identifier",
          "description": "Identifies a user-defined customization of UBL for a specific use.",
          "items": {
            "$ref": "../common/UBL-CommonBasicComponents-2.1.json#/definitions/CustomizationID"
            },
          "maxItems": 1,
          "minItems": 1,
          "additionalProperties": false,
          "type": "array"
          },
        "ProfileID": {
          "title": "Order. Profile Identifier. Identifier",
          "description": "Identifies a user-defined profile of the customization of UBL being used.",
          "items": {
            "$ref": "../common/UBL-CommonBasicComponents-2.1.json#/definitions/ProfileID"
            },
          "maxItems": 1,
          "minItems": 1,
          "additionalProperties": false,
          "type": "array"
          },
        "ProfileExecutionID": {
          "title": "Order. Profile Execution Identifier. Identifier",
          "description": "Identifies an instance of executing a profile, to associate all transactions in a collaboration.",
          "items": {
            "$ref": "../common/UBL-CommonBasicComponents-2.1.json#/definitions/ProfileExecutionID"
            },
          "maxItems": 1,
          "minItems": 1,
          "additionalProperties": false,
          "type": "array"
          },
        "ID": {
          "title": "Order. Identifier",
          "description": "An identifier for this document, assigned by the sender.",
          "items": {
            "$ref": "../common/UBL-CommonBasicComponents-2.1.json#/definitions/ID"
            },
          "maxItems": 1,
          "minItems": 1,
          "additionalProperties": false,
          "type": "array"
          },
        "SalesOrderID": {
          "title": "Order. Sales_ Order Identifier. Identifier",
          "description": "An identifier for the Order, assigned by the seller.",
          "items": {
            "$ref": "../common/UBL-CommonBasicComponents-2.1.json#/definitions/SalesOrderID"
            },
          "maxItems": 1,
          "minItems": 1,
          "additionalProperties": false,
          "type": "array"
          },
        "CopyIndicator": {
          "title": "Order. Copy_ Indicator. Indicator",
          "description": "Indicates whether this document is a copy (true) or not (false).",
          "items": {
            "$ref": "../common/UBL-CommonBasicComponents-2.1.json#/definitions/CopyIndicator"
            },
          "maxItems": 1,
          "minItems": 1,
          "additionalProperties": false,
          "type": "array"
          },
        "UUID": {
          "title": "Order. UUID. Identifier",
          "description": "A universally unique identifier for an instance of this document.",
          "items": {
            "$ref": "../common/UBL-CommonBasicComponents-2.1.json#/definitions/UUID"
            },
          "maxItems": 1,
          "minItems": 1,
          "additionalProperties": false,
          "type": "array"
          },
        "IssueDate": {
          "title": "Order. Issue Date. Date",
          "description": "The date, assigned by the sender, on which this document was issued.",
          "items": {
            "$ref": "../common/UBL-CommonBasicComponents-2.1.json#/definitions/IssueDate"
            },
          "maxItems": 1,
          "minItems": 1,
          "additionalProperties": false,
          "type": "array"
          },
        "IssueTime": {
          "title": "Order. Issue Time. Time",
          "description": "The time, assigned by the sender, at which this document was issued.",
          "items": {
            "$ref": "../common/UBL-CommonBasicComponents-2.1.json#/definitions/IssueTime"
            },
          "maxItems": 1,
          "minItems": 1,
          "additionalProperties": false,
          "type": "array"
          },
        "OrderTypeCode": {
          "title": "Order. Order Type Code. Code",
          "description": "A code signifying the type of Order.",
          "items": {
            "$ref": "../common/UBL-CommonBasicComponents-2.1.json#/definitions/OrderTypeCode"
            },
          "maxItems": 1,
          "minItems": 1,
          "additionalProperties": false,
          "type": "array"
          },
        "Note": {
          "title": "Order. Note. Text",
          "description": "Free-form text pertinent to this document, conveying information that is not contained explicitly in other structures.",
          "items": {
            "$ref": "../common/UBL-CommonBasicComponents-2.1.json#/definitions/Note"
            },
          "minItems": 1,
          "additionalProperties": false,
          "type": "array"
          },
        "RequestedInvoiceCurrencyCode": {
          "title": "Order. Requested Invoice_ Currency Code. Code",
          "description": "A code signifying the currency requested for amount totals in Invoices related to this Order.",
          "items": {
            "$ref": "../common/UBL-CommonBasicComponents-2.1.json#/definitions/RequestedInvoiceCurrencyCode"
            },
          "maxItems": 1,
          "minItems": 1,
          "additionalProperties": false,
          "type": "array"
          },
        "DocumentCurrencyCode": {
          "title": "Order. Document_ Currency Code. Code",
          "description": "A code signifying the default currency for this document.",
          "items": {
            "$ref": "../common/UBL-CommonBasicComponents-2.1.json#/definitions/DocumentCurrencyCode"
            },
          "maxItems": 1,
          "minItems": 1,
          "additionalProperties": false,
          "type": "array"
          },
        "PricingCurrencyCode": {
          "title": "Order. Pricing_ Currency Code. Code",
          "description": "A code signifying the currency used for all prices in the Order.",
          "items": {
            "$ref": "../common/UBL-CommonBasicComponents-2.1.json#/definitions/PricingCurrencyCode"
            },
          "maxItems": 1,
          "minItems": 1,
          "additionalProperties": false,
          "type": "array"
          },
        "TaxCurrencyCode": {
          "title": "Order. Tax_ Currency Code. Code",
          "description": "A code signifying the currency requested for tax amounts in Invoices related to this Order.",
          "items": {
            "$ref": "../common/UBL-CommonBasicComponents-2.1.json#/definitions/TaxCurrencyCode"
            },
          "maxItems": 1,
          "minItems": 1,
          "additionalProperties": false,
          "type": "array"
          },
        "CustomerReference": {
          "title": "Order. Customer_ Reference. Text",
          "description": "A supplementary reference for the Order.",
          "items": {
            "$ref": "../common/UBL-CommonBasicComponents-2.1.json#/definitions/CustomerReference"
            },
          "maxItems": 1,
          "minItems": 1,
          "additionalProperties": false,
          "type": "array"
          },
        "AccountingCostCode": {
          "title": "Order. Accounting Cost Code. Code",
          "description": "The buyer's accounting code, applied to the Order as a whole.",
          "items": {
            "$ref": "../common/UBL-CommonBasicComponents-2.1.json#/definitions/AccountingCostCode"
            },
          "maxItems": 1,
          "minItems": 1,
          "additionalProperties": false,
          "type": "array"
          },
        "AccountingCost": {
          "title": "Order. Accounting Cost. Text",
          "description": "The buyer's accounting cost centre, applied to the Order as a whole, expressed as text.",
          "items": {
            "$ref": "../common/UBL-CommonBasicComponents-2.1.json#/definitions/AccountingCost"
            },
          "maxItems": 1,
          "minItems": 1,
          "additionalProperties": false,
          "type": "array"
          },
        "LineCountNumeric": {
          "title": "Order. Line Count. Numeric",
          "description": "The number of Order Lines in the document.",
          "items": {
            "$ref": "../common/UBL-CommonBasicComponents-2.1.json#/definitions/LineCountNumeric"
            },
          "maxItems": 1,
          "minItems": 1,
          "additionalProperties": false,
          "type": "array"
          },
        "ValidityPeriod": {
          "title": "Order. Validity_ Period. Period",
          "description": "The period for which the Order is valid.",
          "items": {
            "$ref": "../common/UBL-CommonAggregateComponents-2.1.json#/definitions/ValidityPeriod"
            },
          "minItems": 1,
          "additionalProperties": false,
          "type": "array"
          },
        "QuotationDocumentReference": {
          "title": "Order. Quotation_ Document Reference. Document Reference",
          "description": "A reference to a Quotation.",
          "items": {
            "$ref": "../common/UBL-CommonAggregateComponents-2.1.json#/definitions/QuotationDocumentReference"
            },
          "maxItems": 1,
          "minItems": 1,
          "additionalProperties": false,
          "type": "array"
          },
        "OrderDocumentReference": {
          "title": "Order. Order_ Document Reference. Document Reference",
          "description": "A reference to another Order.",
          "items": {
            "$ref": "../common/UBL-CommonAggregateComponents-2.1.json#/definitions/OrderDocumentReference"
            },
          "minItems": 1,
          "additionalProperties": false,
          "type": "array"
          },
        "OriginatorDocumentReference": {
          "title": "Order. Originator_ Document Reference. Document Reference",
          "description": "A reference to an originator document associated with this document.",
          "items": {
            "$ref": "../common/UBL-CommonAggregateComponents-2.1.json#/definitions/OriginatorDocumentReference"
            },
          "maxItems": 1,
          "minItems": 1,
          "additionalProperties": false,
          "type": "array"
          },
        "CatalogueReference": {
          "title": "Order. Catalogue Reference",
          "description": "A reference to the Catalogue on which this Order is based.",
          "items": {
            "$ref": "../common/UBL-CommonAggregateComponents-2.1.json#/definitions/CatalogueReference"
            },
          "maxItems": 1,
          "minItems": 1,
          "additionalProperties": false,
          "type": "array"
          },
        "AdditionalDocumentReference": {
          "title": "Order. Additional_ Document Reference. Document Reference",
          "description": "A reference to an additional document associated with this document.",
          "items": {
            "$ref": "../common/UBL-CommonAggregateComponents-2.1.json#/definitions/AdditionalDocumentReference"
            },
          "minItems": 1,
          "additionalProperties": false,
          "type": "array"
          },
        "Contract": {
          "title": "Order. Contract",
          "description": "A contracts associated with this Order.",
          "items": {
            "$ref": "../common/UBL-CommonAggregateComponents-2.1.json#/definitions/Contract"
            },
          "minItems": 1,
          "additionalProperties": false,
          "type": "array"
          },
        "ProjectReference": {
          "title": "Order. Project Reference",
          "description": "A project with which this Order is associated.",
          "items": {
            "$ref": "../common/UBL-CommonAggregateComponents-2.1.json#/definitions/ProjectReference"
            },
          "minItems": 1,
          "additionalProperties": false,
          "type": "array"
          },
        "Signature": {
          "title": "Order. Signature",
          "description": "A signature applied to this document.",
          "items": {
            "$ref": "../common/UBL-CommonAggregateComponents-2.1.json#/definitions/Signature"
            },
          "minItems": 1,
          "additionalProperties": false,
          "type": "array"
          },
        "BuyerCustomerParty": {
          "title": "Order. Buyer_ Customer Party. Customer Party",
          "description": "The buyer.",
          "items": {
            "$ref": "../common/UBL-CommonAggregateComponents-2.1.json#/definitions/BuyerCustomerParty"
            },
          "maxItems": 1,
          "minItems": 1,
          "additionalProperties": false,
          "type": "array"
          },
        "SellerSupplierParty": {
          "title": "Order. Seller_ Supplier Party. Supplier Party",
          "description": "The seller.",
          "items": {
            "$ref": "../common/UBL-CommonAggregateComponents-2.1.json#/definitions/SellerSupplierParty"
            },
          "maxItems": 1,
          "minItems": 1,
          "additionalProperties": false,
          "type": "array"
          },
        "OriginatorCustomerParty": {
          "title": "Order. Originator_ Customer Party. Customer Party",
          "description": "The originator.",
          "items": {
            "$ref": "../common/UBL-CommonAggregateComponents-2.1.json#/definitions/OriginatorCustomerParty"
            },
          "maxItems": 1,
          "minItems": 1,
          "additionalProperties": false,
          "type": "array"
          },
        "FreightForwarderParty": {
          "title": "Order. Freight Forwarder_ Party. Party",
          "description": "A freight forwarder or carrier.",
          "items": {
            "$ref": "../common/UBL-CommonAggregateComponents-2.1.json#/definitions/FreightForwarderParty"
            },
          "maxItems": 1,
          "minItems": 1,
          "additionalProperties": false,
          "type": "array"
          },
        "AccountingCustomerParty": {
          "title": "Order. Accounting_ Customer Party. Customer Party",
          "description": "The accounting customer party.",
          "items": {
            "$ref": "../common/UBL-CommonAggregateComponents-2.1.json#/definitions/AccountingCustomerParty"
            },
          "maxItems": 1,
          "minItems": 1,
          "additionalProperties": false,
          "type": "array"
          },
        "Delivery": {
          "title": "Order. Delivery",
          "description": "A delivery associated with this document.",
          "items": {
            "$ref": "../common/UBL-CommonAggregateComponents-2.1.json#/definitions/Delivery"
            },
          "minItems": 1,
          "additionalProperties": false,
          "type": "array"
          },
        "DeliveryTerms": {
          "title": "Order. Delivery Terms",
          "description": "A set of delivery terms associated with this document.",
          "items": {
            "$ref": "../common/UBL-CommonAggregateComponents-2.1.json#/definitions/DeliveryTerms"
            },
          "minItems": 1,
          "additionalProperties": false,
          "type": "array"
          },
        "PaymentMeans": {
          "title": "Order. Payment Means",
          "description": "Expected means of payment.",
          "items": {
            "$ref": "../common/UBL-CommonAggregateComponents-2.1.json#/definitions/PaymentMeans"
            },
          "minItems": 1,
          "additionalProperties": false,
          "type": "array"
          },
        "PaymentTerms": {
          "title": "Order. Payment Terms",
          "description": "A set of payment terms associated with this document.",
          "items": {
            "$ref": "../common/UBL-CommonAggregateComponents-2.1.json#/definitions/PaymentTerms"
            },
          "minItems": 1,
          "additionalProperties": false,
          "type": "array"
          },
        "TransactionConditions": {
          "title": "Order. Transaction Conditions",
          "description": "A specification of purchasing or sales conditions applying to the whole Order.",
          "items": {
            "$ref": "../common/UBL-CommonAggregateComponents-2.1.json#/definitions/TransactionConditions"
            },
          "maxItems": 1,
          "minItems": 1,
          "additionalProperties": false,
          "type": "array"
          },
        "AllowanceCharge": {
          "title": "Order. Allowance Charge",
          "description": "A discount or charge that applies to a price component.",
          "items": {
            "$ref": "../common/UBL-CommonAggregateComponents-2.1.json#/definitions/AllowanceCharge"
            },
          "minItems": 1,
          "additionalProperties": false,
          "type": "array"
          },
        "TaxExchangeRate": {
          "title": "Order. Tax_ Exchange Rate. Exchange Rate",
          "description": "The exchange rate between the document currency and the tax currency.",
          "items": {
            "$ref": "../common/UBL-CommonAggregateComponents-2.1.json#/definitions/TaxExchangeRate"
            },
          "maxItems": 1,
          "minItems": 1,
          "additionalProperties": false,
          "type": "array"
          },
        "PricingExchangeRate": {
          "title": "Order. Pricing_ Exchange Rate. Exchange Rate",
          "description": "The exchange rate between the document currency and the pricing currency.",
          "items": {
            "$ref": "../common/UBL-CommonAggregateComponents-2.1.json#/definitions/PricingExchangeRate"
            },
          "maxItems": 1,
          "minItems": 1,
          "additionalProperties": false,
          "type": "array"
          },
        "PaymentExchangeRate": {
          "title": "Order. Payment_ Exchange Rate. Exchange Rate",
          "description": "The exchange rate between the document currency and the payment currency.",
          "items": {
            "$ref": "../common/UBL-CommonAggregateComponents-2.1.json#/definitions/PaymentExchangeRate"
            },
          "maxItems": 1,
          "minItems": 1,
          "additionalProperties": false,
          "type": "array"
          },
        "DestinationCountry": {
          "title": "Order. Destination_ Country. Country",
          "description": "The country of destination (for customs purposes).",
          "items": {
            "$ref": "../common/UBL-CommonAggregateComponents-2.1.json#/definitions/DestinationCountry"
            },
          "maxItems": 1,
          "minItems": 1,
          "additionalProperties": false,
          "type": "array"
          },
        "TaxTotal": {
          "title": "Order. Tax Total",
          "description": "The total amount of a specific type of tax.",
          "items": {
            "$ref": "../common/UBL-CommonAggregateComponents-2.1.json#/definitions/TaxTotal"
            },
          "minItems": 1,
          "additionalProperties": false,
          "type": "array"
          },
        "AnticipatedMonetaryTotal": {
          "title": "Order. Anticipated_ Monetary Total. Monetary Total",
          "description": "The total amount for the Order anticipated by the buyer.",
          "items": {
            "$ref": "../common/UBL-CommonAggregateComponents-2.1.json#/definitions/AnticipatedMonetaryTotal"
            },
          "maxItems": 1,
          "minItems": 1,
          "additionalProperties": false,
          "type": "array"
          },
        "OrderLine": {
          "title": "Order. Order Line",
          "description": "A line associated with a line in the Catalogue and specifying a kind of item being ordered.",
          "items": {
            "$ref": "../common/UBL-CommonAggregateComponents-2.1.json#/definitions/OrderLine"
            },
          "minItems": 1,
          "additionalProperties": false,
          "type": "array"
          }
        },
      "additionalProperties": false,
      "type": "object"
      }
    }
  }