Reason Codes
Base URL: https://api.covasoft.net/reasoncode
Endpoints
| Endpoint | Description |
|---|---|
GET Companies({CompanyId})/ReasonCodes | Returns All the Reason Codes for a Company |
GET Companies({CompanyId})/ReasonCodes({ReasonCodeId}) | Returns Details for a Reason Code |
POST Companies({CompanyId})/ReasonCodes | Creates a Reason Code for a Company |
DELETE Companies({CompanyId})/ReasonCodes({ReasonCodeId}) | Delete a Reason Code in a Company |
GET Companies({CompanyId})/ReasonCodes
Returns All the Reason Codes for a Company
Base URL:
https://api.covasoft.net/reasoncode
Example of a call would be:
https://api.covasoft.net/reasoncode/Companies({CompanyId})/ReasonCodes
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| CompanyId | The unique Company Id that was provided in your onboarding pacakage | integer | Required |
Body Parameters
None.
Response Information
Resource Description
All the Reason Codes for a Company
Collection of ReasonCodesByCompanyReturn
| Name | Description | Type | Additional information |
|---|---|---|---|
| Id | globally unique identifier | None. | |
| Name | string | None. | |
| Type | string | None. | |
| UpdatedDateUtc | date | None. | |
| UpdatedBy | string | None. |
Response Formats
application/json, text/json
[
{
"Id": "47ae84df-8a89-4308-bce3-838292061efc",
"Name": "sample string 2",
"Type": "sample string 3",
"UpdatedDateUtc": "2026-10-02T17:43:41.7311545+00:00",
"UpdatedBy": "sample string 5"
},
{
"Id": "47ae84df-8a89-4308-bce3-838292061efc",
"Name": "sample string 2",
"Type": "sample string 3",
"UpdatedDateUtc": "2026-10-02T17:43:41.7311545+00:00",
"UpdatedBy": "sample string 5"
}
]
GET Companies({CompanyId})/ReasonCodes({ReasonCodeId})
Returns Details for a Reason Code
Base URL:
https://api.covasoft.net/reasoncode
Example of a call would be:
https://api.covasoft.net/reasoncode/Companies({CompanyId})/ReasonCodes({ReasonCodeId})
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| CompanyId | The unique Company Id that was provided in your onboarding pacakage | integer | Required |
| ReasonCodeId | The Reason Code Id Guid you want to get Details | globally unique identifier | Required |
Body Parameters
None.
Response Information
Resource Description
Details for a Reason Code
ReasonCodeDetailsReturn
| Name | Description | Type | Additional information |
|---|---|---|---|
| Id | globally unique identifier | None. | |
| Name | string | None. | |
| Type | string | None. | |
| UpdatedDateUtc | date | None. | |
| UpdatedBy | string | None. |
Response Formats
application/json, text/json
{
"Id": "c97fd8d4-202a-4695-a9a2-344dc772d884",
"Name": "sample string 2",
"Type": "sample string 3",
"UpdatedDateUtc": "2026-10-02T17:43:44.1884797+00:00",
"UpdatedBy": "sample string 5"
}
POST Companies({CompanyId})/ReasonCodes
Creates a Reason Code for a Company
Base URL:
https://api.covasoft.net/reasoncode
Example of a call would be:
https://api.covasoft.net/reasoncode/Companies({CompanyId})/ReasonCodes
Body Example:
{ "Name": "Test - New Quantity reason code", "Type": "Quantity" }
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| CompanyId | The unique Company Id that was provided in your onboarding pacakage | integer | Required |
Body Parameters
Body of call see example above
CreateReasonCodePost
| Name | Description | Type | Additional information |
|---|---|---|---|
| Name | string | None. | |
| Type | string | None. |
Request Formats
application/json, text/json
{
"Name": "sample string 1",
"Type": "sample string 2"
}
Response Information
Resource Description
The Created Reason Code
None.
Response Formats
application/json, text/json
Sample not available.
Models
IHttpActionResult
None.
DELETE Companies({CompanyId})/ReasonCodes({ReasonCodeId})
Delete a Reason Code in a Company
Base URL:
https://api.covasoft.net/reasoncode
Example of a call would be:
https://api.covasoft.net/reasoncode/Companies({CompanyId})/ReasonCodes({ReasonCodeId})
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| CompanyId | The unique Company Id that was provided in your onboarding pacakage | integer | Required |
| ReasonCodeId | The Reason Code Id Guid you want to get Details | globally unique identifier | Required |
Body Parameters
None.
Response Information
Resource Description
HttpResponseMessage
| Name | Description | Type | Additional information |
|---|---|---|---|
| Version | Version | None. | |
| Content | HttpContent | None. | |
| StatusCode | HttpStatusCode | None. | |
| ReasonPhrase | string | None. | |
| Headers | Collection of Object | None. | |
| RequestMessage | HttpRequestMessage | None. | |
| IsSuccessStatusCode | boolean | None. |
Models
Version
| Name | Description | Type | Additional information |
|---|---|---|---|
| Major | integer | None. | |
| Minor | integer | None. | |
| Build | integer | None. | |
| Revision | integer | None. | |
| MajorRevision | integer | None. | |
| MinorRevision | integer | None. |
HttpContent
| Name | Description | Type | Additional information |
|---|---|---|---|
| Headers | Collection of Object | None. |
HttpStatusCode
Possible enumeration values:
| Name | Value | Description |
|---|---|---|
| Continue | 100 | |
| SwitchingProtocols | 101 | |
| OK | 200 | |
| Created | 201 | |
| Accepted | 202 | |
| NonAuthoritativeInformation | 203 | |
| NoContent | 204 | |
| ResetContent | 205 | |
| PartialContent | 206 | |
| MultipleChoices | 300 | |
| Ambiguous | 300 | |
| MovedPermanently | 301 | |
| Moved | 301 | |
| Found | 302 | |
| Redirect | 302 | |
| SeeOther | 303 | |
| RedirectMethod | 303 | |
| NotModified | 304 | |
| UseProxy | 305 | |
| Unused | 306 | |
| TemporaryRedirect | 307 | |
| RedirectKeepVerb | 307 | |
| BadRequest | 400 | |
| Unauthorized | 401 | |
| PaymentRequired | 402 | |
| Forbidden | 403 | |
| NotFound | 404 | |
| MethodNotAllowed | 405 | |
| NotAcceptable | 406 | |
| ProxyAuthenticationRequired | 407 | |
| RequestTimeout | 408 | |
| Conflict | 409 | |
| Gone | 410 | |
| LengthRequired | 411 | |
| PreconditionFailed | 412 | |
| RequestEntityTooLarge | 413 | |
| RequestUriTooLong | 414 | |
| UnsupportedMediaType | 415 | |
| RequestedRangeNotSatisfiable | 416 | |
| ExpectationFailed | 417 | |
| UpgradeRequired | 426 | |
| InternalServerError | 500 | |
| NotImplemented | 501 | |
| BadGateway | 502 | |
| ServiceUnavailable | 503 | |
| GatewayTimeout | 504 | |
| HttpVersionNotSupported | 505 |
HttpRequestMessage
| Name | Description | Type | Additional information |
|---|---|---|---|
| Version | Version | None. | |
| Content | HttpContent | None. | |
| Method | HttpMethod | None. | |
| RequestUri | URI | None. | |
| Headers | Collection of Object | None. | |
| Properties | Dictionary of string [key] and Object [value] | None. |
HttpMethod
| Name | Description | Type | Additional information |
|---|---|---|---|
| Method | string | None. |