Skip to main content

List of all balances for business partners (customers)

GET 
/balances/biz-partners/customers

Returns aggregated balances per business partner (customer) and currency, with optional grouping for deeper analysis.

Audit event:

  • invoice.biz-partners.customers.balance.list

Privilege (one of):

  • finance-balance-view
  • finance-balance-own-view

Filter fields:

  • instanceId
  • bizPartnerName
  • bizPartnerBriefName
  • bizPartnerId
  • bizPartnerType
  • currency
  • currencyCode
  • ownerId
  • ownerBpName
  • ownerBpBriefName
  • docClassId
  • docClassCodeName
  • docClassDomain
  • docClassArea
  • dataSourceId
  • dataSourceCodeName
  • domainId
  • domainCodeName
  • documentTypeId
  • documentTypeName
  • documentTypeSelfBilling
  • documentTypeDtsSelectorId
  • documentTypeDtsSelectorCodeName

Sortable fields:

  • bizPartnerName
  • bizPartnerBriefName
  • bizPartnerId
  • bizPartnerType
  • rounding
  • currency
  • currencyCode
  • ownerId
  • ownerBpName
  • ownerBpBriefName
  • docClassId
  • docClassCodeName
  • docClassDomain
  • docClassArea
  • dataSourceId
  • dataSourceCodeName
  • domainId
  • domainCodeName
  • documentTypeId
  • documentTypeName
  • documentTypeSelfBilling
  • documentTypeDtsSelectorId
  • documentTypeDtsSelectorCodeName
  • amountNoVat
  • amountVat
  • total
  • totalUnpaid
  • totalPaid

Searchable attributes:

  • bizPartnerBriefName
  • bizPartnerId
  • bizPartnerName
  • bizPartnerType
  • rounding
  • custName
  • currency
  • currencyCode
  • ownerId
  • ownerBpName
  • ownerBpBriefName
  • docClassId
  • docClassCodeName
  • docClassDomain
  • docClassArea
  • dataSourceId
  • dataSourceCodeName
  • domainId
  • domainCodeName
  • documentTypeId
  • documentTypeName
  • documentTypeSelfBilling
  • documentTypeDtsSelectorId
  • documentTypeDtsSelectorCodeName

Grouping fields

  • domainId
  • domainCodeName
  • docClassId
  • docClassCodeName
  • docClassDomain
  • docClassArea
  • documentTypeId
  • dataSourceId
  • dataSourceCodeName
  • documentTypeName
  • documentTypeDtsSelectorId
  • documentTypeDtsSelectorCodeName
  • documentTypeSelfBilling

Errors:

  • NOT_AUTHENTICATED - Not authenticated
  • NOT_AUTHORIZED - Not authorized
  • INT_APP_ERROR - Unexpected internal error

Request​

Responses​

List of balances for customers