Filter Parameters for the Operational Reporting API

The following filter parameters can be used in view templates, passed in the request body, or included as part of the query URL:

Parameter

Available In...

Description

approvalDateFrom

Invoice, Purchase Requisition

Specify the document approval date range.

approvalDateTo

createdDateFrom

All transaction types

Specify document creation date range.

createdDateTo

updatedDateFrom

All transaction types

Specify document update date range.

updatedDateTo

status

All transaction types

Status of the document. See Status values by transaction type for permissible values.

UniqueNames

All transaction types

Specify the documents to be approved by their unique names. For details about how to use this parameters, see the table entry for filterExpressions in View Template Structure.

Status Values by Transaction Type

This table lists the possible values of status for each transaction type.

Transaction Type

Status Values

Requisition

  • Approved

  • Canceled

  • Canceling

  • Collaborating

  • Collaboration

  • Completed

  • Composing

  • Denied

  • Invalid

  • Ordered

  • Ordering

  • Received

  • Receiving

  • Submitted

Purchase order including ERPOrder, DirectOrder, and CopyOrder

  • Approved

  • Canceled

  • Canceling

  • Confirmed

  • Confirming

  • Ordered

  • Ordering

  • Received

  • Receiving

  • Shipped

  • Shipping

Receipt

  • Approved

  • Composing

  • Denied

  • FailedProcessing

  • InvoiceCreated

  • Invoiced

  • Invoicing

  • Processed

  • Submitted

Invoice

  • Unprocessed

  • Rejecting

  • Paying

  • Rejected

  • Paid

  • FailedRejecting

  • FailedPaying

  • Canceled

  • Invalid

  • AwaitingExternalResolution

  • FailedExternalPush

Invoice Reconciliation

  • Approving

  • Canceled

  • FailedPaying

  • Paid

  • Paying

  • Reconciling

  • Rejected

Contract

  • Created

  • Processed

  • Open

  • Received

  • Invoiced

  • Inactive

  • Closed

  • Sending