RfrdDocInf

Provides the identification and the content of the referred document.

With the following properties:

Property Type Required Description
Tp Object Optional Specifies the type of referred document.
Nb String Optional Unique and unambiguous identification of the referred document. Maximum length: 35 characters
RltdDt String Optional Date associated with the referred document. Format: date-time
LineDtls array Optional Quantity of cash resulting from the calculation of the tax.

Tp

Specifies the type of referred document.

With the following properties:

Property Type Required Description
CdOrPrtry Object Optional Provides the type details of the referred document.
Issr String Optional Identification of the issuer of the Reference document type. Maximum length 35 characters

CdOrPrtry

Coded or proprietary format creditor Reference type.

With the following properties:

Property Type Required Description
Cd String Optional Document type in a coded form. As defined in ISO list DocumentType6Code, the value of this property must be equal to one of the known values below.
Prtry Optional String Proprietary identification of the type of garnishment. Maximum length 35 characters
Cd known values
Value Description
MSIN Metered Service Invoice
CNFA Credit Note Related To Financial Adjustment
DNFA Debit Note Related To Financial Adjustment
CINV Commercial Invoice
CREN Credit Note
DEBN Debit Note
HIRI Hire Invoice
SBIN Self Billed Invoice
CMCN Commercial Contract
SOAC Statement Of Account
DISP Dispatch Advice
BOLD Bill Of Lading
VCHR Voucher
AROI Account Receivable Open Item
TSUT Trade Services Utility Transaction
PUOR Purchase Order

LineDtls

Set of elements used to provide the content of the referred document line.

With the following properties:

Property Type Required Description
Id Object Optional Provides identification of the document line.
Desc String Optional Description associated with the document line. Maximum length: 2048 characters
Amt Object Optional Provides details on the amounts of the document line.

Id

Set of elements used to provide the content of the referred document line.

With the following properties:

Property Type Required Description
Tp Object Optional Specifies the type of referred document line identification.
Nb String Optional Identification of the type specified for the referred document line.. Maximum length: 35 characters
RltdDt String Optional Date associated with the referred document line. Format: Date-time

Id.Tp

Specifies the type of creditor reference.

With the following properties:

Property Type Required Description
CdOrPrtry Object Optional Provides the type details of the referred document line identification.
Issr String Optional Identification of the issuer of the Reference document line identification type.

CdOrPrtry

Provides the type details of the referred document line identification.

With the following properties:

Property Type Required Description
Cd String Optional Line identification type in a coded form. Uses ISO list ExternalDocumentLineType1Code, the value of this property must be equal to one of the known values below.
Prtry String Optional Field to support proprietary value. Maximum length 35 characters
Known values
Value Description
ADPI Additional Product Identification Assigned by the Manufacturer. Line item Reference is an additional product identification assigned by the manufacturer.
AISB Alternate ISBN. Line item Reference is an alternate International Standard Book Number (ISBN).
ASNB Asset Number. Line item Reference is an asset number.
CTNB Catalog Number. Line item Reference is a catalog number.
DBSP Dun & Bradstreet Standard Product and Service Code. Line item Reference is Dun & Bradstreet Standard Product and Service code.
EANN European Article Number (EAN) (2-5-5-1). Line item Reference is an European Article Number (EAN).
EINB Equipment Identification Number. Line item Reference is an equipment identification number.
GSNB General Specification Number. Line item Reference is a general specification number.
HIBC HIBC (Health Care Industry Bar Code). Line item Reference is a Health Care Industry Bar Code (HIBC)
ISBN International Standard Book Number (ISBN). Line item Reference is an International Standard Book Number (ISBN).
LTNB Lot Number. Line item Reference is a lot number.
MDNB Model Number. Line item Reference is a model number.
PRNB Part Number. Line item Reference is a part Reference number.
PTCD Product Type Code. Line item Reference is a product type code.
SKNB Stock Number. Line item Reference is a stock number.
STNB Style Number. Line item Reference is a style number.
TONB Technical Order Number. Line item Reference is a technical order number.
UPCC UPC Consumer Package Code. Line item Reference is an UPC consumer package code.
UPNB Universal Product Number. Line item Reference is an Universal Product Number.

Amt

Provides details on the amounts of the document line.

With the following properties:

Property Type Required Description
DuePyblAmt Object Optional Amount specified is the exact amount due and payable to the creditor.
DscntApldAmt Object Optional Amount specified for the referred document is the amount of discount to be applied to the amount due and payable to the creditor.
CdtNoteAmt Object Optional Amount specified for the referred document is the amount of a credit note.
TaxAmt Object Optional Quantity of cash resulting from the calculation of the tax.
AdjstmntAmtAndRsn Object Optional Specifies detailed information on the amount and reason of the document adjustment.
RmtdAmt Object Optional Amount of money remitted for the referred document.

DuePyblAmt

Provides details on the amounts of the referred document.

With the following properties:

Property Type Required Description
amount string optional Amount. Maximum length: 19 characters
currency string optional Currency for the amountm, defined in #/definitions/currency

DscntApldAmt

Amount specified for the referred document is the amount of discount to be applied to the amount due and payable to the creditor.

With the following properties:

Property Type Required Description
Tp String Optional Specifies the type of the amount.
Amt String Optional Amount of money, which has been typed.

DscntApldAmt.Tp

With the following properties:

Property Type Required Description
Cd String Optional Specifies the amount type, in a coded form. Based on ISO ExternalDiscountAmountType1Code, the value of this property must be equal to one of the known values below.
Prtry String Optional Field to support proprietary value. Maximum length 35 characters
DscntApldAmt.Cd known values
Value Description
APDS Additional Promotional Discount
STDS Standing Discount
TMDS Terms Discount

DscntApldAmt.Amt

Amount of money, which has been typed.

With the following properties:

Property Type Required Description
amount string optional Amount. Maximum length: 19 characters
currency string optional Currency for the amountm, defined in #/definitions/currency

CdtNoteAmt

Amount specified for the referred document is the amount of a credit note.

With the following properties:

Property Type Required Description
amount string optional Amount. Maximum length: 19 characters
currency string optional Currency for the amountm, defined in #/definitions/currency

TaxAmt

Quantity of cash resulting from the calculation of the tax.

With the following properties:

Property Type Required Description
Tp String Optional Specifies the type of the amount.
Amt String Optional Amount of money, which has been typed.

TaxAmt.Tp

Specifies the type of the amount.

With the following properties:

Property Type Required Description
Cd String Optional Specifies the amount type, in a coded form. Based on the ISO ExternalTaxAmountType1Code list, the value of this property must be equal to one of the known values below.
Prtry String Optional Field to support proprietary value. Maximum length 35 characters
TaxAmt.Cd known values
Value Description
CITY City Tax
CNTY County Tax
LOCL Local Tax
PROV Province Tax
STAT State Tax

TaxAmt.Amt

Amount of money, which has been typed.

With the following properties:

Property Type Required Description
amount string optional Amount. Maximum length: 19 characters
currency string optional Currency for the amountm, defined in #/definitions/currency

AdjstmntAmtAndRsn

Specifies detailed information on the amount and reason of the document adjustment.

With the following properties:

Property Type Required Description
AdjstmntAmtAndRsn.Amt object optional Amount of money of the document adjustment.
CdtDbtInd string optional Specifies whether the adjustment must be substracted or added to the total amount, the value of this property must be equal to one of the known values below.
Rsn string optional Specifies the reason for the adjustment. Maximum length: 4 characters
AddtlInf string optional Provides further details on the document adjustment. Maximum length: 140 characters

AdjstmntAmtAndRsn known values

Value Description
CRDT Credit
DBIT Debit

AdjstmntAmtAndRsn.Amt

Amount of money remitted for the referred document.

With the following properties:

Property Type Required Description
amount string optional Amount. Maximum length: 19 characters
currency string optional Currency for the amountm, defined in #/definitions/currency

RmtdAmt

Amount of money remitted for the referred document.

With the following properties:

Property Type Required Description
amount string optional Amount. Maximum length: 19 characters
currency string optional Currency for the amountm, defined in #/definitions/currency

JSON schema extract

Click to expand
Copy
Copied!
"RfrdDocInf": {
    "type": "object",
    "description": "Provides the identification and the content of the referred document.",
    "properties": {
        "Tp": {
            "type": "object",
            "description": "Specifies the type of referred document.",
            "properties": {
                "CdOrPrtry": {
                    "type": "object",
                    "description": "Provides the type details of the referred document.",
                    "properties": {
                        "Cd": {
                            "type": "string",
                            "description": "Document type in a coded form. As defined in ISO list DocumentType6Code ",
                            "enum": [
                                "MSIN",
                                "CNFA",
                                "DNFA",
                                "CINV",
                                "CREN",
                                "DEBN",
                                "HIRI",
                                "SBIN",
                                "CMCN",
                                "SOAC",
                                "DISP",
                                "BOLD",
                                "VCHR",
                                "AROI",
                                "TSUT",
                                "PUOR"
                            ]
                        },
                        "Prtry": {
                            "type": "string",
                            "description": "Field to support proprietary values",
                            "maxLength": 35
                        }
                    },
                    "Issr": {
                        "type": "string",
                        "description": "Identification of the issuer of the Reference document type.",
                        "maxLength": 35
                    }
                }
            }
        },
        "Nb": {
            "type": "string",
            "description": "Unique and unambiguous identification of the referred document.",
            "maxLength": 35
        },
        "RltdDt": {
            "type": "string",
            "description": "Date associated with the referred document.",
            "format": "date-time"
        },
        "LineDtls": {
            "type": "array",
            "description": "Set of elements used to provide the content of the referred document line.",
            "items": [
                    {
                    "Id": {
                        "type": "object",
                        "description": "Provides identification of the document line.",
                        "properties": {
                            "Tp": {
                                "type": "object",
                                "description": "Specifies the type of referred document line identification.",
                                "properties": {
                                    "CdOrPrtry": {
                                        "type": "object",
                                        "description": "Provides the type details of the referred document line identification.",
                                        "properties": {
                                            "Cd": {
                                                "type": "string",
                                                "description": "Line identification type in a coded form. Uses ISO list ExternalDocumentLineType1Code",
                                                "enum": [
                                                    "CINV",
                                                    "CNFA",
                                                    "CONT",
                                                    "CREN",
                                                    "DEBN",
                                                    "DISP",
                                                    "DNFA",
                                                    "HIRI",
                                                    "INVS",
                                                    "MSIN",
                                                    "PROF",
                                                    "PUOR",
                                                    "QUOT",
                                                    "SBIN",
                                                    "SPRR",
                                                    "TISH",
                                                    "USAR"
                                                ]
                                            },
                                            "Prtry": {
                                                "type": "string",
                                                "description": "Field to support proprietary value",
                                                "maxLength": 35
                                            }
                                        },
                                    "Issr": {
                                        "type": "string",
                                        "description": "Identification of the issuer of the Reference document line identification type.",
                                        "maxLength": 35
                                    }
                            },
                            "Nb": {
                                "type": "string",
                                "description": "Identification of the type specified for the referred document line.",
                                "maxLength": 35
                            },
                            "RltdDt": {
                                "type": "string",
                                "description": "Date associated with the referred document line.",
                                "format": "date-time"
                                }
                            }
                        },
                    "Desc": {
                        "type": "string",
                        "description": "Description associated with the document line.",
                        "maxLength": 2048
                    },
                    "Amt": {
                        "type": "object",
                        "description": "Provides details on the amounts of the document line.",
                        "properties": {
                            "DuePyblAmt": {
                                "type": "object",
                                "description": "Amount specified is the exact amount due and payable to the creditor.",
                                "properties": {
                                    "amount": {
                                        "type": "string",
                                        "maxLength": 19
                                    },
                                    "currency": {
                                        "$ref": "#/definitions/currency"
                                    }
                                }
                            },
                            "DscntApldAmt": {
                                "type": "object",
                                "description": "Amount of discount to be applied to the amount due and payable to the creditor.",
                                "properties": {
                                    "Tp": {
                                        "type": "object",
                                        "description": "Specifies the type of the amount.",
                                        "properties": {
                                            "Cd": {
                                                "type": "string",
                                                "description": "Specifies the amount type, in a coded form. Based on ISO list ExternalDiscountAmountType1Code",
                                                "enum": [
                                                    "APDS",
                                                    "STDS",
                                                    "TMDS"
                                                ]
                                            },
                                            "Prtry": {
                                                "type": "string",
                                                "description": "Field to support proprietary value",
                                                "maxLength": 35
                                            }
                                        }
                                    },
                                    "Amt": {
                                        "type": "object",
                                        "description": "Amount of money, which has been typed",
                                        "properties": {
                                            "amount": {
                                                "type": "string",
                                                "maxLength": 19
                                            },
                                            "currency": {
                                                "$ref": "#/definitions/currency"
                                            }
                                        }
                                    }
                                }
                            },
                            "CdtNoteAmt": {
                                "type": "object",
                                "description": "Amount of a credit note.",
                                "properties": {
                                    "amount": {
                                        "type": "string",
                                        "maxLength": 19
                                    },
                                    "currency": {
                                        "$ref": "#/definitions/currency"
                                    }
                                }
                            },
                            "TaxAmt": {
                                "type": "object",
                                "description": "Amount of the tax.",
                                "properties": {
                                    "Tp": {
                                        "type": "object",
                                        "description": "Specifies the type of the amount.",
                                        "properties": {
                                            "Cd": {
                                                "type": "string",
                                                "description": "Specifies the amount type, in a coded form. Based on ISO ExternalTaxAmountType1Code list",
                                                "enum": [
                                                    "CITY",
                                                    "CNTY",
                                                    "LOCL",
                                                    "PROV",
                                                    "STAT"
                                                ]
                                            },
                                            "Prtry": {
                                                "type": "string",
                                                "description": "Specifies the amount type, in a free-text form.",
                                                "maxLength": 35
                                            }
                                        }
                                    },
                                    "Amt": {
                                        "type": "object",
                                        "description": "Amount of money, which has been typed",
                                        "properties": {
                                            "amount": {
                                                "type": "string",
                                                "maxLength": 19
                                            },
                                            "currency": {
                                                "$ref": "#/definitions/currency"
                                            }
                                        }
                                    }
                                }
                            },
                            "AdjstmntAmtAndRsn": {
                                "type": "object",
                                "description": "Specifies detailed information on the amount and reason of the adjustment.",
                                "properties": {
                                    "Amt": {
                                        "type": "object",
                                        "properties": {
                                            "amount": {
                                                "type": "string",
                                                "maxLength": 19
                                            },
                                            "currency": {
                                                "$ref": "#/definitions/currency"
                                            }
                                        }
                                    },
                                    "CdtDbtInd": {
                                        "type": "string",
                                        "description": "Specifies whether the adjustment must be substracted or added to the total amount.",
                                        "enum": [
                                            "CRDT",
                                            "DBIT"
                                        ]
                                    },
                                    "Rsn": {
                                        "type": "string",
                                        "description": "Specifies the reason for the adjustment.",
                                        "maxLength": 4
                                    },
                                    "AddtlInf": {
                                        "type": "string",
                                        "description": "Provides further details on the document adjustment.",
                                        "maxLength": 140
                                    }
                                }
                            },
                            "RmtdAmt": {
                                "type": "object",
                                "description": "Amount of money remitted.",
                                "properties": {
                                    "amount": {
                                        "type": "string",
                                        "maxLength": 19
                                    },
                                    "currency": {
                                        "$ref": "#/definitions/currency"
                                    }
                                }
                                }
                            }
                        }
                    }
                }
            }]
        }
    }
}