version

Bankgiro

This component is not suitable for users who require assistive technologies.

Interacts with Bankgirot and generates and parses related files.

Component modes: Bankgiro Link | Process files | Generate files | FTP via Internet | Third party files via FTP

Component mode: FTP via Internet

Supports the FTP via Internet and FTPS methods of delivery. See FTP Communication Overview for more information.

The system settings in the Bankgiro FTP category must be set.

This mode puts generated files in the outgoing queue SoftadminApi.BankgiroFileOutgoing. The files will automatically be uploaded to Bankgirot's FTP server.

Files from Bankgirot are not handled by this mode. They can be found in the incoming queue SoftadminApi.BankgiroFileIncoming and have to be processed by the Process files mode.

Bankgiro, plusgiro, and bank account numbers

For bankgiro and plusgiro columns, the component will strip the characters '.', '-', and ' '. All other non-numeric characters will result in an error. The resulting number must contain 10 digits or less.

Bank account numbers should start with the clearing number (four digits) followed by the account number. For clearing numbers with five digits (Swedbank), do not include the fifth digit.

SQL

SQL Call: Get actions (mandatory)

May modify database: Yes

Parameters

@Action string

Set to 'Init' for this call.

Resultset: Actions

Table count: repeated exactly once

Row count: exactly one row

Columns

AgBetMak optional bit

Triggers call 'AgBetMak'.

AgBetUnd optional bit

Triggers call 'AgBetUnd'.

AgMedgivReg optional bit

Triggers call 'AgMedgivReg'.

BatchId optional int

Will be included as a parameter in subsequent calls if set.

CustomerNumber mandatory int

The customer number to use.

IsTest optional bit

Set to 1 to generate files using the test key.

SQL Call: File put in outgoing queue

Called once for each file put in the outgoing queue.

May modify database: Yes

Parameters

@Action string

The type of file generated.

Possible value	Description
AgBetMak
AgBetUnd
AgMedgivReg

@BankgiroFileOutgoingIdGenerated int

The generated ID in SoftadminApi.BankgiroFileOutgoing.

@BatchId int

The parameter is only set if a batch ID has been specified.

SQL Call: Autogiro admissions (AGMEDGIVREG) [To Bankgirot]

Is used to send AGMEDGIVREG files to Bankgirot. SQL with rows corresponding to payers whose admission, to be eligible for automatic transactions, should be registered or withdrawn. Accounts must be registered with AGMEDGIVREG before automatic transactions can be set up using AGBETUND.

May modify database: No

Parameters

@Action string

Set to 'AGMEDGIVREG' for this call.

@BatchId string

Passes the current batchid.

Resultset: Admissions and withdrawals

Resultset with one row for every admission or withdrawal.

Table count: repeated exactly once

Row count: one or more rows

Columns

BankgiroFrom optional string

Deprecated. The payer's Bankgiro account. Used as payer number if PayerNumber has not been specified.

BankgiroTo mandatory string

The account to which the payment should be made.

IsRejected optional bit

Set to 1 to reject a new mandate via the Internet bank.

OrganizationNumber optional string

The payer's organization number (10 digits).

PayerBankAccount optional string

The payer's bank acccount number. Must be returned if admission have been announced by mail form. Formatted as XXXXYYYYYYYYYYYY, where XXXX is the clearing number. If the account number is shorter than twelve digits, insert zeroes between clearing no. and account no. If account is "personkonto", using SSNO, the clearing no. should be 3300, if account is in "Handelsbanken" the clearing no. should be 6000. Not used with the service "Autogiro Företag".

PayerElectronicId optional string

ID number from electronic annoucement of admission. Retrieved from an AGMEDGIVANM file. Must be returned if admission has been announced electronically. Not used with the service "Autogiro Företag".

PayerNumber mandatory string

The payer number to use. Can contain at most 16 digits.

SSNO optional string

The payer's social security number. Formatted as YYYYMMDDXXXX. Used as payer number if PayerNumber has not been specified.

Withdraw optional bit

Set to one to withdraw admission. Leave blank or set to zero to register.

SQL Call: Autogiro payments (AGBETUND) [To Bankgirot]

Is used to send AGBETUND files to Bankgirot. SQL returning details for automatic transaction initiation. Payers must have been registered for automatic transactions by means of AGMEDGIVREG previously.

May modify database: No

Parameters

@Action string

Set to 'AGBETUND' for this call.

@BatchId string

Passes the current batchid.

Resultset: Autogiro transactions

Resultset with one row for every assignment of automatic transactions.

Table count: repeated exactly once

Row count: one or more rows

Columns

Amount mandatory decimal

The amount to be debited at every occasion within the assignment. If negative, the amount will be credited. Accepts the amount with up to two decimal spaces.

BankgiroFrom optional string

Deprecated. The payer's Bankgiro account. Used as payer number if PayerNumber has not been specified.

BankgiroTo mandatory string

The account to which the payment should be made.

PayDate mandatory datetime

The date when first payment for this assignment should be made. If is NULL the payment will be carried out as soon as possible (only allowed if PaymentInterval is set to "ONCE").

PayerNumber mandatory string

The payer number to use. Can contain at most 16 digits.

PaymentCount mandatory int

Number of times payment should be carried out until the assignment expires. If value is omitted or NULL, the assignment will run indefinitely.

PaymentInterval mandatory string

Interval between payments.

Possible value	Description
FULLYEAR	Transaction occurs yearly.
HALFYEAR	Transaction occurs every half year.
MONTH	Transaction occurs monthly.
ONCE	Transaction occurs only once.
QUARTER	Transaction occurs quarterly.

Reference mandatory string

OCR No, Invoice No. or similar. Maximum length 16 characters.

SSNO optional string

Deprecated. The payer's social security number. Formatted as YYYYMMDDXXXX. Used as payer number if PayerNumber has not been specified.

SQL Call: Withdraw autogiro assignments (AGBETMAK) [To Bankgirot]

Is used to send AGBETMAK files to Bankgirot. SQL returning identification info for assignment to be withdrawn. Withdrawal will be effective for all assigments corresponding to a combination of payer number and BankgiroTo number. Only revokes the assignments from AGBETUND, not the admission through AGMEDGIVREG.

The following combinations are available for cancellations:
PayerNumber
The above + DueDate
The above + Amount
The above + Reference

The following combinations are available for amendments:
NewDueDate
The above + DueDate
The above + PayerNumber
The above + Amount
The above + Reference

Recurring payments can not be amended.

May modify database: No

Parameters

@Action string

Set to 'AGBETMAK' for this call.

@BatchId string

Passes the current batchid.

Resultset: Withdraw assignments

Resultset with one row for every combination of Bankgiro number and payer SSNO whose assignments should be withdrawn.

Table count: repeated exactly once

Row count: one or more rows

Columns

Amount optional decimal

The cancellation/amendment only applies to payments with this amount.

BankgiroFrom optional string

Deprecated. The payer's Bankgiro account. Used as payer number if PayerNumber has not been specified.

BankgiroTo mandatory string

The account to which the payment should be made.

DueDate optional date

The cancellation/amendment only applies to payments with this due date.

NewDueDate optional date

Indicates that this is an amendment instead of a cancellation, and that the due date should be changed to this due date.

PayerNumber mandatory string

The payer number to use. Can contain at most 16 digits.

Reference optional string

The cancellation/amendment only applies to payments with this reference.

SSNO optional string

Deprecated. The payer's social security number. Formatted as YYYYMMDDXXXX. Used as payer number if PayerNumber has not been specified.

SQL Call: Validate parameters

Allows you to validate the parameters supplied by the user before any other SQL is run in the component. This call is only made if the component has visible parameters, the SQL is a stored procedure, and Validate parameters is checked.

May modify database: No

Parameters

@Force bit

Set to 1 if the last call to validate parameters used admin_force and the user clicked OK in the OK/Cancel dialog.

@ValidateParams bit

Set to 1 when this call is made.

Resultset: Messages (optional)

Table count: repeated zero or one time

Row count: zero or one row

Columns

ADMIN_Force optional string

Message asking the end user to confirm their parameters.

ADMIN_Message optional string

Message explaining why the parameters are rejected.

Custom access control and logging

SQL Call: Custom access control and logging

Use this call to restrict which entries a user is allowed to view and edit, and to log which entries a user views.

Access to a menu item is normally controlled through functions and roles alone but some entities need more fine grained control. For example, a user may have access to the View Member menu item for normal members but not for members with a protected identity.

The menu items a user visits are always logged (in ADMINLogMenuItem) but for sensitive data you may need to log exactly what entries are viewed. Do the logging in this call as the common ways of viewing data (grid and InfoSQL) are not allowed to modify the database.

If you bind a scalar function instead of a stored procedure to this call then its name must end with '_GrantAccess'.

May modify database: Yes

Resultset: Access permissions

Return whether the user is allowed to visit the menu item with the current parameters.

Table count: repeated exactly once

Row count: exactly one row

Columns

GrantAccess mandatory bit

1 if the user is allowed to view the menu item, 0 if the user should not be allowed to view the menu item.

If 0 then an error will be logged as the user should not have been able to reach the menu item with the given parameters in the first place.

Querystring parameters

menuitemheading optional

String that replaces the menu item name when the menu item is loaded. It does not replace the name before that (like for example in the navigator). It is ignored if the menu item is displayed as a part in a multipart in which case the name can be set from the multipart procedure.