Get | Mercoa | Documentation

from mercoa import Mercoa
client = Mercoa(
    token="YOUR_TOKEN",
)
client.entity.counterparty.vendor_credit.get(
    entity_id="ent_8545a84e-a45f-41bf-bdf1-33b42a55812c",
    counterparty_id="ent_21661ac1-a2a8-4465-a6c0-64474ba8181d",
    vendor_credit_id="vcr_c3f4c87d-794d-4543-9562-575cdddfc0d7",
)

{
  "id": "vcr_c3f4c87d-794d-4543-9562-575cdddfc0d7",
  "vendorId": "ent_21661ac1-a2a8-4465-a6c0-64474ba8181d",
  "payerId": "ent_8545a84e-a45f-41bf-bdf1-33b42a55812c",
  "createdAt": "2021-01-01T00:00:00Z",
  "updatedAt": "2021-01-01T00:00:00Z",
  "memoNumber": "123456",
  "totalAmount": 100,
  "remainingAmount": 100,
  "currency": "USD",
  "creatorEntityId": "ent_21661ac1-a2a8-4465-a6c0-64474ba8181d",
  "note": "This is a note",
  "invoiceIds": [
    "in_26e7b5d3-a739-4b23-9ad9-6aaa085f47a9"
  ]
}

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

vendorCreditIdstringRequired

ID of the vendor credit to retrieve

Response

This endpoint returns an object.

idstring

vendorIdstring

ID of the vendor the vendor credit may be used for

payerIdstring

ID of the payer who may use the vendor credit

createdAtdatetime

updatedAtdatetime

memoNumberstring

Memo number for the vendor credit

totalAmountdouble

Total issued amount of the vendor credit in major units

remainingAmountdouble

Remaining usable amount in the vendor credit in major units

currencyenum

Currency code for the amount. Defaults to USD.

creatorEntityIdstring

ID of the entity that created this vendor credit

notestring

An optional note to attach to the vendor credit

invoiceIdslist of strings

The IDs of the invoices that this vendor credit has been applied to

Errors

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

409

Conflict

500

Internal Server Error

501

Unimplemented