Skip to main content
API docs by Redocly

Accounting Coordinator API (v1)

Download OpenAPI specification:Download

API for manage accounting entries (v1.155.0)

BankNotifications

GetBankNotifications

Returns a list containing all available bank notifications on partner

query Parameters
fromDate
string <date-time>
toDate
string <date-time>
type
string
pageSize
integer <int32>
Default: 50
pageNumber
integer <int32>
Default: 0

Responses

Response samples

Content type
{
  • "totalCount": 0,
  • "limitCount": 0,
  • "items": [
    ]
}

RejectBankNotification

Mark a received bank notification as rejected, in order to send back to creditor

path Parameters
bankNotificationId
required
string <uuid>

identifier of notification to be rejected

Responses

Response samples

Content type
{
  • "errorCode": "string",
  • "errorDescription": "string",
  • "errorProperties": {
    }
}

ApproveBankNotification

Approve specified notification in order to start its process

path Parameters
bankNotificationId
required
string <uuid>

Identifier of notification

Responses

Response samples

Content type
{
  • "errorCode": "string",
  • "errorDescription": "string",
  • "errorProperties": {
    }
}

GetBankNotificationStates

Get list of possible states of bank notifications

Responses

Response samples

Content type
[
  • "string"
]

GetBankNotificationTypes

Get list of possible types of bank notifications

Responses

Response samples

Content type
[
  • "string"
]

Diagnostics

GetDiagnosticsInfo

Get current platform diagnostics data

Responses

Response samples

Content type
{
  • "applicationName": "string",
  • "applicationVersion": "string",
  • "environment": "string",
  • "properties": {
    }
}

Flows

GetFlowSchedulingTimer

Get the Flow Scheduling Timer (it's include CRON and next schedules)

path Parameters
flowKey
required
string

Responses

Response samples

Content type
{
  • "cron": "string",
  • "nextSchedules": [
    ]
}

Forcing

ForceBankNotificationsFlow

Triggers the flow 'BankNotifications' overriding execution without needing to wait for the CRON trigger

query Parameters
type
required
string
Enum: "IncomingSctStandard" "IncomingSctInstant" "IncomingReconciliation" "IncomingSdd"

Type of banking event that can be received

bankNotificationId
string <uuid>

Responses

Response samples

Content type
{
  • "errorCode": "string",
  • "errorDescription": "string",
  • "errorProperties": {
    }
}

ForceAccountingOperationsFlow

Triggers the flow 'AccountingOperations' overriding execution without needing to wait for the CRON trigger

query Parameters
operationId
string <uuid>

Responses

Response samples

Content type
{
  • "errorCode": "string",
  • "errorDescription": "string",
  • "errorProperties": {
    }
}

ForceMandateDepositsFlow

Triggers the flow 'MandateDeposits' overriding execution without needing to wait for the CRON trigger

Responses

Response samples

Content type
{
  • "errorCode": "string",
  • "errorDescription": "string",
  • "errorProperties": {
    }
}

ForceMandateDepositRequest

Triggers the 'MandateDepositRequest' of a SINGLE mandate overriding execution without needing to wait for the CRON trigger.

NOTE: The date of next deposit request still needs to be today, or the message will be ignored

query Parameters
mandateId
required
string <uuid>

Single mandate deposit request to trigger

Responses

Response samples

Content type
{
  • "errorCode": "string",
  • "errorDescription": "string",
  • "errorProperties": {
    }
}