Get All — Mercoa | Documentation

Path parameters

entityIdstringRequired

Entity ID or Entity ForeignID

counterpartyIdstringRequired

Counterparty Entity ID or Counterparty Entity ForeignID

Response

This endpoint returns an object.

countinteger

Total number of vendor credits for the given filters. This value is not limited by the limit parameter. It is provided so that you can determine how many pages of results are available.

hasMoreboolean

True if there are more vendor credits available for the given filters.

datalist of objects

1 curl https://api.mercoa.com/entity/ent_8545a84e-a45f-41bf-bdf1-33b42a55812c/counterparty/ent_21661ac1-a2a8-4465-a6c0-64474ba8181d/vendor-credits \ 2 -H "Authorization: Bearer <token>"

1 { 2 "count": 1, 3 "hasMore": false, 4 "data": [ 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 "totalAmount": 100, 12 "remainingAmount": 100, 13 "currency": "USD", 14 "creatorEntityId": "ent_21661ac1-a2a8-4465-a6c0-64474ba8181d", 15 "note": "This is a note", 16 "invoiceIds": [ 17 "in_26e7b5d3-a739-4b23-9ad9-6aaa085f47a9" 18 ] 19 } 20 ] 21 }

1	curl https://api.mercoa.com/entity/ent_8545a84e-a45f-41bf-bdf1-33b42a55812c/counterparty/ent_21661ac1-a2a8-4465-a6c0-64474ba8181d/vendor-credits \
2	-H "Authorization: Bearer <token>"

1	{
2	"count": 1,
3	"hasMore": false,
4	"data": [
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	"totalAmount": 100,
12	"remainingAmount": 100,
13	"currency": "USD",
14	"creatorEntityId": "ent_21661ac1-a2a8-4465-a6c0-64474ba8181d",
15	"note": "This is a note",
16	"invoiceIds": [
17	"in_26e7b5d3-a739-4b23-9ad9-6aaa085f47a9"
18	]
19	}
20	]
21	}