Skip to main content

Direct Debit

How to create a direct debit mandate via REST API?

Written by Lenka Haringerová

A direct debit order can be created via the REST API with a simple call using the PUT or POST method:

/c/{firma}/bankovni-ucet/{id}/prikaz-k-inkasu

For the specified bank account, creates a direct debit order from all outstanding unpaid documents.

/c/{firma}/bankovni-ucet/{id}/prikaz-k-inkasu?splatnost=2014-10-14&datVystOd=2014-09-01&datVystDo=2014-09-31

For the specified bank account, creates a direct debit order with the specified due date from all unpaid documents within the given period.

Inputs

Request processing is governed by the following parameters:

parameter

type

description

default value

splatnost

date yyyy-mm-dd

due date of the order

next business day

datVystOd

date yyyy-mm-dd

issue date of the oldest document to be paid

unlimited

datVystDo

date yyyy-mm-dd

issue date of the most recent document to be paid

current date

The following conditions must be met for a document to be included in the direct debit order being created:

  1. the document is of type issued invoice or receivable with a positive (non-zero) value,

  2. the document is of type received invoice or payable with a negative (non-zero) value,

  3. the document is not a pro-forma tax document,

  4. the payment method on the document is "bank transfer",

  5. the document has bank account details filled in (account number),

  6. the currency of the document matches the currency of the account,

  7. the document has not yet been fully paid (partial payment is allowed),

  8. the document does not already appear on a direct debit order,

  9. the document does not have a payment block set (received invoice),

  10. the document is approved for payment, if a signature is required before issuing a payment order,

  11. the issue date of the document meets the specified criteria (see parameters datVystOd and datVystDo).

Outputs

Successful request processing may return the following statuses:

200

No suitable documents were found to create an order.

201

The direct debit order has been created; the URL is provided in the Location header.

Did this answer your question?