Group Account Periods

Create GroupAccountPeriod

Creates a new GroupAccountPeriod

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
groupID
required
string

Group ID

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
groupAccountPeriod_Key
required
integer <int32>

Unique identifier for each effective period on this account setting. Note: This field is marked as NOT NULL in the database and therefore required by the API.

division_ID
string or null <= 20 characters

References GroupDivision.Division_ID value on the parent record.

effective_Date
string or null <date-time>

Date when the Group Account Period becomes/became effective.

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
required
string [ 1 .. 20 ] characters

References GroupDivision.Group_ID value on the parent record.

term_Date
string or null <date-time>

Date when the Group Account Period expires/expired.

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/groups/{groupID}/account-periods
Request samples
{
  • "groupAccountPeriod_Key": 0,
  • "division_ID": "string",
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "group_ID": "string",
  • "term_Date": "2019-08-24T14:15:22Z",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List GroupAccountPeriod

Lists all GroupAccountPeriod

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
groupID
required
string

Group ID

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/groups/{groupID}/account-periods
Request samples 
Response samples 
No sample
Get GroupAccountPeriod
Gets GroupAccountPeriod


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
groupID
required
string
Group ID


 
groupAccountPeriodKey
required
integer <int32> 
GroupAccountPeriod Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/groups/{groupID}/account-periods/{groupAccountPeriodKey}
Request samples 
Response samples 
No sample
Update GroupAccountPeriod
Updates a specific GroupAccountPeriod.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
groupID
required
string
Group ID


 
groupAccountPeriodKey
required
integer <int32> 
GroupAccountPeriod Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
groupAccountPeriod_Key
required
integer <int32> 
Unique identifier for each effective period on this account setting. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
division_ID
string or null  <= 20 characters 
References GroupDivision.Division_ID value on the parent record.


 
effective_Date
string or null <date-time> 
Date when the Group Account Period becomes/became effective.


 
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
required
string  [ 1 .. 20 ] characters 
References GroupDivision.Group_ID value on the parent record.


 
term_Date
string or null <date-time> 
Date when the Group Account Period expires/expired.


 
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/groups/{groupID}/account-periods/{groupAccountPeriodKey}
Request samples 
{
  • "groupAccountPeriod_Key": 0,
  • "division_ID": "string",
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "group_ID": "string",
  • "term_Date": "2019-08-24T14:15:22Z",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete GroupAccountPeriod
Deletes an GroupAccountPeriod


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
groupID
required
string
Group ID


 
groupAccountPeriodKey
required
integer <int32> 
GroupAccountPeriod Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/groups/{groupID}/account-periods/{groupAccountPeriodKey}
Request samples 
Create or Update Batch GroupAccountPeriod
Create or Update multiple GroupAccountPeriod at once.  If the entity exists, it will be updated.  If the entity does not exist, it will be created.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
groupID
required
string
Group ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
groupAccountPeriod_Key
required
integer <int32> 
Unique identifier for each effective period on this account setting. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
division_ID
string or null  <= 20 characters 
References GroupDivision.Division_ID value on the parent record.


 
effective_Date
string or null <date-time> 
Date when the Group Account Period becomes/became effective.


 
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
required
string  [ 1 .. 20 ] characters 
References GroupDivision.Group_ID value on the parent record.


 
term_Date
string or null <date-time> 
Date when the Group Account Period expires/expired.


 
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/groups/{groupID}/account-periods-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}