Funding Statement Formats

Create FundingStatementFormat

Creates a new FundingStatementFormat

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
statement_Format_Key
required
integer <int32>

ID of the statement_format. Note: This field is marked as NOT NULL in the database and therefore required by the API.

business_Object
string or null <= 64 characters

Object of the funding statement format.

description
string or null <= 64 characters

Description of the funding statement format.

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

format
string or null <= 32 characters

Format of the funding statement format.

length
integer or null <int32>

ID of the length.

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/funding-statement-formats
Request samples
{
  • "statement_Format_Key": 0,
  • "business_Object": "string",
  • "description": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "format": "string",
  • "length": 0,
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List FundingStatementFormat

Lists all FundingStatementFormat

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/funding-statement-formats
Request samples 
Response samples 
No sample
Get FundingStatementFormat
Gets FundingStatementFormat


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
statementFormatKey
required
integer <int32> 
Statement Format Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/funding-statement-formats/{statementFormatKey}
Request samples 
Response samples 
No sample
Update FundingStatementFormat
Updates a specific FundingStatementFormat.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
statementFormatKey
required
integer <int32> 
Statement Format Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
statement_Format_Key
required
integer <int32> 
ID of the statement_format. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
business_Object
string or null  <= 64 characters 
Object of the funding statement format.


 
description
string or null  <= 64 characters 
Description of the funding statement format.


 
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


 
format
string or null  <= 32 characters 
Format of the funding statement format.


 
length
integer or null <int32> 
ID of the length.


 
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/funding-statement-formats/{statementFormatKey}
Request samples 
{
  • "statement_Format_Key": 0,
  • "business_Object": "string",
  • "description": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "format": "string",
  • "length": 0,
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete FundingStatementFormat
Deletes an FundingStatementFormat


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
statementFormatKey
required
integer <int32> 
Statement Format Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/funding-statement-formats/{statementFormatKey}
Request samples 
Create or Update Batch FundingStatementFormat
Create or Update multiple FundingStatementFormat 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 
statement_Format_Key
required
integer <int32> 
ID of the statement_format. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
business_Object
string or null  <= 64 characters 
Object of the funding statement format.


 
description
string or null  <= 64 characters 
Description of the funding statement format.


 
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


 
format
string or null  <= 32 characters 
Format of the funding statement format.


 
length
integer or null <int32> 
ID of the length.


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