workday-accounts-payable

Workday Accounts Payable - supplier invoice requests, attachments, lines

Server path: /workday-accounts-payable | Type: Application | PCID required: Yes

Tools

Tool	Description
workday_accounts_payable_get_supplierinvoicerequests	Retrieves a collection of supplier invoices.
workday_accounts_payable_get_supplierinvoicerequests_by_id	Retrieves a single supplier invoice instance.
workday_accounts_payable_get_supplierinvoicerequests_by_id_attachments	Retrieves a collection of attachments for the specified supplier invoice.
workday_accounts_payable_get_supplierinvoicerequests_by_id_attachments_by_subresourceid	Retrieves a single attachment instance.
workday_accounts_payable_get_supplierinvoicerequests_by_id_attachments_by_subresourceid_viewcontent	<b>Secured by:</b> Process: Supplier Invoice - Request, View: Supplier Invoice Request <b>Scope:</b> Supplier Accounts Contains attachment(s)
workday_accounts_payable_get_supplierinvoicerequests_by_id_attachments_viewcontent	<b>Secured by:</b> Process: Supplier Invoice - Request, View: Supplier Invoice Request <b>Scope:</b> Supplier Accounts Contains attachment(s)
workday_accounts_payable_get_supplierinvoicerequests_by_id_lines	Retrieves a collection of supplier invoice lines.
workday_accounts_payable_get_supplierinvoicerequests_by_id_lines_by_subresourceid	Retrieves a single supplier invoice line instance.
workday_accounts_payable_post_sendsupplierinvoiceattachmentsforscanning	Sends supplier invoice attachments for scanning.
workday_accounts_payable_post_supplierinvoicerequests	Creates the supplier invoice as specified in the request.
workday_accounts_payable_post_supplierinvoicerequests_by_id_attachments	Creates a new attachment for the supplier invoice.
workday_accounts_payable_post_supplierinvoicerequests_by_id_submit	Submits a single supplier invoice instance.

---

workday_accounts_payable_get_supplierinvoicerequests

Retrieves a collection of supplier invoices.

Parameters:

Parameter	Type	Required	Default	Description
company	string[]	No	—	The company for the Common Financial Dimensions. This is for internal use only on a REST API.
fromDueDate	string	No	—	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	string	No	—	The date on or after which the supplier invoice is created using the MM/DD/YYYY format.
limit	integer	No	—	The maximum number of objects in a single response. The default is 20. The maximum is 100.
offset	integer	No	—	The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.
requester	string[]	No	—	The ID of the worker generating the supplier invoice request.
status	string[]	No	—	The status of the supplier invoice request. This is for internal use only on a REST API.
supplier	string[]	No	—	The supplier on the business documents.
toDueDate	string	No	—	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	string	No	—	The date on or before which the supplier invoice is created using the MM/DD/YYYY format.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "company": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The company for the Common Financial Dimensions. This is for internal use only on a REST API."
    },
    "fromDueDate": {
      "type": "string",
      "description": "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": {
      "type": "string",
      "description": "The date on or after which the supplier invoice is created using the MM/DD/YYYY format."
    },
    "limit": {
      "type": "integer",
      "description": "The maximum number of objects in a single response. The default is 20. The maximum is 100."
    },
    "offset": {
      "type": "integer",
      "description": "The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object."
    },
    "requester": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The ID of the worker generating the supplier invoice request."
    },
    "status": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The status of the supplier invoice request. This is for internal use only on a REST API."
    },
    "supplier": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The supplier on the business documents."
    },
    "toDueDate": {
      "type": "string",
      "description": "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": {
      "type": "string",
      "description": "The date on or before which the supplier invoice is created using the MM/DD/YYYY format."
    }
  },
  "required": [
    "PCID"
  ]
}

---

workday_accounts_payable_get_supplierinvoicerequests_by_id

Retrieves a single supplier invoice instance.

Parameters:

Parameter	Type	Required	Default	Description
ID	string	Yes	—	The Workday ID of the resource.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "ID": {
      "type": "string",
      "description": "The Workday ID of the resource."
    }
  },
  "required": [
    "PCID",
    "ID"
  ]
}

---

workday_accounts_payable_get_supplierinvoicerequests_by_id_attachments

Retrieves a collection of attachments for the specified supplier invoice.

Parameters:

Parameter	Type	Required	Default	Description
ID	string	Yes	—	The Workday ID of the resource.
limit	integer	No	—	The maximum number of objects in a single response. The default is 20. The maximum is 100.
offset	integer	No	—	The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "ID": {
      "type": "string",
      "description": "The Workday ID of the resource."
    },
    "limit": {
      "type": "integer",
      "description": "The maximum number of objects in a single response. The default is 20. The maximum is 100."
    },
    "offset": {
      "type": "integer",
      "description": "The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object."
    }
  },
  "required": [
    "PCID",
    "ID"
  ]
}

---

workday_accounts_payable_get_supplierinvoicerequests_by_id_attachments_by_subresourceid

Retrieves a single attachment instance.

Parameters:

Parameter	Type	Required	Default	Description
ID	string	Yes	—	The Workday ID of the resource.
subresourceID	string	Yes	—	The Workday ID of the subresource.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "ID": {
      "type": "string",
      "description": "The Workday ID of the resource."
    },
    "subresourceID": {
      "type": "string",
      "description": "The Workday ID of the subresource."
    }
  },
  "required": [
    "PCID",
    "ID",
    "subresourceID"
  ]
}

---

workday_accounts_payable_get_supplierinvoicerequests_by_id_attachments_by_subresourceid_viewcontent

<b>Secured by:</b> Process: Supplier Invoice - Request, View: Supplier Invoice Request <b>Scope:</b> Supplier Accounts Contains attachment(s)

Parameters:

Parameter	Type	Required	Default	Description
ID	string	Yes	—	The Workday ID of the resource.
subresourceID	string	Yes	—	The Workday ID of the subresource.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "ID": {
      "type": "string",
      "description": "The Workday ID of the resource."
    },
    "subresourceID": {
      "type": "string",
      "description": "The Workday ID of the subresource."
    }
  },
  "required": [
    "PCID",
    "ID",
    "subresourceID"
  ]
}

---

workday_accounts_payable_get_supplierinvoicerequests_by_id_attachments_viewcontent

<b>Secured by:</b> Process: Supplier Invoice - Request, View: Supplier Invoice Request <b>Scope:</b> Supplier Accounts Contains attachment(s)

Parameters:

Parameter	Type	Required	Default	Description
ID	string	Yes	—	The Workday ID of the resource.
limit	integer	No	—	The maximum number of objects in a single response. The default is 20. The maximum is 100.
offset	integer	No	—	The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "ID": {
      "type": "string",
      "description": "The Workday ID of the resource."
    },
    "limit": {
      "type": "integer",
      "description": "The maximum number of objects in a single response. The default is 20. The maximum is 100."
    },
    "offset": {
      "type": "integer",
      "description": "The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object."
    }
  },
  "required": [
    "PCID",
    "ID"
  ]
}

---

workday_accounts_payable_get_supplierinvoicerequests_by_id_lines

Retrieves a collection of supplier invoice lines.

Parameters:

Parameter	Type	Required	Default	Description
ID	string	Yes	—	The Workday ID of the resource.
limit	integer	No	—	The maximum number of objects in a single response. The default is 20. The maximum is 100.
offset	integer	No	—	The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "ID": {
      "type": "string",
      "description": "The Workday ID of the resource."
    },
    "limit": {
      "type": "integer",
      "description": "The maximum number of objects in a single response. The default is 20. The maximum is 100."
    },
    "offset": {
      "type": "integer",
      "description": "The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object."
    }
  },
  "required": [
    "PCID",
    "ID"
  ]
}

---

workday_accounts_payable_get_supplierinvoicerequests_by_id_lines_by_subresourceid

Retrieves a single supplier invoice line instance.

Parameters:

Parameter	Type	Required	Default	Description
ID	string	Yes	—	The Workday ID of the resource.
subresourceID	string	Yes	—	The Workday ID of the subresource.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "ID": {
      "type": "string",
      "description": "The Workday ID of the resource."
    },
    "subresourceID": {
      "type": "string",
      "description": "The Workday ID of the subresource."
    }
  },
  "required": [
    "PCID",
    "ID",
    "subresourceID"
  ]
}

---

workday_accounts_payable_post_sendsupplierinvoiceattachmentsforscanning

Sends supplier invoice attachments for scanning.

Parameters:

Parameter	Type	Required	Default	Description
descriptor	string	No	—	The display name of the instance
id	string	No	—	Workday Id or Reference Id of the instance.
ocrSupplierInvoices	any[]	No	—	Container for OCR Supplier Invoice Root.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "descriptor": {
      "type": "string",
      "description": "The display name of the instance"
    },
    "id": {
      "type": "string",
      "description": "Workday Id or Reference Id of the instance."
    },
    "ocrSupplierInvoices": {
      "type": "array",
      "description": "Container for OCR Supplier Invoice Root."
    }
  },
  "required": [
    "PCID"
  ]
}

---

workday_accounts_payable_post_supplierinvoicerequests

Creates the supplier invoice as specified in the request.

Parameters:

Parameter	Type	Required	Default	Description
company	object	Yes	—	The company used for Common Financial Dimensions. This is for internal use only on a REST API.
controlTotalAmount	object	No	—	The amount entered that should match the total of the line amounts.
currency	object	No	—	The currency for the reporting transaction.
descriptor	string	No	—	The display name of the instance
freightAmount	object	No	—	Freight amount for the supplier invoice request.
handlingCode	object	No	—	The handling code for Supplier Invoice Request.
id	string	No	—	Workday Id or Reference Id of the instance.
invoiceDate	string	Yes	—	The date when a request for a supplier invoice is created.
invoiceReceivedDate	string	No	—	The date an invoice is received.
lines	any[]	No	—	The Supplier Invoice Request Lines for a Supplier Invoice Request.
memo	string	No	—	The memo for the Supplier Invoice Request.
paymentTerms	object	No	—	The payment terms of the customer defined on the transaction or payment terms defined on the transaction directly. You can use this field to drill into details and access the related actions menu.
referenceNumber	string	No	—	The reference number encoded with the key payment information on the supplier invoice request.
referenceType	object	No	—	The type of reference used to encode key payment information on the invoice documents.
remitToConnection	object	No	—	The remit-to address for the supplier on the supplier invoice request.
requester	object	No	—	The requester of the supplier invoice request.
shipToAddress	object	No	—	The shipping address for Supplier Invoice Request.
statutoryInvoiceType	object	No	—	The Invoice Type selected on the supplier invoice request.
supplier	object	Yes	—	The supplier for the business documents. This field allows you to drill into the details and access related actions.
suppliersInvoiceNumber	string	No	—	The reference number provided by the supplier for the supplier invoice request.
taxAmount	object	No	—	Tax amount for the supplier invoice request.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "company": {
      "description": "The company used for Common Financial Dimensions. This is for internal use only on a REST API."
    },
    "controlTotalAmount": {
      "type": "object",
      "description": "The amount entered that should match the total of the line amounts."
    },
    "currency": {
      "description": "The currency for the reporting transaction."
    },
    "descriptor": {
      "type": "string",
      "description": "The display name of the instance"
    },
    "freightAmount": {
      "type": "object",
      "description": "Freight amount for the supplier invoice request."
    },
    "handlingCode": {
      "description": "The handling code for Supplier Invoice Request."
    },
    "id": {
      "type": "string",
      "description": "Workday Id or Reference Id of the instance."
    },
    "invoiceDate": {
      "type": "string",
      "description": "The date when a request for a supplier invoice is created."
    },
    "invoiceReceivedDate": {
      "type": "string",
      "description": "The date an invoice is received."
    },
    "lines": {
      "type": "array",
      "description": "The Supplier Invoice Request Lines for a Supplier Invoice Request."
    },
    "memo": {
      "type": "string",
      "description": "The memo for the Supplier Invoice Request."
    },
    "paymentTerms": {
      "description": "The payment terms of the customer defined on the transaction or payment terms defined on the transaction directly.  You can use this field to drill into details and access the related actions menu."
    },
    "referenceNumber": {
      "type": "string",
      "description": "The reference number encoded with the key payment information on the supplier invoice request."
    },
    "referenceType": {
      "description": "The type of reference used to encode key payment information on the invoice documents."
    },
    "remitToConnection": {
      "description": "The remit-to address for the supplier on the supplier invoice request."
    },
    "requester": {
      "description": "The requester of the supplier invoice request."
    },
    "shipToAddress": {
      "description": "The shipping address for Supplier Invoice Request."
    },
    "statutoryInvoiceType": {
      "description": "The Invoice Type selected on the supplier invoice request."
    },
    "supplier": {
      "description": "The supplier for the business documents. This field allows you to drill into the details and access related actions."
    },
    "suppliersInvoiceNumber": {
      "type": "string",
      "description": "The reference number provided by the supplier for the supplier invoice request."
    },
    "taxAmount": {
      "type": "object",
      "description": "Tax amount for the supplier invoice request."
    }
  },
  "required": [
    "PCID",
    "company",
    "invoiceDate",
    "supplier"
  ]
}

---

workday_accounts_payable_post_supplierinvoicerequests_by_id_attachments

Creates a new attachment for the supplier invoice.

Parameters:

Parameter	Type	Required	Default	Description
ID	string	Yes	—	The Workday ID of the resource.
contentType	object	No	—	Content type of the attachment.
descriptor	string	No	—	The display name of the instance
fileLength	integer	No	—	File length of the attachment.
fileName	string	No	—	File name of the attachment.
id	string	No	—	Workday Id or Reference Id of the instance.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "ID": {
      "type": "string",
      "description": "The Workday ID of the resource."
    },
    "contentType": {
      "description": "Content type of the attachment."
    },
    "descriptor": {
      "type": "string",
      "description": "The display name of the instance"
    },
    "fileLength": {
      "type": "integer",
      "description": "File length of the attachment."
    },
    "fileName": {
      "type": "string",
      "description": "File name of the attachment."
    },
    "id": {
      "type": "string",
      "description": "Workday Id or Reference Id of the instance."
    }
  },
  "required": [
    "PCID",
    "ID"
  ]
}

---

workday_accounts_payable_post_supplierinvoicerequests_by_id_submit

Submits a single supplier invoice instance.

Parameters:

Parameter	Type	Required	Default	Description
ID	string	Yes	—	The Workday ID of the resource.
descriptor	string	No	—	The display name of the instance
id	string	No	—	Workday Id or Reference Id of the instance.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "ID": {
      "type": "string",
      "description": "The Workday ID of the resource."
    },
    "descriptor": {
      "type": "string",
      "description": "The display name of the instance"
    },
    "id": {
      "type": "string",
      "description": "Workday Id or Reference Id of the instance."
    }
  },
  "required": [
    "PCID",
    "ID"
  ]
}