Skip to main content

List of top-up (prepaid customer) invoices

GET 
/topup-invoices

Returns a paginated list of top-up invoices: customer prepaid invoices. The server restricts results to classCodeName = CUSTOMER_INVOICE and dataSourceCodeName = PREPAID

Audit event:

  • topup.invoice.list

Privilege (one of):

  • finance-invoices.view
  • finance-invoices-own.view

Filter fields:

  • custName
  • invoice
  • instanceId
  • custShortName
  • invNumber
  • invDate
  • invoicingDate
  • invoicingDatePolicy
  • invDueDate
  • overDueDate
  • total
  • totalUnpaid
  • totalPaid
  • invType
  • invTypeName
  • invPeriod
  • invPeriodStart
  • invPeriodEnd
  • status
  • statusDt
  • bpInstanceId
  • nettingInvoiceId
  • PaymentStatus
  • currency
  • custId
  • id
  • disputeStatus
  • classCodeName
  • customerType
  • dataSourceCodeName
  • domainCodeName
  • docsDeliveryStatus
  • selfBilling
  • collectionLeadId
  • processingStatus
  • collectionMode
  • domainName
  • syncStatus
  • syncStatusDt
  • syncMode
  • nettingInvoicePaymentStatus
  • nettingInvoiceStatus
  • amountVat
  • amountNoVat
  • vat
  • rounding
  • collectionLeadNumber
  • custCountry
  • custPOBox
  • dtsSelectorId
  • dtsSelectorCodeName
  • invUid
  • ownerId
  • ownerBpName
  • ownerBpBriefName
  • documentSync
  • externalRefId

Sortable fields:

  • custName
  • invoice
  • custShortName
  • invNumber
  • invDate
  • invoicingDate
  • invoicingDatePolicy
  • invDueDate
  • overDueDate
  • total
  • totalUnpaid
  • totalPaid
  • invType
  • invTypeName
  • invPeriod
  • invPeriodStart
  • invPeriodEnd
  • status
  • statusDt
  • nettingInvoiceId
  • PaymentStatus
  • currency
  • custId
  • id
  • disputeStatus
  • classCodeName
  • customerType
  • dataSourceCodeName
  • domainCodeName
  • docsDeliveryStatus
  • selfBilling
  • collectionLeadId
  • processingStatus
  • collectionMode
  • domainName
  • syncStatus
  • syncStatusDt
  • syncMode
  • nettingInvoicePaymentStatus
  • nettingInvoiceStatus
  • amountVat
  • amountNoVat
  • vat
  • rounding
  • collectionLeadNumber
  • custCountry
  • custPOBox
  • dtsSelectorId
  • dtsSelectorCodeName
  • invUid
  • ownerId
  • ownerBpName
  • ownerBpBriefName
  • documentSync
  • externalRefId

Searchable attributes:

  • custShortName
  • status
  • custName
  • invNumber
  • invDate
  • invoicingDate
  • invoicingDatePolicy
  • invDueDate
  • currencyCode
  • invTypeName
  • invPeriod
  • paymentStatus
  • disputeStatus
  • invUid
  • custID
  • externalRefId
  • ownerId
  • ownerBpName
  • ownerBpBriefName

Errors:

  • NOT_AUTHORIZED – Not authorized
  • NOT_AUTHENTICATED - Not authenticated
  • INT_APP_ERROR - Internal server error
  • INVOICE_NOTFOUND - Invoice not found

Request​

Responses​

List of top-up invoices