Events — Mercoa | Documentation

Get all events for an invoice

Path parameters

invoiceIdstringRequired

Invoice ID or Invoice ForeignID

Query parameters

startDatedatetimeOptional

Start date filter. If not provided, events from the start of time will be returned.

endDatedatetimeOptional

End date filter. If not provided, events to the end of time will be returned.

Response

This endpoint returns an object.

datalist of objects

countinteger

1 curl https://api.mercoa.com/invoice/in_8545a84e-a45f-41bf-bdf1-33b42a55812c/events \ 2 -H "Authorization: Bearer <token>"

1 { 2 "data": [ 3 { 4 "webhookIds": [ 5 "webhook_12345" 6 ], 7 "data": { 8 "amount": 100, 9 "creatorEntityId": "ent_8545a84e-a45f-41bf-bdf1-33b42a55812c", 10 "creatorUserId": "user_e24fc81c-c5ee-47e8-af42-4fe29d895506", 11 "currency": "USD", 12 "dueDate": "2021-01-31T00:00:00Z", 13 "invoiceDate": "2021-01-01T00:00:00Z", 14 "invoiceNumber": "INV-123", 15 "lineItems": [ 16 { 17 "amount": 100, 18 "category": "EXPENSE", 19 "currency": "USD", 20 "description": "Product A", 21 "glAccountId": "600394", 22 "id": "inli_26672f38-eb9a-48f1-a7a0-f1b855e38cd7", 23 "metadata": { 24 "key1": "value1", 25 "key2": "value2" 26 }, 27 "name": "Product A", 28 "quantity": 1, 29 "serviceEndDate": "2021-01-31T00:00:00Z", 30 "serviceStartDate": "2021-01-01T00:00:00Z", 31 "unitPrice": 100 32 } 33 ], 34 "noteToSelf": "For the month of January", 35 "payerId": "ent_8545a84e-a45f-41bf-bdf1-33b42a55812c", 36 "paymentDestinationId": "pm_5fde2f4a-facc-48ef-8f0d-6b7d087c7b18", 37 "paymentDestinationOptions": { 38 "type": "check", 39 "delivery": "MAIL", 40 "printDescription": true 41 }, 42 "paymentSourceId": "pm_4794d597-70dc-4fec-b6ec-c5988e759769", 43 "status": "NEW", 44 "vendorId": "ent_21661ac1-a2a8-4465-a6c0-64474ba8181d" 45 }, 46 "createdAt": "2024-01-01T00:00:00.000Z", 47 "userId": "user_e24fc81c-c5ee-47e8-af42-4fe29d895506" 48 } 49 ], 50 "count": 1 51 }

1	curl https://api.mercoa.com/invoice/in_8545a84e-a45f-41bf-bdf1-33b42a55812c/events \
2	-H "Authorization: Bearer <token>"

1	{
2	"data": [
3	{
4	"webhookIds": [
5	"webhook_12345"
6	],
7	"data": {
8	"amount": 100,
9	"creatorEntityId": "ent_8545a84e-a45f-41bf-bdf1-33b42a55812c",
10	"creatorUserId": "user_e24fc81c-c5ee-47e8-af42-4fe29d895506",
11	"currency": "USD",
12	"dueDate": "2021-01-31T00:00:00Z",
13	"invoiceDate": "2021-01-01T00:00:00Z",
14	"invoiceNumber": "INV-123",
15	"lineItems": [
16	{
17	"amount": 100,
18	"category": "EXPENSE",
19	"currency": "USD",
20	"description": "Product A",
21	"glAccountId": "600394",
22	"id": "inli_26672f38-eb9a-48f1-a7a0-f1b855e38cd7",
23	"metadata": {
24	"key1": "value1",
25	"key2": "value2"
26	},
27	"name": "Product A",
28	"quantity": 1,
29	"serviceEndDate": "2021-01-31T00:00:00Z",
30	"serviceStartDate": "2021-01-01T00:00:00Z",
31	"unitPrice": 100
32	}
33	],
34	"noteToSelf": "For the month of January",
35	"payerId": "ent_8545a84e-a45f-41bf-bdf1-33b42a55812c",
36	"paymentDestinationId": "pm_5fde2f4a-facc-48ef-8f0d-6b7d087c7b18",
37	"paymentDestinationOptions": {
38	"type": "check",
39	"delivery": "MAIL",
40	"printDescription": true
41	},
42	"paymentSourceId": "pm_4794d597-70dc-4fec-b6ec-c5988e759769",
43	"status": "NEW",
44	"vendorId": "ent_21661ac1-a2a8-4465-a6c0-64474ba8181d"
45	},
46	"createdAt": "2024-01-01T00:00:00.000Z",
47	"userId": "user_e24fc81c-c5ee-47e8-af42-4fe29d895506"
48	}
49	],
50	"count": 1
51	}