Payor Account Signatures

Create PayorAccountSignature

Creates a new PayorAccountSignature

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
payorAccountSignature_Key
required
integer <int32>

Unique identifer for this Account Signature. Note: This field is marked as NOT NULL in the database and therefore required by the API.

effective_Date
required
string <date-time>

Date when the Payor signature becomes effective. 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 added to the system.

entry_User
string or null <= 20 characters

User that first added the record to the system.

payor_Account_Key
required
integer <int32>

The Payor/Account that this signature definite is attached. Note: This field is marked as NOT NULL in the database and therefore required by the API.

required
required
boolean

Indicates whether the Payor's signature is always required. Note: This field is marked as NOT NULL in the database and therefore required by the API.

signature_Key
required
integer <int32>

Select the signature to be used on this Payor's check stock. Note: This field is marked as NOT NULL in the database and therefore required by the API.

term_Date
string or null <date-time>

Date when the Payor signature expires.

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/payor-account-signatures
Request samples
{
  • "payorAccountSignature_Key": 0,
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "payor_Account_Key": 0,
  • "required": true,
  • "signature_Key": 0,
  • "term_Date": "2019-08-24T14:15:22Z",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List PayorAccountSignature

Lists all PayorAccountSignature

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/payor-account-signatures
Request samples 
Response samples 
No sample
Get PayorAccountSignature
Gets PayorAccountSignature


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
payorAccountSignatureKey
required
integer <int32> 
PayorAccountSignature Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/payor-account-signatures/{payorAccountSignatureKey}
Request samples 
Response samples 
No sample
Update PayorAccountSignature
Updates a specific PayorAccountSignature.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
payorAccountSignatureKey
required
integer <int32> 
PayorAccountSignature Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
payorAccountSignature_Key
required
integer <int32> 
Unique identifer for this Account Signature. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
effective_Date
required
string <date-time> 
Date when the Payor signature becomes effective. 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 added to the system.


 
entry_User
string or null  <= 20 characters 
User that first added the record to the system.


 
payor_Account_Key
required
integer <int32> 
The Payor/Account that this signature definite is attached. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
required
required
boolean
Indicates whether the Payor's signature is always required. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
signature_Key
required
integer <int32> 
Select the signature to be used on this Payor's check stock. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
term_Date
string or null <date-time> 
Date when the Payor signature expires.


 
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/payor-account-signatures/{payorAccountSignatureKey}
Request samples 
{
  • "payorAccountSignature_Key": 0,
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "payor_Account_Key": 0,
  • "required": true,
  • "signature_Key": 0,
  • "term_Date": "2019-08-24T14:15:22Z",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete PayorAccountSignature
Deletes an PayorAccountSignature


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
payorAccountSignatureKey
required
integer <int32> 
PayorAccountSignature Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/payor-account-signatures/{payorAccountSignatureKey}
Request samples 
Create or Update Batch PayorAccountSignature
Create or Update multiple PayorAccountSignature 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 
payorAccountSignature_Key
required
integer <int32> 
Unique identifer for this Account Signature. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
effective_Date
required
string <date-time> 
Date when the Payor signature becomes effective. 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 added to the system.


 
entry_User
string or null  <= 20 characters 
User that first added the record to the system.


 
payor_Account_Key
required
integer <int32> 
The Payor/Account that this signature definite is attached. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
required
required
boolean
Indicates whether the Payor's signature is always required. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
signature_Key
required
integer <int32> 
Select the signature to be used on this Payor's check stock. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
term_Date
string or null <date-time> 
Date when the Payor signature expires.


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