Release Notes

Information about future and past API releases

Version releases

We are constantly adding new features to Procountor API. This page has the planned changes in future releases as well as release notes for the current ones. For anyone interested, we recommend subscribing to our mailing list to get notifications about API changes as soon as they become available.

Subscribe to our mailing list

Currently available API versions

Procountor API version diagram

API Path Version Release Date Support Ends
/latest monthly release with no extended support
/supported 22.08 updated to latest numbered version every three months
/v2208 22.08 2022-08-20 mid-May 2023
/v2205 22.05 2021-05-22 mid-Feb 2023
/v2202 22.02 2021-02-19 mid-Nov 2022

You can find the version update schedule from Procountor news and announcements site.

Release notes

Changes highlighted in red are not backwards compatible

Planned changes for the future

  • In POST /invoices and PUT /invoices endpoints, for SALES_INVOICE if invoiceChannel is ELECTRONIC_INVOICE, following fields will be made mandatory in billingAddress and counterPartyAddress
    • street
    • zip
    • city

Changes in version 22.09

Endpoints

  • POST /invoices endpoint was fixed so that a new sales invoice can be created successfully even when user has no other right than to create new sales invoice or group invoice.

Changes in version 22.08

Endpoints

  • We are introducing new endpoint POST /reports/ledgeraccounts to retrieve ledger accounts accounting report. This new endpoint mimics Procountor UI functionality behind Accounting -> Accounting reports (new) and Accounting report type 'Ledger accounts'. This endpoint has following limitations:
    • Date range (end date - start date) can't be more than 1 year
    • Report is presented in 'every month and total sum' format
    • Comparison data options aren't supported
    • Only handful of presentation options are supported
    • Filtering by dimensions isn't supported
  • In POST /reports/accounting endpoint, transactionValue can now be filtered with comparison symbols ( >,=>,=<, <). For example, '> 210.00'.

Other

  • Bugs fix included in this version:
    • POST /invoices endpoint now checks if user has right to view the corresponding register if partnerId is given. If user doesn't have the required right, 403 forbidden error is returned with an appropriate error message.
    • When creating sales invoice via endpoint POST /invoices, if partnerId is given but not penaltyPercent, penalty percent is fetched from the business partner's penalInterestRate. If the business partner doesn't have penalInterestRate, sales invoice's penaltyPercent shall be set to 0,00.
    • In POST /invoices endpoint, if partnerId and penaltyPercent are missing, penaltyPercent is set from Management > Company info > Usage settings > 'Collection and penal expense settings', if it's set there. Otherwise, penaltyPercent will be set according to the country's specific general penalty percent.
    • PUT /users endpoint now checks if mobilePhone starts with prefix '+'. If it doesn't, error code 400 is returned.
    • All API requests using Webhooks that receive response transactionIdentifier will include additional confirmationApp field to indicate which application was used to confirm the transaction (FINAGO_KEY or PROCOUNTOR_KEY). In future, Finago Key will be replaced by Procountor Key as a 2-factor authentication application.
    • In POST /reports/generalledger/{id} endpoint ledgerReceiptTransactions doesn't anymore return first row with receiptDate and transactionDescription.
    • ledgerReceiptTransactions returned by POST /reports/generalledger/{id} endpoint now returns vatStatus as integer instead of string.
    • deliveryInstructions in PUT /invoices/{invoiceId}, GET /invoices/{invoiceId} and POST /invoices now supports maximum 255 chars instead of 250.

Changes in version 22.06

Endpoints

  • We are introducing new endpoints regarding business partner's default dimensions:
    • GET /businesspartners/{id}/defaults/dimensions to fetch the basic information on default dimensions and their items of a particular business partner.
    • GET /businesspartners/{id}/defaults/dimensions/{dimensionId} to fetch the default dimensions items for a particular business partner.
    • PUT /businesspartners/{id}/defaults/dimensions/{dimensionId} to update the dimension items percents for a particular business partner. The number of items in a dimension is unlimited but the total percent must equal to 100. Since only percent can be updated, new endpoint GET /businesspartners/{id}/defaults/dimensions/{dimensionId} can be called first to fetch the item's other details.
  • We are introducing new endpoint POST /reports/generalledger/{id} to retrieve the general ledger accounting report for a particular ledger account.
    • This endpoint has following limitations:
      • Ledger receipts are sorted by receipt number in DESC order
      • Date range (end date - start date) can't be more than 1 year
      • Filtering by dimensions, balance sheet items, balance sheet items in transactions, ledger accounts, ledger account numbers aren't supported
      • Only handful of presentation options are supported
  • We are introducing new endpoint GET /company/expenses/collectionpenal/settings to fetch the environment's collection and penal expenses settings that is available in Procountor UI under Management > Company Info > Usage settings.

Other

Changes in version 22.05

Endpoints

  • New optional field invoiceOperatorInfo that contains operator and receivingAddress information have been added to InvoiceRow used in the GET /invoices/{invoiceId} endpoint for PURCHASE_INVOICE type.
  • We are introducing new endpoint GET /company/deliveryterms to view list of delivery terms allowed in invoice types PURCHASE_INVOICE, PURCHASE_ORDER, SALES_INVOICE and SALES_ORDER.
  • New optional field deliveryTermsInfo that contains name of the delivery term and municipality have been added to InvoiceRow used in the GET /invoices/{invoiceId}, POST /invoices and PUT /invoices/{invoiceId} endpoints.

Other

  • API reference page updates:
    • The following resources names have changed
      • from Report to Reports
      • from User to Users
    • At the top of the page (just before the Servers link), OpenAPI JSON links have been added to all supported API versions

Changes in version 22.04

Endpoints

  • We are introducing new endpoint PUT /invoice/{invoiceId}/reject to reject payment of the specified invoice. Supported invoice types are PURCHASE_INVOICE, TRAVEL_INVOICE and BILL_OF_CHARGES. Invoice with rejected payment transits to PAYMENT_DENIED status.
  • New optional fields startDate and endDate have been added to InvoiceRow used in the GET /invoices/{invoiceId}, POST /invoices and PUT /invoices/{invoiceId} endpoints to enable row level accrual periods in invoices.
  • New optional fields startDate and endDate have been added to Transaction used in the GET /ledgerreceipts/{receiptId}, POST /ledgerreceipts and PUT /ledgerreceipts/{receiptId} endpoints to enable transaction level accrual periods in ledger receipts.
  • PUT /invoices/{invoiceId}/approve endpoint now approves invoice of type PURCHASE_INVOICE, TRAVEL_INVOICE, BILL_OF_CHARGES in PAYMENT_DENIED status.

Changes in version 22.03

Endpoints

  • We are introducing new endpoint POST /reports/accounting to mimic the new accounting reports functionality available in Procountor UI under Accounting > Accounting reports (new).
    • Syntax of the report rows returned by the endpoint depends on report formulas. Please check Procountor manual to learn more about default report formulas used in income statement, balance sheet and cash flow reports.
    • This endpoint has following limitations:
      • Accounting reports are returned in JSON format
      • Supports only these accounting report types: INCOME_STATEMENT, CASH_FLOW, BALANCE_SHEET
      • Custom reports aren't supported
      • Supports only these filtering options: receiptType, receiptCurrency, receiptName, customerCompanyId, entryPeriodStart, entryPeriodEnd, transactionValue, transactionCurrency (not considered if transactionValue is missing)
      • Comparison data options aren't supported and only handful of presentation options can be configured
  • New optional fields allowPersonalSubstitution and substitutes have been added to GET /company/invoicecirculation/settings to support invoice circulation substitution.
  • A bug where empty attachment list was returned in GET ​/ledgerreceipts​/{receiptId} for ledger receipt type BANK_STATEMENT_AS_RECEIPT that had attachment, has been fixed.

Changes in version 22.02

Endpoints

  • We are introducing new endpoint GET /businesspartners/groups to fetch business partner groups.
  • We are introducing new endpoint POST /businesspartners/groups to create business partner group.
  • We are introducing new endpoint GET /businesspartners/groups/{id} to fetch details of the given business partner group.
  • We are introducing new endpoint PUT /businesspartners/groups/{id} to update business partner group. Changing business partner group type isn't supported with this endpoint.
  • New optional field reportGroupId has been added to RegistryInfo structure used in the GET /businesspartners/{id}, POST /businesspartners and PUT /businesspartners/{id} endpoints. The reportGroupId must be one of the ids from business partner groups in partnerGroups.
  • New optional field id has been added to BusinessPartnerGroup structure returned by the GET /businesspartners/{id} endpoint. In POST /businesspartners and PUT /businesspartners/{id} endpoints:
    • If user gives conflicting id and name for business partner group, id is honored.
    • If all business partner groups have id, reportGroupId is required.
    • Either all business partner groups in partnerGroups must have id or id for all business partner groups must be null.
  • PUT /businesspartners and POST /businesspartners endpoints now save business partner groups information given in reportGroupId and partnerGroups fields. If group information isn't given, group assignments won't be changed. To remove partner groups associations please provide empty list [] for partnerGroups.
  • In PUT /invoices/{invoiceId}/paymentevents/markpaid endpoint if given currency is different than environment's base currency, payment amount will now be converted to base currency with currency rate from the invoice. This change will apply to these invoice types: sales, purchase, travel.
  • GET /invoices results can now be filtered using invoiceNumber.

Other

  • All resources in API reference page have been collapsed.

Changes in version 22.01

Endpoints

  • New optional field statementNumber has been added to BankStatement structure returned by the GET /bankstatements endpoint to get bank statement number. This number starts from 1 and is reset each year.
  • New optional field receiptNumber has been added to LedgerReceipt structure returned by the GET /ledgerreceipts/{id} endpoint. This field contains the receipt number used e.g. with ledger receipts of type BANK_STATEMENT_AS_RECEIPT. The field is also available in POST /ledgerreceipts and PUT /ledgerreceipts/{id} endpoints.
  • POST /invoices and PUT /invoices/{id} endpoints now check if mandatory EInvoiceAddress is given when creating sales invoice with paymentMethod DIRECT_PAYMENT. If the address is missing, API returns error message EINVOICE_ADDRESS_MISSING.

Changes in version 21.12

Endpoints

  • A modified timestamp has been added to FiscalYear and TrackingPeriod structures returned by the GET /fiscalyears endpoint.

Older release notes

Older release notes can be found from their own page.

Old release notes