ADadfin
Activities

Read one activity

Changed on

Returns a single activity by its own id.

get/activities/{activityId}

Request

  • Base URL
    https://api.adfin.com/api
  • URL
    https://api.adfin.com/api/activities/{activityId}
  • Auth
    • OAuth 2
      Client credentials
      Token URL: https://api.staging.adfin.com/api/oauth2/token
    • or OAuth 2
      Client credentials
      Token URL: https://api.adfin.com/api/oauth2/token

Path parameters

activityIdstring uuid required

Response

The requested activity.

idstring uuid required

The activity itself, for fetching it on its own.

creationTimestring date-time required

When it happened.

entityType'INVOICE' | 'PAYMENT_REQUEST' | 'CUSTOMER' | 'SCHEDULE' required

The kind of record it happened to.

entityIdstring uuid required

The record it happened to.

type'INVOICE_CREATED' | 'TAX_INVOICE_ISSUED' | 'INVOICE_EDITED' | 'INVOICE_OUTSTANDING' | 'INVOICE_OVERDUE' | 'INVOICE_SCHEDULED' | 'INVOICE_SUBMITTED' | 'INVOICE_PAID' | 'INVOICE_SETTLED' | 'INVOICE_VOIDED' | 'INVOICE_DELETED' | 'INVOICE_MANUALLY_MARKED_AS_PAID' | 'INVOICE_MANUALLY_UNMARKED_AS_PAID' | 'INVOICE_PAYMENT_LINK_SEEN' | 'INVOICE_CREDIT_NOTE_ADDED' | 'INVOICE_CREDIT_NOTE_CANCELLED' | 'INVOICE_FEES_APPLIED' | 'INVOICE_FEES_WAIVED' | 'INVOICE_PUSHED_TO_CONNECTOR' | 'INVOICE_CONNECTOR_PUSH_FAILED' | 'PAYMENT_REQUEST_OUTSTANDING' | 'PAYMENT_REQUEST_OVERDUE' | 'PAYMENT_REQUEST_SCHEDULED' | 'PAYMENT_REQUEST_SUBMITTED' | 'PAYMENT_REQUEST_PAID' | 'PAYMENT_REQUEST_SETTLED' | 'PAYMENT_REQUEST_VOIDED' | 'PAYMENT_REQUEST_DELETED' | 'PAYMENT_MADE' | 'PAYMENT_SUBMITTED' | 'PAYMENT_SETTLED' | 'PAYMENT_CANCELLED' | 'PAYMENT_FAILED' | 'PAYMENT_PUSHED_TO_CONNECTOR' | 'PAYMENT_CONNECTOR_PUSH_FAILED' | 'CUSTOMER_CREATED' | 'CUSTOMER_EDITED' | 'OWNER_CHANGED' | 'LAST_ACTION_CHANGED' | 'CUSTOMER_CHANGED' | 'CUSTOMER_MERGED' | 'CUSTOMER_ARCHIVED' | 'CUSTOMER_REACTIVATED' | 'CUSTOMER_AUTO_LINKED' | 'CUSTOMER_CASE_CREATED' | 'COLLECTION_AGENT_LINKED' | 'CUSTOMER_INVOICE_MIGRATION_COMPLETED' | 'CUSTOMER_PUSHED_TO_CONNECTOR' | 'CUSTOMER_CONNECTOR_PUSH_FAILED' | 'MANDATE_CREATED' | 'MANDATE_ACTIVATED' | 'MANDATE_PENDING_CANCELLATION' | 'MANDATE_CANCELLED' | 'MANDATE_MIGRATING' | 'MANDATE_DELETED' | 'MANDATE_REINSTATED' | 'CARD_DETAILS_REQUESTED' | 'CARD_ACTIVATED' | 'CARD_CANCELLED' | 'CARD_EXPIRED' | 'AI_PHONE_CALL_ENDED' | 'DEBT_RECOVERY_STATUS_CHANGED' | 'SCHEDULE_CREATED' | 'SCHEDULE_EDITED' | 'SCHEDULE_ACTIVATED' | 'SCHEDULE_FINISHED' | 'SCHEDULE_CANCELLED' | 'SCHEDULE_DELETED' | 'SCHEDULE_ITEM_CREATED' | 'COLLECTION_METHOD_CHANGED' | 'COLLECTION_PAUSED' | 'COLLECTION_RESUMED' | 'COLLECTION_CANCELLED' | 'COLLECTION_CANCELLATION_REQUESTED' | 'COLLECTION_COMPLETED' | 'COLLECTION_CONFIGURATION_CREATED' | 'COLLECTION_CONFIGURATION_UPDATED' | 'COLLECTION_CONFIGURATION_DELETED' | 'COLLECTION_CONFIGURATION_RESET' | 'DIRECT_DEBIT_COLLECTION_ATTEMPTED' | 'AUTO_COLLECT_SET_TO_DIRECT_DEBIT' | 'AUTO_COLLECT_SET_TO_CARD' | 'AUTO_COLLECT_SET_TO_DIRECT_DEBIT_WITH_CARD_BACKUP' | 'CREDIT_CONTROL_STATUS_CHANGED' | 'NOTIFICATION_PENDING' | 'NOTIFICATION_DEFERRED' | 'NOTIFICATION_SENT' | 'NOTIFICATION_FAILED' | 'NOTIFICATION_RETRIED' | 'NOTIFICATION_OPENED' | 'ACTIVITY_NOTE_ADDED' required

What happened.

Changes

  • 3bcc12f59ff0Revision changes
    • warning

      added the new DEBT_RECOVERY_STATUS_CHANGED enum value to the response property for the response status

  • fba3f53d7338Revision changes
    • warning

      added the new AI_PHONE_CALL_ENDED enum value to the response property for the response status