Developer docs
/
Rebilly API
/
Credit memos timeline
/
Retrieve credit memo timeline messages

Retrieve credit memo timeline messages

Retrieves a list of credit memo timeline messages.

SecurityAPI Key: SecretApiKey or HTTP: JWT
Request
path Parameters
id
required
string <= 50 characters ^[@~\-\.\w]+$

ID of the resource.

query Parameters
limit
integer [ 0 .. 1000 ]

Limits the number of collection items to be returned.

offset
integer [ 0 .. 1000 ]

Specifies the starting point within the collection of items to be returned.

filter
string

Filters the collection items. This field requires a special format. Use , for multiple allowed values. Use ; for multiple fields.

For more information, see Using filter with collections.

sort
Array of strings

Sorts and orders the collection of items. To sort in descending order, prefix with -. Multiple fields can be sorted by separating each with ,.

q
string

Use this field to perform a partial search of text fields.

get
/credit-memos/{id}/timeline
Responses

200

List of credit memo timeline messages retrieved.

Response Headers
Pagination-Total
integer

Total number of items.

Example: 332
Pagination-Limit
integer

Maximum number of items per page.

Example: 100
Pagination-Offset
integer

Specifies the starting point within the collection of resource results. For example, a request with limit=20 retrieves and displays the first 20 results on a page. A following request with limit=20 and offset=20, retrieves the next page of 20 results.

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

ID of the timeline message.

type
string

Type of timeline message.

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

Specifies who, or what, triggered the timeline event.

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

Content of the timeline message.

object (TimelineExtraData)

Additional data.

occurredTime
string <date-time> (ServerTimestamp)

Read-only timestamp in ISO 8601 date-time format.

Array of objects (SelfLink)

Related links.

401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

Response samples
application/json
[
{
"id": "tmln_0YV8Q9WEF5DTA8HFXS27D1G6GC",
"type": "credit-memo-created",
"triggeredBy": "rebilly",
"message": "string",

"occurredTime": "2019-08-24T14:15:22Z",

}
]