EDI Code Mappings

Create EDICodeMap

Creates a new EDICodeMap

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
ediCodeMap_Key
required
integer <int32>

Key value that identifies the EDI code map Note: This field is marked as NOT NULL in the database and therefore required by the API.

destination_Value
required
string [ 1 .. 64 ] characters

Value that is assigned at the destination when the source value is encountered

direction
required
string [ 1 .. 3 ] characters

Specifies the direction of the EDI transfer - import or export

effective_Date
string or null <date-time>

Optional date when the EDI code map condition becomes effective

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

map_Type
required
string [ 1 .. 16 ] characters

Type of map that is being used for the EDI transfer

map_Variable1
string or null <= 128 characters

Variable associated with the EDI code map

map_Variable2
string or null <= 128 characters

Variable associated with the EDI code map

map_Variable3
string or null <= 128 characters

Variable associated with the EDI code map

map_Variable4
string or null <= 128 characters

Variable associated with the EDI code map

map_Variable5
string or null <= 128 characters

Variable associated with the EDI code map

source_Value
required
string [ 1 .. 64 ] characters

Value specified by the source that needs to be mapped

term_Date
string or null <date-time>

Optional date when the EDI code map condition terminates

trading_Partner_Key
integer or null <int32>

Kev value that identifies the EDI trading partner or vendor

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/edi-code-mapping
Request samples
{
  • "ediCodeMap_Key": 0,
  • "destination_Value": "string",
  • "direction": "str",
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "map_Type": "string",
  • "map_Variable1": "string",
  • "map_Variable2": "string",
  • "map_Variable3": "string",
  • "map_Variable4": "string",
  • "map_Variable5": "string",
  • "source_Value": "string",
  • "term_Date": "2019-08-24T14:15:22Z",
  • "trading_Partner_Key": 0,
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List EDICodeMap

Lists all EDICodeMap

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-code-mapping
Request samples 
Response samples 
No sample
Get EDICodeMap
Gets EDICodeMap


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
eDICodeMapKey
required
integer <int32> 
EDICodeMap Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/edi-code-mapping/{eDICodeMapKey}
Request samples 
Response samples 
No sample
Update EDICodeMap
Updates a specific EDICodeMap.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
eDICodeMapKey
required
integer <int32> 
EDICodeMap Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
ediCodeMap_Key
required
integer <int32> 
Key value that identifies the EDI code map Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
destination_Value
required
string  [ 1 .. 64 ] characters 
Value that is assigned at the destination when the source value is encountered


 
direction
required
string  [ 1 .. 3 ] characters 
Specifies the direction of the EDI transfer - import or export


 
effective_Date
string or null <date-time> 
Optional date when the EDI code map condition becomes effective


 
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


 
map_Type
required
string  [ 1 .. 16 ] characters 
Type of map that is being used for the EDI transfer


 
map_Variable1
string or null  <= 128 characters 
Variable associated with the EDI code map


 
map_Variable2
string or null  <= 128 characters 
Variable associated with the EDI code map


 
map_Variable3
string or null  <= 128 characters 
Variable associated with the EDI code map


 
map_Variable4
string or null  <= 128 characters 
Variable associated with the EDI code map


 
map_Variable5
string or null  <= 128 characters 
Variable associated with the EDI code map


 
source_Value
required
string  [ 1 .. 64 ] characters 
Value specified by the source that needs to be mapped


 
term_Date
string or null <date-time> 
Optional date when the EDI code map condition terminates


 
trading_Partner_Key
integer or null <int32> 
Kev value that identifies the EDI trading partner or vendor


 
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/edi-code-mapping/{eDICodeMapKey}
Request samples 
{
  • "ediCodeMap_Key": 0,
  • "destination_Value": "string",
  • "direction": "str",
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "map_Type": "string",
  • "map_Variable1": "string",
  • "map_Variable2": "string",
  • "map_Variable3": "string",
  • "map_Variable4": "string",
  • "map_Variable5": "string",
  • "source_Value": "string",
  • "term_Date": "2019-08-24T14:15:22Z",
  • "trading_Partner_Key": 0,
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete EDICodeMap
Deletes an EDICodeMap


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
eDICodeMapKey
required
integer <int32> 
EDICodeMap Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/edi-code-mapping/{eDICodeMapKey}
Request samples 
Create or Update Batch EDICodeMap
Create or Update multiple EDICodeMap 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 
ediCodeMap_Key
required
integer <int32> 
Key value that identifies the EDI code map Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
destination_Value
required
string  [ 1 .. 64 ] characters 
Value that is assigned at the destination when the source value is encountered


 
direction
required
string  [ 1 .. 3 ] characters 
Specifies the direction of the EDI transfer - import or export


 
effective_Date
string or null <date-time> 
Optional date when the EDI code map condition becomes effective


 
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


 
map_Type
required
string  [ 1 .. 16 ] characters 
Type of map that is being used for the EDI transfer


 
map_Variable1
string or null  <= 128 characters 
Variable associated with the EDI code map


 
map_Variable2
string or null  <= 128 characters 
Variable associated with the EDI code map


 
map_Variable3
string or null  <= 128 characters 
Variable associated with the EDI code map


 
map_Variable4
string or null  <= 128 characters 
Variable associated with the EDI code map


 
map_Variable5
string or null  <= 128 characters 
Variable associated with the EDI code map


 
source_Value
required
string  [ 1 .. 64 ] characters 
Value specified by the source that needs to be mapped


 
term_Date
string or null <date-time> 
Optional date when the EDI code map condition terminates


 
trading_Partner_Key
integer or null <int32> 
Kev value that identifies the EDI trading partner or vendor


 
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/edi-code-mapping-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}