Skip to main content

List clearing records for invoice

GET 
/invoices/{invoiceId}/clearingrecords

Returns clearing records that belong to the invoice's clearing. Invoice clearing is created when invoice status is approved and payment status is set to 'open'.

By default only active clearing records are returned. To include other statuses: Status filter:

  • Operator: in
  • Example: in(status)=active,canceled

Audit event:

  • invoice.clearing.record.list

Privilege (one of):

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

Filter/Sort fields:

  • id
  • clearingId
  • clearingTypeId
  • clearingTypeCodeName
  • recordDate
  • paymentTypeId
  • paymentTypeName
  • amountIncrement
  • paidAmount
  • paymentReference
  • comment
  • status
  • statusDate
  • bankAccountId
  • bankAccountName
  • bankAccountNumber
  • bankAccountIban
  • bankAccountSwiftBic
  • revokeUserId
  • revokeUserName
  • revokeComment

Searchable attributes:

  • status
  • paymentReference
  • comment
  • revokeUserId
  • revokeUserName
  • revokeComment
  • clearingTypeCodeName
  • paymentTypeName
  • bankAccountName
  • bankAccountNumber
  • bankAccountIban
  • bankAccountSwiftBic

Errors:

  • INVOICE_NOTFOUND - Invoice not found
  • INVOICE_CLEARING_NOTFOUND - Invoice clearing not found
  • INVOICE_CLEARING_RECORD_NOTFOUND - Invoice clearing record not found
  • NOT_AUTHORIZED - Not authorized
  • NOT_AUTHENTICATED - Not authenticated
  • INT_APP_ERROR - Unexpected internal error

Request​

Responses​

List of clearing records