org.oasis-open.ubl.schemas.maindoc.UBL-OrderResponse-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-OrderResponse-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-OrderResponse-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": [
    "OrderResponse"
    ],
  "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"
      },
    "OrderResponse": {
      "description": "A document used to indicate detailed acceptance or rejection of an Order or to make a counter-offer.",
      "items": {
        "$ref": "#/definitions/OrderResponse"
        },
      "maxItems": 1,
      "minItems": 1,
      "type": "array"
      }
    },
  "additionalProperties": false,
  "type": "object",
  "definitions": {
    "OrderResponse": {
      "title": "Order Response. Details",
      "description": "A document used to indicate detailed acceptance or rejection of an Order or to make a counter-offer.",
      "required": [
        "ID",
        "IssueDate",
        "OrderReference",
        "SellerSupplierParty",
        "BuyerCustomerParty"
        ],
      "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 Response. 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 Response. Customization Identifier. Identifier",
          "description": "Identifies a user-defined customization of UBL.",
          "items": {
            "$ref": "../common/UBL-CommonBasicComponents-2.1.json#/definitions/CustomizationID"
            },
          "maxItems": 1,
          "minItems": 1,
          "additionalProperties": false,
          "type": "array"
          },
        "ProfileID": {
          "title": "Order Response. 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 Response. 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 Response. 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 Response. Sales_ Order Identifier. Identifier",
          "description": "An identifier for the Order, issued by the Seller.",
          "items": {
            "$ref": "../common/UBL-CommonBasicComponents-2.1.json#/definitions/SalesOrderID"
            },
          "maxItems": 1,
          "minItems": 1,
          "additionalProperties": false,
          "type": "array"
          },
        "CopyIndicator": {
          "title": "Order Response. 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 Response. 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 Response. 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 Response. 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"
          },
        "OrderResponseCode": {
          "title": "Order Response. Order Response Code. Code",
          "description": "A code signifying the type of response for this Order.",
          "items": {
            "$ref": "../common/UBL-CommonBasicComponents-2.1.json#/definitions/OrderResponseCode"
            },
          "maxItems": 1,
          "minItems": 1,
          "additionalProperties": false,
          "type": "array"
          },
        "Note": {
          "title": "Order Response. 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"
          },
        "DocumentCurrencyCode": {
          "title": "Order Response. 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 Response. Pricing_ Currency Code. Code",
          "description": "A code signifying the currency that is used for all prices in the Order Response.",
          "items": {
            "$ref": "../common/UBL-CommonBasicComponents-2.1.json#/definitions/PricingCurrencyCode"
            },
          "maxItems": 1,
          "minItems": 1,
          "additionalProperties": false,
          "type": "array"
          },
        "TaxCurrencyCode": {
          "title": "Order Response. Tax_ Currency Code. Code",
          "description": "A code signifying the currency that is used for all tax amounts in the Order Response.",
          "items": {
            "$ref": "../common/UBL-CommonBasicComponents-2.1.json#/definitions/TaxCurrencyCode"
            },
          "maxItems": 1,
          "minItems": 1,
          "additionalProperties": false,
          "type": "array"
          },
        "TotalPackagesQuantity": {
          "title": "Order Response. Total_ Packages Quantity. Quantity",
          "description": "The total number of packages contained in the Order Response.",
          "items": {
            "$ref": "../common/UBL-CommonBasicComponents-2.1.json#/definitions/TotalPackagesQuantity"
            },
          "maxItems": 1,
          "minItems": 1,
          "additionalProperties": false,
          "type": "array"
          },
        "GrossWeightMeasure": {
          "title": "Order Response. Gross_ Weight. Measure",
          "description": "The total gross weight for the Order Response (goods + packaging + transport equipment).",
          "items": {
            "$ref": "../common/UBL-CommonBasicComponents-2.1.json#/definitions/GrossWeightMeasure"
            },
          "maxItems": 1,
          "minItems": 1,
          "additionalProperties": false,
          "type": "array"
          },
        "NetWeightMeasure": {
          "title": "Order Response. Net_ Weight. Measure",
          "description": "The total net weight for the Order Response (goods + packaging).",
          "items": {
            "$ref": "../common/UBL-CommonBasicComponents-2.1.json#/definitions/NetWeightMeasure"
            },
          "maxItems": 1,
          "minItems": 1,
          "additionalProperties": false,
          "type": "array"
          },
        "NetNetWeightMeasure": {
          "title": "Order Response. Net Net_ Weight. Measure",
          "description": "The total net weight of the goods in the Order Response excluding packaging.",
          "items": {
            "$ref": "../common/UBL-CommonBasicComponents-2.1.json#/definitions/NetNetWeightMeasure"
            },
          "maxItems": 1,
          "minItems": 1,
          "additionalProperties": false,
          "type": "array"
          },
        "GrossVolumeMeasure": {
          "title": "Order Response. Gross_ Volume. Measure",
          "description": "The total volume of the goods in the Order Response including packaging.",
          "items": {
            "$ref": "../common/UBL-CommonBasicComponents-2.1.json#/definitions/GrossVolumeMeasure"
            },
          "maxItems": 1,
          "minItems": 1,
          "additionalProperties": false,
          "type": "array"
          },
        "NetVolumeMeasure": {
          "title": "Order Response. Net_ Volume. Measure",
          "description": "The total volume of the goods in the Order Response excluding packaging.",
          "items": {
            "$ref": "../common/UBL-CommonBasicComponents-2.1.json#/definitions/NetVolumeMeasure"
            },
          "maxItems": 1,
          "minItems": 1,
          "additionalProperties": false,
          "type": "array"
          },
        "CustomerReference": {
          "title": "Order Response. Customer_ Reference. Text",
          "description": "A supplementary reference assigned by the buyer, e.g., the CRI in a purchasing card transaction.",
          "items": {
            "$ref": "../common/UBL-CommonBasicComponents-2.1.json#/definitions/CustomerReference"
            },
          "maxItems": 1,
          "minItems": 1,
          "additionalProperties": false,
          "type": "array"
          },
        "AccountingCostCode": {
          "title": "Order Response. Accounting Cost Code. Code",
          "description": "An accounting cost 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 Response. Accounting Cost. Text",
          "description": "An accounting cost code 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 Response. Line Count. Numeric",
          "description": "The number of Order Lines in this document.",
          "items": {
            "$ref": "../common/UBL-CommonBasicComponents-2.1.json#/definitions/LineCountNumeric"
            },
          "maxItems": 1,
          "minItems": 1,
          "additionalProperties": false,
          "type": "array"
          },
        "ValidityPeriod": {
          "title": "Order Response. Validity_ Period. Period",
          "description": "The period for which the Order Response is valid.",
          "items": {
            "$ref": "../common/UBL-CommonAggregateComponents-2.1.json#/definitions/ValidityPeriod"
            },
          "minItems": 1,
          "additionalProperties": false,
          "type": "array"
          },
        "OrderReference": {
          "title": "Order Response. Order Reference",
          "description": "A reference to the Order being responded to.",
          "items": {
            "$ref": "../common/UBL-CommonAggregateComponents-2.1.json#/definitions/OrderReference"
            },
          "minItems": 1,
          "additionalProperties": false,
          "type": "array"
          },
        "OrderDocumentReference": {
          "title": "Order Response. Order_ Document Reference. Document Reference",
          "description": "A reference to an Order other than the one being responded to.",
          "items": {
            "$ref": "../common/UBL-CommonAggregateComponents-2.1.json#/definitions/OrderDocumentReference"
            },
          "minItems": 1,
          "additionalProperties": false,
          "type": "array"
          },
        "OriginatorDocumentReference": {
          "title": "Order Response. 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"
          },
        "AdditionalDocumentReference": {
          "title": "Order Response. 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 Response. Contract",
          "description": "A contract associated with the Order being responded to.",
          "items": {
            "$ref": "../common/UBL-CommonAggregateComponents-2.1.json#/definitions/Contract"
            },
          "minItems": 1,
          "additionalProperties": false,
          "type": "array"
          },
        "Signature": {
          "title": "Order Response. Signature",
          "description": "A signature applied to this document.",
          "items": {
            "$ref": "../common/UBL-CommonAggregateComponents-2.1.json#/definitions/Signature"
            },
          "minItems": 1,
          "additionalProperties": false,
          "type": "array"
          },
        "SellerSupplierParty": {
          "title": "Order Response. 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"
          },
        "BuyerCustomerParty": {
          "title": "Order Response. 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"
          },
        "OriginatorCustomerParty": {
          "title": "Order Response. 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 Response. 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"
          },
        "AccountingSupplierParty": {
          "title": "Order Response. Accounting_ Supplier Party. Supplier Party",
          "description": "The accounting supplier party.",
          "items": {
            "$ref": "../common/UBL-CommonAggregateComponents-2.1.json#/definitions/AccountingSupplierParty"
            },
          "maxItems": 1,
          "minItems": 1,
          "additionalProperties": false,
          "type": "array"
          },
        "AccountingCustomerParty": {
          "title": "Order Response. 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 Response. 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 Response. Delivery Terms",
          "description": "A set of delivery terms associated with this document.",
          "items": {
            "$ref": "../common/UBL-CommonAggregateComponents-2.1.json#/definitions/DeliveryTerms"
            },
          "maxItems": 1,
          "minItems": 1,
          "additionalProperties": false,
          "type": "array"
          },
        "PaymentMeans": {
          "title": "Order Response. 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 Response. 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"
          },
        "AllowanceCharge": {
          "title": "Order Response. 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"
          },
        "TransactionConditions": {
          "title": "Order Response. 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"
          },
        "TaxExchangeRate": {
          "title": "Order Response. 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 Response. 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 Response. 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 Response. 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 Response. Tax Total",
          "description": "The total amount of a specific type of tax, as calculated by the seller.",
          "items": {
            "$ref": "../common/UBL-CommonAggregateComponents-2.1.json#/definitions/TaxTotal"
            },
          "minItems": 1,
          "additionalProperties": false,
          "type": "array"
          },
        "LegalMonetaryTotal": {
          "title": "Order Response. Legal_ Monetary Total. Monetary Total",
          "description": "The total amount of the Order (or counter-offer).",
          "items": {
            "$ref": "../common/UBL-CommonAggregateComponents-2.1.json#/definitions/LegalMonetaryTotal"
            },
          "maxItems": 1,
          "minItems": 1,
          "additionalProperties": false,
          "type": "array"
          },
        "OrderLine": {
          "title": "Order Response. 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"
      }
    }
  }