Invoice Retrieval with Nue Self-Service APICopied!

The Nue Self-Service API provides robust capabilities for retrieving and managing customer invoices throughout their lifecycle. This functionality allows customers to view their billing history, track payments, and manage their financial records.

How to Retrieve Customer InvoicesCopied!

Required Information

To retrieve customer invoices, you need:

• Customer IDs: The unique identifier(s) for the customers whose invoices you want to retrieve

• Optional Filters: Parameters to refine the invoices returned

Query Parameters

The invoice retrieval endpoint supports several query parameters to customize the results:

• customerIds: JSON-encoded array of customer IDs to fetch invoices for

• includes: Comma-separated list of related data to include (assets, orders)

• status: Filter invoices by payment status:

  • nottransferred

  • transferred

  • transfererror

  • paid

  • partiallypaid

  • canceled

  • creditback

  • applied

  • partiallyapplied

  • refunded

  • partiallyrefunded

  • writtenoff

  • partiallywrittenoff

Retrieval Process

When you request invoices using the /invoices endpoint with appropriate query parameters, the system:

• Authenticates and authorizes the request

• Retrieves invoices matching the specified criteria

• Applies any status filters

• Includes related data as requested

• Returns a structured response with invoice details

Invoice Response

The response includes comprehensive information about each invoice:

• Basic Invoice Details: ID, name, status, created/modified dates

• Financial Information: Amounts, taxes, balances

• Payment Details: Status, hosted payment URLs, payment records

• Related Data: Associated assets and orders (when included)

• Tracking Information: PO numbers, dates, accounting status

Invoice Management Lifecycle

The invoice retrieval functionality supports the complete invoice management lifecycle:

• Draft Invoices: Review pending charges

• Active Invoices: Track current bills

• Payment Processing: Monitor payment status

• Historical Records: Access past invoices

• Related Documents: Link to associated assets and orders

Use Cases for Invoice Retrieval

This functionality is essential for several self-service scenarios:

• Payment Management: Track outstanding balances

• Financial Planning: Review upcoming charges

• Expense Tracking: Monitor service costs

• Compliance: Maintain financial records

• Budget Planning: Analyze spending patterns

Best Practices for Invoice Retrieval

• Provide filtering options for invoice management

• Include clear payment status indicators

• Link to appropriate payment actions

• Cache commonly accessed invoice information for performance

By implementing effective invoice retrieval, you enable customers to maintain a complete view of their financial obligations and manage their payments efficiently throughout the billing lifecycle.