JSON Schema Property 'InvoiceHeader'

Diagram

Value

Object

Properties

Property Name	Type	Description
Id	string	A String value where *length <= 50* Description : Document ID
Timestamp	string	A String value Description : Date/time stamp for this document
SoldTo	object	SoldTo (invoice.json)
InvoiceId	string	A String value where *length <= 32* Description : Vendor invoice number
InvoiceType	string	InvoiceType (invoice.json)
Supplier	object	Party (common.json)
RemitTo	object	Party (common.json)
BillTo	object	Party (common.json)
ShipTo	object	Party (common.json)
CurrencyCode	string	CurrencyCode (common.json)
TermsCode	string	TermsCode (common.json)
TermsDays	integer	A Integer value Description : Number of days for payment
TermsDate	string	A String value Description : Date payment is due
TermsPercent	number	A Number value Description : Percentage terms
TermsPercentDays	integer	A Integer value Description : Number of days for percentage terms
ShipInstructions	string	A String value where *length <= 250* Description : Shipping instructions
TranspCode	string	TranspCode (common.json)
TranspDesc	string	A String value where *length <= 50* Description : Transport description
TranspCarrier	string	A String value where *length <= 15* Description : Transport carrier name
TranspTime	integer	A Integer value Description : Expected transport time
TranspTerms	string	A String value Description : Transport terms
IncoTermsCode	string	IncoTermsCode (common.json)
IncoTermsDesc	string	A String value where *length <= 35*
InvoiceDate	string	A String value Description : Invoice date
InvoiceDueDate	string	A String value Description : Date payment is due
BuyerName	string	A String value where *length <= 35* Description : Buyer company name
SalesRep	string	A String value where *length <= 35* Description : Supplier sales representative name
Comments	string	A String value where *length <= 250*
Additional Properties	Type	Description
Any Property	any	/properties/InvoiceHeader/additionalProperties (invoice.json)

Source

"InvoiceHeader": {
    "type": "object",
    "additionalProperties": {
        "not": {}
    },
    "properties": {
        "Id": {
            "type": "string",
            "description": "Document ID",
            "maxLength": 50
        },
        "Timestamp": {
            "type": "string",
            "description": "Date/time stamp for this document",
            "format": "date-time"
        },
        "SoldTo": {
            "type": "object",
            "additionalProperties": {
                "not": {}
            },
            "properties": {
                "PartyId": {
                    "type": "string",
                    "description": "Buyer GLN/NAMM ID",
                    "maxLength": 25
                },
                "Name": {
                    "type": "string",
                    "description": "Buyer company name",
                    "maxLength": 35
                }
            },
            "required": [
                "PartyId"
            ]
        },
        "InvoiceId": {
            "type": "string",
            "description": "Vendor invoice number",
            "maxLength": 32
        },
        "InvoiceType": {
            "type": "string",
            "description": "Invoice type",
            "enum": [
                "C",
                "D"
            ]
        },
        "Supplier": {
            "$ref": "https://standards.namm.org/schema/2020.1/common.json#/definitions/Party"
        },
        "RemitTo": {
            "$ref": "https://standards.namm.org/schema/2020.1/common.json#/definitions/Party"
        },
        "BillTo": {
            "$ref": "https://standards.namm.org/schema/2020.1/common.json#/definitions/Party"
        },
        "ShipTo": {
            "$ref": "https://standards.namm.org/schema/2020.1/common.json#/definitions/Party"
        },
        "CurrencyCode": {
            "$ref": "https://standards.namm.org/schema/2020.1/common.json#/definitions/CurrencyCode"
        },
        "TermsCode": {
            "$ref": "https://standards.namm.org/schema/2020.1/common.json#/definitions/TermsCode"
        },
        "TermsDays": {
            "type": "integer",
            "description": "Number of days for payment"
        },
        "TermsDate": {
            "type": "string",
            "description": "Date payment is due"
        },
        "TermsPercent": {
            "type": "number",
            "description": "Percentage terms"
        },
        "TermsPercentDays": {
            "type": "integer",
            "description": "Number of days for percentage terms"
        },
        "ShipInstructions": {
            "type": "string",
            "description": "Shipping instructions",
            "maxLength": 250
        },
        "TranspCode": {
            "$ref": "https://standards.namm.org/schema/2020.1/common.json#/definitions/TranspCode"
        },
        "TranspDesc": {
            "type": "string",
            "description": "Transport description",
            "maxLength": 50
        },
        "TranspCarrier": {
            "type": "string",
            "description": "Transport carrier name",
            "maxLength": 15
        },
        "TranspTime": {
            "type": "integer",
            "description": "Expected transport time"
        },
        "TranspTerms": {
            "type": "string",
            "description": "Transport terms"
        },
        "IncoTermsCode": {
            "$ref": "https://standards.namm.org/schema/2020.1/common.json#/definitions/IncoTermsCode"
        },
        "IncoTermsDesc": {
            "type": "string",
            "maxLength": 35
        },
        "InvoiceDate": {
            "type": "string",
            "description": "Invoice date",
            "format": "date"
        },
        "InvoiceDueDate": {
            "type": "string",
            "description": "Date payment is due",
            "format": "date"
        },
        "BuyerName": {
            "type": "string",
            "description": "Buyer company name",
            "maxLength": 35
        },
        "SalesRep": {
            "type": "string",
            "description": "Supplier sales representative name",
            "maxLength": 35
        },
        "Comments": {
            "type": "string",
            "maxLength": 250
        }
    },
    "required": [
        "Id",
        "Timestamp",
        "SoldTo",
        "InvoiceId",
        "InvoiceType",
        "Supplier",
        "RemitTo",
        "BillTo",
        "ShipTo",
        "TermsCode",
        "InvoiceDate",
        "InvoiceDueDate"
    ]
}

https://standards.namm.org/schema/2020.1/invoice.json (11:10)

References

Documentation for Invoice
Generated using Liquid Studio 2019 - Data Designer Edition 17.1.14.9682