For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Sign inBook a demo
HomeGuidesAPI ReferenceGlossary
HomeGuidesAPI ReferenceGlossary
  • API Reference
      • GETSearch entities
      • POSTCreate entity
      • GETGet entity
      • POSTUpdate entity
      • DELDelete entity
      • POSTAccept Terms of Service
      • POSTInitiate KYB
      • POSTGenerate JWT Token
      • GETGenerate Onboarding Link
      • POSTSend Onboarding Email
      • GETEvents
        • GETFind payee counterparties
        • GETFind payor counterparties
        • POSTLink Payees
        • POSTHide Payee
        • POSTLink Payors
        • POSTHide Payors
          • GETGet All
          • GETGet
          • POSTCreate
          • DELDelete
          • GETEstimate Vendor Credit Usage
Logo
Sign inBook a demo
API ReferenceEntityCounterpartyVendor Credit

Estimate Vendor Credit Usage

GET
https://api.mercoa.com/entity/:entityId/counterparty/:counterpartyId/vendor-credits/estimate-usage
GET
/entity/:entityId/counterparty/:counterpartyId/vendor-credits/estimate-usage
$curl -G https://api.mercoa.com/entity/ent_8545a84e-a45f-41bf-bdf1-33b42a55812c/counterparty/ent_21661ac1-a2a8-4465-a6c0-64474ba8181d/vendor-credits/estimate-usage \
>     -H "Authorization: Bearer <token>" \
>     -d amount=150 \
>     -d currency=USD
1{
2  "remainingAmount": 50,
3  "currency": "USD",
4  "vendorCredits": [
5    {
6      "id": "vcr_c3f4c87d-794d-4543-9562-575cdddfc0d7",
7      "vendorId": "ent_21661ac1-a2a8-4465-a6c0-64474ba8181d",
8      "payerId": "ent_8545a84e-a45f-41bf-bdf1-33b42a55812c",
9      "createdAt": "2021-01-01T00:00:00Z",
10      "updatedAt": "2021-01-01T00:00:00Z",
11      "memoNumber": "123456",
12      "totalAmount": 100,
13      "remainingAmount": 0,
14      "currency": "USD",
15      "creatorEntityId": "ent_21661ac1-a2a8-4465-a6c0-64474ba8181d",
16      "note": "This is a note",
17      "invoiceIds": [
18        "in_26e7b5d3-a739-4b23-9ad9-6aaa085f47a9"
19      ]
20    }
21  ]
22}
Estimate the usage of vendor credits on an invoice of a given amount
Was this page helpful?
Previous

Get all incoming email logs

Next
Built with

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

entityIdstringRequired
Entity ID or Entity ForeignID
counterpartyIdstringRequired
Counterparty Entity ID or Counterparty Entity ForeignID

Query parameters

amountdoubleRequired
The amount of the invoice to calculate vendor credit usage for.
currencyenumOptional
The currency of the invoice to calculate vendor credit usage for. Defaults to USD.
excludedInvoiceIdslist of stringsOptional
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.
includedVendorCreditIdslist of stringsOptional

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).

Response

The vendor credit usage estimate
remainingAmountdouble
Remaining amount on the invoice after vendor credits are applied in major units.
currencyenum
Currency code for the amount. Defaults to USD.
vendorCreditslist of objects
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.

Errors

400
Bad Request
401
Unauthorized
403
Forbidden
404
Not Found
409
Conflict
500
Internal Server Error
501
Unimplemented