Group ACH Pulls

Create GroupACHPull

Creates a new GroupACHPull

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
Group_ID
required
string

Group ID

header Parameters
vbasoftware-database
required
string

Target database

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

References the Groups.Group_ID value on the parent record.

acH_Pull_Day
required
integer <int32>

Day the ACH transaction occurs Note: This field is marked as NOT NULL in the database and therefore required by the API.

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.

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/{Group_ID}/ach-pulls
Request samples
{
  • "group_ID": "string",
  • "acH_Pull_Day": 0,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List GroupACHPull

Lists all GroupACHPull for the given Group_ID

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
Group_ID
required
string

Group ID

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/groups/{Group_ID}/ach-pulls
Request samples 
Response samples 
No sample
Get GroupACHPull
Gets GroupACHPull


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
Group_ID
required
string
Group ID


 
ACH_Pull_Day
required
integer <int32> 
ACH Pull Day


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/groups/{Group_ID}/ach-pulls/{ACH_Pull_Day}
Request samples 
Response samples 
No sample
Update GroupACHPull
Updates a specific GroupACHPull.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
Group_ID
required
string
Group ID


 
ACH_Pull_Day
required
integer <int32> 
ACH Pull Day


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
group_ID
required
string  [ 1 .. 20 ] characters 
References the Groups.Group_ID value on the parent record.


 
acH_Pull_Day
required
integer <int32> 
Day the ACH transaction occurs Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
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.


 
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/{Group_ID}/ach-pulls/{ACH_Pull_Day}
Request samples 
{
  • "group_ID": "string",
  • "acH_Pull_Day": 0,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete GroupACHPull
Deletes an GroupACHPull


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
Group_ID
required
string
Group ID


 
ACH_Pull_Day
required
integer <int32> 
ACH Pull Day


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/groups/{Group_ID}/ach-pulls/{ACH_Pull_Day}
Request samples 
Create or Update Batch GroupACHPull
Create or Update multiple GroupACHPull 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
Group_ID
required
string
Group ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
group_ID
required
string  [ 1 .. 20 ] characters 
References the Groups.Group_ID value on the parent record.


 
acH_Pull_Day
required
integer <int32> 
Day the ACH transaction occurs Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
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.


 
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/{Group_ID}/ach-pulls-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}