Auth Reference

Create AuthReference

Creates a new AuthReference from an existing Auth

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
originalAuthNumber
required
string

Original Auth Number

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
original_Auth_Number
required
string [ 1 .. 20 ] characters

This is the Auth Number being referenced by Referenced Auth Number

referenced_Auth_Number
required
string [ 1 .. 20 ] characters

This is the Auth Number being referenced by Original Auth Number

entry_Date
string <date-time>

Date when the record was first added to the system.

entry_User
string or null <= 20 characters

User that first added the record to the system.

reference_Date
string or null <date-time>

The date this reference was processed by the system.

reference_Type
required
string [ 1 .. 2 ] characters

This indicates the type of Reference being made. The only Reference_Type value currently in use is "A" for "Adjustment".

update_Date
string <date-time>

Date when 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/auths/{originalAuthNumber}/references
Request samples
{
  • "original_Auth_Number": "string",
  • "referenced_Auth_Number": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "reference_Date": "2019-08-24T14:15:22Z",
  • "reference_Type": "st",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List AuthReferences

Lists all AuthReference for an existing Auth

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
originalAuthNumber
required
string

Original Auth Number

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/auths/{originalAuthNumber}/references
Request samples 
Response samples 
No sample
Get AuthReference
Gets AuthReference


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
originalAuthNumber
required
string
Original Auth Number


 
referencedAuthNumber
required
string
Referenced Auth Number


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/auths/{originalAuthNumber}/references/{referencedAuthNumber}
Request samples 
Response samples 
No sample
Update AuthReference
Updates a specific AuthReference.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
originalAuthNumber
required
string
Original Auth Number


 
referencedAuthNumber
required
string
Referenced Auth Number


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
original_Auth_Number
required
string  [ 1 .. 20 ] characters 
This is the Auth Number being referenced by Referenced Auth Number


 
referenced_Auth_Number
required
string  [ 1 .. 20 ] characters 
This is the Auth Number being referenced by Original Auth Number


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


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


 
reference_Date
string or null <date-time> 
The date this reference was processed by the system.


 
reference_Type
required
string  [ 1 .. 2 ] characters 
This indicates the type of Reference being made. The only Reference_Type value currently in use is "A" for "Adjustment".


 
update_Date
string <date-time> 
Date when 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/auths/{originalAuthNumber}/references/{referencedAuthNumber}
Request samples 
{
  • "original_Auth_Number": "string",
  • "referenced_Auth_Number": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "reference_Date": "2019-08-24T14:15:22Z",
  • "reference_Type": "st",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete AuthReference
Deletes an AuthReference


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
originalAuthNumber
required
string
Original Auth Number


 
referencedAuthNumber
required
string
Referenced Auth Number


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/auths/{originalAuthNumber}/references/{referencedAuthNumber}
Request samples 
Update Batch AuthReference
Updates a multiple AuthReference.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
originalAuthNumber
required
string
Original Auth Number


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
original_Auth_Number
required
string  [ 1 .. 20 ] characters 
This is the Auth Number being referenced by Referenced Auth Number


 
referenced_Auth_Number
required
string  [ 1 .. 20 ] characters 
This is the Auth Number being referenced by Original Auth Number


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


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


 
reference_Date
string or null <date-time> 
The date this reference was processed by the system.


 
reference_Type
required
string  [ 1 .. 2 ] characters 
This indicates the type of Reference being made. The only Reference_Type value currently in use is "A" for "Adjustment".


 
update_Date
string <date-time> 
Date when 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/auths/{originalAuthNumber}/references-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}