Provides remittance information about a payment for garnishment-related purposes.
With the following properties:
| Property | Type | Required | Description |
|---|---|---|---|
| Tp | Object | Optional | Specifies the type of garnishment. |
| Grnshee | Reference | Optional | Ultimate party that owes an amount of money to the (ultimate) creditor, in this case, to the garnisher |
| GrnshmtAdmstr | Reference | Optional | Party on the credit side of the transaction who administers the garnishment on behalf of the ultimate beneficiary |
RefNb | String | Optional | Reference information that is specific to the agency receiving the garnishment. Maximum length: 140 Characters |
Dt | Reference | Optional | Date of payment which garnishment was taken from. Format: date-time |
| RmtdAmt | Object | Optional | Amount of money remitted for the referred document. |
FmlyMdcllnsrncInd | Boolean | Optional | Indicates if the person to whom the garnishment applies (that is, the ultimate debtor) has family medical insurance coverage available. |
MplyeeTermntnInd | Boolean | Optional | Indicates if the employment of the person to whom the garnishment applies (that is, the ultimate debtor) has been terminated |
Specifies the type of garnishment.
With the following properties:
| Property | Type | Required | Description |
|---|---|---|---|
| CdOrPrtry | Object | Optional | Provides the type details of the garnishment. |
Issr | String | Optional | Identification of the issuer of the garnishment type. Maximum length 35 characters |
Coded or proprietary format creditor Reference type.
With the following properties:
| Property | Type | Required | Description |
|---|---|---|---|
| Cd | String | Optional | Garnishment type in a coded form. Based on ISO ExternalGarnishmentType1Code list, the value of this property must be equal to one of the known values below. |
Prtry | String | Optional | Proprietary identification of the type of garnishment. Maximum length 35 characters |
| Value | Description |
|---|---|
GNCS | Garnishment from a third party payer for Child Support |
GNDP | Garnishment from a Direct Payer for Child Support |
GTPP | Garnishment from a third party payer to taxing agency |
Ultimate party that owes an amount of money to the (ultimate) creditor, in this case, to the garnisher.
With the following properties:
| Property | Type | Required | Description |
|---|---|---|---|
| CtctDtls | Reference | Optional | Allows the contact of the Ultimate Debtor to be held. Defined in #/definitions/contact_details |
| Id | Reference | Optional | Unique and unambiguous way to identify the Ultimate Debtor. Defined in #/definitions/id_section |
| CtryRes | Reference | Optional | Allows the Country of Residence of the Utlimate Debtor to be held. Defined in #/definitions/country |
| Nm | Reference | Optional | Allows the name of the Ultimate Debtor to be held as a single value. Defined in #/definitions/fullname |
| PstlAdr | Reference | Optional | Allows the address of the Ultimate Debtor to be held. Defined in #/definitions/address |
| StrdNm | Reference | Optional | Allows the name of the Ultimate Debtor to be held in a structured format. Defined in #/definitions/name |
Party on the credit side of the transaction who administers the garnishment on behalf of the ultimate beneficiary.
With the following properties:
| Property | Type | Required | Description |
|---|---|---|---|
| CtctDtls | Reference | Optional | Allows the contact of the Ultimate Creditor to be held. Defined in #/definitions/contact_details |
| Id | Reference | Optional | Unique and unambiguous way to identify the Ultimate Creditor. Defined in #/definitions/id_section |
| CtryRes | Reference | Optional | Allows the Country of Residence of the Utlimate Creditor to be held. Defined in #/definitions/country |
| Nm | Reference | Optional | Allows the name of the Ultimate Creditor to be held as a single value. Defined in #/definitions/fullname |
| PstlAdr | Reference | Optional | Allows the address of the Ultimate Creditor to be held. Defined in #/definitions/address |
| StrdNm | Reference | Optional | Allows the name of the Ultimate Creditor to be held in a structured format. Defined in #/definitions/name |
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 |
Click to expand
"GrnshmtRmt": {
"type": "object",
"description": "Provides remittance information about a payment for garnishment-related purposes.",
"properties": {
"Tp": {
"type": "object",
"description": "Specifies the type of garnishment.",
"properties": {
"CdOrPrtry": {
"type": "object",
"description": "Provides the type details of the garnishment.",
"properties": {
"Cd": {
"type": "string",
"description": "Garnishment type in a coded form. Based on ISO ExternalGarnishmentType1Code list",
"enum": [
"GNCS",
"GNDP",
"GTPP"
]
},
"Prtry": {
"type": "string",
"description": "Proprietary identification of the type of garnishment.",
"maxLength": 35
}
}
}
},
"Issr": {
"type": "string",
"description": "Identification of the issuer of the garnishment type.",
"maxLength": 35
}
},
"Grnshee": {
"type": "object",
"description": "Ultimate party that owes an amount of money to the (ultimate) creditor, in this case, to the garnisher.",
"properties": {
"Nm": {
"$ref": "#/definitions/fullname"
},
"StrdNm": {
"$ref": "#/definitions/name"
},
"CtryOfRes": {
"$ref": "#/definitions/country"
},
"PstlAdr": {
"$ref": "#/definitions/address"
},
"Id": {
"$ref": "#/definitions/id_section"
},
"CtctDtls": {
"$ref": "#/definitions/contact_details"
}
}
},
"GrnshmtAdmstr": {
"type": "object",
"description": "Party on the credit side of the transaction who administers the garnishment on behalf of the ultimate beneficiary.",
"properties": {
"Nm": {
"$ref": "#/definitions/fullname"
},
"StrdNm": {
"$ref": "#/definitions/name"
},
"CtryOfRes": {
"$ref": "#/definitions/country"
},
"PstlAdr": {
"$ref": "#/definitions/address"
},
"Id": {
"$ref": "#/definitions/id_section"
},
"CtctDtls": {
"$ref": "#/definitions/contact_details"
}
}
},
"RefNb": {
"type": "string",
"description": "Reference information that is specific to the agency receiving the garnishment.",
"maxLength": 140
},
"Dt": {
"type": "string",
"description": "Date of payment which garnishment was taken from.",
"format": "date-time"
},
"RmtdAmt": {
"type": "object",
"description": "Amount of money remitted for the referred document.",
"properties": {
"amount": {
"type": "string",
"maxLength": 19
},
"currency": {
"$ref": "#/definitions/currency"
}
}
},
"FmlyMdcllnsrncInd": {
"type": "boolean",
"description": "Indicates if the person to whom the garnishment applies (that is, the ultimate debtor) has family medical insurance coverage available."
},
"MplyeeTermntnInd": {
"type": "boolean",
"description": "Indicates if the employment of the person to whom the garnishment applies (that is, the ultimate debtor) has been terminated."
}
}
}