org.oasis-open.ubl.schemas.maindoc.UBL-UtilityStatement-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-UtilityStatement-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-UtilityStatement-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": [
    "UtilityStatement"
    ],
  "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"
      },
    "UtilityStatement": {
      "description": "A supplement to an Invoice or Credit Note, containing information on the consumption of services provided by utility suppliers to private and public customers, including electricity, gas, water, and telephone services.",
      "items": {
        "$ref": "#/definitions/UtilityStatement"
        },
      "maxItems": 1,
      "minItems": 1,
      "type": "array"
      }
    },
  "additionalProperties": false,
  "type": "object",
  "definitions": {
    "UtilityStatement": {
      "title": "Utility Statement. Details",
      "description": "A supplement to an Invoice or Credit Note, containing information on the consumption of services provided by utility suppliers to private and public customers, including electricity, gas, water, and telephone services.",
      "required": [
        "ID",
        "IssueDate",
        "UtilityStatementTypeCode",
        "DocumentCurrencyCode",
        "ParentDocumentReference",
        "SenderParty",
        "ReceiverParty"
        ],
      "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": "Utility Statement. 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": "Utility Statement. 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": "Utility Statement. 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": "Utility Statement. 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": "Utility Statement. 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"
          },
        "CopyIndicator": {
          "title": "Utility Statement. 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": "Utility Statement. 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": "Utility Statement. 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": "Utility Statement. 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"
          },
        "UtilityStatementTypeCode": {
          "title": "Utility Statement. Utility Statement Type Code. Code",
          "description": "A code signifying the type of Utility Statement.",
          "items": {
            "$ref": "../common/UBL-CommonBasicComponents-2.1.json#/definitions/UtilityStatementTypeCode"
            },
          "maxItems": 1,
          "minItems": 1,
          "additionalProperties": false,
          "type": "array"
          },
        "Note": {
          "title": "Utility Statement. 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": "Utility Statement. 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"
          },
        "AccountingCostCode": {
          "title": "Utility Statement. Accounting Cost Code. Code",
          "description": "The buyer's accounting cost code, applied to the UtilityStatement.",
          "items": {
            "$ref": "../common/UBL-CommonBasicComponents-2.1.json#/definitions/AccountingCostCode"
            },
          "maxItems": 1,
          "minItems": 1,
          "additionalProperties": false,
          "type": "array"
          },
        "AccountingCost": {
          "title": "Utility Statement. Accounting Cost. Text",
          "description": "The buyer's accounting cost code, applied to the UtilityStatement, expressed as text.",
          "items": {
            "$ref": "../common/UBL-CommonBasicComponents-2.1.json#/definitions/AccountingCost"
            },
          "maxItems": 1,
          "minItems": 1,
          "additionalProperties": false,
          "type": "array"
          },
        "ParentDocumentReference": {
          "title": "Utility Statement. Parent_ Document Reference. Document Reference",
          "description": "A reference to the parent Invoice or Credit Note.",
          "items": {
            "$ref": "../common/UBL-CommonAggregateComponents-2.1.json#/definitions/ParentDocumentReference"
            },
          "maxItems": 1,
          "minItems": 1,
          "additionalProperties": false,
          "type": "array"
          },
        "AdditionalDocumentReference": {
          "title": "Utility Statement. 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"
          },
        "Signature": {
          "title": "Utility Statement. Signature",
          "description": "A signature applied to this document.",
          "items": {
            "$ref": "../common/UBL-CommonAggregateComponents-2.1.json#/definitions/Signature"
            },
          "minItems": 1,
          "additionalProperties": false,
          "type": "array"
          },
        "SenderParty": {
          "title": "Utility Statement. Sender_ Party. Party",
          "description": "The party sending this document.",
          "items": {
            "$ref": "../common/UBL-CommonAggregateComponents-2.1.json#/definitions/SenderParty"
            },
          "maxItems": 1,
          "minItems": 1,
          "additionalProperties": false,
          "type": "array"
          },
        "ReceiverParty": {
          "title": "Utility Statement. Receiver_ Party. Party",
          "description": "The party receiving this document.",
          "items": {
            "$ref": "../common/UBL-CommonAggregateComponents-2.1.json#/definitions/ReceiverParty"
            },
          "maxItems": 1,
          "minItems": 1,
          "additionalProperties": false,
          "type": "array"
          },
        "CustomerParty": {
          "title": "Utility Statement. Customer Party",
          "description": "The buyer, if different from the receiver of the document.",
          "items": {
            "$ref": "../common/UBL-CommonAggregateComponents-2.1.json#/definitions/CustomerParty"
            },
          "maxItems": 1,
          "minItems": 1,
          "additionalProperties": false,
          "type": "array"
          },
        "SubscriberParty": {
          "title": "Utility Statement. Subscriber_ Party. Party",
          "description": "The subscriber (user or receiver of the service), if different from the buyer and from the party receiving this document.",
          "items": {
            "$ref": "../common/UBL-CommonAggregateComponents-2.1.json#/definitions/SubscriberParty"
            },
          "maxItems": 1,
          "minItems": 1,
          "additionalProperties": false,
          "type": "array"
          },
        "MainOnAccountPayment": {
          "title": "Utility Statement. Main_ On Account Payment. On Account Payment",
          "description": "A payment on an account.",
          "items": {
            "$ref": "../common/UBL-CommonAggregateComponents-2.1.json#/definitions/MainOnAccountPayment"
            },
          "minItems": 1,
          "additionalProperties": false,
          "type": "array"
          },
        "SubscriberConsumption": {
          "title": "Utility Statement. Subscriber Consumption",
          "description": "A utility statement for a particular consumption point.",
          "items": {
            "$ref": "../common/UBL-CommonAggregateComponents-2.1.json#/definitions/SubscriberConsumption"
            },
          "minItems": 1,
          "additionalProperties": false,
          "type": "array"
          }
        },
      "additionalProperties": false,
      "type": "object"
      }
    }
  }