InvoiceActivityType
A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.
Classifies entries in the invoice activity timeline.
Values
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
Created |
Invoice was created. |
Sent |
Invoice was sent to the recipient. |
Viewed |
Recipient viewed the invoice. |
PaymentReceived |
A payment was received. |
PaymentDeclined |
A payment attempt was declined. |
ReminderSent |
A reminder was sent. |
StatusChanged |
Invoice status changed. |
Edited |
Invoice was edited (Draft only). |
Closed |
Invoice was closed. |
Cancelled |
Invoice was cancelled. |
Refunded |
Invoice was refunded. |
CreditApplied |
A credit note was applied. |
NoteAdded |
An internal note was added. |
AutoChargeAttempted |
An automatic payment was attempted (auto-charge or smart-retry). |
PaymentRetryScheduled |
A soft-declined automatic payment was scheduled for a retry. |
PaymentRetriesExhausted |
Smart-retry attempts were exhausted (max attempts or retry window reached). |
PaymentRetriesStopped |
Smart-retry attempts were stopped (hard decline or manual intervention). |
PaymentPlanStarted |
A payment plan was set up against the invoice balance. |
InstallmentCollected |
An installment was collected (manually recorded or auto-charged). |
InstallmentCollectionFailed |
An automatic installment collection attempt failed (declined). |
PaymentPlanCancelled |
The payment plan was cancelled before all installments were collected. |
PaymentIndeterminate |
A payment attempt came back with a result the invoice cannot act on (a referral, a pending or submitted authorization, a partial approval, or an unrecognized status). Nothing was credited. Appended last: the numeric value is stored on the activity row and must never be renumbered. |
PaymentLinkReissued |
An operator replaced the payment link with a fresh one without notifying the recipient. The previous link stopped working. Appended last: the numeric value is stored on the activity row and must never be renumbered. |
Fields
| Field | Type | Description |
|---|
This model has no documented fields.