Credit memos Timeline

The credit memos timeline keeps an audit trail of changes and activity for each credit memo.

Retrieve a list of credit memo timeline messages

Retrieve a list of credit memo timeline messages.

SecuritySecretApiKey or JWT
Request
path Parameters
id
required
string <= 50 characters ^[@~\-\.\w]+$

The resource identifier string.

query Parameters
limit
integer [ 0 .. 1000 ]

The collection items limit.

offset
integer >= 0

The collection items offset.

filter
string

The collection items filter requires a special format. Use "," for multiple allowed values. Use ";" for multiple fields. See the filter guide for more options and examples about this format.

sort
Array of strings

The collection items sort field and order (prefix with "-" for descending sort).

q
string

The partial search of the text fields.

Responses
200

A list of credit memo timeline messages was retrieved successfully.

Response Headers
Pagination-Total
integer

Total items count.

Pagination-Limit
integer

Items per page limit.

Pagination-Offset
integer

Pagination offset.

Response Schema: application/json
Array
id
string <= 50 characters

The resource ID. Defaults to UUID v4.

type
string

Timeline message type.

Enum: "credit-memo-created" "credit-memo-applied" "credit-memo-partially-applied" "credit-memo-voided"
triggeredBy
string

Shows who or what triggered the Timeline event.

Enum: "rebilly" "app" "direct-api"
message
string

The message that describes the message details.

object (TimelineExtraData)

Additional data.

Array of objects (TimelineAction) >= 0 items

Actions available to a Timeline message. Can be empty in case no actions are available for a message.

Array of objects (TimelineTable) >= 0 items
object

Timeline comment author data.

object
Array of objects
occurredTime
string <date-time>

Read-only timestamp, automatically assigned on back-end.

Array of objects (SelfLink) non-empty

The links related to resource.

Array (non-empty)
rel
required
string

The link type.

Value: "self"
href
required
string

The link URL.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

get/credit-memos/{id}/timeline
Request samples
curl -i -X GET \
  'https://api-sandbox.rebilly.com/organizations/unknown/credit-memos/{id}/timeline?limit=1000&offset=0&filter=string&sort=string&q=string' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'
Response samples
application/json
[
  • {
    }
]

Create a credit memo timeline message.

Create a credit memo timeline message.

SecuritySecretApiKey or JWT
Request
path Parameters
id
required
string <= 50 characters ^[@~\-\.\w]+$

The resource identifier string.

Request Body schema: application/json

Credit memo timeline resource.

message
string

The message that describes the message details.

Responses
201

Credit memo timeline message was created.

Response Schema: application/json
id
string <= 50 characters

The resource ID. Defaults to UUID v4.

type
string

Timeline message type.

Enum: "credit-memo-created" "credit-memo-applied" "credit-memo-partially-applied" "credit-memo-voided"
triggeredBy
string

Shows who or what triggered the Timeline event.

Enum: "rebilly" "app" "direct-api"
message
string

The message that describes the message details.

object (TimelineExtraData)

Additional data.

Array of objects (TimelineAction) >= 0 items

Actions available to a Timeline message. Can be empty in case no actions are available for a message.

Array (>= 0 items)
action
string
redemptionId
string <= 50 characters Recursive

The resource ID. Defaults to UUID v4.

Array of objects (TimelineTable) >= 0 items
Array (>= 0 items)
type
string
title
string

Data table title.

footer
string

Data table footer.

Array of objects

Table data. Each array element represents a table row.

object

Timeline comment author data.

userFullName
string
userId
string
object
property name*
additional property
string
Array of objects
Array
resourceType
string
Enum: "kyc-document" "invoice" "subscription" "transaction" "email-message" "dispute" "coupon" "external"
resourceId
string (ResourceId) <= 50 characters Recursive

The resource ID. Defaults to UUID v4.

placeholder
string
externalUrl
string
occurredTime
string <date-time>

Read-only timestamp, automatically assigned on back-end.

Array of objects (SelfLink) non-empty

The links related to resource.

Array (non-empty)
rel
required
string

The link type.

Value: "self"
href
required
string

The link URL.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

422

Invalid data was sent.

post/credit-memos/{id}/timeline
Request samples
application/json
{
  • "message": "string"
}
Response samples
application/json
{
  • "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "type": "credit-memo-created",
  • "triggeredBy": "rebilly",
  • "message": "string",
  • "extraData": {
    },
  • "occurredTime": "2019-08-24T14:15:22Z",
  • "_links": [
    ]
}

Retrieve a credit memo timeline message

Retrieve a credit memo timeline message with specified identifier string.

SecuritySecretApiKey or JWT
Request
path Parameters
id
required
string <= 50 characters ^[@~\-\.\w]+$

The resource identifier string.

messageId
required
string

The credit memo timeline message ID.

Responses
200

Credit memo timeline message was retrieved successfully.

Response Schema: application/json
id
string <= 50 characters

The resource ID. Defaults to UUID v4.

type
string

Timeline message type.

Enum: "credit-memo-created" "credit-memo-applied" "credit-memo-partially-applied" "credit-memo-voided"
triggeredBy
string

Shows who or what triggered the Timeline event.

Enum: "rebilly" "app" "direct-api"
message
string

The message that describes the message details.

object (TimelineExtraData)

Additional data.

Array of objects (TimelineAction) >= 0 items

Actions available to a Timeline message. Can be empty in case no actions are available for a message.

Array (>= 0 items)
action
string
redemptionId
string <= 50 characters Recursive

The resource ID. Defaults to UUID v4.

Array of objects (TimelineTable) >= 0 items
Array (>= 0 items)
type
string
title
string

Data table title.

footer
string

Data table footer.

Array of objects

Table data. Each array element represents a table row.

object

Timeline comment author data.

userFullName
string
userId
string
object
property name*
additional property
string
Array of objects
Array
resourceType
string
Enum: "kyc-document" "invoice" "subscription" "transaction" "email-message" "dispute" "coupon" "external"
resourceId
string (ResourceId) <= 50 characters Recursive

The resource ID. Defaults to UUID v4.

placeholder
string
externalUrl
string
occurredTime
string <date-time>

Read-only timestamp, automatically assigned on back-end.

Array of objects (SelfLink) non-empty

The links related to resource.

Array (non-empty)
rel
required
string

The link type.

Value: "self"
href
required
string

The link URL.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

404

Resource was not found.

get/credit-memos/{id}/timeline/{messageId}
Request samples
curl -i -X GET \
  'https://api-sandbox.rebilly.com/organizations/unknown/credit-memos/{id}/timeline/{messageId}' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "type": "credit-memo-created",
  • "triggeredBy": "rebilly",
  • "message": "string",
  • "extraData": {
    },
  • "occurredTime": "2019-08-24T14:15:22Z",
  • "_links": [
    ]
}

Delete a credit memo timeline message

Delete a credit memo timeline message with predefined identifier string.

SecuritySecretApiKey or JWT
Request
path Parameters
id
required
string <= 50 characters ^[@~\-\.\w]+$

The resource identifier string.

messageId
required
string

The credit memo timeline message ID.

Responses
204

Credit memo timeline message was deleted.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

404

Resource was not found.

409

Conflict.

delete/credit-memos/{id}/timeline/{messageId}
Request samples
curl -i -X DELETE \
  'https://api-sandbox.rebilly.com/organizations/unknown/credit-memos/{id}/timeline/{messageId}' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "status": 401,
  • "title": "string",
  • "detail": "string",
  • "instance": "string"
}