Group Company Data Ex-Code Overrides

Create GroupCompanyDataExCodeOverride

Creates a new GroupCompanyDataExCodeOverride

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
groupID
required
string

Group ID

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
groupCompanyDataExCodeOverride_Key
required
integer <int32>

Unique identifier for each Ex Code override configuration. Note: This field is marked as NOT NULL in the database and therefore required by the API.

companyData_Ex_Code_Field
required
string [ 1 .. 128 ] characters

Indicates the Ex_Code field on CompanyData that is having an override applied for this Group/Division.

division_ID
string or null <= 20 characters

References GroupDivision.Division_ID value on the parent record.

entry_Date
string <date-time>

User that first added the record to the system.

entry_User
string or null <= 20 characters

Date when the record was first added to the system.

group_ID
required
string [ 1 .. 20 ] characters

References GroupDivision.Group_ID value on the parent record.

override_Ex_Code
string or null <= 6 characters

References ExplanationCodes.Ex_Code and is the override value that is used instead of the setting on CompanyData during adjudication.

update_Date
string <date-time>

User that last updated the record in the system.

update_User
string or null <= 20 characters

Date when the record was last updated in the system.

Responses
200

Success

401

Unauthorized

post/groups/{groupID}/company-data-ex-code-overrides
Request samples
{
  • "groupCompanyDataExCodeOverride_Key": 0,
  • "companyData_Ex_Code_Field": "string",
  • "division_ID": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "group_ID": "string",
  • "override_Ex_Code": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List GroupCompanyDataExCodeOverride

Lists all GroupCompanyDataExCodeOverride for the given groupID

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
groupID
required
string

Group ID

query Parameters
page
integer <int32>
Default: 1

Page

pageSize
integer <int32>
Default: 100

Page Size

sortBy
string

Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., 'Property1:desc,Property2:asc,Property3:asc' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/groups/{groupID}/company-data-ex-code-overrides
Request samples 
Response samples 
No sample
Get GroupCompanyDataExCodeOverride
Gets GroupCompanyDataExCodeOverride


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
groupID
required
string
Group ID


 
groupCompanyDataExCodeOverrideKey
required
integer <int32> 
GroupCompanyDataExCodeOverride Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/groups/{groupID}/company-data-ex-code-overrides/{groupCompanyDataExCodeOverrideKey}
Request samples 
Response samples 
No sample
Update GroupCompanyDataExCodeOverride
Updates a specific GroupCompanyDataExCodeOverride.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
groupID
required
string
Group ID


 
groupCompanyDataExCodeOverrideKey
required
integer <int32> 
GroupCompanyDataExCodeOverride Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
groupCompanyDataExCodeOverride_Key
required
integer <int32> 
Unique identifier for each Ex Code override configuration. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
companyData_Ex_Code_Field
required
string  [ 1 .. 128 ] characters 
Indicates the Ex_Code field on CompanyData that is having an override applied for this Group/Division.


 
division_ID
string or null  <= 20 characters 
References GroupDivision.Division_ID value on the parent record.


 
entry_Date
string <date-time> 
User that first added the record to the system.


 
entry_User
string or null  <= 20 characters 
Date when the record was first added to the system.


 
group_ID
required
string  [ 1 .. 20 ] characters 
References GroupDivision.Group_ID value on the parent record.


 
override_Ex_Code
string or null  <= 6 characters 
References ExplanationCodes.Ex_Code and is the override value that is used instead of the setting on CompanyData during adjudication.


 
update_Date
string <date-time> 
User that last updated the record in the system.


 
update_User
string or null  <= 20 characters 
Date when the record was last updated in the system.


 
Responses 
200
Success


401
Unauthorized


put/groups/{groupID}/company-data-ex-code-overrides/{groupCompanyDataExCodeOverrideKey}
Request samples 
{
  • "groupCompanyDataExCodeOverride_Key": 0,
  • "companyData_Ex_Code_Field": "string",
  • "division_ID": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "group_ID": "string",
  • "override_Ex_Code": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete GroupCompanyDataExCodeOverride
Deletes an GroupCompanyDataExCodeOverride


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
groupID
required
string
Group ID


 
groupCompanyDataExCodeOverrideKey
required
integer <int32> 
GroupCompanyDataExCodeOverride Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/groups/{groupID}/company-data-ex-code-overrides/{groupCompanyDataExCodeOverrideKey}
Request samples 
Create or Update Batch GroupCompanyDataExCodeOverride
Create or Update multiple GroupCompanyDataExCodeOverride at once.  If the entity exists, it will be updated.  If the entity does not exist, it will be created.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
groupID
required
string
Group ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
groupCompanyDataExCodeOverride_Key
required
integer <int32> 
Unique identifier for each Ex Code override configuration. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
companyData_Ex_Code_Field
required
string  [ 1 .. 128 ] characters 
Indicates the Ex_Code field on CompanyData that is having an override applied for this Group/Division.


 
division_ID
string or null  <= 20 characters 
References GroupDivision.Division_ID value on the parent record.


 
entry_Date
string <date-time> 
User that first added the record to the system.


 
entry_User
string or null  <= 20 characters 
Date when the record was first added to the system.


 
group_ID
required
string  [ 1 .. 20 ] characters 
References GroupDivision.Group_ID value on the parent record.


 
override_Ex_Code
string or null  <= 6 characters 
References ExplanationCodes.Ex_Code and is the override value that is used instead of the setting on CompanyData during adjudication.


 
update_Date
string <date-time> 
User that last updated the record in the system.


 
update_User
string or null  <= 20 characters 
Date when the record was last updated in the system.


 
Responses 
207
Success


401
Unauthorized


put/groups/{groupID}/company-data-ex-code-overrides-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}