Invoices Timeline

The invoices timeline keeps an audit trail of changes and activity for each invoice.

Retrieve a list of invoice timeline messages

Retrieve a list of invoice 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 invoice 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: "coupon-applied" "email-message-sent" "invoice-abandoned" "invoice-disputed" "invoice-issued" "invoice-paid" "invoice-partially-paid" "invoice-partially-refunded" "invoice-past-due" "invoice-refunded" … 20 more

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/invoices/{id}/timeline

Request samples

// all parameters are optional except for the `id`
const firstCollection = await api.invoices
    .getAllTimelineMessages({id: 'my-invoice'});

// alternatively you can specify one or more of them
const params = {id: 'my-invoice', limit: 20, offset: 100};
const secondCollection = await api.invoices.getAllTimelineMessages(params);

// access the collection items, each item is a Member
secondCollection.items
    .forEach(message => console.log(message.fields.eventType));

Response samples

200
401
403

application/json

[{"id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
"type": "coupon-applied",
"triggeredBy": "rebilly",
"message": "string",
"extraData": {"actions": [{"action": "resend-email"
}
],
"tables": [{"type": "list",
"title": "string",
"footer": "string"
}
],
"author": {"userFullName": "string",
"userId": "string"
},
"mentions": {"property1": {"@test@mail.com": "userId-1"
},
"property2": {"@test@mail.com": "userId-1"
}
},
"links": [{"resourceType": "kyc-document",
"resourceId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
"placeholder": "KYC Document",
"externalUrl": "http://example.com"
}
]
},
"occurredTime": "2019-08-24T14:15:22Z",
"_links": [{"rel": "self",
"href": "string"
}
]
}
]

Create an invoice Timeline comment

Create an invoice Timeline comment.

SecuritySecretApiKey or JWT

Request

path Parameters

id

required

string <= 50 characters ^[@~\-\.\w]+$

The resource identifier string.

Request Body schema: application/json

Invoice Timeline resource.

message

string

The message that describes the message details.

Responses

201

Invoice Timeline comment was created.

Response Schema: application/json

id

string <= 50 characters

The resource ID. Defaults to UUID v4.

type

string

Timeline message type.

Enum: "coupon-applied" "email-message-sent" "invoice-abandoned" "invoice-disputed" "invoice-issued" "invoice-paid" "invoice-partially-paid" "invoice-partially-refunded" "invoice-past-due" "invoice-refunded" … 20 more

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 redemption-cancel
redemptionId	string <= 50 characters Recursive The resource ID. Defaults to UUID v4.

Array of objects (TimelineTable) >= 0 items

Array (>= 0 items)

type	string three-columns
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/invoices/{id}/timeline

Request samples

application/json

{"message": "string"
}

Response samples

201
401
403
422

application/json

{"id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
"type": "coupon-applied",
"triggeredBy": "rebilly",
"message": "string",
"extraData": {"actions": [{"action": "resend-email"
}
],
"tables": [{"type": "list",
"title": "string",
"footer": "string"
}
],
"author": {"userFullName": "string",
"userId": "string"
},
"mentions": {"property1": {"@test@mail.com": "userId-1"
},
"property2": {"@test@mail.com": "userId-1"
}
},
"links": [{"resourceType": "kyc-document",
"resourceId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
"placeholder": "KYC Document",
"externalUrl": "http://example.com"
}
]
},
"occurredTime": "2019-08-24T14:15:22Z",
"_links": [{"rel": "self",
"href": "string"
}
]
}

Retrieve an Invoice Timeline message

Retrieve a invoice 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 Invoice Timeline message ID.

Responses

200

Invoice 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: "coupon-applied" "email-message-sent" "invoice-abandoned" "invoice-disputed" "invoice-issued" "invoice-paid" "invoice-partially-paid" "invoice-partially-refunded" "invoice-past-due" "invoice-refunded" … 20 more

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 redemption-cancel
redemptionId	string <= 50 characters Recursive The resource ID. Defaults to UUID v4.

Array of objects (TimelineTable) >= 0 items

Array (>= 0 items)

type	string three-columns
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/invoices/{id}/timeline/{messageId}

Request samples

const message = await api.invoices
    .getTimelineMessage({id: 'foobar-001', messageId: 'message-202'});
console.log(message.fields.eventType);

Response samples

200
401
403
404

application/json

{"id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
"type": "coupon-applied",
"triggeredBy": "rebilly",
"message": "string",
"extraData": {"actions": [{"action": "resend-email"
}
],
"tables": [{"type": "list",
"title": "string",
"footer": "string"
}
],
"author": {"userFullName": "string",
"userId": "string"
},
"mentions": {"property1": {"@test@mail.com": "userId-1"
},
"property2": {"@test@mail.com": "userId-1"
}
},
"links": [{"resourceType": "kyc-document",
"resourceId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
"placeholder": "KYC Document",
"externalUrl": "http://example.com"
}
]
},
"occurredTime": "2019-08-24T14:15:22Z",
"_links": [{"rel": "self",
"href": "string"
}
]
}

Delete an Invoice Timeline message

Delete an Invoice 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 Invoice Timeline message ID.

Responses

204

Invoice Timeline message was deleted.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

404

Resource was not found.

409

Conflict.

delete/invoices/{id}/timeline/{messageId}

Request samples

const request = await api.invoices
    .deleteTimelineMessage({id: 'foobar-001', messageId: 'message-202'});

// the request does not return any fields but
// you can confirm the success using the status code
console.log(request.response.status); // 204

Response samples

401
403
404
409

application/json

{"status": 401,
"type": "http://example.com",
"title": "string",
"detail": "string",
"instance": "string"
}