Credit Memos Overview
In the Nue API, a Credit Memo serves as a financial document used to record customer account credits, refunds, returns, and billing adjustments. Credit memos are typically created to reverse or reduce charges on previously issued invoices, handle product returns, process refunds, or apply account credits. Credit memo management enables businesses to maintain accurate financial records while providing customers with transparent documentation of credits, refunds, and billing adjustments within the Nue ecosystem.
What Is a Credit Memo Lifecycle
The credit memo lifecycle in the context of the Nue API describes the sequence of states and processes a credit memo undergoes from its initial creation to final application or closure. This lifecycle automates and manages all financial activities associated with crediting customers, applying adjustments, handling refunds, and ensuring financial reconciliation.
Stages of the Credit Memo Lifecycle in Nue
- Draft The credit memo is generated, usually triggered by a invoice cancellation or a stand alone credit memo creation. In this stage, the credit memo is not yet visible to the customer or applicable to invoices.
- Pending Activation The credit memo awaits approval or additional conditions (such as review or final amount calculation). No credit application is initiated at this stage.
- Active The credit memo is now officially issued and can be applied to outstanding invoices or processed as a refund via a connected payment system.
- Apply: Credit memos can be applied to reduce the outstanding balance of invoices, and the payment status ("Applied" or "Partially Applied") is updated.
- Refund: If a refund is processed, the corresponding payment status ("Refunded" or "Partially Refunded") is updated.
- Transfer: If a payment system is connected, the credit memo will be transferred to the system upon activation, and the payment status is updated from "NotTransferred" to "Transferred".
- Canceled The credit memo has been officially voided and will be removed from the billing process, ensuring that no further credit application or post-processing actions are performed on the document.
For more information about credit memo lifecycle, please refer to this article.
All credit memo activities are synchronized with external financial systems (like ERP or accounting software) to ensure records match. The credit memo's lifecycle ends when its balance is zero—either through application to invoices, refund processing, or write-off—and its final state is logged.
Credit Memo Statuses
Credit memos can have one of the following statuses, and the actions available for that credit memo depend on its current status.
STATUS | DESCRIPTION | AVAILABLE ACTIONS |
|---|---|---|
Draft | The credit memo is generated but not yet applicable. | - Update certain fields - Activate - Cancel |
PendingActivation | The credit memo awaits approval or additional adjustments. | - Update certain fields - Activate - Cancel |
Active | The credit memo is finalized and can be applied or refunded. | - Update certain fields - Cancel - Apply to invoices - Process refund |
Canceled | The credit memo is voided. | - Delete |
Credit Memo Payment Statuses
The payment status of an active credit memo is set based on the application and refund actions performed. Credit memos can have one of the following payment statuses.
PAYMENT STATUS | DESCRIPTION | AVAILABLE ACTIONS |
|---|---|---|
NotTransferred | The credit memo is available for application and has not been transferred to a payment system. | - Apply to invoices - Send to payment system - Process refund |
Transferred | The credit memo has been successfully transferred to the payment system and is awaiting action. | - Process refund - Apply to invoices |
TransferError | The credit memo failed to be transferred to the payment system due to an error. | - Resend to payment system |
Applied | The full amount of the credit memo has been applied to invoices. | - Unapply from invoices |
PartiallyApplied | A portion of the credit memo has been applied to invoices, with remaining balance available. | - Apply remaining balance - Unapply applied portions |
Refunded | The credit memo has been fully refunded to the customer. | - No Actions Available |
PartiallyRefunded | The credit memo has been partially refunded, with remaining balance available for application. | - Apply remaining balance - Process additional refund |
WrittenOff | The credit memo is considered closed and has been written off. | - No Actions Available |
PartiallyWrittenOff | A portion of the credit memo has been written off, with remaining balance available. | - Apply remaining balance |
Canceled | The credit memo was canceled before any application or refund occurred. | - No Actions Available |
CreditBack | The credit memo was created as part of the refund process to offset invoices. | - Apply to invoices |
Credit Memo vs Invoice Relationship
Credit memos and invoices work together in the Nue financial ecosystem:
- Credit Application: Credit memos can be applied to outstanding invoices to reduce balances
- Refund Processing: Credit memos can be converted to customer refunds through payment systems
- Financial Reconciliation: Both documents are synchronized with external accounting systems
- Audit Trail: Complete transaction history is maintained for both credit memos and invoices
Use Cases for Credit Memos
Product Returns
- Process returns of physical products or cancel services
- Generate credit memos for returned items with proper asset tracking
- Apply credits to future purchases or process refunds
Billing Adjustments
- Correct billing errors or pricing discrepancies
- Apply promotional credits or discounts retroactively
- Adjust charges based on usage corrections or service level adjustments
Refund Management
- Process customer refund requests with proper documentation
- Handle subscription cancellations with pro-rated credits
- Manage dispute resolutions and goodwill credits
Account Management
- Apply account credits from overpayments or deposits
- Process bulk credit applications across multiple invoices
- Handle complex multi-invoice credit scenarios
Next Steps
Explore the credit memo implementation guides:
- Fetch Credit MemosFetch Credit Memos - Learn core credit memo retrieval operations with filtering and pagination
- Credit Memo Data Reference - Complete field reference and data structures
- Advanced Credit Memo Workflows - Complex scenarios and best practices
Each guide serves as a comprehensive reference for different aspects of credit memo management, offering complete coverage of credit memo features in the Nue API.