Group Bill Cycle Payment Methods

Create GroupBillCyclePaymentMethod

Creates a new GroupBillCyclePaymentMethod

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
groupBillCyclePaymentMethod_Key
required
integer <int32>

Unique identifier for the Group Billing Cycle Payment Method Note: This field is marked as NOT NULL in the database and therefore required by the API.

billing_Cycle_ID
string or null <= 2 characters

Unique identifier for the Billing Cycle

division_ID
string or null <= 20 characters

Unique ID for the Division

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.

group_ID
string or null <= 20 characters

Unique ID for the Group

payment_Method
string or null <= 20 characters

The primary key of the payment method

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/group-bill-cycle-payment-methods
Request samples
{
  • "groupBillCyclePaymentMethod_Key": 0,
  • "billing_Cycle_ID": "st",
  • "division_ID": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "group_ID": "string",
  • "payment_Method": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List GroupBillCyclePaymentMethod

Lists all GroupBillCyclePaymentMethod

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/group-bill-cycle-payment-methods
Request samples 
Response samples 
No sample
Get GroupBillCyclePaymentMethod
Gets GroupBillCyclePaymentMethod


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
GroupBillCyclePaymentMethod_Key
required
integer <int32> 
GroupBillCyclePaymentMethod Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/group-bill-cycle-payment-methods/{GroupBillCyclePaymentMethod_Key}
Request samples 
Response samples 
No sample
Update GroupBillCyclePaymentMethod
Updates a specific GroupBillCyclePaymentMethod.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
GroupBillCyclePaymentMethod_Key
required
integer <int32> 
GroupBillCyclePaymentMethod Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
groupBillCyclePaymentMethod_Key
required
integer <int32> 
Unique identifier for the Group Billing Cycle Payment Method Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
billing_Cycle_ID
string or null  <= 2 characters 
Unique identifier for the Billing Cycle


 
division_ID
string or null  <= 20 characters 
Unique ID for the Division


 
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.


 
group_ID
string or null  <= 20 characters 
Unique ID for the Group


 
payment_Method
string or null  <= 20 characters 
The primary key of the payment method


 
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/group-bill-cycle-payment-methods/{GroupBillCyclePaymentMethod_Key}
Request samples 
{
  • "groupBillCyclePaymentMethod_Key": 0,
  • "billing_Cycle_ID": "st",
  • "division_ID": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "group_ID": "string",
  • "payment_Method": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete GroupBillCyclePaymentMethod
Deletes an GroupBillCyclePaymentMethod


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
GroupBillCyclePaymentMethod_Key
required
integer <int32> 
GroupBillCyclePaymentMethod Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/group-bill-cycle-payment-methods/{GroupBillCyclePaymentMethod_Key}
Request samples 
Create or Update Batch GroupBillCyclePaymentMethod
Create or Update multiple GroupBillCyclePaymentMethod 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 
groupBillCyclePaymentMethod_Key
required
integer <int32> 
Unique identifier for the Group Billing Cycle Payment Method Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
billing_Cycle_ID
string or null  <= 2 characters 
Unique identifier for the Billing Cycle


 
division_ID
string or null  <= 20 characters 
Unique ID for the Division


 
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.


 
group_ID
string or null  <= 20 characters 
Unique ID for the Group


 
payment_Method
string or null  <= 20 characters 
The primary key of the payment method


 
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/group-bill-cycle-payment-methods-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}