Skip to main content

List of payable invoices

GET 

/payable-invoices

Returns a paginated list of payable invoices where

  • status is approved
  • paymentStatus is open
  • collectionMode is not member
  • classCodeName is not CONTROL_INVOICE

Audit event:

  • payable.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:

  • INVOICE_NOTFOUND - Invoice not found
  • NOT_AUTHORIZED - Not authorized
  • NOT_AUTHENTICATED - Not authenticated
  • INT_APP_ERROR - Unexpected internal error

Request

Responses

List of payable invoices