Skip to main content

Reason Codes

Base URL: https://api.covasoft.net/reasoncode

Endpoints​

EndpointDescription
GET Companies({CompanyId})/ReasonCodesReturns All the Reason Codes for a Company
GET Companies({CompanyId})/ReasonCodes({ReasonCodeId})Returns Details for a Reason Code
POST Companies({CompanyId})/ReasonCodesCreates 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​

NameDescriptionTypeAdditional information
CompanyIdThe unique Company Id that was provided in your onboarding pacakageintegerRequired

Body Parameters​

None.

Response Information​

Resource Description​

All the Reason Codes for a Company

Collection of ReasonCodesByCompanyReturn

NameDescriptionTypeAdditional information
Idglobally unique identifierNone.
NamestringNone.
TypestringNone.
UpdatedDateUtcdateNone.
UpdatedBystringNone.

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​

NameDescriptionTypeAdditional information
CompanyIdThe unique Company Id that was provided in your onboarding pacakageintegerRequired
ReasonCodeIdThe Reason Code Id Guid you want to get Detailsglobally unique identifierRequired

Body Parameters​

None.

Response Information​

Resource Description​

Details for a Reason Code

ReasonCodeDetailsReturn

NameDescriptionTypeAdditional information
Idglobally unique identifierNone.
NamestringNone.
TypestringNone.
UpdatedDateUtcdateNone.
UpdatedBystringNone.

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​

NameDescriptionTypeAdditional information
CompanyIdThe unique Company Id that was provided in your onboarding pacakageintegerRequired

Body Parameters​

Body of call see example above

CreateReasonCodePost

NameDescriptionTypeAdditional information
NamestringNone.
TypestringNone.

Request Formats​

application/json, text/json

{
"Name": "sample string 1",
"Type": "sample string 2"
}

Response Information​

Resource Description​

The Created Reason Code

IHttpActionResult

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​

NameDescriptionTypeAdditional information
CompanyIdThe unique Company Id that was provided in your onboarding pacakageintegerRequired
ReasonCodeIdThe Reason Code Id Guid you want to get Detailsglobally unique identifierRequired

Body Parameters​

None.

Response Information​

Resource Description​

HttpResponseMessage

NameDescriptionTypeAdditional information
VersionVersionNone.
ContentHttpContentNone.
StatusCodeHttpStatusCodeNone.
ReasonPhrasestringNone.
HeadersCollection of ObjectNone.
RequestMessageHttpRequestMessageNone.
IsSuccessStatusCodebooleanNone.

Models​

Version
NameDescriptionTypeAdditional information
MajorintegerNone.
MinorintegerNone.
BuildintegerNone.
RevisionintegerNone.
MajorRevisionintegerNone.
MinorRevisionintegerNone.
HttpContent
NameDescriptionTypeAdditional information
HeadersCollection of ObjectNone.
HttpStatusCode

Possible enumeration values:

NameValueDescription
Continue100
SwitchingProtocols101
OK200
Created201
Accepted202
NonAuthoritativeInformation203
NoContent204
ResetContent205
PartialContent206
MultipleChoices300
Ambiguous300
MovedPermanently301
Moved301
Found302
Redirect302
SeeOther303
RedirectMethod303
NotModified304
UseProxy305
Unused306
TemporaryRedirect307
RedirectKeepVerb307
BadRequest400
Unauthorized401
PaymentRequired402
Forbidden403
NotFound404
MethodNotAllowed405
NotAcceptable406
ProxyAuthenticationRequired407
RequestTimeout408
Conflict409
Gone410
LengthRequired411
PreconditionFailed412
RequestEntityTooLarge413
RequestUriTooLong414
UnsupportedMediaType415
RequestedRangeNotSatisfiable416
ExpectationFailed417
UpgradeRequired426
InternalServerError500
NotImplemented501
BadGateway502
ServiceUnavailable503
GatewayTimeout504
HttpVersionNotSupported505
HttpRequestMessage
NameDescriptionTypeAdditional information
VersionVersionNone.
ContentHttpContentNone.
MethodHttpMethodNone.
RequestUriURINone.
HeadersCollection of ObjectNone.
PropertiesDictionary of string [key] and Object [value]None.
HttpMethod
NameDescriptionTypeAdditional information
MethodstringNone.