Retrieves a collection of supplier invoices.

Workday Resource Information

Retrieves the supplier invoice with the specified ID.

Secured by: Process: Supplier Invoice - Request, Self-Service: Supplier Invoice Request, View: Supplier Invoice Request

Scope: Supplier Accounts

Aggregate Fields

The provider represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is.

This information is derived from the Workday REST API specification which does not explicitly list all business rules and validations that apply to each object. More fields may be required than what is listed here.

Lines_Aggregate

[{
  billable: Boolean /* True if the supplier invoice request line or line split are billable. */
  descriptor: Text /* A preview of the instance */
  extendedAmount: Currency /* The extended amount for the document line.  Excludes extended amount on tax only invoices. */
  id: Text /* Id of the instance */
  internalMemo: Text /* The internal line memo for the supplier invoice request line. */
  item: { /* The item for the document line. */
     *id: Text /* wid / id / reference id */
  }
  itemDescription: Text /* The description of the item on the document line. This is a text-only value. */
  memo: Text /* The memo on the document line. */
  order: Text /* The order of the lines on a transaction. You can use this field to compare other transactions, such as supplier invoice matching events. */
  quantity: Numeric /* The quantity on the transaction line. This value can have 20 integer places, is precise to 2 decimal places, and can be negative. */
  serviceLine: Boolean /* The line type for supplier invoice request line. */
  spendCategory: { /* Returns the Spend Category defined on the Line for the Business Document Line Distribution. */
     *id: Text /* wid / id / reference id */
  }
  splitBy: { /* The distribution method for supplier invoice request line. */
     *id: Text /* wid / id / reference id */
  }
  splits: [{
      amount: Currency /* The amount on the transaction line split. This value displays in the same currency as the business document. */
      billable: Boolean /* True if the supplier invoice request line or line split are billable. */
      descriptor: Text /* A preview of the instance */
      id: Text /* Id of the instance */
      memo: Text /* The memo for a line split */
      percent: Numeric /* The percentage specified for the Business Document Line distribution line split. */
      quantity: Numeric /* The quantity specified for the Business Document Line distribution line split. */
      worktags: [{
          descriptor: Text /* A preview of the instance */
          id: Text /* Id of the instance */
      }]
  }]
  unitCost: Currency /* The unit cost for the document line. */
  unitOfMeasure: { /* The unit of measure for the document line. */
     *id: Text /* wid / id / reference id */
  }
  worktags: [{
      descriptor: Text /* A preview of the instance */
      id: Text /* Id of the instance */
  }]
}]

Columns

Name	Type	ReadOnly	Description
Id [KEY]	String	False	Id of the instance
Company_Descriptor	String	False	A description of the instance
Company_Href	String	False	A link to the instance
Company_Id	String	False	wid / id / reference id
ControlTotalAmount_Currency	String	False	The amount entered that should match the total of the line amounts.
ControlTotalAmount_Value	Decimal	False	The amount entered that should match the total of the line amounts.
Currency_CurrencyID	String	False	The Reference ID to use for lookups within our Workday Web Services. For supervisory organizations, this is also the 'Organization ID'
Currency_Descriptor	String	False	A preview of the instance
Currency_Id	String	False	wid / id / reference id
Descriptor	String	False	A preview of the instance
DueDate	Datetime	False	The due date for payment for this Supplier Invoice Request. Example: If the payment terms are Net 30, the Due Date field is 30 days after the invoice date.
FreightAmount_Currency	String	False	The freight amount for the supplier invoice request.
FreightAmount_Value	Decimal	False	The freight amount for the supplier invoice request.
HandlingCode_Descriptor	String	False	A description of the instance
HandlingCode_Href	String	False	A link to the instance
HandlingCode_Id	String	False	wid / id / reference id
InvoiceDate	Datetime	False	The date when a request for a supplier invoice is created.
InvoiceReceivedDate	Datetime	False	The date the invoice was recieved
Lines_Aggregate	String	False	The Supplier Invoice Request Lines for a Supplier Invoice Request.
Memo	String	False	The memo for the supplier invoice request.
PaymentTerms_Descriptor	String	False	A description of the instance
PaymentTerms_Href	String	False	A link to the instance
PaymentTerms_Id	String	False	wid / id / reference id
ReferenceNumber	String	False	The reference number that is encoded with key payment information on the invoice request document.
ReferenceType_Descriptor	String	False	A description of the instance
ReferenceType_Href	String	False	A link to the instance
ReferenceType_Id	String	False	wid / id / reference id
RemitToConnection_Descriptor	String	False	A description of the instance
RemitToConnection_Href	String	False	A link to the instance
RemitToConnection_Id	String	False	wid / id / reference id
RequestNumber	String	False	The unique number assigned to the Supplier Invoice Request at the time of creation.
Requester_Descriptor	String	False	A description of the instance
Requester_Href	String	False	A link to the instance
Requester_Id	String	False	wid / id / reference id
ShipToAddress_Descriptor	String	False	A description of the instance
ShipToAddress_Href	String	False	A link to the instance
ShipToAddress_Id	String	False	wid / id / reference id
Status_Descriptor	String	False	A description of the instance
Status_Href	String	False	A link to the instance
Status_Id	String	False	wid / id / reference id
StatutoryInvoiceType_Descriptor	String	False	A description of the instance
StatutoryInvoiceType_Href	String	False	A link to the instance
StatutoryInvoiceType_Id	String	False	wid / id / reference id
Supplier_Descriptor	String	False	A description of the instance
Supplier_Href	String	False	A link to the instance
Supplier_Id	String	False	wid / id / reference id
SuppliersInvoiceNumber	String	False	The reference number provided by the supplier for the supplier invoice request.
TaxAmount_Currency	String	False	Tax amount for the supplier invoice request.
TaxAmount_Value	Decimal	False	Tax amount for the supplier invoice request.
Company_Prompt	String	False	The company for the Common Financial Dimensions. This is for internal use only on a REST API.
FromDueDate_Prompt	Date	False	The beginning date of the payment due period for this supplier invoice request. Use the MM/DD/YYYY format. Example: When the payment term is Net 30, the due date value is the day from this invoice date.
FromInvoiceDate_Prompt	Date	False	The date on or after which the supplier invoice is created using the MM/DD/YYYY format.
Requester_Prompt	String	False	The ID of the worker generating the supplier invoice request.
Status_Prompt	String	False	The status of the supplier invoice request. This is for internal use only on a REST API.
Supplier_Prompt	String	False	The supplier on the business documents.
ToDueDate_Prompt	Date	False	The end date of the payment due period for this supplier invoice request. Use the MM/DD/YYYY format. Example: When the payment term is Net 30, the due date value is 30 days from the invoice date.
ToInvoiceDate_Prompt	Date	False	The date on or before which the supplier invoice is created using the MM/DD/YYYY format.