Skip to main content

Payment Status as of Date REST API

How to Generate a Payment Balance Report as of a Specific Date via API

Written by Petr Pech

The payment status as of a given date can be retrieved via the REST API using a GET request to the URL:

/c/{firma}/saldo-k-datu, where {firma} is the database identifier of the company.

Data is available in both XML and JSON.

When generating the output, you can apply filtering on the register fields. The register also supports Summation.

The output can be further controlled using the following parameters:

  • datum

    • The date as of which the payment status is determined.

      • the default value is the current day (not required)

  • modul

    • The list of modules to be included

      • the default values are FAV, PHL, FAP, ZAV. The list of modules can be found in the register list.

  • dleUcto

    • A flag indicating whether the output relates to the accounting date or the issue date (default is accounting date).

      • the default value is true, meaning the accounting date is used by default

All parameters are optional.

Call examples

The balance as of a date can be generated with a GET request, for example, for a restricted issue date:

Balance as of date from 12 December 2021, for the FAV module only, referenced to the issue date

GET /c/demo/saldo-k-datu.xml?datum=2021-12-12&modul=FAV&dleUcto=false

Did this answer your question?