EDICustomFields

Create EDICustomField

Creates a new EDICustomField

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
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_Name
string or null <= 64 characters

Name of the EDI custom field

source
required
string [ 1 .. 16 ] characters

Source where the EDI custom field will retrieved from

Responses
200

Success

401

Unauthorized

post/edi-custom-fields
Request samples
{
  • "ediCustomField_Key": 0,
  • "field_Name": "string",
  • "source": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List EDICustomField

Lists all EDICustomField

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-fields
Request samples 
Response samples 
No sample
Get EDICustomField
Gets EDICustomField


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
EDICustomField_Key
required
integer <int32> 
EDICustomField Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/edi-custom-fields/{EDICustomField_Key}
Request samples 
Response samples 
No sample
Update EDICustomField
Updates a specific EDICustomField.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
EDICustomField_Key
required
integer <int32> 
EDICustomField Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
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_Name
string or null  <= 64 characters 
Name of the EDI custom field


 
source
required
string  [ 1 .. 16 ] characters 
Source where the EDI custom field will retrieved from


 
Responses 
200
Success


401
Unauthorized


put/edi-custom-fields/{EDICustomField_Key}
Request samples 
{
  • "ediCustomField_Key": 0,
  • "field_Name": "string",
  • "source": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete EDICustomField
Deletes an EDICustomField


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
EDICustomField_Key
required
integer <int32> 
EDICustomField Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/edi-custom-fields/{EDICustomField_Key}
Request samples 
Create or Update Batch EDICustomField
Create or Update multiple EDICustomField 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 
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_Name
string or null  <= 64 characters 
Name of the EDI custom field


 
source
required
string  [ 1 .. 16 ] characters 
Source where the EDI custom field will retrieved from


 
Responses 
207
Success


401
Unauthorized


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