openapi: 3.2.0
info:
  title: Soldo Business API v2.0 Webhooks API
  description: Soldo Business API v2.0 OpenAPI specification
  version: 5.56.0
servers:
- url: https://api.soldo.com
  description: Production server (using live data)
- url: https://api-demo.soldocloud.net
  description: Sandbox server (using test data)
tags:
- name: Webhooks
paths: {}
webhooks:
  move_resources_card:
    post:
      tags:
      - Webhooks
      summary: Group - Move Resources Card
      description: A `Card` has been moved to another `Group`.
      operationId: webhook-group-move-resources-card
      parameters:
      - name: X-Soldo-Fingerprint
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint}}'
          description: '[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.'
          example: '{{fingerprint}}'
      - name: X-Soldo-Fingerprint-Order
        in: header
        required: true
        schema:
          type: string
          default: id, name, type, customReferenceId
          description: '[Webhook authentication](ref:webhook-authentication): The order of the values used to calculate the fingerprint.'
          example: id, name, type, customReferenceId
      - name: X-Soldo-Fingerprint-Signature
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint_signature}}'
          description: '[Webhook authentication](ref:webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](ref:soldo-public-key).'
          example: '{{fingerprint_signature}}'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MoveResourcesCardEvent'
      responses:
        '200':
          description: Success.
      x-soldo:
        fingerprint-order: id, name, type, customReferenceId
  move_resources_wallet:
    post:
      tags:
      - Webhooks
      summary: Group - Move Resources Wallet
      description: A `Wallet` is moved to another `Group`.
      operationId: webhook-group-move-resources-wallet
      parameters:
      - name: X-Soldo-Fingerprint
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint}}'
          description: '[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.'
          example: '{{fingerprint}}'
      - name: X-Soldo-Fingerprint-Order
        in: header
        required: true
        schema:
          type: string
          default: id, name, type, customReferenceId
          description: '[Webhook authentication](ref:webhook-authentication): The order of the values used to calculate the fingerprint.'
          example: id, name, type, customReferenceId
      - name: X-Soldo-Fingerprint-Signature
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint_signature}}'
          description: '[Webhook authentication](ref:webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](ref:soldo-public-key).'
          example: '{{fingerprint_signature}}'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MoveResourcesWalletEvent'
      responses:
        '200':
          description: Success.
      x-soldo:
        fingerprint-order: id, name, type, customReferenceId
  customer_care_withdraw:
    post:
      tags:
      - Webhooks
      summary: Transaction - Customer Care Withdraw
      description: A `Withdrawal` has been performed by customer care support
      operationId: webhook-transaction-customer-care-withdraw
      parameters:
      - name: X-Soldo-Fingerprint
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint}}'
          description: '[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.'
          example: '{{fingerprint}}'
      - name: X-Soldo-Fingerprint-Order
        in: header
        required: true
        schema:
          type: string
          default: id, walletId, status, transactionSign
          description: '[Webhook authentication](ref:webhook-authentication): The order of the values used to calculate the fingerprint.'
          example: id, walletId, status, transactionSign
      - name: X-Soldo-Fingerprint-Signature
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint_signature}}'
          description: '[Webhook authentication](ref:webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](ref:soldo-public-key).'
          example: '{{fingerprint_signature}}'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomerCareWithdrawEvent'
      responses:
        '200':
          description: Success.
      x-soldo:
        fingerprint-order: id, walletId, status, transactionSign
  transaction_business_trip_unlinked:
    post:
      tags:
      - Webhooks
      summary: Transaction - Transaction Business Trip Unlinked
      description: A `Transaction` has been unlinked from a `BusinessTrip`.
      operationId: webhook-transaction-transaction-business-trip-unlinked
      parameters:
      - name: X-Soldo-Fingerprint
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint}}'
          description: '[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.'
          example: '{{fingerprint}}'
      - name: X-Soldo-Fingerprint-Order
        in: header
        required: true
        schema:
          type: string
          default: id, walletId, status, transactionSign
          description: '[Webhook authentication](ref:webhook-authentication): The order of the values used to calculate the fingerprint.'
          example: id, walletId, status, transactionSign
      - name: X-Soldo-Fingerprint-Signature
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint_signature}}'
          description: '[Webhook authentication](ref:webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](ref:soldo-public-key).'
          example: '{{fingerprint_signature}}'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TransactionBusinessTripUnlinkedEvent'
      responses:
        '200':
          description: Success.
      x-soldo:
        fingerprint-order: id, walletId, status, transactionSign
  remove_resources_card:
    post:
      tags:
      - Webhooks
      summary: Group - Remove Resources Card
      description: A `Card` has been removed from a `Group`.
      operationId: webhook-group-remove-resources-card
      parameters:
      - name: X-Soldo-Fingerprint
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint}}'
          description: '[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.'
          example: '{{fingerprint}}'
      - name: X-Soldo-Fingerprint-Order
        in: header
        required: true
        schema:
          type: string
          default: id, name, type, customReferenceId
          description: '[Webhook authentication](ref:webhook-authentication): The order of the values used to calculate the fingerprint.'
          example: id, name, type, customReferenceId
      - name: X-Soldo-Fingerprint-Signature
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint_signature}}'
          description: '[Webhook authentication](ref:webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](ref:soldo-public-key).'
          example: '{{fingerprint_signature}}'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RemoveResourcesCardEvent'
      responses:
        '200':
          description: Success.
      x-soldo:
        fingerprint-order: id, name, type, customReferenceId
  load_failed:
    post:
      tags:
      - Webhooks
      summary: Transaction - Load Failed
      description: A money load for company `Wallet` failed.
      operationId: webhook-transaction-load-failed
      parameters:
      - name: X-Soldo-Fingerprint
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint}}'
          description: '[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.'
          example: '{{fingerprint}}'
      - name: X-Soldo-Fingerprint-Order
        in: header
        required: true
        schema:
          type: string
          default: id, walletId, status, transactionSign
          description: '[Webhook authentication](ref:webhook-authentication): The order of the values used to calculate the fingerprint.'
          example: id, walletId, status, transactionSign
      - name: X-Soldo-Fingerprint-Signature
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint_signature}}'
          description: '[Webhook authentication](ref:webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](ref:soldo-public-key).'
          example: '{{fingerprint_signature}}'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LoadFailedEvent'
      responses:
        '200':
          description: Success.
      x-soldo:
        fingerprint-order: id, walletId, status, transactionSign
  created_expense_configuration:
    post:
      tags:
      - Webhooks
      summary: Expense Review - Configuration Created
      description: An `ExpenseReview` configuration has been created`.
      operationId: webhook-expensereview-created-expense-configuration
      parameters:
      - name: X-Soldo-Fingerprint
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint}}'
          description: '[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.'
          example: '{{fingerprint}}'
      - name: X-Soldo-Fingerprint-Order
        in: header
        required: true
        schema:
          type: string
          default: startDate, policyUrl, enabled, transactionId
          description: '[Webhook authentication](ref:webhook-authentication): The order of the values used to calculate the fingerprint.'
          example: startDate, policyUrl, enabled, transactionId
      - name: X-Soldo-Fingerprint-Signature
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint_signature}}'
          description: '[Webhook authentication](ref:webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](ref:soldo-public-key).'
          example: '{{fingerprint_signature}}'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreatedExpenseConfigurationEvent'
      responses:
        '200':
          description: Success.
      x-soldo:
        fingerprint-order: startDate, policyUrl, enabled, transactionId
  change_expense_type:
    post:
      tags:
      - Webhooks
      summary: Expense Review - Change Expense Type
      description: A `Transaction` expense type has been changed.
      operationId: webhook-expensereview-change-expense-type
      parameters:
      - name: X-Soldo-Fingerprint
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint}}'
          description: '[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.'
          example: '{{fingerprint}}'
      - name: X-Soldo-Fingerprint-Order
        in: header
        required: true
        schema:
          type: string
          default: startDate, policyUrl, enabled, transactionId
          description: '[Webhook authentication](ref:webhook-authentication): The order of the values used to calculate the fingerprint.'
          example: startDate, policyUrl, enabled, transactionId
      - name: X-Soldo-Fingerprint-Signature
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint_signature}}'
          description: '[Webhook authentication](ref:webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](ref:soldo-public-key).'
          example: '{{fingerprint_signature}}'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ChangeExpenseTypeEvent'
      responses:
        '200':
          description: Success.
      x-soldo:
        fingerprint-order: startDate, policyUrl, enabled, transactionId
  move_resources_member:
    post:
      tags:
      - Webhooks
      summary: Group - Move Resources Member
      description: An `User` is moved to another `Group`.
      operationId: webhook-group-move-resources-member
      parameters:
      - name: X-Soldo-Fingerprint
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint}}'
          description: '[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.'
          example: '{{fingerprint}}'
      - name: X-Soldo-Fingerprint-Order
        in: header
        required: true
        schema:
          type: string
          default: id, name, type, customReferenceId
          description: '[Webhook authentication](ref:webhook-authentication): The order of the values used to calculate the fingerprint.'
          example: id, name, type, customReferenceId
      - name: X-Soldo-Fingerprint-Signature
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint_signature}}'
          description: '[Webhook authentication](ref:webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](ref:soldo-public-key).'
          example: '{{fingerprint_signature}}'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MoveResourcesMemberEvent'
      responses:
        '200':
          description: Success.
      x-soldo:
        fingerprint-order: id, name, type, customReferenceId
  purchase_redeem_card:
    post:
      tags:
      - Webhooks
      summary: Pre-Approved Spend - Purchase Redeem Card
      description: A `Card` of purchase has been redeemed.
      operationId: webhook-preapprovedspend-purchase-redeem-card
      parameters:
      - name: X-Soldo-Fingerprint
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint}}'
          description: '[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.'
          example: '{{fingerprint}}'
      - name: X-Soldo-Fingerprint-Order
        in: header
        required: true
        schema:
          type: string
          default: id, title, description, amount, amountCurrency
          description: '[Webhook authentication](ref:webhook-authentication): The order of the values used to calculate the fingerprint.'
          example: id, title, description, amount, amountCurrency
      - name: X-Soldo-Fingerprint-Signature
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint_signature}}'
          description: '[Webhook authentication](ref:webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](ref:soldo-public-key).'
          example: '{{fingerprint_signature}}'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PurchaseRedeemCardEvent'
      responses:
        '200':
          description: Success.
      x-soldo:
        fingerprint-order: id, title, description, amount, amountCurrency
  billing:
    post:
      tags:
      - Webhooks
      summary: Transaction - Billing
      description: Billing related to `Card` purchase.
      operationId: webhook-transaction-billing
      parameters:
      - name: X-Soldo-Fingerprint
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint}}'
          description: '[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.'
          example: '{{fingerprint}}'
      - name: X-Soldo-Fingerprint-Order
        in: header
        required: true
        schema:
          type: string
          default: id, walletId, status, transactionSign
          description: '[Webhook authentication](ref:webhook-authentication): The order of the values used to calculate the fingerprint.'
          example: id, walletId, status, transactionSign
      - name: X-Soldo-Fingerprint-Signature
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint_signature}}'
          description: '[Webhook authentication](ref:webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](ref:soldo-public-key).'
          example: '{{fingerprint_signature}}'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BillingEvent'
      responses:
        '200':
          description: Success.
      x-soldo:
        fingerprint-order: id, walletId, status, transactionSign
  customer_care_deposit:
    post:
      tags:
      - Webhooks
      summary: Transaction - Customer Care Deposit
      description: A `Deposit` has been performed by customer care support.
      operationId: webhook-transaction-customer-care-deposit
      parameters:
      - name: X-Soldo-Fingerprint
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint}}'
          description: '[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.'
          example: '{{fingerprint}}'
      - name: X-Soldo-Fingerprint-Order
        in: header
        required: true
        schema:
          type: string
          default: id, walletId, status, transactionSign
          description: '[Webhook authentication](ref:webhook-authentication): The order of the values used to calculate the fingerprint.'
          example: id, walletId, status, transactionSign
      - name: X-Soldo-Fingerprint-Signature
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint_signature}}'
          description: '[Webhook authentication](ref:webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](ref:soldo-public-key).'
          example: '{{fingerprint_signature}}'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomerCareDepositEvent'
      responses:
        '200':
          description: Success.
      x-soldo:
        fingerprint-order: id, walletId, status, transactionSign
  store_order_completed:
    post:
      tags:
      - Webhooks
      summary: Order - Store Order Completed
      description: An `Order` has been completed.
      operationId: webhook-order-store-order-completed
      parameters:
      - name: X-Soldo-Fingerprint
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint}}'
          description: '[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.'
          example: '{{fingerprint}}'
      - name: X-Soldo-Fingerprint-Order
        in: header
        required: true
        schema:
          type: string
          default: id, status
          description: '[Webhook authentication](ref:webhook-authentication): The order of the values used to calculate the fingerprint.'
          example: id, status
      - name: X-Soldo-Fingerprint-Signature
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint_signature}}'
          description: '[Webhook authentication](ref:webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](ref:soldo-public-key).'
          example: '{{fingerprint_signature}}'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StoreOrderCompletedEvent'
      responses:
        '200':
          description: Success.
      x-soldo:
        fingerprint-order: id, status
  card_lost:
    post:
      tags:
      - Webhooks
      summary: Card - Card Lost
      description: A `Card` has been reported as lost.
      operationId: webhook-card-card-lost
      parameters:
      - name: X-Soldo-Fingerprint
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint}}'
          description: '[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.'
          example: '{{fingerprint}}'
      - name: X-Soldo-Fingerprint-Order
        in: header
        required: true
        schema:
          type: string
          default: id, name, status, walletId
          description: '[Webhook authentication](ref:webhook-authentication): The order of the values used to calculate the fingerprint.'
          example: id, name, status, walletId
      - name: X-Soldo-Fingerprint-Signature
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint_signature}}'
          description: '[Webhook authentication](ref:webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](ref:soldo-public-key).'
          example: '{{fingerprint_signature}}'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CardLostEvent'
      responses:
        '200':
          description: Success.
      x-soldo:
        fingerprint-order: id, name, status, walletId
  inbound_payment_reversal:
    post:
      tags:
      - Webhooks
      summary: Transaction - Inbound Payment Reversal
      description: Reversal of an inbound payment from Faster Payment
      operationId: webhook-transaction-inbound-payment-reversal
      parameters:
      - name: X-Soldo-Fingerprint
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint}}'
          description: '[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.'
          example: '{{fingerprint}}'
      - name: X-Soldo-Fingerprint-Order
        in: header
        required: true
        schema:
          type: string
          default: id, walletId, status, transactionSign
          description: '[Webhook authentication](ref:webhook-authentication): The order of the values used to calculate the fingerprint.'
          example: id, walletId, status, transactionSign
      - name: X-Soldo-Fingerprint-Signature
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint_signature}}'
          description: '[Webhook authentication](ref:webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](ref:soldo-public-key).'
          example: '{{fingerprint_signature}}'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InboundPaymentReversalEvent'
      responses:
        '200':
          description: Success.
      x-soldo:
        fingerprint-order: id, walletId, status, transactionSign
  new_user:
    post:
      tags:
      - Webhooks
      summary: User - New User
      description: A new `User` has been created.
      operationId: webhook-user-new-user
      parameters:
      - name: X-Soldo-Fingerprint
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint}}'
          description: '[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.'
          example: '{{fingerprint}}'
      - name: X-Soldo-Fingerprint-Order
        in: header
        required: true
        schema:
          type: string
          default: id, name, surname, status
          description: '[Webhook authentication](ref:webhook-authentication): The order of the values used to calculate the fingerprint.'
          example: id, name, surname, status
      - name: X-Soldo-Fingerprint-Signature
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint_signature}}'
          description: '[Webhook authentication](ref:webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](ref:soldo-public-key).'
          example: '{{fingerprint_signature}}'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NewUserEvent'
      responses:
        '200':
          description: Success.
      x-soldo:
        fingerprint-order: id, name, surname, status
  updated_expense_configuration:
    post:
      tags:
      - Webhooks
      summary: Expense Review - Updated Expense Configuration
      description: An `ExpenseReview` configuration is updated.
      operationId: webhook-expensereview-updated-expense-configuration
      parameters:
      - name: X-Soldo-Fingerprint
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint}}'
          description: '[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.'
          example: '{{fingerprint}}'
      - name: X-Soldo-Fingerprint-Order
        in: header
        required: true
        schema:
          type: string
          default: startDate, policyUrl, enabled, transactionId
          description: '[Webhook authentication](ref:webhook-authentication): The order of the values used to calculate the fingerprint.'
          example: startDate, policyUrl, enabled, transactionId
      - name: X-Soldo-Fingerprint-Signature
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint_signature}}'
          description: '[Webhook authentication](ref:webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](ref:soldo-public-key).'
          example: '{{fingerprint_signature}}'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdatedExpenseConfigurationEvent'
      responses:
        '200':
          description: Success.
      x-soldo:
        fingerprint-order: startDate, policyUrl, enabled, transactionId
  scheduled_transfer:
    post:
      tags:
      - Webhooks
      summary: Transaction - Scheduled Transfer
      description: Failed scheduled internal transfer to top-up a `Wallet`.
      operationId: webhook-transaction-scheduled-transfer
      parameters:
      - name: X-Soldo-Fingerprint
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint}}'
          description: '[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.'
          example: '{{fingerprint}}'
      - name: X-Soldo-Fingerprint-Order
        in: header
        required: true
        schema:
          type: string
          default: id, walletId, status, transactionSign
          description: '[Webhook authentication](ref:webhook-authentication): The order of the values used to calculate the fingerprint.'
          example: id, walletId, status, transactionSign
      - name: X-Soldo-Fingerprint-Signature
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint_signature}}'
          description: '[Webhook authentication](ref:webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](ref:soldo-public-key).'
          example: '{{fingerprint_signature}}'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ScheduledTransferEvent'
      responses:
        '200':
          description: Success.
      x-soldo:
        fingerprint-order: id, walletId, status, transactionSign
  transaction_modified:
    post:
      tags:
      - Webhooks
      summary: Transaction - Transaction Modified
      description: A `Transaction` has been modified, e.g. moved to another `Wallet` or changed in other describing attributes.
      operationId: webhook-transaction-transaction-modified
      parameters:
      - name: X-Soldo-Fingerprint
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint}}'
          description: '[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.'
          example: '{{fingerprint}}'
      - name: X-Soldo-Fingerprint-Order
        in: header
        required: true
        schema:
          type: string
          default: id, walletId, status, transactionSign
          description: '[Webhook authentication](ref:webhook-authentication): The order of the values used to calculate the fingerprint.'
          example: id, walletId, status, transactionSign
      - name: X-Soldo-Fingerprint-Signature
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint_signature}}'
          description: '[Webhook authentication](ref:webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](ref:soldo-public-key).'
          example: '{{fingerprint_signature}}'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TransactionModifiedEvent'
      responses:
        '200':
          description: Success.
      x-soldo:
        fingerprint-order: id, walletId, status, transactionSign
  card_change_status:
    post:
      tags:
      - Webhooks
      summary: Card - Card Change Status
      description: A `Card` changed status.
      operationId: webhook-card-card-change_status
      parameters:
      - name: X-Soldo-Fingerprint
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint}}'
          description: '[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.'
          example: '{{fingerprint}}'
      - name: X-Soldo-Fingerprint-Order
        in: header
        required: true
        schema:
          type: string
          default: id, name, status, walletId
          description: '[Webhook authentication](ref:webhook-authentication): The order of the values used to calculate the fingerprint.'
          example: id, name, status, walletId
      - name: X-Soldo-Fingerprint-Signature
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint_signature}}'
          description: '[Webhook authentication](ref:webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](ref:soldo-public-key).'
          example: '{{fingerprint_signature}}'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CardChangeStatusEvent'
      responses:
        '200':
          description: Success.
      x-soldo:
        fingerprint-order: id, name, status, walletId
  online_ads_updated:
    post:
      tags:
      - Webhooks
      summary: OnlineAds - OnlineAds Updated
      description: An `OnlineAds` has been updated.
      operationId: webhook-onlineads-online-ads-updated
      parameters:
      - name: X-Soldo-Fingerprint
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint}}'
          description: '[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.'
          example: '{{fingerprint}}'
      - name: X-Soldo-Fingerprint-Order
        in: header
        required: true
        schema:
          type: string
          default: id, name, walletId, cardId
          description: '[Webhook authentication](ref:webhook-authentication): The order of the values used to calculate the fingerprint.'
          example: id, name, walletId, cardId
      - name: X-Soldo-Fingerprint-Signature
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint_signature}}'
          description: '[Webhook authentication](ref:webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](ref:soldo-public-key).'
          example: '{{fingerprint_signature}}'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OnlineAdsUpdatedEvent'
      responses:
        '200':
          description: Success.
      x-soldo:
        fingerprint-order: id, name, walletId, cardId
  delete_group:
    post:
      tags:
      - Webhooks
      summary: Group - Group Deleted
      description: A`Group` has been deleted.
      operationId: webhook-group-delete-group
      parameters:
      - name: X-Soldo-Fingerprint
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint}}'
          description: '[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.'
          example: '{{fingerprint}}'
      - name: X-Soldo-Fingerprint-Order
        in: header
        required: true
        schema:
          type: string
          default: id, name, type, customReferenceId
          description: '[Webhook authentication](ref:webhook-authentication): The order of the values used to calculate the fingerprint.'
          example: id, name, type, customReferenceId
      - name: X-Soldo-Fingerprint-Signature
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint_signature}}'
          description: '[Webhook authentication](ref:webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](ref:soldo-public-key).'
          example: '{{fingerprint_signature}}'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteGroupEvent'
      responses:
        '200':
          description: Success.
      x-soldo:
        fingerprint-order: id, name, type, customReferenceId
  load_money:
    post:
      tags:
      - Webhooks
      summary: Transaction - Load Money
      description: A money load on company `Wallet` succeeded.
      operationId: webhook-transaction-load-money
      parameters:
      - name: X-Soldo-Fingerprint
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint}}'
          description: '[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.'
          example: '{{fingerprint}}'
      - name: X-Soldo-Fingerprint-Order
        in: header
        required: true
        schema:
          type: string
          default: id, walletId, status, transactionSign
          description: '[Webhook authentication](ref:webhook-authentication): The order of the values used to calculate the fingerprint.'
          example: id, walletId, status, transactionSign
      - name: X-Soldo-Fingerprint-Signature
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint_signature}}'
          description: '[Webhook authentication](ref:webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](ref:soldo-public-key).'
          example: '{{fingerprint_signature}}'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LoadMoneyEvent'
      responses:
        '200':
          description: Success.
      x-soldo:
        fingerprint-order: id, walletId, status, transactionSign
  wiretransfer:
    post:
      tags:
      - Webhooks
      summary: Transaction - Wiretransfer
      description: Deposit in.
      operationId: webhook-transaction-wiretransfer
      parameters:
      - name: X-Soldo-Fingerprint
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint}}'
          description: '[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.'
          example: '{{fingerprint}}'
      - name: X-Soldo-Fingerprint-Order
        in: header
        required: true
        schema:
          type: string
          default: id, walletId, status, transactionSign
          description: '[Webhook authentication](ref:webhook-authentication): The order of the values used to calculate the fingerprint.'
          example: id, walletId, status, transactionSign
      - name: X-Soldo-Fingerprint-Signature
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint_signature}}'
          description: '[Webhook authentication](ref:webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](ref:soldo-public-key).'
          example: '{{fingerprint_signature}}'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WiretransferEvent'
      responses:
        '200':
          description: Success.
      x-soldo:
        fingerprint-order: id, walletId, status, transactionSign
  contact_deleted:
    post:
      tags:
      - Webhooks
      summary: Contact - Contact Deleted
      description: A `Contact` has been deleted.
      operationId: webhook-contact-contact-deleted
      parameters:
      - name: X-Soldo-Fingerprint
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint}}'
          description: '[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.'
          example: '{{fingerprint}}'
      - name: X-Soldo-Fingerprint-Order
        in: header
        required: true
        schema:
          type: string
          default: id, name, userId, type, status
          description: '[Webhook authentication](ref:webhook-authentication): The order of the values used to calculate the fingerprint.'
          example: id, name, userId, type, status
      - name: X-Soldo-Fingerprint-Signature
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint_signature}}'
          description: '[Webhook authentication](ref:webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](ref:soldo-public-key).'
          example: '{{fingerprint_signature}}'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ContactDeletedEvent'
      responses:
        '200':
          description: Success.
      x-soldo:
        fingerprint-order: id, name, userId, type, status
  card_destroyed:
    post:
      tags:
      - Webhooks
      summary: Card - Card Destroyed
      description: A `Card` has been destroyed.
      operationId: webhook-card-card-destroyed
      parameters:
      - name: X-Soldo-Fingerprint
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint}}'
          description: '[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.'
          example: '{{fingerprint}}'
      - name: X-Soldo-Fingerprint-Order
        in: header
        required: true
        schema:
          type: string
          default: id, name, status, walletId
          description: '[Webhook authentication](ref:webhook-authentication): The order of the values used to calculate the fingerprint.'
          example: id, name, status, walletId
      - name: X-Soldo-Fingerprint-Signature
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint_signature}}'
          description: '[Webhook authentication](ref:webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](ref:soldo-public-key).'
          example: '{{fingerprint_signature}}'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CardDestroyedEvent'
      responses:
        '200':
          description: Success.
      x-soldo:
        fingerprint-order: id, name, status, walletId
  card_authorization:
    post:
      tags:
      - Webhooks
      summary: Transaction - Card Authorization
      description: A `Transaction` authorisation has been requested.
      operationId: webhook-transaction-card-authorization
      parameters:
      - name: X-Soldo-Fingerprint
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint}}'
          description: '[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.'
          example: '{{fingerprint}}'
      - name: X-Soldo-Fingerprint-Order
        in: header
        required: true
        schema:
          type: string
          default: id, walletId, status, transactionSign
          description: '[Webhook authentication](ref:webhook-authentication): The order of the values used to calculate the fingerprint.'
          example: id, walletId, status, transactionSign
      - name: X-Soldo-Fingerprint-Signature
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint_signature}}'
          description: '[Webhook authentication](ref:webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](ref:soldo-public-key).'
          example: '{{fingerprint_signature}}'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CardAuthorizationEvent'
      responses:
        '200':
          description: Success.
      x-soldo:
        fingerprint-order: id, walletId, status, transactionSign
  updated_transaction:
    post:
      tags:
      - Webhooks
      summary: Expense Review - Updated Transaction
      description: A `Transaction` has been update.
      operationId: webhook-expensereview-updated-transaction
      parameters:
      - name: X-Soldo-Fingerprint
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint}}'
          description: '[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.'
          example: '{{fingerprint}}'
      - name: X-Soldo-Fingerprint-Order
        in: header
        required: true
        schema:
          type: string
          default: startDate, policyUrl, enabled, transactionId
          description: '[Webhook authentication](ref:webhook-authentication): The order of the values used to calculate the fingerprint.'
          example: startDate, policyUrl, enabled, transactionId
      - name: X-Soldo-Fingerprint-Signature
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint_signature}}'
          description: '[Webhook authentication](ref:webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](ref:soldo-public-key).'
          example: '{{fingerprint_signature}}'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdatedTransactionEvent'
      responses:
        '200':
          description: Success.
      x-soldo:
        fingerprint-order: startDate, policyUrl, enabled, transactionId
  transaction_adjustment:
    post:
      tags:
      - Webhooks
      summary: Transaction - Transaction Adjustment
      description: A `Transaction` has been adjusted.
      operationId: webhook-transaction-transaction-adjustment
      parameters:
      - name: X-Soldo-Fingerprint
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint}}'
          description: '[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.'
          example: '{{fingerprint}}'
      - name: X-Soldo-Fingerprint-Order
        in: header
        required: true
        schema:
          type: string
          default: id, walletId, status, transactionSign
          description: '[Webhook authentication](ref:webhook-authentication): The order of the values used to calculate the fingerprint.'
          example: id, walletId, status, transactionSign
      - name: X-Soldo-Fingerprint-Signature
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint_signature}}'
          description: '[Webhook authentication](ref:webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](ref:soldo-public-key).'
          example: '{{fingerprint_signature}}'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TransactionAdjustmentEvent'
      responses:
        '200':
          description: Success.
      x-soldo:
        fingerprint-order: id, walletId, status, transactionSign
  attachment_delete:
    post:
      tags:
      - Webhooks
      summary: Transaction Attachment - Attachment Delete
      description: An attachment has been deleted from a `Transaction`.
      operationId: webhook-transactionattachment-attachment-delete
      parameters:
      - name: X-Soldo-Fingerprint
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint}}'
          description: '[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.'
          example: '{{fingerprint}}'
      - name: X-Soldo-Fingerprint-Order
        in: header
        required: true
        schema:
          type: string
          default: attachmentId, transactionId, fileName
          description: '[Webhook authentication](ref:webhook-authentication): The order of the values used to calculate the fingerprint.'
          example: attachmentId, transactionId, fileName
      - name: X-Soldo-Fingerprint-Signature
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint_signature}}'
          description: '[Webhook authentication](ref:webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](ref:soldo-public-key).'
          example: '{{fingerprint_signature}}'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AttachmentDeleteEvent'
      responses:
        '200':
          description: Success.
      x-soldo:
        fingerprint-order: attachmentId, transactionId, fileName
  disabled_expense_configuration:
    post:
      tags:
      - Webhooks
      summary: Expense Review - Configuration Disabled
      description: An `ExpenseReview` configuration has been disabled.
      operationId: webhook-expensereview-disabled-expense-configuration
      parameters:
      - name: X-Soldo-Fingerprint
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint}}'
          description: '[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.'
          example: '{{fingerprint}}'
      - name: X-Soldo-Fingerprint-Order
        in: header
        required: true
        schema:
          type: string
          default: startDate, policyUrl, enabled, transactionId
          description: '[Webhook authentication](ref:webhook-authentication): The order of the values used to calculate the fingerprint.'
          example: startDate, policyUrl, enabled, transactionId
      - name: X-Soldo-Fingerprint-Signature
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint_signature}}'
          description: '[Webhook authentication](ref:webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](ref:soldo-public-key).'
          example: '{{fingerprint_signature}}'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DisabledExpenseConfigurationEvent'
      responses:
        '200':
          description: Success.
      x-soldo:
        fingerprint-order: startDate, policyUrl, enabled, transactionId
  purchase_delete:
    post:
      tags:
      - Webhooks
      summary: Pre-Approved Spend - Purchase Delete
      description: A `Purchase` has been deleted.
      operationId: webhook-preapprovedspend-purchase-delete
      parameters:
      - name: X-Soldo-Fingerprint
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint}}'
          description: '[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.'
          example: '{{fingerprint}}'
      - name: X-Soldo-Fingerprint-Order
        in: header
        required: true
        schema:
          type: string
          default: id, title, description, amount, amountCurrency
          description: '[Webhook authentication](ref:webhook-authentication): The order of the values used to calculate the fingerprint.'
          example: id, title, description, amount, amountCurrency
      - name: X-Soldo-Fingerprint-Signature
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint_signature}}'
          description: '[Webhook authentication](ref:webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](ref:soldo-public-key).'
          example: '{{fingerprint_signature}}'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PurchaseDeleteEvent'
      responses:
        '200':
          description: Success.
      x-soldo:
        fingerprint-order: id, title, description, amount, amountCurrency
  wallet_created:
    post:
      tags:
      - Webhooks
      summary: Wallet - Wallet Created
      description: A new `Wallet` has been created.
      operationId: webhook-wallet-wallet-created
      parameters:
      - name: X-Soldo-Fingerprint
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint}}'
          description: '[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.'
          example: '{{fingerprint}}'
      - name: X-Soldo-Fingerprint-Order
        in: header
        required: true
        schema:
          type: string
          default: id, name, currencyCode, primaryUserPublicId
          description: '[Webhook authentication](ref:webhook-authentication): The order of the values used to calculate the fingerprint.'
          example: id, name, currencyCode, primaryUserPublicId
      - name: X-Soldo-Fingerprint-Signature
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint_signature}}'
          description: '[Webhook authentication](ref:webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](ref:soldo-public-key).'
          example: '{{fingerprint_signature}}'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WalletCreatedEvent'
      responses:
        '200':
          description: Success.
      x-soldo:
        fingerprint-order: id, name, currencyCode, primaryUserPublicId
  card_activated:
    post:
      tags:
      - Webhooks
      summary: Card - Card Activated
      description: A `Card` has been activated.
      operationId: webhook-card-card-activated
      parameters:
      - name: X-Soldo-Fingerprint
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint}}'
          description: '[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.'
          example: '{{fingerprint}}'
      - name: X-Soldo-Fingerprint-Order
        in: header
        required: true
        schema:
          type: string
          default: id, name, status, walletId
          description: '[Webhook authentication](ref:webhook-authentication): The order of the values used to calculate the fingerprint.'
          example: id, name, status, walletId
      - name: X-Soldo-Fingerprint-Signature
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint_signature}}'
          description: '[Webhook authentication](ref:webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](ref:soldo-public-key).'
          example: '{{fingerprint_signature}}'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CardActivatedEvent'
      responses:
        '200':
          description: Success.
      x-soldo:
        fingerprint-order: id, name, status, walletId
  unload_money:
    post:
      tags:
      - Webhooks
      summary: Transaction - Unload Money
      description: Unload money from a company `Wallet`.
      operationId: webhook-transaction-unload-money
      parameters:
      - name: X-Soldo-Fingerprint
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint}}'
          description: '[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.'
          example: '{{fingerprint}}'
      - name: X-Soldo-Fingerprint-Order
        in: header
        required: true
        schema:
          type: string
          default: id, walletId, status, transactionSign
          description: '[Webhook authentication](ref:webhook-authentication): The order of the values used to calculate the fingerprint.'
          example: id, walletId, status, transactionSign
      - name: X-Soldo-Fingerprint-Signature
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint_signature}}'
          description: '[Webhook authentication](ref:webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](ref:soldo-public-key).'
          example: '{{fingerprint_signature}}'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UnloadMoneyEvent'
      responses:
        '200':
          description: Success.
      x-soldo:
        fingerprint-order: id, walletId, status, transactionSign
  create_group:
    post:
      tags:
      - Webhooks
      summary: Group - Group Created
      description: A new `Group` has been created.
      operationId: webhook-group-create-group
      parameters:
      - name: X-Soldo-Fingerprint
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint}}'
          description: '[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.'
          example: '{{fingerprint}}'
      - name: X-Soldo-Fingerprint-Order
        in: header
        required: true
        schema:
          type: string
          default: id, name, type, customReferenceId
          description: '[Webhook authentication](ref:webhook-authentication): The order of the values used to calculate the fingerprint.'
          example: id, name, type, customReferenceId
      - name: X-Soldo-Fingerprint-Signature
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint_signature}}'
          description: '[Webhook authentication](ref:webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](ref:soldo-public-key).'
          example: '{{fingerprint_signature}}'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateGroupEvent'
      responses:
        '200':
          description: Success.
      x-soldo:
        fingerprint-order: id, name, type, customReferenceId
  update_group:
    post:
      tags:
      - Webhooks
      summary: Group - Update Group
      description: A `Group` has been updated.
      operationId: webhook-group-update-group
      parameters:
      - name: X-Soldo-Fingerprint
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint}}'
          description: '[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.'
          example: '{{fingerprint}}'
      - name: X-Soldo-Fingerprint-Order
        in: header
        required: true
        schema:
          type: string
          default: id, name, type, customReferenceId
          description: '[Webhook authentication](ref:webhook-authentication): The order of the values used to calculate the fingerprint.'
          example: id, name, type, customReferenceId
      - name: X-Soldo-Fingerprint-Signature
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint_signature}}'
          description: '[Webhook authentication](ref:webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](ref:soldo-public-key).'
          example: '{{fingerprint_signature}}'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateGroupEvent'
      responses:
        '200':
          description: Success.
      x-soldo:
        fingerprint-order: id, name, type, customReferenceId
  user_updated:
    post:
      tags:
      - Webhooks
      summary: User - User Updated
      description: An `User` has been updated.
      operationId: webhook-user-user-updated
      parameters:
      - name: X-Soldo-Fingerprint
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint}}'
          description: '[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.'
          example: '{{fingerprint}}'
      - name: X-Soldo-Fingerprint-Order
        in: header
        required: true
        schema:
          type: string
          default: id, name, surname, status
          description: '[Webhook authentication](ref:webhook-authentication): The order of the values used to calculate the fingerprint.'
          example: id, name, surname, status
      - name: X-Soldo-Fingerprint-Signature
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint_signature}}'
          description: '[Webhook authentication](ref:webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](ref:soldo-public-key).'
          example: '{{fingerprint_signature}}'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserUpdatedEvent'
      responses:
        '200':
          description: Success.
      x-soldo:
        fingerprint-order: id, name, surname, status
  subscription_assignee_added:
    post:
      tags:
      - Webhooks
      summary: Subscription - Subscription Assignee Added
      description: A `Subscription` assignee is added.
      operationId: webhook-subscription-subscription-assignee-added
      parameters:
      - name: X-Soldo-Fingerprint
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint}}'
          description: '[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.'
          example: '{{fingerprint}}'
      - name: X-Soldo-Fingerprint-Order
        in: header
        required: true
        schema:
          type: string
          default: id, name, platform, status, paymentFrequency, cardId
          description: '[Webhook authentication](ref:webhook-authentication): The order of the values used to calculate the fingerprint.'
          example: id, name, platform, status, paymentFrequency, cardId
      - name: X-Soldo-Fingerprint-Signature
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint_signature}}'
          description: '[Webhook authentication](ref:webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](ref:soldo-public-key).'
          example: '{{fingerprint_signature}}'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SubscriptionAssigneeAddedEvent'
      responses:
        '200':
          description: Success.
      x-soldo:
        fingerprint-order: id, name, platform, status, paymentFrequency, cardId
  inbound_payment:
    post:
      tags:
      - Webhooks
      summary: Transaction - Inbound Payment
      description: Inbound payment from Faster Payment
      operationId: webhook-transaction-inbound-payment
      parameters:
      - name: X-Soldo-Fingerprint
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint}}'
          description: '[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.'
          example: '{{fingerprint}}'
      - name: X-Soldo-Fingerprint-Order
        in: header
        required: true
        schema:
          type: string
          default: id, walletId, status, transactionSign
          description: '[Webhook authentication](ref:webhook-authentication): The order of the values used to calculate the fingerprint.'
          example: id, walletId, status, transactionSign
      - name: X-Soldo-Fingerprint-Signature
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint_signature}}'
          description: '[Webhook authentication](ref:webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](ref:soldo-public-key).'
          example: '{{fingerprint_signature}}'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InboundPaymentEvent'
      responses:
        '200':
          description: Success.
      x-soldo:
        fingerprint-order: id, walletId, status, transactionSign
  joule_feed:
    post:
      tags:
      - Webhooks
      summary: Transaction - Joule Feed
      description: A `Transaction` has been settled/reversed.
      operationId: webhook-transaction-joule-feed
      parameters:
      - name: X-Soldo-Fingerprint
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint}}'
          description: '[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.'
          example: '{{fingerprint}}'
      - name: X-Soldo-Fingerprint-Order
        in: header
        required: true
        schema:
          type: string
          default: id, walletId, status, transactionSign
          description: '[Webhook authentication](ref:webhook-authentication): The order of the values used to calculate the fingerprint.'
          example: id, walletId, status, transactionSign
      - name: X-Soldo-Fingerprint-Signature
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint_signature}}'
          description: '[Webhook authentication](ref:webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](ref:soldo-public-key).'
          example: '{{fingerprint_signature}}'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/JouleFeedEvent'
      responses:
        '200':
          description: Success.
      x-soldo:
        fingerprint-order: id, walletId, status, transactionSign
  transaction_business_trip_linked:
    post:
      tags:
      - Webhooks
      summary: Transaction - Transaction Business Trip Linked
      description: A `Transaction` has been linked to a `BusinessTrip`.
      operationId: webhook-transaction-transaction-business-trip-linked
      parameters:
      - name: X-Soldo-Fingerprint
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint}}'
          description: '[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.'
          example: '{{fingerprint}}'
      - name: X-Soldo-Fingerprint-Order
        in: header
        required: true
        schema:
          type: string
          default: id, walletId, status, transactionSign
          description: '[Webhook authentication](ref:webhook-authentication): The order of the values used to calculate the fingerprint.'
          example: id, walletId, status, transactionSign
      - name: X-Soldo-Fingerprint-Signature
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint_signature}}'
          description: '[Webhook authentication](ref:webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](ref:soldo-public-key).'
          example: '{{fingerprint_signature}}'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TransactionBusinessTripLinkedEvent'
      responses:
        '200':
          description: Success.
      x-soldo:
        fingerprint-order: id, walletId, status, transactionSign
  transaction_deleted:
    post:
      tags:
      - Webhooks
      summary: Transaction - Transaction Deleted
      description: A `Transaction` has been deleted. This may happen only for `OUT_OF_PLATFORM_COMPANY` or `OUT_OF_PLATFORM_PERSONAL` transactions.
      operationId: webhook-transaction-transaction-deleted
      parameters:
      - name: X-Soldo-Fingerprint
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint}}'
          description: '[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.'
          example: '{{fingerprint}}'
      - name: X-Soldo-Fingerprint-Order
        in: header
        required: true
        schema:
          type: string
          default: id, walletId, status, transactionSign
          description: '[Webhook authentication](ref:webhook-authentication): The order of the values used to calculate the fingerprint.'
          example: id, walletId, status, transactionSign
      - name: X-Soldo-Fingerprint-Signature
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint_signature}}'
          description: '[Webhook authentication](ref:webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](ref:soldo-public-key).'
          example: '{{fingerprint_signature}}'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TransactionDeletedEvent'
      responses:
        '200':
          description: Success.
      x-soldo:
        fingerprint-order: id, walletId, status, transactionSign
  vehicle_create:
    post:
      tags:
      - Webhooks
      summary: Vehicle - Vehicle Create
      description: A `Vehicle` has been created.
      operationId: webhook-vehicle-vehicle-create
      parameters:
      - name: X-Soldo-Fingerprint
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint}}'
          description: '[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.'
          example: '{{fingerprint}}'
      - name: X-Soldo-Fingerprint-Order
        in: header
        required: true
        schema:
          type: string
          default: id,numberPlate
          description: '[Webhook authentication](ref:webhook-authentication): The order of the values used to calculate the fingerprint.'
          example: id,numberPlate
      - name: X-Soldo-Fingerprint-Signature
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint_signature}}'
          description: '[Webhook authentication](ref:webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](ref:soldo-public-key).'
          example: '{{fingerprint_signature}}'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/VehicleCreateEvent'
      responses:
        '200':
          description: Success.
      x-soldo:
        fingerprint-order: id,numberPlate
  card_replaced:
    post:
      tags:
      - Webhooks
      summary: Card - Card Replaced
      description: A `Card` has been replaced.
      operationId: webhook-card-card-replaced
      parameters:
      - name: X-Soldo-Fingerprint
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint}}'
          description: '[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.'
          example: '{{fingerprint}}'
      - name: X-Soldo-Fingerprint-Order
        in: header
        required: true
        schema:
          type: string
          default: id, name, status, walletId
          description: '[Webhook authentication](ref:webhook-authentication): The order of the values used to calculate the fingerprint.'
          example: id, name, status, walletId
      - name: X-Soldo-Fingerprint-Signature
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint_signature}}'
          description: '[Webhook authentication](ref:webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](ref:soldo-public-key).'
          example: '{{fingerprint_signature}}'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CardReplacedEvent'
      responses:
        '200':
          description: Success.
      x-soldo:
        fingerprint-order: id, name, status, walletId
  card_stolen:
    post:
      tags:
      - Webhooks
      summary: Card - Card Stolen
      description: A `Card` has been reported as stolen.
      operationId: webhook-card-card-stolen
      parameters:
      - name: X-Soldo-Fingerprint
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint}}'
          description: '[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.'
          example: '{{fingerprint}}'
      - name: X-Soldo-Fingerprint-Order
        in: header
        required: true
        schema:
          type: string
          default: id, name, status, walletId
          description: '[Webhook authentication](ref:webhook-authentication): The order of the values used to calculate the fingerprint.'
          example: id, name, status, walletId
      - name: X-Soldo-Fingerprint-Signature
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint_signature}}'
          description: '[Webhook authentication](ref:webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](ref:soldo-public-key).'
          example: '{{fingerprint_signature}}'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CardStolenEvent'
      responses:
        '200':
          description: Success.
      x-soldo:
        fingerprint-order: id, name, status, walletId
  card_creation:
    post:
      tags:
      - Webhooks
      summary: Card - Card Creation
      description: A new `Card` has been created.
      operationId: webhook-card-card-creation
      parameters:
      - name: X-Soldo-Fingerprint
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint}}'
          description: '[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.'
          example: '{{fingerprint}}'
      - name: X-Soldo-Fingerprint-Order
        in: header
        required: true
        schema:
          type: string
          default: id, name, status, walletId
          description: '[Webhook authentication](ref:webhook-authentication): The order of the values used to calculate the fingerprint.'
          example: id, name, status, walletId
      - name: X-Soldo-Fingerprint-Signature
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint_signature}}'
          description: '[Webhook authentication](ref:webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](ref:soldo-public-key).'
          example: '{{fingerprint_signature}}'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CardCreationEvent'
      responses:
        '200':
          description: Success.
      x-soldo:
        fingerprint-order: id, name, status, walletId
  add_resources_card:
    post:
      tags:
      - Webhooks
      summary: Group - Add Resources Card
      description: A `Card` has been added to a `Group`.
      operationId: webhook-group-add-resources-card
      parameters:
      - name: X-Soldo-Fingerprint
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint}}'
          description: '[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.'
          example: '{{fingerprint}}'
      - name: X-Soldo-Fingerprint-Order
        in: header
        required: true
        schema:
          type: string
          default: id, name, type, customReferenceId
          description: '[Webhook authentication](ref:webhook-authentication): The order of the values used to calculate the fingerprint.'
          example: id, name, type, customReferenceId
      - name: X-Soldo-Fingerprint-Signature
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint_signature}}'
          description: '[Webhook authentication](ref:webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](ref:soldo-public-key).'
          example: '{{fingerprint_signature}}'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AddResourcesCardEvent'
      responses:
        '200':
          description: Success.
      x-soldo:
        fingerprint-order: id, name, type, customReferenceId
  online_ads_created:
    post:
      tags:
      - Webhooks
      summary: OnlineAds - OnlineAds Created
      description: An `OnlineAds` has been created.
      operationId: webhook-onlineads-online-ads-created
      parameters:
      - name: X-Soldo-Fingerprint
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint}}'
          description: '[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.'
          example: '{{fingerprint}}'
      - name: X-Soldo-Fingerprint-Order
        in: header
        required: true
        schema:
          type: string
          default: id, name, walletId, cardId
          description: '[Webhook authentication](ref:webhook-authentication): The order of the values used to calculate the fingerprint.'
          example: id, name, walletId, cardId
      - name: X-Soldo-Fingerprint-Signature
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint_signature}}'
          description: '[Webhook authentication](ref:webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](ref:soldo-public-key).'
          example: '{{fingerprint_signature}}'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OnlineAdsCreatedEvent'
      responses:
        '200':
          description: Success.
      x-soldo:
        fingerprint-order: id, name, walletId, cardId
  vehicle_delete:
    post:
      tags:
      - Webhooks
      summary: Vehicle - Vehicle Delete
      description: A `Vehicle` has been deleted.
      operationId: webhook-vehicle-vehicle-delete
      parameters:
      - name: X-Soldo-Fingerprint
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint}}'
          description: '[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.'
          example: '{{fingerprint}}'
      - name: X-Soldo-Fingerprint-Order
        in: header
        required: true
        schema:
          type: string
          default: id,numberPlate
          description: '[Webhook authentication](ref:webhook-authentication): The order of the values used to calculate the fingerprint.'
          example: id,numberPlate
      - name: X-Soldo-Fingerprint-Signature
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint_signature}}'
          description: '[Webhook authentication](ref:webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](ref:soldo-public-key).'
          example: '{{fingerprint_signature}}'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/VehicleDeleteEvent'
      responses:
        '200':
          description: Success.
      x-soldo:
        fingerprint-order: id,numberPlate
  remove_resources_member:
    post:
      tags:
      - Webhooks
      summary: Group - Remove Resources Member
      description: An `User` has been removed from a `Group`.
      operationId: webhook-group-remove-resources-member
      parameters:
      - name: X-Soldo-Fingerprint
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint}}'
          description: '[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.'
          example: '{{fingerprint}}'
      - name: X-Soldo-Fingerprint-Order
        in: header
        required: true
        schema:
          type: string
          default: id, name, type, customReferenceId
          description: '[Webhook authentication](ref:webhook-authentication): The order of the values used to calculate the fingerprint.'
          example: id, name, type, customReferenceId
      - name: X-Soldo-Fingerprint-Signature
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint_signature}}'
          description: '[Webhook authentication](ref:webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](ref:soldo-public-key).'
          example: '{{fingerprint_signature}}'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RemoveResourcesMemberEvent'
      responses:
        '200':
          description: Success.
      x-soldo:
        fingerprint-order: id, name, type, customReferenceId
  subscription_created:
    post:
      tags:
      - Webhooks
      summary: Subscription - Subscription Created
      description: A `Subscription` has been created.
      operationId: webhook-subscription-subscription-created
      parameters:
      - name: X-Soldo-Fingerprint
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint}}'
          description: '[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.'
          example: '{{fingerprint}}'
      - name: X-Soldo-Fingerprint-Order
        in: header
        required: true
        schema:
          type: string
          default: id, name, platform, status, paymentFrequency, cardId
          description: '[Webhook authentication](ref:webhook-authentication): The order of the values used to calculate the fingerprint.'
          example: id, name, platform, status, paymentFrequency, cardId
      - name: X-Soldo-Fingerprint-Signature
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint_signature}}'
          description: '[Webhook authentication](ref:webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](ref:soldo-public-key).'
          example: '{{fingerprint_signature}}'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SubscriptionCreatedEvent'
      responses:
        '200':
          description: Success.
      x-soldo:
        fingerprint-order: id, name, platform, status, paymentFrequency, cardId
  add_resources_wallet:
    post:
      tags:
      - Webhooks
      summary: Group - Add Resources Wallet
      description: A `Wallet` has been added to a `Group`.
      operationId: webhook-group-add-resources-wallet
      parameters:
      - name: X-Soldo-Fingerprint
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint}}'
          description: '[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.'
          example: '{{fingerprint}}'
      - name: X-Soldo-Fingerprint-Order
        in: header
        required: true
        schema:
          type: string
          default: id, name, type, customReferenceId
          description: '[Webhook authentication](ref:webhook-authentication): The order of the values used to calculate the fingerprint.'
          example: id, name, type, customReferenceId
      - name: X-Soldo-Fingerprint-Signature
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint_signature}}'
          description: '[Webhook authentication](ref:webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](ref:soldo-public-key).'
          example: '{{fingerprint_signature}}'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AddResourcesWalletEvent'
      responses:
        '200':
          description: Success.
      x-soldo:
        fingerprint-order: id, name, type, customReferenceId
  balanced_transfer:
    post:
      tags:
      - Webhooks
      summary: Transaction - Balanced Transfer
      description: Failed balanced internal transfer to top-up a `Wallet`.
      operationId: webhook-transaction-balanced-transfer
      parameters:
      - name: X-Soldo-Fingerprint
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint}}'
          description: '[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.'
          example: '{{fingerprint}}'
      - name: X-Soldo-Fingerprint-Order
        in: header
        required: true
        schema:
          type: string
          default: id, walletId, status, transactionSign
          description: '[Webhook authentication](ref:webhook-authentication): The order of the values used to calculate the fingerprint.'
          example: id, walletId, status, transactionSign
      - name: X-Soldo-Fingerprint-Signature
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint_signature}}'
          description: '[Webhook authentication](ref:webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](ref:soldo-public-key).'
          example: '{{fingerprint_signature}}'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BalancedTransferEvent'
      responses:
        '200':
          description: Success.
      x-soldo:
        fingerprint-order: id, walletId, status, transactionSign
  vehicle_update:
    post:
      tags:
      - Webhooks
      summary: Vehicle - Vehicle Update
      description: A `Vehicle` has been updated.
      operationId: webhook-vehicle-vehicle-update
      parameters:
      - name: X-Soldo-Fingerprint
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint}}'
          description: '[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.'
          example: '{{fingerprint}}'
      - name: X-Soldo-Fingerprint-Order
        in: header
        required: true
        schema:
          type: string
          default: id,numberPlate
          description: '[Webhook authentication](ref:webhook-authentication): The order of the values used to calculate the fingerprint.'
          example: id,numberPlate
      - name: X-Soldo-Fingerprint-Signature
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint_signature}}'
          description: '[Webhook authentication](ref:webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](ref:soldo-public-key).'
          example: '{{fingerprint_signature}}'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/VehicleUpdateEvent'
      responses:
        '200':
          description: Success.
      x-soldo:
        fingerprint-order: id,numberPlate
  online_ads_activated:
    post:
      tags:
      - Webhooks
      summary: OnlineAds - OnlineAds Activated
      description: An `OnlineAds` has been activated.
      operationId: webhook-onlineads-online-ads-activated
      parameters:
      - name: X-Soldo-Fingerprint
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint}}'
          description: '[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.'
          example: '{{fingerprint}}'
      - name: X-Soldo-Fingerprint-Order
        in: header
        required: true
        schema:
          type: string
          default: id, name, walletId, cardId
          description: '[Webhook authentication](ref:webhook-authentication): The order of the values used to calculate the fingerprint.'
          example: id, name, walletId, cardId
      - name: X-Soldo-Fingerprint-Signature
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint_signature}}'
          description: '[Webhook authentication](ref:webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](ref:soldo-public-key).'
          example: '{{fingerprint_signature}}'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OnlineAdsActivatedEvent'
      responses:
        '200':
          description: Success.
      x-soldo:
        fingerprint-order: id, name, walletId, cardId
  card_label_updated:
    post:
      tags:
      - Webhooks
      summary: Card - Card Update Label
      description: A label `Card` has been updated label.
      operationId: webhook-card-card_label_updated
      parameters:
      - name: X-Soldo-Fingerprint
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint}}'
          description: '[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.'
          example: '{{fingerprint}}'
      - name: X-Soldo-Fingerprint-Order
        in: header
        required: true
        schema:
          type: string
          default: id,label,token
          description: '[Webhook authentication](ref:webhook-authentication): The order of the values used to calculate the fingerprint.'
          example: id, name, status, walletId
      - name: X-Soldo-Fingerprint-Signature
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint_signature}}'
          description: '[Webhook authentication](ref:webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](ref:soldo-public-key).'
          example: '{{fingerprint_signature}}'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CardLabelUpdatedEvent'
      responses:
        '200':
          description: Success.
      x-soldo:
        fingerprint-order: id, name, status, walletId
  subscription_deleted:
    post:
      tags:
      - Webhooks
      summary: Subscription - Subscription Deleted
      description: A `Subscription` has been deleted.
      operationId: webhook-subscription-subscription-deleted
      parameters:
      - name: X-Soldo-Fingerprint
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint}}'
          description: '[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.'
          example: '{{fingerprint}}'
      - name: X-Soldo-Fingerprint-Order
        in: header
        required: true
        schema:
          type: string
          default: id, name, platform, status, paymentFrequency, cardId
          description: '[Webhook authentication](ref:webhook-authentication): The order of the values used to calculate the fingerprint.'
          example: id, name, platform, status, paymentFrequency, cardId
      - name: X-Soldo-Fingerprint-Signature
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint_signature}}'
          description: '[Webhook authentication](ref:webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](ref:soldo-public-key).'
          example: '{{fingerprint_signature}}'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SubscriptionDeletedEvent'
      responses:
        '200':
          description: Success.
      x-soldo:
        fingerprint-order: id, name, platform, status, paymentFrequency, cardId
  recurring_billing:
    post:
      tags:
      - Webhooks
      summary: Transaction - Recurring Billing
      description: Monthly billing.
      operationId: webhook-transaction-recurring-billing
      parameters:
      - name: X-Soldo-Fingerprint
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint}}'
          description: '[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.'
          example: '{{fingerprint}}'
      - name: X-Soldo-Fingerprint-Order
        in: header
        required: true
        schema:
          type: string
          default: id, walletId, status, transactionSign
          description: '[Webhook authentication](ref:webhook-authentication): The order of the values used to calculate the fingerprint.'
          example: id, walletId, status, transactionSign
      - name: X-Soldo-Fingerprint-Signature
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint_signature}}'
          description: '[Webhook authentication](ref:webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](ref:soldo-public-key).'
          example: '{{fingerprint_signature}}'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RecurringBillingEvent'
      responses:
        '200':
          description: Success.
      x-soldo:
        fingerprint-order: id, walletId, status, transactionSign
  upload_completed:
    post:
      tags:
      - Webhooks
      summary: Transaction Attachment - Upload Completed
      description: An attachment is uploaded to a `Transaction`.
      operationId: webhook-transactionattachment-upload-completed
      parameters:
      - name: X-Soldo-Fingerprint
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint}}'
          description: '[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.'
          example: '{{fingerprint}}'
      - name: X-Soldo-Fingerprint-Order
        in: header
        required: true
        schema:
          type: string
          default: attachmentId, transactionId, fileName
          description: '[Webhook authentication](ref:webhook-authentication): The order of the values used to calculate the fingerprint.'
          example: attachmentId, transactionId, fileName
      - name: X-Soldo-Fingerprint-Signature
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint_signature}}'
          description: '[Webhook authentication](ref:webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](ref:soldo-public-key).'
          example: '{{fingerprint_signature}}'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UploadCompletedEvent'
      responses:
        '200':
          description: Success.
      x-soldo:
        fingerprint-order: attachmentId, transactionId, fileName
  subscription_updated:
    post:
      tags:
      - Webhooks
      summary: Subscription - Subscription Updated
      description: A `Subscription` has been updated.
      operationId: webhook-subscription-subscription-updated
      parameters:
      - name: X-Soldo-Fingerprint
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint}}'
          description: '[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.'
          example: '{{fingerprint}}'
      - name: X-Soldo-Fingerprint-Order
        in: header
        required: true
        schema:
          type: string
          default: id, name, platform, status, paymentFrequency, cardId
          description: '[Webhook authentication](ref:webhook-authentication): The order of the values used to calculate the fingerprint.'
          example: id, name, platform, status, paymentFrequency, cardId
      - name: X-Soldo-Fingerprint-Signature
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint_signature}}'
          description: '[Webhook authentication](ref:webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](ref:soldo-public-key).'
          example: '{{fingerprint_signature}}'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SubscriptionUpdatedEvent'
      responses:
        '200':
          description: Success.
      x-soldo:
        fingerprint-order: id, name, platform, status, paymentFrequency, cardId
  online_ads_deleted:
    post:
      tags:
      - Webhooks
      summary: OnlineAds - OnlineAds Deleted
      description: An `OnlineAds` has been deleted.
      operationId: webhook-onlineads-online-ads-deleted
      parameters:
      - name: X-Soldo-Fingerprint
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint}}'
          description: '[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.'
          example: '{{fingerprint}}'
      - name: X-Soldo-Fingerprint-Order
        in: header
        required: true
        schema:
          type: string
          default: id, name, walletId, cardId
          description: '[Webhook authentication](ref:webhook-authentication): The order of the values used to calculate the fingerprint.'
          example: id, name, walletId, cardId
      - name: X-Soldo-Fingerprint-Signature
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint_signature}}'
          description: '[Webhook authentication](ref:webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](ref:soldo-public-key).'
          example: '{{fingerprint_signature}}'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OnlineAdsDeletedEvent'
      responses:
        '200':
          description: Success.
      x-soldo:
        fingerprint-order: id, name, walletId, cardId
  conversion:
    post:
      tags:
      - Webhooks
      summary: Transaction - Conversion
      description: A transfer between `Wallets` with different currencies.
      operationId: webhook-transaction-conversion
      parameters:
      - name: X-Soldo-Fingerprint
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint}}'
          description: '[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.'
          example: '{{fingerprint}}'
      - name: X-Soldo-Fingerprint-Order
        in: header
        required: true
        schema:
          type: string
          default: id, walletId, status, transactionSign
          description: '[Webhook authentication](ref:webhook-authentication): The order of the values used to calculate the fingerprint.'
          example: id, walletId, status, transactionSign
      - name: X-Soldo-Fingerprint-Signature
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint_signature}}'
          description: '[Webhook authentication](ref:webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](ref:soldo-public-key).'
          example: '{{fingerprint_signature}}'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConversionEvent'
      responses:
        '200':
          description: Success.
      x-soldo:
        fingerprint-order: id, walletId, status, transactionSign
  edit_tag:
    post:
      tags:
      - Webhooks
      summary: Transaction - Tag Edited
      description: A `Tag` has been added or removed from a `Transaction`.
      operationId: webhook-transaction-edit-tag
      parameters:
      - name: X-Soldo-Fingerprint
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint}}'
          description: '[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.'
          example: '{{fingerprint}}'
      - name: X-Soldo-Fingerprint-Order
        in: header
        required: true
        schema:
          type: string
          default: id, walletId, status, transactionSign
          description: '[Webhook authentication](ref:webhook-authentication): The order of the values used to calculate the fingerprint.'
          example: id, walletId, status, transactionSign
      - name: X-Soldo-Fingerprint-Signature
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint_signature}}'
          description: '[Webhook authentication](ref:webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](ref:soldo-public-key).'
          example: '{{fingerprint_signature}}'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EditTagEvent'
      responses:
        '200':
          description: Success.
      x-soldo:
        fingerprint-order: id, walletId, status, transactionSign
  contact_updated:
    post:
      tags:
      - Webhooks
      summary: Contact - Contact Updated
      description: A `Contact` has been updated.
      operationId: webhook-contact-contact-updated
      parameters:
      - name: X-Soldo-Fingerprint
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint}}'
          description: '[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.'
          example: '{{fingerprint}}'
      - name: X-Soldo-Fingerprint-Order
        in: header
        required: true
        schema:
          type: string
          default: id, name, userId, type, status
          description: '[Webhook authentication](ref:webhook-authentication): The order of the values used to calculate the fingerprint.'
          example: id, name, userId, type, status
      - name: X-Soldo-Fingerprint-Signature
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint_signature}}'
          description: '[Webhook authentication](ref:webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](ref:soldo-public-key).'
          example: '{{fingerprint_signature}}'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ContactUpdatedEvent'
      responses:
        '200':
          description: Success.
      x-soldo:
        fingerprint-order: id, name, userId, type, status
  online_ads_assignee_added:
    post:
      tags:
      - Webhooks
      summary: OnlineAds - OnlineAds Assignee Added
      description: An `OnlineAds` assignee has been added.
      operationId: webhook-onlineads-online-ads-assignee-added
      parameters:
      - name: X-Soldo-Fingerprint
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint}}'
          description: '[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.'
          example: '{{fingerprint}}'
      - name: X-Soldo-Fingerprint-Order
        in: header
        required: true
        schema:
          type: string
          default: id, name, walletId, cardId
          description: '[Webhook authentication](ref:webhook-authentication): The order of the values used to calculate the fingerprint.'
          example: id, name, walletId, cardId
      - name: X-Soldo-Fingerprint-Signature
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint_signature}}'
          description: '[Webhook authentication](ref:webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](ref:soldo-public-key).'
          example: '{{fingerprint_signature}}'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OnlineAdsAssigneeAddedEvent'
      responses:
        '200':
          description: Success.
      x-soldo:
        fingerprint-order: id, name, walletId, cardId
  purchase_update:
    post:
      tags:
      - Webhooks
      summary: Pre-Approved Spend - Purchase Update
      description: A `Purchase` has been updated.
      operationId: webhook-preapprovedspend-purchase-update
      parameters:
      - name: X-Soldo-Fingerprint
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint}}'
          description: '[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.'
          example: '{{fingerprint}}'
      - name: X-Soldo-Fingerprint-Order
        in: header
        required: true
        schema:
          type: string
          default: id, title, description, amount, amountCurrency
          description: '[Webhook authentication](ref:webhook-authentication): The order of the values used to calculate the fingerprint.'
          example: id, title, description, amount, amountCurrency
      - name: X-Soldo-Fingerprint-Signature
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint_signature}}'
          description: '[Webhook authentication](ref:webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](ref:soldo-public-key).'
          example: '{{fingerprint_signature}}'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PurchaseUpdateEvent'
      responses:
        '200':
          description: Success.
      x-soldo:
        fingerprint-order: id, title, description, amount, amountCurrency
  online_ads_assignee_removed:
    post:
      tags:
      - Webhooks
      summary: OnlineAds - OnlineAds Assignee Removed
      description: An `OnlineAds` assignee has been removed.
      operationId: webhook-onlineads-online-ads-assignee-removed
      parameters:
      - name: X-Soldo-Fingerprint
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint}}'
          description: '[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.'
          example: '{{fingerprint}}'
      - name: X-Soldo-Fingerprint-Order
        in: header
        required: true
        schema:
          type: string
          default: id, name, walletId, cardId
          description: '[Webhook authentication](ref:webhook-authentication): The order of the values used to calculate the fingerprint.'
          example: id, name, walletId, cardId
      - name: X-Soldo-Fingerprint-Signature
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint_signature}}'
          description: '[Webhook authentication](ref:webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](ref:soldo-public-key).'
          example: '{{fingerprint_signature}}'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OnlineAdsAssigneeRemovedEvent'
      responses:
        '200':
          description: Success.
      x-soldo:
        fingerprint-order: id, name, walletId, cardId
  wallet_deleted:
    post:
      tags:
      - Webhooks
      summary: Wallet - Wallet Deleted
      description: A `Wallet` has been deleted.
      operationId: webhook-wallet-wallet-deleted
      parameters:
      - name: X-Soldo-Fingerprint
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint}}'
          description: '[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.'
          example: '{{fingerprint}}'
      - name: X-Soldo-Fingerprint-Order
        in: header
        required: true
        schema:
          type: string
          default: id, name, currencyCode, primaryUserPublicId
          description: '[Webhook authentication](ref:webhook-authentication): The order of the values used to calculate the fingerprint.'
          example: id, name, currencyCode, primaryUserPublicId
      - name: X-Soldo-Fingerprint-Signature
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint_signature}}'
          description: '[Webhook authentication](ref:webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](ref:soldo-public-key).'
          example: '{{fingerprint_signature}}'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WalletDeletedEvent'
      responses:
        '200':
          description: Success.
      x-soldo:
        fingerprint-order: id, name, currencyCode, primaryUserPublicId
  remove_resources_wallet:
    post:
      tags:
      - Webhooks
      summary: Group - Remove Resources Wallet
      description: A `Wallet` is removed from a `Group`.
      operationId: webhook-group-remove-resources-wallet
      parameters:
      - name: X-Soldo-Fingerprint
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint}}'
          description: '[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.'
          example: '{{fingerprint}}'
      - name: X-Soldo-Fingerprint-Order
        in: header
        required: true
        schema:
          type: string
          default: id, name, type, customReferenceId
          description: '[Webhook authentication](ref:webhook-authentication): The order of the values used to calculate the fingerprint.'
          example: id, name, type, customReferenceId
      - name: X-Soldo-Fingerprint-Signature
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint_signature}}'
          description: '[Webhook authentication](ref:webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](ref:soldo-public-key).'
          example: '{{fingerprint_signature}}'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RemoveResourcesWalletEvent'
      responses:
        '200':
          description: Success.
      x-soldo:
        fingerprint-order: id, name, type, customReferenceId
  enabled_expense_configuration:
    post:
      tags:
      - Webhooks
      summary: Expense Review - Configuration Enabled
      description: An `ExpenseReview` configuration has been enabled.
      operationId: webhook-expensereview-enabled-expense-configuration
      parameters:
      - name: X-Soldo-Fingerprint
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint}}'
          description: '[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.'
          example: '{{fingerprint}}'
      - name: X-Soldo-Fingerprint-Order
        in: header
        required: true
        schema:
          type: string
          default: startDate, policyUrl, enabled, transactionId
          description: '[Webhook authentication](ref:webhook-authentication): The order of the values used to calculate the fingerprint.'
          example: startDate, policyUrl, enabled, transactionId
      - name: X-Soldo-Fingerprint-Signature
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint_signature}}'
          description: '[Webhook authentication](ref:webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](ref:soldo-public-key).'
          example: '{{fingerprint_signature}}'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EnabledExpenseConfigurationEvent'
      responses:
        '200':
          description: Success.
      x-soldo:
        fingerprint-order: startDate, policyUrl, enabled, transactionId
  completed_transactions_import:
    post:
      tags:
      - Webhooks
      summary: Expense Review - Transaction Import Completed
      description: A `Transaction` import has been completed.
      operationId: webhook-expensereview-completed-transactions-import
      parameters:
      - name: X-Soldo-Fingerprint
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint}}'
          description: '[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.'
          example: '{{fingerprint}}'
      - name: X-Soldo-Fingerprint-Order
        in: header
        required: true
        schema:
          type: string
          default: startDate, policyUrl, enabled, transactionId
          description: '[Webhook authentication](ref:webhook-authentication): The order of the values used to calculate the fingerprint.'
          example: startDate, policyUrl, enabled, transactionId
      - name: X-Soldo-Fingerprint-Signature
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint_signature}}'
          description: '[Webhook authentication](ref:webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](ref:soldo-public-key).'
          example: '{{fingerprint_signature}}'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CompletedTransactionsImportEvent'
      responses:
        '200':
          description: Success.
      x-soldo:
        fingerprint-order: startDate, policyUrl, enabled, transactionId
  store_order_placed:
    post:
      tags:
      - Webhooks
      summary: Order - Store Order Placed
      description: An `Order` has been placed.
      operationId: webhook-order-store-order-placed
      parameters:
      - name: X-Soldo-Fingerprint
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint}}'
          description: '[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.'
          example: '{{fingerprint}}'
      - name: X-Soldo-Fingerprint-Order
        in: header
        required: true
        schema:
          type: string
          default: id, status
          description: '[Webhook authentication](ref:webhook-authentication): The order of the values used to calculate the fingerprint.'
          example: id, status
      - name: X-Soldo-Fingerprint-Signature
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint_signature}}'
          description: '[Webhook authentication](ref:webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](ref:soldo-public-key).'
          example: '{{fingerprint_signature}}'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StoreOrderPlacedEvent'
      responses:
        '200':
          description: Success.
      x-soldo:
        fingerprint-order: id, status
  purchase_create:
    post:
      tags:
      - Webhooks
      summary: Pre-Approved Spend - Purchase Create
      description: A `Purchase` has been created.
      operationId: webhook-preapprovedspend-purchase-create
      parameters:
      - name: X-Soldo-Fingerprint
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint}}'
          description: '[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.'
          example: '{{fingerprint}}'
      - name: X-Soldo-Fingerprint-Order
        in: header
        required: true
        schema:
          type: string
          default: id, title, description, amount, amountCurrency
          description: '[Webhook authentication](ref:webhook-authentication): The order of the values used to calculate the fingerprint.'
          example: id, title, description, amount, amountCurrency
      - name: X-Soldo-Fingerprint-Signature
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint_signature}}'
          description: '[Webhook authentication](ref:webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](ref:soldo-public-key).'
          example: '{{fingerprint_signature}}'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PurchaseCreateEvent'
      responses:
        '200':
          description: Success.
      x-soldo:
        fingerprint-order: id, title, description, amount, amountCurrency
  subscription_assignee_removed:
    post:
      tags:
      - Webhooks
      summary: Subscription - Subscription Assignee Removed
      description: A `Subscription` assignee is removed.
      operationId: webhook-subscription-subscription-assignee-removed
      parameters:
      - name: X-Soldo-Fingerprint
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint}}'
          description: '[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.'
          example: '{{fingerprint}}'
      - name: X-Soldo-Fingerprint-Order
        in: header
        required: true
        schema:
          type: string
          default: id, name, platform, status, paymentFrequency, cardId
          description: '[Webhook authentication](ref:webhook-authentication): The order of the values used to calculate the fingerprint.'
          example: id, name, platform, status, paymentFrequency, cardId
      - name: X-Soldo-Fingerprint-Signature
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint_signature}}'
          description: '[Webhook authentication](ref:webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](ref:soldo-public-key).'
          example: '{{fingerprint_signature}}'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SubscriptionAssigneeRemovedEvent'
      responses:
        '200':
          description: Success.
      x-soldo:
        fingerprint-order: id, name, platform, status, paymentFrequency, cardId
  contact_created:
    post:
      tags:
      - Webhooks
      summary: Contact - Contact Created
      description: A `Contact` has been created.
      operationId: webhook-contact-contact-created
      parameters:
      - name: X-Soldo-Fingerprint
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint}}'
          description: '[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.'
          example: '{{fingerprint}}'
      - name: X-Soldo-Fingerprint-Order
        in: header
        required: true
        schema:
          type: string
          default: id, name, userId, type, status
          description: '[Webhook authentication](ref:webhook-authentication): The order of the values used to calculate the fingerprint.'
          example: id, name, userId, type, status
      - name: X-Soldo-Fingerprint-Signature
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint_signature}}'
          description: '[Webhook authentication](ref:webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](ref:soldo-public-key).'
          example: '{{fingerprint_signature}}'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ContactCreatedEvent'
      responses:
        '200':
          description: Success.
      x-soldo:
        fingerprint-order: id, name, userId, type, status
  add_resources_member:
    post:
      tags:
      - Webhooks
      summary: Group - Add Resources Member
      description: An `User` has been added to a `Group`.
      operationId: webhook-group-add-resources-member
      parameters:
      - name: X-Soldo-Fingerprint
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint}}'
          description: '[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.'
          example: '{{fingerprint}}'
      - name: X-Soldo-Fingerprint-Order
        in: header
        required: true
        schema:
          type: string
          default: id, name, type, customReferenceId
          description: '[Webhook authentication](ref:webhook-authentication): The order of the values used to calculate the fingerprint.'
          example: id, name, type, customReferenceId
      - name: X-Soldo-Fingerprint-Signature
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint_signature}}'
          description: '[Webhook authentication](ref:webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](ref:soldo-public-key).'
          example: '{{fingerprint_signature}}'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AddResourcesMemberEvent'
      responses:
        '200':
          description: Success.
      x-soldo:
        fingerprint-order: id, name, type, customReferenceId
  internal_transfer:
    post:
      tags:
      - Webhooks
      summary: Transaction - Internal Transfer
      description: A Transfer between `Wallets` with the same currency
      operationId: webhook-transaction-internal-transfer
      parameters:
      - name: X-Soldo-Fingerprint
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint}}'
          description: '[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.'
          example: '{{fingerprint}}'
      - name: X-Soldo-Fingerprint-Order
        in: header
        required: true
        schema:
          type: string
          default: id, walletId, status, transactionSign
          description: '[Webhook authentication](ref:webhook-authentication): The order of the values used to calculate the fingerprint.'
          example: id, walletId, status, transactionSign
      - name: X-Soldo-Fingerprint-Signature
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint_signature}}'
          description: '[Webhook authentication](ref:webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](ref:soldo-public-key).'
          example: '{{fingerprint_signature}}'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InternalTransferEvent'
      responses:
        '200':
          description: Success.
      x-soldo:
        fingerprint-order: id, walletId, status, transactionSign
  card_assignee_updated:
    post:
      tags:
      - Webhooks
      summary: Card - Card Update Assignee
      description: A label `Card` has been updated assignee.
      operationId: webhook-card-card_assignee_updated
      parameters:
      - name: X-Soldo-Fingerprint
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint}}'
          description: '[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.'
          example: '{{fingerprint}}'
      - name: X-Soldo-Fingerprint-Order
        in: header
        required: true
        schema:
          type: string
          default: id,join(addCardAssignees),join(removeCardAssignees),token
          description: '[Webhook authentication](ref:webhook-authentication): The order of the values used to calculate the fingerprint.'
          example: id, name, status, walletId
      - name: X-Soldo-Fingerprint-Signature
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint_signature}}'
          description: '[Webhook authentication](ref:webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](ref:soldo-public-key).'
          example: '{{fingerprint_signature}}'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CardAssigneeUpdatedEvent'
      responses:
        '200':
          description: Success.
      x-soldo:
        fingerprint-order: id, name, status, walletId
  user_status_changed:
    post:
      tags:
      - Webhooks
      summary: User - User Status Changed
      description: The status of a `User` changed.
      operationId: webhook-user-user-status-changed
      parameters:
      - name: X-Soldo-Fingerprint
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint}}'
          description: '[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.'
          example: '{{fingerprint}}'
      - name: X-Soldo-Fingerprint-Order
        in: header
        required: true
        schema:
          type: string
          default: id, name, surname, status
          description: '[Webhook authentication](ref:webhook-authentication): The order of the values used to calculate the fingerprint.'
          example: id, name, surname, status
      - name: X-Soldo-Fingerprint-Signature
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint_signature}}'
          description: '[Webhook authentication](ref:webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](ref:soldo-public-key).'
          example: '{{fingerprint_signature}}'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserStatusChangedEvent'
      responses:
        '200':
          description: Success.
      x-soldo:
        fingerprint-order: id, name, surname, status
  subscription_activated:
    post:
      tags:
      - Webhooks
      summary: Subscription - Subscription Activated
      description: A `Subscription` has been activated.
      operationId: webhook-subscription-subscription-activated
      parameters:
      - name: X-Soldo-Fingerprint
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint}}'
          description: '[Webhook authentication](ref:webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.'
          example: '{{fingerprint}}'
      - name: X-Soldo-Fingerprint-Order
        in: header
        required: true
        schema:
          type: string
          default: id, name, platform, status, paymentFrequency, cardId
          description: '[Webhook authentication](ref:webhook-authentication): The order of the values used to calculate the fingerprint.'
          example: id, name, platform, status, paymentFrequency, cardId
      - name: X-Soldo-Fingerprint-Signature
        in: header
        required: true
        schema:
          type: string
          default: '{{fingerprint_signature}}'
          description: '[Webhook authentication](ref:webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](ref:soldo-public-key).'
          example: '{{fingerprint_signature}}'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SubscriptionActivatedEvent'
      responses:
        '200':
          description: Success.
      x-soldo:
        fingerprint-order: id, name, platform, status, paymentFrequency, cardId
components:
  schemas:
    Subscription:
      properties:
        id:
          type: string
          description: The `Subscription` ID.
          example: 7bf79328-a7ae-4222-aa54-091ff7f429a7
        name:
          type: string
          description: The name of the `Subscription`.
          example: EXAMPLE SUBSCRIPTION.
        description:
          type: string
          description: A custom description of the `Subscription`.
          example: This is a subscription
        platform:
          $ref: '#/components/schemas/SubscriptionPlatform'
          description: The platform the `Subscription` is made on.
          example: OTHER
        assignees:
          type: array
          description: List of `User` ID currently assigned to the `Subscription` and its `Card`.
          example:
          - XMPL1234-000001
          - XMPL1234-000002
          - XMPL1234-000003
          items:
            type: string
        status:
          $ref: '#/components/schemas/SubscriptionStatus'
          description: The status of the `Subscription`.
          example: ACTIVE
        wallet_id:
          type: string
          description: The ID of the `Wallet` the `Subscription` and its `Card` are linked to.
          example: 7bf79328-a7ae-4222-aa54-091ff7f429a7
        payment_frequency:
          $ref: '#/components/schemas/SubscriptionPaymentFrequency'
          description: The payment frequency indicates how often a `Transaction` is expected to be made.
          example: YEARLY
        last_spent:
          type: number
          description: The amount of the last `Transaction` made with the `Card`.
          example: 75.01
        total_spent:
          type: number
          description: The overall amount spent with the `Card`.
          example: 775.01
        card_id:
          type: string
          description: The ID of the `Card` reserved for this `Subscription` (only available after the subscription is activated).
          example: 2d65bd5e-3fdf-4002-b166-bde7fb8863fa
        last_spent_date:
          type: string
          description: The date and time of the last `Transaction` made with the `Card`.
          example: '2020-05-07T12:48:40Z'
        creation_time:
          type: string
          description: The date and time when the `Subscription` was last updated.
          example: '2017-06-01T12:48:40Z'
        last_update_time:
          type: string
          description: The date and time when the `Subscription` was last updated.
          example: '2017-06-01T12:48:40Z'
    PaymentSchema:
      type: string
      enum:
      - FPS
      - SEPA
      - SEPA_INSTANT
    ExpenseDateType:
      type: string
      enum:
      - TRANSACTION
      - SETTLEMENT
    CardRenewalInfo:
      properties:
        expiring_soon:
          type: boolean
          description: Whether the `Card` is approaching its expiration date.
          example: true
        renewed_card_ready_for_activation:
          type: boolean
          description: Whether the renewed `Card` is ready to be activated.
          example: true
    TransactionMerchantCategory:
      properties:
        description:
          type: string
          description: The merchant category description as defined in the Soldo platform.
          example: Travel
        mcc:
          type: string
          description: The official Mastercard Merchant Category Code (MCC).
          example: 7011
        mcc_description:
          type: string
          description: The official Mastercard Merchant category description.
          example: Lodging - Hotels, Motels, Resorts - not elsewhere classified
        code:
          type: string
          deprecated: true
          description: 'The merchant category code as defined in the Soldo platform. *Deprecated*: use `description` instead.'
          example: Lodging - Hotels, Motels, Resorts - not elsewhere classified
        sub_category:
          type: string
          description: The merchant sub-category as defined in the Soldo platform.
          example: Hotels
    TransactionCarbonEmissionInfo:
      properties:
        value:
          type: number
          description: The amount of greenhouses gas emissions generated.
        unit:
          type: string
          description: The unit of measure related to the `value` of greenhouses gas emissions generated.
    VehicleDeleteEvent:
      properties:
        event_uuid:
          type: string
          description: The webhook unique ID.
          example: 7bf79328-a7ae-4222-aa54-091ff7f429a7
        event_type:
          $ref: '#/components/schemas/WebhookEventType'
          default: Vehicle
          description: The webhook event type.
          example: Vehicle
        event_name:
          $ref: '#/components/schemas/WebhookEventName'
          default: vehicle_delete
          description: The webhook event name.
          example: vehicle_delete
        company_account_id:
          type: string
          description: The company account ID.
          example: XMPL1234
        data:
          $ref: '#/components/schemas/Vehicle'
          description: The webhook `Vehicle` data.
        subscription_id:
          type: string
          description: The webhook subscription ID used to route this event.
          example: 2d65bd5e-3fdf-4002-b166-bde7fb8863fa
    TransactionFuelDetails:
      description: The transaction fuel details `Refueling` resource
      properties:
        plate:
          type: string
          description: '`Vehicle`''s plate number.'
          example: AA000BB
        vehicle_fuel_type:
          $ref: '#/components/schemas/FuelType'
          description: Fuel type specified in the `Vehicle`'s configuration page.
          example: PETROL
        vat_deductibility_percentage:
          type: string
          description: The deductible VAT percentage configured for the `Vehicle`.
          example: 40%
        mileage:
          type: integer
          format: int32
          description: The `Vehicle` mileage.
          example: 125000
        quantity:
          type: number
          description: The fuel quantity as specified in the invoice.
          example: 80
        unit_price:
          type: number
          description: The fuel unit price as specified on the transaction.
          example: 1.41
        tx_fuel_type:
          $ref: '#/components/schemas/FuelType'
          description: The fuel type as specified on the transaction.
          example: PETROL
        to_be_ignored:
          type: boolean
          description: If the transaction link status is set to ignored.
          example: false
        invoice_id:
          type: integer
          format: int64
          description: Invoice ID.
          example: 4421109
        invoice_number:
          type: string
          description: Invoice number.
          example: NVC112200987
        invoice_date:
          type: string
          description: Invoice date.
          example: '2017-06-01T12:48:40Z'
        invoice_total_amount:
          type: number
          description: Total amount of the linked invoice.
          example: 10.25
        invoice_row:
          type: integer
          format: int32
          description: Row of the linked invoice.
          example: 4
        invoice_row_amount:
          type: number
          description: Amount of the transaction's row in the linked invoice.
          example: 10.25
        supplier_vat_id:
          type: string
          description: Supplier VAT ID.
          example: 98746784967
        dri:
          type: string
          description: The DRI (Documento Riepilogativo) code.
          example: DRI00099881
        vehicle_id:
          type: string
          description: The `Vehicle` ID.
          example: 6853e657-c797-4985-8d6b-5425d4e51df8
    UpdatedExpenseConfigurationEvent:
      properties:
        event_uuid:
          type: string
          description: The webhook unique ID.
          example: 7bf79328-a7ae-4222-aa54-091ff7f429a7
        event_type:
          $ref: '#/components/schemas/WebhookEventType'
          default: ExpenseReviewConfiguration
          description: The webhook event type.
          example: ExpenseReviewConfiguration
        event_name:
          $ref: '#/components/schemas/WebhookEventName'
          default: updated_expense_configuration
          description: The webhook event name.
          example: updated_expense_configuration
        company_account_id:
          type: string
          description: The company account ID.
          example: XMPL1234
        data:
          $ref: '#/components/schemas/ExpenseReviewConfiguration'
          description: The webhook `ExpenseReview` data.
        subscription_id:
          type: string
          description: The webhook subscription ID used to route this event.
          example: 2d65bd5e-3fdf-4002-b166-bde7fb8863fa
    SubscriptionActivatedEvent:
      properties:
        event_uuid:
          type: string
          description: The webhook unique ID.
          example: 7bf79328-a7ae-4222-aa54-091ff7f429a7
        event_type:
          $ref: '#/components/schemas/WebhookEventType'
          default: Subscription
          description: The webhook event type.
          example: Subscription
        event_name:
          $ref: '#/components/schemas/WebhookEventName'
          default: subscription_activated
          description: The webhook event name.
          example: subscription_activated
        company_account_id:
          type: string
          description: The company account ID.
          example: XMPL1234
        data:
          $ref: '#/components/schemas/Subscription'
          description: The webhook `Subscription` data.
        subscription_id:
          type: string
          description: The webhook subscription ID used to route this event.
          example: 2d65bd5e-3fdf-4002-b166-bde7fb8863fa
    ContactDeletedEvent:
      properties:
        event_uuid:
          type: string
          description: The webhook unique ID.
          example: 7bf79328-a7ae-4222-aa54-091ff7f429a7
        event_type:
          $ref: '#/components/schemas/WebhookEventType'
          default: Contact
          description: The webhook event type.
          example: Contact
        event_name:
          $ref: '#/components/schemas/WebhookEventName'
          default: contact_deleted
          description: The webhook event name.
          example: contact_deleted
        company_account_id:
          type: string
          description: The company account ID.
          example: XMPL1234
        data:
          $ref: '#/components/schemas/Contact'
          description: The webhook `Contact` data. Only the `id` of the resource is returned.
        subscription_id:
          type: string
          description: The webhook subscription ID used to route this event.
          example: 2d65bd5e-3fdf-4002-b166-bde7fb8863fa
    TransactionOwnerType:
      type: string
      enum:
      - employee
      - company
    Invoice:
      properties:
        number:
          type: string
          description: A unique identifier assigned to an invoice by the supplier.
          example: INV-2023-001
          maxLength: 50
          pattern: ^(?![=+\-@])[^,;'"]{0,50}$
        date:
          type: string
          description: 'The date the invoice was issued by the supplier. Accepted format: yyyy-MM-dd.'
          example: '2023-01-23'
        po_number:
          type: string
          description: A reference number provided by the customer's purchasing system (Purchase Order Number)
          example: PO-2023-001
          maxLength: 50
          pattern: ^(?![=+\-@])[^,;'"]{0,50}$
        supplier_vat_number:
          type: string
          description: The Value-Added Tax (VAT) registration number of the supplier.
          example: 123456789
          maxLength: 15
          pattern: ^[a-zA-Z0-9]{0,15}$
    CardAssigneeUpdatedEvent:
      properties:
        event_uuid:
          type: string
          description: The webhook unique ID.
          example: 7bf79328-a7ae-4222-aa54-091ff7f429a7
        event_type:
          $ref: '#/components/schemas/WebhookEventType'
          default: Card
          description: The webhook event type.
          example: Card
        event_name:
          $ref: '#/components/schemas/WebhookEventName'
          default: card_assignee_updated
          description: The webhook event name.
          example: card_assignee_updated
        company_account_id:
          type: string
          description: The company account ID.
          example: XMPL1234
        data:
          $ref: '#/components/schemas/Card'
          description: The webhook `Card` data.
        subscription_id:
          type: string
          description: The webhook subscription ID used to route this event.
          example: 2d65bd5e-3fdf-4002-b166-bde7fb8863fa
    AddResourcesCardEvent:
      properties:
        event_uuid:
          type: string
          description: The webhook unique ID.
          example: 7bf79328-a7ae-4222-aa54-091ff7f429a7
        event_type:
          $ref: '#/components/schemas/WebhookEventType'
          default: Team
          description: The webhook event type.
          example: Team
        event_name:
          $ref: '#/components/schemas/WebhookEventName'
          default: add_resources_card
          description: The webhook event name.
          example: add_resources_card
        company_account_id:
          type: string
          description: The company account ID.
          example: XMPL1234
        data:
          $ref: '#/components/schemas/Group'
          description: The webhook `Group` data.
        subscription_id:
          type: string
          description: The webhook subscription ID used to route this event.
          example: 2d65bd5e-3fdf-4002-b166-bde7fb8863fa
    OnlineAdsDeletedEvent:
      properties:
        event_uuid:
          type: string
          description: The webhook unique ID.
          example: 7bf79328-a7ae-4222-aa54-091ff7f429a7
        event_type:
          $ref: '#/components/schemas/WebhookEventType'
          default: OnlineAds
          description: The webhook event type.
          example: OnlineAds
        event_name:
          $ref: '#/components/schemas/WebhookEventName'
          default: online_ads_deleted
          description: The webhook event name.
          example: online_ads_deleted
        company_account_id:
          type: string
          description: The company account ID.
          example: XMPL1234
        data:
          $ref: '#/components/schemas/OnlineAds'
          description: The webhook `OnlineAds` data.
        subscription_id:
          type: string
          description: The webhook subscription ID used to route this event.
          example: 2d65bd5e-3fdf-4002-b166-bde7fb8863fa
    CustomerCareDepositEvent:
      properties:
        event_uuid:
          type: string
          description: The webhook unique ID.
          example: 7bf79328-a7ae-4222-aa54-091ff7f429a7
        event_type:
          $ref: '#/components/schemas/WebhookEventType'
          default: Transaction
          description: The webhook event type.
          example: Transaction
        event_name:
          $ref: '#/components/schemas/WebhookEventName'
          default: customer_care_deposit
          description: The webhook event name.
          example: customer_care_deposit
        company_account_id:
          type: string
          description: The company account ID.
          example: XMPL1234
        data:
          $ref: '#/components/schemas/Transaction'
          description: The webhook `Transaction` data.
        subscription_id:
          type: string
          description: The webhook subscription ID used to route this event.
          example: 2d65bd5e-3fdf-4002-b166-bde7fb8863fa
    FuelType:
      type: string
      enum:
      - PETROL
      - DIESEL
      - METHANE
      - LPG
      - LNG
      - ELECTRIC
      - UNKNOWN
    EditTagEvent:
      properties:
        event_uuid:
          type: string
          description: The webhook unique ID.
          example: 7bf79328-a7ae-4222-aa54-091ff7f429a7
        event_type:
          $ref: '#/components/schemas/WebhookEventType'
          default: Transaction
          description: The webhook event type.
          example: Transaction
        event_name:
          $ref: '#/components/schemas/WebhookEventName'
          default: edit_tag
          description: The webhook event name.
          example: edit_tag
        company_account_id:
          type: string
          description: The company account ID.
          example: XMPL1234
        data:
          $ref: '#/components/schemas/Transaction'
          description: The webhook `Transaction` data.
        subscription_id:
          type: string
          description: The webhook subscription ID used to route this event.
          example: 2d65bd5e-3fdf-4002-b166-bde7fb8863fa
    TransactionTimelineBalance:
      properties:
        available_amount:
          type: number
          description: The `Wallet` available amount in the currency of the `Wallet`.
          example: 10.25
        pending_amount:
          type: number
          description: The `Wallet` pending amount in the currency of the `Wallet`. This is also known as `blocked` amount.
          example: 10.25
        ledger_amount:
          type: number
          description: The `Wallet` ledger amount in the currency of the `Wallet`. This is a shorthand for the sum of available and pending amounts.
          example: 10.25
    Purchase:
      properties:
        id:
          type: string
          description: 'The `Purchase` ID (sortable: no).'
          example: 7bf79328-a7ae-4222-aa54-091ff7f429a7
        status:
          $ref: '#/components/schemas/PurchaseStatus'
          description: 'The status of the `Purchase` (sortable: no).'
          example: ASSIGNED
        title:
          type: string
          description: 'The name of the `Purchase` (sortable: no).'
          example: Tech book
        description:
          type: string
          description: 'The description of the `Purchase` (sortable: no).'
          example: A purchase to approve
        amount:
          type: number
          description: 'The maximum spendable amount of the `Purchase` (sortable: no).'
          example: 10.25
        amount_currency:
          $ref: '#/components/schemas/ISO4217Currency'
          description: 'The currency of the `Purchase` ([ISO 4217](https://www.six-group.com/en/products-services/financial-information/data-standards.html#scrollTo=maintenance-agency) code) (sortable: no).'
          example: EUR
        wallet_id:
          type: string
          description: 'The ID of the `Wallet` the money are taken from, the funding source of the `Purchase` (sortable: no).'
          example: 2d65bd5e-3fdf-4002-b166-bde7fb8863fa
        wallet_name:
          type: string
          description: 'The name of the `Wallet` the money are taken from, the funding source of the `Purchase` (sortable: no).'
          example: John Doe
        has_attachments:
          type: boolean
          description: 'It determines whether the `Purchase` has one or more attachments (sortable: no).'
          example: true
        notes:
          type: string
          description: 'The notes of the `Purchase` (sortable: no).'
          example: Notes about the purchase request
        assignee_id:
          type: string
          description: 'The ID of the `User` assigned to the `Purchase` (sortable: no).'
          example: XMPL1234-000003
        additional_assignee_ids:
          type: array
          description: 'The IDs of any additional `User` assigned to the `Purchase` (sortable: no).'
          example: XMPL1234-000003
          items:
            type: string
          uniqueItems: true
        assignee_custom_reference_id:
          type: string
          description: 'The custom reference of the `User` assigned to the `Purchase` (sortable: no).'
          example: 123456-user-1
        author_id:
          type: string
          description: 'The ID of the `User` that created the `Purchase` (sortable: no).'
          example: XMPL1234-000001
        author_custom_reference_id:
          type: string
          description: 'The custom reference of the `User` that created the purchase (sortable: no).'
          example: 123456-user-2
        expiration_date:
          type: string
          description: 'The date and time when the `Purchase` will expire (sortable: no).'
          example: '2017-06-01T12:48:40Z'
        card_id:
          type: string
          description: 'The ID of the `Card` assigned to the `Purchase`, only available after the redemption `Order` has been completed (sortable: no).'
          example: 2d65bd5e-3fdf-4002-b166-bde7fb8863fa
        transactions:
          type: array
          description: 'The `Transactions` originated by the `Purchase` (sortable: no).'
          items:
            $ref: '#/components/schemas/PurchaseTransaction'
        max_tx_number:
          type: integer
          format: int32
          description: The max number of the `Transactions` that can be made with the `Card`.
          example: 3
        creation_time:
          type: string
          description: 'The date and time when the `Purchase` was created (sortable: yes).'
          example: '2017-06-01T12:48:40Z'
        last_update_time:
          type: string
          description: 'The date and time when the `Purchase` was last updated (sortable: yes).'
          example: '2017-06-01T12:48:40Z'
    MoveResourcesWalletEvent:
      properties:
        event_uuid:
          type: string
          description: The webhook unique ID.
          example: 7bf79328-a7ae-4222-aa54-091ff7f429a7
        event_type:
          $ref: '#/components/schemas/WebhookEventType'
          default: Team
          description: The webhook event type.
          example: Team
        event_name:
          $ref: '#/components/schemas/WebhookEventName'
          default: move_resources_wallet
          description: The webhook event name.
          example: move_resources_wallet
        company_account_id:
          type: string
          description: The company account ID.
          example: XMPL1234
        data:
          $ref: '#/components/schemas/Group'
          description: The webhook `Group` data.
        subscription_id:
          type: string
          description: The webhook subscription ID used to route this event.
          example: 2d65bd5e-3fdf-4002-b166-bde7fb8863fa
    WalletCreatedEvent:
      properties:
        event_uuid:
          type: string
          description: The webhook unique ID.
          example: 7bf79328-a7ae-4222-aa54-091ff7f429a7
        event_type:
          $ref: '#/components/schemas/WebhookEventType'
          default: Wallet
          description: The webhook event type.
          example: Wallet
        event_name:
          $ref: '#/components/schemas/WebhookEventName'
          default: wallet_created
          description: The webhook event name.
          example: wallet_created
        company_account_id:
          type: string
          description: The company account ID.
          example: XMPL1234
        data:
          $ref: '#/components/schemas/Wallet'
          description: The webhook `Wallet` data.
        subscription_id:
          type: string
          description: The webhook subscription ID used to route this event.
          example: 2d65bd5e-3fdf-4002-b166-bde7fb8863fa
    OnlineAdsAssigneeRemovedEvent:
      properties:
        event_uuid:
          type: string
          description: The webhook unique ID.
          example: 7bf79328-a7ae-4222-aa54-091ff7f429a7
        event_type:
          $ref: '#/components/schemas/WebhookEventType'
          default: OnlineAds
          description: The webhook event type.
          example: OnlineAds
        event_name:
          $ref: '#/components/schemas/WebhookEventName'
          default: online_ads_assignee_removed
          description: The webhook event name.
          example: online_ads_assignee_removed
        company_account_id:
          type: string
          description: The company account ID.
          example: XMPL1234
        data:
          $ref: '#/components/schemas/OnlineAds'
          description: The webhook `OnlineAds` data.
        subscription_id:
          type: string
          description: The webhook subscription ID used to route this event.
          example: 2d65bd5e-3fdf-4002-b166-bde7fb8863fa
    CardActivatedEvent:
      properties:
        event_uuid:
          type: string
          description: The webhook unique ID.
          example: 7bf79328-a7ae-4222-aa54-091ff7f429a7
        event_type:
          $ref: '#/components/schemas/WebhookEventType'
          default: Card
          description: The webhook event type.
          example: Card
        event_name:
          $ref: '#/components/schemas/WebhookEventName'
          default: card_activated
          description: The webhook event name.
          example: card_activated
        company_account_id:
          type: string
          description: The company account ID.
          example: XMPL1234
        data:
          $ref: '#/components/schemas/Card'
          description: The webhook `Card` data.
        subscription_id:
          type: string
          description: The webhook subscription ID used to route this event.
          example: 2d65bd5e-3fdf-4002-b166-bde7fb8863fa
    Wallet:
      properties:
        id:
          type: string
          description: 'The `Wallet` ID (sortable: yes)'
          example: 7bf79328-a7ae-4222-aa54-091ff7f429a7
        name:
          type: string
          description: 'The name of the `Wallet` (sortable: yes)'
          example: CompanyWallet1
        currency_code:
          $ref: '#/components/schemas/ISO4217Currency'
          description: 'The [ISO 4217](https://www.six-group.com/en/products-services/financial-information/data-standards.html#scrollTo=maintenance-agency) code of the currency of the `Wallet` (sortable: no)'
          example: EUR
        available_amount:
          type: number
          description: 'The currently available balance of the `Wallet` (sortable: no)'
          example: 100
        blocked_amount:
          type: number
          description: 'The blocked balance of the `Wallet` (the overall amount of `Transactions` in `Authorised` status) (sortable: no)'
          example: 0
        primary_user_type:
          $ref: '#/components/schemas/PrimaryUserType'
          description: 'The type of resource assigned to the `Wallet` (sortable: no)'
          example: dedicated
        primary_user_public_id:
          type: string
          description: 'The ID of the `User` if the `Wallet` is of type `employee`, not available for other `Wallet` types (sortable: no)'
          example: XMPL1234-000001
        custom_reference_id:
          type: string
          description: 'The custom reference of the `User` if the `Wallet` is of type `employee`, not available for other wallet types (sortable: yes)'
          example: 123456-usa-1
        group_id:
          type: string
          deprecated: true
          description: 'The ID of the `Group` the wallet is related to (sortable: no). In case of multiple groups associated this field contains the first one for backward compatibility.'
          example: 7bf79328-a7ae-4222-aa54-091ff7f429a7
        groups:
          type: array
          description: 'The list of `Group` ID the wallet is related to (sortable: no)'
          example:
          - 7bf79328-a7ae-4222-aa54-091ff7f429a7
          - 2d65bd5e-3fdf-4002-b166-bde7fb8863fa
          items:
            type: string
        label:
          type: string
          description: 'The label of the `Wallet` (sortable: yes)'
          example: CompanyWallet1
        visible:
          type: boolean
          description: 'It determines whether the `Wallet` is visible on the web console (sortable: yes)'
          example: true
        creation_time:
          type: string
          description: 'The date and time when the `Wallet` was created (sortable: yes)'
          example: '2017-06-01T12:48:40Z'
        last_update:
          type: string
          description: 'The date and time when the `Wallet` was last updated (sortable: yes)'
          example: '2017-06-01T12:48:40Z'
        deposit_account_info:
          type: array
          description: The deposit account info of the `Wallet`.
          example:
          - 7bf79328-a7ae-4222-aa54-091ff7f429a7
          - 2d65bd5e-3fdf-4002-b166-bde7fb8863fa
          items:
            $ref: '#/components/schemas/DepositAccountInfo'
        description:
          type: string
          description: 'The note of the `Wallet` (sortable: yes)'
          example: CompanyWallet1
    CardOwnerType:
      type: string
      enum:
      - company
      - employee
    CardReplacedEvent:
      properties:
        event_uuid:
          type: string
          description: The webhook unique ID.
          example: 7bf79328-a7ae-4222-aa54-091ff7f429a7
        event_type:
          $ref: '#/components/schemas/WebhookEventType'
          default: Card
          description: The webhook event type.
          example: Card
        event_name:
          $ref: '#/components/schemas/WebhookEventName'
          default: card_replaced
          description: The webhook event name.
          example: card_replaced
        company_account_id:
          type: string
          description: The company account ID.
          example: XMPL1234
        data:
          $ref: '#/components/schemas/Card'
          description: The webhook `Card` data.
        subscription_id:
          type: string
          description: The webhook subscription ID used to route this event.
          example: 2d65bd5e-3fdf-4002-b166-bde7fb8863fa
    TransactionPaymentMethod:
      type: string
      enum:
      - USER
      - COMPANY
      - PURCHASE
      - SUBSCRIPTION
      - ONLINE_ADS
      - OUT_OF_PLATFORM_COMPANY
      - OUT_OF_PLATFORM_PERSONAL
      - IATS
      - WIRETRANSFER
    TransactionSplitInfo:
      properties:
        amount:
          $ref: '#/components/schemas/TransactionAmount'
          description: The `Transaction`'s line amount.
        vat_amount:
          $ref: '#/components/schemas/TransactionAmount'
          description: The `Transaction`'s line VAT amount.
        expense_type:
          $ref: '#/components/schemas/ExpenseType'
          description: The type of the expense.
          example: TRAVEL_AND_ENTERTAINMENT
        line_number:
          type: integer
          format: int32
          description: The `Transaction`'s line number.
          example: 1
        tags:
          type: array
          description: The list of the Tags of the Transaction (only returned from [Get Transaction](https://developer.soldo.com/reference/transaction-get)).
          items:
            $ref: '#/components/schemas/TransactionSplitInfoTag'
        employee:
          $ref: '#/components/schemas/User'
          description: The `User` which the transaction line is assigned to.
        expense_category:
          $ref: '#/components/schemas/ExpenseCategory'
          description: The `ExpenseCategory` object.
        tax_rate:
          $ref: '#/components/schemas/VatRate'
          description: The `VATRate` object.
        approved_amount:
          $ref: '#/components/schemas/TransactionAmount'
          description: The `TransactionList`'s line amount approved in policy.
        rejected_amount:
          $ref: '#/components/schemas/TransactionAmount'
          description: The `TransactionList`'s line amount rejected in policy.
    ISO3166Country:
      type: string
      enum:
      - ASC
      - AND
      - ARE
      - AFG
      - ATG
      - AIA
      - ALB
      - ARM
      - ANT
      - AGO
      - ATA
      - ARG
      - ASM
      - AUT
      - AUS
      - ABW
      - ALA
      - AZE
      - BIH
      - BRB
      - BGD
      - BEL
      - BFA
      - BGR
      - BHR
      - BDI
      - BEN
      - BLM
      - BMU
      - BRN
      - BOL
      - BES
      - BRA
      - BHS
      - BTN
      - BUR
      - BVT
      - BWA
      - BLR
      - BLZ
      - CAN
      - CCK
      - COD
      - CAF
      - COG
      - CHE
      - CIV
      - COK
      - CHL
      - CMR
      - CHN
      - COL
      - CPT
      - CRI
      - CSXX
      - CUB
      - CPV
      - CUW
      - CXR
      - CYP
      - CZE
      - DEU
      - DGA
      - DJI
      - DNK
      - DMA
      - DOM
      - DZA
      - ECU
      - EST
      - EGY
      - ESH
      - ERI
      - ESP
      - ETH
      - FIN
      - FJI
      - FLK
      - FSM
      - FRO
      - FRA
      - FXX
      - GAB
      - GBR
      - GRD
      - GEO
      - GUF
      - GGY
      - GHA
      - GIB
      - GRL
      - GMB
      - GIN
      - GLP
      - GNQ
      - GRC
      - SGS
      - GTM
      - GUM
      - GNB
      - GUY
      - HKG
      - HMD
      - HND
      - HRV
      - HTI
      - HUN
      - IDN
      - IRL
      - ISR
      - IMN
      - IND
      - IOT
      - IRQ
      - IRN
      - ISL
      - ITA
      - JEY
      - JAM
      - JOR
      - JPN
      - KEN
      - KGZ
      - KHM
      - KIR
      - COM
      - KNA
      - PRK
      - KOR
      - KWT
      - CYM
      - KAZ
      - LAO
      - LBN
      - LCA
      - LIE
      - LKA
      - LBR
      - LSO
      - LTU
      - LUX
      - LVA
      - LBY
      - MAR
      - MCO
      - MDA
      - MNE
      - MAF
      - MDG
      - MHL
      - MKD
      - MLI
      - MMR
      - MNG
      - MAC
      - MNP
      - MTQ
      - MRT
      - MSR
      - MLT
      - MUS
      - MDV
      - MWI
      - MEX
      - MYS
      - MOZ
      - NAM
      - NCL
      - NER
      - NFK
      - NGA
      - NIC
      - NLD
      - NOR
      - NPL
      - NRU
      - NTZ
      - NIU
      - NZL
      - OMN
      - PAN
      - PER
      - PYF
      - PNG
      - PHL
      - PAK
      - POL
      - SPM
      - PCN
      - PRI
      - PSE
      - PRT
      - PLW
      - PRY
      - QAT
      - REU
      - ROU
      - ROM
      - SRB
      - RUS
      - RWA
      - SAU
      - SLB
      - SYC
      - SDN
      - SWE
      - SGP
      - SHN
      - SVN
      - SJM
      - SVK
      - SLE
      - SMR
      - SEN
      - SOM
      - SUR
      - SSD
      - STP
      - SUN
      - SLV
      - SXM
      - SYR
      - SWZ
      - TAA
      - TCA
      - TCD
      - ATF
      - TGO
      - THA
      - TJK
      - TKL
      - TLS
      - TKM
      - TUN
      - TON
      - TUR
      - TTO
      - TUV
      - TWN
      - TZA
      - UKR
      - UGA
      - UMI
      - USA
      - URY
      - UZB
      - VAT
      - VCT
      - VEN
      - VGB
      - VIR
      - VNM
      - VUT
      - WLF
      - WSM
      - XKX
      - XXK
      - QZZ
      - YEM
      - MYT
      - YUCS
      - ZAF
      - ZMB
      - ZRCD
      - ZWE
    SubscriptionDeletedEvent:
      properties:
        event_uuid:
          type: string
          description: The webhook unique ID.
          example: 7bf79328-a7ae-4222-aa54-091ff7f429a7
        event_type:
          $ref: '#/components/schemas/WebhookEventType'
          default: Subscription
          description: The webhook event type.
          example: Subscription
        event_name:
          $ref: '#/components/schemas/WebhookEventName'
          default: subscription_deleted
          description: The webhook event name.
          example: subscription_deleted
        company_account_id:
          type: string
          description: The company account ID.
          example: XMPL1234
        data:
          $ref: '#/components/schemas/Subscription'
          description: The webhook `Subscription` data.
        subscription_id:
          type: string
          description: The webhook subscription ID used to route this event.
          example: 2d65bd5e-3fdf-4002-b166-bde7fb8863fa
    PurchaseUpdateEvent:
      properties:
        event_uuid:
          type: string
          description: The webhook unique ID.
          example: 7bf79328-a7ae-4222-aa54-091ff7f429a7
        event_type:
          $ref: '#/components/schemas/WebhookEventType'
          default: Purchase
          description: The webhook event type.
          example: Purchase
        event_name:
          $ref: '#/components/schemas/WebhookEventName'
          default: purchase_update
          description: The webhook event name.
          example: purchase_update
        company_account_id:
          type: string
          description: The company account ID.
          example: XMPL1234
        data:
          $ref: '#/components/schemas/Purchase'
          description: The webhook `Purchase` data.
        subscription_id:
          type: string
          description: The webhook subscription ID used to route this event.
          example: 2d65bd5e-3fdf-4002-b166-bde7fb8863fa
    CardLabelUpdatedEvent:
      properties:
        event_uuid:
          type: string
          description: The webhook unique ID.
          example: 7bf79328-a7ae-4222-aa54-091ff7f429a7
        event_type:
          $ref: '#/components/schemas/WebhookEventType'
          default: Card
          description: The webhook event type.
          example: Card
        event_name:
          $ref: '#/components/schemas/WebhookEventName'
          default: card_label_updated
          description: The webhook event name.
          example: card_label_updated
        company_account_id:
          type: string
          description: The company account ID.
          example: XMPL1234
        data:
          $ref: '#/components/schemas/Card'
          description: The webhook `Card` data.
        subscription_id:
          type: string
          description: The webhook subscription ID used to route this event.
          example: 2d65bd5e-3fdf-4002-b166-bde7fb8863fa
    Contact:
      properties:
        id:
          type: string
          description: The `Contact` ID.
          example: 7bf79328-a7ae-4222-aa54-091ff7f429a7
        name:
          type: string
          description: The name of the `Contact`.
          example: John Doe
        user_id:
          type: string
          description: The ID of the `User` the bank details are assigned to (only available for `Contacts` of type `EMPLOYEE`).
          example: XMPL1234-000001
        type:
          $ref: '#/components/schemas/ContactType'
          description: The type of `Contact`.
          example: SUPPLIER
        payment_scheme:
          type: array
          description: The type of payment accepted by the `Contact`.
          items:
            $ref: '#/components/schemas/PaymentSchema'
          uniqueItems: true
        account_info:
          type: array
          description: The bank account information of the `Contact`.
          items:
            $ref: '#/components/schemas/AccountInfoContact'
        bic:
          type: string
          description: The bic of the `User` the bank details .
          example: XMPL1234-000001
        country:
          $ref: '#/components/schemas/ISO3166Country'
          description: The [ISO 3166-1 alpha-3](https://www.iso.org/obp/ui/#search/code/) code of the country of the `Contact`.
          example: GBR
        status:
          $ref: '#/components/schemas/ContactStatus'
          description: The status of the `Contact`.
          example: SUGGESTED
        creation_time:
          type: string
          description: The date and time when the `Contact` was created.
          example: '2017-06-01T12:48:40Z'
        last_update_time:
          type: string
          description: The date and time when the `Contact` was last updated.
          example: '2017-06-01T12:48:40Z'
        bank_account_verification_status:
          $ref: '#/components/schemas/ContactBankAccountVerificationStatus'
          description: Whether the provided `Contact` bank account details matches the actual ones.
          example: '2017-06-01T12:48:40Z'
    LoadSource:
      type: string
      enum:
      - UNSPECIFIED
      - BANK_TRANSFER
      - CARD
      - SISAL_PAY
      - FASTER_PAYMENT
    CardChangeStatusEvent:
      properties:
        event_uuid:
          type: string
          description: The webhook unique ID.
          example: 7bf79328-a7ae-4222-aa54-091ff7f429a7
        event_type:
          $ref: '#/components/schemas/WebhookEventType'
          default: Card
          description: The webhook event type.
          example: Card
        event_name:
          $ref: '#/components/schemas/WebhookEventName'
          default: card_change_status
          description: The webhook event name.
          example: card_change_status
        company_account_id:
          type: string
          description: The company account ID.
          example: XMPL1234
        data:
          $ref: '#/components/schemas/Card'
          description: The webhook `Card` data.
        subscription_id:
          type: string
          description: The webhook subscription ID used to route this event.
          example: 2d65bd5e-3fdf-4002-b166-bde7fb8863fa
    AddResourcesMemberEvent:
      properties:
        event_uuid:
          type: string
          description: The webhook unique ID.
          example: 7bf79328-a7ae-4222-aa54-091ff7f429a7
        event_type:
          $ref: '#/components/schemas/WebhookEventType'
          default: Team
          description: The webhook event type.
          example: Team
        event_name:
          $ref: '#/components/schemas/WebhookEventName'
          default: add_resources_member
          description: The webhook event name.
          example: add_resources_member
        company_account_id:
          type: string
          description: The company account ID.
          example: XMPL1234
        data:
          $ref: '#/components/schemas/Group'
          description: The webhook `Group` data.
        subscription_id:
          type: string
          description: The webhook subscription ID used to route this event.
          example: 2d65bd5e-3fdf-4002-b166-bde7fb8863fa
    WalletDeletedEvent:
      properties:
        event_uuid:
          type: string
          description: The webhook unique ID.
          example: 7bf79328-a7ae-4222-aa54-091ff7f429a7
        event_type:
          $ref: '#/components/schemas/WebhookEventType'
          default: Wallet
          description: The webhook event type.
          example: Wallet
        event_name:
          $ref: '#/components/schemas/WebhookEventName'
          default: wallet_deleted
          description: The webhook event name.
          example: wallet_deleted
        company_account_id:
          type: string
          description: The company account ID.
          example: XMPL1234
        data:
          $ref: '#/components/schemas/Wallet'
          description: The webhook `Wallet` data.
        subscription_id:
          type: string
          description: The webhook subscription ID used to route this event.
          example: 2d65bd5e-3fdf-4002-b166-bde7fb8863fa
    OnlineAdsUpdatedEvent:
      properties:
        event_uuid:
          type: string
          description: The webhook unique ID.
          example: 7bf79328-a7ae-4222-aa54-091ff7f429a7
        event_type:
          $ref: '#/components/schemas/WebhookEventType'
          default: OnlineAds
          description: The webhook event type.
          example: OnlineAds
        event_name:
          $ref: '#/components/schemas/WebhookEventName'
          default: online_ads_updated
          description: The webhook event name.
          example: online_ads_updated
        company_account_id:
          type: string
          description: The company account ID.
          example: XMPL1234
        data:
          $ref: '#/components/schemas/OnlineAds'
          description: The webhook `OnlineAds` data.
        subscription_id:
          type: string
          description: The webhook subscription ID used to route this event.
          example: 2d65bd5e-3fdf-4002-b166-bde7fb8863fa
    UserUpdatedEvent:
      properties:
        event_uuid:
          type: string
          description: The webhook unique ID.
          example: 7bf79328-a7ae-4222-aa54-091ff7f429a7
        event_type:
          $ref: '#/components/schemas/WebhookEventType'
          default: Employee
          description: The webhook event type.
          example: Employee
        event_name:
          $ref: '#/components/schemas/WebhookEventName'
          default: user_updated
          description: The webhook event name.
          example: user_updated
        company_account_id:
          type: string
          description: The company account ID.
          example: XMPL1234
        data:
          $ref: '#/components/schemas/User'
          description: The webhook `User` data.
        subscription_id:
          type: string
          description: The webhook subscription ID used to route this event.
          example: 2d65bd5e-3fdf-4002-b166-bde7fb8863fa
    OnlineAds:
      properties:
        id:
          type: string
          description: The `OnlineAds` ID.
          example: 7bf79328-a7ae-4222-aa54-091ff7f429a7
        name:
          type: string
          description: The name of the `OnlineAds`.
          example: EXAMPLE ONLINE AD
        description:
          type: string
          description: A custom description of the `OnlineAds`.
          example: This is an online advertisement
        platform:
          $ref: '#/components/schemas/OnlineAdsPlatform'
          description: The platform the `OnlineAds` are made on.
          example: OTHER
        assignees:
          type: array
          description: List of `User` IDs currently assigned to the `OnlineAds` and its `Cards`.
          example:
          - XMPL1234-000001
          - XMPL1234-000002
          - XMPL1234-000003
          items:
            type: string
        status:
          $ref: '#/components/schemas/OnlineAdsStatus'
          description: The status of the `OnlineAds`.
          example: ACTIVE
        wallet_id:
          type: string
          description: The `Wallet` ID the `OnlineAds` and its `Card` are linked to.
          example: 2d65bd5e-3fdf-4002-b166-bde7fb8863fa
        last_spent_date:
          type: string
          description: The date and time of the last `Transaction` made with the `Card`.
          example: '2020-05-07T12:48:40Z'
        last_spent:
          type: number
          description: The amount of the last `Transaction` made with the `Card`.
          example: 75.01
        total_spent:
          type: number
          description: The overall amount spent with the `Card`.
          example: 775.01
        card_id:
          type: string
          description: The ID of the `Card` reserved for this `OnlineAds` (only available after the `OnlineAds` has been activated).
          example: c861cc24-6663-410f-8c78-73f886fff4ef
        creation_time:
          type: string
          description: The date and time when the `OnlineAds` was created.
          example: '2017-06-01T12:48:40Z'
        last_update_time:
          type: string
          description: The date and time when the `OnlineAds` was last updated.
          example: '2017-06-01T12:48:40Z'
    TransactionTimelineItem:
      properties:
        created_at:
          type: string
          description: The instant the change happened to the `Transaction` and related `Wallet`.
          example: '2017-06-01T12:48:40Z'
        status:
          $ref: '#/components/schemas/TransactionTimelineStatus'
          description: What happened in that moment to the `Transaction` and to the related `Wallet`.
          example: Settled
        amount:
          type: number
          description: The amount related to the change in the currency of the `Wallet`.
          example: 10.25
        balance_after:
          $ref: '#/components/schemas/TransactionTimelineBalance'
          description: The `Wallet` balance after the change took place.
          example: 10.25
        balance_before:
          $ref: '#/components/schemas/TransactionTimelineBalance'
          description: The `Wallet` balance before the change took place.
          example: 10.25
        is_fee:
          type: boolean
          description: Indicate whether the change is a fee.
          example: true
    ExpenseStatus:
      type: string
      enum:
      - APPROVED
      - PARTIALLY_APPROVED
      - DENIED
      - TO_REVIEW
    UploadUserChannel:
      type: string
      enum:
      - WEB
      - MOBILE
      - BO_USER
      - business
      - BAPI
      - PAPI
      - OTHER
    VehicleCreateEvent:
      properties:
        event_uuid:
          type: string
          description: The webhook unique ID.
          example: 7bf79328-a7ae-4222-aa54-091ff7f429a7
        event_type:
          $ref: '#/components/schemas/WebhookEventType'
          default: Vehicle
          description: The webhook event type.
          example: Vehicle
        event_name:
          $ref: '#/components/schemas/WebhookEventName'
          default: vehicle_create
          description: The webhook event name.
          example: vehicle_create
        company_account_id:
          type: string
          description: The company account ID.
          example: XMPL1234
        data:
          $ref: '#/components/schemas/Vehicle'
          description: The webhook `Vehicle` data.
        subscription_id:
          type: string
          description: The webhook subscription ID used to route this event.
          example: 2d65bd5e-3fdf-4002-b166-bde7fb8863fa
    AccountInfoDeposit:
      type: string
      enum:
      - IBAN
      - SISAL
      - SORT_CODE
      - VIRTUAL_IBAN
      - SHARED_SWIFT
      - DEDICATED_SWIFT
    LoadMoneyEvent:
      properties:
        event_uuid:
          type: string
          description: The webhook unique ID.
          example: 7bf79328-a7ae-4222-aa54-091ff7f429a7
        event_type:
          $ref: '#/components/schemas/WebhookEventType'
          default: Transaction
          description: The webhook event type.
          example: Transaction
        event_name:
          $ref: '#/components/schemas/WebhookEventName'
          default: load_money
          description: The webhook event name.
          example: load_money
        company_account_id:
          type: string
          description: The company account ID.
          example: XMPL1234
        data:
          $ref: '#/components/schemas/Transaction'
          description: The webhook `Transaction` data.
        subscription_id:
          type: string
          description: The webhook subscription ID used to route this event.
          example: 2d65bd5e-3fdf-4002-b166-bde7fb8863fa
    OnlineAdsCreatedEvent:
      properties:
        event_uuid:
          type: string
          description: The webhook unique ID.
          example: 7bf79328-a7ae-4222-aa54-091ff7f429a7
        event_type:
          $ref: '#/components/schemas/WebhookEventType'
          default: OnlineAds
          description: The webhook event type.
          example: OnlineAds
        event_name:
          $ref: '#/components/schemas/WebhookEventName'
          default: online_ads_created
          description: The webhook event name.
          example: online_ads_created
        company_account_id:
          type: string
          description: The company account ID.
          example: XMPL1234
        data:
          $ref: '#/components/schemas/OnlineAds'
          description: The webhook `OnlineAds` data.
        subscription_id:
          type: string
          description: The webhook subscription ID used to route this event.
          example: 2d65bd5e-3fdf-4002-b166-bde7fb8863fa
    TransactionModifiedEvent:
      properties:
        event_uuid:
          type: string
          description: The webhook unique ID.
          example: 7bf79328-a7ae-4222-aa54-091ff7f429a7
        event_type:
          $ref: '#/components/schemas/WebhookEventType'
          default: Transaction
          description: The webhook event type.
          example: Transaction
        event_name:
          $ref: '#/components/schemas/WebhookEventName'
          default: transaction_modified
          description: The webhook event name.
          example: transaction_modified
        company_account_id:
          type: string
          description: The company account ID.
          example: XMPL1234
        data:
          $ref: '#/components/schemas/Transaction'
          description: The webhook `Transaction` data.
        subscription_id:
          type: string
          description: The webhook subscription ID used to route this event.
          example: 2d65bd5e-3fdf-4002-b166-bde7fb8863fa
    OnlineAdsAssigneeAddedEvent:
      properties:
        event_uuid:
          type: string
          description: The webhook unique ID.
          example: 7bf79328-a7ae-4222-aa54-091ff7f429a7
        event_type:
          $ref: '#/components/schemas/WebhookEventType'
          default: OnlineAds
          description: The webhook event type.
          example: OnlineAds
        event_name:
          $ref: '#/components/schemas/WebhookEventName'
          default: online_ads_assignee_added
          description: The webhook event name.
          example: online_ads_assignee_added
        company_account_id:
          type: string
          description: The company account ID.
          example: XMPL1234
        data:
          $ref: '#/components/schemas/OnlineAds'
          description: The webhook `OnlineAds` data.
        subscription_id:
          type: string
          description: The webhook subscription ID used to route this event.
          example: 2d65bd5e-3fdf-4002-b166-bde7fb8863fa
    CardDestroyedEvent:
      properties:
        event_uuid:
          type: string
          description: The webhook unique ID.
          example: 7bf79328-a7ae-4222-aa54-091ff7f429a7
        event_type:
          $ref: '#/components/schemas/WebhookEventType'
          default: Card
          description: The webhook event type.
          example: Card
        event_name:
          $ref: '#/components/schemas/WebhookEventName'
          default: card_destroyed
          description: The webhook event name.
          example: card_destroyed
        company_account_id:
          type: string
          description: The company account ID.
          example: XMPL1234
        data:
          $ref: '#/components/schemas/Card'
          description: The webhook `Card` data.
        subscription_id:
          type: string
          description: The webhook subscription ID used to route this event.
          example: 2d65bd5e-3fdf-4002-b166-bde7fb8863fa
    AttachmentDeleteEvent:
      properties:
        event_uuid:
          type: string
          description: The webhook unique ID.
          example: 7bf79328-a7ae-4222-aa54-091ff7f429a7
        event_type:
          $ref: '#/components/schemas/WebhookEventType'
          default: TransactionAttachment
          description: The webhook event type.
          example: TransactionAttachment
        event_name:
          $ref: '#/components/schemas/WebhookEventName'
          default: attachment_delete
          description: The webhook event name.
          example: attachment_delete
        company_account_id:
          type: string
          description: The company account ID.
          example: XMPL1234
        data:
          $ref: '#/components/schemas/TransactionAttachment'
          description: The webhook `TransactionAttachment` data.
        subscription_id:
          type: string
          description: The webhook subscription ID used to route this event.
          example: 2d65bd5e-3fdf-4002-b166-bde7fb8863fa
    ChangeExpenseTypeEvent:
      properties:
        event_uuid:
          type: string
          description: The webhook unique ID.
          example: 7bf79328-a7ae-4222-aa54-091ff7f429a7
        event_type:
          $ref: '#/components/schemas/WebhookEventType'
          default: ExpenseReview
          description: The webhook event type.
          example: ExpenseReview
        event_name:
          $ref: '#/components/schemas/WebhookEventName'
          default: change_expense_type
          description: The webhook event name.
          example: change_expense_type
        company_account_id:
          type: string
          description: The company account ID.
          example: XMPL1234
        data:
          $ref: '#/components/schemas/ExpenseReview'
          description: The webhook `ExpenseReview` data.
        subscription_id:
          type: string
          description: The webhook subscription ID used to route this event.
          example: 2d65bd5e-3fdf-4002-b166-bde7fb8863fa
    SubscriptionAssigneeAddedEvent:
      properties:
        event_uuid:
          type: string
          description: The webhook unique ID.
          example: 7bf79328-a7ae-4222-aa54-091ff7f429a7
        event_type:
          $ref: '#/components/schemas/WebhookEventType'
          default: Subscription
          description: The webhook event type.
          example: Subscription
        event_name:
          $ref: '#/components/schemas/WebhookEventName'
          default: subscription_assignee_added
          description: The webhook event name.
          example: subscription_assignee_added
        company_account_id:
          type: string
          description: The company account ID.
          example: XMPL1234
        data:
          $ref: '#/components/schemas/Subscription'
          description: The webhook `Subscription` data.
        subscription_id:
          type: string
          description: The webhook subscription ID used to route this event.
          example: 2d65bd5e-3fdf-4002-b166-bde7fb8863fa
    TransactionAttachment:
      properties:
        attachment_id:
          type: string
          description: The `TransactionAttachment` ID.
          example: 2d65bd5e-3fdf-4002-b166-bde7fb8863fa
        transaction_id:
          type: string
          description: The `Transaction` ID the file is attached to.
          example: 7bf79328-a7ae-4222-aa54-091ff7f429a7
        file_name:
          type: string
          description: The file name of the attachment.
          example: invoice01.jpg
        file_extension:
          type: string
          description: The file extension of the attachment.
          example: .jpg
        file_size:
          type: integer
          format: int64
          description: The file size in bytes.
          example: 32768
        url:
          type: string
          description: The url of the attachment.
        file_url:
          type: string
          deprecated: true
          description: The Base64 string of the File URL encrypted by DES in ECB mode, Pkcs7 padding scheme and using Token for key. Deprecated, use `url` instead.
        url_type:
          $ref: '#/components/schemas/UrlType'
          description: The URL type (DOWNLOAD_URL to download the attachment; UPLOAD_URL to upload the attachment).
          example: DOWNLOAD_URL
        attachment_type:
          $ref: '#/components/schemas/TransactionAttachmentType'
          description: The type of attachment.
          example: INVOICE
        read_only:
          type: boolean
          description: It determines whether the attachment can be removed or updated.
        content_type:
          type: string
          description: 'The type of the `TransactionAttachment` content (default: ''binary/octet-stream'').'
          example: binary/octet-stream
        upload_time:
          type: string
          description: The date of upload.
          example: '2017-06-01T12:48:40Z'
        attachment_user_id:
          type: string
          description: The ID of the `User` that uploaded the attachment.
        upload_user_channel:
          $ref: '#/components/schemas/UploadUserChannel'
          description: The channel used to upload the attachment ).
        compressed_file:
          $ref: '#/components/schemas/TransactionAttachmentCompressedFile'
          description: The Compressed version of the attachment, Soldo automatically generates a compressedversion of any image type (e.g. `JPG`, `JPEG`, `PNG`) attachment having a size greater than `2.5MB`.
        metadata:
          type: object
          additionalProperties:
            type: string
          description: The metadata of the attachment.
        last_update_time:
          type: string
          description: The date and time when the `TransactionAttachment` was last updated.
          example: '2017-06-01T12:48:40Z'
    UserStatusChangedEvent:
      properties:
        event_uuid:
          type: string
          description: The webhook unique ID.
          example: 7bf79328-a7ae-4222-aa54-091ff7f429a7
        event_type:
          $ref: '#/components/schemas/WebhookEventType'
          default: Employee
          description: The webhook event type.
          example: Employee
        event_name:
          $ref: '#/components/schemas/WebhookEventName'
          default: user_status_changed
          description: The webhook event name.
          example: user_status_changed
        company_account_id:
          type: string
          description: The company account ID.
          example: XMPL1234
        data:
          $ref: '#/components/schemas/User'
          description: The webhook `User` data.
        subscription_id:
          type: string
          description: The webhook subscription ID used to route this event.
          example: 2d65bd5e-3fdf-4002-b166-bde7fb8863fa
    UnloadMoneyEvent:
      properties:
        event_uuid:
          type: string
          description: The webhook unique ID.
          example: 7bf79328-a7ae-4222-aa54-091ff7f429a7
        event_type:
          $ref: '#/components/schemas/WebhookEventType'
          default: Transaction
          description: The webhook event type.
          example: Transaction
        event_name:
          $ref: '#/components/schemas/WebhookEventName'
          default: unload_money
          description: The webhook event name.
          example: unload_money
        company_account_id:
          type: string
          description: The company account ID.
          example: XMPL1234
        data:
          $ref: '#/components/schemas/Transaction'
          description: The webhook `Transaction` data.
        subscription_id:
          type: string
          description: The webhook subscription ID used to route this event.
          example: 2d65bd5e-3fdf-4002-b166-bde7fb8863fa
    SubscriptionUpdatedEvent:
      properties:
        event_uuid:
          type: string
          description: The webhook unique ID.
          example: 7bf79328-a7ae-4222-aa54-091ff7f429a7
        event_type:
          $ref: '#/components/schemas/WebhookEventType'
          default: Subscription
          description: The webhook event type.
          example: Subscription
        event_name:
          $ref: '#/components/schemas/WebhookEventName'
          default: subscription_updated
          description: The webhook event name.
          example: subscription_updated
        company_account_id:
          type: string
          description: The company account ID.
          example: XMPL1234
        data:
          $ref: '#/components/schemas/Subscription'
          description: The webhook `Subscription` data.
        subscription_id:
          type: string
          description: The webhook subscription ID used to route this event.
          example: 2d65bd5e-3fdf-4002-b166-bde7fb8863fa
    ExpenseType:
      type: string
      enum:
      - COMPANY
      - PERSONAL
      - TRAVEL_AND_ENTERTAINMENT
    TransactionAttachmentCompressedFile:
      properties:
        file_name:
          type: string
          description: The file name of the compressed attachment.
          example: invoice01_thumb.jpg
        file_extension:
          type: string
          description: The file extension of the compressed attachment.
          example: .jpg
        file_size:
          type: integer
          format: int64
          description: The file size of the compressed attachment in bytes.
          example: 32768
        file_url:
          type: string
          deprecated: true
          description: The Base64 string of the Compressed File URL encrypted by DES in ECB mode, Pkcs7 padding scheme and using Token for key. Deprecated, use `url` instead.
        url:
          type: string
          description: The fileUrl  of the compressed attachment.
        url_type:
          $ref: '#/components/schemas/UrlType'
          description: The URL type (DOWNLOAD_URL to download the attachment; UPLOAD_URL to upload the attachment).
          example: DOWNLOAD_URL
    PurchaseDeleteEvent:
      properties:
        event_uuid:
          type: string
          description: The webhook unique ID.
          example: 7bf79328-a7ae-4222-aa54-091ff7f429a7
        event_type:
          $ref: '#/components/schemas/WebhookEventType'
          default: Purchase
          description: The webhook event type.
          example: Purchase
        event_name:
          $ref: '#/components/schemas/WebhookEventName'
          default: purchase_delete
          description: The webhook event name.
          example: purchase_delete
        company_account_id:
          type: string
          description: The company account ID.
          example: XMPL1234
        data:
          $ref: '#/components/schemas/Purchase'
          description: The webhook `Purchase` data.
        subscription_id:
          type: string
          description: The webhook subscription ID used to route this event.
          example: 2d65bd5e-3fdf-4002-b166-bde7fb8863fa
    ContactType:
      type: string
      enum:
      - SUPPLIER
      - CLIENT
      - EMPLOYEE
      - ACCOUNT
    LoadFailedEvent:
      properties:
        event_uuid:
          type: string
          description: The webhook unique ID.
          example: 7bf79328-a7ae-4222-aa54-091ff7f429a7
        event_type:
          $ref: '#/components/schemas/WebhookEventType'
          default: Transaction
          description: The webhook event type.
          example: Transaction
        event_name:
          $ref: '#/components/schemas/WebhookEventName'
          default: load_failed
          description: The webhook event name.
          example: load_failed
        company_account_id:
          type: string
          description: The company account ID.
          example: XMPL1234
        data:
          $ref: '#/components/schemas/Transaction'
          description: The webhook `Transaction` data.
        subscription_id:
          type: string
          description: The webhook subscription ID used to route this event.
          example: 2d65bd5e-3fdf-4002-b166-bde7fb8863fa
    UserStatus:
      type: string
      enum:
      - ACTIVE
      - INACTIVE
      - BLOCKED
      - SUSPENDED
      - PENDING
      - ARCHIVED
    ExpenseConfigurationActivityGroup:
      type: string
      enum:
      - USER
      - COMPANY
      - PURCHASE
      - SUBSCRIPTION
      - ONLINE_ADS
      - OUT_OF_PLATFORM_COMPANY
      - OUT_OF_PLATFORM_PERSONAL
    GroupType:
      type: string
      enum:
      - TEAM
      - PROJECT
      - DEPARTMENT
      - DIVISION
      - SQUAD
      - UNIT
      - PRODUCTION
    OrderStatus:
      type: string
      enum:
      - PENDING
      - ERROR
      - PLACED
      - CANCELLED
      - COMPLETED
      - COMPLETED_WITH_CREDIT
    WorkStatus:
      type: string
      enum:
      - AVAILABLE
      - OUT_OF_OFFICE
    OnlineAdsActivatedEvent:
      properties:
        event_uuid:
          type: string
          description: The webhook unique ID.
          example: 7bf79328-a7ae-4222-aa54-091ff7f429a7
        event_type:
          $ref: '#/components/schemas/WebhookEventType'
          default: OnlineAds
          description: The webhook event type.
          example: OnlineAds
        event_name:
          $ref: '#/components/schemas/WebhookEventName'
          default: online_ads_activated
          description: The webhook event name.
          example: online_ads_activated
        company_account_id:
          type: string
          description: The company account ID.
          example: XMPL1234
        data:
          $ref: '#/components/schemas/OnlineAds'
          description: The webhook `OnlineAds` data.
        subscription_id:
          type: string
          description: The webhook subscription ID used to route this event.
          example: 2d65bd5e-3fdf-4002-b166-bde7fb8863fa
    StoreOrderPlacedEvent:
      properties:
        event_uuid:
          type: string
          description: The webhook unique ID.
          example: 7bf79328-a7ae-4222-aa54-091ff7f429a7
        event_type:
          $ref: '#/components/schemas/WebhookEventType'
          default: Order
          description: The webhook event type.
          example: Order
        event_name:
          $ref: '#/components/schemas/WebhookEventName'
          default: store_order_placed
          description: The webhook event name.
          example: store_order_placed
        company_account_id:
          type: string
          description: The company account ID.
          example: XMPL1234
        data:
          $ref: '#/components/schemas/Order'
          description: The webhook `Order` data.
        subscription_id:
          type: string
          description: The webhook subscription ID used to route this event.
          example: 2d65bd5e-3fdf-4002-b166-bde7fb8863fa
    DisabledExpenseConfigurationEvent:
      properties:
        event_uuid:
          type: string
          description: The webhook unique ID.
          example: 7bf79328-a7ae-4222-aa54-091ff7f429a7
        event_type:
          $ref: '#/components/schemas/WebhookEventType'
          default: ExpenseReviewConfiguration
          description: The webhook event type.
          example: ExpenseReviewConfiguration
        event_name:
          $ref: '#/components/schemas/WebhookEventName'
          default: disabled_expense_configuration
          description: The webhook event name.
          example: disabled_expense_configuration
        company_account_id:
          type: string
          description: The company account ID.
          example: XMPL1234
        data:
          $ref: '#/components/schemas/ExpenseReviewConfiguration'
          description: The webhook `ExpenseReview` data.
        subscription_id:
          type: string
          description: The webhook subscription ID used to route this event.
          example: 2d65bd5e-3fdf-4002-b166-bde7fb8863fa
    UpdatedTransactionEvent:
      properties:
        event_uuid:
          type: string
          description: The webhook unique ID.
          example: 7bf79328-a7ae-4222-aa54-091ff7f429a7
        event_type:
          $ref: '#/components/schemas/WebhookEventType'
          default: ExpenseReview
          description: The webhook event type.
          example: ExpenseReview
        event_name:
          $ref: '#/components/schemas/WebhookEventName'
          default: updated_transaction
          description: The webhook event name.
          example: updated_transaction
        company_account_id:
          type: string
          description: The company account ID.
          example: XMPL1234
        data:
          $ref: '#/components/schemas/ExpenseReview'
          description: The webhook `ExpenseReview` data.
        subscription_id:
          type: string
          description: The webhook subscription ID used to route this event.
          example: 2d65bd5e-3fdf-4002-b166-bde7fb8863fa
    Source:
      properties:
        name:
          type: string
          description: The source name.
          example: J. Doe
        type:
          $ref: '#/components/schemas/LoadSource'
          description: The source type.
          example: BANK_TRANSFER
        destination_wallet_id:
          type: string
          description: ' The receiving wallet in the transaction, to which funds are being transferred.'
          example: de29bffb-7da2-40f1-934a-241170762d3e
        destination_wallet_name:
          type: string
          description: ' The receiving wallet name in the transaction, to which funds are being transferred.'
          example: EURO VIBAN
    SubscriptionPlatform:
      type: string
      enum:
      - ADOBE
      - AMAZON
      - APPLE
      - ATLASSIAN
      - FACEBOOK
      - FIGMA
      - GITHUB
      - GOOGLE
      - HUBSPOT
      - LINKEDIN
      - MICROSOFT
      - NOTION
      - OTHER
      - PINTEREST
      - SALESFORCE
      - TWITTER
      - XERO
      - ZOOM
    ContactStatus:
      type: string
      enum:
      - CREATED
      - SUGGESTED
    DepositAccountInfo:
      properties:
        type:
          $ref: '#/components/schemas/AccountInfoDeposit'
          description: The `type` of account identification.
          example: IBAN
        identification:
          type: string
          description: The account identification related to the type.
          example: GB00ABCD00000123456789
    ContactUpdatedEvent:
      properties:
        event_uuid:
          type: string
          description: The webhook unique ID.
          example: 7bf79328-a7ae-4222-aa54-091ff7f429a7
        event_type:
          $ref: '#/components/schemas/WebhookEventType'
          default: Contact
          description: The webhook event type.
          example: Contact
        event_name:
          $ref: '#/components/schemas/WebhookEventName'
          default: contact_updated
          description: The webhook event name.
          example: contact_updated
        company_account_id:
          type: string
          description: The company account ID.
          example: XMPL1234
        data:
          $ref: '#/components/schemas/Contact'
          description: The webhook `Contact` data.
        subscription_id:
          type: string
          description: The webhook subscription ID used to route this event.
          example: 2d65bd5e-3fdf-4002-b166-bde7fb8863fa
    PurchaseTransaction:
      properties:
        id:
          type: string
          description: 'The `Transaction` ID (sortable: no)'
          example: c861cc24-6663-410f-8c78-73f886fff4ef
        amount:
          type: number
          description: 'The maximum spendable amount of the `Purchase` (sortable: no)'
          example: 10.25
        amount_currency:
          $ref: '#/components/schemas/ISO4217Currency'
          description: 'The currency of the `Purchase` ([ISO 4217](https://www.six-group.com/en/products-services/financial-information/data-standards.html#scrollTo=maintenance-agency) code) (sortable: no)'
          example: EUR
        completed_time:
          type: string
          description: 'The date and time when the `Purchase` was completed (sortable: no)'
          example: '2017-06-01T12:48:40Z'
        transaction_category:
          type: string
          description: 'The category of the `Transaction` (sortable: no)'
    WebhookEventName:
      type: string
      enum:
      - business_trip_created
      - business_trip_updated
      - business_trip_deleted
      - card_activated
      - card_change_status
      - card_creation
      - card_destroyed
      - card_lost
      - card_replaced
      - card_stolen
      - card_label_updated
      - card_assignee_updated
      - add_resources_card
      - add_resources_member
      - add_resources_wallet
      - create_group
      - delete_group
      - move_resources_card
      - move_resources_member
      - move_resources_wallet
      - remove_resources_card
      - remove_resources_member
      - remove_resources_wallet
      - update_group
      - store_order_completed
      - store_order_placed
      - balanced_transfer
      - billing
      - card_authorization
      - conversion
      - customer_care_deposit
      - customer_care_withdraw
      - edit_tag
      - inbound_payment
      - inbound_payment_reversal
      - internal_transfer
      - joule_feed
      - load_failed
      - load_money
      - recurring_billing
      - scheduled_transfer
      - transaction_adjustment
      - unload_money
      - wiretransfer
      - upload_completed
      - attachment_delete
      - new_user
      - user_status_changed
      - user_updated
      - wallet_created
      - wallet_deleted
      - vehicle_create
      - vehicle_update
      - vehicle_delete
      - purchase_create
      - purchase_update
      - purchase_delete
      - purchase_redeem_card
      - created_expense_configuration
      - disabled_expense_configuration
      - enabled_expense_configuration
      - updated_expense_configuration
      - completed_transactions_import
      - updated_transaction
      - change_expense_type
      - subscription_activated
      - subscription_created
      - subscription_updated
      - subscription_deleted
      - subscription_assignee_added
      - subscription_assignee_removed
      - online_ads_activated
      - online_ads_created
      - online_ads_updated
      - online_ads_deleted
      - online_ads_assignee_added
      - online_ads_assignee_removed
      - transaction_created
      - transaction_modified
      - transaction_deleted
      - transaction_business_trip_linked
      - transaction_business_trip_unlinked
      - contact_created
      - contact_updated
      - contact_deleted
    AddressCategory:
      type: string
      enum:
      - USER
      - COMPANY
    ExpenseTransactionCategory:
      type: string
      enum:
      - Payment
      - Withdrawal
      - Refund
      - Chargeback
      - MileageReimbursement
    ExpenseCategory:
      properties:
        id:
          type: string
          description: The `ExpenseCategory` ID.
          example: 7bf79328-a7ae-4222-aa54-091ff7f429a7
        code:
          type: string
          description: The code of the `ExpenseCategory`.
          example: 123
        name:
          type: string
          description: The name of the `ExpenseCategory`.
          example: category-one
        description:
          type: string
          description: A custom description of the `ExpenseCategory`.
          example: An expense category
        tax_rate_id:
          type: string
          description: The ID of the VAT rate linked to the `ExpenseCategory`.
          example: c861cc24-6663-410f-8c78-73f886fff4ef
        enabled:
          type: boolean
          description: The `ExpenseCategory` is visible in the transaction detail.
          example: false
        merchant_categories:
          type: array
          description: A list of merchant categories this `ExpenseCategory`.
          items:
            $ref: '#/components/schemas/MerchantCategory'
          uniqueItems: true
        expense_type:
          type: string
          description: The type of expense assigned to category.
          example: TRAVEL_AND_ENTERTAINMENT
        integration:
          type: string
          description: The `ExpenseCategory`'s correlated integration.
          example: Netsuite
        creation_time:
          type: string
          description: 'The date and time when the `ExpenseCategory` was created (sortable: no).'
          example: '2017-06-01T12:48:40Z'
        last_update_time:
          type: string
          description: 'The date and time when the `ExpenseCategory` was last updated (sortable: no).'
          example: '2017-06-01T12:48:40Z'
    InboundPaymentReversalEvent:
      properties:
        event_uuid:
          type: string
          description: The webhook unique ID.
          example: 7bf79328-a7ae-4222-aa54-091ff7f429a7
        event_type:
          $ref: '#/components/schemas/WebhookEventType'
          default: Transaction
          description: The webhook event type.
          example: Transaction
        event_name:
          $ref: '#/components/schemas/WebhookEventName'
          default: inbound_payment_reversal
          description: The webhook event name.
          example: inbound_payment_reversal
        company_account_id:
          type: string
          description: The company account ID.
          example: XMPL1234
        data:
          $ref: '#/components/schemas/Transaction'
          description: The webhook `Transaction` data.
        subscription_id:
          type: string
          description: The webhook subscription ID used to route this event.
          example: 2d65bd5e-3fdf-4002-b166-bde7fb8863fa
    RecurringBillingEvent:
      properties:
        event_uuid:
          type: string
          description: The webhook unique ID.
          example: 7bf79328-a7ae-4222-aa54-091ff7f429a7
        event_type:
          $ref: '#/components/schemas/WebhookEventType'
          default: Transaction
          description: The webhook event type.
          example: Transaction
        event_name:
          $ref: '#/components/schemas/WebhookEventName'
          default: recurring_billing
          description: The webhook event name.
          example: recurring_billing
        company_account_id:
          type: string
          description: The company account ID.
          example: XMPL1234
        data:
          $ref: '#/components/schemas/Transaction'
          description: The webhook `Transaction` data.
        subscription_id:
          type: string
          description: The webhook subscription ID used to route this event.
          example: 2d65bd5e-3fdf-4002-b166-bde7fb8863fa
    CustomerCareWithdrawEvent:
      properties:
        event_uuid:
          type: string
          description: The webhook unique ID.
          example: 7bf79328-a7ae-4222-aa54-091ff7f429a7
        event_type:
          $ref: '#/components/schemas/WebhookEventType'
          default: Transaction
          description: The webhook event type.
          example: Transaction
        event_name:
          $ref: '#/components/schemas/WebhookEventName'
          default: customer_care_withdraw
          description: The webhook event name.
          example: customer_care_withdraw
        company_account_id:
          type: string
          description: The company account ID.
          example: XMPL1234
        data:
          $ref: '#/components/schemas/Transaction'
          description: The webhook `Transaction` data.
        subscription_id:
          type: string
          description: The webhook subscription ID used to route this event.
          example: 2d65bd5e-3fdf-4002-b166-bde7fb8863fa
    InboundPaymentEvent:
      properties:
        event_uuid:
          type: string
          description: The webhook unique ID.
          example: 7bf79328-a7ae-4222-aa54-091ff7f429a7
        event_type:
          $ref: '#/components/schemas/WebhookEventType'
          default: Transaction
          description: The webhook event type.
          example: Transaction
        event_name:
          $ref: '#/components/schemas/WebhookEventName'
          default: inbound_payment
          description: The webhook event name.
          example: inbound_payment
        company_account_id:
          type: string
          description: The company account ID.
          example: XMPL1234
        data:
          $ref: '#/components/schemas/Transaction'
          description: The webhook `Transaction` data.
        subscription_id:
          type: string
          description: The webhook subscription ID used to route this event.
          example: 2d65bd5e-3fdf-4002-b166-bde7fb8863fa
    VehicleUpdateEvent:
      properties:
        event_uuid:
          type: string
          description: The webhook unique ID.
          example: 7bf79328-a7ae-4222-aa54-091ff7f429a7
        event_type:
          $ref: '#/components/schemas/WebhookEventType'
          default: Vehicle
          description: The webhook event type.
          example: Vehicle
        event_name:
          $ref: '#/components/schemas/WebhookEventName'
          default: vehicle_update
          description: The webhook event name.
          example: vehicle_update
        company_account_id:
          type: string
          description: The company account ID.
          example: XMPL1234
        data:
          $ref: '#/components/schemas/Vehicle'
          description: The webhook `Vehicle` data.
        subscription_id:
          type: string
          description: The webhook subscription ID used to route this event.
          example: 2d65bd5e-3fdf-4002-b166-bde7fb8863fa
    CardStatus:
      type: string
      enum:
      - Normal
      - Do not honor
      - Lost card
      - Stolen card
      - Expired card
      - Restricted card
      - Security Violation
      - Cardholder to contact the issuer
      - Card Destroyed
    UrlType:
      type: string
      enum:
      - DOWNLOAD_URL
      - UPLOAD_URL
      - UPLOAD_COMPLETED
      - DELETE
      - THUMBNAILS_DOWNLOAD_URL
      - UPDATE_METADATA
    TransactionStatus:
      type: string
      enum:
      - Authorised
      - Settled
      - Cancelled
      - Declined
      - DisputeFailed
      - DisputeOpened
      - DisputeWon
      - Moved
      - Unknown
    WebhookEventType:
      type: string
      enum:
      - BusinessTrip
      - Card
      - Contact
      - ExpenseReview
      - Group
      - OnlineAds
      - Order
      - Purchase
      - Subscription
      - Transaction
      - TransactionAttachment
      - Employee
      - Vehicle
      - Wallet
    CardSensitiveData:
      properties:
        encrypted_full_pan:
          type: string
          description: The encrypted PAN of the card.
        encrypted_cvv:
          type: string
          description: The encrypted cvv of the card.
        encrypted_pin:
          type: string
          description: The encrypted pin of the card (only valid for PLASTIC or FUEL card type).
    ContactCreatedEvent:
      properties:
        event_uuid:
          type: string
          description: The webhook unique ID.
          example: 7bf79328-a7ae-4222-aa54-091ff7f429a7
        event_type:
          $ref: '#/components/schemas/WebhookEventType'
          default: Contact
          description: The webhook event type.
          example: Contact
        event_name:
          $ref: '#/components/schemas/WebhookEventName'
          default: contact_created
          description: The webhook event name.
          example: contact_created
        company_account_id:
          type: string
          description: The company account ID.
          example: XMPL1234
        data:
          $ref: '#/components/schemas/Contact'
          description: The webhook `Contact` data.
        subscription_id:
          type: string
          description: The webhook subscription ID used to route this event.
          example: 2d65bd5e-3fdf-4002-b166-bde7fb8863fa
    CardType:
      type: string
      enum:
      - PLASTIC
      - VIRTUAL
      - FUEL
      - GOOGLE_CARD
    UserRole:
      properties:
        id:
          type: string
          description: The ID of the `UserRole`.
          example: superAdmin
        name:
          type: string
          description: The name of the `UserRole`.
          example: superAdmin
        description:
          type: string
          description: The description of the `UserRole`.
          example: The SuperAdmin role
        scope:
          type: string
          description: The scope of the `UserRole`.
          example: ALL
    TransactionBusinessTripLinkedEvent:
      properties:
        event_uuid:
          type: string
          description: The webhook unique ID.
          example: 7bf79328-a7ae-4222-aa54-091ff7f429a7
        event_type:
          $ref: '#/components/schemas/WebhookEventType'
          default: Transaction
          description: The webhook event type.
          example: Transaction
        event_name:
          $ref: '#/components/schemas/WebhookEventName'
          default: transaction_business_trip_linked
          description: The webhook event name.
          example: transaction_business_trip_linked
        company_account_id:
          type: string
          description: The company account ID.
          example: XMPL1234
        data:
          $ref: '#/components/schemas/Transaction'
          description: The webhook `Transaction` data.
        subscription_id:
          type: string
          description: The webhook subscription ID used to route this event.
          example: 2d65bd5e-3fdf-4002-b166-bde7fb8863fa
    PurchaseStatus:
      type: string
      enum:
      - SUCCESSFUL
      - ACTIVE
      - ASSIGNED
      - DELETED
      - EXPIRED
      - REQUEST_EXTENSION
    TransactionBusinessTripUnlinkedEvent:
      properties:
        event_uuid:
          type: string
          description: The webhook unique ID.
          example: 7bf79328-a7ae-4222-aa54-091ff7f429a7
        event_type:
          $ref: '#/components/schemas/WebhookEventType'
          default: Transaction
          description: The webhook event type.
          example: Transaction
        event_name:
          $ref: '#/components/schemas/WebhookEventName'
          default: transaction_business_trip_unlinked
          description: The webhook event name.
          example: transaction_business_trip_unlinked
        company_account_id:
          type: string
          description: The company account ID.
          example: XMPL1234
        data:
          $ref: '#/components/schemas/Transaction'
          description: The webhook `Transaction` data.
        subscription_id:
          type: string
          description: The webhook subscription ID used to route this event.
          example: 2d65bd5e-3fdf-4002-b166-bde7fb8863fa
    ConversionEvent:
      properties:
        event_uuid:
          type: string
          description: The webhook unique ID.
          example: 7bf79328-a7ae-4222-aa54-091ff7f429a7
        event_type:
          $ref: '#/components/schemas/WebhookEventType'
          default: Transaction
          description: The webhook event type.
          example: Transaction
        event_name:
          $ref: '#/components/schemas/WebhookEventName'
          default: conversion
          description: The webhook event name.
          example: conversion
        company_account_id:
          type: string
          description: The company account ID.
          example: XMPL1234
        data:
          $ref: '#/components/schemas/Transaction'
          description: The webhook `Transaction` data.
        subscription_id:
          type: string
          description: The webhook subscription ID used to route this event.
          example: 2d65bd5e-3fdf-4002-b166-bde7fb8863fa
    Transaction:
      properties:
        id:
          type: string
          description: 'The `Transaction` ID (sortable: yes).'
          example: 7bf79328-a7ae-4222-aa54-091ff7f429a7
        wallet_id:
          type: string
          description: 'The ID of the `Wallet` from where the `Transaction` has been authorised (sortable: no).'
          example: 6853e657-c797-4985-8d6b-5425d4e51df8
        wallet_name:
          type: string
          description: 'The name of the `Wallet` from where the `Transaction` has been authorised (sortable: no).'
          example: John Doe
        status:
          $ref: '#/components/schemas/TransactionStatus'
          description: 'The status of the `Transaction` (sortable: yes).'
          example: Settled
        category:
          $ref: '#/components/schemas/TransactionCategory'
          description: 'The category of the `Transaction` (sortable: yes).'
          example: Payment
        transaction_sign:
          $ref: '#/components/schemas/TransactionSign'
          description: 'The sign of the transaction amount (Negative, Positive, None) (sortable: no).'
          example: Negative
        purchase_id:
          type: string
          description: 'The `Purchase` ID (sortable: no).'
          example: 6853e657-c797-4985-8d6b-5425d4e51df8
        amount:
          type: number
          description: 'The amount of the `Transaction` in the currency of the `Wallet` (sortable: no).'
          example: 10.25
        amount_currency:
          $ref: '#/components/schemas/ISO4217Currency'
          description: 'The currency [ISO 4217](https://www.six-group.com/en/products-services/financial-information/data-standards.html#scrollTo=maintenance-agency) code of the amount (sortable: no).'
          example: EUR
        tx_amount:
          type: number
          description: 'The amount of the `Transaction` in the currency of the `Merchant` (sortable: no).'
          example: 10.25
        tx_amount_currency:
          $ref: '#/components/schemas/ISO4217Currency'
          description: 'The currency [ISO 4217](https://www.six-group.com/en/products-services/financial-information/data-standards.html#scrollTo=maintenance-agency) code of the `tx_amount` (sortable: no).'
          example: EUR
        fee_amount:
          type: number
          description: 'The amount of the `Transaction` fee in the currency of the `Wallet` (sortable: no).'
          example: 10.25
        fee_currency:
          $ref: '#/components/schemas/ISO4217Currency'
          description: 'The currency [ISO 4217](https://www.six-group.com/en/products-services/financial-information/data-standards.html#scrollTo=maintenance-agency) code of the fee_amount (sortable: no).'
          example: EUR
        exchange_rate:
          type: number
          description: 'The exchange rate applied at the `Settled` status (sortable: no).'
          example: 1
        auth_exchange_rate:
          type: number
          description: 'The exchange rate applied at the `Authorised` status (sortable: no).'
          example: 1
        expense_status:
          $ref: '#/components/schemas/ExpenseStatus'
          description: 'The status of approval of the expense (sortable: no).'
          example: APPROVED
        expense_type:
          $ref: '#/components/schemas/ExpenseType'
          description: 'The type of the expense (sortable: no).'
          example: TRAVEL_AND_ENTERTAINMENT
        expense_date:
          type: string
          description: 'The date and time of the last review of the expense (sortable: no).'
          example: '2017-06-01T12:48:40Z'
        expense_reviewer:
          type: string
          description: 'The ID of the `User` who reviewed the expense (sortable: no).'
          example: XMPL1234-000001
        expense_approved_amount:
          type: number
          description: 'The expense amount that a reviewer has approved (sortable: no).'
          example: 10.25
        expense_report_id:
          type: string
          description: 'The ID of the `ExpenseReport` the `Transaction` is included into (sortable: no).'
          example: c861cc24-6663-410f-8c78-73f886fff4ef
        date:
          type: string
          description: 'The date and time of the `Transaction` at the `Authorised` status (sortable: yes).'
          example: '2017-06-01T12:48:40Z'
        settlement_date:
          type: string
          description: 'The date and time of the `Transaction` at the `Settled` status (sortable: yes).'
          example: '2017-06-01T12:48:40Z'
        update_time:
          type: string
          description: 'The date and time of the last update to the `Transaction` (sortable: yes).'
          example: '2017-06-01T12:48:40Z'
        merchant:
          $ref: '#/components/schemas/TransactionMerchant'
          description: 'The name of the Merchant of the transaction (only valid for `Payment`, `Withdrawal`, `Refund` transaction categories) (sortable: no).'
        merchant_category:
          $ref: '#/components/schemas/TransactionMerchantCategory'
          description: 'The category of the `Merchant` of the `Transaction` (only valid for `Payment`, `Withdrawal`, `Refund` transaction categories) (sortable: no).'
        tags:
          type: array
          description: The list of the `Tags` of the `Transaction`.
          items:
            $ref: '#/components/schemas/TransactionTag'
        card_id:
          type: string
          description: 'The ID of the `Card` used for the `Transaction` (sortable: no).'
          example: 6853e657-c797-4985-8d6b-5425d4e51df8
        masked_pan:
          type: string
          description: 'The masked PAN of the `Card` used for the `Transaction` (sortable: yes).'
          example: 123456******1234
        owner_name:
          type: string
          description: 'The name of the cardholder who made the transaction (only available when `owner_type` is `employee`) (sortable: no).'
          example: John
        owner_surname:
          type: string
          description: 'The surname of the cardholder who made the transaction (only available when `owner_type` is `employee`) (sortable: no).'
          example: Smith
        owner_type:
          $ref: '#/components/schemas/TransactionOwnerType'
          description: 'The owner type (`company`, `employee`) (sortable: no).'
          example: company
        owner_id:
          type: string
          description: 'The ID of the Cardholder who made the `Transaction` (only available when `owner_type` is `employee`) (sortable: no).'
          example: XMPL1234-000003
        custom_reference_id:
          type: string
          description: 'The custom reference ID of the Cardholder who made the `Transaction` (only available when `owner_type` is `employee`) (sortable: no).'
          example: 123456-user-1
        group_id:
          type: string
          description: 'The ID of the `Group` the `Transaction` belongs to (sortable: no). '
          example: 2d65bd5e-3fdf-4002-b166-bde7fb8863fa
        has_attachments:
          type: boolean
          description: 'It determines whether the transaction has one or more `TransactionAttachments` (sortable: no).'
          example: false
        trx_owner_id:
          type: string
          description: 'For User `Card` transactions, when `owner_type` is `employee`, is the cardholder ID, for Company `Card`, when `owner_type` is `company`, is empty or one of the `Card` assignees (sortable: no).'
          example: XMPL1234-000003
        metadata_ids:
          type: array
          description: 'A list of IDs related to custom generated `Metadata` of the `Transaction` (sortable: no).'
          example:
          - express
          items:
            type: string
        fuel_details:
          $ref: '#/components/schemas/TransactionFuelDetails'
          description: 'The fuel details of the `Transaction`  (sortable: no).'
        vat_percentage:
          type: number
          description: 'The VAT percentage applied (sortable: no).'
          example: 15
        vat_amount:
          type: number
          description: 'The amount of the VAT in the currency of the `Wallet` (sortable: no).'
          example: 10.25
        vat_currency:
          $ref: '#/components/schemas/ISO4217Currency'
          description: 'The currency [ISO 4217](https://www.six-group.com/en/products-services/financial-information/data-standards.html#scrollTo=maintenance-agency) code of the vat_amount (sortable: no).'
          example: EUR
        user_notes:
          type: string
          description: 'The notes defined by the `User` (sortable: no).'
        notes:
          type: string
          description: 'The notes defined by Soldo (sortable: no).'
        direct_url:
          type: string
          description: 'The direct URL to the transaction details page (sortable: no).'
        flags:
          type: array
          description: 'List of strings: `forUser`, `forAdmin` or empty. It determines for which kinds of `Users` the transaction is flagged to (sortable: no).'
          example:
          - forUser
          items:
            type: string
        payment_method:
          $ref: '#/components/schemas/TransactionPaymentMethod'
          description: The payment method of the `Transaction`.
          example: ONLINE_ADS
        payment_method_id:
          type: string
          description: 'The ID of the payment method, could be the ID of a `Subscription`, `OnlineAds` or `Purchase` resource (sortable: no).'
          example: 6853e657-c797-4985-8d6b-5425d4e51df8
        expense_category:
          $ref: '#/components/schemas/ExpenseCategory'
          description: The `ExpenseCategory` assigned to the `Transaction`.
        tax_rate:
          $ref: '#/components/schemas/VatRate'
          description: The `Transaction`'s `VatRate`.
        split:
          type: boolean
          description: 'It determines whether the transaction has been split (sortable: no).'
          example: false
        tx_id:
          type: string
          description: The transaction's internal id (the same ID that can be found on reports and the advanced details section of a `Transaction`).
          example: 5-857211147-150603333585014265
        payment_trn_code:
          type: string
          description: The Transaction Reference Number (TRN) of the outbound payment generated by Soldo. Available for `SEPA`, `SEPA_INSTANT`.
          example: 1234567890123456789012345678IT
        carbon_emissions:
          $ref: '#/components/schemas/TransactionCarbonEmissionInfo'
          description: The amount of CO2e emissions generated as a result of the `Transaction`.
        required_information:
          $ref: '#/components/schemas/SearchTransactionRequiredInformation'
          description: It indicates whether a transaction has (or doesn’t have) all details marked as mandatory in the ‘Reminders’ section filled in.
          example: COMPLETE
        reimbursement_expense_report_id:
          type: string
          description: 'The ID of the ExpenseReport that was reimbursed by this payment. Note to developer: if this ID is not null this payment can be considered a reimbursement. (sortable: no).'
        invoice:
          $ref: '#/components/schemas/Invoice'
          description: The invoice to which this transaction relates
        source:
          $ref: '#/components/schemas/Source'
          description: Info about the origin of the `Transaction` (this applies for `InboundFasterPayment`, `InboundFasterPaymentReversal`, `Load`, `LoadReversal` and `Wiretransfer`).
        custom_export:
          type: array
          description: The info generated as a result of the custom export `Transaction`.
          items:
            $ref: '#/components/schemas/CustomExport'
        out_spending_policy:
          $ref: '#/components/schemas/TransactionSpendingPolicyMetadata'
          description: The outSpendingPolicy of the `Transaction`.
        business_trip_id:
          type: string
          description: 'The ID of the `BusinessTrip` the `Transaction` is linked to (sortable: no).'
        card_name:
          type: string
          description: 'The name of the `Card` used for the `Transaction` (sortable: no).'
          example: CardName
        details:
          $ref: '#/components/schemas/TransactionDetails'
          description: 'The details of the `Transaction`  (sortable: no).'
        split_transactions:
          type: array
          description: The list of `SplitTransactionInfo`.
          items:
            $ref: '#/components/schemas/TransactionSplitInfo'
        timeline:
          type: array
          description: The timeline of changes affecting the `Transaction` and the related `Wallet`. For each occurrence, the `Wallet` balance is reported before and after the change.
          items:
            $ref: '#/components/schemas/TransactionTimelineItem'
    Address:
      properties:
        id:
          type: string
          description: The `Address` ID.
          example: 7bf79328-a7ae-4222-aa54-091ff7f429a7
        recipient:
          type: string
          description: The recipient of the `Address`
          example: JohnSmith
        name:
          type: string
          description: The actual name of the `Address`.
          example: Foo Street 75
        line1:
          type: string
          description: The `Address` street.
          example: Bar Street 64
        line2:
          type: string
          description: An optional other street.
          example: Other street 31
        country:
          type: string
          description: The country of the `Address`.
          example: GB
        county:
          type: string
          description: The county of the `Address`.
          example: LD
        city:
          type: string
          description: The city of the `Address`.
          example: London
        post_code:
          type: string
          description: The postal code of the `Address`.
          example: '00000'
        delivery_phone_number:
          type: string
          description: Delivery phone number
          example: '+441234567890'
        default_shipping:
          type: boolean
          description: True if the `Address` is the default shipping address.
          example: false
        type:
          type: string
          description: The type of the `Address`.
          example: SHIPPING
        category:
          $ref: '#/components/schemas/AddressCategory'
          description: The category of the `Address`.
          example: COMPANY
        user_id:
          type: string
          description: The `User` ID, only if category of the `Address` is `USER`.
        creation_time:
          type: string
          description: The date and time when the `Address` was created.
          example: '2017-06-01T12:48:40Z'
        last_update:
          type: string
          description: The date and time when the `Address` was last updated.
          example: '2017-06-01T12:48:40Z'
    User:
      properties:
        id:
          type: string
          description: The `User` ID.
          example: XMPL1234-000001
        name:
          type: string
          description: 'The name of the `User` (sortable: yes).'
          example: John
        surname:
          type: string
          description: 'The surname of the `User` (sortable: yes).'
          example: Smith
        middlename:
          type: string
          description: 'The middlename of the `User` (sortable: no).'
          example: John
        dob:
          type: string
          description: The Date of birth of the `User`.
          example: '1970-10-21'
        job_title:
          type: string
          description: 'The job title of the `User` (sortable: yes).'
          example: Business Strategist
        department:
          type: string
          description: 'The department of the `User` (sortable: no).'
          example: Research & Development
        email:
          type: string
          description: 'The email address of the `User` (sortable: no).'
          example: jdoe@fake.soldo.com
        mobile:
          type: string
          description: 'The mobile number of the `User` including the country code (sortable: no).'
          example: '+44123323232'
        mobile_prefix:
          type: string
          description: 'The mobile number country code (sortable: no).'
          example: '+44'
        custom_reference_id:
          type: string
          description: 'The reference of the employee in an external system (sortable: yes).'
          example: 123456-user-1
        status:
          $ref: '#/components/schemas/UserStatus'
          description: 'The status of the `User` (sortable: yes).'
          example: ACTIVE
        visible:
          type: boolean
          description: 'It determines whether the `User` is visible in the web console (sortable: yes).'
          example: true
        mobile_access:
          type: boolean
          description: 'It determines whether the `User` has mobile access (sortable: no).'
          example: true
        web_access:
          type: boolean
          description: 'It determines whether the `User` has web access (sortable: no).'
          example: true
        groups:
          type: array
          description: 'The list of `Groups` ID the `User` is member of (sortable: no).'
          example:
          - 7bf79328-a7ae-4222-aa54-091ff7f429a7
          - 2d65bd5e-3fdf-4002-b166-bde7fb8863fa
          items:
            type: string
        shipping_address:
          $ref: '#/components/schemas/Address'
          description: The default shipping `Address` of the `User`.
          example: 7bf79328-a7ae-4222-aa54-091ff7f429a7
        reports_to:
          type: string
          description: The ID of the `User` it reports to.
          example: XMPL1234-000001
        roles:
          type: array
          description: The list of `UserRole` of the `User`.
          items:
            $ref: '#/components/schemas/UserRole'
        contact_id:
          type: string
          description: The ID of the `Contact` assigned to the `User`. This information can be updated from the [Add Contact](ref:contact-add) and [Update Contact](ref:contact-update) endpoints.
          example: 135fdb6c-2e77-4fc0-a79f-2453fde75ef7
        creation_time:
          type: string
          description: 'The date and time when the `User` was created (sortable: yes).'
          example: '2017-06-01T12:48:40Z'
        last_update:
          type: string
          description: 'The date and time when the `User` was last updated (sortable: yes).'
          example: '2017-06-01T12:48:40Z'
        work_status:
          $ref: '#/components/schemas/WorkStatus'
          description: The work status of the `User`.
          example: OUT_OF_OFFICE
    TransactionSign:
      type: string
      enum:
      - Negative
      - Positive
      - None
    CustomExport:
      properties:
        product:
          type: string
          description: A product that exported list of `Transaction`
          example: SAP
        export_date:
          type: string
          description: A date of exported `Transactions`
          example: '2017-06-01T12:48:40Z'
    VehicleStatus:
      type: string
      enum:
      - ACTIVE
      - ARCHIVED
    CardAuthorizationEvent:
      properties:
        event_uuid:
          type: string
          description: The webhook unique ID.
          example: 7bf79328-a7ae-4222-aa54-091ff7f429a7
        event_type:
          $ref: '#/components/schemas/WebhookEventType'
          default: Transaction
          description: The webhook event type.
          example: Transaction
        event_name:
          $ref: '#/components/schemas/WebhookEventName'
          default: card_authorization
          description: The webhook event name.
          example: card_authorization
        company_account_id:
          type: string
          description: The company account ID.
          example: XMPL1234
        data:
          $ref: '#/components/schemas/Transaction'
          description: The webhook `Transaction` data.
        subscription_id:
          type: string
          description: The webhook subscription ID used to route this event.
          example: 2d65bd5e-3fdf-4002-b166-bde7fb8863fa
    OnlineAdsStatus:
      type: string
      enum:
      - ACTIVE
      - ASSIGNED
      - CANCELLED
    RemoveResourcesWalletEvent:
      properties:
        event_uuid:
          type: string
          description: The webhook unique ID.
          example: 7bf79328-a7ae-4222-aa54-091ff7f429a7
        event_type:
          $ref: '#/components/schemas/WebhookEventType'
          default: Team
          description: The webhook event type.
          example: Team
        event_name:
          $ref: '#/components/schemas/WebhookEventName'
          default: remove_resources_wallet
          description: The webhook event name.
          example: remove_resources_wallet
        company_account_id:
          type: string
          description: The company account ID.
          example: XMPL1234
        data:
          $ref: '#/components/schemas/Group'
          description: The webhook `Group` data.
        subscription_id:
          type: string
          description: The webhook subscription ID used to route this event.
          example: 2d65bd5e-3fdf-4002-b166-bde7fb8863fa
    AccountInfoContact:
      properties:
        type:
          $ref: '#/components/schemas/AccountIdentificationType'
          description: The type of the bank account identification.
          example: IBAN
        identification:
          type: string
          description: The bank account identification for the specified type.
          example: GB00ABCD00000123456789
    OrderItem:
      properties:
        id:
          type: string
          description: The ID of a single item of a specific `Order`.
          example: 7bf79328-a7ae-4222-aa54-091ff7f429a7
        item_type:
          type: string
          description: The type of the ordered item.
          example: CARD
        category:
          type: string
          description: The category of the ordered item.
    TransactionMerchant:
      properties:
        id:
          type: string
          description: The ID of the `Merchant`.
          example: 2100846839
        name:
          type: string
          description: The name of the `Merchant` (normalised).
          example: SHH HOTEL LONDON
        raw_name:
          type: string
          description: The raw name of the `Merchant`.
          example: SHERLOCK HOLMES HOTEL  LONDON        GBR
        code:
          type: string
          description: The Mastercard `Merchant` code.
        address:
          type: string
          description: The `Merchant` address.
    Order:
      properties:
        id:
          type: string
          description: The `Order` ID.
          example: 7bf79328-a7ae-4222-aa54-091ff7f429a7
        status:
          $ref: '#/components/schemas/OrderStatus'
          description: The status of the `Order`.
          example: PENDING
        creation_time:
          type: string
          description: The date and time when the `Order` was created.
          example: '2017-06-01T12:48:40Z'
        last_update_time:
          type: string
          description: The last update date of the `Order`.
          example: '2017-06-01T12:48:40Z'
        error_code:
          type: string
          description: In case is_valid is false, the error code of the `Order` is shown.
        total_paid_amount:
          type: number
          description: The total amount of the `Order`.
          example: 10.25
        total_paid_currency:
          $ref: '#/components/schemas/ISO4217Currency'
          description: The currency for the total paid amount.
          example: EUR
        items:
          type: array
          description: The products associated with the `Order`.
          items:
            $ref: '#/components/schemas/OrderItem'
        is_valid:
          type: boolean
          description: It states whether the `Order` is valid.
          example: true
    AddResourcesWalletEvent:
      properties:
        event_uuid:
          type: string
          description: The webhook unique ID.
          example: 7bf79328-a7ae-4222-aa54-091ff7f429a7
        event_type:
          $ref: '#/components/schemas/WebhookEventType'
          default: Team
          description: The webhook event type.
          example: Team
        event_name:
          $ref: '#/components/schemas/WebhookEventName'
          default: add_resources_wallet
          description: The webhook event name.
          example: add_resources_wallet
        company_account_id:
          type: string
          description: The company account ID.
          example: XMPL1234
        data:
          $ref: '#/components/schemas/Group'
          description: The webhook `Group` data.
        subscription_id:
          type: string
          description: The webhook subscription ID used to route this event.
          example: 2d65bd5e-3fdf-4002-b166-bde7fb8863fa
    CreatedExpenseConfigurationEvent:
      properties:
        event_uuid:
          type: string
          description: The webhook unique ID.
          example: 7bf79328-a7ae-4222-aa54-091ff7f429a7
        event_type:
          $ref: '#/components/schemas/WebhookEventType'
          default: ExpenseReviewConfiguration
          description: The webhook event type.
          example: ExpenseReviewConfiguration
        event_name:
          $ref: '#/components/schemas/WebhookEventName'
          default: created_expense_configuration
          description: The webhook event name.
          example: created_expense_configuration
        company_account_id:
          type: string
          description: The company account ID.
          example: XMPL1234
        data:
          $ref: '#/components/schemas/ExpenseReviewConfiguration'
          description: The webhook `ExpenseReview` data.
        subscription_id:
          type: string
          description: The webhook subscription ID used to route this event.
          example: 2d65bd5e-3fdf-4002-b166-bde7fb8863fa
    Vehicle:
      properties:
        id:
          type: string
          description: 'The `Vehicle` ID (sortable: no).'
          example: 7bf79328-a7ae-4222-aa54-091ff7f429a7
        number_plate:
          type: string
          description: 'The plate number of the `Vehicle` (sortable: yes).'
          example: AA000BB
        description:
          type: string
          description: 'The description of the `Vehicle` (sortable: no).'
          example: Employee electric vehicle
        vat_deductible:
          $ref: '#/components/schemas/VatDeductibilityPercentage'
          description: 'The VAT deductibility rate (sortable: no).'
          example: 40
        fuel_type:
          $ref: '#/components/schemas/FuelType'
          description: 'The fuel type (sortable: no).'
          example: PETROL
        status:
          $ref: '#/components/schemas/VehicleStatus'
          description: 'The vehicle status (sortable: no).'
          example: ACTIVE
        creation_time:
          type: string
          description: 'The date and time when the `Vehicle` was created (sortable: yes).'
          example: '2017-06-01T12:48:40Z'
        last_update_time:
          type: string
          description: 'The last date and time when the `Vehicle` was updated (sortable: yes).'
          example: '2017-06-01T12:48:40Z'
        card_ids:
          type: array
          description: 'The list of `Card` ID associated with the vehicle (sortable: no).'
          example:
          - 7bf79328-a7ae-4222-aa54-091ff7f429a7
          - 2d65bd5e-3fdf-4002-b166-bde7fb8863fa
          items:
            type: string
        reimbursement_rate:
          type: number
          description: 'The rate to apply for a `MileageReimbursement`, measured in main `Wallet` currency per km (sortable: no).'
          example: 0.45
    Card:
      properties:
        id:
          type: string
          description: 'The `Card` ID (sortable: yes).'
          example: 7bf79328-a7ae-4222-aa54-091ff7f429a7
        name:
          type: string
          description: 'The name of the `Card` (sortable: yes).'
          example: CardName
        label:
          type: string
          description: 'The label of the `Card (sortable: no)`.'
          example: CardLabel
        masked_pan:
          type: string
          description: 'The masked PAN of the `Card` (sortable: yes).'
          example: 123456******1234
        card_holder:
          type: string
          description: 'The name and surname of the Cardholder of the `Card`, only available when `owner_type` is `employee` (sortable: yes).'
          example: John Doe
        expiration_date:
          type: string
          description: 'The expiration date and time of the `Card` (sortable: yes).'
          example: '2026-05-07T23:59:59Z'
        creation_time:
          type: string
          description: 'The date and time when the `Card` was created (sortable: yes).'
          example: '2017-06-01T12:48:40Z'
        last_update:
          type: string
          description: 'The date and time when the `Card` was last updated (sortable: yes).'
          example: '2017-06-01T12:48:40Z'
        type:
          $ref: '#/components/schemas/CardType'
          description: 'The type of `Card` (sortable: no).'
          example: PLASTIC
        status:
          $ref: '#/components/schemas/CardStatus'
          description: 'The status of the `Card` (sortable: yes).'
          example: Normal
        owner_type:
          $ref: '#/components/schemas/CardOwnerType'
          description: 'The owner type (sortable: no).'
          example: employee
        owner_public_id:
          type: string
          description: The ID of the Cardholder available when `owner_type` is `employee`.
          example: XMPL1234-000001
        custom_reference_id:
          type: string
          description: 'The custom reference ID of the Cardholder (sortable: no).'
          example: 123456-user-1
        wallet_id:
          type: string
          description: 'The ID of the `Wallet` the `Card` is linked to (sortable: no).'
          example: 7bf79328-a7ae-4222-aa54-091ff7f429a7
        currency_code:
          $ref: '#/components/schemas/ISO4217Currency'
          description: 'The currency of the `Wallet` the `Card` is linked to ([ISO 4217](https://www.six-group.com/en/products-services/financial-information/data-standards.html#scrollTo=maintenance-agency) code) (sortable: no).'
          example: EUR
        emboss_line4:
          type: string
          description: 'The fourth line printed on the `Card` (sortable: no).'
          example: Example Inc.
        active:
          type: boolean
          description: 'It determines whether the `Card` is active (sortable: yes).'
          example: true
        group_id:
          type: string
          deprecated: true
          description: 'The ID of the `Group` the `Card` is related to (sortable: no). In case of multiple groups associated this field contains the first one for backward compatibility.'
          example: 7bf79328-a7ae-4222-aa54-091ff7f429a7
        groups:
          type: array
          description: 'The list of `Group` ID the `Card` is related to (sortable: no).'
          example:
          - 7bf79328-a7ae-4222-aa54-091ff7f429a7
          - 2d65bd5e-3fdf-4002-b166-bde7fb8863fa
          items:
            type: string
        sensitive_data:
          $ref: '#/components/schemas/CardSensitiveData'
          description: 'The `Card` sensitive data (sortable: no).'
        vehicle_id:
          type: string
          description: 'The ID of the `Vehicle` assigned to the card (sortable: no).'
          example: 7bf79328-a7ae-4222-aa54-091ff7f429a7
        assignees:
          type: array
          description: 'List of `User` IDs currently assigned to the `Card`, when `owner_type` is `employee` there is only one assignee, when is `company` there could be none or more assignees (sortable: no).'
          example:
          - XMPL1234-000001
          - XMPL1234-000002
          - XMPL1234-000003
          items:
            type: string
        payment_method:
          $ref: '#/components/schemas/CardPaymentMethod'
          description: 'The `Card` payment method (sortable: no).'
          example: ONLINE_ADS
        payment_method_id:
          type: string
          description: 'The payment method ID (sortable: no).'
          example: 7bf79328-a7ae-4222-aa54-091ff7f429a7
        preset_id:
          type: string
          description: The `cardRulePreset` ID assigned to the `Card`.
          example: c861cc24-6663-410f-8c78-73f886fff4ef
        shipping_address_id:
          type: string
          description: The `shippingAddress` ID assigned to the `Card`.
          example: c861cc24-6663-410f-8c78-73f886fff4ef
        renewal_info:
          $ref: '#/components/schemas/CardRenewalInfo'
          description: Renewal details for the `Card`. Present only when a renewal process has been initiated for the `Card`, `null` otherwise.
    InternalTransferEvent:
      properties:
        event_uuid:
          type: string
          description: The webhook unique ID.
          example: 7bf79328-a7ae-4222-aa54-091ff7f429a7
        event_type:
          $ref: '#/components/schemas/WebhookEventType'
          default: Transaction
          description: The webhook event type.
          example: Transaction
        event_name:
          $ref: '#/components/schemas/WebhookEventName'
          default: internal_transfer
          description: The webhook event name.
          example: internal_transfer
        company_account_id:
          type: string
          description: The company account ID.
          example: XMPL1234
        data:
          $ref: '#/components/schemas/Transaction'
          description: The webhook `Transaction` data.
        subscription_id:
          type: string
          description: The webhook subscription ID used to route this event.
          example: 2d65bd5e-3fdf-4002-b166-bde7fb8863fa
    SubscriptionStatus:
      type: string
      enum:
      - ACTIVE
      - ASSIGNED
      - CANCELLED
    SearchTransactionRequiredInformation:
      type: string
      enum:
      - COMPLETE
      - NOT_COMPLETE
    PurchaseCreateEvent:
      properties:
        event_uuid:
          type: string
          description: The webhook unique ID.
          example: 7bf79328-a7ae-4222-aa54-091ff7f429a7
        event_type:
          $ref: '#/components/schemas/WebhookEventType'
          default: Purchase
          description: The webhook event type.
          example: Purchase
        event_name:
          $ref: '#/components/schemas/WebhookEventName'
          default: purchase_create
          description: The webhook event name.
          example: purchase_create
        company_account_id:
          type: string
          description: The company account ID.
          example: XMPL1234
        data:
          $ref: '#/components/schemas/Purchase'
          description: The webhook `Purchase` data.
        subscription_id:
          type: string
          description: The webhook subscription ID used to route this event.
          example: 2d65bd5e-3fdf-4002-b166-bde7fb8863fa
    BillingEvent:
      properties:
        event_uuid:
          type: string
          description: The webhook unique ID.
          example: 7bf79328-a7ae-4222-aa54-091ff7f429a7
        event_type:
          $ref: '#/components/schemas/WebhookEventType'
          default: Transaction
          description: The webhook event type.
          example: Transaction
        event_name:
          $ref: '#/components/schemas/WebhookEventName'
          default: billing
          description: The webhook event name.
          example: billing
        company_account_id:
          type: string
          description: The company account ID.
          example: XMPL1234
        data:
          $ref: '#/components/schemas/Transaction'
          description: The webhook `Transaction` data.
        subscription_id:
          type: string
          description: The webhook subscription ID used to route this event.
          example: 2d65bd5e-3fdf-4002-b166-bde7fb8863fa
    ContactBankAccountVerificationStatus:
      type: string
      enum:
      - UNABLE_TO_MATCH
      - FULL_MATCH
      - PARTIAL_MATCH
      - NO_MATCH
      - UNABLE_TO_VERIFY
    VatRate:
      properties:
        id:
          type: string
          description: The `VATRate` ID.
          example: 7bf79328-a7ae-4222-aa54-091ff7f429a7
        code:
          type: string
          description: The code of the `VATRate`.
          example: code-vat-11
        name:
          type: string
          description: The name of the `VATRate`
          example: Tax 11
        description:
          type: string
          description: A custom description of the `VATRate`.
          example: Number 11 of Tax code
        percentage:
          type: number
          format: double
          description: The percentage value of the `VATRate`
          example: 15
        enabled:
          type: boolean
          description: The `VATRate` is visible in the transaction detail.
          example: true
        integration:
          type: string
          description: The `VATRate`'s corresponding integration.
          example: something
        creation_time:
          type: string
          description: 'The date and time when the `VATRate` was created (sortable: yes).'
          example: '2017-06-01T12:48:40Z'
        last_update_time:
          type: string
          description: 'The date and time when the `VATRate` was last updated (sortable: yes).'
          example: '2017-06-01T12:48:40Z'
    UpdateGroupEvent:
      properties:
        event_uuid:
          type: string
          description: The webhook unique ID.
          example: 7bf79328-a7ae-4222-aa54-091ff7f429a7
        event_type:
          $ref: '#/components/schemas/WebhookEventType'
          default: Team
          description: The webhook event type.
          example: Team
        event_name:
          $ref: '#/components/schemas/WebhookEventName'
          default: update_group
          description: The webhook event name.
          example: update_group
        company_account_id:
          type: string
          description: The company account ID.
          example: XMPL1234
        data:
          $ref: '#/components/schemas/Group'
          description: The webhook `Group` data.
        subscription_id:
          type: string
          description: The webhook subscription ID used to route this event.
          example: 2d65bd5e-3fdf-4002-b166-bde7fb8863fa
    DeleteGroupEvent:
      properties:
        event_uuid:
          type: string
          description: The webhook unique ID.
          example: 7bf79328-a7ae-4222-aa54-091ff7f429a7
        event_type:
          $ref: '#/components/schemas/WebhookEventType'
          default: Team
          description: The webhook event type.
          example: Team
        event_name:
          $ref: '#/components/schemas/WebhookEventName'
          default: delete_group
          description: The webhook event name.
          example: delete_group
        company_account_id:
          type: string
          description: The company account ID.
          example: XMPL1234
        data:
          $ref: '#/components/schemas/Group'
          description: The webhook `Group` data.
        subscription_id:
          type: string
          description: The webhook subscription ID used to route this event.
          example: 2d65bd5e-3fdf-4002-b166-bde7fb8863fa
    CardPaymentMethod:
      type: string
      enum:
      - SUBSCRIPTION
      - ONLINE_ADS
      - PURCHASE
    UploadCompletedEvent:
      properties:
        event_uuid:
          type: string
          description: The webhook unique ID.
          example: 7bf79328-a7ae-4222-aa54-091ff7f429a7
        event_type:
          $ref: '#/components/schemas/WebhookEventType'
          default: TransactionAttachment
          description: The webhook event type.
          example: TransactionAttachment
        event_name:
          $ref: '#/components/schemas/WebhookEventName'
          default: upload_completed
          description: The webhook event name.
          example: upload_completed
        company_account_id:
          type: string
          description: The company account ID.
          example: XMPL1234
        data:
          $ref: '#/components/schemas/TransactionAttachment'
          description: The webhook `TransactionAttachment` data.
        subscription_id:
          type: string
          description: The webhook subscription ID used to route this event.
          example: 2d65bd5e-3fdf-4002-b166-bde7fb8863fa
    TransactionAmount:
      properties:
        amount:
          type: number
          description: The amount of the `Transaction` line.
          example: 10.25
        currency:
          $ref: '#/components/schemas/ISO4217Currency'
          description: The currency [ISO 4217](https://www.six-group.com/en/products-services/financial-information/data-standards.html#scrollTo=maintenance-agency) code of the amount.
          example: EUR
    Group:
      properties:
        id:
          type: string
          description: 'The `Group` ID (sortable: yes).'
          example: 1bf79328-a7ae-4222-aa54-091ff7f429a7
        name:
          type: string
          description: 'The name of the `Group` (sortable: yes).'
          example: HR
        custom_reference_id:
          type: string
          description: The `Group` reference in an external system.
          example: hr-division-0001
        type:
          $ref: '#/components/schemas/GroupType'
          description: 'The `Group` type (sortable: no).'
          example: DIVISION
        note:
          type: string
          description: 'Any notes about the `Group` (sortable: no).'
          example: division
        members:
          type: array
          description: 'A list of `User` IDs belonging to the `Group` (sortable: no).'
          example:
          - 5bf79328-a7ae-4222-aa54-091ff7f429a7
          items:
            type: string
        wallets:
          type: array
          description: 'A list of `Wallet` IDs related to the `Group` (sortable: no).'
          example:
          - 4bf79328-a7ae-4222-aa54-091ff7f429a7
          items:
            type: string
        cards:
          type: array
          description: 'A list of `Card` IDs related to the `Group` (sortable: no).'
          example:
          - 3bf79328-a7ae-4222-aa54-091ff7f429a7
          items:
            type: string
        creation_time:
          type: string
          description: 'The date and time when the `Group` was created (sortable: yes).'
          example: '2017-06-01T12:48:40Z'
        last_update:
          type: string
          description: 'The date and time when the `Group` was last updated (sortable: yes).'
          example: '2017-06-30T12:48:40Z'
    MerchantCategory:
      type: string
      enum:
      - Advertising
      - Entertainment
      - Utilities
      - Food_Cocktail_Bar
      - Food_Restaurant
      - Food_Store
      - Food_Wine
      - Services_Business
      - Services_Cleaning
      - Services_Contracted
      - Services_Delivery
      - Services_Educational
      - Services_Financial
      - Services_Gambling
      - Services_Government
      - Services_Health
      - Services_Insurance
      - Services_Legal
      - Services_Museum
      - Services_Organisation
      - Services_Personal
      - Services_Repair
      - Services_Social
      - Services_Stationery
      - Services_Telecommunication
      - Services_Veterinary
      - Services_Warehouse
      - Services_Wholesale
      - Shopping_Accessories
      - Shopping_Airline
      - Shopping_Art
      - Shopping_Automotive
      - Shopping_Beauty
      - Shopping_Books
      - Shopping_Clothes
      - Shopping_Digital_Goods
      - Shopping_Direct_Marketing
      - Shopping_Furnitures
      - Shopping_Sport
      - Shopping_Store
      - Shopping_Technology
      - Transport_Airports
      - Transport_Charging_Station
      - Transport_Parking
      - Transport_Public_Transportation
      - Transport_Road
      - Transport_Service_Station
      - Transport_Ships
      - Transport_Taxi
      - Transport_Toll_Roads
      - Transport_Trains
      - Travel_Airlines
      - Travel_Agency
      - Travel_Car_Rental
      - Travel_Hotels
      - Travel_Time_Shares
    RemoveResourcesMemberEvent:
      properties:
        event_uuid:
          type: string
          description: The webhook unique ID.
          example: 7bf79328-a7ae-4222-aa54-091ff7f429a7
        event_type:
          $ref: '#/components/schemas/WebhookEventType'
          default: Team
          description: The webhook event type.
          example: Team
        event_name:
          $ref: '#/components/schemas/WebhookEventName'
          default: remove_resources_member
          description: The webhook event name.
          example: remove_resources_member
        company_account_id:
          type: string
          description: The company account ID.
          example: XMPL1234
        data:
          $ref: '#/components/schemas/Group'
          description: The webhook `Group` data.
        subscription_id:
          type: string
          description: The webhook subscription ID used to route this event.
          example: 2d65bd5e-3fdf-4002-b166-bde7fb8863fa
    JouleFeedEvent:
      properties:
        event_uuid:
          type: string
          description: The webhook unique ID.
          example: 7bf79328-a7ae-4222-aa54-091ff7f429a7
        event_type:
          $ref: '#/components/schemas/WebhookEventType'
          default: Transaction
          description: The webhook event type.
          example: Transaction
        event_name:
          $ref: '#/components/schemas/WebhookEventName'
          default: joule_feed
          description: The webhook event name.
          example: joule_feed
        company_account_id:
          type: string
          description: The company account ID.
          example: XMPL1234
        data:
          $ref: '#/components/schemas/Transaction'
          description: The webhook `Transaction` data.
        subscription_id:
          type: string
          description: The webhook subscription ID used to route this event.
          example: 2d65bd5e-3fdf-4002-b166-bde7fb8863fa
    VatDeductibilityPercentage:
      type: string
      enum:
      - NONE
      - '40'
      - '80'
      - '100'
    AccountIdentificationType:
      type: string
      enum:
      - SORT_CODE
      - ACCOUNT_NUMBER
      - IBAN
    ISO4217Currency:
      type: string
      enum:
      - AED
      - AFN
      - ALL
      - AMD
      - ANG
      - AOA
      - ARS
      - AUD
      - AWG
      - AZN
      - BAM
      - BBD
      - BDT
      - BGN
      - BHD
      - BIF
      - BMD
      - BND
      - BOB
      - BOV
      - BRL
      - BSD
      - BTN
      - BWP
      - BYN
      - BZD
      - CAD
      - CDF
      - CHE
      - CHF
      - CHW
      - CLF
      - CLP
      - CNY
      - COP
      - COU
      - CRC
      - CUC
      - CUP
      - CVE
      - CZK
      - DJF
      - DKK
      - DOP
      - DZD
      - EGP
      - ERN
      - ETB
      - EUR
      - FJD
      - FKP
      - GBP
      - GEL
      - GHS
      - GIP
      - GMD
      - GNF
      - GTQ
      - GYD
      - HKD
      - HNL
      - HRK
      - HTG
      - HUF
      - IDR
      - ILS
      - INR
      - IQD
      - IRR
      - ISK
      - JMD
      - JOD
      - JPY
      - KES
      - KGS
      - KHR
      - KMF
      - KPW
      - KRW
      - KWD
      - KYD
      - KZT
      - LAK
      - LBP
      - LKR
      - LRD
      - LSL
      - LYD
      - MAD
      - MDL
      - MGA
      - MKD
      - MMK
      - MNT
      - MOP
      - MRO
      - MRU
      - MUR
      - MVR
      - MWK
      - MXN
      - MXV
      - MYR
      - MZN
      - NAD
      - NGN
      - NIO
      - NOK
      - NPR
      - NZD
      - OMR
      - PAB
      - PEN
      - PGK
      - PHP
      - PKR
      - PLN
      - PYG
      - QAR
      - RON
      - RSD
      - RUB
      - RWF
      - SAR
      - SBD
      - SCR
      - SDG
      - SEK
      - SGD
      - SHP
      - SLE
      - SLL
      - SOS
      - SRD
      - SSP
      - STD
      - STN
      - SVC
      - SYP
      - SZL
      - THB
      - TJS
      - TMT
      - TND
      - TOP
      - TRY
      - TTD
      - TWD
      - TZS
      - UAH
      - UGX
      - USD
      - USN
      - UYI
      - UYU
      - UYW
      - UZS
      - VED
      - VEF
      - VES
      - VND
      - VUV
      - WST
      - XAF
      - XAG
      - XAU
      - XBA
      - XBB
      - XBC
      - XBD
      - XCD
      - XDR
      - XOF
      - XPD
      - XPF
      - XPT
      - XSU
      - XTS
      - XUA
      - XXX
      - YER
      - ZAR
      - ZMW
      - ZWL
    MoveResourcesMemberEvent:
      properties:
        event_uuid:
          type: string
          description: The webhook unique ID.
          example: 7bf79328-a7ae-4222-aa54-091ff7f429a7
        event_type:
          $ref: '#/components/schemas/WebhookEventType'
          default: Team
          description: The webhook event type.
          example: Team
        event_name:
          $ref: '#/components/schemas/WebhookEventName'
          default: move_resources_member
          description: The webhook event name.
          example: move_resources_member
        company_account_id:
          type: string
          description: The company account ID.
          example: XMPL1234
        data:
          $ref: '#/components/schemas/Group'
          description: The webhook `Group` data.
        subscription_id:
          type: string
          description: The webhook subscription ID used to route this event.
          example: 2d65bd5e-3fdf-4002-b166-bde7fb8863fa
    TransactionSplitInfoTag:
      properties:
        id:
          type: string
          description: The `Tag` ID.
          example: 2d65bd5e-3fdf-4002-b166-bde7fb8863fa
        dictionary_id:
          type: string
          description: The `List` ID.
          example: 7bf79328-a7ae-4222-aa54-091ff7f429a7
        dictionary:
          type: string
          description: The name of the `List` where the `Tag` is listed.
          example: ExampleTagDictionary
        tag:
          type: string
          description: The name of the `Tag`.
          example: tx-label
        code:
          type: string
          description: The code of the `Tag`.
          example: CODE tag
        visible:
          type: boolean
          description: It determines whether the `Tag` is visible in the `Transaction` detail.
          example: true
        description:
          type: string
          description: The description of the `Tag`.
          example: Label to mark transactions
    PurchaseRedeemCardEvent:
      properties:
        event_uuid:
          type: string
          description: The webhook unique ID.
          example: 7bf79328-a7ae-4222-aa54-091ff7f429a7
        event_type:
          $ref: '#/components/schemas/WebhookEventType'
          default: Purchase
          description: The webhook event type.
          example: Purchase
        event_name:
          $ref: '#/components/schemas/WebhookEventName'
          default: purchase_redeem_card
          description: The webhook event name.
          example: purchase_redeem_card
        company_account_id:
          type: string
          description: The company account ID.
          example: XMPL1234
        data:
          $ref: '#/components/schemas/Purchase'
          description: The webhook `Purchase` data.
        subscription_id:
          type: string
          description: The webhook subscription ID used to route this event.
          example: 2d65bd5e-3fdf-4002-b166-bde7fb8863fa
    ExpenseReview:
      properties:
        transaction_id:
          type: string
          description: The ID of the `Transaction`.
        expense_status:
          type: string
          description: The status of the expense.
        expense_status_category:
          type: string
          description: The status category of the expense.
        expense_type:
          type: string
          description: The type of the expense.
        expense_date:
          type: string
          description: The date of the expense.
        expense_reviewer:
          type: string
          description: The review of the expense.
        transaction_ids:
          type: array
          description: The `Transaction` IDs of the `ExpenseReport`.
          example:
          - 7bf79328-a7ae-4222-aa54-091ff7f429a7
          - 2d65bd5e-3fdf-4002-b166-bde7fb8863fa
          items:
            type: string
        expense_report_protocol_ids:
          type: array
          description: The `ExpenseReport` protocol IDs of the `ExpenseReport`.
          example:
          - 7bf79328-a7ae-4222-aa54-091ff7f429a7
          - 2d65bd5e-3fdf-4002-b166-bde7fb8863fa
          items:
            type: string
        expense_report_id:
          type: string
          description: The ID of the `ExpenseReport`.
    CompletedTransactionsImportEvent:
      properties:
        event_uuid:
          type: string
          description: The webhook unique ID.
          example: 7bf79328-a7ae-4222-aa54-091ff7f429a7
        event_type:
          $ref: '#/components/schemas/WebhookEventType'
          default: ExpenseReviewConfiguration
          description: The webhook event type.
          example: ExpenseReviewConfiguration
        event_name:
          $ref: '#/components/schemas/WebhookEventName'
          default: completed_transactions_import
          description: The webhook event name.
          example: completed_transactions_import
        company_account_id:
          type: string
          description: The company account ID.
          example: XMPL1234
        data:
          $ref: '#/components/schemas/ExpenseReviewConfiguration'
          description: The webhook `ExpenseReview` data.
        subscription_id:
          type: string
          description: The webhook subscription ID used to route this event.
          example: 2d65bd5e-3fdf-4002-b166-bde7fb8863fa
    TransactionTag:
      properties:
        id:
          type: string
          description: The `Tag` ID.
          example: 2d65bd5e-3fdf-4002-b166-bde7fb8863fa
        dictionary_id:
          type: string
          description: The `List` ID.
          example: 7bf79328-a7ae-4222-aa54-091ff7f429a7
        dictionary:
          type: string
          description: The name of the `List` where the `Tag` is listed.
          example: ExampleTagDictionary
        tag:
          type: string
          description: The name of the `Tag`.
          example: tx-label
        code:
          type: string
          description: The code of the `Tag`.
          example: CODE tag
        visible:
          type: boolean
          description: It determines whether the `Tag` is visible in the `Transaction` detail.
          example: true
        description:
          type: string
          description: The description of the `Tag`.
          example: Label to mark transactions
    StoreOrderCompletedEvent:
      properties:
        event_uuid:
          type: string
          description: The webhook unique ID.
          example: 7bf79328-a7ae-4222-aa54-091ff7f429a7
        event_type:
          $ref: '#/components/schemas/WebhookEventType'
          default: Order
          description: The webhook event type.
          example: Order
        event_name:
          $ref: '#/components/schemas/WebhookEventName'
          default: store_order_completed
          description: The webhook event name.
          example: store_order_completed
        company_account_id:
          type: string
          description: The company account ID.
          example: XMPL1234
        data:
          $ref: '#/components/schemas/Order'
          description: The webhook `Order` data.
        subscription_id:
          type: string
          description: The webhook subscription ID used to route this event.
          example: 2d65bd5e-3fdf-4002-b166-bde7fb8863fa
    TransactionDeletedEvent:
      properties:
        event_uuid:
          type: string
          description: The webhook unique ID.
          example: 7bf79328-a7ae-4222-aa54-091ff7f429a7
        event_type:
          $ref: '#/components/schemas/WebhookEventType'
          default: Transaction
          description: The webhook event type.
          example: Transaction
        event_name:
          $ref: '#/components/schemas/WebhookEventName'
          default: transaction_deleted
          description: The webhook event name.
          example: transaction_deleted
        company_account_id:
          type: string
          description: The company account ID.
          example: XMPL1234
        data:
          $ref: '#/components/schemas/Transaction'
          description: The webhook `Transaction` data. Only the `id` of the resource is returned.
        subscription_id:
          type: string
          description: The webhook subscription ID used to route this event.
          example: 2d65bd5e-3fdf-4002-b166-bde7fb8863fa
    TransactionAdjustmentEvent:
      properties:
        event_uuid:
          type: string
          description: The webhook unique ID.
          example: 7bf79328-a7ae-4222-aa54-091ff7f429a7
        event_type:
          $ref: '#/components/schemas/WebhookEventType'
          default: Transaction
          description: The webhook event type.
          example: Transaction
        event_name:
          $ref: '#/components/schemas/WebhookEventName'
          default: transaction_adjustment
          description: The webhook event name.
          example: transaction_adjustment
        company_account_id:
          type: string
          description: The company account ID.
          example: XMPL1234
        data:
          $ref: '#/components/schemas/Transaction'
          description: The webhook `Transaction` data.
        subscription_id:
          type: string
          description: The webhook subscription ID used to route this event.
          example: 2d65bd5e-3fdf-4002-b166-bde7fb8863fa
    MoveResourcesCardEvent:
      properties:
        event_uuid:
          type: string
          description: The webhook unique ID.
          example: 7bf79328-a7ae-4222-aa54-091ff7f429a7
        event_type:
          $ref: '#/components/schemas/WebhookEventType'
          default: Team
          description: The webhook event type.
          example: Team
        event_name:
          $ref: '#/components/schemas/WebhookEventName'
          default: move_resources_card
          description: The webhook event name.
          example: move_resources_card
        company_account_id:
          type: string
          description: The company account ID.
          example: XMPL1234
        data:
          $ref: '#/components/schemas/Group'
          description: The webhook `Group` data.
        subscription_id:
          type: string
          description: The webhook subscription ID used to route this event.
          example: 2d65bd5e-3fdf-4002-b166-bde7fb8863fa
    TransactionSpendingPolicyMetadata:
      properties:
        approved_amount:
          $ref: '#/components/schemas/TransactionAmount'
          description: The `Transaction` amount approved in policy.
        rejected_amount:
          $ref: '#/components/schemas/TransactionAmount'
          description: The `Transaction` amount rejected in policy.
    WiretransferEvent:
      properties:
        event_uuid:
          type: string
          description: The webhook unique ID.
          example: 7bf79328-a7ae-4222-aa54-091ff7f429a7
        event_type:
          $ref: '#/components/schemas/WebhookEventType'
          default: Transaction
          description: The webhook event type.
          example: Transaction
        event_name:
          $ref: '#/components/schemas/WebhookEventName'
          default: wiretransfer
          description: The webhook event name.
          example: wiretransfer
        company_account_id:
          type: string
          description: The company account ID.
          example: XMPL1234
        data:
          $ref: '#/components/schemas/Transaction'
          description: The webhook `Transaction` data.
        subscription_id:
          type: string
          description: The webhook subscription ID used to route this event.
          example: 2d65bd5e-3fdf-4002-b166-bde7fb8863fa
    TransactionCategory:
      type: string
      enum:
      - Billing
      - Chargeback
      - Conversion
      - Fee
      - FeeReversal
      - InboundFasterPayment
      - InboundFasterPaymentReversal
      - Load
      - LoadReversal
      - MileageReimbursement
      - NotRecognized
      - P2P
      - Payment
      - Rebalance
      - RecurringBilling
      - Refund
      - SoldoActivity
      - SoldoCreditOperation
      - SoldoDebitOperation
      - Transfer
      - Wiretransfer
      - Withdrawal
      - InterAccountTransferWithdrawalRecurringBilling
      - InterAccountTransferWithdrawal
      - InterAccountTransferDeposit
      - InterAccountTransferDepositRecurringBilling
    TransactionDetails:
      properties:
        de022:
          type: string
          description: Mastercard `DE022` field.
        de061:
          type: string
          description: Mastercard `DE061` field.
        tx_country:
          $ref: '#/components/schemas/ISO3166Country'
          description: The [ISO 3166-1 alpha-3](https://www.iso.org/obp/ui/#search/code/) code of the country where the `Transaction` has been authorised.
          example: GBR
        denied_info_type:
          type: string
          description: The type of the denied reason of the transaction (only if the `Transaction` is `Declined`).
        denied_info_description:
          type: string
          description: The description of the denied reason (only if the `Transaction` is `Declined`).
        is_card_present:
          type: boolean
          description: It determines whether the card was there at the moment of the `Transaction`.
          example: false
        is_atm_transaction:
          type: boolean
          description: It determines whether the transaction is an ATM withdrawal.
          example: false
    TransactionAttachmentType:
      type: string
      enum:
      - RECEIPT
      - INVOICE
      - MAIL
      - OTHER
      - PURCHASE_REQUEST
      - POP_AUTH
      - POP_SETTLEMENT
    SubscriptionCreatedEvent:
      properties:
        event_uuid:
          type: string
          description: The webhook unique ID.
          example: 7bf79328-a7ae-4222-aa54-091ff7f429a7
        event_type:
          $ref: '#/components/schemas/WebhookEventType'
          default: Subscription
          description: The webhook event type.
          example: Subscription
        event_name:
          $ref: '#/components/schemas/WebhookEventName'
          default: subscription_created
          description: The webhook event name.
          example: subscription_created
        company_account_id:
          type: string
          description: The company account ID.
          example: XMPL1234
        data:
          $ref: '#/components/schemas/Subscription'
          description: The webhook `Subscription` data.
        subscription_id:
          type: string
          description: The webhook subscription ID used to route this event.
          example: 2d65bd5e-3fdf-4002-b166-bde7fb8863fa
    PrimaryUserType:
      type: string
      description: The type of resource assigned to the `Wallet`.
      enum:
      - main
      - company
      - employee
      - dedicated
      example: company
    ScheduledTransferEvent:
      properties:
        event_uuid:
          type: string
          description: The webhook unique ID.
          example: 7bf79328-a7ae-4222-aa54-091ff7f429a7
        event_type:
          $ref: '#/components/schemas/WebhookEventType'
          default: Transaction
          description: The webhook event type.
          example: Transaction
        event_name:
          $ref: '#/components/schemas/WebhookEventName'
          default: scheduled_transfer
          description: The webhook event name.
          example: scheduled_transfer
        company_account_id:
          type: string
          description: The company account ID.
          example: XMPL1234
        data:
          $ref: '#/components/schemas/Transaction'
          description: The webhook `Transaction` data.
        subscription_id:
          type: string
          description: The webhook subscription ID used to route this event.
          example: 2d65bd5e-3fdf-4002-b166-bde7fb8863fa
    SubscriptionAssigneeRemovedEvent:
      properties:
        event_uuid:
          type: string
          description: The webhook unique ID.
          example: 7bf79328-a7ae-4222-aa54-091ff7f429a7
        event_type:
          $ref: '#/components/schemas/WebhookEventType'
          default: Subscription
          description: The webhook event type.
          example: Subscription
        event_name:
          $ref: '#/components/schemas/WebhookEventName'
          default: subscription_assignee_removed
          description: The webhook event name.
          example: subscription_assignee_removed
        company_account_id:
          type: string
          description: The company account ID.
          example: XMPL1234
        data:
          $ref: '#/components/schemas/Subscription'
          description: The webhook `Subscription` data.
        subscription_id:
          type: string
          description: The webhook subscription ID used to route this event.
          example: 2d65bd5e-3fdf-4002-b166-bde7fb8863fa
    RemoveResourcesCardEvent:
      properties:
        event_uuid:
          type: string
          description: The webhook unique ID.
          example: 7bf79328-a7ae-4222-aa54-091ff7f429a7
        event_type:
          $ref: '#/components/schemas/WebhookEventType'
          default: Team
          description: The webhook event type.
          example: Team
        event_name:
          $ref: '#/components/schemas/WebhookEventName'
          default: remove_resources_card
          description: The webhook event name.
          example: remove_resources_card
        company_account_id:
          type: string
          description: The company account ID.
          example: XMPL1234
        data:
          $ref: '#/components/schemas/Group'
          description: The webhook `Group` data.
        subscription_id:
          type: string
          description: The webhook subscription ID used to route this event.
          example: 2d65bd5e-3fdf-4002-b166-bde7fb8863fa
    CardLostEvent:
      properties:
        event_uuid:
          type: string
          description: The webhook unique ID.
          example: 7bf79328-a7ae-4222-aa54-091ff7f429a7
        event_type:
          $ref: '#/components/schemas/WebhookEventType'
          default: Card
          description: The webhook event type.
          example: Card
        event_name:
          $ref: '#/components/schemas/WebhookEventName'
          default: card_lost
          description: The webhook event name.
          example: card_lost
        company_account_id:
          type: string
          description: The company account ID.
          example: XMPL1234
        data:
          $ref: '#/components/schemas/Card'
          description: The webhook `Card` data.
        subscription_id:
          type: string
          description: The webhook subscription ID used to route this event.
          example: 2d65bd5e-3fdf-4002-b166-bde7fb8863fa
    TransactionTimelineStatus:
      type: string
      enum:
      - Unspecified
      - Authorized
      - Reversed
      - Refunded
      - Settled
      - Withdraw
      - Deposit
      - Chargeback
    OnlineAdsPlatform:
      type: string
      enum:
      - GOOGLE
      - TWITTER
      - TABOOLA
      - PINTEREST
      - MICROSOFT
      - FACEBOOK
      - AMAZON
      - APPLE
      - TIKTOK
      - LINKEDIN
      - INSTAGRAM
      - OTHER
    ExpenseReviewConfiguration:
      properties:
        start_date:
          type: string
          description: The starting date from which the expenses can be reviewed.
          example: '2017-06-01T12:48:40Z'
        transaction_categories:
          type: array
          description: It determines the filter by category of the `Transaction`.
          items:
            $ref: '#/components/schemas/ExpenseTransactionCategory'
          uniqueItems: true
        activity_groups:
          type: array
          description: It determines the filter by types of `Cards` whose `Transactions` are considered as expenses to be reviewed.
          items:
            $ref: '#/components/schemas/ExpenseConfigurationActivityGroup'
          uniqueItems: true
        policy_url:
          type: string
          description: The url of the company spending policy
          example: https://www.policy.pdf
        start_date_type:
          $ref: '#/components/schemas/ExpenseDateType'
          description: It determines the type of date filter to be used.
          example: SETTLEMENT
        enabled:
          type: boolean
          description: Indicates `ExpenseReview` configuration is enabled.
        locked:
          type: boolean
          description: Indicates `ExpenseReview` configuration is locked.
          example: false
        update_timestamp:
          type: string
          description: The date and time when the configuration was last updated.
          example: '2017-06-01T12:48:40Z'
    BalancedTransferEvent:
      properties:
        event_uuid:
          type: string
          description: The webhook unique ID.
          example: 7bf79328-a7ae-4222-aa54-091ff7f429a7
        event_type:
          $ref: '#/components/schemas/WebhookEventType'
          default: Transaction
          description: The webhook event type.
          example: Transaction
        event_name:
          $ref: '#/components/schemas/WebhookEventName'
          default: balanced_transfer
          description: The webhook event name.
          example: balanced_transfer
        company_account_id:
          type: string
          description: The company account ID.
          example: XMPL1234
        data:
          $ref: '#/components/schemas/Transaction'
          description: The webhook `Transaction` data.
        subscription_id:
          type: string
          description: The webhook subscription ID used to route this event.
          example: 2d65bd5e-3fdf-4002-b166-bde7fb8863fa
    EnabledExpenseConfigurationEvent:
      properties:
        event_uuid:
          type: string
          description: The webhook unique ID.
          example: 7bf79328-a7ae-4222-aa54-091ff7f429a7
        event_type:
          $ref: '#/components/schemas/WebhookEventType'
          default: ExpenseReviewConfiguration
          description: The webhook event type.
          example: ExpenseReviewConfiguration
        event_name:
          $ref: '#/components/schemas/WebhookEventName'
          default: enabled_expense_configuration
          description: The webhook event name.
          example: enabled_expense_configuration
        company_account_id:
          type: string
          description: The company account ID.
          example: XMPL1234
        data:
          $ref: '#/components/schemas/ExpenseReviewConfiguration'
          description: The webhook `ExpenseReview` data.
        subscription_id:
          type: string
          description: The webhook subscription ID used to route this event.
          example: 2d65bd5e-3fdf-4002-b166-bde7fb8863fa
    SubscriptionPaymentFrequency:
      type: string
      enum:
      - OTHER
      - YEARLY
      - WEEKLY
      - QUARTERLY
      - MONTHLY
    CreateGroupEvent:
      properties:
        event_uuid:
          type: string
          description: The webhook unique ID.
          example: 7bf79328-a7ae-4222-aa54-091ff7f429a7
        event_type:
          $ref: '#/components/schemas/WebhookEventType'
          default: Team
          description: The webhook event type.
          example: Team
        event_name:
          $ref: '#/components/schemas/WebhookEventName'
          default: create_group
          description: The webhook event name.
          example: create_group
        company_account_id:
          type: string
          description: The company account ID.
          example: XMPL1234
        data:
          $ref: '#/components/schemas/Group'
          description: The webhook `Group` data.
        subscription_id:
          type: string
          description: The webhook subscription ID used to route this event.
          example: 2d65bd5e-3fdf-4002-b166-bde7fb8863fa
    CardCreationEvent:
      properties:
        event_uuid:
          type: string
          description: The webhook unique ID.
          example: 7bf79328-a7ae-4222-aa54-091ff7f429a7
        event_type:
          $ref: '#/components/schemas/WebhookEventType'
          default: Card
          description: The webhook event type.
          example: Card
        event_name:
          $ref: '#/components/schemas/WebhookEventName'
          default: card_creation
          description: The webhook event name.
          example: card_creation
        company_account_id:
          type: string
          description: The company account ID.
          example: XMPL1234
        data:
          $ref: '#/components/schemas/Card'
          description: The webhook `Card` data.
        subscription_id:
          type: string
          description: The webhook subscription ID used to route this event.
          example: 2d65bd5e-3fdf-4002-b166-bde7fb8863fa
    NewUserEvent:
      properties:
        event_uuid:
          type: string
          description: The webhook unique ID.
          example: 7bf79328-a7ae-4222-aa54-091ff7f429a7
        event_type:
          $ref: '#/components/schemas/WebhookEventType'
          default: Employee
          description: The webhook event type.
          example: Employee
        event_name:
          $ref: '#/components/schemas/WebhookEventName'
          default: new_user
          description: The webhook event name.
          example: new_user
        company_account_id:
          type: string
          description: The company account ID.
          example: XMPL1234
        data:
          $ref: '#/components/schemas/User'
          description: The webhook `User` data.
        subscription_id:
          type: string
          description: The webhook subscription ID used to route this event.
          example: 2d65bd5e-3fdf-4002-b166-bde7fb8863fa
    CardStolenEvent:
      properties:
        event_uuid:
          type: string
          description: The webhook unique ID.
          example: 7bf79328-a7ae-4222-aa54-091ff7f429a7
        event_type:
          $ref: '#/components/schemas/WebhookEventType'
          default: Card
          description: The webhook event type.
          example: Card
        event_name:
          $ref: '#/components/schemas/WebhookEventName'
          default: card_stolen
          description: The webhook event name.
          example: card_stolen
        company_account_id:
          type: string
          description: The company account ID.
          example: XMPL1234
        data:
          $ref: '#/components/schemas/Card'
          description: The webhook `Card` data.
        subscription_id:
          type: string
          description: The webhook subscription ID used to route this event.
          example: 2d65bd5e-3fdf-4002-b166-bde7fb8863fa
  securitySchemes:
    standardAuth:
      type: oauth2
      description: This API uses OAuth 2 with the "Client Credentials" grant flow.
      flows:
        clientCredentials:
          tokenUrl: https://api.soldo.com/oauth/authorize
          refreshUrl: https://api.soldo.com/oauth/refresh
          scopes:
            address_read: Can read address details.
            address_write: Can update address details.
            card_read: Can read card details.
            card_write: Can change card details.
            company_read: Can read company details.
            company_write: Can change company details.
            contact_read: Can read contact details.
            contact_write: Can change contact details.
            employee_read: Can read employee details.
            employee_write: Can change employee details.
            expense_category_read: Can read expense category details.
            expense_category_write: Can change expense category details.
            expense_report_read: Can read expense report details.
            expense_report_write: Can change expense report details.
            expense_review_read: Can read expense review status.
            expense_review_write: Can change expense review status.
            group_read: Can read group details.
            group_write: Can change groups details.
            online_ads_read: Can read online ads details.
            online_ads_write: Can change online ads details.
            payment_read: Can read payment details.
            payment_write: Can change payment details.
            purchase_read: Can read purchase details.
            purchase_write: Can change purchase details.
            refueling_read: Can read refueling details.
            refueling_write: Can change refueling details.
            resource_set_read: Can read resource set details.
            resource_set_write: Can change resource set details.
            role_read: Can read role details.
            statement_read: Can read statement details.
            subscription_read: Can read subscription details.
            subscription_write: Can change subscription details.
            tag_read: Can read tags.
            tag_write: can change tags.
            tax_rate_read: Can read vat rate details.
            tax_rate_write: Can change vat rate details.
            transaction_read: Can read transaction details.
            transaction_write: Can change transaction details.
            vehicle_read: Can read vehicle details.
            vehicle_write: Can change vehicle details.
            wallet_read: Can read wallet details.
            wallet_write: Can change wallet details.
            webhook_subscription_read: Can read webhook subscription details.
            webhook_subscription_write: Can change webhook subscription details.
x-readme:
  hidden: false