1. U4 ERPx
  2. API Reference
  3. Accounting
  4. Financial Transactions

Financial Transactions

Financial Transactions API Reference This page provides a comprehensive reference for all parameters, endpoints, and behaviors of the Financial Transactions API. Use this guide to understand request/response structures, validation rules, and integration best practices.

Purpose:
The Financial Transactions API manages individual financial transactions within ERPx. It is suited for transaction-based integrations where users expect either immediate validation errors or direct confirmation that posting was successful. For high-volume imports or multiple transactions, use the Financial Transactions Batch API instead.

Base URL:
/v1/financial-transactions

Authentication:
All APIs require a Client ID and Client Secret.
Refer to the global authentication documentation for details.

Supported Methods

HTTP MethodEndpointDescriptionLimits & Notes
POST/v1/financial-transactionsCreates a financial transaction based on a sent object.Supports treatment codes 2, 4, and 5.
Only 1 transaction per call.
Max 500 transaction details (hard limit).
POST/v1/financial-transactions-validateValidates creation of a financial transaction without posting.Supports treatment codes 2, 4, and 5.
Only 1 transaction per call.
Max 500 transaction details (hard limit).
GET/v1/financial-transactions/account/
{companyId}/{account}/{period}
Checks whether an account can be posted for a specific company and periodUse as a pre-validation step before posting
or registering transactions.
GET/v1/registered-financial-transactions/
{transactionNumber}
Gets a registered financial transaction based on provided companyId and transaction numberUse to inquire about registered financial transactions not yet posted.
GET/v1/objects/financial-transactionsGets registered financial transactions that have not been posted yet.For more information, refer to Ontology.
GET /v2/objects/general-ledger-transactionsGets financial transactions that have already been posted.This endpoint supports standard query operations.
For complete details on filtering, sorting, pagination and other query capabilities, refer to the Object API section.

   

Swagger / Schema

Version v1

Version v2

Version v1

   

Method Details

Sample Request

{
  "companyId": "EN",
  "period": 202602,
  "transactionDate": "2026-02-17",
  "transactionType": "IO",
  "externalReference": "Trans NNN from external system YYY",
  "invoice": {
    "invoiceNumber": "Inv001",
    "supplierId": "1000",
    "dueDate": "2026-03-19T13:25:36.524Z",
    "discountDate": "2026-02-27T13:25:36.524Z",
    "discountPercentage": 1.00,
    "discountCurrencyAmount": 1.23,
    "paymentMethod": "CH",
    "paymentCurrency": "GBP",
    "creditTerms": "32"
  },
  "details": [
    {
      "accountingInformation": {
        "account": "2010",
        "analyticalInformation": [
          {
            "id": "C1",
            "value": "110"
          }
        ]
      },
      "description": "Supplier transaction",
      "valueDate": "2026-02-17",
      "amounts": {
        "currencyAmount": -123.00,
        "currencyCode": "GBP"
      }
    },
    {
      "accountingInformation": {
        "account": "4010",
        "analyticalInformation": [
          {
            "id": "C1",
            "value": "120"
          }
        ]
      },
      "description": "Supplier transaction",
      "valueDate": "2026-02-17",
      "amounts": {
        "currencyAmount": 100,
        "currencyCode": "GBP"
      },
      "taxInformation": {
        "taxCode": "1N"
      }
    }
  ]
}
The example above posts a supplier invoice including the currencyAmount, a single posting dimension and taxCode on the cost account. Note that the API logic will autocomplete some invoice properties and posting dimensions when they are not provided in the request; amount, amount3, amount4, and taxes are calculated.

   

Default Values

Acrtrans fields autocompletion

The following fields in the arctrans table will be auto-completed by the API:

*** The value used for a client will always be the value set in the companyId

  • account: This field is auto-completed as follows:

    1. When the supplierId is provided and Line Type AP is provided but account is empty, account is auto-completed with the account assigned to Supplier Group for given Supplier.

    2. When the customerId is provided and Line Type AR is provided but account is empty, account is auto-completed with the account assigned to Customer Group for given Customer.

    3. Account for GL line is never autocompleted and needs to be provided.

  • apar_id: If a PaymentInformation Data Transfer Object (DTO) is provided, the value for this field is taken from the transaction line referred to by the parameters within Payment Information (Customer or Supplier ID).

  • apar_name: This field is auto-completed with a Supplier name from the Supplier master file.

  • apar_type: The value for this field depends on the information provided in the JSON format.

    1. If Invoice DTO information is provided, it will be: a. ‘P’ when the supplierId is provided.
      b. ‘R’ when the customerId is provided.
    2. If a PaymentInformation Data Transfer Object (DTO) is provided, it will be: a. ‘P’ when the transaction line referred to by the parameters within Payment Information is related to a Supplier.
      b. ‘R’ when the transaction line referred to by the parameters within Payment Information is related to a Customer.
  • arrival_date: If no value is set for it, this field will be auto-completed with the UpdatedAt value and then converted to Time Zone which is set in Company Information.

  • arrive_id: If no value is set for it, this field will be auto-completed with the Transaction Number value. However, in case of Registration of GL transactions, this auto-completion will be the standard behaviour and the field will be read-only.

  • collection: This field is auto-completed in taxes lines. The value for this field depends on the taxCode setup.

    1. Value will be 0 when Cash Principle flag is not selected.
    2. Value will be 1 when Cash Principle flag is selected.
  • ext_ref: This field is auto-completed with the externalReference value provided at the Transaction level of the JSON request. The value is populated in all rows, including generated Tax rows. This field is used to pass on external references with financial transactions posted based on integrations/interfaces from external systems.

  • factor_short: This field is auto-completed for AP/AR rows as follows (it will not be auto-completed on Secondary open items):

    1. When the supplierId is provided, factor_short is auto-completed with the payment recipient assigned to the supplier in the Supplier master file.

    2. When the customerId is provided, factor_short is auto-completed with the payment recipient assigned to the customer in the Customer master file.

  • fiscal_year: The fiscal_year for the selected acc_period and period_id = GL, extracted from the acrperiod table.

  • last_update: Date on which the API was called

  • line_type: If no value is set for it, this field will be auto-completed based on account.

  • pay_currency: This field is auto-completed as follows:

    1. When the supplierId is provided, pay_currency is auto-completed with the same value as currency on AP line.

    2. When the customerId is provided, pay_currency is auto-completed with the same value as currency on AR line.

  • pay_flag: The value for this field depends on the information in each Detail DTO provided in the JSON format.

    1. Value will be 0 when no PaymentInformation DTO is provided.
    2. Value will be 1 when a PaymentInformation DTO is provided.
  • pay_method: This field is auto-completed as follows:

    • For AP/AR rows:

      1. When the supplierId is provided for the invoice, pay_method is auto-completed with the payment method assigned to the supplier in the Supplier master file.

      2. When the customerId is provided for the invoice, pay_method is auto-completed with the payment method assigned to the customer in the Customer master file.

    • For secondary open item rows: When pay_method is not provided, it is auto-completed with the payment method assigned or auto-completed in the related AP row.

  • period: This field is auto-completed based on GL period assigned for given transaction date

  • reg_amount: This field is auto-completed with the cur_amount value.

  • sequence_no: This field is auto-completed following this logic:

    1. Per Header (voucher_no), a consecutive number is assigned to each Transaction Detail. The first detail of each header is assigned number 1.

    2. In SecondaryOpenItems, it takes the next value assigned to the Detail it corresponds to.

    3. In TaxInformation rows, it takes the next value assigned to the Detail it corresponds to.

    4. In TaxInformationDetail, it takes the next value assigned to the TaxInformation it corresponds to.

  • status: This field is auto-completed with the following values:

    1. In Detail rows, ‘N’ is assigned for rows where the trans_type value is AP or AR. It is left empty for rows where the trans_type value is GL.

    2. In TaxInformation rows, this field is always assigned the value ‘X’.

  • tax_seq_ref: This field is auto-completed with the following values:

    1. In Detail rows, the value is -1.

    2. In TaxInformation and TaxInformationDetail rows, this field takes the same value as the sequence_no of its parent row.

  • terms_id: This field is auto-completed as follows:

    1. When the supplierId is provided, terms_id is auto-completed with the payment term assigned to the supplier in the Supplier master file.

    2. When the customerId is provided, terms_id is auto-completed with the payment term assigned to the customer in the Customer master file.

  • trans_date: The same value as the voucher_date field

  • trans_id: If this value is provided in the PostingCycle field of the JSON format, it is directly assigned. Otherwise, the API selects one of the following values from the acrtransgr table:

    1. The oldest trans_id for the selected vouch_series (trans_type) and period with status N or P. If not found, the API selects...

    2. The trans_id for the selected vouch_series and fiscal_year. If not found, the API selects...

    3. The trans_id for the selected vouch_series and fiscal_year 0. If not found, the field is left empty.

  • trans_type: In general, this field takes the account_type for the selected account and period, extracted from the aglaccounts table. In TaxInformation rows, it takes the value ‘TX’, except when linked to an exempt-type tax system, in which case it takes the value ‘TE’.

  • user_id: User ID of the currently logged-in API user.

  • unro_amount: The same value as the amount field.

  • unro_cur_amount: The same value as the cur_amount field.

  • vat_reg_no: This field is auto-completed as follows:

    1. When supplierId is provided, vat_reg_no is auto-completed in tax lines (trans_type = TX) with the VAT registration number assigned to the supplier in the Supplier master file.

    2. When customerId is provided, vat_reg_no is auto-completed in tax lines (trans_type = TX) with the VAT registration number assigned to the customer in the Customer master file.

  • voucher_no: The next available value in counter for the selected posting cycle (trans_id), extracted from the acrperiod table.

Analytical Information

In this section, you can find how the autocomplete of Analytical Information is carried out for all the categories defined in the Account rule and not sent in the DTO.

The Analytical Information DTO, which is an array, can be completed with all the analytical details (Dimension 1 to 7 and Dimension Values 1 to 7).

The Account rule allows you to autocomplete these values in three ways:

  1. Through the value of an attribute that is also an owner of another attribute. For example, if we have an Account rule where Cost Center (Category 1) is the owner of Project (Category 2), then the value of the first attribute is completed depending on the value entered in the second attribute.
  2. Through a defined Value Matrix where one or more attributes (up to 4) can be combined to get the value of another attribute.
  3. Through a default value.

The attribute values are always auto-completed (if applicable), regardless of the values in the User input field in the Account rule window. However:

  1. If the User input value is Optional - The user can set a different value. Empty is a valid value.
  2. If the User input value is Mandatory - The user can set a different value except for Empty.
  3. If the User input value is Fixed - The user cannot set a different value.
  4. If the User input is No check - The user can send any value even though it does not exist in the database as a valid attribute value. However, the value cannot exceed the length and it must be aligned with the type (numeric/alphanumeric) of the attribute definition.

We take into account the following information in the calculations:

  • Attributes:
IDAttributeDescriptionOwnerTypeFieldLengthMaintenancePMWDATES
API2OFFICEOfficeCOMPANYAlphanumericCat412ManualX
API3BUILDINGBuildingAlphanumericCat512ManualX
C1COSTCCost centreCOSTCAlphanumericCat112ManualXXXX
B0PROJECTProject codeAlphanumericCat212AutomaticXX
NBCOMPANYInterCompany CompanyAlphanumericCat72ManualX
ZAPIOFICINILLAOficinillaPROJECTAlphanumericCat412ManualX
VR5NUMERIC TESTNumeric testNumericCat612ManualX
  • Project 1000 - Relation group:
RelationRelation valueDescriptionUnits
Cost centre (COSTC)210Direct sales
Project code (PROJECT)1000Project 1000
Project type (PRO.TYPE)RDResearch and development
Resource (RESNO)87010102Wendy jo AlthropeAmount/H
  • Attribute values - OFFICE:
Attribute valueDescriptionCompanyValuePeriod fromPeriod toStatus
BRISTOLBRISTOLEN00209999Active
LEEDSLEEDSEN00209999Active
LONDONLONDONEN00209999Active
MALMOMALMOSE00209999Active
STOCKHOLMSTOCKHOLMSE00209999Active
YORKYORKEN00209999Active
  • Attribute values - COMPANY:
Attribute valueDescriptionOwnerValuePeriod fromPeriod toStatus
ENAgresso Demo00209999Active
NOAgresso Demo AS (Norway)00209999Active
SEAgresso Demo AS (Sweden)00209999Active
  • Attribute values - COSTC:
Attribute valueDescriptionOwnerValuePeriod fromPeriod toStatus
110Management0199401209999Active
210Direct Sales00209999Active
  • Attribute values - PROJECT:
Attribute valueDescriptionCOSTCValuePeriod fromPeriod toStatus
1000Project 10002100199807209999Active
  • Attribute values - OFICINILLA:
Attribute valueDescriptionProjectValuePeriod fromPeriod toStatus
OFFICEAA100000209999Active
OFFICEBB120000209999Active
  • Attribute values - BUILDING:
Attribute valueDescriptionCompanyValuePeriod fromPeriod toStatus
ABUILDINGANO0202001202003Active
ABUILDINGAEN0202004209999Active
BBUILDINGBSE0202001209999Active
  • Chart of Accounts:
AccountDescriptionRuleGroupPeriod fromPeriod toTypeStatus
1320Ingoing VATTAXES130199401209912General LedgerActive
1330Investment DutyTAXES2130199901209912General LedgerActive
1340Base Investment DutyTAXES130199901209912General LedgerActive
2010Accounts Payable Domestic SuppliersBALANCE/FINANCE200199401209912Accounts PayableActive
6210RentRENTALCOST620200001209912General LedgerActive
6250ElectricityDEPENDENCIES620199901209912General LedgerActive
6270CleaningOFFICECOST620199901209912General LedgerActive
6290Other Costs PremisesRENTALCOSTMATRIX620199901209912General LedgerActive
7000Travel ExpensesTRAVEL EXPENSES700199401209912General LedgerActive
  • Account rule - OFFICECOST:
OFFICECOSTAttributeUser inputAuto-completionDefault valueValidation relation
AccountACCOUNT
Category 1COSTCMandatoryPROJECT100
Category 2PROJECTOptional
Category 3Fixed
Category 4OFFICEMandatoryMALMO
Category 5BUILDINGFixedB
Category 6Fixed
Category 7COMPANYFixedOFFICE
CurrencyCURRENCYMandatoryGBP
Tax codeTAXCODEOptional0
Tax systemTAXCATOptional
Factor VATFACTOR_VATOptional
  • Account rule - BALANCE/FINANCE:
BALANCE/FINANCEAttributeUser inputAuto-completionDefault valueValidation relation
AccountACCOUNT
Category 1COSTCOptional
Category 2Fixed
Category 3Fixed
Category 4Fixed
Category 5Fixed
Category 6Fixed
Category 7Fixed
CurrencyCURRENCYMandatoryGBP
Tax codeTAXCODEMandatory0
Tax systemTAXCATOptional
  • Account rule - TAXES:
TAXESAttributeUser inputAuto-completionDefault valueValidation relation
AccountACCOUNT
Category 1COSTCFixed110
Category 2Fixed
Category 3Fixed
Category 4Fixed
Category 5Fixed
Category 6Fixed
Category 7Fixed
CurrencyCURRENCYFixedGBP
Tax codeTAXCODEFixed0
Tax systemTAXCATOptional
Factor VATFACTOR_VATOptional
  • Account rule - DEPENDENCIES:
DEPENDENCIESAttributeUser inputAuto-completionDefault valueValidation relation
AccountACCOUNT
Category 1COSTCMandatoryPROJECT
Category 2PROJECTMandatoryOFICINILLA
Category 3Fixed
Category 4OFICINILLAMandatory
Category 5Fixed
Category 6Fixed
Category 7Fixed
CurrencyCURRENCYFixedGBP
Tax codeTAXCODEFixed0
Tax systemTAXCATOptional
Factor VATFACTOR_VATOptional
  • Account rule - RENTALCOST:
RENTALCOSTAttributeUser inputAuto-completionDefault valueValidation relation
AccountACCOUNT
Category 1COSTCOptionalPROJECT
Category 2PROJECTOptional1000
Category 3Fixed
Category 4Fixed
Category 5BUILDINGNo checkA
Category 6Fixed
Category 7COMPANYNo checkBUILDING
CurrencyCURRENCYMandatoryGBP
Tax codeTAXCODEOptional0
Tax systemTAXCATOptional
Factor VATFACTOR_VATOptional
  • Account rule - TAXES2:
TAXES2AttributeUser inputAuto-completionDefault valueValidation relation
AccountACCOUNT
Category 1COSTCOptional
Category 2PROJECTNo check
Category 3Fixed
Category 4Fixed
Category 5Fixed
Category 6Fixed
Category 7Fixed
CurrencyCURRENCYFixedGBP
Tax codeTAXCODEFixed0
Tax systemTAXCATOptional
Factor VATFACTOR_VATOptional
  • Account rule - RENTALCOSTMATRIX:
RENTALCOSTMATRIXAttributeUser inputAuto-completionDefault valueValidation relation
AccountACCOUNT
Category 1COSTCMandatoryCOMPLETECOSTCENTER
Category 2PROJECTOptional
Category 3Fixed
Category 4Fixed
Category 5BUILDINGOptional
Category 6Fixed
Category 7COMPANYOptional
CurrencyCURRENCYMandatoryGBP
Tax codeTAXCODEOptional0
Tax systemTAXCATOptional
Factor VATFACTOR_VATOptional
  • Account rule - TRAVEL EXPENSES:
TRAVEL EXPENSESAttributeUser inputAuto-completionDefault valueValidation relation
AccountACCOUNT
Category 1COSTCNo check
Category 2PROJECTNo check
Category 3RESNONo check
Category 4WORKORDNo check
Category 5ACTIVITYNo check
Category 6NUMERIC TESTNo check
Category 7
CurrencyCURRENCYMandatoryGBP
Tax codeTAXCODEOptional0
Tax systemTAXCATOptional
Factor VATFACTOR_VATOptional
  • Tax Code 1X:
Tax CodeAccountVAT percentageNet flagReductionNon-recoverable VAT accountDate fromDate to
1X132023True10013802000-01-012019-12-31
1X1320234013402020-01-012099-12-31
  • Value matrix - COMPLETECOSTCENTER:
Source Attribute 1Source Attribute 2Destination Attribute 1
PROJECTBUILDINGCOSTC

Matrix Rows

Project codeBUILDINGCost centre
1000A110
1000A310
1000B210

Value matrix

AttributeAttribute valueFromTo
Project code100010001000
BUILDINGBAA
Cost centreStatusPeriod fromPeriod to
110Active199901202001
310Active202002209999
AttributeAttribute valueFromTo
Project code1000100019999
BUILDINGBBB
Cost centreStatusPeriod fromPeriod to
210Active202001209999

Based on the information mentioned above, the Analytical Information will be autocompleted as the following scenarios show.

Scenario 1: Autocomplete Analytical Information in a simple AP invoice without taxes. Value for a mandatory attribute with a default value is sent in JSON.

GIVEN that a Financial Transaction needs to be posted
AND a Financial Transaction API with a POST endpoint that can autocomplete the analytical dimension where possible
AND a transaction document is sent, with the following information:

Line typeAccountIdValueIdValueAmountCurrency amount
GL6270API2LEEDSB0100010001000
AP2010-1000-1000

WHEN posted to the transaction resource in the API
THEN the transaction is posted and returns a 202 response (Accepted)
AND the Analytical Information is autocompleted as follows:

AccountAtt Id 1Att Id 2Att Id 3Att Id 4Att Id 5Att Id 6Att Id 7Dim 1Dim 2Dim 3Dim 4Dim 5Dim 6Dim 7
6270C1B0API2API3NB2101000LEEDSBEN
2010C1
Scenario 2: Autocomplete Analytical Information in a simple AP invoice without taxes. The value of a mandatory attribute with an auto-completion is sent in JSON.

GIVEN that a Financial Transaction needs to be posted
AND a Financial Transaction API with a POST endpoint that can autocomplete the analytical dimension where possible
AND a transaction document is sent, with the following information:

Line typeAccountIdValueAmountCurrency amount
GL6270C111010001000
AP2010-1000-1000

WHEN posted to the transaction resource in the API
THEN the transaction is posted and returns a 202 response (Accepted)
AND the Analytical Information is autocompleted as follows:

AccountAtt Id 1Att Id 2Att Id 3Att Id 4Att Id 5Att Id 6Att Id 7Dim 1Dim 2Dim 3Dim 4Dim 5Dim 6Dim 7
6270C1B0API2API3NB110MALMOBSE
2010C1
Scenario 3: Autocomplete Analytical Information in an AP invoice with taxes and a child GL row.

GIVEN that a Financial Transaction needs to be posted
AND a Financial Transaction API with a POST endpoint that can autocomplete the analytical dimension where possible
AND a transaction document is sent, with the following information:

Line typeAccountIdValueAmountCurrency amount
GL6270C111012301230
AP2010-1230-1230

AND tax Information is given

Tax point dateTax code
2020-04-011X

WHEN posted to the transaction resource in the API
THEN the transaction is posted and returns a 202 response (Accepted)
AND the Analytical Information is autocompleted as follows:

AccountAtt Id 1Att Id 2Att Id 3Att Id 4Att Id 5Att Id 6Att Id 7Dim 1Dim 2Dim 3Dim 4Dim 5Dim 6Dim 7
6270C1B0API2API3NB2101000MALMOBSE
1320C1110
1340C1110
2010C1
Scenario 4: Autocomplete Analytical Information in a simple AP invoice without taxes where there are dependencies between attributes in the Account rule.

GIVEN that a Financial Transaction needs to be posted
AND a Financial Transaction API with a POST endpoint that can autocomplete the analytical dimension where possible
AND a transaction document is sent, with the following information:

Line typeAccountIdValueAmountCurrency amount
GL6250ZAPIOFFICEA12301230
AP2010-1230-1230

WHEN posted to the transaction resource in the API
THEN the transaction is posted and returns a 202 response (Accepted)
AND the Analytical Information is autocompleted as follows:

AccountAtt Id 1Att Id 2Att Id 3Att Id 4Att Id 5Att Id 6Att Id 7Dim 1Dim 2Dim 3Dim 4Dim 5Dim 6Dim 7
6250C1B0ZAPI2101000OFFICEA
2010C1
Scenario 5: Autocomplete Analytical Information in a simple AP invoice without taxes where attribute values are **Optional** and **No check**. One of the attributes has been set to empty.

GIVEN that a Financial Transaction needs to be posted
AND a Financial Transaction API with a POST endpoint that can autocomplete the analytical dimension where possible
AND a transaction document is sent, with the following information:

Line typeAccountIdValueIdValueAmountCurrency amount
GL6210C1B010001000
AP2010-1000-1000

WHEN posted to the transaction resource in the API
THEN the transaction is posted and returns a 202 response (Accepted)
AND the Analytical Information is autocompleted as follows:

AccountAtt Id 1Att Id 2Att Id 3Att Id 4Att Id 5Att Id 6Att Id 7Dim 1Dim 2Dim 3Dim 4Dim 5Dim 6Dim 7
6210C1B0API3NB1000AEN
2010
Scenario 6: Autocomplete Analytical Information in an AP invoice with taxes and a child GL row. Some values set to empty.

GIVEN that a Financial Transaction needs to be posted
AND a Financial Transaction API with a POST endpoint that can autocomplete the analytical dimension where possible
AND a transaction document is sent, with the following information:

Line typeAccountIdValueIdValueAmountCurrency amount
GL6210C1110B010001000
AP2010-1230-1230

AND tax Information is given

Tax point dateTax code
2020-04-011X

WHEN posted to the transaction resource in the API
THEN the transaction is posted and returns a 202 response (Accepted)
AND the Analytical Information is autocompleted as follows:

AccountAtt Id 1Att Id 2Att Id 3Att Id 4Att Id 5Att Id 6Att Id 7Dim 1Dim 2Dim 3Dim 4Dim 5Dim 6Dim 7
6210C1B0API3NB110AEN
1320C1B0API3AG110ACONTRACT1
1330C1B0AG110CONTRACT1
2010
Scenario 7: Autocomplete Analytical Information in a simple AP invoice without taxes where User input is either Optional or No check. The value of the No check attribute does not exist.

GIVEN that a Financial Transaction needs to be posted
AND a Financial Transaction API with a POST endpoint that can autocomplete the analytical dimension where possible
AND a transaction document is sent, with the following information:

Line TypeAccountIdValueIdValueIdValueAmountCurrency amount
GL6210C1B01000API3HOME10001000
AP2010-1000-1000

WHEN posted to the transaction resource in the API
THEN the transaction is posted and returns a 202 response (Accepted)
AND the Analytical Information is autocompleted as follows:

AccountAtt Id 1Att Id 2Att Id 3Att Id 4Att Id 5Att Id 6Att Id 7Dim 1Dim 2Dim 3Dim 4Dim 5Dim 6Dim 7
6210C1B0API3NB2101000HOME
2010
Scenario 8: Autocomplete Analytical Information in a simple AP invoice without taxes where one of the attributes is to be autocompleted through a value matrix and a valid value can be found in a range of attribute values.

GIVEN that a Financial Transaction needs to be posted
AND a Financial Transaction API with a POST endpoint that can autocomplete the analytical dimension where possible
AND a transaction document is sent, with the following information:

Line TypeAccountIdValueIdValueIdValueAmountCurrency amount
GL6290B01000API3B10001000
AP2010-1000-1000

WHEN posted to the transaction resource in the API
THEN the transaction is posted and returns a 202 response (Accepted)
AND the Analytical Information is autocompleted as follows:

AccountAtt Id 1Att Id 2Att Id 3Att Id 4Att Id 5Att Id 6Att Id 7Dim 1Dim 2Dim 3Dim 4Dim 5Dim 6Dim 7
6290C1B0API3NB2101200BEN
2010
Currency Code

In this section, you can find how to autocomplete the Currency code.

User input of Currency code in the account rule can be Mandatory or Fixed.

The field is optional in the DTO, but if the user doesn’t provide a value and the system is unable to auto-complete it, an error message is displayed.

The Currency code field can be autocompleted in the following way:

  • For GL rows, the logic is the same as the one for autocompleting analyticalInformation.
  • For AP/AR rows:
    • If User input of the account rule is Fixed, the logic is the same as the one implemented for analyticalInformation.
    • If User input of the account rule is Optional/Mandatory:
      • We get the value from the Customer/Supplier information.
      • If a value cannot be found in the Customer/Supplier information, we get it from the account rule.
  • For the TX line, the value is inherited from the parent.

We take into account the following information in the calculations:

  • Supplier 1001 - INVOICE
Currency
Norwegian Kroner - NOK
  • Attribute values - Company
Attribute valueDescriptionOwnerValuePeriod fromPeriod toStatus
ENERP DEMO (EN)00209999Active
NOAgresso Demo AS (Norway)00209999Active
SEAgresso Demo AS (Sweden)00209999Active
  • Value matrix. COMPLETECURRENCY
Source Attribute 1Source Attribute 2Destination Attribute
COMPANYCOSTCURRENCY

MATRIX ROWS

InterCompany CompanyCost centreCurrency Code
EN100GBP
NO100NOK
NO110EUR
SE100EUR
SE115SEK
  • Chart of accounts
AccountDescriptionRuleGroupPeriod fromPeriod toTypeStatus
6210RentRENTALCOST620200001209912General LedgerActive
2011Accounts Payable International SuppliersBalance/Finance200199401209912Accounts PayableActive
1320Ingoing VATBalance/Finance130199401209912General LedgerActive
  • Account rule. RENTALCOST
AttributeUser inputAuto-completionDefault valueValidation relation
AccountACCOUNT
Category 1COSTCMandatory
Category 2PROJECTOptional
Category 3Fixed
Category 4Fixed
Category 5Fixed
Category 6Fixed
Category 7COMPANYMandatory
CurrencyCURRENCYFixedCOMPLETECURRENCYGBP
Tax codeTAXCODEFixed0
Tax systemTAXCATOptionalEX
Factor VATFACTOR_VATOptional
  • Account rule. Balance/Finance
AttributeUser inputAuto-completionDefault valueValidation relation
AccountACCOUNT
Category 1COSTCMandatory
Category 2Fixed
Category 3Fixed
Category 4Fixed
Category 5Fixed
Category 6Fixed
Category 7Fixed
CurrencyCURRENCYMandatoryGBP
Tax codeTAXCODEFixed0
Tax systemTAXCATOptional
Factor VATFACTOR_VATOptional
  • Tax Code 1G defined in the database:
Tax CodeAccountVat PercentageNet flagReductionNon-recoverable VAT accountDate fromDate To
1G132023True10001-01-199212-31-2099

Based on the information mentioned above, Currency will be autocompleted as the following scenarios show.

Scenario 1. Autocomplete Currency in the two details of an AP/AR invoice

GIVEN that a Financial Transaction needs to be posted with the supplier 1001
AND a Financial Transaction API with a POST endpoint that can autocomplete the currency where possible
AND a transaction document is sent, with the following information:

Line TypeAccountAmountCurrency amountIDValueIDValue
GL621010001000C1100NBNO
AP2011-1000-1000

WHEN posted to the transaction resource in the API
THEN the transaction is posted and returns a 202 response (Accepted)
AND the information is autocompleted as follows:

AccountAmountTransaction typeCurrency
62101000GLNOK
2011-1000APNOK

Scenario 2. Autocomplete Currency in the two details of an AP/AR invoice triggering compute tax logic

GIVEN that a Financial Transaction needs to be posted with the supplier 1001
AND a Financial Transaction API with a POST endpoint that can autocomplete the currency where possible
AND a transaction document is sent, with the following information:

Line TypeAccountAmountCurrency amountIDValueIDValue
GL621014601230C1100NBNO
AP2011-1460-1230

WHEN posted to the transaction resource in the API
THEN the transaction is posted and returns a 202 response (Accepted)
AND the information is autocompleted as follows:

AccountAmountTransaction typeCurrency
62101460GLNOK
2011-1230APNOK
1320-230TXNOK
DueDate and DiscountDate

In this section you can find how to autocomplete the dueDate and discountDate fields.

For AP/AR lines

This autocompletion will only happen for transaction types whose treatment code is 1, 2 or 5.

As dueDate and discountDate are optional fields of Invoice DTO, the user may send them or not:

  1. If the dueDate and discountDate values are sent by the user, the sent values are kept.

  2. If the dueDate and/or discountDate are not sent but creditTerms is set (the user sent it or API autocompleted it), dueDate and/or discountDate is autocompleted as explained below.

The calculation of dueDate and discountDate is done according to the creditTerms configuration. The logic already implemented in UBW is directly used by API. Check documentation of UBW for more details.

This calculation logic uses a referenceDate to determine the final dueDate and discountDate values.

API determines the referenceDate value as a replication of UBW logic:

  • In case of AR line, referenceDate is always transactionDate.

  • In case of AP line, referenceDate is set according to the DUE_DATE_AP system parameter as follows:

    a. If parameter is Active and has value “2”, referenceDate is set to valueDate (from AP line)
    b. If parameter is Active and has value “3”, referenceDate is set to registeredDate.
    c. For any other parameter configuration, referenceDate is set to transactionDate.

For secondary open item lines

When dueDate is not provided, it is auto-completed with the due date assigned to the related AP row.

Tax Code, Tax System, Factor VAT

In this section, you can find how to autocomplete Tax system, Tax code and Factor VAT.

User input of Tax code in the account rule can be Mandatory or Fixed.

The field is optional in the DTO, but if the user doesn’t provide a value and the system is unable to auto-complete it, an error message is displayed.

User input of Tax system in the account rule can be Optional, Mandatory, or Fixed.

The field is optional in the DTO. An empty value is valid when User input is Optional in the account rule.

The Tax code and Tax system fields are auto-completed in the detail line as follows:

  • For GL rows, the logic is the same as the one for auto-completing analyticalInformation through the account rule.
  • For AP/AR rows:
    • If User input of the account rule is Fixed, the logic is the same as the one implemented for analyticalInformation.
    • If User input of the account rule is Optional/Mandatory:
      • The system takes values from the Customer/Supplier information. If the value of Tax system is Fixed and empty, it is also taken into account.
      • If no values can be found in the Customer/Supplier information, they are taken from the account rule.

User input of Factor VAT can be Optional, Mandatory, or Fixed.

The field is optional in the DTO. An empty value is valid when User input is Optional in the account rule.

This field is auto-completed in the detail line as follows:

  • For GL rows, the logic is the same as the one for auto-completing analyticalInformation through the account rule.
  • For AP/AR rows:
    • If User input of the account rule is Fixed, the logic is also the same as the one implemented for analyticalInformation.
    • If User input of the account rule is Optional/Mandatory, values are taken from the account rule.

For TX lines, Tax System, Tax code and Factor VAT are auto-completed by copying them from the detail line. When the TX line generates a GL line, Tax code, Tax system and Factor VAT are set as empty.

We take into account the following information in the calculations:

  • Supplier 1001 - INVOICE
CurrencyTax codeTax system
Norwegian Kroner - NOKGross 23% - 1G
  • Attribute values - Company
Attribute valueDescriptionOwnerValuePeriod fromPeriod toStatus
ENERP DEMO (EN)00209999Active
NOAgresso Demo AS (Norway)00209999Active
  • Value matrix - COMPLETEFACTORVAT
Source Attribute 1Source Attribute 2Destination Attribute
COMPANYCOSTFACTOR_VAT

MATRIX ROWS

InterCompany CompanyCost centreFactor VAT
EN1001C
NO1001D
  • Chart of accounts
AccountDescriptionRuleGroupPeriod fromPeriod toTypeStatus
6210RentRENTALCOST620200001209912General LedgerActive
6250ElectricityELECTRICITYCOST620200001209912General LedgerActive
2011Accounts Payable International SuppliersBalance/Finance200199401209912Accounts PayableActive
1320Ingoing VATBalance/Finance130199401209912General LedgerActive
  • Account rule. RENTALCOST
AttributeUser inputAuto-completionDefault valueValidation relation
AccountACCOUNT
Category 1COSTCMandatory
Category 2PROJECTOptional
Category 3Fixed
Category 4Fixed
Category 5Fixed
Category 6Fixed
Category 7COMPANYMandatory
CurrencyCURRENCYMandatoryNOK
Tax codeTAXCODEFixed0
Tax systemTAXCATOptionalEX
Factor_VATFACTOR_VATOptional
  • Account rule. ELECTRICITYCOST
AttributeUser inputAuto-completionDefault valueValidation relation
AccountACCOUNT
Category 1COSTCMandatory
Category 2PROJECTOptional
Category 3Fixed
Category 4Fixed
Category 5Fixed
Category 6Fixed
Category 7COMPANYMandatory
CurrencyCURRENCYMandatoryNOK
Tax codeTAXCODEFixed0
Tax systemTAXCATOptional
Factor_VATFACTOR_VATMandatoryCOMPLETEFACTORVAT
  • Account rule. Balance/Finance
AttributeUser inputAuto-completionDefault valueValidation relation
AccountACCOUNT
Category 1COSTCOptional
Category 2Fixed
Category 3Fixed
Category 4Fixed
Category 5Fixed
Category 6Fixed
Category 7Fixed
CurrencyCURRENCYMandatoryNOK
Tax codeTAXCODEMandatory0
Tax systemTAXCATOptional
FACTOR_VATFACTOR_VATOptional
  • Tax Code 1G defined in the database:
Tax CodeAccountVat PercentageNet flagReductionNon-recoverable VAT accountDate fromDate To
1G132023True10001-01-199212-31-2099

Based on the information mentioned above, taxCode, Tax system, and Factor VAT will be auto-completed as the following scenarios show.

Scenario 1. Autocomplete Tax system, Tax code, and Factor VAT in the two details of an AP/AR invoice

GIVEN that a Financial Transaction needs to be posted with the supplier 1001
AND a Financial Transaction API with a POST endpoint that can autocomplete the currency where possible
AND a transaction document is sent, with the following information:

Line TypeAccountAmountCurrency amountIDValueIDValue
GL621010001000C1100NBNO
AP2011-1000-1000

WHEN posted to the transaction resource in the API
THEN the transaction is posted and returns a 202 response (Accepted)
AND the information is autocompleted as follows:

AccountAmountTransaction typeTax codeTax systemReduction code
62101000GL0EX
2011-1000AP0

Scenario 2. Keep values sent by the user and auto-complete where there is no value set for taxCode, Tax system, and Factor VAT

GIVEN that a Financial Transaction needs to be posted with the supplier 1001 AND a Financial Transaction API with a POST endpoint that can autocomplete the currency where possible
AND a transaction document is sent, with the following information:

Line TypeAccountAmountCurrency amountIDValueIDValue
GL621010001000C1100NBNO
AP2011-1000-1000

WHEN posted to the transaction resource in the API
THEN the transaction is posted and returns a 202 response (Accepted)
AND the information is autocompleted as follows:

AccountAmountTransaction typeTax codeTax systemReduction code
62101000GL00
2011-1000AP00

Scenario 3. Autocomplete Tax code, Tax system, and Factor VAT in the two details of an AP/AR invoice triggering compute tax logic

GIVEN that a Financial Transaction needs to be posted with the supplier 1001
AND a Financial Transaction API with a POST endpoint that can autocomplete the currency where possible
AND a transaction document is sent, with the following information:

Line TypeAccountAmountCurrency amountIDValueIDValue
GL621014601230C1100NBNO
AP2011-1460-1230

WHEN posted to the transaction resource in the API
THEN the transaction is posted and returns a 202 response (Accepted)
AND the information is autocompleted as follows:

AccountAmountTransaction typeTax codeTax systemReduction code
62101460GL0
20111230AP1G
1320-230TX1G

Scenario 4. Autocomplete Currency, Tax system, Tax code, and Factor VAT in the two details of an AP/AR invoice

GIVEN that a Financial Transaction needs to be posted with the supplier 1001
AND a Financial Transaction API with a POST endpoint that can autocomplete the currency where possible
AND a transaction document is sent, with the following information:

Line TypeAccountAmountCurrency amountIDValueIDValue
GL625010001000C1100NBNO
AP2011-1000-1000

WHEN posted to the transaction resource in the API
THEN the transaction is posted and returns a 202 response (Accepted)
AND the information is autocompleted as follows:

AccountAmountTransaction typeTax codeTax systemReduction code
62501000GL001D
2011-1000AP0
DiscountPercentage and DiscountCurrencyAmount

In this section, you can find how to autocomplete the discountPercentage and discountCurrencyAmount fields.

This autocompletion will only happen for transaction types whose treatment code is 1, 2 or 5.

As discountPercentage and discountCurrencyAmount are optional fields in the Invoice DTO, the user may send them or not.

The CALC_PAY_DISC_AP/AR system parameter is considered in the discountCurrencyAmount auto-completion with the following settings:

  • When parameter is Not Active, the discountPercentage is applied to the currencyAmount of the AP/AR row.
  • When parameter is Active with value “0” or “1”, the calculation depends on the “Payment discount on tax” flag in the supplier/customer information:
    • If it is selected, the discountPercentage is applied to the SUM of currencyAmount of all GL and taxes rows.
    • If it is not selected, the discountPercentage is applied to the SUM of currencyAmount of all GL rows.

See validations on discountCurrencyAmount field: Scenario_136, Scenario_137 and Scenario_138.

There may be accounts set as excluded from the payment discount calculation. The following scenarios are possible:

  1. If the discountPercentage and discountCurrencyAmount values are sent by the user:

    • The discountPercentage is ALWAYS kept.
    • The discountCurrencyAmount is ALWAYS kept.
  2. If only the discountPercentage value is sent by the user:

    • The discountPercentage is ALWAYS kept.
    • The discountCurrencyAmount is calculated based on the setup of the CALC_PAY_DISC_AP/AR system parameter and the “Payment discount on tax” flag in the supplier/customer information.
  3. If only the discountCurrencyAmount value is sent by the user:

    • The discountPercentage is autocompleted based on the creditTerm definition.
    • The discountCurrencyAmount is ALWAYS kept.

    In this case, the discountPercentage and discountCurrencyAmount values may not be aligned.

  4. If neither the discountPercentage nor the discountCurrencyAmount values are sent by the user:

    • The discountPercentage is autocompleted based on the creditTerm definition. If no creditTerm is available, then, first, the creditTerm in the supplier/customer information will be autocompleted.
    • The discountCurrencyAmount is calculated based on the setup of the CALC_PAY_DISC_AP/AR system parameter and the “Payment discount on tax” flag in the supplier/customer information.

Based on the information mentioned above, the DiscountPercentage and DiscountCurrencyAmount will be auto-completed as the following scenarios show.

  • Supplier 10000 - INVOICE
Payment terms
11 (10 days - 1.5%)
  • Credit term ID: 11

WHEN posted to the transaction resource in the API
THEN the transaction is posted and returns a 202 response (Accepted)
AND the information of the AP line is autocompleted as follows:

Due dateDiscount dateDiscount percentageDiscount currency amountCredit terms
11/09/202011/09/2020549.211
Originating user IDUser ID of the user who is logged in to the API.
Debit/Credit signThe debitCreditSign shown in the response is an auto-completed property. Any input provided in the request will be ignored by the Financial Transactions API.

The Debit/Credit value is derived from the currencyAmount sign. The mapping logic is the following:

currencyAmountdebitCreditSign
> 01
< 0-1
= 00

   

Calculations

Compute Tax

In this section, you can find how the Tax Transaction lines are generated depending on the data provided in the Tax Information section.

taxCode “0” represents no taxes, then this calculation will only happen for any taxCode other than “0”.

Take the following into consideration:

  • All tax-related information is extracted from the combination of taxCode and Tax system, unless this information is explicitly given in the Tax Input section.
  • The Tax point date is the date used to obtain valid values from taxCode or Factor VAT.
  • The taxCode, Tax system, and Factor VAT fields from the detail line are copied to the line generated from the TX line. When the TX line generates a General Ledger line, taxCode is set to ‘0’, and Tax system and Factor VAT are set as empty.

We consider the following input:

  • Tax Code 1E defined in the database:
Tax CodeAccountVat PercentageNet flagReductionNon-recoverable VAT accountDate fromDate To
1E132123True1002000-01-012020-03-31
1E132123True10013802020-04-012099-12-31
  • Tax Code 1H defined in the database:
Tax CodeAccountVat PercentageNet flagReductionNon-recoverable VAT accountDate fromDate To
1H132123True10013802000-01-012020-01-31
1H132023True4013402020-02-012099-12-31
  • Tax Code 1N defined in the database:
Tax CodeAccountVat PercentageNet flagReductionDate fromDate To
1N132023True501993-01-012099-12-31
  • Tax Code 1C is defined as 1N (see above) but with Cash Principle flag selected

  • Tax Code 1S defined in the database:

Tax CodeAccountVat PercentageNet flagReductionDate fromDate To
1S132023True502019-01-012099-12-31
  • Tax Code 1W defined in the database:
Tax CodeAccountVat PercentageNet flagReductionNon-recoverable VAT accountDate fromDate To
1W132023True1002019-01-012019-12-31
1W132023True4013402020-01-012099-12-31
  • Tax Code 1X defined in the database:
Tax CodeAccountVat PercentageNet flagReductionNon-recoverable VAT accountDate fromDate To
1X132023True10013802000-01-012019-12-31
1X132023True4013402020-01-012099-12-31
  • Tax Code 1E defined in the database:
Tax CodeAccountVat PercentageNet flagReductionNon-recoverable VAT accountDate fromDate To
1E132123True1002000-01-012020-03-31
1E132123True10013802020-04-012099-12-31
  • Tax System EX and ER defined in the database:
Tax systemExemptReductionVat Reverse ChargeVat Reverse Account
EXTrue100False
ERTrue100True1312
  • Tax System PD80 defined in the database:
Tax systemReductionVat Reverse ChargeVat Reverse Account
PD8080False
  • Tax system REV defined in the database:
Tax systemReductionVat Reverse ChargeVat Reverse Account
REV100True1312
  • Factor VAT 1D defined in the database:
FactorVatReductionDate fromDate to
1D752000-01-012099-12-31
1D601999-01-011999-12-31
  • Undeclared VAT account is set in the company as 1345
  • Undeclared VAT for AP transactions account is set in the company as 1310
  • Undeclared VAT for AR transactions account is set in the company as 1330

Based on the information mentioned above, the Tax Transaction Line will be calculated as the following scenarios show.

Scenario 1. Compute Tax considering taxCode 1N and No Tax Input

GIVEN that a Financial Transaction needs to be posted
AND a Financial Transactions API with a POST endpoint is available
AND a transaction document is sent, with the following information

Line TypeAccountAmountCurrency amountTax point dateTax code
GL6250100010002019-05-051N
AP2010-1230-1230

BUT there is no Tax Input information
WHEN the transaction is posted to the transaction resource in the API
THEN the transaction is posted and returns a 202 response (Accepted)
AND the tax transaction line is created with the following information:

Line TypeAccountAmountBase amountOrig AmountOrig Base AmountTax CodeVat Percentage
TX1320230100023010001N23
Scenario 2. Compute Tax considering Tax Code 1N but with fixed Tax Amounts

GIVEN that a Financial Transaction needs to be posted
AND a Financial Transactions API with a POST endpoint is available
AND a transaction document is sent, with the following information

Line TypeAccountAmountCurrency amountTax point dateTax code
GL6250100010002019-05-051N
AP2010-1230-1230

AND Tax Input is given with fixed amount of 225.36
WHEN the transaction is posted to the transaction resource in the API
THEN the transaction is posted and returns a 202 response (Accepted)
AND the tax transaction line is created with the following information:

Line TypeAccountAmountBase amountOrig AmountOrig Base AmountTax CodeVat Percentage
TX1320225.361000225.3610001N23
Scenario 3. Compute Tax considering Tax Code 1N but with fixed Vat Percentage

GIVEN that a Financial Transaction needs to be posted
AND a Financial Transactions API with a POST endpoint is available
AND a transaction document is sent, with the following information

Line TypeAccountAmountCurrency amountTax point dateTax code
GL6250100010002019-05-051N
AP2010-1230-1230

AND Tax Input is given with fixed Vat Percentage of 20 %
WHEN the transaction is posted to the transaction resource in the API
THEN the transaction is posted and returns a 202 response (Accepted)
AND the tax transaction line is created with the following information:

Line TypeAccountAmountBase amountOrig AmountOrig Base AmountTax CodeVat Percentage
TX1320200100020010001N20
Scenario 4. Compute Tax considering Tax Code 1N and Factor Vat defined for the given Tax Point Date

GIVEN that a Financial Transaction needs to be posted
AND a Financial Transactions API with a POST endpoint is available
AND a transaction document is sent, with the following information

Line TypeAccountAmountCurrency amountTax point dateTax codeFactor Vat
GL6250100010002019-05-051N1D
AP2010-1230-1230

WHEN the transaction is posted to the transaction resource in the API
THEN the transaction is posted and returns a 202 response (Accepted)
AND the tax transaction line is created with the following information:

Line TypeAccountAmountBase AmountOrig AmountOrig Base AmountFactor VatFactor Vat ReductionTax CodeTax Code ReductionTotal Reduction
TX1320172.5075023010001D751N10075

AND the amounts in GL line are modified as following to balance the transaction

Line TypeAccountAmountFactor Vat CodeTax Code
GL62501057.501D1N
Scenario 5. Compute Tax considering Tax Code 1N and Factor Vat not defined for the given Tax Point Date

GIVEN that a Financial Transaction needs to be posted
AND a Financial Transactions API with a POST endpoint is available
AND a transaction document is sent, with the following information

Line TypeAccountAmountCurrency amountTax point dateTax codeFactor Vat
GL6250100010001998-01-011N1D
AP2010-1230-1230

WHEN the transaction is posted to the transaction resource in the API
THEN the transaction is posted and returns a 202 response (Accepted)
AND the tax transaction line is created with the following information:

Line TypeAccountAmountBase AmountOrig AmountOrig Base AmountFactor VatFactor Vat ReductionTax CodeTax Code ReductionTotal Reduction
TX1320230100023010001D1001N100100

AND the amounts in GL line remain unmodified.

Scenario 6. Compute Tax considering Tax Code 1S and Tax System EF

GIVEN that a Financial Transaction needs to be posted
AND a Financial Transactions API with a POST endpoint is available
AND a transaction document is sent, with the following information

Line TypeAccountAmountCurrency amountTax point dateTax CodeTax system
GL6520100010002019-05-051SPD80
AP2010-1230-1230

WHEN the transaction is posted to the transaction resource in the API
THEN the transaction is posted and returns a 202 response (Accepted)
AND the tax transaction line is created with the following information:

Line TypeAccountAmountBase AmountOrig AmountOrig Base AmountTax CodeTax Code ReductionTax SystemTax System ReductionTotal Reduction
TX13209240023010001S50PD808040

AND the amounts in GL line are modified as following to balance the transaction

Line TypeAccountAmountTax CodeTax system
GL625011381SPD80
Scenario 7. Compute Tax considering Tax Code 1S, Tax System PD80 and Factor Vat 1D

GIVEN that a Financial Transaction needs to be posted
AND a Financial Transactions API with a POST endpoint is available
AND a transaction document is sent, with the following information

Line TypeAccountAmountCurrency amountTax point dateFactor VatTax CodeTax system
GL6520100010002019-05-051D1SPD80
AP2010-1230-1230

WHEN the transaction is posted to the transaction resource in the API
THEN the transaction is posted and returns a 202 response (Accepted)
AND the tax transaction line is created with the following information:

Line TypeAccountAmountBase AmountOrig AmountOrig Base AmountFactor VatFactor Vat ReductionTax CodeReduction Tax CodeTax SystemReduction Tax SystemTotal Reduction
TX1320172.5075023010001D751S50PD808075

AND the amounts in GL line are modified as following to balance the transaction

Line TypeAccountAmountFactor VatTax CodeTax system
GL62501057.501D1SPD80
Scenario 8: Compute Tax considering Tax Code 1W and Tax System PD80 with reductions. A "non-recoverable VAT account" cannot be found in the Tax Code definition

GIVEN that a Financial Transaction needs to be posted
AND a Financial Transactions API with a POST endpoint is available
AND a transaction document is sent, containing the information below

Line TypeAccountAmountCurrency amountTax point dateTax CodeTax systemDate To
GL6520100010002019-12-311WPD802019-12-31
AP2010-1230-12302099-12-31

WHEN the transaction is posted to the transaction resource in the API
THEN the transaction is posted and returns a 202 response (Accepted)
AND the tax transaction line is created with the following information:

Line TypeAccountAmountBase AmountOrig AmountOrig Base AmountVat percentageTax CodeTax SystemReductionIs Vat Non RecoverableTax sequence referenceSequence number
TX13201848002301000231WPD8080112

AND the amounts in GL line are modified as following to balance the transaction

Line TypeAccountAmountCurrency amountTax CodeTax system
GL6250104610461WPD80
Scenario 9: Compute Tax considering Tax Code 1X, Tax System PD80 and Factor Vat 1D with reductions. A "non-recoverable VAT account" can be found in the Tax Code definition

GIVEN that a Financial Transaction needs to be posted
AND a Financial Transactions API with a POST endpoint is available
AND a transaction document is sent, containing the information below

Line TypeAccountAmountCurrency amountTax point dateTax CodeTax systemFactor Vat
GL6520100010002020-04-011XPD801D
AP2010-1230-1230

WHEN the transaction is posted to the transaction resource in the API
THEN the transaction is posted and returns a 202 response (Accepted)
AND the tax transaction line is created with the following information:

Line TypeAccountAmountBase AmountOrig AmountOrig Base AmountVat percentageReduction codeTax CodeTax SystemReductionIs Vat Non RecoverableTax sequence referenceSequence number
TX1320172.507502301000231D1XPD8075112
GL134057.500123

AND the amounts in GL line remain unmodified.

Scenario 10: Compute Tax considering tax system with reverse charge

GIVEN that a Financial Transaction needs to be posted
AND a Financial Transactions API with a POST endpoint is available
AND a transaction document is sent, containing the information below

Line TypeAccountAmountCurrency amountTax point dateTax CodeTax system
GL6520100010002020-04-011EREV
AP2010-1000-1000

WHEN the transaction is posted to the transaction resource in the API
THEN the transaction is posted and returns a 202 response (Accepted)
AND the tax transaction line is created with the following information:

Line TypeAccountAmountBase AmountOrig AmountOrig Base AmountTax CodeVat PercentageTax SystemReductionIs Vat Non RecoverableIs Vat Reverse ChargeSequence NumberTax Sequence Reference
TX1321230100023010001E23REV1000121
GL1312-2300132

AND the amounts in GL line remain unmodified.

Scenario 11: Compute Tax considering tax system with reverse charge, non-recoverable vat on separate GL account and given vat percentage and vat amount in the tax input DTO

GIVEN that a Financial Transaction needs to be posted
AND a Financial Transactions API with a POST endpoint is available
AND a transaction document is sent, containing the information below

Line TypeAccountAmountCurrency amountTax point dateTax CodeTax systemFactor Vat
GL6520100010002020-04-011EREV1D
AP2010-1000-1000

WHEN the transaction is posted to the transaction resource in the API
THEN the transaction is posted and returns a 202 response (Accepted)
AND the tax transaction line is created with the following information:

Line TypeAccountAmountBase AmountOrig AmountOrig Base AmountVat PercentageVat reverse charge amountVat reverse charge curr amountReduction codeTax CodeTax SystemReductionIs Vat Non RecoverableIs Vat Reverse ChargeSequence NumberTax Sequence Reference
TX1321129.757501731000171731731D1EREV751121
GL138043.250132
GL1312-1730142

AND the amounts in GL line remain unmodified.

Scenario 12: Compute Tax on a Financial Transaction with basic tax code and Exempt tax system

GIVEN that a Financial Transaction needs to be posted
AND a Financial Transactions API with a POST endpoint is available
AND a transaction document is sent, containing the information below

Line TypeAccountAmountCurrency amountTax point dateTax CodeTax system
GL6520100010002020-01-011HEX
AP2010-1000-1000

WHEN the transaction is posted to the transaction resource in the API
THEN the transaction is posted and returns a 202 response (Accepted)
AND the tax transaction line is created with the following information:

Line TypeAccountAmountBase AmountOrig AmountOrig Base AmountTax CodeVat PercentageTax SystemReductionIs Vat Non RecoverableIs Vat Reverse ChargeSequence NumberTax Sequence ReferenceTrans Type
TX132101000010001H23EX1000021TE

AND the amounts in GL line remain unmodified.

Scenario 13: Compute Tax on a Financial Transaction with non-deductible vat on a separate GL row, reverse charge and Exempt tax system

GIVEN that a Financial Transaction needs to be posted
AND a Financial Transactions API with a POST endpoint is available
AND a transaction document is sent, containing the information below

Line TypeAccountAmountCurrency amountTax point dateTax CodeTax system
GL6520100010002020-01-011HER
AP2010-1000-1000

WHEN the transaction is posted to the transaction resource in the API
THEN the transaction is posted and returns a 202 response (Accepted)
AND the tax transaction line is created with the following information:

Line TypeAccountAmountBase AmountOrig AmountOrig Base AmountTax CodeVat PercentageTax SystemReductionIs Vat Non RecoverableIs Vat Reverse ChargeSequence NumberTax Sequence ReferenceTrans Type
TX1321040023010001H23ER401121TE

AND the amounts in GL line remain unmodified.

Scenario 14. Compute Tax considering Tax Code 1C and No Tax Input

GIVEN that a Financial Transaction needs to be posted
AND split of undeclared VAT for AP and AR transactions is turned off AND a Financial Transactions API with a POST endpoint is available
AND a transaction document is sent, with the following information

Line TypeAccountAmountCurrency amountTax point dateTax code
GL6250100010002019-05-051C
AP2010-1230-1230

BUT there is no Tax Input information
WHEN the transaction is posted to the transaction resource in the API
THEN the transaction is posted and returns a 202 response (Accepted)
AND the tax transaction line is created with the following information:

Line TypeAccountCollectionAmountBase amountOrig AmountOrig Base AmountTax CodeVat Percentage
TX13451230100023010001C23
Scenario 15. Compute Tax considering Tax Code 1C and No Tax Input

GIVEN that a Financial Transaction needs to be posted
AND split of undeclared VAT for AP and AR transactions is turned on
AND a Financial Transactions API with a POST endpoint is available
AND a transaction document is sent, with the following information

Line TypeAccountAmountCurrency amountTax point dateTax code
GL6250100010002019-05-051C
AP2010-1230-1230

BUT there is no Tax Input information
WHEN the transaction is posted to the transaction resource in the API
THEN the transaction is posted and returns a 202 response (Accepted)
AND the tax transaction line is created with the following information:

Line TypeAccountCollectionAmountBase amountOrig AmountOrig Base AmountTax CodeVat Percentage
TX13101230100023010001C23
Scenario 16. Compute Tax considering Tax Code 1C and No Tax Input

GIVEN that a Financial Transaction needs to be posted
AND split of undeclared VAT for AP and AR transactions is turned on AND a Financial Transactions API with a POST endpoint is available
AND a transaction document is sent, with the following information

Line TypeAccountAmountCurrency amountTax point dateTax code
GL3016-1000-10002019-05-051C
AR121012301230

BUT there is no Tax Input information
WHEN the transaction is posted to the transaction resource in the API
THEN the transaction is posted and returns a 202 response (Accepted)
AND the tax transaction line is created with the following information:

Line TypeAccountCollectionAmountBase amountOrig AmountOrig Base AmountTax CodeVat Percentage
TX13301-230-1000-230-10001C23
Computing amounts

In this section, you can find how the Financial Transactions API calculates Amount, Amounts3 and Amounts4 when the consumer of the API posts or registers transactions in multiple currencies without providing values for all of them.

The same calculation is used for Amount, Amounts3 and Amounts4 in the SecondaryOpenItems DTO.

This calculation is also used when the DTO is in taxTransactionLine, Base (Amount, Amount3, Amount4, Currency amount), Original (Amount, Amount3, Amount4, Currency amount), Original base (Amount, Amount3, Amount4, Currency amount) and Reverse charge (Amount, Amount3, Amount4, Currency amount).

The amount fields are nullable, meaning that:

  • They can be included in JSON with a specific value.
  • They can be included with value: NULL.
  • They don’t have to be included in JSON.

The calculation of Amount, Amount3 and Amount4 is based on the values in Currency amount and Currency, when:

  • The values are not set in the JSON file
    or
  • They are set with value: NULL
    and
  • They are defined in the Company information tab in U4ERP.

The calculation of the amounts is triggered after the tax has been calculated.

It has the following rules:

  • It is always possible to find an exchange rate to calculate the different amounts that are defined for the company.
  • In case taxTransactionLines are included in JSON, the amounts (Base amounts, Original base amounts, Amount…) in this DTO will always have the corresponding amounts in the parent details (that is: if we have Amount3, Base amount3, Original base amount3, etc. in the taxTransactionLine DTO, the parent details will also have the same values available).

The calculation takes into account the following information:

  • Company information - Currency - EN
CurrencyCurrency typeBalanceMaximum transaction diffDifference accountBalance account
AMOUNTSterling Pound (GB)Daily ratestrue
AMOUNT3EuroEuro rates99989998
AMOUNT4US DollarRate in USD9998
  • Currency codes
Currency codeDescriptionUnitSortLimitNumber of decimalsBank
EUREuro110.004
USDUS Dollar110.001DNBUSD
GBPSterling Pound (GB)170.002NATWEST
NOKNorwegian kroner1200.002DNBNOK
  • Chart of accounts
AccountDescriptionRuleGroupPeriod fromPeriod toTypeStatus
6250ElectricityCosts (20)620199300209912General LedgerActive
2010Accounts Payable Domestic SuppliersBalance/Finance (10)200199401209912Accounts PayableActive
1320Ingoing VATBalance/Finance (10)130199401209912General LedgerActive
  • Account rule Costs (20)
RULE 20 COSTSAttributeUser inputAuto-completionDefault valueValidation relation
AccountACCOUNT
Category 1COSTCOptionalCOMP100
Category 2PROJECTOptional
Category 3COMPOptional
Category 4
Category 5
Category 6
Category 7
CurrencyCURRENCYMandatoryGBP
Tax codeTAXCODEMandatory0
Tax systemTAXCATOptional
AMOUNTS
AmountMandatoryExchange ratesRate in GBPDebit/CreditNormal
AmountExchange ratesEuro rates
STATISTICAL VALUES
Value textAPITESTShow on invoiceTrueText on invoiceTrue
  • Account rule Balance/Finance (10)
RULE 10 BALANCE/FINANCEAttributeUser inputAuto-completionDefault valueValidation relation
AccountACCOUNT
Category 1COSTCOptionalCOMP100
Category 2
Category 3
Category 4
Category 5
Category 6
Category 7COMPANYOptional
CurrencyCURRENCYMandatoryGBP
Tax codeTAXCODEMandatory0
Tax systemTAXCATOptional
AMOUNTS
AmountMandatoryExchange ratesRate in GBPDebit/CreditNormal
AmountExchange ratesEuro rates
STATISTICAL VALUES
Value textShow on invoiceText on invoiceTrue
  • Exchange rate entry Rate in GBP company EN
CurrencyRegistered rateExchange rateDate fromDate toDirect/Indirect
NOK101001-01-202012-31-2099Indirect
  • Exchange rate entry Euro rates company EN
CurrencyRegistered rateExchange rateDate fromDate toDirect/Indirect
NOK8.73078.730727-01-200013-31-2099Indirect
SEK8.61510.0861501-27-200012-31-2099Indirect
  • Exchange rate entry Rate in USD company EN
CurrencyRegistered rateExchange rateDate fromDate toDirect/Indirect
NOK7.52057.520501-02-190013-31-2099Indirect
SEK8.12758.127501-02-190013-31-2099Direct
  • Tax code 1N defined in the database
Tax codeAccountVAT percentageNet flagReductionDate fromDate to
1N132023True10001-01-199331-12-2099
  • Factor VAT 1D defined in the database
Factor VATReductionDate fromDate to
1D7501-04-202031-12-2099

The amounts are calculated according to the following scenarios.

Scenario 1. Compute *Amount* (with the *Indirect exchange rate*) and *Compute tax* (*Amount3* and *Amount4* are not to be calculated but set to 0). *Tax transaction line* is not provided and *Amount* is not set (so it needs to be calculated).

GIVEN that a Financial Transaction needs to be posted with amounts in different currencies
AND a Financial Transactions API with a POST endpoint that can calculate amounts in different currencies is available
AND a transaction document is sent
AND Tax Information is given

Tax point dateTax code
01/01/20201N

AND one GL rows are given

Line typeAccountCurrencyAmount3Amount4Currency amount
GL6250NOK0010000

WHEN the transaction is posted to the transaction resource in the API
THEN the transaction is posted and returns a 202 response (Accepted)
AND the tax transaction lines are created with the following information

Line typeAccountAmountValue2Value3Currrency AmountCurrencyExch RateExch Rate2Exch Rate3Base amountBase CurrencyBase value 2Base value 3Original base amountOriginal base currOriginal base value 2Original base value 3Original amountOriginal curr amountOriginal Value 2Original Value 3
GL62501000,000,0000,010000,00NOK0,100,00000,00,000,000,0000,00,000,000,0000,00,000,000,0000,0
AP2010-1230,000,0000,0-12300,00NOK0,100,00000,00,000,000,0000,00,000,000,0000,00,000,000,0000,0
TX1320230,000,0000,02300,00NOK0,100,00000,01000,0010000,000,0000,01000,0010000,000,0000,0230,002300,000,0000,0
Scenario 2. Only Compute *Amount4* (Values for other amounts are set. *Currency type* to be checked in **Company information** tab). *Tax transaction line* is provided so compute tax logic is not triggered:

GIVEN that a Financial Transaction needs to be posted with amounts in different currencies
AND a Financial Transactions API with a POST endpoint that can calculate amounts in different currencies is available
AND a transaction document is sent
AND Tax Information is given

Tax point dateTax codeFactor VAT
01/04/20201N1D

AND one GL rows are given

Line typeAccountCurrencyAmountAmount3Currency amount
GL6250SEK1046.9251163.2510575

AND Tax transaction lines are given

Original base amountOriginal base amount3Original base currency amountBase amountBase amount3Base currency amountAmountAmount3Currency amountOriginal amountOriginal amount3Original currency amount
990110010000742.58257500170.775189.751725227.72532300

WHEN the transaction is posted to the transaction resource in the API
THEN the transaction is posted and returns a 202 response (Accepted)
AND the tax transaction lines are created with the following information

Line typeAccountAmountValue2Value3Currency amountCurrencyExch rateExch rate2Exch rate3Base amountbase currBase value 2Base value 3Orig base amountOrig base currOrig base value 2Orig base value 3Orig amountOrig cur amountOrig value 2Orig value 3
GL62501046,931163,25085949,2010575,00SEK0,099000470,110000008,100000000,000,000,0000,00,000,000,0000,00,000,000,0000,0
AP2010-1217,70-1353,000-99969,20-12300,00SEK0,099000000,110000008,100000000,000,000,0000,00,000,000,0000,00,000,000,0000,0
TX1320170,78189,75014020,101725,00SEK0,099002900,110000008,10000000742,507500,00825,00060956,9990,0010000,001100,00081275,8227,702300,00253,00018693,4
Tax Summary

In this section you can find how to calculate the tax lines based on the input given in the “SummaryTaxInformation”.
The following rules apply:

  • ‘Amounts’ or ‘VatPercentages’ set in the SummaryTaxInformation are to be used to create the Tax transaction lines (even though they are not aligned with values coming from Tax codes in U4ERP).

  • To calculate the amount of the Tax transaction lines, the amounts given in the SummaryTaxInformation are proportionally distributed among the amounts in each detail line per combination taxCode/taxSystem. This is done by multiplying the amount in each detail line by the amount in SummaryTaxInformation corresponding to that combination. Then this result is divided by the sum of the detail line amounts with that same taxCode/taxSystem combination. Any rounding differences are assigned to the detail line with the greatest Currency Amount.

    In the example in Scenario 2, 35.2 is multiplied by 96, then this result is divided by 184 (the sum of the detail lines: 96 + 88). i Based on the information mentioned above, the Tax Transaction Line will be calculated as the following scenarios show.

Scenario 1. Posting a Financial Transaction given one set of SummaryTaxInformation with Vat Percentage and having two details with taxes.

GIVEN that a Financial Transaction needs to be posted
AND a Financial Transactions API with a POST endpoint is available
AND a transaction document is sent
AND a SummaryTaxInformation is given

Tax codeTax SystemVat Percentage
1NEU23.05

AND two GL rows are given

Line TypeAccountAmountCurrency amountTax CodeTax system
GL65204806001NEU
GL65203204001NEU

WHEN the transaction is posted to the transaction resource in the API
THEN the transaction is posted and returns a 202 response (Accepted)
AND the tax transaction lines are created with the following information:

Line TypeAccountAmountBase AmountCurrency AmountBase Currency AmountTax CodeTax SystemVat Percentage
TX1320110.64480138.306001NEU23.05
TX132073.7632092.204001NEU23.05
Scenario 2. Posting a Financial Transaction given two sets of SummaryTaxInformation with Vat percentage and Tax Amounts and having two details with taxes.

GIVEN that a Financial Transaction needs to be posted
AND a Financial Transactions API with a POST endpoint is available
AND a transaction document is sent
AND a SummaryTaxInformation is given

Tax codeTax SytemVat PercentageAmountCurrency amount
V5EU2035.244
V657.759.69

AND five GL rows are given

Line TypeAmountCurrency amountTax codeTax System
GL96120V5EU
GL88110V5EU
GL80100V6
GL26.6633.33V6
GL48.4460.55V6

WHEN the transaction is posted to the transaction resource in the API
THEN the transaction is posted and returns a 202 response (Accepted)
AND the tax transaction lines are created with the following information:

Line TypeAccountAmountBase AmountCurrency AmountBase Currency AmountTax CodeTax SystemVat Percentage
TX132018.379622.96120V5EU20
TX132016.838821.04110V5EU20
TX13204.00805.00100V65
TX13201.3326.661.6733.33V65
TX13202.4248.443.0360.55V65
   

Limits and Notes

Non-supported scenarios

  • Import of large volume transactions. The API is not suited for creation of transaction with more than 500 details.
  • Registration of financial transaction. Transaction types with treatment codes 1 and 10 are outside the supported scope.
  • Payments and Prepayments transactions. The paymentInformation properties are not supported in the current release.
  • Negative amounts in Debit/Credit accounting. The debitCreditSign property cannot be used in the request, any input will be ignored.
  • Linked tax codes. Tax codes configured with ‘Transfer to’ information are not accepted.
  • Tax systems defined with the option ‘VAT transactions’ are not accepted.
  • Tax systems defined with the option ‘Base excluding discounts’ are not accepted.
  • taxLineInfo is computed by the API, any input in the request will be ignored.
  • Recurring journals are currently not supported.
  • Data control functionality is not implemented in the API.
  • Document archive functionality is not implemented in the API.
  • Payment plans cannot be created or referenced by this API.
  • The following Open item fields are not supported and cannot be posted by the API.
    • Both Supplier Open item and Customer Open item related fields
      • complaint date and complaint code.
      • currency doc/1099 code and its description.
      • collection agency, Case number and Collection status.
      • Order ID and Line number.
    • Supplier Open item related fields
      • Contract ID.
    • Customer Open item related fields
      • Reminder level, Last reminded and Interest status.
      • Interest and reminder rule.
  • The validation to ensure the currency amounts for a transaction are in balance (system parameter CURRENCY_BALANCE) is not implemented in the API.

   

Validation Rules for POST Method (Financial Transactions)

Scenario_000 - User not authorised
ElementDetails
Scenario IDPOST_000
Scenario NameUser not authorised
HTTP Code403
GIVENA transactions needs to be imported
WHENCalling the POST method
BUTUser does NOT have permissions
THENAPI is not reached; 403 Forbidden response is returned
Example Error Message“User is not authorised.”
Scenario_001 - Missing mandatory fields
ElementDetails
Scenario IDScenario_001
Scenario NameMissing mandatory fields
GIVENA financial transaction needs to be posted
WHENCalling POST /v1/financial-transactions
THENValidation outcome: Register transaction = Error; Post transaction = Error
HTTP Code (Post)422
ApplicabilityApplicable to POST /v1/financial-transactions
Scenario_002 - Incorrect format or value of fields
ElementDetails
Scenario IDScenario_002
Scenario NameIncorrect format or value of fields
GIVENA financial transaction needs to be posted
WHENCalling POST /v1/financial-transactions
THENValidation outcome: Register transaction = Error; Post transaction = Error
HTTP Code (Post)422
ApplicabilityApplicable to POST /v1/financial-transactions
Scenario_003 - A Transaction has less than two Transaction details
ElementDetails
Scenario IDScenario_003
Scenario NameA Transaction has less than two Transaction details
GIVENA financial transaction needs to be posted
WHENCalling POST /v1/financial-transactions
THENValidation outcome: Register transaction = Warning; Post transaction = Error
HTTP Code (Post)422
ApplicabilityApplicable to POST /v1/financial-transactions
Scenario_004 - Posting cycle cannot be found
ElementDetails
Scenario IDScenario_004
Scenario NamePosting cycle cannot be found
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent, containing the information below:
Company IdPeriodTrans DateTrans TypeAccountAmountAmount3Amount4Cur AmountCurrency
EN2019072019-07-21GL1011-160-250-267-2000NOK
EN2019072019-07-21GL62201602502672000NOK
BUTno posting cycle can be found for Transaction Type GL period 201907
ANDno posting cycle can be found for Transaction Type GL fiscal year 2019
ANDno posting cycle can be found for Transaction Type GL fiscal year (empty)
WHENthe transaction is posted to the transaction resource in the API
THENthe transaction is not posted
ANDa 422 response (Unprocessable entity) is obtained
ANDthe response contains the error message below:
Example Error Message“A valid Posting cycle must be created for Transaction type {0}"
{0} - Value of the Transaction type set in the JSON file
Scenario_005 - Voucher number cannot be assigned because posting cycle has been exhausted
ElementDetails
Scenario IDScenario_005
Scenario NameVoucher number cannot be assigned because posting cycle has been exhausted
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent, containing the information below
Company IdPeriodTrans DateTrans TypeAccountAmountAmount3Amount4Cur AmountCurrency
EN2019072019-07-21GL1011-160-250-267-2000NOK
EN2019072019-07-21GL62201602502672000NOK
ANDa posting cycle can be found
BUTthe counter for the posting cycle has been exhausted (there are no numbers available )
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable entity) is obtained
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Exhausted Posting Cycle; No Transaction Numbers available for Posting Cycle {0} assigned to Transaction Type {1}."
{0} - Value of the Posting cycle that is given or auto-completed by the API
{1} - Value of the Transaction type set in the JSON file
Scenario_006 - Transaction Type does not exist for the selected company
ElementDetails
Scenario IDScenario_006
Scenario NameTransaction Type does not exist for the selected company
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent, containing the information below
Company IdPeriodTrans DateTrans TypeAccountAmountAmount3Amount4Cur AmountCurrency
EN2019072019-07-21GZ1011-160-250-267-2000NOK
EN2019072019-07-21GZ62201602502672000NOK
BUTtransaction type GZ does not exist in Client EN
WHENposted to the transaction resource in the API
THENa 422 response (Unprocessable entity) is obtained
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Unknown Transaction Type {0}."
{0} - Value of the Transaction type set in the JSON file
Scenario_007 - Transaction Type does not have status N
ElementDetails
Scenario IDScenario_007
Scenario NameTransaction Type does not have status N
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent, containing the information below
Company IdPeriodTrans DateTrans TypeAccountAmountAmount3Amount4Cur AmountCurrency
EN2019072019-07-21G21011-160-250-267-2000NOK
EN2019072019-07-21G262201602502672000NOK
BUTtransaction type G2 in Client EN does not have status N
WHENposted to the transaction resource in the API
THENa 422 response (Unprocessable entity) is obtained
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Invalid Transaction Type; status must be N (Active).”
Scenario_008 - Transaction Type does not have Treatment code 4
ElementDetails
Scenario IDScenario_008
Scenario NameTransaction Type does not have Treatment code 4
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent, containing the information below
Company IdPeriodTrans DateTrans TypeAccountAmountAmount3Amount4Cur AmountCurrency
EN2019072019-07-21AP1011-160-250-267-2000NOK
EN2019072019-07-21AP62201602502672000NOK
BUTtransaction type AP in Client EN does not have treatment code 2, 4 or 5
WHENthe transaction is posted through “financial-transactions” endpoint
THENa 422 response (Unprocessable entity) is obtained
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Invalid Transaction Type; Treatment Code must be one of the following: {0}"
{0} - valid treatment codes for “financial-transactions” endpoint (2, 4, 5)
Scenario_009 - Period is not defined in the client (Company Id)
ElementDetails
Scenario IDScenario_009
Scenario NamePeriod is not defined in the client (Company Id)
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent, containing the information below:
Company IdPeriodTrans DateTrans TypeAccountAmountAmount3Amount4Cur AmountCurrency
EN2020012020-01-26GL1011-160-250-267-2000NOK
EN2020012020-01-26GL62201602502672000NOK
BUTperiod 202001 is not defined in Client EN
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable entity) is obtained
ANDthe response contains the error message below:
ANDthe transaction is not posted.
Example Error Message“Unknown Period.”
Scenario_010 - Period is not Active
ElementDetails
Scenario IDScenario_010
Scenario NamePeriod is not Active
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent, containing the information below:
Company IdPeriodTrans DateTrans TypeAccountAmountAmount3Amount4Cur AmountCurrency
EN2018012018-01-26GL1011-160-250-267-2000NOK
EN2018012018-01-26GL62201602502672000NOK
BUTperiod 201801 has status different from N
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable entity) is obtained
ANDthe response contains the error message below:
ANDthe transaction is not posted.
Example Error Message“Invalid Period; status must be N (Active).”
Scenario_011 - Unparseable date
ElementDetails
Scenario IDScenario_011
Scenario NameUnparseable date
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
BUTany of transactionDate, discountDate or dueDate fields is provided as an unparseable date (e.g. “1125”, “Any text”, …)
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable entity) is obtained
ANDthe response contains the error message below:
ANDthe transaction is not posted.
Example Error Message“Invalid {0}; date format must be YYYY-MM-DD."
{0} - the date field”
Scenario_012 - GL account does not exist for the selected period
ElementDetails
Scenario IDScenario_012
Scenario NameGL account does not exist for the selected period
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent, containing the information below:
Company IdPeriodTrans DateTrans TypeAccountAmountAmount3Amount4Cur AmountCurrency
EN2019072019-07-21GL1080-160-250-267-2000NOK
EN2019072019-07-21GL62201602502672000NOK
BUTGL account 1080 does not exist for period 201907
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable entity) is obtained
ANDthe response contains the error message below:
ANDthe transaction is not posted.
Example Error Message“Invalid {0} ({1}) for period {2}."
{0} - the validated field (account)
{1} - the account
{2} - the period
Scenario_013 - GL account is not active for the selected period
ElementDetails
Scenario IDScenario_013
Scenario NameGL account is not active for the selected period
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent, containing the information below:
Company IdPeriodTrans DateTrans TypeAccountAmountAmount3Amount4Cur AmountCurrency
EN2019072019-07-21GL1001-160-250-267-2000NOK
EN2019072019-07-21GL62201602502672000NOK
BUTGL account 1001 has a status different from N for period 201907
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable entity) is obtained
ANDthe response contains the error message below:
ANDthe transaction is not posted.
Example Error Message“Invalid Account; status must be N (Active) for Period {0}."
{0} - Value of the Period set in the JSON file
Scenario_014 - Currency is not defined in the selected Client
ElementDetails
Scenario IDScenario_014
Scenario NameCurrency is not defined in the selected Client
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent, containing the information below:
Company IdPeriodTrans DateTrans TypeAccountAmountAmount3Amount4Cur AmountCurrency
EN2019102019-10-21GL1011-160-250-267-2000ZZZ
EN2019102019-10-21GL62201602502672000ZZZ
BUTCurrency code ZZZ does not exist for Client EN
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable entity) is obtained
ANDthe response contains the error message below:
ANDthe transaction is not posted.
Example Error Message“Unknown Currency code."
{0} - Value of the Period set in the JSON file
Scenario_015 - All amounts in a "Transaction Detail" are either 0 or blank
ElementDetails
Scenario IDScenario_015
Scenario NameAll amounts in a “Transaction Detail” are either 0 or blank
HTTP Code422
GIVENthat there is a POST API for financial transactions
ANDa transaction document is sent
ANDthe fields Amount, Amount3, Amount4 and CurrencyAmount of one (or many) of the Transaction Details are all empty or have the value zero
WHENthe corresponding Transaction Details are posted to the transaction resource in the API
THENa 422 response (Unprocessable entity) is returned
ANDthe response contains the error message below for each of the details for which this is the case:
ANDthe transaction is not posted
Example Error Message“Invalid Transaction Detail; either “Currency Amount” or any of the “Amounts” defined for Company ID {0} must differ from 0."
{0} - Company Id value set in the JSON file
Scenario_016 - The number of decimals for one or more amounts exceeds the maximum number allowed
ElementDetails
Scenario IDScenario_016
Scenario NameThe number of decimals for one or more amounts exceeds the maximum number allowed
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDthe number of decimals for one or more “Amounts” (Currency Amount, Amount, Amount3 or Amount4) exceeds 3, which is the maximum defined for those fields
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Invalid {0}; the maximum number of decimals that the system can accept ({1}) has been exceeded”.
{0} - The amount that exceeds the number of decimals (this may be “Currency Amount”, “Amount”, “Amount3” or “Amount4”)
{1} - the maximum number of decimals that system can accept for field
Scenario_017 - The number of decimals for one or more amounts exceeds the maximum number of decimals defined for the Currency
ElementDetails
Scenario IDScenario_017
Scenario NameThe number of decimals for one or more amounts exceeds the maximum number of decimals defined for the Currency
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDthe number of decimals for one or more of the “Amounts” (Currency Amount, Amount, Amount3 or Amount4) exceeds the maximum number of decimals defined for the corresponding currency, bu> is less than the general maximum of 3
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Invalid {0}; the maximum number of decimals that the system can accept ({1}) has been exceeded”.
{0} - The amount that exceeds the number of decimals (this may be “Currency Amount”, “Amount”, “Amount3” or “Amount4”)
{1} - the maximum number of decimals that system can accept for field
Scenario_018 - There is no currency definition for one of the amounts included in the JSON file
ElementDetails
Scenario IDScenario_018
Scenario NameThere is no currency definition for one of the amounts included in the JSON file
HTTP Code422
GIVENthat there is a POST API for financial transactions
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDa value other than zero is set in “Amount3” and “Amount4”
BUTno currency is defined for these amounts in the Company information tab for the Company Id set in the JSON file
WHENthe transaction is posted to the transaction resource on the API
THENa 422 response (Unprocessable entity) is returned
ANDthe response contains the error message below for each of the details with a value other than 0 in “Amount3” and “Amount4”
ANDthe transaction is not posted
Example Error Message“Currency not defined for “{0}” in Company Id {1}"
{0} - The amount whose value is different than 0 but which has no corresponding currency definition (this may be “Amount3” or “Amount4”)
{1} - The value of the Company Id set in the JSON file
Scenario_019 - Transaction type does not have treatment code 2, 4 or 5
ElementDetails
Scenario IDScenario_019
Scenario NameTransaction type does not have treatment code 2, 4 or 5
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent, containing the information below
Company IdPeriodTrans DateTrans TypeAccountAmountAmount3Amount4Cur AmountCurrency
EN2019072019-07-21AP1011-160-250-267-2000NOK
EN2019072019-07-21AP62201602502672000NOK
BUTtransaction type AP in Client EN does not have treatment code 2, 4 or 5
WHENthe transaction is posted through “financial-transactions” endpoint
THENa 422 response (Unprocessable entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Invalid Transaction Type; Treatment Code must be one of the following: {0}"
{0} - valid treatment codes for “financial-transactions” endpoint (2, 4, 5)
Scenario_021 - Post or Register a Financial Transaction with customerId and supplierId
ElementDetails
Scenario IDScenario_021
Scenario NamePost or Register a Financial Transaction with customerId and supplierId
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent, containing the information below
Company IdInvoice NumberCustomer IdSupplier IdValue Date
ENAPI-10010002002019-10-08
ENAPI-11010002019-10-08
WHENthe transaction is posted to the transaction resource on the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Provide only a customerId or a supplierId.”
Scenario_022 - Posting a Financial Transaction with both Invoice and PaymentInformation objects
ElementDetails
Scenario IDScenario_022
Scenario NamePosting a Financial Transaction with both Invoice and PaymentInformation objects
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent containing both “Invoice” and “PaymentInformation” objects
WHENthe transaction is posted through “financial-transactions” endpoint
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Provide either an invoice or a paymentInformation object.”
Scenario_024 - Posting a Financial Transaction with both SummaryTaxInformation and TaxTransactionLine information
ElementDetails
Scenario IDScenario_024
Scenario NamePosting a Financial Transaction with both SummaryTaxInformation and TaxTransactionLine information
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent, containing both “summaryTaxInformation” and “taxInformation” information
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“The summaryTaxInformation and taxTransactionLine properties cannot both contain tax information at the same time. Provide a tax information value for one of those properties only.”
Scenario_025 - Posting a Financial Transaction with both SummaryTaxInformation and TaxInput information
ElementDetails
Scenario IDScenario_025
Scenario NamePosting a Financial Transaction with both SummaryTaxInformation and TaxInput information
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent, containing both “summaryTaxInformation” and “taxInput” information
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“The summaryTaxInformation and taxInput properties cannot both contain tax information at the same time. Provide a tax information value for one of those properties only.”
Scenario_026 - Posting a Financial Transaction with a date earlier than 1900-01-01
ElementDetails
Scenario IDScenario_026
Scenario NamePosting a Financial Transaction with a date earlier than 1900-01-01
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
BUTtransactionDate/registeredDate/dueDate/discountDate/valueDate/taxPointDate is equal to or less than 1900-01-01
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Invalid {0}; {0} must be later than 1900-01-01."
{0} - the date field
Scenario_027 - Posting a Financial Transaction with a date later than 2099-12-31
ElementDetails
Scenario IDScenario_027
Scenario NamePosting a Financial Transaction with a date later than 2099-12-31
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
BUTtransactionDate/registeredDate/dueDate/discountDate/valueDate/taxPointDate is equal or more than 2099-12-31
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Invalid {0}; {0} must be earlier than 2099-12-31."
{0} - the date field
Scenario_028 - Posting a Financial Transaction with date not in range of given of GL Period and CHK_VOUCHER_DATE is ON
ElementDetails
Scenario IDScenario_028
Scenario NamePosting a Financial Transaction with date not in range of given of GL Period and CHK_VOUCHER_DATE is ON
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent, containing the information below:
Company IdPeriodTrans DateTrans TypeAccountAmountAmount3Amount4Cur AmountCurrency
EN2019062019-07-06GL2010-100-144-167-100GBP
EN2019062019-07-06GL1001100144167100GBP
BUTGL period definition for 201906 is date from: 2019-06-06 - date to: 2019-06-30
ANDCHK_VOUCHER_DATE is ON
WHENthe transaction is posted through “financial-transactions” endpoint
THENa 422 response (Unprocessable entity) is obtained
ANDthe response contains the error message below:
ANDthe transaction is not posted.
Example Error Message“Invalid Transaction Date;Since CHK_VOUCHER_DATE is ON, Transaction Date must be in the interval 2019-06-01 - 2019-06-30 defined for the GL Period 201906.”
Scenario_029 - Posting cycle is not defined in the client (Company Id)
ElementDetails
Scenario IDScenario_029
Scenario NamePosting cycle is not defined in the client (Company Id)
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent, containing the information below:
Company IdPeriodTrans DateTrans TypeAccountAmountAmount3Amount4Cur AmountCurrency
EN2019062019-06-06GL2010-100-144-167-100GBP
EN2019062019-06-06GL1001100144167100GBP
BUTgiven “Posting cycle” is not defined in client EN
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable entity) is obtained
ANDthe response contains the error message below:
ANDthe transaction is not posted.
Example Error Message“Unknown Posting Cycle”
Scenario_030 - Transaction Series of given Posting Cycle is not same as Transaction Series of given Transaction Type
ElementDetails
Scenario IDScenario_030
Scenario NameTransaction Series of given Posting Cycle is not same as Transaction Series of given Transaction Type
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent, containing the information below:
Company IdPeriodTrans DateTrans TypeAccountAmountAmount3Amount4Cur AmountCurrency
EN2019062019-06-06GL2010-100-144-167-100GBP
EN2019062019-06-06GL1001100144167100GBP
BUTTransaction Series of given Posting Cycle is not same as Transaction Series
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable entity) is obtained
ANDthe response contains the error message below:
ANDthe transaction is not posted.
Example Error Message“Mismatch Transaction Series; Transaction Series of Posting Cycle{0} is not the same as Transaction Series of Transaction Type {1}."
{0} - value of the given Posting cycle
{1} - value of the given Transaction type
Scenario_031 - Fiscal year of given Posting Cycle is not same as Fiscal year of given Period
ElementDetails
Scenario IDScenario_031
Scenario NameFiscal year of given Posting Cycle is not same as Fiscal year of given Period
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent, containing the information below:
Company IdPeriodTrans DateTrans TypeAccountAmountAmount3Amount4Cur AmountCurrency
EN2019062019-06-06GL2010-100-144-167-100GBP
EN2019062019-06-06GL1001100144167100GBP
BUTFiscal year of given Posting Cycle is not same as Fiscal year of given Period
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable entity) is obtained
ANDthe response contains the error message below:
ANDthe transaction is not posted.
Example Error Message“Invalid Posting Cycle; Fiscal Year of Posting Cycle {0} is not same as Fiscal Year of GL Period {1}."
{0} - value of the given Posting cycle
{1} - value of the given Period
Scenario_032 - Posting Cycle has invalid status
ElementDetails
Scenario IDScenario_032
Scenario NamePosting Cycle has invalid status
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent, containing the information below:
Company IdPeriodTrans DateTrans TypeAccountAmountAmount3Amount4Cur AmountCurrency
EN2019062019-06-06GL2010-100-144-167-100GBP
EN2019062019-06-06GL1001100144167100GBP
BUTPosting Cycle has invalid status
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable entity) is obtained
ANDthe response contains the error message below:
ANDthe transaction is not posted.
Example Error Message“Invalid Posting Cycle; Posting Cycle must be in Status N(Active) or P(Period).”
Scenario_033 - Posting a transaction with Posting Cycle in Status P
ElementDetails
Scenario IDScenario_033
Scenario NamePosting a transaction with Posting Cycle in Status P
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent, containing the information below:
Company IdPeriodTrans DateTrans TypeAccountAmountAmount3Amount4Cur AmountCurrency
EN2019062019-06-06GL2010-100-144-167-100GBP
EN2019062019-06-06GL1001100144167100GBP
BUTPosting Cycle has status P
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable entity) is obtained
ANDthe response contains the error message below:
ANDthe transaction is not posted.
Example Error Message“Invalid Posting Cycle; Transaction GL Period {0} must be equal to Posting Cycle GL Period when Posting Cycle status equals P."
{0} - value of the given period
Scenario_034 - Posting a GL Financial Transaction with registration date
ElementDetails
Scenario IDScenario_034
Scenario NamePosting a GL Financial Transaction with registration date
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent, containing the information below:
Company IdPeriodTrans DateTrans TypeAccountAmountAmount3Amount4Cur AmountCurrency
EN2019062019-06-06GL2010-100-144-167-100GBP
EN2019062019-06-06GL1001100144167100GBP
BUTRegistered date is not empty
ANDTransaction Type has a Treatment code other than 1 or 2
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable entity) is obtained
ANDthe response contains the error message below:
ANDthe transaction is not posted.
Example Error Message“Invalid Registered Date; Registered Date can only be provided with Treatment Code {0}."
{0} - value of the Treatment Code
Scenario_035 - Registering a Financial Transaction with registered transaction number
ElementDetails
Scenario IDScenario_035
Scenario NameRegistering a Financial Transaction with registered transaction number
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent, containing the information below:
Company IdPeriodTrans DateTrans TypeAccountAmountAmount3Amount4Cur AmountCurrency
EN2019062019-06-06GL2010-100-144-167-100GBP
EN2019062019-06-06GL1001100144167100GBP
BUTRegistered Transaction Number is not empty
WHENthe transaction is posted through “financial-transactions” endpoint
THENa 422 response (Unprocessable entity) is obtained
ANDthe response contains the error message below:
ANDthe transaction is not posted.
Example Error Message“Invalid Registered Transaction Number; Registered Transaction Number must be empty.”
Scenario_036 - Posting a Financial Transaction with registered transaction number
ElementDetails
Scenario IDScenario_036
Scenario NamePosting a Financial Transaction with registered transaction number
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent, containing the information below:
Company IdPeriodTrans DateTrans TypeAccountAmountAmount3Amount4Cur AmountCurrency
EN2019062019-06-06GL2010-100-144-167-100GBP
EN2019062019-06-06GL1001100144167100GBP
BUTRegistered Transaction Number is not empty
ANDTreatment Code is not 2
WHENthe transaction is posted through “financial-transactions” endpoint
THENa 422 response (Unprocessable entity) is obtained
ANDthe response contains the error message below:
ANDthe transaction is not posted.
Example Error Message“Invalid Registered Transaction Number; Registered Transaction Number can only be provided with Treatment Code 2.”
Scenario_038 - Posting a Financial Transaction without invoice section for treatment code 2 or 5
ElementDetails
Scenario IDScenario_038
Scenario NamePosting a Financial Transaction without invoice section for treatment code 2 or 5
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDTreatment code in (2,5)
ANDobject invoice is not provided
WHENthe transaction is posted through “financial-transactions” endpoint
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Invoice section is required for given Transaction Type (treatment code 2 or 5).”
Scenario_040 - Posting a Financial Transaction with more than InvoiceNumber and (customerId or supplierId) fields for treatment code 4
ElementDetails
Scenario IDScenario_040
Scenario NamePosting a Financial Transaction with more than InvoiceNumber and (customerId or supplierId) fields for treatment code 4
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDTreatment code = 4
ANDthe invoice object contains at least one of the following fields: creditTerms, discountCurrencyAmount, discountDate, discountPercentage, dueDate, paymentCurrency, paymentMethod, paymentRecipient, responsible, vatRegistrationNumber
WHENthe transaction is posted through “financial-transactions” endpoint
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Invoice section can only contain InvoiceNumber and (customerId or supplierId) for given Transaction Type (treatment code 4).”
Scenario_041 - Posting a Financial Transaction without customerId or supplierId
ElementDetails
Scenario IDScenario_041
Scenario NamePosting a Financial Transaction without customerId or supplierId
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDInvoice number is provided
ANDcustomerId and supplierId are not provided
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“customerId or supplierId is required.”
Scenario_042 - Invoice number already exists for given Company
ElementDetails
Scenario IDScenario_042
Scenario NameInvoice number already exists for given Company
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDInvoice number is provided
ANDcustomerId is provided
ANDSystem parameter CU_CHK_EXT_INV_REF is ON, value = null
BUTInvoice number already exists within the company
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDInvoice number is provided
ANDcustomerId is provided
ANDSystem parameter CU_CHK_EXT_INV_REF is ON, value = 1
BUTInvoice number already exists within the company per fiscal year
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Invoice number already exists for given CompanyID; system parameter CU_CHK_EXT_INV_REF is active."
“Invoice number already exists for given CompanyID and fiscal year; system parameter CU_CHK_EXT_INV_REF is active with value = 1.”
Scenario_043 - Invoice number already exists for given Company and supplierId
ElementDetails
Scenario IDScenario_043
Scenario NameInvoice number already exists for given Company and supplierId
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDInvoice number is provided
ANDsupplierId is provided
ANDSystem parameter SU_CHK_EXT_INV_REF is ON, value = null
BUTInvoice number already exists within the company for given supplierId
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDInvoice number is provided
ANDsupplierId is provided
ANDSystem parameter SU_CHK_EXT_INV_REF is ON, value = 1
BUTInvoice number already exists within the company for given supplierId per fiscal year
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Invoice number already exists for given CompanyID and SupplierID; system parameter SU_CHK_EXT_INV_REF is active."
“Invoice number already exists for given CompanyID, SupplierID and fiscal year; system parameter SU_CHK_EXT_INV_REF is active with value = 1.”
Scenario_044 - Payment method does not exist for given Company
ElementDetails
Scenario IDScenario_044
Scenario NamePayment method does not exist for given Company
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDPayment method is provided
BUTPayment method is not defined in UBW
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Unknown Payment method.”
Scenario_045 - Payment method is not active for given Company
ElementDetails
Scenario IDScenario_045
Scenario NamePayment method is not active for given Company
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDPayment method is provided
ANDPayment method is defined in UBW
BUTPayment method is not active (N)
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Invalid Payment method; status must be N (Active).”
Scenario_046 - Payment method is different than defined in given customerId or supplierId
ElementDetails
Scenario IDScenario_046
Scenario NamePayment method is different than defined in given customerId or supplierId
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDPayment method is provided
ANDcustomerId or supplierId is provided
ANDPayment method for given customer or supplier is FIXED
BUTPayment method from transaction document is not equal to payment method defined in customer or supplier
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Invalid Payment method; for {0} {1} payment method is fixed and must be {2}."
{0} - customerId or supplierId
{1} - customerId or supplierId value set in the JSON file
{2} - Payment method defined for given customerId or supplierId
Scenario_047 - Posting a Financial Transaction when Account Rule is NOT active
ElementDetails
Scenario IDScenario_047
Scenario NamePosting a Financial Transaction when Account Rule is NOT active
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
BUTAccount Rule is NOT Active
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Invalid Account Rule; Status must be N (Active).”
Scenario_048 - Posting a Financial Transaction when Mandatory ID in Account Rule is NOT provided
ElementDetails
Scenario IDScenario_048
Scenario NamePosting a Financial Transaction when Mandatory ID in Account Rule is NOT provided
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
BUTMandatory Attribute ID is not provided
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Invalid Attribute ID; {0} is/are mandatory Attribute ID(s)."
{0} - list of missing Attribute IDs
Scenario_049 - Posting a Financial Transaction when Attribute ID is not in Account Rule
ElementDetails
Scenario IDScenario_049
Scenario NamePosting a Financial Transaction when Attribute ID is not in Account Rule
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
BUTAttribute ID is not in account rule
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Invalid Attribute ID; {(Extra) Attribute ID } is not defined in Account Rule."
{0} - Attribute IDs not defined in Account rule
Scenario_050 - Posting a Financial Transaction when dupicate Attribute ID is provided
ElementDetails
Scenario IDScenario_050
Scenario NamePosting a Financial Transaction when dupicate Attribute ID is provided
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
BUTDuplicate Attrtibute ID is provided
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Duplicate Attribute {0}; Only one Instance per Attribute ID can be provided."
{0} - Attribute ID being duplicated
Scenario_051 - Posting a Financial Transaction when value without attribute is provided
ElementDetails
Scenario IDScenario_051
Scenario NamePosting a Financial Transaction when value without attribute is provided
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
BUTAttribute value without an Attribute ID is provided
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Invalid Attribute Value; Value without an Attribute ID provided, Attribute Value must have corresponding Attribute ID.”
Scenario_052 - 'Value' is provided and not selected on account rule
ElementDetails
Scenario IDScenario_052
Scenario Name‘Value’ is provided and not selected on account rule
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
BUT‘Value’ is provided and not selected on account rule
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Invalid Value: Value field is not selected for this Account Rule.”
Scenario_053 - 'Number' is provided and not selected on account rule
ElementDetails
Scenario IDScenario_053
Scenario Name‘Number’ is provided and not selected on account rule
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
BUT‘Number’ is provided and not selected on account rule
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Invalid Number: Number field is not selected for this Account Rule.”
Scenario_054 - 'Description/Text on Invoice' is provided and not selected on account rule
ElementDetails
Scenario IDScenario_054
Scenario Name‘Description/Text on Invoice’ is provided and not selected on account rule
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
AND‘Text on Invoice’ is NOT selected on account rule
BUT‘Description’ is provided
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Invalid Description: Text on invoice field is not selected for this Account Rule.”
Scenario_055 - Provided attribute is not in Category 1-7
ElementDetails
Scenario IDScenario_055
Scenario NameProvided attribute is not in Category 1-7
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
BUTProvided Attribute ID is not in Category 1-7
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Invalid Attribute ID; Attribute category must be 1-7.”
Scenario_056 - Attribute Value for Mandatory Attribute ID is not provided
ElementDetails
Scenario IDScenario_056
Scenario NameAttribute Value for Mandatory Attribute ID is not provided
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDAttribute value is NOT provided
BUTAttribute is Mandatory on Account Rule
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Invalid Attribute Value; Attribute Value for {0} is Mandatory."
{0} - Mandatory Attribute ID
Scenario_057 - Attribute ID with with maintenance of Manual/Automatic is provided with non existing value
ElementDetails
Scenario IDScenario_057
Scenario NameAttribute ID with with maintenance of Manual/Automatic is provided with non existing value
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDMaintenance is Manual/Automatic
ANDValue doesn’t exist in the system
BUTAttribute is Mandatory on Account Rule
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Invalid Attribute Value; Attribute Value for {0} must exist in the system."
{0} - Mandatory Attribute ID
Scenario_058 - Attribute value for an attribute with User input Fixed does not match the value which would be autocompleted
ElementDetails
Scenario IDScenario_058
Scenario NameAttribute value for an attribute with User input Fixed does not match the value which would be autocompleted
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDuser has provided an Analytical Information Attribute (Category 1 - 7) Value
ANDAttribute has User Input as Fixed on the Account Rule
BUTAttribute value sent by user is not equal to the Attribute value which would be autocompleted
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Invalid attribute value; attribute {0} is fixed in the account rule and its value must be equal to {1}"
{0} - Attribute ID
{1} - the value we would get if we applied code completion
Scenario_059 - Attribute ID with maintenace of Manual/Automatic is provided with a value which is NOT active
ElementDetails
Scenario IDScenario_059
Scenario NameAttribute ID with maintenace of Manual/Automatic is provided with a value which is NOT active
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDProvided value is NOT active
BUTAttribute maintenace is Manual or Automatic
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Invalid Attribute Value; Status must be N (Active).”
Scenario_060 - Attribute ID with maintenace of Manual/Automatic is provided with a value which is NOT valid for given Period
ElementDetails
Scenario IDScenario_060
Scenario NameAttribute ID with maintenace of Manual/Automatic is provided with a value which is NOT valid for given Period
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDProvided value is not valid for given Period
BUTAttribute maintenace is Manual or Automatic
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Invalid Attribute Value; Period control is on and Attribute Value is not valid for this Period {period}.”
Scenario_061 - Attribute ID with maintenace of Optional is provided with a value which exceeds the length
ElementDetails
Scenario IDScenario_061
Scenario NameAttribute ID with maintenace of Optional is provided with a value which exceeds the length
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDProvided value exceeds the Attribute length
BUTAttribute maintenace is Optional
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Invalid Attribute Value; Length of given Attribute Value exceeds the maximum allowed length ({0}) for this Attribute ID."
{0} - length of the Attribute
Scenario_062 - Attribute ID with maintenace of Optional is provided with a value which violates data type
ElementDetails
Scenario IDScenario_062
Scenario NameAttribute ID with maintenace of Optional is provided with a value which violates data type
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDProvided value is not in numeric type
BUTAttribute maintenace is Optional
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Invalid Attribute Value; Attribute Value must be of numeric type.”
Scenario_063 - Attribute ID with maintenace of Optional is provided with a value which contains special characters
ElementDetails
Scenario IDScenario_063
Scenario NameAttribute ID with maintenace of Optional is provided with a value which contains special characters
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDProvided value contains special characters
BUTAttribute maintenace is Optional
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Invalid Attribute value. It contains one of the special characters that are not allowed ({0})."
{0} - special characters (Space, percentage sign (%), wildcard (*), square brackets ([]), question mark(?), apostrophe(’))
Scenario_064 - customerId does not exist for given Company
ElementDetails
Scenario IDScenario_064
Scenario NamecustomerId does not exist for given Company
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDcustomerId is provided
BUTcustomerId is not defined in UBW
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Unknown {0}."
{0} - customerId
Scenario_065 - customerId is not active or parked for given Company
ElementDetails
Scenario IDScenario_065
Scenario NamecustomerId is not active or parked for given Company
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDcustomerId is provided
BUTcustomerId status is not active (N) or parked (P)
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Invalid {0}; status must be N (Active) or P (Parked)."
{0} - supplierId
Scenario_066 - supplierId does not exist for given Company
ElementDetails
Scenario IDScenario_066
Scenario NamesupplierId does not exist for given Company
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDsupplierId is provided
BUTsupplierId is not defined in UBW
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Unknown {0}."
{0} - supplierId
Scenario_067 - supplierId is not active or parked for given Company
ElementDetails
Scenario IDScenario_067
Scenario NamesupplierId is not active or parked for given Company
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDsupplierId is provided
BUTsupplierId status is not active (N) or parked (P)
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Invalid {0}; status must be N (Active) or P (Parked)."
{0} - supplierId
Scenario_069 - Posting a Financial Transaction with customerId and Treatment code 2
ElementDetails
Scenario IDScenario_069
Scenario NamePosting a Financial Transaction with customerId and Treatment code 2
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDTreatment code = 2
ANDcustomerId is provided
WHENthe transaction is posted through “financial-transactions” endpoint
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“customerId is not allowed for given Transaction Type (treatment code 2); Provide supplierId.”
Scenario_070 - Posting a Financial Transaction with supplierId and Treatment code 5
ElementDetails
Scenario IDScenario_070
Scenario NamePosting a Financial Transaction with supplierId and Treatment code 5
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDTreatment code = 5
ANDsupplierId is provided
WHENthe transaction is posted through “financial-transactions” endpoint
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“supplierId is not allowed for given Transaction Type (treatment code 5); Provide customerId.”
Scenario_071 - Credit terms does not exist for given Company
ElementDetails
Scenario IDScenario_071
Scenario NameCredit terms does not exist for given Company
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDCredit terms is provided
BUTCredit terms is not defined in UBW
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Unknown Credit Terms.”
Scenario_072 - Credit terms is different than defined in given CustomerId or SupplierId
ElementDetails
Scenario IDScenario_072
Scenario NameCredit terms is different than defined in given CustomerId or SupplierId
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDCredit terms is provided
ANDCredit terms for given customer or supplier is FIXED
BUTCredit terms from transaction document is not equal to Credit terms defined in customer or supplier
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Invalid Credit Terms; for {0} {1} credit terms is fixed and must be {2}."
{0} - CustomerID or SupplierID
{1} - CustomerID or SupplierID value set in the JSON file
{2} - Credit terms defined for given CustomerID or SupplierID
Scenario_073 - Payment currency does not exist for given Company
ElementDetails
Scenario IDScenario_073
Scenario NamePayment currency does not exist for given Company
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDPayment currency is provided
BUTPayment currency is not defined in UBW
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Unknown Payment currency.”
Scenario_074 - Payment recipient does not exist for given Company
ElementDetails
Scenario IDScenario_074
Scenario NamePayment recipient does not exist for given Company
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDPayment recipient is provided
BUTPayment recipient is not defined in UBW
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Unknown Payment recipient.”
Scenario_075 - Payment recipient is not active for given Company
ElementDetails
Scenario IDScenario_075
Scenario NamePayment recipient is not active for given Company
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDPayment recipient is provided
BUTPayment recipient status is not active (N) or parked (P)
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Invalid Payment recipient; status must be N (Active) or P (Parked).”
Scenario_076 - Payment recipient is different than defined in given CustomerId or SupplierId
ElementDetails
Scenario IDScenario_076
Scenario NamePayment recipient is different than defined in given CustomerId or SupplierId
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDPayment recipient is provided
ANDPayment recipient for given customer or supplier is FIXED
BUTPayment recipient from transaction document is not equal to Payment recipient defined in customer or supplier
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Invalid Payment recipient; for {0} {1} payment recipient is fixed and must be {2}."
{0} - CustomerID or SupplierID
{1} - CustomerID or SupplierID value set in the JSON file
{2} - Payment recipient value defined for given CustomerID or SupplierID
Scenario_077 - CustomerId or SupplierId is different than defined in given Payment recipient
ElementDetails
Scenario IDScenario_077
Scenario NameCustomerId or SupplierId is different than defined in given Payment recipient
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDPayment recipient is provided
ANDCustomerId or SupplierId for given Payment recipient is FIXED
BUTCustomerId or SupplierId from transaction document is not equal to CustomerId or SupplierId defined in Payment recipient
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Invalid {0}; for payment recipient {1} {0} is fixed and must be {2}."
{0} - CustomerID or SupplierID
{1} - Payment recipient value set in the JSON file
{2} - CustomerID or SupplierID value defined for a given Payment recipient
Scenario_078 - Posting a Financial Transaction without InvoiceNumber
ElementDetails
Scenario IDScenario_078
Scenario NamePosting a Financial Transaction without InvoiceNumber
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDobject invoice is provided
BUTInvoice number is not provided
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“The InvoiceNumber field is required.”
Scenario_079 - Responsible is not defined in UBW as a user
ElementDetails
Scenario IDScenario_079
Scenario NameResponsible is not defined in UBW as a user
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDResponsible is provided
BUTResponsible is not defined in UBW as a user
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Unknown responsible.”
Scenario_080 - Responsible user status is not Active (N)
ElementDetails
Scenario IDScenario_080
Scenario NameResponsible user status is not Active (N)
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDResponsible is provided
BUTResponsible user status is not Active (N)
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Invalid responsible; status must be N (Active).”
Scenario_081 - Responsible user is not assigned to role selected in general responsible setup
ElementDetails
Scenario IDScenario_081
Scenario NameResponsible user is not assigned to role selected in general responsible setup
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDResponsible is provided
BUTResponsible user is not assigned to the role selected in the general responsible setup
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Invalid responsible; user {0} is not assigned to role {1} chosen in general responsible setup."
{0} - responsible
{1} - responsible role chosen in general responsible setup in UBW
Scenario_082 - There is no role selected in general responsible setup
ElementDetails
Scenario IDScenario_082
Scenario NameThere is no role selected in general responsible setup
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDResponsible is provided
BUTThere is no role selected in the general responsible setup
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Invalid responsible; there is no role chosen in general responsible setup, no user can be selected.”
Scenario_083 - Responsible user does not have connected resource ID
ElementDetails
Scenario IDScenario_083
Scenario NameResponsible user does not have connected resource ID
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDResponsible is provided
BUTResponsible user does not have connected resource ID
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Invalid responsible; user {0} does not have a connected resource ID.”
Scenario_084 - System parameter OPTIONAL_RESPONSIBLE is not active
ElementDetails
Scenario IDScenario_084
Scenario NameSystem parameter OPTIONAL_RESPONSIBLE is not active
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDResponsible is provided
BUTSystem parameter OPTIONAL_RESPONSIBLE is not active
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Invalid value for responsible; responsible is mandatory because system parameter OPTIONAL_RESPONSIBLE is not active.”
Scenario_086 - Account type is not GL for a transaction with treatment code 4
ElementDetails
Scenario IDScenario_086
Scenario NameAccount type is not GL for a transaction with treatment code 4
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDTC = 4
ANDAccount is provided
BUTAccount type is not GL
WHENthe transaction is posted through “financial-transactions” endpoint
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Invalid account; account type must be “GL” for a transaction type with treatment code 4.”
Scenario_088 - Transaction has zero or more than one line with account type AP for treatment code 2
ElementDetails
Scenario IDScenario_088
Scenario NameTransaction has zero or more than one line with account type AP for treatment code 2
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDTC = 2
ANDAccount is provided
BUTtransaction has zero or more than one line with account type AP
WHENthe transaction is posted through “financial-transactions” endpoint
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Invalid transaction details; transaction must contain one detail line with account type “AP” for transaction type with treatment code 2.”
Scenario_090 - Account type is AR for a transaction with treatment code 2
ElementDetails
Scenario IDScenario_090
Scenario NameAccount type is AR for a transaction with treatment code 2
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDTC = 1
ANDAccount is provided
BUTAccount type is AR
WHENthe transaction is posted through “financial-transactions” endpoint
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Invalid transaction details; details with account type “AR” are not accepted for transaction types with treatment code 2.”
Scenario_091 - Transaction has zero or more than one line with account type AR for treatment code 5
ElementDetails
Scenario IDScenario_091
Scenario NameTransaction has zero or more than one line with account type AR for treatment code 5
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDTC = 5
ANDAccount is provided
BUTtransaction has zero or more than one line with account type AR
WHENthe transaction is posted through “financial-transactions” endpoint
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Invalid transaction details; transaction must contain one detail line with account type “AR” for transaction type with treatment code 5.”
Scenario_092 - Account type is AP for a transaction with treatment code 5
ElementDetails
Scenario IDScenario_092
Scenario NameAccount type is AP for a transaction with treatment code 5
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDTC = 5
ANDAccount is provided
BUTAccount type is AP
WHENthe transaction is posted through “financial-transactions” endpoint
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Invalid transaction details; details with account type “AP” are not accepted for transaction types with treatment code 5.”
Scenario_093 - Exchange rate does not exist for the currency type defined in account rule for amount/amount3 currency
ElementDetails
Scenario IDScenario_093
Scenario NameExchange rate does not exist for the currency type defined in account rule for amount/amount3 currency
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDcurrencyCode is provided
BUTfor the transaction date, exchange rate does not exist for the currency type defined in account rule for amount/amount3 currency
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“No Exchange rate found for {0} in currency type “{1}” date {2} to calculate {3}, amount currency type is defined with the account rule of the GL account."
{0} - Currency code
{1} - Currency type
{2} - voucher date
{3} - the amount we are calculating (amount or amount3 or amount4)
Scenario_094 - Exchange rate does not exist for the currency type defined in company information for amount4 currency
ElementDetails
Scenario IDScenario_094
Scenario NameExchange rate does not exist for the currency type defined in company information for amount4 currency
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDcurrencyCode is provided
BUTfor the transaction date, exchange rate does not exist for the currency type defined in company information for amount4 currency
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“No Exchange rate found for {0} in currency type “{1}” date {2} to calculate {3}, amount currency type is defined in company information."
{0} - Currency code
{1} - Currency type
{2} - voucher date
{3} - The amount we are calculating (amount or amount3 or amount4)
Scenario_095 - Amounts are not provided in all details - amounts instances
ElementDetails
Scenario IDScenario_095
Scenario NameAmounts are not provided in all details - amounts instances
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDamount/amount3/amount4 is provided
BUTamount/amount3/amount4 is not provided in all details - amounts instances (including the SecondaryOpenItems section)
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Invalid Transaction details; {0} must be provided in all or none of the “amounts” sections”
{0} - The amount we are validating
Scenario_096 - Posting a Financial Transaction when User input for Attribute is No check and the provided Attribute Value exceeds the maximum length
ElementDetails
Scenario IDScenario_096
Scenario NamePosting a Financial Transaction when User input for Attribute is No check and the provided Attribute Value exceeds the maximum length
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with the “registered-financial-transactions” or “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDprovided value exceeds the Attribute length
BUTAttribute User input is No check
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Invalid Attribute Value; Length of given Attribute value exceeds the maximum allowed length ({0}) for this Attribute ID."
{0} - length of the Attribute
Scenario_097 - Posting a Financial Transaction when User input for Attribute is No check and the provided Attribute Value violates data type
ElementDetails
Scenario IDScenario_097
Scenario NamePosting a Financial Transaction when User input for Attribute is No check and the provided Attribute Value violates data type
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDprovided value is not of numeric type
BUTAttribute User input is No check
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Invalid Attribute Value; Attribute Value must be of numeric type.”
Scenario_098 - Posting a Financial Transaction when User input for Attribute is No check and the provided Attribute Value contains special characters
ElementDetails
Scenario IDScenario_098
Scenario NamePosting a Financial Transaction when User input for Attribute is No check and the provided Attribute Value contains special characters
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDprovided value contains special characters
BUTAttribute User input is No check
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Invalid Attribute value. It contains one of the special characters that are not allowed ({0})."
{0} - Special characters (Space, percentage sign (%), wildcard (*), square brackets ([]), question mark(?), apostrophe(’))
Scenario_099 - Value matrix does not find a fixed attribute value
ElementDetails
Scenario IDScenario_099
Scenario NameValue matrix does not find a fixed attribute value
HTTP Code422
GIVENa Financial Transaction to be posted or registered
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDthe existing valid account rule associated with the existing valid account in transaction contains the existing valid attribute with User input Fixed and auto-completion determined by the existing validMatrix
ANDmatrix does not find an attribute value
WHENthe transaction is posted through API’s transaction resource
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Invalid Attribute Value; {0} is/are fixed Attribute ID(s) and no valid value can be found in the value matrix."
{0} - Attribute Id
Scenario_100 - Direct relation does not find a fixed attribute value
ElementDetails
Scenario IDScenario_100
Scenario NameDirect relation does not find a fixed attribute value
HTTP Code422
GIVENa Financial Transaction to be posted or registered
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDthe existing valid account rule associated with the existing valid account in transaction contains the existing valid attribute with User input Fixed and autocompletion determined by the existing valid Direct Relation (Owner)
ANDdirect relation does not find an attribute value
WHENthe transaction is posted through the API’s transaction resource
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Invalid Attribute value. {0} is/are fixed Attribute ID(s) and cannot be autocompleted through its owner attribute."
{0} - Attribute Id
Scenario_101 - Amount/amount3/amount4 is not provided in taxinformation - taxinput - taxamounts section
ElementDetails
Scenario IDScenario_101
Scenario NameAmount/amount3/amount4 is not provided in taxinformation - taxinput - taxamounts section
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDamount/amount3/amount4 is provided in details - amounts section
BUTamount/amount3/amount4 is not provided in taxinformation - taxinput - taxamounts section
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Invalid amounts; {0} must be provided in the amounts section in both details and taxInput or must not be provided at all."
{0} - the amount we are validating
Scenario_102 - Amount/amount3/amount4 is not provided in summaryTaxInformation - amounts section
ElementDetails
Scenario IDScenario_102
Scenario NameAmount/amount3/amount4 is not provided in summaryTaxInformation - amounts section
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDevery instance of summaryTaxInformation has detail instance, sharing the same taxCode and taxSystem
ANDamount/amount3/amount4 is provided in details - amounts section
BUTamount/amount3/amount4 is not provided in summaryTaxInformation - amounts section
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Invalid amounts; {0} must be provided in the amounts section in both details and SummaryTaxInformation or must not be provided at all."
{0} - the amount we are validating
Scenario_103 - There is no transaction line which contains the same combination of taxCode and taxSystem
ElementDetails
Scenario IDScenario_103
Scenario NameThere is no transaction line which contains the same combination of taxCode and taxSystem
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDtaxCode and taxSystem in summaryTaxInformation section are provided
BUTthere is no transaction line which contains the same combination of taxCode and taxSystem
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“No taxInformation can be found for taxCode/taxSystem {0}/{1} in any of the details."
{0} - taxCode provided in JSON in summaryTaxInformation section
{1} - taxSystem provided in JSON in summaryTaxInformation section
Scenario_104 - There is no summaryTaxInformation with a taxCode/tax system combination provided in one of the details different than 0/whatever
ElementDetails
Scenario IDScenario_104
Scenario NameThere is no summaryTaxInformation with a taxCode/tax system combination provided in one of the details different than 0/whatever
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDsummaryTaxInformation section is provided
BUTthere is no summaryTaxInformation with a taxCode/tax system combination provided in one of the details different than 0/whatever
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“No data can be found for taxCode/taxSystem {0}/{1} in summaryTaxInformation."
{0} - taxCode provided in JSON in the details section
{1} - taxSystem provided in JSON in the details section
Scenario_105 - The same combination of taxCode/taxSystem is dupicated in summaryTaxInformation
ElementDetails
Scenario IDScenario_105
Scenario NameThe same combination of taxCode/taxSystem is dupicated in summaryTaxInformation
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDsummaryTaxInformation section is provided
BUTthe same combination of taxCode/taxSystem is dupicated in summaryTaxInformation
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Invalid summaryTaxInformation; there are more than one sets of data for the same combination of taxCode/taxSystem {0}/{1}."
{0} - taxCode provided in JSON in the summaryTaxInformation section
{1} - taxSystem provided in JSON in the summaryTaxInformation section
Scenario_106 - vatPercentage and currencyAmount in summaryTaxInformation section are not provided
ElementDetails
Scenario IDScenario_106
Scenario NamevatPercentage and currencyAmount in summaryTaxInformation section are not provided
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
BUTvatPercentage and currencyAmount in the summaryTaxInformation section are not provided
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“vatPercentage or currencyAmount is required in every set of summaryTaxInformation.”
Scenario_107 - CurrencyAmount/amount/amount3/amount4 is not provided in all summaryTaxInformation instances
ElementDetails
Scenario IDScenario_107
Scenario NameCurrencyAmount/amount/amount3/amount4 is not provided in all summaryTaxInformation instances
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDcurrencyAmount/amount/amount3/amount4 in summaryTaxInformation is provided
BUTcurrencyAmount/amount/amount3/amount4 is not provided in all summaryTaxInformation instances
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Invalid summaryTaxInformation; if {0} is to be provided, it has to be provided in all summaryTaxInformation set of data."
{0} - the amount we are validating (currencyAmount or amount or amount3 or amount4)
Scenario_108 - Amount/amount3/amount4 is not provided in details - amount section for the same taxCode/taxSystem combination
ElementDetails
Scenario IDScenario_108
Scenario NameAmount/amount3/amount4 is not provided in details - amount section for the same taxCode/taxSystem combination
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDamount/amount3/amount4 in summaryTaxInformation is provided
BUTamount/amount3/amount4 is not provided in details - amount section for the same taxCode/taxSystem combination
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Invalid amounts; {0} has been provided in summaryTaxInformation for taxCode/taxSystem {1}/{2} and it is missing on here."
{0} - the amount we are validating
{1} - the value of Tax code from summaryTaxInformation
{2} - the value of Tax system from summaryTaxInformation
Scenario_109 - CurrencyAmount in summaryTaxInformation is not provided
ElementDetails
Scenario IDScenario_109
Scenario NameCurrencyAmount in summaryTaxInformation is not provided
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDamount/amount3/amount4 in summaryTaxInformation is provided
BUTcurrencyAmount in summaryTaxInformation is not provided
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Invalid summaryTaxInformation; if amounts are to be provided, currencyAmount is required.”
Scenario_110 - VatPercentage is not provided in all summaryTaxInformation instances
ElementDetails
Scenario IDScenario_110
Scenario NameVatPercentage is not provided in all summaryTaxInformation instances
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDvatPercentage in summaryTaxInformation is provided
BUTvatPercentage is not provided in all summaryTaxInformation instances
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Invalid summaryTaxInformation; if vatPercentage is to be provided, it has to be provided in all summaryTaxInformation set of data.”
Scenario_111 - VatPercentage is provided in details - amount section for the same taxCode/taxSystem combination
ElementDetails
Scenario IDScenario_111
Scenario NameVatPercentage is provided in details - amount section for the same taxCode/taxSystem combination
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDvatPercentage in summaryTaxInformation is provided
BUTvatPercentage is provided in details - amount section for the same taxCode/taxSystem combination
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Invalid vatPercentage; vatPercentage has been provided in summaryTaxInformation for taxCode/taxSystem (0}/{1} and cannot be provided here."
{0} - value of Tax code from summaryTaxInformation
{1} - value of Tax system from summaryTaxInformation
Scenario_112 - The number of decimals for vatPercentage exceeds 8, which is the maximum defined for vatPercentage
ElementDetails
Scenario IDScenario_112
Scenario NameThe number of decimals for vatPercentage exceeds 8, which is the maximum defined for vatPercentage
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDthe number of decimals for vatPercentage exceeds 8, which is the maximum defined for vatPercentage
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Invalid {0}; the number of decimals exceeds the maximum number of decimals allowed ({1})."
{0} - The amount that exceeds the number of decimals (vatPercentage)
{1} - the maximum number of decimals that system can accept for field
Scenario_113 - Currency is not defined for amount3/amount4 in the company information
ElementDetails
Scenario IDScenario_113
Scenario NameCurrency is not defined for amount3/amount4 in the company information
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDamount3/amount4 is provided
BUTcurrency for amount3/amount4 is not defined in company information
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“The currency code is not defined for {0} in the company information table. Please define one."
{0} - amount3 or amount4
Scenario_114 - CurrencyCode value do not matching value determined for the Account Rule
ElementDetails
Scenario IDScenario_114
Scenario NameCurrencyCode value do not matching value determined for the Account Rule
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDcurrencyCode is provided
ANDcurrencyCode has User input as Fixed in the account rule
BUTprovided the currencyCode value is not the same as the one determined for the account rule
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Invalid {0}; {0} is fixed in the account rule and it must be {1}."
{0} - the tag we are validating, currencyCode in this case.
{1} - the value we would get if we applied code completion.
Scenario_115 - CurrencyCode value do not matching value determined for the Supplier
ElementDetails
Scenario IDScenario_115
Scenario NameCurrencyCode value do not matching value determined for the Supplier
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDcurrencyCode is provided
ANDcurrencyCode has User input as Mandatory in the Account rule
ANDcurrencyCode is flagged as Fixed for the supplier
BUTprovided the currencyCode value is not the same as the one determined for the supplier
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Invalid {0}; {0} is fixed for the supplier and it must be {1}."
{0} - the tag we are validating, currencyCode in this case.
{1} - the value we would get if we applied code completion. The value for the supplier.
Scenario_116 - CurrencyCode value do not matching value determined for the Customer
ElementDetails
Scenario IDScenario_116
Scenario NameCurrencyCode value do not matching value determined for the Customer
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDcurrencyCode is provided
ANDcurrencyCode has User input as Mandatory in the account rule
ANDcurrencyCode is flagged as Fixed for the customer
BUTprovided the currencyCode value is not the same as the one determined for the customer
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Invalid {0}; {0} is fixed for the customer and it must be {1}."
{0} - the tag we are validating, currencyCode in this case.
{1} - the value we would get if we applied code completion. The value for the customer.
Scenario_117 - CurrencyCode value cannot be determined through its Owner Attribute
ElementDetails
Scenario IDScenario_117
Scenario NameCurrencyCode value cannot be determined through its Owner Attribute
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDcurrencyCode is not provided
ANDcurrencyCode has User input as Fixed in the account rule
ANDcurrencyCode value is determined for the owner attribute
BUTthe currencyCode value cannot be autocompleted through its owner attribute
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Invalid {0}; {0} is fixed in the account rule and it cannot be autocompleted through its owner attribute."
{0} - the tag we are validating, currencyCode in this case.
Scenario_118 - CurrencyCode value cannot be found in the Value Matrix
ElementDetails
Scenario IDScenario_118
Scenario NameCurrencyCode value cannot be found in the Value Matrix
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDcurrencyCode is not provided
ANDcurrencyCode has User Input as Fixed in the Account Rule
ANDcurrencyCode value is determined for the Value Matrix
BUTthe currencyCode value cannot be autocompleted through the value matrix
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Invalid {0}; {0} is fixed in the account rule and no value can be found in the value matrix."
{0} - the tag we are validating, currencyCode in this case.
Scenario_119 - CurrencyCode value cannot be determined, so validation cannot be evaluated
ElementDetails
Scenario IDScenario_119
Scenario NameCurrencyCode value cannot be determined, so validation cannot be evaluated
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDcurrencyCode is provided
ANDcurrencyCode has User input as Fixed in the account rule
BUTthe currencyCode value cannot be determined for the account rule
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Invalid {0}; it is impossible to determine if the {0} is valid according to the current account rule."
{0} - the tag we are validating, currencyCode in this case.
Scenario_120 - CurrencyCode value not provided and autocompletion is not possible
ElementDetails
Scenario IDScenario_120
Scenario NameCurrencyCode value not provided and autocompletion is not possible
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDcurrencyCode is not provided
ANDcurrencyCode has User input as Mandatory in the account rule
BUTthe currencyCode value cannot be determined for the account rule
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Invalid {0}; {0} is mandatory."
{0} - currencyCode
Scenario_121 - Attribute Value for an Attribute with User Input Fixed cannot be evaluated as autocompletion is not possible
ElementDetails
Scenario IDScenario_121
Scenario NameAttribute Value for an Attribute with User Input Fixed cannot be evaluated as autocompletion is not possible
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDthe user has provided an Analytical Information Attribute (Category 1 - 7) Value
ANDAttribute has User input as Fixed in the account rule
BUTAttribute value sent by the user cannot be compared with the value which would be autocompleted as autocompletion is not possible - there is no owner value or Value Matrix is not completed and there is no default value.
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Invalid attribute value; attribute {0} is fixed in the account rule and it is impossible to determine if the value sent is valid."
{0} - Attribute ID
Scenario_122 - Amount/amount3/amount4 is defined in the company information but the currency does not exist
ElementDetails
Scenario IDScenario_122
Scenario NameAmount/amount3/amount4 is defined in the company information but the currency does not exist
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDamount/amount3/amount4 is defined in company information
BUTthe Currency code defined does not exist in the system
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Currency code {0} defined in company information does not exist."
{0} - amount, amount3 or amount4
Scenario_123 - Currency code is not equal in every details - amounts section where the tax code <> 0
ElementDetails
Scenario IDScenario_123
Scenario NameCurrency code is not equal in every details - amounts section where the tax code <> 0
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDsummaryTaxInformation section is provided
BUTCurrency code is not equal in every details - amounts section where the tax code <> 0
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Invalid currencyCode; if summaryTaxInformation is provided, the same Currency code must be used in all transaction lines where the tax code does not equal 0.”
Scenario_124 - Discount date is not earlier than or equal to Due date.
ElementDetails
Scenario IDScenario_124
Scenario NameDiscount date is not earlier than or equal to Due date.
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDdueDate and/or discountDate are provided or autocalculated
BUTdiscountDate is not earlier than or equal to dueDate
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Invalid {0}; {0} must be earlier or equal to {1}."
{0} - discountDate
{1} - dueDate
Scenario_125 - discountCurrencyAmount exceeds the total invoice amount
ElementDetails
Scenario IDScenario_125
Scenario NamediscountCurrencyAmount exceeds the total invoice amount
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDthe DiscountCurrencyAmount exceeds the total invoice amount
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Invalid discountCurrencyAmount; it cannot exceed the total invoice amount ({0})."
{0} - The “Currency Amount” of the AP/AR row
Scenario_126 - discountCurrencyAmount differs from the one calculated by the API
ElementDetails
Scenario IDScenario_126
Scenario NamediscountCurrencyAmount differs from the one calculated by the API
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDSystem parameter CALC_PAY_DISC_AP/AR is ON, value = 1
ANDthe discountCurrencyAmount differs from the one calculated by the API
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Invalid discountCurrencyAmount; value must be the calculated one ({0}) because system parameter {1} is ON with value 1."
{0} - calculated value for discountCurrencyAmount
{1} - CALC_PAY_DISC_AP For AP invoices and CALC_PAY_DISC_AR for AR invoices
Scenario_127 - The number of decimals for one or more amounts exceeds the maximum number allowed
ElementDetails
Scenario IDScenario_127
Scenario NameThe number of decimals for one or more amounts exceeds the maximum number allowed
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDthe number of decimals for DiscountCurrencyAmount exceeds 3, which is the maximum defined for this field
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Invalid {0}; the maximum number of decimals that the system can accept ({1}) has been exceeded”.
{0} - The amount that exceeds the number of decimals (DiscountCurrencyAmount)
{1} - the maximum number of decimals that system can accept for field
Scenario_128 - Discount percentage value exceeds the maximum numbers of decimals the database can handle
ElementDetails
Scenario IDScenario_128
Scenario NameDiscount percentage value exceeds the maximum numbers of decimals the database can handle
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDthe discount percentage provided is 5.123456789%
BUTthe maximum numbers of decimals allowed in the database is 8
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Invalid {0}; the maximum number of decimals that the system can accept ({1}) has been exceeded”.
{0} - The amount that exceeds the number of decimals (discountPercentage)
{1} - the maximum number of decimals that system can accept for field
Scenario_129 - Discount percentage value is not between 0 and 99.99%
ElementDetails
Scenario IDScenario_129
Scenario NameDiscount percentage value is not between 0 and 99.99%
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDthe discount percentage provided is 100%
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Invalid {0}; value must be between 0 and 99.99%."
{0} - discountPercentage
Scenario_130 - discountCurrencyAmount without discountDate
ElementDetails
Scenario IDScenario_130
Scenario NamediscountCurrencyAmount without discountDate
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDthe discountCurrencyAmount is sent
ANDthere is no information about discounts in the credit term definition of the credit term sent (no autocompletion is possible)
BUTthe discountDate does not
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“{0} cannot be sent without {1}."
{0} - field name
{1} - dependent field name
Scenario_131 - discountPercentage without discountDate
ElementDetails
Scenario IDScenario_131
Scenario NamediscountPercentage without discountDate
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDthe discountPercentage is sent
ANDthere is no information about discounts in the credit term definition of the credit term sent (no autocompletion is possible)
BUTthe discountDate does not
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“{0} cannot be sent without {1}."
{0} - field name
{1} - dependent field name
Scenario_132 - discountDate without discountCurrencyAmount/discountPercentage
ElementDetails
Scenario IDScenario_132
Scenario NamediscountDate without discountCurrencyAmount/discountPercentage
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDthe discountDate is sent
BUTthe discountCurrencyAmount does not
ANDthere is no information about discounts in the credit term definition of the credit term sent (no autocompletion is possible)
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“{0} cannot be sent without {1} or {2}."
{0} - discountDate
{1} - discountCurrencyAmount
{2} - discountPercentage
Scenario_133 - The sum of all Amount fields is greather than the maximum transaction difference
ElementDetails
Scenario IDScenario_133
Scenario NameThe sum of all Amount fields is greather than the maximum transaction difference
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent, containing the information below:
Company IdLine TypeSecondary open itemAccountAmountCur AmountCurrency
ENGL10108080GBP
ENTX13202020GBP
ENAP4010-66.64-66.64GBP
ENAPYES4010-33.33-33.33GBP
ANDthe maximum transaction difference allowed for the company is 0.02
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“The transaction does not balance due to a difference of {1} in {0}. This difference is greater than the maximum transaction difference defined in Company information."
{0} - the validated field (Amount)
{1} - the sum of all the Amount fields
Scenario_134 - The sum of all Amount fields is smaller than the maximum transaction difference but there is no difference account
ElementDetails
Scenario IDScenario_134
Scenario NameThe sum of all Amount fields is smaller than the maximum transaction difference but there is no difference account
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent, containing the information below:
Company IdLine TypeSecondary open itemAccountAmountCur AmountCurrency
ENGL10108080GBP
ENTX13202020GBP
ENAP4010-66.66-66.66GBP
ENAPYES4010-33.33-33.33GBP
ANDthe maximum transaction difference allowed for the company is 0.02
BUTthere is no difference account defined for that company
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“There is no {0} defined in Company information for {1} to post the balance difference of {2}."
{0} - the validated field (Difference account)
{1} - the validated field (Amount)
{2} - the sum of all the Amount fields
Scenario_135 - The sum of all Amount3/Amount4 fields is greater than the maximum transaction difference but there is no balance account
ElementDetails
Scenario IDScenario_135
Scenario NameThe sum of all Amount3/Amount4 fields is greater than the maximum transaction difference but there is no balance account
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent, containing the information below:
Company IdLine TypeSecondary open itemAccountAmount3Amount4Cur AmountCurrency
ENGL101012420080GBP
ENTX13202032.2520GBP
ENAP4010-96.05-154.88-66.66GBP
ENAPYES4010-48.02-77.44-33.33GBP
ANDthe balance flag is selected for Amount3/Amount4 in Company information
ANDthe maximum transaction difference allowed for the company is 0.05
BUTthere is no balance account defined for Amount3/Amount4 for that company
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“There is no {0} defined in Company information for {1} to post the balance difference of {2}."
{0} - the validated field (Balance account)
{1} - the validated field (Amount3/Amount4)
{2} - the sum of all the Amount fields
Scenario_136 - The sum of all Amount3/Amount4 fields is greater than the maximum transaction difference but balance account is not GL type
ElementDetails
Scenario IDScenario_136
Scenario NameThe sum of all Amount3/Amount4 fields is greater than the maximum transaction difference but balance account is not GL type
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent, containing the information below:
Company IdLine TypeSecondary open itemAccountAmount3Amount4Cur AmountCurrency
ENGL101012420080GBP
ENTX13202032.2520GBP
ENAP4010-96.05-154.88-66.66GBP
ENAPYES4010-48.02-77.44-33.33GBP
ANDthe balance flag is selected for Amount3/Amount4 in Company information
ANDthe maximum transaction difference allowed for the company is 0.05
ANDthere is a balance account defined for Amount3/Amount4 for that company
BUTthe account type is different from GL
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“The account defined in {0} for {1} in Company information is not a GL account."
{0} - the validated field (Balance account)
{1} - the validated field (Amount3/Amount4)
Scenario_137 - The sum of all Amount3/Amount4 fields is greater than the maximum transaction difference but balance account is not active
ElementDetails
Scenario IDScenario_137
Scenario NameThe sum of all Amount3/Amount4 fields is greater than the maximum transaction difference but balance account is not active
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent, containing the information below:
Company IdLine TypeSecondary open itemPeriodAccountAmount3Amount4Cur AmountCurrency
ENGL202001101012420080GBP
ENTX20200113202032.2520GBP
ENAP2020014010-96.05-154.88-66.66GBP
ENAPYES2020014010-48.02-77.44-33.33GBP
ANDthe balance flag is selected for Amount3/Amount4 in Company information
ANDthe maximum transaction difference allowed for the company is 0.05
ANDthere is a balance account defined for Amount3/Amount4 for that company
BUTthe account is not Active (N) for that period
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“The account defined in {0} for {1} in Company information is closed for the period of the transaction {(2)}."
{0} - the validated field (Balance account)
{1} - the validated field (Amount3/Amount4)
{2} - the period of the transaction
Scenario_138 - The sum of all Amount3/Amount4 fields is greater than the maximum transaction difference but we cannot find a value for the posting attributes associated to the balance account rule
ElementDetails
Scenario IDScenario_138
Scenario NameThe sum of all Amount3/Amount4 fields is greater than the maximum transaction difference but we cannot find a value for the posting attributes associated to the balance account rule
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent, containing the information below:
Company IdLine TypeSecondary open itemAccountAmount3Amount4Cur AmountCurrency
ENGL101012420080GBP
ENTX13202032.2520GBP
ENAP4010-96.05-154.88-66.66GBP
ENAPYES4010-48.02-77.44-33.33GBP
ANDthe balance flag is selected for Amount3/Amount4 in Company information
ANDthe maximum transaction difference allowed for the company is 0.05
ANDthere is a balance account defined for Amount3/Amount4 for that company
BUTwe cannot find a value for the posting attributes associated with the balance account rule
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“The account rule ({0}) is not valid for {1} defined for {2} in Company information. Check the account rule."
{0} - the account rule
{1} - the validated field (Balance account)
{2} - the validated field (Amount3/Amount4)
Scenario_139 - The sum of all Amount3/Amount4 fields is greater than the maximum transaction difference but the Currency is different from the company currency
ElementDetails
Scenario IDScenario_139
Scenario NameThe sum of all Amount3/Amount4 fields is greater than the maximum transaction difference but the Currency is different from the company currency
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent, containing the information below:
Company IdLine TypeSecondary open itemAccountAmount3Amount4Cur AmountCurrency
ENGL101012420080GBP
ENTX13202032.2520GBP
ENAP4010-96.05-154.88-66.66GBP
ENAPYES4010-48.02-77.44-33.33GBP
ANDthe balance flag is selected for Amount3/Amount4 in the company information
ANDthe maximum transaction difference allowed for the company is 0.05
ANDthere is a balance account defined for Amount3/Amount4 for that company
BUTthe company currency is USD
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“The account rule ({0}) is not valid for {1} defined for {2} in Company information. Check the account rule."
{0} - the account rule
{1} - the validated field (Balance account)
{2} - the validated field (Amount3/Amount4)
Scenario_140 - The sum of all Amount/Amount3/Amount4 fields is smaller than the maximum transaction difference but difference account is not GL type
ElementDetails
Scenario IDScenario_140
Scenario NameThe sum of all Amount/Amount3/Amount4 fields is smaller than the maximum transaction difference but difference account is not GL type
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent, containing the information below:
Company IdLine TypeSecondary open itemAccountAmountAmount3Amount4Cur AmountCurrency
ENGL10108012420080GBP
ENTX1320202032.2520GBP
ENAP4010-66.66-96.01-154.86-66.66GBP
ENAPYES4010-33.33-48.01-77.42-33.33GBP
ANDthe maximum transaction difference allowed for the company is 0.05
ANDthere is a difference account defined for Amount/Amount3/Amount4 for that company
BUTthe account type is different than GL
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“The account defined in {0} for {1} in Company information is not a GL account."
{0} - the validated field (Difference account)
{1} - the validated field (Amount/Amount3/Amount4)
Scenario_141 - The sum of all Amount/Amount3/Amount4 fields is smaller than the maximum transaction difference but difference account is not active
ElementDetails
Scenario IDScenario_141
Scenario NameThe sum of all Amount/Amount3/Amount4 fields is smaller than the maximum transaction difference but difference account is not active
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent, containing the information below:
Company IdLine TypeSecondary open itemPeriodAccountAmountAmount3Amount4Cur AmountCurrency
ENGL20200110108012420080GBP
ENTX2020011320202032.2520GBP
ENAP2020014010-66.66-96.01-154.85-66.66GBP
ENAPYES2020014010-33.33-48.01-77.42-33.33GBP
ANDthe maximum transaction difference allowed for the company is 0.05
ANDthere is a difference account defined for Amount/Amount3/Amount4 for that company
BUTthe account is not active (N) for that period
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“The account defined in {0} for {1} in Company information is closed for the period of the transaction {(2)}."
{0} - the validated field (Difference account)
{1} - the validated field (Amount/Amount3/Amount4)
{2} - the period of the transaction
Scenario_142 - The sum of all Amount/Amount3/Amount4 fields is smaller than the maximum transaction difference but we cannot find a value for the posting attributes associated to the difference account rule
ElementDetails
Scenario IDScenario_142
Scenario NameThe sum of all Amount/Amount3/Amount4 fields is smaller than the maximum transaction difference but we cannot find a value for the posting attributes associated to the difference account rule
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent, containing the information below:
Company IdLine TypeSecondary open itemAccountAmountAmount3Amount4Cur AmountCurrency
ENGL10108012420080GBP
ENTX1320202032.2520GBP
ENAP4010-66.66-96.01-154.85-66.66GBP
ENAPYES4010-33.33-48.01-77.42-33.33GBP
ANDthe maximum transaction difference allowed for the company is 0.05
ANDthere is a difference account defined for Amount/Amount3/Amount4 for that company
BUTwe cannot find a value for the posting attributes associated with the difference account rule
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“The account rule {(0)} is not valid for the account {1} defined for {2} in Company information. Check the account rule."
{0} - the account rule
{1} - the validated field (Difference account)
{2} - the validated field (Amount/Amount3/Amount4)
Scenario_143 - The sum of all Amount/Amount3/Amount4 fields is smaller than the maximum transaction difference but the Currency is different from the company currency
ElementDetails
Scenario IDScenario_143
Scenario NameThe sum of all Amount/Amount3/Amount4 fields is smaller than the maximum transaction difference but the Currency is different from the company currency
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent, containing the information below:
Company IdLine TypeSecondary open itemAccountAmountAmount3Amount4Cur AmountCurrency
ENGL10108012420080GBP
ENTX1320202032.2520GBP
ENAP4010-66.66-96.01-154.85-66.66GBP
ENAPYES4010-33.33-48.01-77.42-33.33GBP
ANDthe maximum transaction difference allowed for the company is 0.05
ANDthere is a difference account defined for Amount/Amount3/Amount4 for that company
BUTthe company currency is USD
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“The account rule {(0)} is not valid for the account {1} defined for {2} in Company information. Check the account rule."
{0} - the account rule
{1} - the validated field (Difference account)
{2} - the validated field (Amount/Amount3/Amount4)
Scenario_144 - Line Type does not equal AP or AR or GL
ElementDetails
Scenario IDScenario_144
Scenario NameLine Type does not equal AP or AR or GL
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDlineType is provided
BUTlineType does not equal AP or AR or GL
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Invalid lineType; Line Type must equal AP or AR or GL or should be empty.”
Scenario_145 - Line Type does not match the account according to the system setup
ElementDetails
Scenario IDScenario_145
Scenario NameLine Type does not match the account according to the system setup
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDlineType is provided
ANDaccount is provided
BUTlineType does not match the account according to the system setup
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Invalid lineType; Account {0} is “{1}” account type."
{0} - account number
{1} - account type for account {0} according to the system setup
Scenario_146 - Account and Line Type for a detail have not been provided
ElementDetails
Scenario IDScenario_146
Scenario NameAccount and Line Type for a detail have not been provided
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
BUTaccount and lineType for a detail have not been provided
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“If this is a GL detail - line type and account must be provided. If this is an AP/AR detail - either line type, account or both must be provided.”
Scenario_147 - GL account has not been provided
ElementDetails
Scenario IDScenario_147
Scenario NameGL account has not been provided
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDline type GL has been provided
BUTGL account has not been provided
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“For GL details account must be provided.”
Scenario_148 - AP/AR account has not been provided or autocompleted
ElementDetails
Scenario IDScenario_148
Scenario NameAP/AR account has not been provided or autocompleted
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDlineType AP or AR has been provided
BUTAP/AR account has not been provided or autocompleted
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Account is not provided and it can’t be autocompleted.”
Scenario_149 - Account defined in the Difference account/Balance account does not exist for the selected period
ElementDetails
Scenario IDScenario_149
Scenario NameAccount defined in the Difference account/Balance account does not exist for the selected period
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent, containing the information below:
Company IdLine TypeAccountAmountAmount3Amount4
ENGL6210100144.34167.47
ENAP2010-100.02-144.36-167.50
ANDthe maximum transaction difference allowed for the company is 0.02
ANDthe account 9995 is defined in difference/balance account for Amount/Amount3/Amount4 for that company
BUTGL account (Difference account/Balance account) 9995 does not exist for period 202004
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“The account defined in {0} for {1} in Company information does not exist for the period of the transaction ({2})."
{0} - validated field (Difference account/Balance account)
{1} - validated field (Amount/Amount3/Amount4)
{2} - period of the transaction
Scenario_150 - Invalid account rule in the account defined in the Difference account/Balance account
ElementDetails
Scenario IDScenario_150
Scenario NameInvalid account rule in the account defined in the Difference account/Balance account
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent, containing the information below:
ANDthe maximum transaction difference allowed for the company is 0.02
ANDthe account 9995 is defined in Difference/Balance account for Amount/Amount3/Amount4 for that company
BUTthe account rule (Help accounts) of the GL account (Difference account/Balance account) 9995 is closed
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Invalid account rule ({0}) for the {1} defined for {2} in Company information. Status must be N (Active)."
{0} - Account rule name
{1} - Validated field (Difference account/Balance account)
{2} - Validated field (Amount/Amount3/Amount4)
Scenario_151 - The account type of the account (accountingInformation) and the flag (GL,AP,AR) of the tax code must be equal
ElementDetails
Scenario IDScenario_151
Scenario NameThe account type of the account (accountingInformation) and the flag (GL,AP,AR) of the tax code must be equal
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDthe account has been provided or autocompleted in one of the details
ANDtaxCode has been provided or autocompleted in that same detail
BUTtaxCode has not the same flag (GL, AP or AR) as the account type
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Invalid {0}; {0} must be set to {1}."
{0} - the validated field (Tax code)
{1} - the account type
Scenario_152 - Account for the balancing attribute is not active for the selected period
ElementDetails
Scenario IDScenario_152
Scenario NameAccount for the balancing attribute is not active for the selected period
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDa balancing attribute is defined in Company information
ANDthe transaction does not balance in the balancing attribute
BUTthe account for the balancing attribute is not active for the selected period
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Transaction does not balance in balancing attribute {0} and account {1} defined for it in Company information is invalid; status must be N (Active) for Period {2}."
{0} - the balancing attribute ID
{1} - the account defined for balancing attribute in Company information
{2} - the value of the period set in the JSON file
Scenario_153 - Account for the balancing attribute is not of the type GL
ElementDetails
Scenario IDScenario_153
Scenario NameAccount for the balancing attribute is not of the type GL
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDa balancing attribute is defined in Company information
ANDthe transaction does not balance in the balancing attribute
BUTthe account type of the balancing attribute is not GL
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Transaction does not balance in balancing attribute {0} and account {1} defined for it in Company Information is invalid; account type must be GL."
{0} - the balancing attribute ID
{1} - the account defined for the balancing attribute in Company information
Scenario_154 - Account for the balancing attribute is not set in Company Information
ElementDetails
Scenario IDScenario_154
Scenario NameAccount for the balancing attribute is not set in Company Information
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDa balancing attribute is defined in Company information
ANDthe transaction does not balance in the balancing attribute
BUTthe account for the balancing attribute is not set in Company Information
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Transaction does not balance in balancing attribute {0} and account for it in Company Information is not defined; provide account number."
{0} - the balancing attribute ID
Scenario_155 - Balancing attribute is not part of account rule of the GL account defined for balancing attribute
ElementDetails
Scenario IDScenario_155
Scenario NameBalancing attribute is not part of account rule of the GL account defined for balancing attribute
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDa balancing attribute is defined in Company information
ANDthe transaction does not balance in the balancing attribute
BUTthe balancing attribute is not part of the account rule of the GL account defined for the balancing attribute
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Transaction does not balance in balancing attribute {0} and account rule {2} of balance account {1} in Company information is invalid; it must contain balancing attribute {0}."
{0} - the balancing attribute ID
{1} - the account defined for the balancing attribute in Company information
{2} - the description of the account rule
Scenario_156 - Attribute value for attribute Y has no relation to attribute value for attribute X
ElementDetails
Scenario IDScenario_156
Scenario NameAttribute value for attribute Y has no relation to attribute value for attribute X
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDattribute Y in an account rule has been set up with a validation relation to attribute X
BUTthe attribute value for attribute Y has no relation to the attribute value for attribute X
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Invalid Attribute Value. {0} {1} has no relation to {2} {3}. For {0} {1} the matching {2} value is {3}."
{0} - attribute Y
{1} - attribute Y value
{2} - attribute X
{3} - attribute X value
Scenario_157 - TaxCode defined
ElementDetails
Scenario IDScenario_157
Scenario NameTaxCode defined
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDtaxCode has been provided or autocompleted
BUTtaxCode is not defined into the system
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Unknown {0}."
{0} - the tag we are validating, taxCode in this case.
Scenario_158 - TaxCode must exist for the given TaxPointDate
ElementDetails
Scenario IDScenario_158
Scenario NameTaxCode must exist for the given TaxPointDate
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDtaxCode has been provided or autocompleted
ANDtaxPointDate has been provided or autocompleted
BUTtaxCode does not exist for the given taxPointDate
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Invalid {0}; {0} does not exist for given {1} ({2})."
{0} - the validated field (Tax Code)
{1} - the Tax point date field
{2} - value of Tax point date
Scenario_159 - TaxCode must be active for the given TaxPointDate
ElementDetails
Scenario IDScenario_159
Scenario NameTaxCode must be active for the given TaxPointDate
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDtaxCode has been provided or autocompleted
ANDtaxPointDate has been provided or autocompleted
BUTtaxCode is not active for the given taxPointDate
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Invalid {0}; status must be N (Active) for {1} ({2})"
{0} - the validated field (Tax code)
{1} - the Tax point date field
{2} - value of Tax point date
Scenario_160 - TaxCode value do not matching value determined for the Account Rule
ElementDetails
Scenario IDScenario_160
Scenario NameTaxCode value do not matching value determined for the Account Rule
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDtaxCode is provided
ANDtaxCode has User input as Fixed in the account rule
BUTprovided the taxCode value is not the same as the one determined for the account rule
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Invalid {0}; {0} is fixed in the account rule and it must be {1}."
{0} - the tag we are validating, taxCode in this case.
{1} - the value we would get if we applied code completion.
Scenario_161 - TaxCode value do not matching value determined for the Supplier
ElementDetails
Scenario IDScenario_161
Scenario NameTaxCode value do not matching value determined for the Supplier
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDtaxCode is provided
ANDtaxCode has User input as Mandatory in the account rule
ANDtaxCode is flagged as Fixed for the supplier
BUTprovided the taxCode value is not the same as the one determined for the supplier
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Invalid {0}; {0} is fixed for the supplier and it must be {1}."
{0} - the tag we are validating, taxCode in this case.
{1} - the value we would get if we applied code completion. The value for the supplier.
Scenario_162 - TaxCode value cannot be determined through its Owner Attribute
ElementDetails
Scenario IDScenario_162
Scenario NameTaxCode value cannot be determined through its Owner Attribute
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDtaxCode is not provided
ANDtaxCode has User input as Fixed in the account rule
ANDtaxCode value is determined for the owner attribute
BUTthe taxCode value cannot be autocompleted through its owner attribute
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Invalid {0}; {0} is fixed in the account rule and it cannot be autocompleted through its owner attribute."
{0} - the tag we are validating, taxCode in this case.
Scenario_163 - TaxCode value cannot be found in the Value Matrix
ElementDetails
Scenario IDScenario_163
Scenario NameTaxCode value cannot be found in the Value Matrix
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDtaxCode is not provided
ANDtaxCode has User input as Fixed in the account rule
ANDthe taxCode value is determined for the value matrix
BUTthe taxCode value cannot be autocompleted through the value matrix
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Invalid {0}; {0} is fixed in the account rule and no value can be found in the value matrix."
{0} - the tag we are validating, taxCode in this case.
Scenario_164 - TaxCode value cannot be determined, so validation cannot be evaluated
ElementDetails
Scenario IDScenario_164
Scenario NameTaxCode value cannot be determined, so validation cannot be evaluated
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDtaxCode is provided
ANDtaxCode has User input as Fixed in the account rule
BUTthe taxCode value cannot be determined for the account rule
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Invalid {0}; it is impossible to determine if the {0} is valid according to the current account rule."
{0} - the tag we are validating, taxCode in this case.
Scenario_165 - TaxCode value not provided and autocompletion is not possible
ElementDetails
Scenario IDScenario_165
Scenario NameTaxCode value not provided and autocompletion is not possible
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDtaxCode is not provided
ANDtaxCode has User input as Mandatory in the account rule
BUTthe taxCode value cannot be determined for the account rule
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Invalid {0}; {0} is mandatory."
{0} - the tag we are validating, taxCode in this case.
Scenario_166 - VAT account exists for the GL period
ElementDetails
Scenario IDScenario_166
Scenario NameVAT account exists for the GL period
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDa period has been provided or autocompleted
ANDtaxCode has been provided or autocompleted
BUTthe VAT account does not exist for the period
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Invalid {0} ({1}) for Period {2}."
{0} - the validated field (VAT account)
{1} - the account
{2} - the period
Scenario_167 - VAT account is not active for the GL period
ElementDetails
Scenario IDScenario_167
Scenario NameVAT account is not active for the GL period
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDa period has been provided or autocompleted
ANDtaxCode has been provided or autocompleted
BUTthe VAT account is not active for that period
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Invalid {0} ({1}); status must be N (Active) for Period {2}."
{0} - the validated field (VAT account)
{1} - the account
{2} - the period
Scenario_168 - VAT account type is GL
ElementDetails
Scenario IDScenario_168
Scenario NameVAT account type is GL
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDtaxCode has been provided or autocompleted
BUTthe VAT account type is not GL
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Invalid {0} ({1}); account type of {0} must be {2}."
{0} - the validated field (VAT account)
{1} - the account
{2} - the account type (GL)
Scenario_169 - Non deductible VAT account exists for the GL period
ElementDetails
Scenario IDScenario_169
Scenario NameNon deductible VAT account exists for the GL period
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDa period has been provided or autocompleted
ANDtaxCode has been provided or autocompleted
ANDthere is reduction in taxes
BUTthe non-deductible VAT account does not exist for the period
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Invalid {0} ({1}) for period {2}."
{0} - the validated field (Non deductible VAT account)
{1} - the account
{2} - the period
Scenario_170 - Non deductible VAT account is not active for the GL period
ElementDetails
Scenario IDScenario_170
Scenario NameNon deductible VAT account is not active for the GL period
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDa period has been provided or autocompleted
ANDtaxCode has been provided or autocompleted
ANDthere is reduction in taxes
BUTthe non-deductible VAT account is not active for the period
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Invalid {0} ({1}); status must be N (Active) for period {2}."
{0} - the validated field (Non deductible VAT account)
{1} - the account
{2} - the period
Scenario_171 - Non deductible VAT account type is GL
ElementDetails
Scenario IDScenario_171
Scenario NameNon deductible VAT account type is GL
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDtaxCode has been provided or autocompleted
ANDthere is reduction in taxes
BUTthe non-deductible VAT account type is not GL
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Invalid {0} ({1}); account type of {0} must be {2}."
{0} - the validated field (non-deductible VAT account)
{1} - the account
{2} - account type (GL)
Scenario_172 - Undeclared VAT account exists for the GL period
ElementDetails
Scenario IDScenario_172
Scenario NameUndeclared VAT account exists for the GL period
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDa period has been provided or autocompleted
ANDtaxCode has been provided or autocompleted
ANDcash principle is set in taxCode
BUTthe undeclared VAT account does not exist for the period
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Invalid {0} ({1}) for period {2}."
{0} - the validated field (undeclared VAT account)
{1} - the account
{2} - the period
Scenario_173 - Undeclared VAT account is not active for the GL period
ElementDetails
Scenario IDScenario_173
Scenario NameUndeclared VAT account is not active for the GL period
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDa period has been provided or autocompleted
ANDtaxCode has been provided or autocompleted
ANDcash principle is set in taxCode
BUTthe undeclared VAT account is not active for the period
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Invalid {0} ({1}); status must be N (Active) for period {2}."
{0} - the validated field (undeclared VAT account)
{1} - the account
{2} - the period
Scenario_174 - Undeclared VAT account type is GL
ElementDetails
Scenario IDScenario_174
Scenario NameUndeclared VAT account type is GL
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDtaxCode has been provided or autocompleted
ANDcash principle is set in taxCode
BUTthe undeclared VAT account type is not GL
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Invalid {0} ({1}); account type of {0} must be {2}."
{0} - the validated field (undeclared VAT account)
{1} - the account
{2} - account type (GL)
Scenario_175 - TaxSystem defined
ElementDetails
Scenario IDScenario_175
Scenario NameTaxSystem defined
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDtaxSystem has been provided or autocompleted
BUTtaxSystem is not defined into the system
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Unknown {0}."
{0} - the tag we are validating, taxSystem in this case.
Scenario_176 - TaxSystem value do not matching value determined for the Account Rule
ElementDetails
Scenario IDScenario_176
Scenario NameTaxSystem value do not matching value determined for the Account Rule
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDtaxSystem is provided
ANDtaxSystem has User input as Fixed in the account rule
BUTprovided the taxSystem value is not the same as the one determined for the account rule
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Invalid {0}; {0} is fixed in the account rule and it must be {1}."
{0} - the tag we are validating, taxSystem in this case
{1} - the value we would get if we applied code completion
Scenario_177 - TaxSystem value do not matching value determined for the Supplier
ElementDetails
Scenario IDScenario_177
Scenario NameTaxSystem value do not matching value determined for the Supplier
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDtaxSystem is provided
ANDtaxSystem has User input as Mandatory in the account rule
ANDtaxSystem is flagged as Fixed for the supplier
BUTprovided the taxSystem value is not the same as the one determined for the supplier
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Invalid {0}; {0} is fixed for the supplier and it must be {1}."
{0} - the tag we are validating, taxSystem in this case
{1} - the value we would get if we applied code completion. The value for the supplier.
Scenario_178 - TaxSystem value do not matching value determined for the Customer
ElementDetails
Scenario IDScenario_178
Scenario NameTaxSystem value do not matching value determined for the Customer
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDtaxSystem is provided
ANDtaxSystem has User input as Mandatory in the account rule
ANDtaxSystem is flagged as Fixed for the customer
BUTprovided the taxSystem value is not the same as the one determined for the customer
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Invalid {0}; {0} is fixed for the customer and it must be {1}."
{0} - the tag we are validating, taxSystem in this case
{1} - the value we would get if we applied code completion. The value for the customer.
Scenario_179 - TaxSystem value cannot be determined through its Owner Attribute
ElementDetails
Scenario IDScenario_179
Scenario NameTaxSystem value cannot be determined through its Owner Attribute
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDtaxSystem is not provided
ANDtaxSystem has User input as Fixed in the account rule
ANDtaxSystem value is determined for the owner attribute
BUTthe taxSystem value cannot be autocompleted through its owner attribute
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Invalid {0}; {0} is fixed in the account rule and it cannot be autocompleted through its owner attribute."
{0} - the tag we are validating, taxSystem in this case.
Scenario_180 - TaxSystem value cannot be found in the Value Matrix
ElementDetails
Scenario IDScenario_180
Scenario NameTaxSystem value cannot be found in the Value Matrix
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDtaxSystem is not provided
ANDtaxSystem has User input as Fixed in the account rule
ANDthe taxSystem value is determined for the value matrix
BUTthe taxSystem value cannot be autocompleted through the value matrix
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Invalid {0}; {0} is fixed in the account rule and no value can be found in the value matrix."
{0} - the tag we are validating, taxSystem in this case.
Scenario_181 - TaxSystem value not provided and autocompletion is not possible
ElementDetails
Scenario IDScenario_181
Scenario NameTaxSystem value not provided and autocompletion is not possible
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDtaxSystem is not provided
ANDtaxSystem has User input as Mandatory in the account rule
BUTthe taxSystem value cannot be determined for the account rule
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Invalid {0}; {0} is mandatory."
{0} - the tag we are validating, taxSystem in this case.
Scenario_182 - VAT reverse charge account exists for the GL period
ElementDetails
Scenario IDScenario_182
Scenario NameVAT reverse charge account exists for the GL period
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDa period has been provided or autocompleted
ANDtaxSystem has been provided or autocompleted
BUTthe VAT reverse charge account does not exist for the period
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Invalid {0} ({1}) for period {2}."
{0} - the validated field (VAT reverse charge account)
{1} - the account
{2} - the period
Scenario_183 - VAT reverse charge account is not active for the GL period
ElementDetails
Scenario IDScenario_183
Scenario NameVAT reverse charge account is not active for the GL period
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDa period has been provided or autocompleted
ANDtaxSystem has been provided or autocompleted
BUTthe VAT reverse charge account is not active for the period
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Invalid {0} ({1}); status must be N (Active) for period {2}."
{0} - the validated field (VAT reverse charge account)
{1} - the account
{2} - the period
Scenario_184 - VAT reverse charge account type is GL
ElementDetails
Scenario IDScenario_184
Scenario NameVAT reverse charge account type is GL
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDtaxSystem has been provided or autocompleted
BUTthe VAT reverse charge account type is not GL
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Invalid {0} ({1}); account type of {0} must be {2}."
{0} - the validated field (VAT reverse charge account)
{1} - the account
{2} - the account type (GL)
Scenario_185 - FactorVat defined
ElementDetails
Scenario IDScenario_185
Scenario NameFactorVat defined
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDfactorVat has been provided or autocompleted
BUTfactorVat is not defined into the system
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Unknown {0}."
{0} - the tag we are validating, factorVat in this case.
Scenario_186 - FactorVat must be active
ElementDetails
Scenario IDScenario_186
Scenario NameFactorVat must be active
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDfactorVat has been provided or autocompleted
BUTfactorVat status is not active (N)
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Invalid {0}; status must be N (Active)"
{0} - the tag we are validating, factorVat in this case.
Scenario_187 - FactorVat value do not matching value determined for the Account Rule
ElementDetails
Scenario IDScenario_187
Scenario NameFactorVat value do not matching value determined for the Account Rule
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDfactorVat is provided
ANDfactorVat has User input as Fixed in the account rule
BUTprovided the factorVat value is not the same as the one determined for the account rule
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Invalid {0}; {0} is fixed in the account rule and it must be {1}."
{0} - the tag we are validating, factorVat in this case
{1} - the value we would get if we applied code completion
Scenario_188 - FactorVat value cannot be determined through its Owner Attribute
ElementDetails
Scenario IDScenario_188
Scenario NameFactorVat value cannot be determined through its Owner Attribute
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDfactorVat is not provided
ANDfactorVat has User input as Fixed in the account rule
ANDfactorVat value is determined for the owner attribute
BUTthe factorVat value cannot be autocompleted through its owner attribute
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Invalid {0}; {0} is fixed in the account rule and it cannot be autocompleted through its owner attribute."
{0} - the tag we are validating, factorVat in this case.
Scenario_189 - FactorVat value cannot be found in the Value Matrix
ElementDetails
Scenario IDScenario_189
Scenario NameFactorVat value cannot be found in the Value Matrix
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDfactorVat is not provided
ANDfactorVat has User input as Fixed in the account rule
ANDthe factorVat value is determined for the value matrix
BUTthe factorVat value cannot be autocompleted through the value matrix
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Invalid {0}; {0} is fixed in the account rule and no value can be found in the value matrix."
{0} - the tag we are validating, factorVat in this case.
Scenario_190 - FactorVat value not provided and autocompletion is not possible
ElementDetails
Scenario IDScenario_190
Scenario NameFactorVat value not provided and autocompletion is not possible
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDfactorVat is not provided
ANDfactorVat has User input as Mandatory in the account rule
BUTthe factorVat value cannot be determined for the account rule
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Invalid {0}; {0} is mandatory."
{0} - the tag we are validating, factorVat in this case.
Scenario_191 - VatPercentage field and taxAmounts section are not provided
ElementDetails
Scenario IDScenario_191
Scenario NameVatPercentage field and taxAmounts section are not provided
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDtaxInput DTO is provided
BUTthe vatPercentage field and the taxAmounts section are not provided
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Invalid taxInput; either vatPercentage or taxAmounts or both must be provided.”
Scenario_192 - TaxSystem is set as exempt
ElementDetails
Scenario IDScenario_192
Scenario NameTaxSystem is set as exempt
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDtaxInput - taxAmounts is provided
BUTtaxSystem is set as exempt
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Invalid taxAmounts; if taxAmounts value is provided, taxSystem cannot be Exempt.”
Scenario_193 - Secondary open items - Secondary open item on GL lines
ElementDetails
Scenario IDScenario_193
Scenario NameSecondary open items - Secondary open item on GL lines
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDSecondary open items information is sent in GL line
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted.
Example Error Message“Secondary open items is only allowed for AP lines.”
Scenario_194 - Secondary open items - Secondary open item on AR lines
ElementDetails
Scenario IDScenario_194
Scenario NameSecondary open items - Secondary open item on AR lines
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDSecondary open items information is sent in AR line
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted.
Example Error Message“Secondary open items is only allowed for AP lines.”
Scenario_195 - Secondary open items - Missing Payment Recipent
ElementDetails
Scenario IDScenario_195
Scenario NameSecondary open items - Missing Payment Recipent
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDSecondary open items information is sent in AP line with no paymentRecipient
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the following error message:
ANDthe transaction is not posted.
Scenario_196 - Secondary open items - Missing Currency Amount
ElementDetails
Scenario IDScenario_196
Scenario NameSecondary open items - Missing Currency Amount
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDSecondary open items information is sent in AP line with currencyAmount (0 or empty)
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the following error message:
ANDthe transaction is not posted
Scenario_197 - Secondary open items - Currency Amount with different sign on Primary and Secondary open items
ElementDetails
Scenario IDScenario_197
Scenario NameSecondary open items - Currency Amount with different sign on Primary and Secondary open items
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDthe AP line currencyAmount has different sign that Secondary open item currencyAmount
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted.
Example Error Message“Secondary open item: Invalid Currency amount, it should have the same sign as in the “AP” detail line.”
Scenario_198 - Secondary open items - Sencondary open item on AP row with taxes
ElementDetails
Scenario IDScenario_198
Scenario NameSecondary open items - Sencondary open item on AP row with taxes
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDthe AP line related to a Secondary open item has taxes (taxCode different than ‘0’)
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted.
Example Error Message“Secondary open item is not valid when taxes are provided/autocompleted in the “AP” detail line.”
Scenario_199 - Secondary open items - More than one secondary open item per AP row
ElementDetails
Scenario IDScenario_199
Scenario NameSecondary open items - More than one secondary open item per AP row
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDSecondary open item elements contains more than one element
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted.
Example Error Message“Only one secondary open item is allowed per AP line.”
Scenario_200 - Secondary open items - Unparseable Due Date
ElementDetails
Scenario IDScenario_200
Scenario NameSecondary open items - Unparseable Due Date
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
BUTthe Secondary open item dueDate is provided as an unparseable date (e.g. “1125”, “Any text”, …)
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable entity) is obtained
ANDthe response contains the error message below:
ANDthe transaction is not posted.
Example Error Message“Invalid Due Date; date format must be YYYY-MM-DD.”
Scenario_201 - Secondary open items - Due Date with a date earlier than 1900-01-01
ElementDetails
Scenario IDScenario_201
Scenario NameSecondary open items - Due Date with a date earlier than 1900-01-01
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
BUTthe Secondary open item dueDate is equal to or less than 1900-01-01
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Invalid Due Date; Due Date must be later than 1900-01-01.”
Scenario_202 - Secondary open items - Due Date with a date later than 2099-12-31
ElementDetails
Scenario IDScenario_202
Scenario NameSecondary open items - Due Date with a date later than 2099-12-31
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
BUTthe Secondary open item dueDate is equal or more than 2099-12-31
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Invalid Due Date; Due Date must be earlier than 2099-12-31.”
Scenario_203 - Secondary open items - Payment recipient does not exist for given Company
ElementDetails
Scenario IDScenario_203
Scenario NameSecondary open items - Payment recipient does not exist for given Company
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDpaymentRecipient is provided for a Secondary open item
BUTpaymentRecipient for that Secondary open item is not defined in ERPx
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Unknown Payment recipient.”
Scenario_204 - Secondary open items - Payment recipient is not active for given Company
ElementDetails
Scenario IDScenario_204
Scenario NameSecondary open items - Payment recipient is not active for given Company
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDpaymentRecipient is provided for a Secondary open item
BUTpaymentRecipient status for that Secondary open item is not active (N) or parked (P)
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Invalid Payment recipient; status must be N (Active) or P (Parked).”
Scenario_205 - Secondary open items - Payment recipient is different than defined in given SupplierId
ElementDetails
Scenario IDScenario_205
Scenario NameSecondary open items - Payment recipient is different than defined in given SupplierId
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDpaymentRecipient is provided for a Secondary open item
ANDpaymentRecipient for given supplier is FIXED
BUTpaymentRecipient from transaction document is not equal to Payment recipient defined in supplier
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Invalid Payment recipient; for {0} {1} payment recipient is fixed and must be {2}."
{0} - SupplierID
{1} - SupplierID value set in the JSON file
{2} - Payment recipient value defined for given SupplierID
Scenario_206 - Secondary open items - SupplierId is different than defined in given Payment recipent
ElementDetails
Scenario IDScenario_206
Scenario NameSecondary open items - SupplierId is different than defined in given Payment recipent
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDpaymentRecipient is provided for a Secondary open item
ANDSupplierId for given Payment recipient is FIXED
BUTSupplierId from transaction document is not equal to SupplierId defined in Payment recipient
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Invalid {0}; for payment recipient {1} {0} is fixed and must be {2}."
{0} - SupplierID
{1} - Payment recipient value set in the JSON file
{2} - SupplierID value defined for a given Payment recipient
Scenario_207 - Secondary open items - Same Payment recipent than related AP line
ElementDetails
Scenario IDScenario_207
Scenario NameSecondary open items - Same Payment recipent than related AP line
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDsame paymentRecipient is provided at invoice level and Secondary Open items level
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response at Invoice level and Secondary Open item level contains the error message below:
ANDthe transaction is not posted
Scenario_208 - Secondary open items - Payment method does not exist for given Company
ElementDetails
Scenario IDScenario_208
Scenario NameSecondary open items - Payment method does not exist for given Company
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDpaymentMethod is provided for a Secondary open item
BUTpaymentMethod fror that Secondary open item is not defined in ERPx
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Unknown Payment method.”
Scenario_209 - Secondary open items - Payment method is not active for given Company
ElementDetails
Scenario IDScenario_209
Scenario NameSecondary open items - Payment method is not active for given Company
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDpaymentMethod is provided provided for a Secondary open item
ANDpaymentMethod is defined in ERPx
BUTpaymentMethod is not active (N)
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Invalid Payment method; status must be N (Active).”
Scenario_210 - Secondary open items - Payment method is different than defined in given SupplierId
ElementDetails
Scenario IDScenario_210
Scenario NameSecondary open items - Payment method is different than defined in given SupplierId
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDPayment method is provided provided for a Secondary open item
ANDSupplierID is provided
ANDpaymentMethod for given supplier is FIXED
BUTpaymentMethod from transaction document is not equal to payment method defined in supplier
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Invalid Payment method; for {0} {1} payment method is fixed and must be {2}."
{0} - SupplierID
{1} - SupplierID value set in the JSON file
{2} - Payment method defined for givenSupplierID
Scenario_211 - Secondary open items - The number of decimals for one or more amounts exceeds the maximum number allowed
ElementDetails
Scenario IDScenario_211
Scenario NameSecondary open items - The number of decimals for one or more amounts exceeds the maximum number allowed
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDat Secondary open items element the number of decimals for one or more “Amounts” (Currency Amount, Amount, Amount3 or Amount4) exceeds 3, which is the maximum defined for those fields
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Invalid {0}; the maximum number of decimals that the system can accept ({1}) has been exceeded."
{0} - The amount that exceeds the number of decimals (this may be “Currency Amount”, “Amount”, “Amount3” or “Amount4”)
{1} - the maximum number of decimals that system can accept for field
Scenario_212 - Secondary open items - The number of decimals for one or more amounts exceeds the maximum number of decimals defined for the Currency
ElementDetails
Scenario IDScenario_212
Scenario NameSecondary open items - The number of decimals for one or more amounts exceeds the maximum number of decimals defined for the Currency
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDat Secondary open items element the number of decimals for one or more of the “Amounts” (Currency Amount, Amount, Amount3 or Amount4) exceeds the maximum number of decimals defined for the corresponding currency, but is less than the general maximum of 3
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“Invalid {0}; the maximum number of decimals that the system can accept ({1}) has been exceeded."
{0} - The amount that exceeds the number of decimals (this may be “Currency Amount”, “Amount”, “Amount3” or “Amount4”)
{1} - the maximum number of decimals that system can accept for field
Scenario_213 - Secondary open items - There is no currency definition for one of the amounts included in the JSON file
ElementDetails
Scenario IDScenario_213
Scenario NameSecondary open items - There is no currency definition for one of the amounts included in the JSON file
HTTP Code422
GIVENthat there is a POST API for financial transactions
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDat Secondary open items element a value other than zero is set in “Amount3” and “Amount4”
BUTno currency is defined for these amounts in the Company information tab for the Company Id set in the JSON file
WHENthe transaction is posted to the transaction resource on the API
THENa 422 response (Unprocessable entity) is returned
ANDthe response contains the error message below for each of the details with a value other than 0 in “Amount3” and “Amount4”
ANDthe transaction is not posted
Example Error Message“Currency not defined for “{0}” in Company Id {1}"
{0} - The amount whose value is different than 0 but which has no corresponding currency definition (this may be “Amount3” or “Amount4”)
{1} - The value of the Company Id set in the JSON file
Scenario_214 - Secondary open items - Exchange rate does not exist for the currency type defined in account rule for amount/amount3 currency
ElementDetails
Scenario IDScenario_214
Scenario NameSecondary open items - Exchange rate does not exist for the currency type defined in account rule for amount/amount3 currency
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDcurrencyCode is provided on the open item
ANDthe Amount/Amount3 fields are = 0 in the related Secondary open item
BUTfor the transaction date, exchange rate does not exist for the currency type defined in account rule for amount/amount3 currency
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“No Exchange rate found for {0} in currency type “{1}” date {2} to calculate {3}, amount currency type is defined with the account rule of the GL account."
{0} - Currency code
{1} - Currency type
{2} - voucher date
{3} - the amount we are calculating (amount or amount3 or amount4)
Scenario_215 - Secondary open items - Exchange rate does not exist for the currency type defined in company information for amount4 currency
ElementDetails
Scenario IDScenario_215
Scenario NameSecondary open items - Exchange rate does not exist for the currency type defined in company information for amount4 currency
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDcurrencyCode is provided on the open item
ANDthe Amount4 field is = 0 in the related Secondary open item
BUTfor the transaction date, exchange rate does not exist for the currency type defined in company information for amount4 currency
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“No Exchange rate found for {0} in currency type “{1}” date {2} to calculate {3}, amount currency type is defined in company information."
{0} - Currency code
{1} - Currency type
{2} - voucher date
{3} - The amount we are calculating (amount or amount3 or amount4)
Scenario_216 - Secondary open items - Currency is not defined for amount3/amount4 in the company information
ElementDetails
Scenario IDScenario_216
Scenario NameSecondary open items - Currency is not defined for amount3/amount4 in the company information
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDamount3/amount4 is provided on the Secondary open item
BUTcurrency for amount3/amount4 is not defined in company information
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“The currency code is not defined for {0} in the company information table. Please define one."
{0} - amount3 or amount4
Scenario_217 - Posting a Financial Transaction with a TaxCode transferring to any linked tax code
ElementDetails
Scenario IDScenario_217
Scenario NamePosting a Financial Transaction with a TaxCode transferring to any linked tax code
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDa TaxCode is provided in the transaction details
BUTthat TaxCode has any linked tax code in the “Transfer to” section of the tax code setup
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“The Financial transactions API does not support linked tax codes (configuration in the ‘Transfer to’ section of a Tax code is not considered).”
Scenario_218 - Posting a Financial Transaction with a TaxSystem that has the 'Base excluding discount' flag selected
ElementDetails
Scenario IDScenario_218
Scenario NamePosting a Financial Transaction with a TaxSystem that has the ‘Base excluding discount’ flag selected
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDa TaxSystem is provided in the transaction details
BUTthat TaxSystem has the ‘Base excluding discount’ flag selected
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“The Financial transactions API does not support Tax systems with the ‘Base excluding discount’ setup (the tax calculation does not consider this specific logic).”
Scenario_219 - Posting a Financial Transaction with a TaxSystem that has the 'VAT Transaction' flag selected
ElementDetails
Scenario IDScenario_219
Scenario NamePosting a Financial Transaction with a TaxSystem that has the ‘VAT Transaction’ flag selected
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDa TaxSystem is provided in the transaction details
BUTthat TaxSystem has the ‘VAT Transaction’ flag selected
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“The Financial transactions API does not support Tax systems with the ‘VAT transaction’ setup (the tax calculation does not consider this specific logic).”
Scenario_220 - A transaction has more transaction details than the maximum number allowed.
ElementDetails
Scenario IDScenario_220
Scenario NameA transaction has more transaction details than the maximum number allowed.
HTTP Code422
GIVENthat a Financial Transaction needs to be posted
ANDa Financial Transactions API with a “financial-transactions” endpoint is available
ANDa transaction document is sent
ANDthe transaction contains more than 500 detail lines in the request payload
WHENthe transaction is posted to the transaction resource in the API
THENa 422 response (Unprocessable Entity) is returned
ANDthe response contains the error message below:
ANDthe transaction is not posted
Example Error Message“This transaction contains {0} details, which exceeds the maximum allowed {1}."
{0} - The number of detail lines provided in the request payload
{1} - The maximum number of allowed detail lines (500)

Sample Request

{
  "companyId": "EN",
  "period": 202602,
  "transactionDate": "2026-02-17",
  "transactionType": "IO",
  "externalReference": "Trans NNN from external system YYY",
  "invoice": {
    "invoiceNumber": "12345",
    "supplierId": "1000",
    "dueDate": "2026-03-19T13:25:36.524Z",
    "discountDate": "2026-02-27T13:25:36.524Z",
    "discountPercentage": 1.00,
    "discountCurrencyAmount": 1.23,
    "paymentMethod": "ZZ",
    "paymentCurrency": "YYY",
    "creditTerms": "99"
  },
  "details": [
    {
      "accountingInformation": {
        "account": "2010",
        "analyticalInformation": [
          {
            "id": "C1",
            "value": "111"
          }
        ]
      },
      "description": "Supplier transaction",
      "valueDate": "2026-02-17",
      "amounts": {
        "currencyAmount": -123.00,
        "currencyCode": "GBP"
      }
    },
    {
      "accountingInformation": {
        "account": "9876",
        "analyticalInformation": [
          {
            "id": "C1",
            "value": "120"
          }
        ]
      },
      "description": "Supplier transaction",
      "valueDate": "2026-02-17",
      "amounts": {
        "currencyAmount": 100,
        "currencyCode": "GBP"
      },
      "taxInformation": {
        "taxCode": "TC"
      }
    }
  ]
}

The example above validates a financial transaction with some illegal values, returning validation errors in the notificationMessage properties in the sections where the errors occur. The ‘financial-transactions-validate’ endpoint has the same request structure as the POST ‘financial-transactions’ but will not save the transaction even if no validation errors occur.

   

Default Values

The Validate method shares the same autocompletion logic as the POST Method.

   

Calculations

The Validate method shares the same calculation logic as the POST Method.

   

Limits and Notes

The Validate method shares the same non-supported scenarios as the POST Method.

   

Validation Rules for POST Method (Financial Transactions Validate)

The Validate method shares the same validation rules as the POST Method.

   

   

Sample Request

GET /v1/financial-transactions/account?companyId=EN&period=202301&account=1110

The example above checks whether account 1110 is valid in company EN during period 202301.

Typical Response Behavior


200 - OK when the account is valid for that period.
422 - Unprocessable Entity when invalid, with a NotificationInfo payload containing the validation error.
       If the account does not exist for that company and period: Invalid Account ({account}) for period {period}.
       If the account exists but is not Active: Invalid Account; status must be N (Active) for Period {period}.

   

Validation Rules for GET Method (Account Availability)

ACC_001 - Missing required parameters
ElementDetails
Scenario IDACC_001
Scenario NameMissing required parameters
HTTP Code422
GIVENAccount availability needs to be checked
WHENCalling the account availability GET method
BUTOne or more required parameters are missing
THENValidation fails; 422 response is returned
Example Error Message“The {0} field is required.”
ACC_002 - Account or period is invalid
ElementDetails
Scenario IDACC_002
Scenario NameAccount or period is invalid
HTTP Code422
GIVENAccount availability needs to be checked
WHENCalling the account availability GET method
BUTAccount is not valid for the selected company or period
THENValidation fails; 422 response is returned
Example Error Message“GL account does not exist for the selected period.”

Sample Request

GET /v1/registered-financial-transactions/18900001?companyId=EN

The example above tries to retrieve from the database the registered financial transaction 18900001 from the company EN.

Typical Response Behavior


200 OK when successful, it returns the full transaction details as a TransactionDto.
404 Not Found with a NotificationInfo payload containing the validation error.
    when the transaction number does NOT exists: "The entity of the following parameters [Company: EN, Transaction Number: 18900001] was not found."
    when the transaction number exists but the transaction type is other than Registration of Incoming Invoices or Registration of GL transactions: Invalid Transaction Type; Treatment Code must be one of the following: 1, 10.

   

Validation Rules for GET Method (Registered Financial Transactions)

GET_001 - User not authorised
ElementDetails
Scenario IDGET_001
Scenario NameUser not authorised
HTTP Code403
GIVENA registered transaction needs to be retrieved
WHENCalling the GET method
BUTUser does NOT have permissions for company access
THENAPI is not reached; 403 response is returned
Example Error Message“User is not authorized”
GET_002 - Registered transaction not found
ElementDetails
Scenario IDGET_002
Scenario NameRegistered transaction not found
HTTP Code404
GIVENA registered transaction needs to be retrieved
WHENCalling the GET method
BUTTransaction does not exist for provided company and transaction number
THENNo data is returned; 404 response is returned
Example Error Message“The entity of the following parameters [Company: EN, Transaction number: 666] was not found.”

Sample Request

GET /v1/objects/financial-transactions?limit=100&offset=0

   

Limits and Notes

Typical Response Behavior

  • 200: Returns object rows matching filters.
  • 400/422: Invalid query options or filter syntax.
  • 401/403: Authentication/authorization issue.

Sample Request

GET /v2/objects/general-ledger-transactions?limit=100&offset=0

   

Limits and Notes

  • This endpoint is an Object API query endpoint for already posted transactions.
  • It supports standard Object API query capabilities (filtering, sorting, pagination and selected fields).
  • For full query syntax and behavior, see ObjectAPI section.

Typical Response Behavior

  • 200: Returns object rows matching filters.
  • 400/422: Invalid query options or filter syntax.
  • 401/403: Authentication/authorization issue.

   

Best Practices

  • Validate requests in Swagger UI before sending: Use the financial-transactions-validate endpoint for testing and schema validation before posting.
  • Transactions are not posted in real time: Posting occurs only after the Transaction Processing Service (TPS) runs.
  • Respect hard limits: Maximum 500 transaction details per POST call. This limit counts only the detail lines provided in the request payload, it does not include the tax lines generated by the API.
  • Use Transaction types with posting treatment codes (2, 4, 5): The financial-transactions endpoint does not support Registration mode.
  • Keep request sizes practical: Large payloads may be rejected by the parser. Keep request size below 3.5 MB.

   

Action APIs


Query APIs (Read-Only)