Events

GET

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

GET

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

200Retrieved

1 {
2   "data": [
3     {
4       "webhookIds": [
5         "webhook_12345"
6       ],
7       "data": {
8         "id": "inv_26e7b5d3-a739-4b23-9ad9-6aaa085f47a9",
9         "status": "DRAFT",
10         "paymentDestinationConfirmed": true,
11         "hasDocuments": true,
12         "hasSourceEmail": true,
13         "approvers": [],
14         "approvalPolicy": [],
15         "metadata": {},
16         "createdAt": "2021-01-01T00:00:00Z",
17         "updatedAt": "2021-01-01T00:00:00Z",
18         "payerId": "ent_8545a84e-a45f-41bf-bdf1-33b42a55812c",
19         "payer": {
20           "acceptedTos": true,
21           "accountType": "business",
22           "createdAt": "2024-01-01T00:00:00Z",
23           "email": "customer@acme.com",
24           "id": "ent_8545a84e-a45f-41bf-bdf1-33b42a55812c",
25           "isCustomer": true,
26           "isNetworkPayee": false,
27           "isNetworkPayor": false,
28           "isPayee": false,
29           "isPayor": true,
30           "name": "Acme Inc.",
31           "profile": {
32             "business": {
33               "legalBusinessName": "Acme Inc.",
34               "taxIDProvided": true,
35               "email": "customer@acme.com",
36               "businessType": "llc",
37               "phone": {
38                 "countryCode": "1",
39                 "number": "4155551234"
40               },
41               "address": {
42                 "addressLine1": "123 Main St",
43                 "city": "San Francisco",
44                 "stateOrProvince": "CA",
45                 "postalCode": "94105",
46                 "addressLine2": "Unit 1",
47                 "country": "US"
48               },
49               "ownersProvided": true
50             }
51           },
52           "status": "verified",
53           "updatedAt": "2024-01-02T00:00:00Z",
54           "accounts": [
55             {
56               "accountId": "85866843",
57               "postalCode": "94105",
58               "nameOnAccount": "John Doe"
59             }
60           ],
61           "counterpartyType": [
62             "ENTITY"
63           ],
64           "foreignId": "MY-DB-ID-12345",
65           "paymentMethods": [
66             {
67               "type": "bankAccount",
68               "accountName": "My Checking Account",
69               "accountNumber": "99988767623",
70               "accountType": "CHECKING",
71               "bankName": "Chase",
72               "createdAt": "2021-01-01T00:00:00Z",
73               "frozen": false,
74               "id": "pm_4794d597-70dc-4fec-b6ec-c5988e759769",
75               "isDefaultDestination": true,
76               "isDefaultSource": true,
77               "metadata": {},
78               "routingNumber": "12345678",
79               "status": "VERIFIED",
80               "supportedCurrencies": [
81                 "USD"
82               ],
83               "updatedAt": "2021-01-01T00:00:00Z"
84             }
85           ]
86         }
87       },
88       "createdAt": "2024-01-01T00:00:00.000Z",
89       "userId": "user_e24fc81c-c5ee-47e8-af42-4fe29d895506"
90     }
91   ],
92   "count": 1
93 }

Built with

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

1	{
2	"data": [
3	{
4	"webhookIds": [
5	"webhook_12345"
6	],
7	"data": {
8	"id": "inv_26e7b5d3-a739-4b23-9ad9-6aaa085f47a9",
9	"status": "DRAFT",
10	"paymentDestinationConfirmed": true,
11	"hasDocuments": true,
12	"hasSourceEmail": true,
13	"approvers": [],
14	"approvalPolicy": [],
15	"metadata": {},
16	"createdAt": "2021-01-01T00:00:00Z",
17	"updatedAt": "2021-01-01T00:00:00Z",
18	"payerId": "ent_8545a84e-a45f-41bf-bdf1-33b42a55812c",
19	"payer": {
20	"acceptedTos": true,
21	"accountType": "business",
22	"createdAt": "2024-01-01T00:00:00Z",
23	"email": "customer@acme.com",
24	"id": "ent_8545a84e-a45f-41bf-bdf1-33b42a55812c",
25	"isCustomer": true,
26	"isNetworkPayee": false,
27	"isNetworkPayor": false,
28	"isPayee": false,
29	"isPayor": true,
30	"name": "Acme Inc.",
31	"profile": {
32	"business": {
33	"legalBusinessName": "Acme Inc.",
34	"taxIDProvided": true,
35	"email": "customer@acme.com",
36	"businessType": "llc",
37	"phone": {
38	"countryCode": "1",
39	"number": "4155551234"
40	},
41	"address": {
42	"addressLine1": "123 Main St",
43	"city": "San Francisco",
44	"stateOrProvince": "CA",
45	"postalCode": "94105",
46	"addressLine2": "Unit 1",
47	"country": "US"
48	},
49	"ownersProvided": true
50	}
51	},
52	"status": "verified",
53	"updatedAt": "2024-01-02T00:00:00Z",
54	"accounts": [
55	{
56	"accountId": "85866843",
57	"postalCode": "94105",
58	"nameOnAccount": "John Doe"
59	}
60	],
61	"counterpartyType": [
62	"ENTITY"
63	],
64	"foreignId": "MY-DB-ID-12345",
65	"paymentMethods": [
66	{
67	"type": "bankAccount",
68	"accountName": "My Checking Account",
69	"accountNumber": "99988767623",
70	"accountType": "CHECKING",
71	"bankName": "Chase",
72	"createdAt": "2021-01-01T00:00:00Z",
73	"frozen": false,
74	"id": "pm_4794d597-70dc-4fec-b6ec-c5988e759769",
75	"isDefaultDestination": true,
76	"isDefaultSource": true,
77	"metadata": {},
78	"routingNumber": "12345678",
79	"status": "VERIFIED",
80	"supportedCurrencies": [
81	"USD"
82	],
83	"updatedAt": "2021-01-01T00:00:00Z"
84	}
85	]
86	}
87	},
88	"createdAt": "2024-01-01T00:00:00.000Z",
89	"userId": "user_e24fc81c-c5ee-47e8-af42-4fe29d895506"
90	}
91	],
92	"count": 1
93	}