Update PremPaymentFileFormat

Request

Updates a specific PremPaymentFileFormat.

Security

apiKeyAuth and bearerAuth

Path

paymentFileFormatKeyinteger, (int32)required

Payment File Format Key

vbasoftware-databasestringrequired

Target database

Bodyapplication/jsonrequired

payment_File_Format_Keyinteger, (int32)required

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

business_Objectstring or null, <= 64 characters

PowerBuilder object that defines the file layout

descriptionstring or null, <= 512 characters

Description of the File Format

entry_Datestring, (date-time)

Date record was first added to the system

entry_Userstring or null, <= 20 characters

User that first added the record to the system

formatstring or null, <= 32 characters

Not used

lengthinteger or null, (int32)

Not used

payment_Typestring or null, <= 16 characters

Type of the Payment

update_Datestring, (date-time)

Date the record was last updated in the system

update_Userstring or null, <= 20 characters

User that last updated the record in the system

curl -i -X PUT \
  'https://vbapi.vbasoftware.com/vbasoftware/premium-payment-file-formats/{paymentFileFormatKey}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'vbasoftware-database: string' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "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"
  }'

Responses

Success

Bodyapplication/json

dataobject

errorobject

debugobject

Response

{
  "data": { … },
  "error": { … },
  "debug": { … }
}