workday-customer-accounts

Workday Customer Accounts - customers, invoices, payments

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

Tools

Tool	Description
workday_customer_accounts_get_customers	Retrieves a collection of customers.
workday_customer_accounts_get_customers_by_id	Retrieves a single customer instance.
workday_customer_accounts_get_invoices	Retrieves a collection of customer invoices and adjustments.
workday_customer_accounts_get_invoices_by_id	Retrieves a single customer invoice or adjustment instance.
workday_customer_accounts_get_invoices_by_id_printruns	Retrieves a collection of customer invoice print runs for the specified customer invoice or adjustment.
workday_customer_accounts_get_invoices_by_id_printruns_by_subresourceid	Retrieves a single customer invoice print run.
workday_customer_accounts_get_payments_by_id	Retrieves a single customer invoice payment instance.
workday_customer_accounts_get_payments_by_id_remittancedetails_by_subresourceid	Retrieves a single customer invoice payment remittance line instance.
workday_customer_accounts_post_payments	Creates customer invoice payments.
workday_customer_accounts_post_payments_by_id_remittancedetails	Creates customer invoice payment remittance lines.

---

workday_customer_accounts_get_customers

Retrieves a collection of customers.

Parameters:

Parameter	Type	Required	Default	Description
limit	integer	No	—	The maximum number of objects in a single response. The default is 20. The maximum is 100.
name	string	No	—	The name value
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"
    },
    "limit": {
      "type": "integer",
      "description": "The maximum number of objects in a single response. The default is 20. The maximum is 100."
    },
    "name": {
      "type": "string",
      "description": "The name value"
    },
    "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"
  ]
}

---

workday_customer_accounts_get_customers_by_id

Retrieves a single customer 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_customer_accounts_get_invoices

Retrieves a collection of customer invoices and adjustments.

Parameters:

Parameter	Type	Required	Default	Description
billToCustomer	string[]	No	—	The customer on the invoice.
company	string[]	No	—	The company value
fromDueDate	string	No	—	The due date of the customer invoice or invoice adjustment as of the defined reporting date, formatted as YYYY-MM-DD.
fromInvoiceDate	string	No	—	The date of the customer invoice, formatted as YYYY-MM-DD.
invoiceStatus	string[]	No	—	The current status of an invoice document. Include invoices with these invoice statuses: Approved (91b0d382d50848e898733757caa9f84a), Canceled (dc76c9b6446c11de98360015c5e6daf6), Denied (dc76c7cc446c11de98360015c5e6daf6), Draft (dc76c4fc446c11de98360015c5e6daf6), Incomplete(e264bc68581342baa70ab61bf71032fe), In Progress (dc76c8bc446c11de98360015c5e6daf6).
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.
paymentStatus	string[]	No	—	The payment status of an invoice document. Include invoices with these payments statuses: Paid (d9e4362a446c11de98360015c5e6daf6), Unpaid (d9e43940446c11de98360015c5e6daf6), Partially Paid (d9e43706446c11de98360015c5e6daf6).
toDueDate	string	No	—	The due date of the customer invoice or invoice adjustment as of the defined reporting date, formatted as YYYY-MM-DD.
toInvoiceDate	string	No	—	The date of the customer invoice, formatted as YYYY-MM-DD.
transactionType	string	No	—	The transaction type of this customer transaction. Use the string “invoice” or “adjustment” to filter to retrieve either only invoices or adjustments.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "billToCustomer": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The customer on the invoice."
    },
    "company": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The company value"
    },
    "fromDueDate": {
      "type": "string",
      "description": "The due date of the customer invoice or invoice adjustment as of the defined reporting date, formatted as YYYY-MM-DD."
    },
    "fromInvoiceDate": {
      "type": "string",
      "description": "The date of the customer invoice, formatted as YYYY-MM-DD."
    },
    "invoiceStatus": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The current status of an invoice document.  Include invoices with these invoice statuses: Approved (91b0d382d50848e898733757caa9f84a),  Canceled (dc76c9b6446c11de98360015c5e6daf6),  Denied (dc76c7cc446c11de98360015c5e6daf6),  Draft (dc76c4fc446c11de98360015c5e6daf6),  Incomplete(e264bc68581342baa70ab61bf71032fe),  In Progress (dc76c8bc446c11de98360015c5e6daf6)."
    },
    "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."
    },
    "paymentStatus": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The payment status of an invoice document.   Include invoices with these payments statuses: Paid (d9e4362a446c11de98360015c5e6daf6),  Unpaid (d9e43940446c11de98360015c5e6daf6),  Partially Paid (d9e43706446c11de98360015c5e6daf6)."
    },
    "toDueDate": {
      "type": "string",
      "description": "The due date of the customer invoice or invoice adjustment as of the defined reporting date, formatted as YYYY-MM-DD."
    },
    "toInvoiceDate": {
      "type": "string",
      "description": "The date of the customer invoice, formatted as YYYY-MM-DD."
    },
    "transactionType": {
      "type": "string",
      "description": "The transaction type of this customer transaction. Use the string \"invoice\" or \"adjustment\" to filter to retrieve either only invoices or adjustments."
    }
  },
  "required": [
    "PCID"
  ]
}

---

workday_customer_accounts_get_invoices_by_id

Retrieves a single customer invoice or adjustment 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_customer_accounts_get_invoices_by_id_printruns

Retrieves a collection of customer invoice print runs for the specified customer invoice or adjustment.

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_customer_accounts_get_invoices_by_id_printruns_by_subresourceid

Retrieves a single customer invoice print run.

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_customer_accounts_get_payments_by_id

Retrieves a single customer invoice payment 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_customer_accounts_get_payments_by_id_remittancedetails_by_subresourceid

Retrieves a single customer invoice payment remittance 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_customer_accounts_post_payments

Creates customer invoice payments.

Parameters:

Parameter	Type	Required	Default	Description
amount	object	No	—	The amount of the customer payment in transaction currency.
company	object	No	—	The company for the customer invoice.
date	string	No	—	The date the customer payment was made.
descriptor	string	No	—	The display name of the instance
id	string	No	—	Workday Id or Reference Id of the instance.
memo	string	No	—	A memo associated with the customer payment.
readyToAutoApply	boolean	No	—	True if the customer payment is ready for automatic application for a cash sale.
reference	string	No	—	The reference to a customer payment that’s processed through a settlement run. This field is blank when the Payment Status is In Progress or when the Payment Type is Check or ETF.
remitFromCustomer	object	No	—	The customer for the invoice.
transactionNumber	string	No	—	The transaction number for the reporting transaction.
type	object	No	—	The payment type for the reporting transaction.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "amount": {
      "type": "object",
      "description": "The amount of the customer payment in transaction currency."
    },
    "company": {
      "description": "The company for the customer invoice."
    },
    "date": {
      "type": "string",
      "description": "The date the customer payment was made."
    },
    "descriptor": {
      "type": "string",
      "description": "The display name of the instance"
    },
    "id": {
      "type": "string",
      "description": "Workday Id or Reference Id of the instance."
    },
    "memo": {
      "type": "string",
      "description": "A memo associated with the customer payment."
    },
    "readyToAutoApply": {
      "type": "boolean",
      "description": "True if the customer payment is ready for automatic application for a cash sale."
    },
    "reference": {
      "type": "string",
      "description": "The reference to a customer payment that's processed through a settlement run. This field is blank when the Payment Status is In Progress or when the Payment Type is Check or ETF."
    },
    "remitFromCustomer": {
      "description": "The customer for the invoice."
    },
    "transactionNumber": {
      "type": "string",
      "description": "The transaction number for the reporting transaction."
    },
    "type": {
      "description": "The payment type for the reporting transaction."
    }
  },
  "required": [
    "PCID"
  ]
}

---

workday_customer_accounts_post_payments_by_id_remittancedetails

Creates customer invoice payment remittance lines.

Parameters:

Parameter	Type	Required	Default	Description
ID	string	Yes	—	The Workday ID of the resource.
amountToPay	object	No	—	The amount to pay specified on the invoice line of the customer payment.
billToCustomer	object	No	—	The bill-to customer or sponsor specified on the invoice line of the customer payment.
id	string	No	—	Workday Id or Reference Id of the instance.
invoice	object	No	—	The invoice associated with the payment remittance.

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."
    },
    "amountToPay": {
      "type": "object",
      "description": "The amount to pay specified on the invoice line of the customer payment."
    },
    "billToCustomer": {
      "description": "The bill-to customer or sponsor specified on the invoice line of the customer payment."
    },
    "id": {
      "type": "string",
      "description": "Workday Id or Reference Id of the instance."
    },
    "invoice": {
      "description": "The invoice associated with the payment remittance."
    }
  },
  "required": [
    "PCID",
    "ID"
  ]
}