invoice-template

Search invoice templates

Search invoice templates for all entities in the organization

get/invoice-templates

Request

  • Base URL: https://api.mercoa.com
  • URL: https://api.mercoa.com/invoice-templates
  • Auth: HTTP bearer

Query parameters

entityIdstring

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

startDatestring date-time

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

endDatestring date-time

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

dateType'INVOICE_DATE' | 'DEDUCTION_DATE' | 'DUE_DATE' | 'SETTLEMENT_DATE' | 'CREATED_AT' | 'UPDATED_AT'

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

orderBy'AMOUNT' | 'DUE_DATE' | 'CREATED_AT' | 'UPDATED_AT' | 'DEDUCTION_DATE' | 'INVOICE_DATE' | 'SETTLEMENT_DATE' | 'INVOICE_NUMBER' | 'VENDOR_NAME' | 'PAYER_NAME'

Field to order invoice templates by. Defaults to CREATED_AT.

orderDirection'ASC' | 'DESC'

Direction to order invoice templates by. Defaults to asc.

limitinteger

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

startingAfterstring

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

searchstring

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

keystring required

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

keystring required

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

lineItemGlAccountIdstring

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

payerIdstring

Filter invoice templates by payer ID or payer foreign ID.

vendorIdstring

Filter invoice templates by vendor ID or vendor foreign ID.

creatorUserIdstring

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

approverIdstring

Filter invoice templates by assigned approver user ID.

approverAction'NONE' | 'APPROVE' | 'REJECT'

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.

invoiceIdstring

Filter invoice templates by invoice ID.

status'UNASSIGNED' | 'DRAFT' | 'NEW' | 'APPROVED' | 'SCHEDULED' | 'PENDING' | 'PAID' | 'ARCHIVED' | 'REFUSED' | 'CANCELED' | 'FAILED'

Invoice status to filter on

paymentTypeInvoiceTypesPaymentType[]

Filter invoice templates by recurring status

Response

Response with status 200

countinteger required

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 required

True if there are more invoice templates available for the given filters.

Changes

No recorded changes to this operation across all 1 revision of this API.