WSE · Schnittstellen

Offene Posten

Verbinden Sie WSE mit Ihren Anwendungen. Entdecken Sie Endpunkte, Datenmodelle und Schnittstellen – nach Funktionsbereichen und Add-ons geordnet.

OpenAPI herunterladen ↓
REST · JSONBearer-Authentifizierung
API docs by Redocly

Offene Posten

ERP API Dokumentation

Offene Posten & Banking

Add-on erforderlich: Offene Posten. Die Nutzung setzt das freigeschaltete Add-on und passende Benutzerberechtigungen voraus.

List Opos Invoices

Return paginated OPOS invoices.

Authorizations:
BearerAuth
query Parameters
OposPaymentStatus (string) or Payment Status (null) (Payment Status)
OposDunningStatus (string) or Dunning Status (null) (Dunning Status)
Customer Id (string) or Customer Id (null) (Customer Id)
Invoice No (integer) or Invoice No (null) (Invoice No)
Invoice Prefix (string) or Invoice Prefix (null) (Invoice Prefix)
Company (string) or Company (null) (Company)
Name (string) or Name (null) (Name)
Due Date From (string) or Due Date From (null) (Due Date From)
Due Date To (string) or Due Date To (null) (Due Date To)
Is Overdue (boolean) or Is Overdue (null) (Is Overdue)
Is Reminder Due (boolean) or Is Reminder Due (null) (Is Reminder Due)
OposInvoiceDueState (string) or Due State (null) (Due State)
skip
integer (Skip) >= 0
Default: 0
limit
integer (Limit) [ 1 .. 1000 ]
Default: 100
sort_by
string (Sort By)
Default: "due_date"
Enum: "due_date" "due_state" "invoice_date" "invoice_no" "customer" "payment_status" "dunning_status" "days_overdue"
sort_order
string (Sort Order)
Default: "asc"
Enum: "asc" "desc"

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request GET \
  --url 'https://your-instance.example.invalid/opos/invoices?payment_status=open&dunning_status=none&customer_id=string&invoice_no=0&invoice_prefix=string&company=string&name=string&due_date_from=2019-08-24&due_date_to=2019-08-24&is_overdue=true&is_reminder_due=true&due_state=not_due&skip=0&limit=100&sort_by=due_date&sort_order=asc' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/json
{
  • "total_count": 0,
  • "items": [
    ]
}

Get Opos Invoice

Return one OPOS invoice.

Authorizations:
BearerAuth
path Parameters
invoice_id
required
string <uuid4> (Invoice Id)

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request GET \
  --url 'https://your-instance.example.invalid/opos/invoices/string' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/json
{
  • "opos_invoice_state_id": "string",
  • "invoice_id": "string",
  • "invoice_no": 0,
  • "invoice_prefix": "string",
  • "invoice_date": "2019-08-24",
  • "customer_id": "string",
  • "company": "string",
  • "firstname": "string",
  • "name": "string",
  • "city": "string",
  • "due_date": "2019-08-24",
  • "gross_amount": "string",
  • "currency": "string",
  • "payment_status": "open",
  • "dunning_status": "none",
  • "paid_amount": "string",
  • "outstanding_amount": "string",
  • "reserved_amount": "string",
  • "available_amount": "string",
  • "paid_at": "2019-08-24T14:15:22Z",
  • "last_reminded_at": "2019-08-24T14:15:22Z",
  • "reminder_count": 0,
  • "is_overdue": true,
  • "is_reminder_due": true,
  • "days_overdue": 0,
  • "due_state": "not_due",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "last_payment_change_at": "2019-08-24T14:15:22Z",
  • "last_dunning_change_at": "2019-08-24T14:15:22Z"
}

List Opos Invoice Payment Reminders

Return OPOS payment reminder history for one invoice.

Authorizations:
BearerAuth
path Parameters
invoice_id
required
string <uuid4> (Invoice Id)

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request GET \
  --url 'https://your-instance.example.invalid/opos/invoices/string/payment-reminders' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/json
{
  • "total_count": 0,
  • "items": [
    ]
}

Post Opos Invoice Payment Reminder

Create the next OPOS payment reminder for one overdue invoice.

Authorizations:
BearerAuth
path Parameters
invoice_id
required
string <uuid4> (Invoice Id)
Request Body schema: application/json
required
Payment Reminder Date (string) or Payment Reminder Date (null) (Payment Reminder Date)
Any of
string <date> (Payment Reminder Date)
Due Date (string) or Due Date (null) (Due Date)
Any of
string <date> (Due Date)
Service Date (string) or Service Date (null) (Service Date)
Any of
string <date> (Service Date)
Note (string) or Note (null) (Note)
Any of
<= 5000 characters
string (Note) <= 5000 characters

Responses

Request samples

Content type
application/json
{
  • "payment_reminder_date": "2019-08-24",
  • "due_date": "2019-08-24",
  • "service_date": "2019-08-24",
  • "note": "string"
}

Response samples

Content type
application/json
{
  • "opos_payment_reminder_id": "string",
  • "opos_invoice_state_id": "string",
  • "invoice_id": "string",
  • "payment_reminder_id": "string",
  • "reminder_level": 0,
  • "reminder_date": "2019-08-24",
  • "due_date": "2019-08-24",
  • "note": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Get Opos Dashboard

Return OPOS dashboard KPIs.

Authorizations:
BearerAuth

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request GET \
  --url 'https://your-instance.example.invalid/opos/dashboard' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/json
{
  • "open_count": 0,
  • "partial_count": 0,
  • "reminded_count": 0,
  • "paid_count": 0,
  • "overdue_count": 0,
  • "reminder_due_count": 0,
  • "oldest_due_date": "2019-08-24",
  • "due_next_7_days_count": 0,
  • "due_next_30_days_count": 0
}

Sync Opos Invoice States

Backfill missing OPOS states for existing finalized invoices.

Authorizations:
BearerAuth

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request POST \
  --url 'https://your-instance.example.invalid/opos/sync' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/json
{
  • "created": 0,
  • "already_existing": 0,
  • "skipped_missing_due_date": 0
}

Get Settings

Authorizations:
BearerAuth

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request GET \
  --url 'https://your-instance.example.invalid/opos/banking/settings' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/json
{
  • "auto_matching_enabled": true,
  • "creditor_identifier": "string",
  • "default_direct_debit_account_id": "string"
}

Patch Settings

Authorizations:
BearerAuth
Request Body schema: application/json
required
Auto Matching Enabled (boolean) or Auto Matching Enabled (null) (Auto Matching Enabled)
Any of
boolean (Auto Matching Enabled)
Creditor Identifier (string) or Creditor Identifier (null) (Creditor Identifier)
Any of
<= 35 characters
string (Creditor Identifier) <= 35 characters
Default Direct Debit Account Id (string) or Default Direct Debit Account Id (null) (Default Direct Debit Account Id)
Any of
string <uuid4> (Default Direct Debit Account Id)

Responses

Request samples

Content type
application/json
{
  • "auto_matching_enabled": true,
  • "creditor_identifier": "string",
  • "default_direct_debit_account_id": "string"
}

Response samples

Content type
application/json
{
  • "auto_matching_enabled": true,
  • "creditor_identifier": "string",
  • "default_direct_debit_account_id": "string"
}

Post Bank Connection Authorization

Authorizations:
BearerAuth
path Parameters
organization_account_id
required
string <uuid4> (Organization Account Id)
header Parameters
Idempotency-Key
required
string <uuid> (Idempotency-Key)

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request POST \
  --url 'https://your-instance.example.invalid/opos/banking/accounts/string/authorizations' \
  --header 'Accept: application/json' \
  --header 'Idempotency-Key: 497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/json
{
  • "authorization_id": "string",
  • "status": "string",
  • "authorization_url": "string",
  • "expires_at": "2019-08-24T14:15:22Z"
}

Get Connections

Authorizations:
BearerAuth

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request GET \
  --url 'https://your-instance.example.invalid/opos/banking/connections' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Post Bank Connection Reauthorization

Authorizations:
BearerAuth
path Parameters
connection_id
required
string <uuid4> (Connection Id)

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request POST \
  --url 'https://your-instance.example.invalid/opos/banking/connections/string/authorizations' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/json
{
  • "authorization_id": "string",
  • "status": "string",
  • "authorization_url": "string",
  • "expires_at": "2019-08-24T14:15:22Z"
}

Post Disconnect

Authorizations:
BearerAuth
path Parameters
connection_id
required
string <uuid4> (Connection Id)

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request POST \
  --url 'https://your-instance.example.invalid/opos/banking/connections/string/disconnect' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/json
{
  • "bank_connection_id": "string",
  • "status": "string",
  • "reauthorization_required": true,
  • "last_successful_sync_at": "2019-08-24T14:15:22Z",
  • "last_error_code": "string",
  • "disconnected_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Get Accounts

Authorizations:
BearerAuth

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request GET \
  --url 'https://your-instance.example.invalid/opos/banking/accounts' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Patch Account

Authorizations:
BearerAuth
path Parameters
account_id
required
string <uuid4> (Account Id)
Request Body schema: application/json
required
Reconciliation Enabled (boolean) or Reconciliation Enabled (null) (Reconciliation Enabled)
Any of
boolean (Reconciliation Enabled)
Is Default Direct Debit Account (boolean) or Is Default Direct Debit Account (null) (Is Default Direct Debit Account)
Any of
boolean (Is Default Direct Debit Account)

Responses

Request samples

Content type
application/json
{
  • "reconciliation_enabled": true,
  • "is_default_direct_debit_account": true
}

Response samples

Content type
application/json
{
  • "organization_bank_account_id": "string",
  • "bank_account_id": "string",
  • "bank_connection_id": "string",
  • "account_type": "string",
  • "account_name": "string",
  • "iban": "string",
  • "bic": "string",
  • "currency": "string",
  • "balance": "string",
  • "reconciliation_enabled": true,
  • "available": true,
  • "is_default_direct_debit_account": true,
  • "capabilities": [
    ],
  • "max_batch_items": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Post Sync Run

Authorizations:
BearerAuth

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request POST \
  --url 'https://your-instance.example.invalid/opos/banking/sync-runs' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/json
{
  • "bank_sync_run_id": "string",
  • "trigger": "event",
  • "status": "queued",
  • "bank_connection_id": "string",
  • "imported_connections": 0,
  • "imported_accounts": 0,
  • "imported_transactions": 0,
  • "error_count": 0,
  • "last_error_code": "string",
  • "started_at": "2019-08-24T14:15:22Z",
  • "finished_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z"
}

Get One Sync Run

Authorizations:
BearerAuth
path Parameters
sync_run_id
required
string <uuid4> (Sync Run Id)

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request GET \
  --url 'https://your-instance.example.invalid/opos/banking/sync-runs/string' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/json
{
  • "bank_sync_run_id": "string",
  • "trigger": "event",
  • "status": "queued",
  • "bank_connection_id": "string",
  • "imported_connections": 0,
  • "imported_accounts": 0,
  • "imported_transactions": 0,
  • "error_count": 0,
  • "last_error_code": "string",
  • "started_at": "2019-08-24T14:15:22Z",
  • "finished_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z"
}

Get Transactions

Authorizations:
BearerAuth
query Parameters
Account Id (string) or Account Id (null) (Account Id)
Date From (string) or Date From (null) (Date From)
Date To (string) or Date To (null) (Date To)
OposBankTransactionStatus (string) or Status (null) (Status)
Allocation Status (string) or Allocation Status (null) (Allocation Status)
skip
integer (Skip) >= 0
Default: 0
limit
integer (Limit) [ 1 .. 500 ]
Default: 100

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request GET \
  --url 'https://your-instance.example.invalid/opos/banking/transactions?account_id=string&date_from=2019-08-24&date_to=2019-08-24&status=pending&allocation_status=allocated&skip=0&limit=100' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/json
{
  • "total_count": 0,
  • "items": [
    ]
}

Get One Transaction

Authorizations:
BearerAuth
path Parameters
transaction_id
required
string <uuid4> (Transaction Id)

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request GET \
  --url 'https://your-instance.example.invalid/opos/banking/transactions/string' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/json
{
  • "bank_transaction_id": "string",
  • "bank_account_id": "string",
  • "status": "pending",
  • "amount": "string",
  • "currency": "string",
  • "booking_date": "2019-08-24",
  • "value_date": "2019-08-24",
  • "purpose": "string",
  • "counterpart_name": "string",
  • "counterpart_iban": "string",
  • "counterpart_bic": "string",
  • "end_to_end_reference": "string",
  • "mandate_reference": "string",
  • "is_adjusting_entry": true,
  • "allocated_amount": "string",
  • "unallocated_amount": "string",
  • "suggestions": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "allocations": [
    ]
}

Disconnect Account

Authorizations:
BearerAuth
path Parameters
organization_account_id
required
string <uuid4> (Organization Account Id)

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request POST \
  --url 'https://your-instance.example.invalid/opos/banking/accounts/string/disconnect' \
  --header 'Accept: application/problem+json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/problem+json
{
  • "type": "urn:wse:problem:bad-request",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "parameters": null,
  • "errors": null
}

Post Bank Transaction Allocations

Authorizations:
BearerAuth
path Parameters
transaction_id
required
string <uuid4> (Transaction Id)
header Parameters
Idempotency-Key
required
string <uuid> (Idempotency-Key)
Request Body schema: application/json
required
required
Array of objects (Allocations) non-empty
Array (non-empty)
invoice_id
required
string <uuid4> (Invoice Id)
required
Amount (number) or Amount (string) (Amount)

Responses

Request samples

Content type
application/json
{
  • "allocations": [
    ]
}

Response samples

Content type
application/json
{
  • "settlement_source_id": "string",
  • "source": "bank_transaction",
  • "bank_transaction_id": "string",
  • "cashbook_entry_id": "string",
  • "total_amount": "string",
  • "currency": "string",
  • "booking_date": "2019-08-24",
  • "payment_method": "cash",
  • "reference": "string",
  • "note": "string",
  • "created_by_actor_id": "string",
  • "reversed_at": "2019-08-24T14:15:22Z",
  • "reversed_by_actor_id": "string",
  • "reversal_reason": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "allocations": [
    ]
}

Post Allocation Reversal

Authorizations:
BearerAuth
path Parameters
allocation_id
required
string <uuid4> (Allocation Id)
Request Body schema: application/json
required
reason
required
string (Reason) [ 1 .. 5000 ] characters

Responses

Request samples

Content type
application/json
{
  • "reason": "string"
}

Response samples

Content type
application/json
{
  • "invoice_allocation_id": "string",
  • "settlement_source_id": "string",
  • "opos_invoice_state_id": "string",
  • "amount": "string",
  • "created_by_actor_id": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "reversed_at": "2019-08-24T14:15:22Z",
  • "reversed_by_actor_id": "string",
  • "reversal_reason": "string"
}

Get Invoice Settlements

Authorizations:
BearerAuth
path Parameters
invoice_id
required
string <uuid4> (Invoice Id)

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request GET \
  --url 'https://your-instance.example.invalid/opos/invoices/string/settlements' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Post Manual Invoice Settlement

Authorizations:
BearerAuth
path Parameters
invoice_id
required
string <uuid4> (Invoice Id)
Request Body schema: application/json
required
required
Amount (number) or Amount (string) (Amount)
Any of
> 0
number (Amount) > 0
booking_date
required
string <date> (Booking Date)
payment_method
required
string (OposPaymentMethod)
Enum: "cash" "card" "external_bank" "other"
note
required
string (Note) [ 1 .. 5000 ] characters
Reference (string) or Reference (null) (Reference)
Any of
<= 255 characters
string (Reference) <= 255 characters

Responses

Request samples

Content type
application/json
{
  • "amount": 1,
  • "booking_date": "2019-08-24",
  • "payment_method": "cash",
  • "reference": "string",
  • "note": "string"
}

Response samples

Content type
application/json
{
  • "settlement_source_id": "string",
  • "source": "bank_transaction",
  • "bank_transaction_id": "string",
  • "cashbook_entry_id": "string",
  • "total_amount": "string",
  • "currency": "string",
  • "booking_date": "2019-08-24",
  • "payment_method": "cash",
  • "reference": "string",
  • "note": "string",
  • "created_by_actor_id": "string",
  • "reversed_at": "2019-08-24T14:15:22Z",
  • "reversed_by_actor_id": "string",
  • "reversal_reason": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "allocations": [
    ]
}

Post Cashbook Settlement

Authorizations:
BearerAuth
Request Body schema: application/json
required
cashbook_id
required
string <uuid4> (Cashbook Id)
required
object (CashbookEntryCreate)

Request payload for creating one manual cashbook entry.

transaction_date
required
string <date> (Transaction Date)
direction
required
string (CashbookEntryDirection)
Enum: "income" "expense"

Cash movement direction values.

required
Amount (number) or Amount (string) (Amount)
booking_text
required
string (Booking Text) [ 1 .. 255 ] characters
offset_account_no
required
string (Offset Account No) [ 1 .. 20 ] characters
tax_key
required
string (Tax Key) [ 1 .. 20 ] characters
required
Tax Rate (number) or Tax Rate (string) (Tax Rate)
Receipt No (string) or Receipt No (null) (Receipt No)
External Reference (string) or External Reference (null) (External Reference)
Cost Center 1 (string) or Cost Center 1 (null) (Cost Center 1)
Cost Center 2 (string) or Cost Center 2 (null) (Cost Center 2)
required
Array of objects (Allocations) non-empty
Array (non-empty)
invoice_id
required
string <uuid4> (Invoice Id)
required
Amount (number) or Amount (string) (Amount)

Responses

Request samples

Content type
application/json
{
  • "cashbook_id": "string",
  • "entry": {
    },
  • "allocations": [
    ]
}

Response samples

Content type
application/json
{
  • "settlement_source_id": "string",
  • "source": "bank_transaction",
  • "bank_transaction_id": "string",
  • "cashbook_entry_id": "string",
  • "total_amount": "string",
  • "currency": "string",
  • "booking_date": "2019-08-24",
  • "payment_method": "cash",
  • "reference": "string",
  • "note": "string",
  • "created_by_actor_id": "string",
  • "reversed_at": "2019-08-24T14:15:22Z",
  • "reversed_by_actor_id": "string",
  • "reversal_reason": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "allocations": [
    ]
}

Post Existing Cashbook Allocations

Authorizations:
BearerAuth
path Parameters
settlement_source_id
required
string <uuid4> (Settlement Source Id)
Request Body schema: application/json
required
required
Array of objects (Allocations) non-empty
Array (non-empty)
invoice_id
required
string <uuid4> (Invoice Id)
required
Amount (number) or Amount (string) (Amount)

Responses

Request samples

Content type
application/json
{
  • "allocations": [
    ]
}

Response samples

Content type
application/json
{
  • "settlement_source_id": "string",
  • "source": "bank_transaction",
  • "bank_transaction_id": "string",
  • "cashbook_entry_id": "string",
  • "total_amount": "string",
  • "currency": "string",
  • "booking_date": "2019-08-24",
  • "payment_method": "cash",
  • "reference": "string",
  • "note": "string",
  • "created_by_actor_id": "string",
  • "reversed_at": "2019-08-24T14:15:22Z",
  • "reversed_by_actor_id": "string",
  • "reversal_reason": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "allocations": [
    ]
}

Get Direct Debit Runs

Authorizations:
BearerAuth
query Parameters
skip
integer (Skip) >= 0
Default: 0
limit
integer (Limit) [ 1 .. 100 ]
Default: 25

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request GET \
  --url 'https://your-instance.example.invalid/opos/direct-debit-runs?skip=0&limit=25' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/json
{
  • "total_count": 0,
  • "items": [
    ]
}

Post Direct Debit Run

Authorizations:
BearerAuth
header Parameters
Idempotency-Key
required
string <uuid> (Idempotency-Key)
Request Body schema: application/json
required
execution_date
required
string <date> (Execution Date)
prenotification_confirmed
required
boolean (Prenotification Confirmed)
required
Array of objects (Items) non-empty
Array (non-empty)
invoice_id
required
string <uuid4> (Invoice Id)
required
Amount (number) or Amount (string) (Amount)
Mandate Id (string) or Mandate Id (null) (Mandate Id)
Bank Account Id (string) or Bank Account Id (null) (Bank Account Id)
final_collection
boolean (Final Collection)
Default: false

Responses

Request samples

Content type
application/json
{
  • "execution_date": "2019-08-24",
  • "prenotification_confirmed": true,
  • "items": [
    ]
}

Response samples

Content type
application/json
{
  • "direct_debit_run_id": "string",
  • "execution_date": "2019-08-24",
  • "prenotification_confirmed": true,
  • "prenotification_confirmed_at": "2019-08-24T14:15:22Z",
  • "prenotification_confirmed_by_actor_id": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "groups": [
    ]
}

Get One Direct Debit Run

Authorizations:
BearerAuth
path Parameters
run_id
required
string <uuid4> (Run Id)

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request GET \
  --url 'https://your-instance.example.invalid/opos/direct-debit-runs/string' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/json
{
  • "direct_debit_run_id": "string",
  • "execution_date": "2019-08-24",
  • "prenotification_confirmed": true,
  • "prenotification_confirmed_at": "2019-08-24T14:15:22Z",
  • "prenotification_confirmed_by_actor_id": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "groups": [
    ]
}

Post Direct Debit Group Authorization

Authorizations:
BearerAuth
path Parameters
run_id
required
string <uuid4> (Run Id)
group_id
required
string <uuid4> (Group Id)
header Parameters
Idempotency-Key
required
string <uuid> (Idempotency-Key)

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request POST \
  --url 'https://your-instance.example.invalid/opos/direct-debit-runs/string/groups/string/authorization' \
  --header 'Accept: application/json' \
  --header 'Idempotency-Key: 497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/json
{
  • "direct_debit_group_id": "string",
  • "authorization_id": "string",
  • "authorization_url": "string",
  • "expires_at": "2019-08-24T14:15:22Z",
  • "status": "draft"
}

Post Direct Debit Run Cancellation

Authorizations:
BearerAuth
path Parameters
run_id
required
string <uuid4> (Run Id)

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request POST \
  --url 'https://your-instance.example.invalid/opos/direct-debit-runs/string/cancel' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/json
{
  • "direct_debit_run_id": "string",
  • "execution_date": "2019-08-24",
  • "prenotification_confirmed": true,
  • "prenotification_confirmed_at": "2019-08-24T14:15:22Z",
  • "prenotification_confirmed_by_actor_id": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "groups": [
    ]
}