Show Credit Actions

Returns a paginated list of credit actions for a specific credit account, filtered by client and action type

Returns a paginated list of credit actions for a specific credit account, filtered by client and action type.

GEThttps://example.thoughtindustries.com/incoming/v2/clients/:id/creditAccount/:creditAccountId/creditActions

Example request

curl "https://example.thoughtindustries.com/incoming/v2/clients/:id/creditAccount/:creditAccountId/creditActions" \
  -H 'Authorization: Bearer YOUR_API_KEY'

Parameters

Name	Type	Required	Location	Description
`id`	`string`	Yes	path	The id identifier.
`creditAccountId`	`uuid`	Yes	path	The creditAccountId identifier.
`clientId`	`uuid`	Yes	query	The UUID of the client whose credit actions to retrieve.
`actionType`	`string`	Yes	query	The type of credit action to filter results by (e.g., `debit`, `credit`).
`cursor`	`string`	No	query	Opaque cursor for the next page of results. Omit to fetch the first page.

Example response

{
  "clientId": "00000000-0000-0000-0000-000000000000",
  "creditAccountId": "00000000-0000-0000-0000-000000000000",
  "creditActions": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "initiator": "string",
      "action": "string",
      "amount": 0,
      "targetType": "string",
      "target": "string",
      "creditAccountName": "string",
      "source": "string",
      "sourceType": "string",
      "timestamp": "2024-01-01T00:00:00.000Z"
    }
  ],
  "pageInfo": {
    "perPage": 0,
    "cursor": "string",
    "total": 0,
    "hasMore": true
  }
}

Response fields

Field	Type	Description
`clientId`	`uuid`	Identifier of the client.
`creditAccountId`	`uuid`	Identifier of the credit account.
`creditActions`	`object[]`	Array of credit action records for the current page.
`creditActions.id`	`uuid`	Identifier of the credit action.
`creditActions.initiator`	`string`	Who or what initiated the action.
`creditActions.action`	`string`	The type of credit action performed.
`creditActions.amount`	`number`	Credit amount involved in the action.
`creditActions.targetType`	`string`	Type of the target the action applied to.
`creditActions.target`	`string`	Identifier or name of the target.
`creditActions.creditAccountName`	`string`	Name of the credit account.
`creditActions.source`	`string`	Source of the action.
`creditActions.sourceType`	`string`	Type of the source.
`creditActions.timestamp`	`ISO 8601 timestamp`	Timestamp when the action occurred.
`pageInfo`	`object`	Cursor-based pagination metadata for the result set.
`pageInfo.perPage`	`integer`	Number of records returned per page.
`pageInfo.cursor`	`string`	Opaque cursor to pass on the next request. Present when `hasMore` is `true`.
`pageInfo.total`	`integer`	Total number of records matching the query.
`pageInfo.hasMore`	`boolean`	Whether additional pages of results are available.