Payment agreement

This table contains information about payment agreements.

PropertyValueDescription
DatabaseCompanyThis table is in the company databases.
SQL namePmtAgrThe table name in the database.
API identifierpaymentAgreementThe API identifier used in GraphQL.
Table no.354The table number in the data model.

The following fields exist in this table:

Aggregated amount

Is updated with the agreed amount that was deducted.

When a payee receives return files with processed and/or rejected deductions all entries where the deduction is made are imported and processed in the same way as an normal payment (OCR). A batch is created for the payment agreements and if they are found from the CID definition, the appropriate row in the Payment agreement table is updated. The Last paid amount field is set as the amount that was deducted, the Aggregated amount field is updated with the amount that was deducted and the Text code field is set as the number of times remaining for making a deduction.

PropertyValueDescription
Visible by defaultYesThis field is visible by default in the table display.
DomainAmountDecimal
SQL nameAccAmThe database field name.
API identifieraggregatedAmountThe API identifier used in GraphQL.
Number14875 

Agreed amount

Is used to enter the amount that will be deducted per period type.

Remember that the agreed amount should be inclusive of VAT.

PropertyValueDescription
Visible by defaultYesThis field is visible by default in the table display.
DomainAmountDecimal
SQL nameAgrAmThe database field name.
API identifieragreedAmountThe API identifier used in GraphQL.
Number14873 

Agreement date

Is set as the date of the deduction if it does not have a value.

It is moved to the next valid date if this is sooner than the date of the deduction.

The date is validated using the regional settings in Windows.

PropertyValueDescription
Visible by defaultYesThis field is visible by default in the table display.
DomainDateInteger
SQL nameDueDtThe database field name.
API identifieragreementDateThe API identifier used in GraphQL.
Number14879 

Agreement ID

The payee receives a file with new payment agreements that the payer himself has initiated via the Internet.

The file is read by some EFT systems and if the customer exists in the Associate table, a row is created in the Payment agreement table with the correct factoring number in relation to the one in the Factoring company table, with the correct customer number. In addition, the Registration type field is set as New agreement, and in the Agreement ID field a unique ID is created for the payment agreement. If the customer does not exist the entries appear in the error list.

PropertyValueDescription
Visible by defaultYesThis field is visible by default in the table display.
DomainString of length 20Text (20)
SQL nameAgrIdThe database field name.
API identifieragreementIdThe API identifier used in GraphQL.
Number14870 

Cust. no.

A unique number identifying the customer.

Note:
If you double-click or press * in this field, you can look up a value in the related table.
PropertyValueDescription
Visible by defaultYesThis field is visible by default in the table display.
DomainCust. no.Integer
SQL nameCustNoThe database field name.
API identifiercustomerNoThe API identifier used in GraphQL.
Number14867 
Table 1. Table relations
To tablePurposeFrom columnsTo columnsComments
AssociateCustomer
  • Cust. no.

Fact. company no./CID-def.

Is used to enter the Factoring ID which is in the Factoring company table.

Note:
If you double-click or press * in this field, you can look up a value in the related table.
PropertyValueDescription
Visible by defaultYesThis field is visible by default in the table display.
DomainFactoring no.Integer
SQL nameFCNoThe database field name.
API identifierfactoringCompanyNoThe API identifier used in GraphQL.
Number14866 
Table 2. Table relations
To tablePurposeFrom columnsTo columnsComments
Factoring companyFactoringCompany
  • Fact. company no./CID-def.

Info 1

Additional payment agreement information.

It contains messages for users about errors when sending payment agreements and/or information from the bank when importing payment agreements.

Information when receiving payment agreement.

PropertyValueDescription
Visible by defaultYesThis field is visible by default in the table display.
DomainString of length 60Text (60)
SQL namePayerInfThe database field name.
API identifierinformation1The API identifier used in GraphQL.
Number14881 

Info 2

Additional payment agreement information.

It contains messages for users about errors when sending payment agreements and/or information from the bank when importing payment agreements.

Information when receiving payment agreement.

PropertyValueDescription
Visible by defaultYesThis field is visible by default in the table display.
DomainString of length 60Text (60)
SQL nameDescrThe database field name.
API identifierinformation2The API identifier used in GraphQL.
Number14882 

Last paid amount

Is updated with the amount that was deducted.

When a payee receives return files with processed and/or rejected deductions all entries where the deduction is made are imported and processed in the same way as an normal payment. A batch is created for the entries and if the entries are found from the CID definition, the appropriate row in the Payment agreement table is updated. The Last paid amount field is set as the amount that was deducted, the Aggregated amount field is updated with the amount that was deducted and the Text code field is set as the number of times remaining for making a deduction.

PropertyValueDescription
Visible by defaultYesThis field is visible by default in the table display.
DomainAmountDecimal
SQL nameLstChrAmThe database field name.
API identifierlastRemittedAmountThe API identifier used in GraphQL.
Number14874 

Last run no.

Shows how many payment agreements that have been uploaded on this day.

The Last run no. field is automatically updated by the system.

PropertyValueDescription
Visible by defaultYesThis field is visible by default in the table display.
DomainNo.Integer
SQL nameLstRunNoThe database field name.
API identifierlastRunNoThe API identifier used in GraphQL.
Number14884 

Last voucher no.

Is updated when you generate deductions files and shows the voucher number for the last run.

PropertyValueDescription
Visible by defaultYesThis field is visible by default in the table display.
DomainNo.Integer
SQL nameLstVoNoThe database field name.
API identifierlastVoucherNoThe API identifier used in GraphQL.
Number14885 

Line no.

Note:
If you press + in this field, the next available number is suggested. Gaps in the number series resulting from any deleted rows are not suggested. If you enter an existing number you will receive an error message. The number cannot be changed once it is entered.
PropertyValueDescription
Visible by defaultYesThis field is visible by default in the table display.
DomainNo.Integer
Primary keyYesLine no.
SQL nameLnNoThe database field name.
API identifierlineNoThe API identifier used in GraphQL.
Number14865 

Payment code

Create payment codes in the Text code table.

Deductions, changing and shredding of deductions

For payment agreements that are OK and where the payees now wish to send deductions files, this is done by setting the correct value in the Registration type field for the relevant customer/agreement line in the payment agreements, and by completing the necessary fields for Agreed amount, Payment date, Period type, Payment term type, Text code and Reference (if the reference should have a fixed value). If the Reference field is not to have a fixed value, the Factoring CID-def. field in the correct row in the Factoring company table is inserted.

Payment code, payment agreements texts for different languages can be defined in the Text table. These texts has text type 186.
Note:
If you double-click or press * in this field, you can look up a Payment code, payment agreements in the Text table.
PropertyValueDescription
Visible by defaultYesThis field is visible by default in the table display.
DomainPayment code, payment agreementsInteger
SQL namePmtCdThe database field name.
API identifierpaymentCodeThe API identifier used in GraphQL.
Number14868 

Payment date

Is set at today's date if not set.

The date is validated using the regional settings in Windows.

PropertyValueDescription
Visible by defaultYesThis field is visible by default in the table display.
DomainDateInteger
SQL nameChrDtThe database field name.
API identifierremittanceDateThe API identifier used in GraphQL.
Number14878 

Payment term type

Enter the due date for the payment agreement.

A look-up in this field gives you the following list of possible values:
0 - On due date
1 - First banking day in period
Applies to self-renewing tasks.
2 - Last banking day in period
Applies to self-renewing tasks.
PropertyValueDescription
Visible by defaultYesThis field is visible by default in the table display.
DomainPayment term typeInteger
SQL nameDueTpThe database field name.
API identifierpaymentTermTypeThe API identifier used in GraphQL.
Number14872 

Period type

Enter when the payment agreement is to be carried out.

A look-up in this field gives you the following list of possible values:
0 - Once, on due date
1 - Daily
2 - Weekly
3 - Monthly
4 - Quarterly
5 - Bi-annually
6 - Yearly
PropertyValueDescription
Visible by defaultYesThis field is visible by default in the table display.
DomainPeriod typeInteger
SQL namePerTpThe database field name.
API identifierperiodeTypeThe API identifier used in GraphQL.
Number14871 

Prev. payer no.

Is automatically assigned the next available line number when a payment agreement is created.

PropertyValueDescription
Visible by defaultNoThis field is not visible by default in the table display.
DomainString of length 18Text (18)
SQL namePrevPNoThe database field name.
API identifierpreviousPayerNoThe API identifier used in GraphQL.
Number16423 

Reference

Fixed CID, CID is generated if this is not filled in based on company data.

PropertyValueDescription
Visible by defaultYesThis field is visible by default in the table display.
DomainString of length 30Text (30)
SQL nameRefCIDThe database field name.
API identifierreferenceThe API identifier used in GraphQL.
Number14883 

Registration type

Choose if you want to approve or reject the new payment agreement. Select the correct status.

Lookup is made against Registration type, payment agreements.

Registration type, payment agreements texts for different languages can be defined in the Text table. These texts has text type 187.
Note:
If you double-click or press * in this field, you can look up a Registration type, payment agreements in the Text table.
PropertyValueDescription
Visible by defaultYesThis field is visible by default in the table display.
DomainRegistration type, payment agreementsInteger
SQL nameRegTpThe database field name.
API identifierregistrationTypeThe API identifier used in GraphQL.
Number14869 

Text code

Refers to Text table.

Comment code, payment agreements texts for different languages can be defined in the Text table. These texts has text type 188.
Note:
If you double-click or press * in this field, you can look up a Comment code, payment agreements in the Text table.
PropertyValueDescription
Visible by defaultYesThis field is visible by default in the table display.
DomainComment code, payment agreementsInteger
SQL nameComCdThe database field name.
API identifiertextCodeThe API identifier used in GraphQL.
Number14880 

Valid from date

Is set at today's date if it is not filled in.

The date is validated using the regional settings in Windows.

PropertyValueDescription
Visible by defaultYesThis field is visible by default in the table display.
DomainDateInteger
SQL nameValFrDtThe database field name.
API identifiervalidFromDateThe API identifier used in GraphQL.
Number14876 

Valid to date

Is set at infinite if it is not filled in.

The date is validated using the regional settings in Windows.

PropertyValueDescription
Visible by defaultYesThis field is visible by default in the table display.
DomainDateInteger
SQL nameValToDtThe database field name.
API identifiervalidToDateThe API identifier used in GraphQL.
Number14877 

Control columns

Control columns include information about who has changed the record last and when, and which process that is currently editing the record.

Changed by provenance

The provenance for the record change.

A look-up in this field gives you the following list of possible values:

0 - None

1 - UI

10 - External API

20 - GAiA

21 - AI Connect

100 - Internal service

101 - Task automation

102 - AutoInvoice download

PropertyValueDescription
Visible by defaultNoThis field is not visible by default in the table display.
DomainProvenanceInteger
Write AccessNoneYou are not allowed to modify the value in this field.
SQL nameChPvnThe database field name.
API identifierchangedByProvenanceThe API identifier used in GraphQL.
NumberA unique column number. 

Changed by user

The name of the user that changed the record.

PropertyValueDescription
Visible by defaultNoThis field is not visible by default in the table display.
DomainUser nameText (24)
Write AccessNoneYou are not allowed to modify the value in this field.
SQL nameChUsrThe database field name.
API identifierchangedByUserThe API identifier used in GraphQL.
NumberA unique column number. 

Changed date

The date when the record was changed.

PropertyValueDescription
Visible by defaultNoThis field is not visible by default in the table display.
DomainDateInteger
Write AccessNoneYou are not allowed to modify the value in this field.
SQL nameChDtThe database field name.
API identifierchangedDateThe API identifier used in GraphQL.
NumberA unique column number. 

Changed time

The time when the record was changed.

PropertyValueDescription
Visible by defaultNoThis field is not visible by default in the table display.
DomainTimeInteger
Write AccessNoneYou are not allowed to modify the value in this field.
SQL nameChTmThe database field name.
API identifierchangedTimeThe API identifier used in GraphQL.
NumberA unique column number. 

Changed time stamp

The date and time when the record was changed.

The field is updated with the UTC time.

This value can be used by external systems to replicate changed data. The column is indexed. 

PropertyValueDescription
Visible by defaultNoThis field is not visible by default in the table display.
DomainDate/timeDateTime
Write AccessNoneYou are not allowed to modify the value in this field.
SQL nameChTsThe database field name.
API identifierchangedTimestampThe API identifier used in GraphQL.
NumberA unique column number. 

Created by provenance

The provenance for the record creation.

A look-up in this field gives you the following list of possible values:

0 - None

1 - UI

10 - External API

20 - GAiA

21 - AI Connect

100 - Internal service

101 - Task automation

102 - AutoInvoice download

PropertyValueDescription
Visible by defaultNoThis field is not visible by default in the table display.
DomainProvenanceInteger
Write AccessNoneYou are not allowed to modify the value in this field.
SQL nameCrePvnThe database field name.
API identifiercreatedByProvenanceThe API identifier used in GraphQL.
NumberA unique column number. 

Created by user

The name of the user that created the record.

PropertyValueDescription
Visible by defaultNoThis field is not visible by default in the table display.
DomainUser nameText (24)
Write AccessNoneYou are not allowed to modify the value in this field.
SQL nameCreUsrThe database field name.
API identifiercreatedByUserThe API identifier used in GraphQL.
NumberA unique column number. 

Created date

The date when the record was created.

PropertyValueDescription
Visible by defaultNoThis field is not visible by default in the table display.
DomainDateInteger
Write AccessNoneYou are not allowed to modify the value in this field.
SQL nameCreDtThe database field name.
API identifiercreatedDateThe API identifier used in GraphQL.
NumberA unique column number. 

Created time

The time when the record was created.

PropertyValueDescription
Visible by defaultNoThis field is not visible by default in the table display.
DomainTimeInteger
Write AccessNoneYou are not allowed to modify the value in this field.
SQL nameCreTmThe database field name.
API identifiercreatedTimeThe API identifier used in GraphQL.
NumberA unique column number. 

Created time stamp

The date and time when the record was created.

The field is updated with the UTC time.

PropertyValueDescription
Visible by defaultNoThis field is not visible by default in the table display.
DomainDate/timeDateTime
Write AccessNoneYou are not allowed to modify the value in this field.
SQL nameCreTsThe database field name.
API identifiercreatedTimestampThe API identifier used in GraphQL.
NumberA unique column number. 

Edit status

The current status of the record.

A look-up in this field gives you the following list of possible values:

0 - Unchanged: The record is read, but not changed.

1 - Inserted: The record is new.

2 - Changed: The record is changed.

3 - Deleted: The record is deleted.

PropertyValueDescription
Visible by defaultNoThis field is not visible by default in the table display.
DomainEdit statusInteger
Write AccessNoneYou are not allowed to modify the value in this field.
SQL nameLckStThe database field name.
API identifiereditStatusThe API identifier used in GraphQL.
NumberA unique column number. 

Process no

The Process no. from the Active company process table which is currently using or has control of this record.

Note:
If you double-click or press * in this field, you can look up a value in the related table.
PropertyValueDescription
Visible by defaultNoThis field is not visible by default in the table display.
DomainProcess no.Integer
Write AccessNoneYou are not allowed to modify the value in this field.
SQL nameChPrcThe database field name.
API identifierlockedByProcessNoThe API identifier used in GraphQL.
NumberA unique column number. 
Table 3. Table relations
To table Purpose From columns To columns Comments
Active company process CompanyProcess Process no. Process no.