Payment agreement
This table contains information about payment agreements.
| Property | Value | Description |
|---|---|---|
| Database | Company | This table is in the company databases. |
| SQL name | PmtAgr | The table name in the database. |
| API identifier | paymentAgreement | The API identifier used in GraphQL. |
| Table no. | 354 | The 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.
| Property | Value | Description |
|---|---|---|
| Visible by default | Yes | This field is visible by default in the table display. |
| Domain | Amount | Decimal |
| SQL name | AccAm | The database field name. |
| API identifier | aggregatedAmount | The API identifier used in GraphQL. |
| Number | 14875 |
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.
| Property | Value | Description |
|---|---|---|
| Visible by default | Yes | This field is visible by default in the table display. |
| Domain | Amount | Decimal |
| SQL name | AgrAm | The database field name. |
| API identifier | agreedAmount | The API identifier used in GraphQL. |
| Number | 14873 |
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.
| Property | Value | Description |
|---|---|---|
| Visible by default | Yes | This field is visible by default in the table display. |
| Domain | Date | Integer |
| SQL name | DueDt | The database field name. |
| API identifier | agreementDate | The API identifier used in GraphQL. |
| Number | 14879 |
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.
| Property | Value | Description |
|---|---|---|
| Visible by default | Yes | This field is visible by default in the table display. |
| Domain | String of length 20 | Text (20) |
| SQL name | AgrId | The database field name. |
| API identifier | agreementId | The API identifier used in GraphQL. |
| Number | 14870 |
Cust. no.
A unique number identifying the customer.
| Property | Value | Description |
|---|---|---|
| Visible by default | Yes | This field is visible by default in the table display. |
| Domain | Cust. no. | Integer |
| SQL name | CustNo | The database field name. |
| API identifier | customerNo | The API identifier used in GraphQL. |
| Number | 14867 |
| To table | Purpose | From columns | To columns | Comments |
|---|---|---|---|---|
| Associate | Customer |
|
Fact. company no./CID-def.
Is used to enter the Factoring ID which is in the Factoring company table.
| Property | Value | Description |
|---|---|---|
| Visible by default | Yes | This field is visible by default in the table display. |
| Domain | Factoring no. | Integer |
| SQL name | FCNo | The database field name. |
| API identifier | factoringCompanyNo | The API identifier used in GraphQL. |
| Number | 14866 |
| To table | Purpose | From columns | To columns | Comments |
|---|---|---|---|---|
| Factoring company | FactoringCompany |
|
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.
| Property | Value | Description |
|---|---|---|
| Visible by default | Yes | This field is visible by default in the table display. |
| Domain | String of length 60 | Text (60) |
| SQL name | PayerInf | The database field name. |
| API identifier | information1 | The API identifier used in GraphQL. |
| Number | 14881 |
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.
| Property | Value | Description |
|---|---|---|
| Visible by default | Yes | This field is visible by default in the table display. |
| Domain | String of length 60 | Text (60) |
| SQL name | Descr | The database field name. |
| API identifier | information2 | The API identifier used in GraphQL. |
| Number | 14882 |
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.
| Property | Value | Description |
|---|---|---|
| Visible by default | Yes | This field is visible by default in the table display. |
| Domain | Amount | Decimal |
| SQL name | LstChrAm | The database field name. |
| API identifier | lastRemittedAmount | The API identifier used in GraphQL. |
| Number | 14874 |
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.
| Property | Value | Description |
|---|---|---|
| Visible by default | Yes | This field is visible by default in the table display. |
| Domain | No. | Integer |
| SQL name | LstRunNo | The database field name. |
| API identifier | lastRunNo | The API identifier used in GraphQL. |
| Number | 14884 |
Last voucher no.
Is updated when you generate deductions files and shows the voucher number for the last run.
| Property | Value | Description |
|---|---|---|
| Visible by default | Yes | This field is visible by default in the table display. |
| Domain | No. | Integer |
| SQL name | LstVoNo | The database field name. |
| API identifier | lastVoucherNo | The API identifier used in GraphQL. |
| Number | 14885 |
Line no.
| Property | Value | Description |
|---|---|---|
| Visible by default | Yes | This field is visible by default in the table display. |
| Domain | No. | Integer |
| Primary key | Yes | Line no. |
| SQL name | LnNo | The database field name. |
| API identifier | lineNo | The API identifier used in GraphQL. |
| Number | 14865 |
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.
| Property | Value | Description |
|---|---|---|
| Visible by default | Yes | This field is visible by default in the table display. |
| Domain | Payment code, payment agreements | Integer |
| SQL name | PmtCd | The database field name. |
| API identifier | paymentCode | The API identifier used in GraphQL. |
| Number | 14868 |
Payment date
Is set at today's date if not set.
The date is validated using the regional settings in Windows.
| Property | Value | Description |
|---|---|---|
| Visible by default | Yes | This field is visible by default in the table display. |
| Domain | Date | Integer |
| SQL name | ChrDt | The database field name. |
| API identifier | remittanceDate | The API identifier used in GraphQL. |
| Number | 14878 |
Payment term type
Enter the due date for the payment agreement.
- 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.
| Property | Value | Description |
|---|---|---|
| Visible by default | Yes | This field is visible by default in the table display. |
| Domain | Payment term type | Integer |
| SQL name | DueTp | The database field name. |
| API identifier | paymentTermType | The API identifier used in GraphQL. |
| Number | 14872 |
Period type
Enter when the payment agreement is to be carried out.
- 0 - Once, on due date
- 1 - Daily
- 2 - Weekly
- 3 - Monthly
- 4 - Quarterly
- 5 - Bi-annually
- 6 - Yearly
| Property | Value | Description |
|---|---|---|
| Visible by default | Yes | This field is visible by default in the table display. |
| Domain | Period type | Integer |
| SQL name | PerTp | The database field name. |
| API identifier | periodeType | The API identifier used in GraphQL. |
| Number | 14871 |
Prev. payer no.
Is automatically assigned the next available line number when a payment agreement is created.
| Property | Value | Description |
|---|---|---|
| Visible by default | No | This field is not visible by default in the table display. |
| Domain | String of length 18 | Text (18) |
| SQL name | PrevPNo | The database field name. |
| API identifier | previousPayerNo | The API identifier used in GraphQL. |
| Number | 16423 |
Reference
Fixed CID, CID is generated if this is not filled in based on company data.
| Property | Value | Description |
|---|---|---|
| Visible by default | Yes | This field is visible by default in the table display. |
| Domain | String of length 30 | Text (30) |
| SQL name | RefCID | The database field name. |
| API identifier | reference | The API identifier used in GraphQL. |
| Number | 14883 |
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.
| Property | Value | Description |
|---|---|---|
| Visible by default | Yes | This field is visible by default in the table display. |
| Domain | Registration type, payment agreements | Integer |
| SQL name | RegTp | The database field name. |
| API identifier | registrationType | The API identifier used in GraphQL. |
| Number | 14869 |
Text code
Refers to Text table.
| Property | Value | Description |
|---|---|---|
| Visible by default | Yes | This field is visible by default in the table display. |
| Domain | Comment code, payment agreements | Integer |
| SQL name | ComCd | The database field name. |
| API identifier | textCode | The API identifier used in GraphQL. |
| Number | 14880 |
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.
| Property | Value | Description |
|---|---|---|
| Visible by default | Yes | This field is visible by default in the table display. |
| Domain | Date | Integer |
| SQL name | ValFrDt | The database field name. |
| API identifier | validFromDate | The API identifier used in GraphQL. |
| Number | 14876 |
Valid to date
Is set at infinite if it is not filled in.
The date is validated using the regional settings in Windows.
| Property | Value | Description |
|---|---|---|
| Visible by default | Yes | This field is visible by default in the table display. |
| Domain | Date | Integer |
| SQL name | ValToDt | The database field name. |
| API identifier | validToDate | The API identifier used in GraphQL. |
| Number | 14877 |
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
| Property | Value | Description |
|---|---|---|
| Visible by default | No | This field is not visible by default in the table display. |
| Domain | Provenance | Integer |
| Write Access | None | You are not allowed to modify the value in this field. |
| SQL name | ChPvn | The database field name. |
| API identifier | changedByProvenance | The API identifier used in GraphQL. |
| Number | A unique column number. |
Changed by user
The name of the user that changed the record.
| Property | Value | Description |
|---|---|---|
| Visible by default | No | This field is not visible by default in the table display. |
| Domain | User name | Text (24) |
| Write Access | None | You are not allowed to modify the value in this field. |
| SQL name | ChUsr | The database field name. |
| API identifier | changedByUser | The API identifier used in GraphQL. |
| Number | A unique column number. |
Changed date
The date when the record was changed.
| Property | Value | Description |
|---|---|---|
| Visible by default | No | This field is not visible by default in the table display. |
| Domain | Date | Integer |
| Write Access | None | You are not allowed to modify the value in this field. |
| SQL name | ChDt | The database field name. |
| API identifier | changedDate | The API identifier used in GraphQL. |
| Number | A unique column number. |
Changed time
The time when the record was changed.
| Property | Value | Description |
|---|---|---|
| Visible by default | No | This field is not visible by default in the table display. |
| Domain | Time | Integer |
| Write Access | None | You are not allowed to modify the value in this field. |
| SQL name | ChTm | The database field name. |
| API identifier | changedTime | The API identifier used in GraphQL. |
| Number | A 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.
| Property | Value | Description |
|---|---|---|
| Visible by default | No | This field is not visible by default in the table display. |
| Domain | Date/time | DateTime |
| Write Access | None | You are not allowed to modify the value in this field. |
| SQL name | ChTs | The database field name. |
| API identifier | changedTimestamp | The API identifier used in GraphQL. |
| Number | A 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
| Property | Value | Description |
|---|---|---|
| Visible by default | No | This field is not visible by default in the table display. |
| Domain | Provenance | Integer |
| Write Access | None | You are not allowed to modify the value in this field. |
| SQL name | CrePvn | The database field name. |
| API identifier | createdByProvenance | The API identifier used in GraphQL. |
| Number | A unique column number. |
Created by user
The name of the user that created the record.
| Property | Value | Description |
|---|---|---|
| Visible by default | No | This field is not visible by default in the table display. |
| Domain | User name | Text (24) |
| Write Access | None | You are not allowed to modify the value in this field. |
| SQL name | CreUsr | The database field name. |
| API identifier | createdByUser | The API identifier used in GraphQL. |
| Number | A unique column number. |
Created date
The date when the record was created.
| Property | Value | Description |
|---|---|---|
| Visible by default | No | This field is not visible by default in the table display. |
| Domain | Date | Integer |
| Write Access | None | You are not allowed to modify the value in this field. |
| SQL name | CreDt | The database field name. |
| API identifier | createdDate | The API identifier used in GraphQL. |
| Number | A unique column number. |
Created time
The time when the record was created.
| Property | Value | Description |
|---|---|---|
| Visible by default | No | This field is not visible by default in the table display. |
| Domain | Time | Integer |
| Write Access | None | You are not allowed to modify the value in this field. |
| SQL name | CreTm | The database field name. |
| API identifier | createdTime | The API identifier used in GraphQL. |
| Number | A unique column number. |
Created time stamp
The date and time when the record was created.
The field is updated with the UTC time.
| Property | Value | Description |
|---|---|---|
| Visible by default | No | This field is not visible by default in the table display. |
| Domain | Date/time | DateTime |
| Write Access | None | You are not allowed to modify the value in this field. |
| SQL name | CreTs | The database field name. |
| API identifier | createdTimestamp | The API identifier used in GraphQL. |
| Number | A 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.
| Property | Value | Description |
|---|---|---|
| Visible by default | No | This field is not visible by default in the table display. |
| Domain | Edit status | Integer |
| Write Access | None | You are not allowed to modify the value in this field. |
| SQL name | LckSt | The database field name. |
| API identifier | editStatus | The API identifier used in GraphQL. |
| Number | A unique column number. |
Process no
The Process no. from the Active company process table which is currently using or has control of this record.
| Property | Value | Description |
|---|---|---|
| Visible by default | No | This field is not visible by default in the table display. |
| Domain | Process no. | Integer |
| Write Access | None | You are not allowed to modify the value in this field. |
| SQL name | ChPrc | The database field name. |
| API identifier | lockedByProcessNo | The API identifier used in GraphQL. |
| Number | A unique column number. |
| To table | Purpose | From columns | To columns | Comments |
|---|---|---|---|---|
| Active company process | CompanyProcess | Process no. | Process no. |