Skip to Content
BookkeepingCreating Reports

Vendor Credit Balance Report

Overview

The Vendor Credit Balance Report shows the credits that Vendors have issued to a Business, and how much of each is still available to use. It is the counterpart of the Customer Credit Balance Report.

A Vendor Credit is money a Vendor owes the Business, for example for returned goods or an overcharge. It can be applied to a future Bill to reduce what the Business has to pay.

Key components, for each Vendor and currency:

  • Total Credits – The total value of the credits issued by the Vendor.
  • Total Applied Credits – The part already applied to Bills.
  • Total Available Credits – The part that can still be applied.

How to Generate a Vendor Credit Balance Report

Call Retrieve the Vendor Credit Balance Report (GET /v0/business/{business_id}/reports/vendor-credits) with the Business ID. It has no other parameters and needs the report:read scope.

curl --request GET \
  --url "https://api.sandbox.getasset.com/v0/business/biz_GA6EG2qFxA97NZHtxeLPUy/reports/vendor-credits" \
  --header 'Authorization: Bearer <token>'

Each line of the response has:

FieldDescription
vendor_id, vendor_nameThe Vendor.
currencyThe currency the totals are in. A Vendor with credit in two currencies has two lines, because credit can only be applied to a Bill in the same currency.
total_creditsCredits issued by the Vendor.
total_applied_creditsCredits already applied to Bills.
total_available_creditsCredits still available.

Vendor Credit Use Cases

  • Show credit before paying a Bill. total_available_credits is what can be applied. To use it, pay the Bill with Vendor Credit.
  • Track what vendors owe. Credit is an amount owed to the Business, so reviewing the report keeps it from being forgotten.
  • Reconcile with the vendor. Compare the report with the vendor's own statement.
Questions? Reach out via our Contact form.

On this page