ListDocumentsCriteriaDto

Array of accountMetadata.account to filter the documents. Should ideally satisfy the /^[a-zA-Z0-9-_:.]+$/ pattern \\ Example:accountMetadata.account='ACC102030'&accountMetadata.account='405060' * @param accountMetadataAccountExists This is used to match and include documents where a value exists for the accountMetadata.account property. \\ Only true or false boolean values are accepted. A mix of operators with basic values is not supported. If accountMetadata.account.exists is provided together with plain values for account, this exists operator is ignored. \\ Example: To filter all documents with accountMetadata.account not set, use accountMetadata.account.exists=false * @param accountMetadataTransactionId Array of accountMetadata.transactionId to filter the documents. Should ideally satisfy the /^[a-zA-Z0-9-_:.]+$/ pattern. \\ Example:accountMetadata.transactionId='TX00001'&accountMetadata.transactionId='TX00002' * @param accountMetadataTransactionIdExists This is used to match and include documents where a value exists for the accountMetadata.transactionId property. \\ Only true or false boolean values are accepted. A mix of operators with basic values is not supported. If accountMetadata.transactionId.exists is provided together with plain values for account, this exists operator is ignored. \\ Example: To filter all documents with accountMetadata.transactionId not set, use accountMetadata.account.transactionId=false * @param amountDue Array of amountDue values to filter the documents. afterTax is the document property considered for the match. \\ Example:filter.amountDue=1000.55&filter.amountDue=1010.90 * @param amountDueGte This is a greater than or equal to filter on the amountDue value to filter the documents. afterTax is the document property considered for the match. \\ Example:filter.amountDue.gte=1000.55 * @param amountDueLte This is a lesser than or equal to filter on the amountDue value to filter the documents. afterTax is the document property considered for the match. \\ Example: amountDue.lte=1000.55 * @param arrivalDateTimeGte This is a filter condition greater than or equal on the arrivalDateTime to filter the documents. ArrivalDateTime value does not accept exact match and is expected to be UTC. Date time formats allowed are: YYYY-MM-DDTHH:mm:ss.SSS or YYYY-MM-DD HH:mm:ss.SSS. Time fields can be suppressed from the end to the beginning i.e. YYYY-MM-DD HH:mm is acceptable. * Example with just date: arrivalDateTime.gte='2012-12-28' * Example with date and time: arrivalDateTime.gte='2012-12-28T21:27' * Example with date and time: arrivalDateTime.gte='2012-12-28 21:27:55.827' * @param arrivalDateTimeLte This is a filter condition less than or equal on the arrivalDateTime to filter the documents. ArrivalDateTime value does not accept exact match and is expected to be UTC. Date time formats allowed are: YYYY-MM-DDTHH:mm:ss.SSS or YYYY-MM-DD HH:mm:ss.SSS. Time fields can be suppressed from the end to the beginning i.e. YYYY-MM-DD HH:mm is acceptable. * Example with just date: arrivalDateTime.lte='2012-12-28' * Example with date and time: arrivalDateTime.lte='2012-12-28T21:27' * Example with date and time: arrivalDateTime.lte='2012-12-28 21:27:55.827' * @param categoryCode Array of categoryCode to filter the documents. Example: categoryCode=['business'] * @param currencyCode Array of currencyCode to filter the documents. Example: currencyCode=['CAD', 'USD'] * @param description Array of description values to filter the documents. The filter is case insentive and matches any document where the description contains the given value. Should ideally satisfy the pattern /^a-zA-Z0-9 +$/ Example: description=['Dinner with friends','Children winter gear','My very specific description'] * @param documentDate Array of documentDate to filter the documents. Example: documentDate=['2021-04-04'] * @param documentDateGte This is a filter condition greater than or equal on the documentDate to filter the documents. \\ Example with single operator: documentDate.gte='2012-12-28' * @param documentDateLte This is a filter condition less than or equal on the documentDate to filter the documents. \\ Example with single operator: documentDate.lte='2023-12-28' * @param documentNumber Array of documentNumber to filter the documents. Example: documentNumber=['1122334455'] * @param documentTime Array of documentTime to filter the documents. Example: documentTime=['21:12', '22:13', '23:14'] * @param documentTimeGte This is a filter condition greater than or equal on the documentTime to filter the documents. Example with single operator: documentTime.gte='10:00' * @param documentTimeLte This is a filter condition less than or equal on the documentTime to filter the documents. Example with single operator: filter.documentTime.gte='10:00' * @param documentType Array of documentType to filter the documents. Currently supported values are invoice, receipt.

Array of foreignId to filter the documents.

Array of document id to filter the documents.

This is a filter condition greater than or equal on the lastUpdateDateTime to filter the documents. lastUpdateDateTime field does not accept exact match. Date time formats allowed are: YYYY-MM-DDTHH:mm:ss.SSS or YYYY-MM-DD HH:mm:ss.SSS. Time fields can be suppressed from the end to the beginning i.e. YYYY-MM-DD HH:mm is acceptable. * Example with just date: lastUpdateDateTime.gte='2012-12-28' * Example with date and time: lastUpdateDateTime.gte='2012-12-28T21:27' * Example with date and time: lastUpdateDateTime.gte='2012-12-28 21:27:55.827' * @param lastUpdateDateTimeLte This is a filter condition less than or equal on the lastUpdateDateTime to filter the documents. lastUpdateDateTime field does not accept exact match. Date time formats allowed are: YYYY-MM-DDTHH:mm:ss.SSS or YYYY-MM-DD HH:mm:ss.SSS. Time fields can be suppressed from the end to the beginning i.e. YYYY-MM-DD HH:mm is acceptable. * Example with just date: lastUpdateDateTime.lte='2012-12-28' * Example with date and time: lastUpdateDateTime.lte='2012-12-28T21:27' * Example with date and time: lastUpdateDateTime.lte='2012-12-28 21:27:55.827' * @param merchantName Array of merchantName to filter the documents.

Array of merchantTaxIdNumber to filter the documents.

Payment Tender array to filter the documents.

Array of total to filter the documents. The value considered is afterTax. Items in the array will compose a logial OR chain in the query. * @param totalGte This is a filter condition greater than or equal on the total value to filter the documents. The value considered is afterTax. All filter conditions will compose a logical AND chain in the query. \\ Example: total.gte=1000.55 * @param totalLte This is a filter condition less than or equal on the total value to filter the documents. The value considered is afterTax. All filter conditions will compose a logical AND chain in the query. \\ Example: total.lte=1000.55 * @param status Array of document status to use for the operation.

Array of sourceFormats for the operation.