Estimate the usage of vendor credits on an invoice of a given amount
Entity ID or Entity ForeignID
Counterparty Entity ID or Counterparty Entity ForeignID
The amount of the invoice to calculate vendor credit usage for.
The currency of the invoice to calculate vendor credit usage for. Defaults to USD.
List of invoice IDs to exclude from the calculation. If not provided or an empty list, no invoices will be excluded. This is useful for recalculating vendor credit usage on invoices that already have vendor credits applied.
List of vendor credit IDs to include in the calculation. If not provided, all applicable vendor credits will be included, while an empty list will not include ANY vendor credits. This is useful for recalculating vendor credit usage on invoices that have a fixed list of applied vendor credits (e.g. a SCHEDULED or PENDING invoice).
The vendor credit usage estimate
Remaining amount on the invoice after vendor credits are applied in major units.
Currency code for the amount. Defaults to USD.
Vendor credits that will be applied to the invoice. The objects returned represent the states each vendor credit will be in AFTER they are applied to the invoice, not their current states.