POST /invoices/{id}/timeline

Creates an invoice timeline comment.

Servers

https://api-sandbox.rebilly.com/organizations/{organizationId}
https://api.rebilly.com/organizations/{organizationId}

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/json"

Request body fields

Name	Type	Required	Description
`id`	String	No	ID of the timeline message.
`extraData`	Object	No	Additional data.
`extraData.mentions`	Object	No	User mentions, or tags, in a timeline.
`extraData.actions[]`	Array	No	Actions available for a timeline message. If no actions are available, this field is empty.
`extraData.tables[]`	Array	No	Table data that is attached to the timeline message.
`extraData.tables[].type`	String	No	Valid values: `"two-columns"` `"one-columns"` `"list"` `"three-columns"`
`extraData.tables[].title`	String	No	Data table title.
`extraData.tables[].footer`	String	No	Data table footer.
`extraData.author`	Object	No	Author of the timeline message.
`extraData.author.userId`	String	No	ID of the author.
`extraData.author.userFullName`	String	No	Full name of the author.
`extraData.links[]`	Array	No	Links that are attached to a timeline message.
`extraData.links[].placeholder`	String	No
`extraData.links[].resourceId`	String	No	Unique resource ID.
`extraData.links[].resourceType`	String	No	Valid values: `"external"` `"transaction"` `"dispute"` `"subscription"` `"coupon"` `"kyc-document"` `"email-message"` `"invoice"`
`extraData.links[].externalUrl`	String	No
`_links[]`	Array	No	Related links.
`_links[].href`	String	No	Link URL.
`_links[].rel`	String	No	Type of link. Valid values: `"self"`
`triggeredBy`	String	No	Specifies who, or what, triggered the timeline event. Valid values: `"rebilly"` `"direct-api"` `"app"`
`occurredTime`	String	No	Date and time when the timeline message occurred.
`message`	String	No	Describes the message details.
`type`	String	No	Type of timeline message. Valid values: `"transaction-declined"` `"invoice-issued"` `"transaction-initiated"` `"quickbooks-credit-memo-voided"` `"quickbooks-revenue-recognition-created"` `"invoice-revenue-recognized"` `"invoice-tax-calculation-failed"` `"invoice-voided"` `"invoice-partially-refunded"` `"coupon-applied"` `"invoice-partially-paid"` `"invoice-past-due"` `"invoice-renewal-payment-declined"` `"invoice-refunded"` `"invoice-reissued"` `"quickbooks-invoice-voided"` `"invoice-disputed"` `"transaction-voided"` `"email-message-sent"` `"transaction-abandoned"` `"invoice-abandoned"` `"quickbooks-credit-memo-created"` `"transaction-refunded"` `"quickbooks-invoice-updated"` `"quickbooks-invoice-created"` `"timeline-comment-created"` `"transaction-canceled"` `"transaction-approved"` `"invoice-paid"` `"quickbooks-invoice-task-failed"`

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.