Skip to main content
Server path: /workday-customer-accounts | Type: Application | PCID required: Yes

Tools

ToolDescription
workday_customer_accounts_get_customersRetrieves a collection of customers.
workday_customer_accounts_get_customers_by_idRetrieves a single customer instance.
workday_customer_accounts_get_invoicesRetrieves a collection of customer invoices and adjustments.
workday_customer_accounts_get_invoices_by_idRetrieves a single customer invoice or adjustment instance.
workday_customer_accounts_get_invoices_by_id_printrunsRetrieves a collection of customer invoice print runs for the specified customer invoice or adjustment.
workday_customer_accounts_get_invoices_by_id_printruns_by_subresourceidRetrieves a single customer invoice print run.
workday_customer_accounts_get_payments_by_idRetrieves a single customer invoice payment instance.
workday_customer_accounts_get_payments_by_id_remittancedetails_by_subresourceidRetrieves a single customer invoice payment remittance line instance.
workday_customer_accounts_post_paymentsCreates customer invoice payments.
workday_customer_accounts_post_payments_by_id_remittancedetailsCreates customer invoice payment remittance lines.

workday_customer_accounts_get_customers

Retrieves a collection of customers. Parameters:
ParameterTypeRequiredDefaultDescription
limitintegerNoThe maximum number of objects in a single response. The default is 20. The maximum is 100.
namestringNoname
offsetintegerNoThe 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.

workday_customer_accounts_get_customers_by_id

Retrieves a single customer instance. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYesThe Workday ID of the resource.

workday_customer_accounts_get_invoices

Retrieves a collection of customer invoices and adjustments. Parameters:
ParameterTypeRequiredDefaultDescription
billToCustomerany[]NoThe customer on the invoice.
companyany[]Nocompany
fromDueDatestringNoThe due date of the customer invoice or invoice adjustment as of the defined reporting date, formatted as YYYY-MM-DD.
fromInvoiceDatestringNoThe date of the customer invoice, formatted as YYYY-MM-DD.
invoiceStatusany[]NoThe 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).
limitintegerNoThe maximum number of objects in a single response. The default is 20. The maximum is 100.
offsetintegerNoThe 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.
paymentStatusany[]NoThe payment status of an invoice document. Include invoices with these payments statuses: Paid (d9e4362a446c11de98360015c5e6daf6), Unpaid (d9e43940446c11de98360015c5e6daf6), Partially Paid (d9e43706446c11de98360015c5e6daf6).
toDueDatestringNoThe due date of the customer invoice or invoice adjustment as of the defined reporting date, formatted as YYYY-MM-DD.
toInvoiceDatestringNoThe date of the customer invoice, formatted as YYYY-MM-DD.
transactionTypestringNoThe transaction type of this customer transaction. Use the string “invoice” or “adjustment” to filter to retrieve either only invoices or adjustments.

workday_customer_accounts_get_invoices_by_id

Retrieves a single customer invoice or adjustment instance. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYesThe Workday ID of the resource.

workday_customer_accounts_get_invoices_by_id_printruns

Retrieves a collection of customer invoice print runs for the specified customer invoice or adjustment. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYesThe Workday ID of the resource.
limitintegerNoThe maximum number of objects in a single response. The default is 20. The maximum is 100.
offsetintegerNoThe 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.

workday_customer_accounts_get_invoices_by_id_printruns_by_subresourceid

Retrieves a single customer invoice print run. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYesThe Workday ID of the resource.
subresourceIDstringYesThe Workday ID of the subresource.

workday_customer_accounts_get_payments_by_id

Retrieves a single customer invoice payment instance. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYesThe Workday ID of the resource.

workday_customer_accounts_get_payments_by_id_remittancedetails_by_subresourceid

Retrieves a single customer invoice payment remittance line instance. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYesThe Workday ID of the resource.
subresourceIDstringYesThe Workday ID of the subresource.

workday_customer_accounts_post_payments

Creates customer invoice payments. Parameters:
ParameterTypeRequiredDefaultDescription
amountobjectNoThe amount of the customer payment in transaction currency.
companyobjectNoThe company for the customer invoice.
datestringNoThe date the customer payment was made.
descriptorstringNoThe display name of the instance
idstringNoWorkday Id or Reference Id of the instance.
memostringNoA memo associated with the customer payment.
readyToAutoApplybooleanNoTrue if the customer payment is ready for automatic application for a cash sale.
referencestringNoThe 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.
remitFromCustomerobjectNoThe customer for the invoice.
transactionNumberstringNoThe transaction number for the reporting transaction.
typeobjectNoThe payment type for the reporting transaction.

workday_customer_accounts_post_payments_by_id_remittancedetails

Creates customer invoice payment remittance lines. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYesThe Workday ID of the resource.
amountToPayobjectNoThe amount to pay specified on the invoice line of the customer payment.
billToCustomerobjectNoThe bill-to customer or sponsor specified on the invoice line of the customer payment.
idstringNoWorkday Id or Reference Id of the instance.
invoiceobjectNoThe invoice associated with the payment remittance.