POST api/validateusecode/GetValidateUseCodeData
Request Information
URI Parameters
None.
Body Parameters
ValidateUseCodeCriteria| Name | Description | Type | Additional information |
|---|---|---|---|
| CustNmbr | string |
None. |
|
| BeginDate | date |
None. |
|
| EndDate | date |
None. |
Request Formats
application/json, text/json
Sample:
{
"CustNmbr": "sample string 1",
"BeginDate": "2026-11-21T05:35:05.2083828+00:00",
"EndDate": "2026-11-21T05:35:05.2083828+00:00"
}
application/xml, text/xml
Sample:
<ValidateUseCodeModels.ValidateUseCodeCriteria xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HarAccountingAPI.Models"> <BeginDate>2026-11-21T05:35:05.2083828+00:00</BeginDate> <CustNmbr>sample string 1</CustNmbr> <EndDate>2026-11-21T05:35:05.2083828+00:00</EndDate> </ValidateUseCodeModels.ValidateUseCodeCriteria>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
ValidateUseCodeWrapper| Name | Description | Type | Additional information |
|---|---|---|---|
| ResponseStatus | string |
None. |
|
| ValidationMessages | Collection of string |
None. |
|
| Warnings | Collection of string |
None. |
|
| BusinessRuleViolations | Collection of string |
None. |
|
| ErrorWrappers | Collection of ErrorWrapper |
None. |
|
| GridSummary | string |
None. |
|
| AdditionalData | Object |
None. |
|
| Data | Collection of ValidateUseCodeRow |
None. |
Response Formats
application/json, text/json
Sample:
{
"ResponseStatus": "sample string 1",
"ValidationMessages": [
"sample string 1",
"sample string 2"
],
"Warnings": [
"sample string 1",
"sample string 2"
],
"BusinessRuleViolations": [
"sample string 1",
"sample string 2"
],
"ErrorWrappers": [
{
"ErrorMessage": "sample string 1",
"ErrorCode": "sample string 2",
"AdditionalInformation": "sample string 3"
},
{
"ErrorMessage": "sample string 1",
"ErrorCode": "sample string 2",
"AdditionalInformation": "sample string 3"
}
],
"GridSummary": "sample string 2",
"AdditionalData": {},
"Data": [
{
"CustNmbr": "sample string 1",
"CustName": "sample string 2",
"NewAddressLine1": "sample string 3",
"NewAddressCSZ": "sample string 4",
"NewEntityUseCode": "sample string 5",
"NewAddressState": "sample string 6",
"NewAddressStateName": "sample string 7",
"ExistingAddressLine1": "sample string 8",
"ExistingAddressCSZ": "sample string 9",
"ExistingEntityUseCode": "sample string 10",
"PreferredEntityUseCode": "sample string 11",
"PreferredIsStateMatch": true,
"TotalAddresses": 13,
"AddressesWithCode": 14,
"AddressesWithoutCode": 15,
"NewAddressId": "sample string 16"
},
{
"CustNmbr": "sample string 1",
"CustName": "sample string 2",
"NewAddressLine1": "sample string 3",
"NewAddressCSZ": "sample string 4",
"NewEntityUseCode": "sample string 5",
"NewAddressState": "sample string 6",
"NewAddressStateName": "sample string 7",
"ExistingAddressLine1": "sample string 8",
"ExistingAddressCSZ": "sample string 9",
"ExistingEntityUseCode": "sample string 10",
"PreferredEntityUseCode": "sample string 11",
"PreferredIsStateMatch": true,
"TotalAddresses": 13,
"AddressesWithCode": 14,
"AddressesWithoutCode": 15,
"NewAddressId": "sample string 16"
}
]
}
application/xml, text/xml
Sample:
<ValidateUseCodeModels.ValidateUseCodeWrapper xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HarAccountingAPI.Models">
<AdditionalData />
<BusinessRuleViolations xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>sample string 1</d2p1:string>
<d2p1:string>sample string 2</d2p1:string>
</BusinessRuleViolations>
<Data>
<ValidateUseCodeModels.ValidateUseCodeRow>
<AddressesWithCode>14</AddressesWithCode>
<AddressesWithoutCode>15</AddressesWithoutCode>
<CustName>sample string 2</CustName>
<CustNmbr>sample string 1</CustNmbr>
<ExistingAddressCSZ>sample string 9</ExistingAddressCSZ>
<ExistingAddressLine1>sample string 8</ExistingAddressLine1>
<ExistingEntityUseCode>sample string 10</ExistingEntityUseCode>
<NewAddressCSZ>sample string 4</NewAddressCSZ>
<NewAddressId>sample string 16</NewAddressId>
<NewAddressLine1>sample string 3</NewAddressLine1>
<NewAddressState>sample string 6</NewAddressState>
<NewAddressStateName>sample string 7</NewAddressStateName>
<NewEntityUseCode>sample string 5</NewEntityUseCode>
<PreferredEntityUseCode>sample string 11</PreferredEntityUseCode>
<PreferredIsStateMatch>true</PreferredIsStateMatch>
<TotalAddresses>13</TotalAddresses>
</ValidateUseCodeModels.ValidateUseCodeRow>
<ValidateUseCodeModels.ValidateUseCodeRow>
<AddressesWithCode>14</AddressesWithCode>
<AddressesWithoutCode>15</AddressesWithoutCode>
<CustName>sample string 2</CustName>
<CustNmbr>sample string 1</CustNmbr>
<ExistingAddressCSZ>sample string 9</ExistingAddressCSZ>
<ExistingAddressLine1>sample string 8</ExistingAddressLine1>
<ExistingEntityUseCode>sample string 10</ExistingEntityUseCode>
<NewAddressCSZ>sample string 4</NewAddressCSZ>
<NewAddressId>sample string 16</NewAddressId>
<NewAddressLine1>sample string 3</NewAddressLine1>
<NewAddressState>sample string 6</NewAddressState>
<NewAddressStateName>sample string 7</NewAddressStateName>
<NewEntityUseCode>sample string 5</NewEntityUseCode>
<PreferredEntityUseCode>sample string 11</PreferredEntityUseCode>
<PreferredIsStateMatch>true</PreferredIsStateMatch>
<TotalAddresses>13</TotalAddresses>
</ValidateUseCodeModels.ValidateUseCodeRow>
</Data>
<ErrorWrappers>
<ErrorWrapper>
<AdditionalInformation>sample string 3</AdditionalInformation>
<ErrorCode>sample string 2</ErrorCode>
<ErrorMessage>sample string 1</ErrorMessage>
</ErrorWrapper>
<ErrorWrapper>
<AdditionalInformation>sample string 3</AdditionalInformation>
<ErrorCode>sample string 2</ErrorCode>
<ErrorMessage>sample string 1</ErrorMessage>
</ErrorWrapper>
</ErrorWrappers>
<GridSummary>sample string 2</GridSummary>
<ResponseStatus>sample string 1</ResponseStatus>
<ValidationMessages xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>sample string 1</d2p1:string>
<d2p1:string>sample string 2</d2p1:string>
</ValidationMessages>
<Warnings xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>sample string 1</d2p1:string>
<d2p1:string>sample string 2</d2p1:string>
</Warnings>
</ValidateUseCodeModels.ValidateUseCodeWrapper>