Premium Payment File Formats

Create PremPaymentFileFormat

Creates a new PremPaymentFileFormat

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
payment_File_Format_Key
required
integer <int32>

Unique identifier of the PremPaymentFileFormat table Note: This field is marked as NOT NULL in the database and therefore required by the API.

business_Object
string or null <= 64 characters

PowerBuilder object that defines the file layout

description
string or null <= 512 characters

Description of the File 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

Not used

length
integer or null <int32>

Not used

payment_Type
string or null <= 16 characters

Type of the Payment

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

List PremPaymentFileFormat

Lists all PremPaymentFileFormat

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/premium-payment-file-formats
Request samples 
Response samples 
No sample
Get PremPaymentFileFormat
Gets PremPaymentFileFormat


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
paymentFileFormatKey
required
integer <int32> 
Payment File Format Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/premium-payment-file-formats/{paymentFileFormatKey}
Request samples 
Response samples 
No sample
Update PremPaymentFileFormat
Updates a specific PremPaymentFileFormat.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
paymentFileFormatKey
required
integer <int32> 
Payment File Format Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
payment_File_Format_Key
required
integer <int32> 
Unique identifier of the PremPaymentFileFormat table Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
business_Object
string or null  <= 64 characters 
PowerBuilder object that defines the file layout


 
description
string or null  <= 512 characters 
Description of the File 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 
Not used


 
length
integer or null <int32> 
Not used


 
payment_Type
string or null  <= 16 characters 
Type of the Payment


 
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/premium-payment-file-formats/{paymentFileFormatKey}
Request samples 
{
  • "payment_File_Format_Key": 0,
  • "business_Object": "string",
  • "description": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "format": "string",
  • "length": 0,
  • "payment_Type": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete PremPaymentFileFormat
Deletes an PremPaymentFileFormat


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
paymentFileFormatKey
required
integer <int32> 
Payment File Format Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/premium-payment-file-formats/{paymentFileFormatKey}
Request samples 
Create or Update Batch PremPaymentFileFormat
Create or Update multiple PremPaymentFileFormat 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 
payment_File_Format_Key
required
integer <int32> 
Unique identifier of the PremPaymentFileFormat table Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
business_Object
string or null  <= 64 characters 
PowerBuilder object that defines the file layout


 
description
string or null  <= 512 characters 
Description of the File 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 
Not used


 
length
integer or null <int32> 
Not used


 
payment_Type
string or null  <= 16 characters 
Type of the Payment


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