workday.customeraccounts
Module workday.customeraccounts
API
Definitions
![](https://bcentral-packageicons.azureedge.net/images/ballerinax_workday.customeraccounts_1.1.0.png)
ballerinax/workday.customeraccounts Ballerina library
Overview
This is a generated connector for WorkDay Customer Accounts REST API v1 OpenAPI specification.
The customer accounts service enables applications to access customer accounts information including customers, invoices,adjustments, and payments.
Prerequisites
Before using this connector in your Ballerina application, complete the following:
- Create a workday application in the Credential Administrator console
- Obtain tokens by following this guide
Clients![](/images/permalink.svg)
workday.customeraccounts: Client![](/images/permalink.svg)
This is a generated connector for WorkDay Customer Accounts REST API v1 OpenAPI specification. The customer accounts service enables applications to access customer accounts information including customers, invoices, adjustments, and payments.
Constructor![](/images/permalink.svg)
Gets invoked to initialize the connector
.
The connector initialization requires setting the API credentials. Follow [this guide] https://credentials.workday.com/docs/authentication/ and obtain tokens.
init (ClientConfig clientConfig, string serviceUrl)
- clientConfig ClientConfig - The configurations to be used when initializing the
connector
- serviceUrl string - URL of the target service
getInvoicePaymentRemittanceLine![](/images/permalink.svg)
function getInvoicePaymentRemittanceLine(string id, string subresourceID) returns ViewRemittanceDetails|error
Retrieves a single customer invoice payment remittance line instance.
Parameters
- id string - The Workday ID of the resource.
- subresourceID string - The Workday ID of the subresource.
Return Type
- ViewRemittanceDetails|error - Successful response. A successful response can return no matched data.
getInvoicePaymentInstance![](/images/permalink.svg)
function getInvoicePaymentInstance(string id) returns ViewCustomerPayment|error
Retrieves a single customer invoice payment instance.
Parameters
- id string - The Workday ID of the resource.
Return Type
- ViewCustomerPayment|error - Successful response. A successful response can return no matched data.
getSingleCustomerInstance![](/images/permalink.svg)
function getSingleCustomerInstance(string id) returns CustomerView|error
Retrieves a single customer instance.
Parameters
- id string - The Workday ID of the resource.
Return Type
- CustomerView|error - Successful response. A successful response can return no matched data.
getInvoiceOrAdjustmentInstance![](/images/permalink.svg)
function getInvoiceOrAdjustmentInstance(string id) returns CustomerInvoice|error
Retrieves a single customer invoice or adjustment instance.
Parameters
- id string - The Workday ID of the resource.
Return Type
- CustomerInvoice|error - Successful response. A successful response can return no matched data.
getInvoicePDFInstance![](/images/permalink.svg)
Retrieves a single customer invoice PDF instance.
Parameters
- id string - The Workday ID of the resource.
createInvoicePayment![](/images/permalink.svg)
function createInvoicePayment(CreateCustomerPayment payload) returns CreateCustomerPayment|error
Creates customer invoice payments.
Parameters
- payload CreateCustomerPayment -
Return Type
- CreateCustomerPayment|error - Resource created.
getCollectionOfInvoices![](/images/permalink.svg)
function getCollectionOfInvoices(string[]? billToCustomer, string[]? company, string? fromDueDate, string? fromInvoiceDate, string[]? invoiceStatus, int? 'limit, int? offset, string[]? paymentStatus, string? toDueDate, string? toInvoiceDate, string? transactionType) returns InlineResponse200|error
Retrieves a collection of customer invoices and adjustments.
Parameters
- billToCustomer string[]? (default ()) - The customer on the invoice.
- company string[]? (default ()) - The company used for Common Financial Dimensions. This is for internal use only on a REST API.
- fromDueDate string? (default ()) - The due date of the customer invoice or invoice adjustment as of the defined reporting date, formatted as YYYY-MM-DD.
- fromInvoiceDate string? (default ()) - The date of the customer invoice, formatted as YYYY-MM-DD.
- invoiceStatus string[]? (default ()) - 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 int? (default ()) - The maximum number of objects in a single response. The default is 20. The maximum is 100.
- offset int? (default ()) - 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[]? (default ()) - The payment status of an invoice document. Include invoices with these payments statuses: Paid (d9e4362a446c11de98360015c5e6daf6), Unpaid (d9e43940446c11de98360015c5e6daf6), Partially Paid (d9e43706446c11de98360015c5e6daf6).
- toDueDate string? (default ()) - The due date of the customer invoice or invoice adjustment as of the defined reporting date, formatted as YYYY-MM-DD.
- toInvoiceDate string? (default ()) - The date of the customer invoice, formatted as YYYY-MM-DD.
- transactionType string? (default ()) - The transaction type of this customer transaction. Use the string "invoice" or "adjustment" to filter to retrieve either only invoices or adjustments.
Return Type
- InlineResponse200|error - Successful response. A successful response can return no matched data.
getInvoicePrintRun![](/images/permalink.svg)
Retrieves a single customer invoice print run.
Parameters
- id string - The Workday ID of the resource.
- subresourceID string - The Workday ID of the subresource.
getInvoicePrintRunForSpecifiedInvoice![](/images/permalink.svg)
function getInvoicePrintRunForSpecifiedInvoice(string id, int? 'limit, int? offset) returns InlineResponse2001|error
Retrieves a collection of customer invoice print runs for the specified customer invoice or adjustment.
Parameters
- id string - The Workday ID of the resource.
- 'limit int? (default ()) - The maximum number of objects in a single response. The default is 20. The maximum is 100.
- offset int? (default ()) - 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.
Return Type
- InlineResponse2001|error - Successful response. A successful response can return no matched data.
getCustomerCollection![](/images/permalink.svg)
function getCustomerCollection(int? 'limit, string? name, int? offset) returns InlineResponse2002|error
Retrieves a collection of customers.
Parameters
- 'limit int? (default ()) - The maximum number of objects in a single response. The default is 20. The maximum is 100.
- name string? (default ()) - The name of the customer.
- offset int? (default ()) - 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.
Return Type
- InlineResponse2002|error - Successful response. A successful response can return no matched data.
createCustomerInvoice![](/images/permalink.svg)
function createCustomerInvoice(string id, CreateRemittanceDetails payload) returns CreateRemittanceDetails|error
Creates customer invoice payment remittance lines.
Return Type
- CreateRemittanceDetails|error - Resource created.
Records![](/images/permalink.svg)
workday.customeraccounts: AdjustmentReason![](/images/permalink.svg)
Fields
- Fields Included from *RelatedAdjustmentReasonDisplay
- descriptor string|()
- anydata...
workday.customeraccounts: BillToAddressDisplay![](/images/permalink.svg)
Fields
- regionSubdivision1 string? - The subdivision of the region of the bill-to customer.
- countryRegion CountryRegion? -
- addressLine3 string? - The third address line for the bill-to customer.
- citySubdivision1 string? - The subdivision of the city of the bill-to customer.
- addressLine1 string? - The first address line for the bill-to customer.
- addressLine4 string? - The fourth address line for the bill-to customer.
- city string? - The city of the bill-to customer.
- citySubdivision2 string? - The second subdivision of the city of the bill-to customer.
- country Country? -
- addressLine2 string? - The second address line for the bill-to customer.
- regionSubdivision2 string? - The second subdivision of the region of the bill-to customer.
- postalCode string? - The postal code of the bill-to customer.
- id string? - Id of the instance
- descriptor string? - A preview of the instance
workday.customeraccounts: BillToCustomer![](/images/permalink.svg)
Fields
- Fields Included from *CustomerDisplay
workday.customeraccounts: BillToCustomerAddress![](/images/permalink.svg)
Fields
- Fields Included from *BillToAddressDisplay
- regionSubdivision1 string|()
- countryRegion CountryRegion|()
- addressLine3 string|()
- citySubdivision1 string|()
- addressLine1 string|()
- addressLine4 string|()
- city string|()
- citySubdivision2 string|()
- country Country|()
- addressLine2 string|()
- regionSubdivision2 string|()
- postalCode string|()
- id string|()
- descriptor string|()
- anydata...
workday.customeraccounts: BillToCustomerRef![](/images/permalink.svg)
Fields
- Fields Included from *InstanceModelReference
workday.customeraccounts: Category![](/images/permalink.svg)
Fields
- Fields Included from *InstanceModelReference
workday.customeraccounts: ClientConfig![](/images/permalink.svg)
Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint.
Fields
- auth BearerTokenConfig - Configurations related to client authentication
- httpVersion string(default "1.1") - The HTTP version understood by the client
- http1Settings ClientHttp1Settings(default {}) - Configurations related to HTTP/1.x protocol
- http2Settings ClientHttp2Settings(default {}) - Configurations related to HTTP/2 protocol
- timeout decimal(default 60) - The maximum time to wait (in seconds) for a response before closing the connection
- forwarded string(default "disable") - The choice of setting
forwarded
/x-forwarded
header
- followRedirects FollowRedirects?(default ()) - Configurations associated with Redirection
- poolConfig PoolConfiguration?(default ()) - Configurations associated with request pooling
- cache CacheConfig(default {}) - HTTP caching related configurations
- compression Compression(default http:COMPRESSION_AUTO) - Specifies the way of handling compression (
accept-encoding
) header
- circuitBreaker CircuitBreakerConfig?(default ()) - Configurations associated with the behaviour of the Circuit Breaker
- retryConfig RetryConfig?(default ()) - Configurations associated with retrying
- cookieConfig CookieConfig?(default ()) - Configurations associated with cookies
- responseLimits ResponseLimitConfigs(default {}) - Configurations associated with inbound response size limits
- secureSocket ClientSecureSocket?(default ()) - SSL/TLS-related options
workday.customeraccounts: Company![](/images/permalink.svg)
Fields
- Fields Included from *CompanyDisplay
workday.customeraccounts: CompanyDisplay![](/images/permalink.svg)
Fields
- id string? - Id of the instance
- descriptor string? - A preview of the instance
workday.customeraccounts: Country![](/images/permalink.svg)
Fields
- Fields Included from *CountryDisplay
- descriptor string|()
- anydata...
workday.customeraccounts: CountryDisplay![](/images/permalink.svg)
Fields
- descriptor string? - A preview of the instance
workday.customeraccounts: CountryRegion![](/images/permalink.svg)
Fields
- Fields Included from *CountryRegionDisplay
- descriptor string|()
- anydata...
workday.customeraccounts: CountryRegionDisplay![](/images/permalink.svg)
Fields
- descriptor string? - A preview of the instance
workday.customeraccounts: CreateCustomerPayment![](/images/permalink.svg)
Fields
- memo string? - A memo associated with the customer payment.
- remitFromCustomer RemitFromCustomer? -
- readyToAutoApply boolean? - True if the customer payment is ready for automatic application for a cash sale.
- reference string? - 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.
- transactionNumber string? - The transaction number for the reporting transaction.
- amount record {}? - The amount of the customer payment in transaction currency.
- 'type TypeRef? -
- date string? - The date the customer payment was made.
- company Company? -
- id string? - Id of the instance
- descriptor string? - A preview of the instance
workday.customeraccounts: CreateRemittanceDetails![](/images/permalink.svg)
Fields
- amountToPay record {}? - The amount to pay specified on the invoice line of the customer payment.
- invoice Invoice? -
- billToCustomer BillToCustomerRef? -
- id string? - Id of the instance
workday.customeraccounts: Currency![](/images/permalink.svg)
Fields
- Fields Included from *CurrencyDisplay
- descriptor string|()
- anydata...
workday.customeraccounts: CurrencyDisplay![](/images/permalink.svg)
Fields
- descriptor string? - A preview of the instance
workday.customeraccounts: CustomerDisplay![](/images/permalink.svg)
Fields
- id string? - Id of the instance
- descriptor string? - A preview of the instance
workday.customeraccounts: CustomerGroup![](/images/permalink.svg)
Fields
- id string? - Id of the instance
- descriptor string? - A preview of the instance
workday.customeraccounts: CustomerInvoice![](/images/permalink.svg)
Fields
- invoiceDate string? - The date of the customer invoice.
- transactionType string? - The type of customer invoice document, either Invoice or Adjustment.
- withholdingAmount record {}? - The tax amount that you withhold from the customer invoice.
- company Company? -
- billToCustomer BillToCustomer? -
- inCollection boolean? - A flag when set to true, places the invoices into collections.
- netAmount record {}? - The total of all invoice line amounts minus the total Tax amount minus the Prepaid Utilization amount. This calculation doesn't deduct the withholding tax. This is the value printed on the customer invoice and can be positive or negative.
- disputeAmount record {}? - The amount you dispute on a customer invoice.
- dueAmount record {}? - The amount due for the customer invoice. The value can be positive or negative.
- invoiceType InvoiceType? -
- poNumber string? - The purchase order number specified on the customer invoice.
- relatedAdjustments RelatedAdjustmentDisplay[]? - Adjustments for a customer Invoice.
- adjustmentReason AdjustmentReason? -
- taxAmount record {}? - The total tax amount for the document with sign.
- disputeDate string? - The date you place the customer invoice in dispute.
- relatedInvoice RelatedInvoice? -
- paymentStatus PaymentStatus? -
- currency Currency? -
- dueDate string? - The due date of the customer invoice or invoice adjustment as of the defined reporting date.
- memo string? - The memo for the customer invoice.
- billToCustomerAddress BillToCustomerAddress? -
- inDispute boolean? - True if the invoice is in dispute.
- disputeReasons DisputeReasonDisplay[]? - The reasons for invoice dispute.
- invoiceStatus InvoiceStatus? -
- retentionAmount record {}? - Total retention amount from invoice lines.
- totalAmount record {}? - The total amount for the customer invoice including tax. The amount can be positive or negative. When the reporting transaction is not an instance of a customer invoice, the amount value is zero.
- invoiceNumber string? - The customer invoice number.
- id string? - Id of the instance
- href string? - A link to the instance
- descriptor string? - A preview of the instance
workday.customeraccounts: CustomerView![](/images/permalink.svg)
Fields
- creditLimit record {}? - The maximum credit limit for the customer.
- name string? - The name of the customer.
- satisfactionScore int? - The customer satisfaction score.
- paymentTerms PaymentTerms? -
- compositeRiskScore int? - The Dun and Bradstreet risk score of the customer.
- groups CustomerGroup[]? - The customer group a customer belongs to. A customer can be part of multiple customer groups.
- commercialCreditScore int? - The Dun and Bradstreet Commercial credit score of the customer.
- primaryPhone string? - The primary phone number of the customer.
- totalBalance record {}? - The total customer balance due in the customer currency, as of the report run time. Workday calculates the total balance by adding the amount of all approved and uncanceled customer invoices and subtracting the total amount of all approved and uncanceled customer payments. The customer currency can be the default currency for the tenant, or the currency you define for a given customer.
- category Category? -
- id string? - Id of the instance
workday.customeraccounts: DeliveryMethodDisplay![](/images/permalink.svg)
Fields
- descriptor string? - A preview of the instance
workday.customeraccounts: DisputeReasonDisplay![](/images/permalink.svg)
Fields
- descriptor string? - A preview of the instance
workday.customeraccounts: ErrorModelReference![](/images/permalink.svg)
Fields
- _error string - A description of the error
workday.customeraccounts: FacetsModelReferenceInner![](/images/permalink.svg)
This object represents the possible facets for this resource
Fields
- descriptor string? - A description of the facet
- facetParameter string? - The alias used to select the facet
workday.customeraccounts: InlineResponse200![](/images/permalink.svg)
collection something or other
Fields
- data CustomerInvoice[]? -
- total int? -
workday.customeraccounts: InlineResponse2001![](/images/permalink.svg)
collection something or other
Fields
- data PrintRun[]? -
- total int? -
workday.customeraccounts: InlineResponse2002![](/images/permalink.svg)
collection something or other
Fields
- data CustomerView[]? -
- total int? -
workday.customeraccounts: InstanceModelReference![](/images/permalink.svg)
Fields
- id string - wid / id / reference id
- descriptor string? - A description of the instance
- href string? - A link to the instance
workday.customeraccounts: Invoice![](/images/permalink.svg)
Fields
- Fields Included from *InstanceModelReference
workday.customeraccounts: InvoicePDFDisplay![](/images/permalink.svg)
Fields
- name string? - The name of the PDF file associated with the customer invoice.
- id string? - Id of the instance
workday.customeraccounts: InvoiceStatus![](/images/permalink.svg)
Fields
- Fields Included from *InvoiceStatusDisplay
workday.customeraccounts: InvoiceStatusDisplay![](/images/permalink.svg)
Fields
- id string? - Id of the instance
- descriptor string? - A preview of the instance
workday.customeraccounts: InvoiceType![](/images/permalink.svg)
Fields
- Fields Included from *InvoiceTypeDisplay
- descriptor string|()
- anydata...
workday.customeraccounts: InvoiceTypeDisplay![](/images/permalink.svg)
Fields
- descriptor string? - A preview of the instance
workday.customeraccounts: MultipleInstanceModelReference![](/images/permalink.svg)
Fields
- total int? -
- data InstanceModelReference[]? -
workday.customeraccounts: PaymentStatus![](/images/permalink.svg)
Fields
- Fields Included from *PaymentStatusDisplay
workday.customeraccounts: PaymentStatusDisplay![](/images/permalink.svg)
Fields
- id string? - Id of the instance
- descriptor string? - A preview of the instance
workday.customeraccounts: PaymentTerms![](/images/permalink.svg)
Fields
- Fields Included from *InstanceModelReference
workday.customeraccounts: PDF![](/images/permalink.svg)
Fields
- Fields Included from *InvoicePDFDisplay
workday.customeraccounts: PrintRun![](/images/permalink.svg)
Fields
- pdf PDF? -
- deliveryMethod DeliveryMethodDisplay[]? - The delivery method associated with the print run of the customer invoice.
- printedDateTime string? - The date when the customer invoice was printed.
- printRunType PrintRunType? -
- id string? - Id of the instance
- descriptor string? - A preview of the instance
workday.customeraccounts: PrintRunType![](/images/permalink.svg)
Fields
- Fields Included from *InstanceModelReference
workday.customeraccounts: RelatedAdjustmentDisplay![](/images/permalink.svg)
Fields
- id string? - Id of the instance
- href string? - A link to the instance
- descriptor string? - A preview of the instance
workday.customeraccounts: RelatedAdjustmentReasonDisplay![](/images/permalink.svg)
Fields
- descriptor string? - A preview of the instance
workday.customeraccounts: RelatedInvoice![](/images/permalink.svg)
Fields
- Fields Included from *InstanceModelReference
workday.customeraccounts: RemitFromCustomer![](/images/permalink.svg)
Fields
- Fields Included from *InstanceModelReference
workday.customeraccounts: TypeRef![](/images/permalink.svg)
Fields
- Fields Included from *InstanceModelReference
workday.customeraccounts: ValidationErrorModelReference![](/images/permalink.svg)
Fields
- Fields Included from *ErrorModelReference
- _error string|()
- anydata...
- errors ErrorModelReference[]? - An array of validation errors
workday.customeraccounts: ViewCustomerPayment![](/images/permalink.svg)
Fields
- id string? - Id of the instance
- descriptor string? - A preview of the instance
workday.customeraccounts: ViewRemittanceDetails![](/images/permalink.svg)
Fields
- id string? - Id of the instance
Import
import ballerinax/workday.customeraccounts;
Metadata
Released date: over 2 years ago
Version: 1.1.0
License: Apache-2.0
Compatibility
Platform: any
Ballerina version: slbeta6
GraalVM compatible: Yes
Pull count
Total: 3
Current verison: 0
Weekly downloads
Keywords
Finance/Accounting
Cost/Paid
Contributors
Dependencies