Search invoice templates

GET

https://api.mercoa.com/invoice-templates

GET

/invoice-templates

1 from mercoa import Mercoa
2 
3 client = Mercoa(
4     token="YOUR_TOKEN",
5 )
6 client.invoice_template.find(
7     entity_id="ent_8545a84e-a45f-41bf-bdf1-33b42a55812c",
8 )

Try it

200Find invoice templates created by a specific entity

1 {
2   "count": 10,
3   "hasMore": true,
4   "data": [
5     {
6       "approvalPolicy": [
7         {
8           "id": "apvl_8545a84e-a45f-41bf-bdf1-33b42a55812c",
9           "trigger": [
10             {
11               "type": "amount",
12               "amount": 100,
13               "currency": "USD"
14             }
15           ],
16           "rule": {
17             "type": "approver",
18             "identifierList": {
19               "type": "rolesList",
20               "value": [
21                 "Admin",
22                 "Controller"
23               ]
24             },
25             "numApprovers": 2
26           },
27           "upstreamPolicyId": "root",
28           "createdAt": "2024-01-01T00:00:00Z",
29           "updatedAt": "2024-01-02T00:00:00Z"
30         }
31       ],
32       "approvers": [
33         {
34           "approvalPolicyId": "apvl_5ce50275-1789-42ea-bc60-bb7e6d03635c",
35           "approvalSlotId": "inap_9bb311c9-7c15-4c9e-8148-63814e0abec6",
36           "action": "APPROVE",
37           "eligibleRoles": [
38             "admin"
39           ],
40           "eligibleUserIds": [
41             "user_e24fc81c-c5ee-47e8-af42-4fe29d895506"
42           ],
43           "date": "2021-01-01T00:00:00Z",
44           "assignedUserId": "user_e24fc81c-c5ee-47e8-af42-4fe29d895506"
45         }
46       ],
47       "createdAt": "2021-01-01T00:00:00Z",
48       "hasDocuments": true,
49       "hasSourceEmail": true,
50       "id": "invt_13c07096-5848-4aeb-ae7d-6576289034c4",
51       "metadata": {
52         "key1": "value1",
53         "key2": "value2"
54       },
55       "paymentDestinationConfirmed": true,
56       "status": "SCHEDULED",
57       "updatedAt": "2021-01-01T00:00:00Z",
58       "amount": 100,
59       "creatorUser": {
60         "id": "user_ec3aafc8-ea86-408a-a6c1-545497badbbb",
61         "roles": [
62           "admin",
63           "approver"
64         ],
65         "createdAt": "2024-01-01T00:00:00Z",
66         "updatedAt": "2024-01-01T00:00:00Z",
67         "foreignId": "MY-DB-ID-12345",
68         "email": "john.doe@acme.com",
69         "name": "John Doe"
70       },
71       "currency": "USD",
72       "deductionDate": "2021-01-01T00:00:00Z",
73       "invoiceDate": "2021-01-01T00:00:00Z",
74       "invoiceNumber": "INV-123",
75       "lineItems": [
76         {
77           "id": "inli_26672f38-eb9a-48f1-a7a0-f1b855e38cd7",
78           "currency": "USD",
79           "category": "EXPENSE",
80           "createdAt": "2021-01-01T00:00:00Z",
81           "updatedAt": "2021-01-01T00:00:00Z",
82           "amount": 100,
83           "description": "Product A",
84           "name": "Product A",
85           "quantity": 1,
86           "unitPrice": 100,
87           "serviceStartDate": "2021-01-01T00:00:00Z",
88           "serviceEndDate": "2021-01-31T00:00:00Z",
89           "metadata": {
90             "key1": "value1",
91             "key2": "value2"
92           },
93           "glAccountId": "600394"
94         }
95       ],
96       "noteToSelf": "For the month of January",
97       "payer": {
98         "acceptedTos": true,
99         "accountType": "business",
100         "createdAt": "2024-01-01T00:00:00Z",
101         "email": "customer@acme.com",
102         "id": "ent_8545a84e-a45f-41bf-bdf1-33b42a55812c",
103         "isCustomer": true,
104         "isNetworkPayee": false,
105         "isNetworkPayor": false,
106         "isPayee": false,
107         "isPayor": true,
108         "name": "Acme Inc.",
109         "profile": {
110           "business": {
111             "legalBusinessName": "Acme Inc.",
112             "taxIDProvided": true,
113             "email": "customer@acme.com",
114             "businessType": "llc",
115             "phone": {
116               "countryCode": "1",
117               "number": "4155551234"
118             },
119             "address": {
120               "addressLine1": "123 Main St",
121               "city": "San Francisco",
122               "stateOrProvince": "CA",
123               "postalCode": "94105",
124               "addressLine2": "Unit 1",
125               "country": "US"
126             },
127             "ownersProvided": true,
128             "taxId": {
129               "ein": {
130                 "number": "12-3456789"
131               }
132             }
133           }
134         },
135         "status": "verified",
136         "updatedAt": "2024-01-02T00:00:00Z",
137         "accounts": [
138           {
139             "accountId": "85866843",
140             "postalCode": "94105",
141             "nameOnAccount": "John Doe"
142           }
143         ],
144         "counterpartyType": [
145           "ENTITY"
146         ],
147         "foreignId": "MY-DB-ID-12345",
148         "paymentMethods": [
149           {
150             "type": "bankAccount",
151             "accountName": "My Checking Account",
152             "accountNumber": "99988767623",
153             "accountType": "CHECKING",
154             "bankName": "Chase",
155             "createdAt": "2021-01-01T00:00:00Z",
156             "frozen": false,
157             "id": "pm_4794d597-70dc-4fec-b6ec-c5988e759769",
158             "isDefaultDestination": true,
159             "isDefaultSource": true,
160             "metadata": {},
161             "routingNumber": "12345678",
162             "status": "VERIFIED",
163             "supportedCurrencies": [
164               "USD"
165             ],
166             "updatedAt": "2021-01-01T00:00:00Z",
167             "confirmedByEntity": true
168           }
169         ]
170       },
171       "payerId": "ent_8545a84e-a45f-41bf-bdf1-33b42a55812c",
172       "paymentDestination": {
173         "type": "check",
174         "addressLine1": "123 Main St",
175         "city": "New York",
176         "country": "US",
177         "createdAt": "2021-01-01T00:00:00Z",
178         "frozen": false,
179         "id": "pm_5fde2f4a-facc-48ef-8f0d-6b7d087c7b18",
180         "isDefaultDestination": true,
181         "isDefaultSource": false,
182         "metadata": {},
183         "payToTheOrderOf": "John Doe",
184         "postalCode": "10001",
185         "stateOrProvince": "NY",
186         "supportedCurrencies": [
187           "USD"
188         ],
189         "updatedAt": "2021-01-01T00:00:00Z",
190         "addressLine2": "Apt 1",
191         "confirmedByEntity": true
192       },
193       "paymentDestinationId": "pm_5fde2f4a-facc-48ef-8f0d-6b7d087c7b18",
194       "paymentDestinationOptions": {
195         "type": "check",
196         "delivery": "MAIL",
197         "printDescription": true
198       },
199       "paymentSource": {
200         "type": "bankAccount",
201         "accountName": "My Checking Account",
202         "accountNumber": "99988767623",
203         "accountType": "CHECKING",
204         "bankName": "Chase",
205         "createdAt": "2021-01-01T00:00:00Z",
206         "frozen": false,
207         "id": "pm_4794d597-70dc-4fec-b6ec-c5988e759769",
208         "isDefaultDestination": true,
209         "isDefaultSource": true,
210         "metadata": {},
211         "routingNumber": "12345678",
212         "status": "VERIFIED",
213         "supportedCurrencies": [
214           "USD"
215         ],
216         "updatedAt": "2021-01-01T00:00:00Z",
217         "confirmedByEntity": true
218       },
219       "paymentSourceId": "pm_4794d597-70dc-4fec-b6ec-c5988e759769",
220       "serviceEndDate": "2021-01-31T00:00:00Z",
221       "serviceStartDate": "2021-01-01T00:00:00Z",
222       "vendor": {
223         "acceptedTos": false,
224         "accountType": "business",
225         "createdAt": "2024-01-01T00:00:00Z",
226         "email": "vendor@bigboxstore.com",
227         "id": "ent_21661ac1-a2a8-4465-a6c0-64474ba8181d",
228         "isCustomer": false,
229         "isNetworkPayee": false,
230         "isNetworkPayor": false,
231         "isPayee": true,
232         "isPayor": false,
233         "name": "Big Box Store",
234         "profile": {
235           "business": {
236             "legalBusinessName": "Big Box Store",
237             "taxIDProvided": false,
238             "email": "vendor@bigboxstore.com",
239             "businessType": "publicCorporation",
240             "ownersProvided": false
241           }
242         },
243         "status": "unverified",
244         "updatedAt": "2024-01-02T00:00:00Z",
245         "counterpartyType": [
246           "ENTITY"
247         ],
248         "foreignId": "MY-DB-ID-90909",
249         "paymentMethods": [
250           {
251             "type": "bankAccount",
252             "accountName": "Vendor Checking Account",
253             "accountNumber": "55934059697648",
254             "accountType": "CHECKING",
255             "bankName": "Chase",
256             "createdAt": "2021-01-01T00:00:00Z",
257             "frozen": false,
258             "id": "pm_7610541f-4619-4033-8620-cfccfb811293",
259             "isDefaultDestination": true,
260             "isDefaultSource": true,
261             "metadata": {},
262             "routingNumber": "66554433",
263             "status": "NEW",
264             "supportedCurrencies": [
265               "USD"
266             ],
267             "updatedAt": "2021-01-01T00:00:00Z",
268             "confirmedByEntity": false
269           }
270         ]
271       },
272       "vendorId": "ent_21661ac1-a2a8-4465-a6c0-64474ba8181d"
273     }
274   ]
275 }

Search invoice templates for all entities in the organization

Query parameters

entityIdstringOptional

Filter invoice templates by the ID or foreign ID of the entity that is the payer or the vendor of the invoice template.

startDatedatetimeOptional

Start date filter. Defaults to CREATED_AT unless specified the dateType is specified

endDatedatetimeOptional

End date filter. Defaults to CREATED_AT unless specified the dateType is specified

dateTypeenumOptional

Type of date to filter by if startDate and endDate filters are provided. Defaults to CREATED_AT.

orderByenumOptional

Field to order invoice templates by. Defaults to CREATED_AT.

orderDirectionenumOptional

Direction to order invoice templates by. Defaults to asc.

Allowed values:

limitintegerOptional

Number of invoice templates to return. Limit can range between 1 and 100, and the default is 10.

startingAfterstringOptional

The ID of the invoice template to start after. If not provided, the first page of invoice templates will be returned.

searchstringOptional

Find invoice templates by vendor name, check number, invoice number, or amount. Partial matches are supported.

metadataobjectOptional

Filter invoice templates by metadata. Each filter will be applied as an AND condition. Duplicate keys will be ignored.

lineItemMetadataobjectOptional

Filter invoice templates by line item metadata. Each filter will be applied as an AND condition. Duplicate keys will be ignored.

lineItemGlAccountIdstringOptional

Filter invoice templates by line item GL account ID. Each filter will be applied as an OR condition. Duplicate keys will be ignored.

payerIdstringOptional

Filter invoice templates by payer ID or payer foreign ID.

vendorIdstringOptional

Filter invoice templates by vendor ID or vendor foreign ID.

creatorUserIdstringOptional

Filter invoices by the ID or foreign ID of the user that created the invoice.

approverIdstringOptional

Filter invoice templates by assigned approver user ID.

approverActionenumOptional

Filter invoice templates by approver action. Needs to be used with approverId. For example, if you want to find all invoice templates that have been approved by a specific user, you would use approverId and approverAction=APPROVE.

Allowed values:

invoiceIdstringOptional

Filter invoice templates by invoice ID.

statusenumOptional

Invoice status to filter on

paymentTypelist of enumsOptional

Filter invoice templates by recurring status

Allowed values:

Response

This endpoint returns an object.

countinteger

Total number of invoice templates 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 invoice templates available for the given filters.

datalist of objects

Search invoice templates

Headers

Query parameters

Response

Errors