RfrdDocAmt
Provides details on the amounts of the referred document.
TP
Specifies the type of garnishment.
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
"RfrdDocAmt": {
"type": "object",
"description": "Provides details on the amounts of the referred document.",
"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 specified for the referred document is the 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 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": "t specified for the referred document is the amount of a credit note.",
"properties": {
"amount": {
"type": "string",
"maxLength": 19
},
"currency": {
"$ref": "#/definitions/currency"
}
}
},
"TaxAmt": {
"type": "object",
"description": "Quantity of cash resulting from the calculation of the tax.",
"properties": {
"Tp": {
"type": "object",
"description": "Specifies the type of the amount. Based on the ISO ExternalTaxAmountType1Code list",
"properties": {
"Cd": {
"type": "string",
"description": "Specifies the amount type, in a coded form. Based on the ISO ExternalTaxAmountType1Code list",
"enum": [
"CITY",
"CNTY",
"LOCL",
"PROV",
"STAT"
]
},
"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"
}
}
}
}
},
"AdjstmntAmtAndRsn": {
"type": "object",
"description": "Specifies detailed information on the amount and reason of the document adjustment.",
"properties": {
"Amt": {
"type": "object",
"description": "Amount of money of the document adjustment.",
"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 for the referred document.",
"properties": {
"amount": {
"type": "string",
"maxLength": 19
},
"currency": {
"$ref": "#/definitions/currency"
}
}
}
}
}