Invoices Overview

invoices overview in the nue api, an invoice serves as the primary financial document used to request and track customer payments for products delivered or services rendered invoices are created based on active subscriptions, assets, entitlements, or usage data, consolidating all charges, adjustments, and payment obligations for a specific billing period invoice management enables businesses to automate the entire payment lifecycle—from invoice creation, delivery, and payment collection through reconciliation and post processing—supporting one time, recurring, usage based, and hybrid billing models within the nue ecosystem what is invoice lifecycle the invoice lifecycle in the context of the nue api describes the sequence of states and processes an invoice undergoes from its initial creation to final closure this lifecycle automates and manages all financial activities associated with charging customers, collecting payments, handling exceptions, and ensuring financial reconciliation stages of the invoice lifecycle in nue draft the invoice is generated, usually triggered by a billing schedule or upon order activation in this stage, the invoice is not yet visible to the customer or payable pending activation the invoice awaits approval or additional conditions (such as review or final amount calculation) no payment collection is initiated at this stage active the invoice is now officially issued and payable via a connected collection system or an email notification containing a secure payment link transfer if a collection system is connected, the invoice will be transferred to the system upon activation, and the payment status of the invoice is updated from "open" to "transferred" pay if a payment is initiated, the payment status (“paid” or “partially paid”) of the invoice is updated apply credit memo credit memos can be applied to reduce the outstanding balance of an invoice, and the payment status (“applied” or “partially applied”) is updated refund if a refund is initiated, the corresponding payment status (“refunded” or “partially refunded”) is updated write off if amounts are deemed uncollectible, the invoice is marked as “write off”, and the payment status (“written off” or “partially written off”) is updated canceled the invoice has been officially voided and will be removed from the billing and payment process, ensuring that no further payment activity or post processing actions are performed on the document for more information about invoice lifecycle, please refer to this article all invoice activities are synchronized with external financial systems (like erp or accounting software) to ensure records match the invoice’s lifecycle ends when its balance is zero—either through payment, credits, write off, or a combination of adjustments—and its final state is logged invoice statuses invoices can have one of the following statuses, and the actions available for that invoice depend on its current status status description available actions draft the invoice is generated but not yet payable update certain fields \ activate \ cancel pendingactivation the invoice awaits approval or additional adjustments update certain fields \ activate \ cancel active the invoice is finalized and awaiting payment update certain fields \ cancel \ process payment canceled the invoice is voided delete e invoicing the invoice is in the process of the electronic invoicing update certain fields \ activate after the process completes \ cancel invoice payment statuses the payment status of an active invoice is set based on the payment and collection actions performed invoices can have one of the following payment statuses payment status description available payment actions nottransferred the invoice is "open" and has not been transferred to a payment system send to the collection system \ process payment and collection transferred the invoice has been successfully transferred to the payment system and is awaiting payment process payment and collection transfererror the invoice failed to be transferred to the payment system due to an error resend to the collection system paid the invoice has been paid in full refund partialpaid the invoice has received partial payment and the balance remains outstanding pay \ refund canceled the invoice was canceled before any payment occurred no payment actions available creditback the transaction was created as part of the refund process to offset invoices refund applied (for credit memos) the full amount of a credit memo has been applied to invoices unapply partiallyapplied (for credit memos) a portion of the credit memo has been applied to invoices unapply refunded the invoice has been fully refunded to the customer no payment actions available partialrefunded the invoice has been partially refunded, and part of the original payment has been returned no payment actions available writtenoff the invoice is considered uncollectible and has been written off as bad debt no payment actions available partiallywrittenoff a portion of the invoice is considered uncollectible and has been written off as bad debt no payment actions available processing the invoice is currently in the process of being paid no payment actions available next steps explore the invoice implementation guides generate invoices docid\ qioddvy7v69ihqkdw rm how nue invoices are generated manage invoices docid\ ypvp4gvl8xafatvesnkvv learn core invoice retrieval and updating operations process payment docid\ srcsfv4mtx6qymclkkjp9 process payment and collection for an invoice preview invoices docid\ ts3vmqeanuqqueoqdrav0 preview invoices for a customer or an order each guide serves as a quick start for different stages, offering comprehensive coverage of invoice and payment features in the nue api