Claim Offset Detail

Create ClaimOffsetDetail

Creates a new ClaimOffsetDetail

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
claimOffsetDetail_Key
required
integer <int32>

Note: This field is marked as NOT NULL in the database and therefore required by the API.

check_ID
required
integer <int32>

Note: This field is marked as NOT NULL in the database and therefore required by the API.

claimOffset_Key
required
integer <int32>

Note: This field is marked as NOT NULL in the database and therefore required by the API.

claim_Number
required
integer <int32>

Note: This field is marked as NOT NULL in the database and therefore required by the API.

entry_Date
string <date-time>

Date record was first added to the system

entry_User
string or null <= 20 characters

User that first added the record to the system

item_Seq
required
integer <int32>

Note: This field is marked as NOT NULL in the database and therefore required by the API.

update_Date
string <date-time>

Date the record was last updated in the system

update_User
string or null <= 20 characters

User that last updated the record in the system

Responses
200

Success

401

Unauthorized

post/claim-offset-details
Request samples
{
  • "claimOffsetDetail_Key": 0,
  • "check_ID": 0,
  • "claimOffset_Key": 0,
  • "claim_Number": 0,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "item_Seq": 0,
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List ClaimOffsetDetail

Lists all ClaimOffsetDetail with optional ClaimOffset_Key query parameter to filter results.

SecurityapiKeyAuth and bearerAuth
Request
query Parameters
ClaimOffset_Key
integer <int32>

ClaimOffset Key

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.

page
integer <int32>
Default: 1

Page

pageSize
integer <int32>
Default: 100

Page Size

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/claim-offset-details
Request samples 
Response samples 
No sample
Get ClaimOffsetDetail
Gets ClaimOffsetDetail


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
ClaimOffsetDetail_Key
required
integer <int32> 
ClaimOffsetDetail Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/claim-offset-details/{ClaimOffsetDetail_Key}
Request samples 
Response samples 
No sample
Update ClaimOffsetDetail
Updates a specific ClaimOffsetDetail.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
ClaimOffsetDetail_Key
required
integer <int32> 
ClaimOffsetDetail Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
claimOffsetDetail_Key
required
integer <int32> 
Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
check_ID
required
integer <int32> 
Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
claimOffset_Key
required
integer <int32> 
Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
claim_Number
required
integer <int32> 
Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
entry_Date
string <date-time> 
Date record was first added to the system


 
entry_User
string or null  <= 20 characters 
User that first added the record to the system


 
item_Seq
required
integer <int32> 
Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
update_Date
string <date-time> 
Date the record was last updated in the system


 
update_User
string or null  <= 20 characters 
User that last updated the record in the system


 
Responses 
200
Success


401
Unauthorized


put/claim-offset-details/{ClaimOffsetDetail_Key}
Request samples 
{
  • "claimOffsetDetail_Key": 0,
  • "check_ID": 0,
  • "claimOffset_Key": 0,
  • "claim_Number": 0,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "item_Seq": 0,
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete ClaimOffsetDetail
Deletes an ClaimOffsetDetail


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
ClaimOffsetDetail_Key
required
integer <int32> 
ClaimOffsetDetail Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/claim-offset-details/{ClaimOffsetDetail_Key}
Request samples 
Create or Update Batch ClaimOffsetDetail
Create or Update multiple ClaimOffsetDetail at once.  If the entity exists, it will be updated.  If the entity does not exist, it will be created.


SecurityapiKeyAuth and bearerAuth 
Request 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
claimOffsetDetail_Key
required
integer <int32> 
Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
check_ID
required
integer <int32> 
Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
claimOffset_Key
required
integer <int32> 
Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
claim_Number
required
integer <int32> 
Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
entry_Date
string <date-time> 
Date record was first added to the system


 
entry_User
string or null  <= 20 characters 
User that first added the record to the system


 
item_Seq
required
integer <int32> 
Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
update_Date
string <date-time> 
Date the record was last updated in the system


 
update_User
string or null  <= 20 characters 
User that last updated the record in the system


 
Responses 
207
Success


401
Unauthorized


put/claim-offset-details-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}