List of invoices
GET/invoices
Returns a list of invoices for given sorting and pagination parameters.
Audit event:
- invoice.list
Privilege (one of):
- finance-invoices.view
- finance-invoices-own.view
Filters
- domainCodeName – invoice domain. Supported values:
- BULK – Bulk SMS
- BULK-MNP – Bulk MNP
- dataSourceCodeName – invoice data source. Supported values:
- PREPAID
- POSTPAID
- FINANCE
- SUPPLIER-INVOICE
- POSTPAID-SUPPLIER-INVOICE
- POSTPAID-CONTROL
- classCodeName – document class; key for listing different kinds of invoices. Each class has distinct properties and behavior. Common values:
- CUSTOMER_INVOICE
- SUPPLIER_INVOICE
- NETTING_INVOICE
- CONTROL_INVOICE
- CREDIT_DEBIT_NOTE
- SUPPLIER_CR_DB_NOTE
- dtsSelectorCodeName – subprocess of data source. Supported values:
- PART-PAYMENT – POSTPAID customer part-payment invoices
- 0 – POSTPAID invoices without part-payment subprocess
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 - Internal server error
Request
Responses
- 200
- 401
- 404
- 500
A list of invoices
Not Authorized, Not Authenticated
Invoice not found
Internal Server Error