EDICustomFieldValueClaims

Create EDICustomFieldValueClaim

Creates a new EDICustomFieldValueClaim

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
ediCustomFieldValueClaim_Key
required
integer <int32>

Key value that identifies a custom field value from a claim Note: The database will apply a default value of 0 for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of 0 to meet the API requirements and ensure that the functionality occurs as expected.

adjustment_Seq
required
string [ 1 .. 3 ] characters

Adjustment sequence of the claim where the custom field will be stored

batch_Claim
required
integer <int32>

Batch claim number of the claim where the custom field will be stored Note: The database will apply a default value of 0 for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of 0 to meet the API requirements and ensure that the functionality occurs as expected.

batch_Number
required
integer <int32>

Batch number of the claim where the custom field will be stored Note: The database will apply a default value of 0 for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of 0 to meet the API requirements and ensure that the functionality occurs as expected.

claim_Seq
required
string [ 1 .. 2 ] characters

Batch claim sequence of the claim where the custom field will be stored

ediCustomField_Key
required
integer <int32>

Key value that identifies a custom field on and EDI load Note: The database will apply a default value of 0 for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of 0 to meet the API requirements and ensure that the functionality occurs as expected.

field_DataType
string or null <= 32 characters

Data type of the custom field on the EDI claim load

field_Value
string or null

Data value of the custom field on the EDI claim load

Responses
200

Success

401

Unauthorized

post/edi-custom-field-value-claims
Request samples
{
  • "ediCustomFieldValueClaim_Key": 0,
  • "adjustment_Seq": "str",
  • "batch_Claim": 0,
  • "batch_Number": 0,
  • "claim_Seq": "st",
  • "ediCustomField_Key": 0,
  • "field_DataType": "string",
  • "field_Value": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List EDICustomFieldValueClaim

Lists all EDICustomFieldValueClaim

SecurityapiKeyAuth and bearerAuth
Request
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/edi-custom-field-value-claims
Request samples 
Response samples 
No sample
Get EDICustomFieldValueClaim
Gets EDICustomFieldValueClaim


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
EDICustomFieldValueClaim_Key
required
integer <int32> 
EDICustomFieldValueClaim Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/edi-custom-field-value-claims/{EDICustomFieldValueClaim_Key}
Request samples 
Response samples 
No sample
Update EDICustomFieldValueClaim
Updates a specific EDICustomFieldValueClaim.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
EDICustomFieldValueClaim_Key
required
integer <int32> 
EDICustomFieldValueClaim Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
ediCustomFieldValueClaim_Key
required
integer <int32> 
Key value that identifies a custom field value from a claim  Note: The database will apply a default value of 0 for this field if a value is not provided.  This field is also marked as NOT NULL in the database and therefore required by the API.  If you do not have a value for this field, supply the database default value of 0 to meet the API requirements and ensure that the functionality occurs as expected.


 
adjustment_Seq
required
string  [ 1 .. 3 ] characters 
Adjustment sequence of the claim where the custom field will be stored


 
batch_Claim
required
integer <int32> 
Batch claim number of the claim where the custom field will be stored  Note: The database will apply a default value of 0 for this field if a value is not provided.  This field is also marked as NOT NULL in the database and therefore required by the API.  If you do not have a value for this field, supply the database default value of 0 to meet the API requirements and ensure that the functionality occurs as expected.


 
batch_Number
required
integer <int32> 
Batch number of the claim where the custom field will be stored  Note: The database will apply a default value of 0 for this field if a value is not provided.  This field is also marked as NOT NULL in the database and therefore required by the API.  If you do not have a value for this field, supply the database default value of 0 to meet the API requirements and ensure that the functionality occurs as expected.


 
claim_Seq
required
string  [ 1 .. 2 ] characters 
Batch claim sequence of the claim where the custom field will be stored


 
ediCustomField_Key
required
integer <int32> 
Key value that identifies a custom field on and EDI load  Note: The database will apply a default value of 0 for this field if a value is not provided.  This field is also marked as NOT NULL in the database and therefore required by the API.  If you do not have a value for this field, supply the database default value of 0 to meet the API requirements and ensure that the functionality occurs as expected.


 
field_DataType
string or null  <= 32 characters 
Data type of the custom field on the EDI claim load


 
field_Value
string or null
Data value of the custom field on the EDI claim load


 
Responses 
200
Success


401
Unauthorized


put/edi-custom-field-value-claims/{EDICustomFieldValueClaim_Key}
Request samples 
{
  • "ediCustomFieldValueClaim_Key": 0,
  • "adjustment_Seq": "str",
  • "batch_Claim": 0,
  • "batch_Number": 0,
  • "claim_Seq": "st",
  • "ediCustomField_Key": 0,
  • "field_DataType": "string",
  • "field_Value": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete EDICustomFieldValueClaim
Deletes an EDICustomFieldValueClaim


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
EDICustomFieldValueClaim_Key
required
integer <int32> 
EDICustomFieldValueClaim Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/edi-custom-field-value-claims/{EDICustomFieldValueClaim_Key}
Request samples 
Create or Update Batch EDICustomFieldValueClaim
Create or Update multiple EDICustomFieldValueClaim 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 
ediCustomFieldValueClaim_Key
required
integer <int32> 
Key value that identifies a custom field value from a claim  Note: The database will apply a default value of 0 for this field if a value is not provided.  This field is also marked as NOT NULL in the database and therefore required by the API.  If you do not have a value for this field, supply the database default value of 0 to meet the API requirements and ensure that the functionality occurs as expected.


 
adjustment_Seq
required
string  [ 1 .. 3 ] characters 
Adjustment sequence of the claim where the custom field will be stored


 
batch_Claim
required
integer <int32> 
Batch claim number of the claim where the custom field will be stored  Note: The database will apply a default value of 0 for this field if a value is not provided.  This field is also marked as NOT NULL in the database and therefore required by the API.  If you do not have a value for this field, supply the database default value of 0 to meet the API requirements and ensure that the functionality occurs as expected.


 
batch_Number
required
integer <int32> 
Batch number of the claim where the custom field will be stored  Note: The database will apply a default value of 0 for this field if a value is not provided.  This field is also marked as NOT NULL in the database and therefore required by the API.  If you do not have a value for this field, supply the database default value of 0 to meet the API requirements and ensure that the functionality occurs as expected.


 
claim_Seq
required
string  [ 1 .. 2 ] characters 
Batch claim sequence of the claim where the custom field will be stored


 
ediCustomField_Key
required
integer <int32> 
Key value that identifies a custom field on and EDI load  Note: The database will apply a default value of 0 for this field if a value is not provided.  This field is also marked as NOT NULL in the database and therefore required by the API.  If you do not have a value for this field, supply the database default value of 0 to meet the API requirements and ensure that the functionality occurs as expected.


 
field_DataType
string or null  <= 32 characters 
Data type of the custom field on the EDI claim load


 
field_Value
string or null
Data value of the custom field on the EDI claim load


 
Responses 
207
Success


401
Unauthorized


put/edi-custom-field-value-claims-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}