Tolerances

Create Tolerance

Creates a new Tolerance

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
tolerance_Key
required
integer <int32>

Unique identifier for the Tolerance entry. 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

group_ID
string or null <= 20 characters

The group to which the Tolerance applies..

payment_Method
string or null <= 20 characters

The subscriber's Payment Method for which the Tolerance applies.

tolerance1
required
number <double>

The amount that is used to determine if an invoice should be closed. 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/tolerances
Request samples
{
  • "tolerance_Key": 0,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "group_ID": "string",
  • "payment_Method": "string",
  • "tolerance1": 0.1,
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List Tolerance

Lists all Tolerance

SecurityapiKeyAuth and bearerAuth
Request
query Parameters
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/tolerances
Request samples 
Response samples 
No sample
Get Tolerance
Gets Tolerance


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
Tolerance_Key
required
integer <int32> 
Tolerance Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/tolerances/{Tolerance_Key}
Request samples 
Response samples 
No sample
Update Tolerance
Updates a specific Tolerance.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
Tolerance_Key
required
integer <int32> 
Tolerance Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
tolerance_Key
required
integer <int32> 
Unique identifier for the Tolerance entry. 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


 
group_ID
string or null  <= 20 characters 
The group to which the Tolerance applies..


 
payment_Method
string or null  <= 20 characters 
The subscriber's Payment Method for which the Tolerance applies.


 
tolerance1
required
number <double> 
The amount that is used to determine if an invoice should be closed. 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/tolerances/{Tolerance_Key}
Request samples 
{
  • "tolerance_Key": 0,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "group_ID": "string",
  • "payment_Method": "string",
  • "tolerance1": 0.1,
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete Tolerance
Deletes an Tolerance


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
Tolerance_Key
required
integer <int32> 
Tolerance Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/tolerances/{Tolerance_Key}
Request samples 
Create or Update Batch Tolerance
Create or Update multiple Tolerance 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 
tolerance_Key
required
integer <int32> 
Unique identifier for the Tolerance entry. 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


 
group_ID
string or null  <= 20 characters 
The group to which the Tolerance applies..


 
payment_Method
string or null  <= 20 characters 
The subscriber's Payment Method for which the Tolerance applies.


 
tolerance1
required
number <double> 
The amount that is used to determine if an invoice should be closed. 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/tolerances-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}