Send To

Create SendTo

Creates a new SendTo

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
sendTo_ID
required
string = 1 characters

Identifier for a type of entity that will be used for sending payments and correspondence

disability
required
boolean

Flag indicating this entity can receive disability payments or correspondence 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

life
required
boolean

Flag indicating this entity can receive life payments or correspondence Note: This field is marked as NOT NULL in the database and therefore required by the API.

mail_To
required
boolean

Flag indicating correspondence can be sent to this entity Note: This field is marked as NOT NULL in the database and therefore required by the API.

medical
required
boolean

Flag indicating this entity can receive medical payments or correspondence Note: This field is marked as NOT NULL in the database and therefore required by the API.

pay_To
required
boolean

Flag indicating payments can be sent to this entity Note: This field is marked as NOT NULL in the database and therefore required by the API.

sendTo_Description
string or null <= 64 characters

Description of a type of entity that will be used for sending payments and correspondence

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/send-tos
Request samples
{
  • "sendTo_ID": "s",
  • "disability": true,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "life": true,
  • "mail_To": true,
  • "medical": true,
  • "pay_To": true,
  • "sendTo_Description": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List SendTo

Lists all SendTo

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/send-tos
Request samples 
Response samples 
No sample
Get SendTo
Gets SendTo


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
sendToID
required
string
SendTo ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/send-tos/{sendToID}
Request samples 
Response samples 
No sample
Update SendTo
Updates a specific SendTo.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
sendToID
required
string
SendTo ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
sendTo_ID
required
string  = 1 characters 
Identifier for a type of entity that will be used for sending payments and correspondence


 
disability
required
boolean
Flag indicating this entity can receive disability payments or correspondence 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


 
life
required
boolean
Flag indicating this entity can receive life payments or correspondence Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
mail_To
required
boolean
Flag indicating correspondence can be sent to this entity Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
medical
required
boolean
Flag indicating this entity can receive medical payments or correspondence Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
pay_To
required
boolean
Flag indicating payments can be sent to this entity Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
sendTo_Description
string or null  <= 64 characters 
Description of a type of entity that will be used for sending payments and correspondence


 
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/send-tos/{sendToID}
Request samples 
{
  • "sendTo_ID": "s",
  • "disability": true,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "life": true,
  • "mail_To": true,
  • "medical": true,
  • "pay_To": true,
  • "sendTo_Description": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete SendTo
Deletes an SendTo


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
sendToID
required
string
SendTo ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/send-tos/{sendToID}
Request samples 
Create or Update Batch SendTo
Create or Update multiple SendTo 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 
sendTo_ID
required
string  = 1 characters 
Identifier for a type of entity that will be used for sending payments and correspondence


 
disability
required
boolean
Flag indicating this entity can receive disability payments or correspondence 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


 
life
required
boolean
Flag indicating this entity can receive life payments or correspondence Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
mail_To
required
boolean
Flag indicating correspondence can be sent to this entity Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
medical
required
boolean
Flag indicating this entity can receive medical payments or correspondence Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
pay_To
required
boolean
Flag indicating payments can be sent to this entity Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
sendTo_Description
string or null  <= 64 characters 
Description of a type of entity that will be used for sending payments and correspondence


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