Payment Schedules

Create PaymentSchedule

Creates a new PaymentSchedule

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
payment_Schedule
required
string [ 1 .. 32 ] characters
description
string or null <= 128 characters
entry_Date
string <date-time>
entry_User
string or null <= 20 characters
schedule_Frequency
integer or null <int32>
schedule_Type
string or null <= 1 characters
update_Date
string <date-time>
update_User
string or null <= 20 characters
Responses
200

Success

401

Unauthorized

post/payment-schedules
Request samples
{
  • "payment_Schedule": "string",
  • "description": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "schedule_Frequency": 0,
  • "schedule_Type": "s",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List PaymentSchedule

Lists all PaymentSchedule

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/payment-schedules
Request samples 
Response samples 
No sample
Get PaymentSchedule
Gets PaymentSchedule


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
paymentSchedule
required
string
Payment Schedule


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/payment-schedules/{paymentSchedule}
Request samples 
Response samples 
No sample
Update PaymentSchedule
Updates a specific PaymentSchedule.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
paymentSchedule
required
string
Payment Schedule


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
payment_Schedule
required
string  [ 1 .. 32 ] characters 
 
description
string or null  <= 128 characters 
 
entry_Date
string <date-time> 
 
entry_User
string or null  <= 20 characters 
 
schedule_Frequency
integer or null <int32> 
 
schedule_Type
string or null  <= 1 characters 
 
update_Date
string <date-time> 
 
update_User
string or null  <= 20 characters 
 
Responses 
200
Success


401
Unauthorized


put/payment-schedules/{paymentSchedule}
Request samples 
{
  • "payment_Schedule": "string",
  • "description": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "schedule_Frequency": 0,
  • "schedule_Type": "s",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete PaymentSchedule
Deletes an PaymentSchedule


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
paymentSchedule
required
string
Payment Schedule


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/payment-schedules/{paymentSchedule}
Request samples 
Create or Update Batch PaymentSchedule
Create or Update multiple PaymentSchedule 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 
payment_Schedule
required
string  [ 1 .. 32 ] characters 
 
description
string or null  <= 128 characters 
 
entry_Date
string <date-time> 
 
entry_User
string or null  <= 20 characters 
 
schedule_Frequency
integer or null <int32> 
 
schedule_Type
string or null  <= 1 characters 
 
update_Date
string <date-time> 
 
update_User
string or null  <= 20 characters 
 
Responses 
207
Success


401
Unauthorized


put/payment-schedules-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}