API status
  • Taxes

Tax Collections

All tax collections related paths

webhook

Tax Collection Events

idstring

required

Event unique identifier

Format
uuid
created_atstring

required

Date and time when the event was created. RFC 3339-5, ISO8601 UTC

Format
date-time
typestring

required

Tax collection webhook type

  • TAX_COLLECTION.CREATED - Tax collection processing started successfully.
  • TAX_COLLECTION.FINALISED - Tax collection processing finalised successfully.
  • TAX_COLLECTION.CANCELLED - Tax collection processing cancelled successfully.
Enum
  • TAX_COLLECTION.CREATED
  • TAX_COLLECTION.FINALISED
  • TAX_COLLECTION.CANCELLED
objectobject (Webhook - Tax collection)

required

idstring

required

Tax Collection Unique Identifier

Format
uuid
created_atstring

required

Date and time when the resource was created. RFC 3339-5, ISO8601 UTC

Format
date-time
updated_atstring

required

Date and time when the resource was last updated. RFC 3339-5, ISO8601 UTC

Format
date-time
account_group_idstring

Account Group Unique Identifier

Format
uuid
typestring

required

Type of the tax collection

  • TAX_PREPAYMENT_DE - German preliminary lump-sum tax payment
  • TAX_PAYMENT - Tax payment
Enum
  • TAX_PREPAYMENT_DE
  • TAX_PAYMENT
collection_amountobject

required

Total amount of taxes to be collected

instrumentobject

Instrument details

processed_amountobject

required

Processed amount details

statusstring

required

Tax collection status

  • PROCESSING - The tax collection processing has started.
  • FINALISED - The tax collection has been processed successfully.
  • CANCELLED - The tax collection was cancelled.
Enum
  • PROCESSING
  • FINALISED
  • CANCELLED
referencesarray
webhook_idstring

required

Webhook unique identifier.

Format
uuid

Responses

Request examples

{
  "id": "38fc59d0-fc42-46ef-9512-824773219b2e",
  "created_at": "2024-08-19T13:06:57.820371265Z",
  "type": "TAX_COLLECTION.CREATED",
  "webhook_id": "1b097e06-8a14-4181-b72a-de0972a3c57b",
  "object": {
    "account_group_id": "999f7566-2ca3-4007-b99d-e501be8c7222",
    "collection_amount": {
      "amount": "100.00",
      "currency": "EUR"
    },
    "id": "d77e6924-9bb7-4db0-addc-404442258f4b",
    "type": "TAX_PREPAYMENT_DE",
    "instrument": {
      "uuid": "d77e6924-9bb7-4db0-addc-404442258f4b",
      "isin": "DE000A0D8QZ0"
    },
    "processed_amount": {
      "cash_balance": {
        "amount": "0.00",
        "currency": "EUR"
      },
      "sell_to_cover": {
        "amount": "0.00",
        "currency": "EUR"
      },
      "offset_amount": {
        "amount": "0.00",
        "currency": "EUR"
      }
    },
    "status": "PROCESSING",
    "updated_at": "2024-08-19T13:06:57.820371265Z",
    "created_at": "2024-08-19T13:06:57.820371265Z"
  }
}

Response examples

Request has been processed successfully.

Empty response

Was this page helpful?