/** * This file was auto-generated by Fern from our API Definition. */ import * as Mercoa from "../../../../index.js"; /** * @example * { * entityId: "ent_8545a84e-a45f-41bf-bdf1-33b42a55812c" * } */ export interface GetAllInvoiceTemplatesRequest { /** Filter invoice templates by the ID or foreign ID of the entity that is the payer or the vendor of the invoice template. */ entityId?: Mercoa.EntityId | Mercoa.EntityId[]; /** Start date filter. Defaults to CREATED_AT unless specified the dateType is specified */ startDate?: Date; /** End date filter. Defaults to CREATED_AT unless specified the dateType is specified */ endDate?: Date; /** Type of date to filter by if startDate and endDate filters are provided. Defaults to CREATED_AT. */ dateType?: Mercoa.InvoiceDateFilter; /** Field to order invoice templates by. Defaults to CREATED_AT. */ orderBy?: Mercoa.InvoiceOrderByField; /** Direction to order invoice templates by. Defaults to asc. */ orderDirection?: Mercoa.OrderDirection; /** Number of invoice templates to return. Limit can range between 1 and 100, and the default is 10. */ limit?: number; /** The ID of the invoice template to start after. If not provided, the first page of invoice templates will be returned. */ startingAfter?: Mercoa.InvoiceTemplateId; /** Find invoice templates by vendor name, check number, invoice number, or amount. Partial matches are supported. */ search?: string; /** Filter invoice templates by metadata. Each filter will be applied as an AND condition. Duplicate keys will be ignored. */ metadata?: Mercoa.MetadataFilter | Mercoa.MetadataFilter[]; /** Filter invoice templates by line item metadata. Each filter will be applied as an AND condition. Duplicate keys will be ignored. */ lineItemMetadata?: Mercoa.MetadataFilter | Mercoa.MetadataFilter[]; /** Filter invoice templates by line item GL account ID. Each filter will be applied as an OR condition. Duplicate keys will be ignored. */ lineItemGlAccountId?: string | string[]; /** Filter invoice templates by payer ID or payer foreign ID. */ payerId?: Mercoa.EntityId | Mercoa.EntityId[]; /** Filter invoice templates by vendor ID or vendor foreign ID. */ vendorId?: Mercoa.EntityId | Mercoa.EntityId[]; /** Filter invoices by the ID or foreign ID of the user that created the invoice. */ creatorUserId?: Mercoa.EntityUserId | Mercoa.EntityUserId[]; /** Filter invoice templates by assigned approver user ID. */ approverId?: Mercoa.EntityUserId | Mercoa.EntityUserId[]; /** 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. */ approverAction?: Mercoa.ApproverAction | Mercoa.ApproverAction[]; /** Filter invoice templates by invoice ID. */ invoiceId?: Mercoa.InvoiceId | Mercoa.InvoiceId[]; /** Invoice status to filter on */ status?: Mercoa.InvoiceStatus | Mercoa.InvoiceStatus[]; /** Filter invoice templates by recurring status */ paymentType?: Mercoa.PaymentType[]; }