Skip to main content

List balance sheets for a supplier (per document)

GET 

/balances/biz-partners/suppliers/{bizPartnerId}/sheets

Returns balance per document for the given business partner (supplier).

Audit event:

  • invoice.biz-partners.suppliers.balance.sheetlist.get

Privilege (one of):

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

Filter fields:

  • instanceId
  • documentId
  • bizPartnerId
  • bizPartnerType
  • bizPartnerName
  • bizPartnerBriefName
  • vat
  • docClassDomain
  • docClassArea
  • documentNumber
  • documentDate
  • documentDueDate
  • documentIssuingDate
  • currency
  • paymentStatus
  • docClassId
  • dataSourceId
  • domainId
  • ownerId
  • ownerBpName
  • ownerBpBriefName
  • documentTypeId
  • documentTypeName
  • documentTypeSelfBilling
  • documentTypeDtsSelectorId
  • invDate
  • vatPercent
  • documentUuid
  • currencyCode
  • dataSourceCodeName
  • docClassCodeName
  • domainCodeName
  • documentTypeDtsSelectorCodeName
  • amountNoVat
  • amountVat
  • total
  • totalUnpaid
  • totalPaid
  • rounding

Sortable fields:

  • documentId
  • documentUuid
  • bizPartnerId
  • bizPartnerType
  • bizPartnerName
  • bizPartnerBriefName
  • vat
  • docClassDomain
  • docClassArea
  • documentNumber
  • documentDate
  • documentDueDate
  • documentIssuingDate
  • currency
  • currencyCode
  • paymentStatus
  • docClassId
  • docClassCodeName
  • dataSourceId
  • dataSourceCodeName
  • domainId
  • domainCodeName
  • ownerId
  • ownerBpName
  • ownerBpBriefName
  • documentTypeId
  • documentTypeName
  • documentTypeSelfBilling
  • documentTypeDtsSelectorId
  • documentTypeDtsSelectorCodeName
  • amountNoVat
  • amountVat
  • total
  • totalUnpaid
  • totalPaid
  • rounding
  • invDate
  • vatPercent

Searchable attributes:

  • documentDate
  • invDate
  • documentId
  • documentUuid
  • bizPartnerName
  • bizPartnerBriefName
  • bizPartnerType
  • amountNoVat
  • amountVat
  • vat
  • vatPercent
  • total
  • totalUnpaid
  • totalPaid
  • rounding
  • documentNumber
  • paymentStatus
  • documentDueDate
  • documentIssuingDate
  • currency
  • currencyCode
  • ownerId
  • ownerBpName
  • ownerBpBriefName
  • docClassId
  • docClassCodeName
  • docClassDomain
  • docClassArea
  • dataSourceId
  • dataSourceCodeName
  • domainId
  • domainCodeName
  • documentTypeId
  • documentTypeName
  • documentTypeSelfBilling
  • documentTypeDtsSelectorId
  • documentTypeDtsSelectorCodeName

Errors:

  • START_DATE_AND_END_DATE_MUST_BE_SENT - Start date and end date must be sent
  • START_DATE_IS_LESS_THAN_END_DATE - Start date is less than end date
  • NOT_AUTHORIZED - Not authorized
  • NOT_AUTHENTICATED - Not authenticated
  • INT_APP_ERROR - Internal server error

Request

Responses

List of balance sheets (per document) for the supplier