action rebilly_post_invoice_timeline { label: "Create an invoice Timeline comment" description: "Create an invoice Timeline comment.\n" provider: rebilly method: POST path: "/invoices/{id}/timeline" encoding: json input: { type: "object" properties: { _links: { type: "array" description: "The links related to resource." items: { type: "object" required: ["rel"] properties: { rel: { type: "string" description: "The link type." enum: ["self"] } } } } extraData: { type: "object" description: "Additional data." properties: { actions: { type: "array" description: "Actions available to a Timeline message. Can be empty in case no actions are available for a message." items: { type: "object" properties: { action: { type: "string" enum: ["resend-email", "redemption-cancel", "ruleset-restore"] } } } } author: { type: "object" description: "Timeline comment author data." properties: { userFullName: { type: "string" } userId: { type: "string" } } } links: { type: "array" items: { type: "object" properties: { placeholder: { type: "string" } resourceId: { type: "string" description: "The resource ID. Defaults to UUID v4." } resourceType: { type: "string" enum: ["kyc-document", "invoice", "subscription", "transaction", "email-message", "dispute", "coupon"] } } } } mentions: { type: "object" } tables: { type: "array" items: { type: "object" description: "Additional information about Timeline message." properties: { footer: { type: "string" description: "Data table footer." } title: { type: "string" description: "Data table title." } type: { type: "string" enum: ["list", "one-columns", "two-columns", "three-columns"] } } } } } } id: { description: "The Timeline message identifier string." type: "object" } message: { type: "string" description: "The message that describes the message details." } occurredTime: { description: "Timeline message time." type: "object" } triggeredBy: { type: "string" description: "Shows who or what triggered the Timeline event." enum: ["rebilly", "app", "direct-api"] } type: { type: "string" description: "Timeline message type." enum: ["timeline-comment-created", "invoice-created", "invoice-issued", "invoice-abandoned", "invoice-voided", "invoice-past-due", "invoice-paid", "invoice-partially-paid", "invoice-disputed", "invoice-refunded", "invoice-partially-refunded", "invoice-renewal-payment-declined", "email-message-sent", "coupon-applied", "transaction-approved", "transaction-abandoned", "transaction-canceled", "transaction-declined", "transaction-initiated", "transaction-refunded", "transaction-voided"] } } } output: { type: "object" properties: { _links: { type: "array" description: "The links related to resource." items: { type: "object" required: ["rel"] properties: { rel: { type: "string" description: "The link type." enum: ["self"] } } } } extraData: { type: "object" description: "Additional data." properties: { actions: { type: "array" description: "Actions available to a Timeline message. Can be empty in case no actions are available for a message." items: { type: "object" properties: { action: { type: "string" enum: ["resend-email", "redemption-cancel", "ruleset-restore"] } } } } author: { type: "object" description: "Timeline comment author data." properties: { userFullName: { type: "string" } userId: { type: "string" } } } links: { type: "array" items: { type: "object" properties: { placeholder: { type: "string" } resourceId: { type: "string" description: "The resource ID. Defaults to UUID v4." } resourceType: { type: "string" enum: ["kyc-document", "invoice", "subscription", "transaction", "email-message", "dispute", "coupon"] } } } } mentions: { type: "object" } tables: { type: "array" items: { type: "object" description: "Additional information about Timeline message." properties: { footer: { type: "string" description: "Data table footer." } title: { type: "string" description: "Data table title." } type: { type: "string" enum: ["list", "one-columns", "two-columns", "three-columns"] } } } } } } id: { description: "The Timeline message identifier string." type: "object" } message: { type: "string" description: "The message that describes the message details." } occurredTime: { description: "Timeline message time." type: "object" } triggeredBy: { type: "string" description: "Shows who or what triggered the Timeline event." enum: ["rebilly", "app", "direct-api"] } type: { type: "string" description: "Timeline message type." enum: ["timeline-comment-created", "invoice-created", "invoice-issued", "invoice-abandoned", "invoice-voided", "invoice-past-due", "invoice-paid", "invoice-partially-paid", "invoice-disputed", "invoice-refunded", "invoice-partially-refunded", "invoice-renewal-payment-declined", "email-message-sent", "coupon-applied", "transaction-approved", "transaction-abandoned", "transaction-canceled", "transaction-declined", "transaction-initiated", "transaction-refunded", "transaction-voided"] } } } }