StartPaymentAccountImportCommandRequestInput
Starts a fetch of the transactions of a payment account from its bank or payment provider. The run works asynchronously; read its state with ‘GetPaymentAccountImportRun’. New transactions are saved, known ones are updated, import filters and workflows apply; afterwards the automatic assignment runs when it is switched on in the settings. When the bank asks for a confirmation or the credentials are invalid, the run fails and the ERP locks the automatic import of the account. Errors: PAYMENT_ACCOUNT_NOT_FOUND (the payment account was not found); PAYMENT_ACCOUNT_HIDDEN (the payment account is hidden; show it with ‘ShowPaymentAccount’ first); PAYMENT_ACCOUNT_IS_EXTERNAL (the account is an external account; its transactions are delivered with ‘ImportPaymentTransaction’); PAYMENT_ACCOUNT_REQUIRES_INTERACTION (the account needs an interactive confirmation (for example a TAN) or a file to be fetched); PAYMENT_PROVIDER_NOT_LICENSED (the licence does not cover the payment provider of the account); LICENSE_CHECK_UNAVAILABLE (the licence could not be checked right now; try again later); PAYMENT_RECONCILIATION_IN_PROGRESS (another fetch of transactions is running right now; try again later); IMPORT_RUN_PERIOD_INVALID (‘from’ is after ‘to’). - Request
StartPaymentAccountImportCommandRequestInputFields
The ID of the payment account.
The start of the period to fetch. Omitted means the default of the provider.
The end of the period to fetch. Omitted means up to now.
Whether to suppress the workflows of the import: the event that runs while a transaction is read in (its workflows can refuse or hide the transaction, so with this flag such rules do not apply) and the event after it is saved. Events for other systems are still published. Defaults to false when omitted.
Client-supplied idempotency key. When provided, a repeated request with the same key and payload replays the original result instead of re-executing the mutation.
Was this page helpful?