Module workday.customeraccounts
ballerinax/workday.customeraccounts Ballerina library
1.5.2
Overview
The WorkDay Customer Accounts REST API v1 connector(https://community.workday.com/sites/default/files/file-hosting/restapi/index.html) OpenAPI specification.
The customer accounts service enables applications to access customer accounts information including customers, invoices,adjustments, and payments.
Key Features
- Programmatic access to create and manage resources via REST API
- Handle payments, billing, and financial transactions
- Manage user accounts and profiles
- Secure authentication with API key or OAuth support
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
workday.customeraccounts: Client
Isolated
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
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 (ConnectionConfig config, string serviceUrl)- config ConnectionConfig - The configurations to be used when initializing the
connector
- serviceUrl string - URL of the target service
getInvoicePaymentRemittanceLine
Isolated FunctionRemote Function
function getInvoicePaymentRemittanceLine(string id, string subresourceID) returns ViewRemittanceDetails|errorRetrieves 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
Isolated FunctionRemote Function
function getInvoicePaymentInstance(string id) returns ViewCustomerPayment|errorRetrieves 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
Isolated FunctionRemote Function
function getSingleCustomerInstance(string id) returns CustomerView|errorRetrieves 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
Isolated FunctionRemote Function
function getInvoiceOrAdjustmentInstance(string id) returns CustomerInvoice|errorRetrieves 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
Isolated FunctionRemote Function
Retrieves a single customer invoice PDF instance.
Parameters
- id string - The Workday ID of the resource.
createInvoicePayment
Isolated FunctionRemote Function
function createInvoicePayment(CreateCustomerPayment payload) returns CreateCustomerPayment|errorCreates customer invoice payments.
Parameters
- payload CreateCustomerPayment -
Return Type
- CreateCustomerPayment|error - Resource created.
getCollectionOfInvoices
Isolated FunctionRemote Function
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|errorRetrieves 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
Isolated FunctionRemote Function
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
Isolated FunctionRemote Function
function getInvoicePrintRunForSpecifiedInvoice(string id, int? 'limit, int? offset) returns InlineResponse2001|errorRetrieves 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
Isolated FunctionRemote Function
function getCustomerCollection(int? 'limit, string? name, int? offset) returns InlineResponse2002|errorRetrieves 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
Isolated FunctionRemote Function
function createCustomerInvoice(string id, CreateRemittanceDetails payload) returns CreateRemittanceDetails|errorCreates customer invoice payment remittance lines.
Return Type
- CreateRemittanceDetails|error - Resource created.
Records
workday.customeraccounts: AdjustmentReason
Fields
- Fields Included from *RelatedAdjustmentReasonDisplay
- descriptor string
- anydata...
workday.customeraccounts: BillToAddressDisplay
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
Fields
- Fields Included from *CustomerDisplay
workday.customeraccounts: BillToCustomerAddress
Fields
- Fields Included from *BillToAddressDisplay
workday.customeraccounts: BillToCustomerRef
Fields
- Fields Included from *InstanceModelReference
workday.customeraccounts: Category
Fields
- Fields Included from *InstanceModelReference
workday.customeraccounts: ClientHttp1Settings
Closed record
Provides settings related to HTTP/1.x protocol.
Fields
- keepAlive KeepAlive(default http:KEEPALIVE_AUTO) - Specifies whether to reuse a connection for multiple requests
- chunking Chunking(default http:CHUNKING_AUTO) - The chunking behaviour of the request
- proxy? ProxyConfig - Proxy server related options
workday.customeraccounts: Company
Fields
- Fields Included from *CompanyDisplay
workday.customeraccounts: CompanyDisplay
Fields
- id? string - Id of the instance
- descriptor? string - A preview of the instance
workday.customeraccounts: ConnectionConfig
Closed record
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 HttpVersion(default http:HTTP_2_0) - The HTTP version understood by the client
- http1Settings? ClientHttp1Settings - Configurations related to HTTP/1.x protocol
- http2Settings? ClientHttp2Settings - 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-forwardedheader
- poolConfig? PoolConfiguration - Configurations associated with request pooling
- cache? CacheConfig - HTTP caching related configurations
- compression Compression(default http:COMPRESSION_AUTO) - Specifies the way of handling compression (
accept-encoding) header
- circuitBreaker? CircuitBreakerConfig - Configurations associated with the behaviour of the Circuit Breaker
- retryConfig? RetryConfig - Configurations associated with retrying
- responseLimits? ResponseLimitConfigs - Configurations associated with inbound response size limits
- secureSocket? ClientSecureSocket - SSL/TLS-related options
- proxy? ProxyConfig - Proxy server related options
- validation boolean(default true) - Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default
workday.customeraccounts: Country
Fields
- Fields Included from *CountryDisplay
- descriptor string
- anydata...
workday.customeraccounts: CountryDisplay
Fields
- descriptor? string - A preview of the instance
workday.customeraccounts: CountryRegion
Fields
- Fields Included from *CountryRegionDisplay
- descriptor string
- anydata...
workday.customeraccounts: CountryRegionDisplay
Fields
- descriptor? string - A preview of the instance
workday.customeraccounts: CreateCustomerPayment
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
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
Fields
- Fields Included from *CurrencyDisplay
- descriptor string
- anydata...
workday.customeraccounts: CurrencyDisplay
Fields
- descriptor? string - A preview of the instance
workday.customeraccounts: CustomerDisplay
Fields
- id? string - Id of the instance
- descriptor? string - A preview of the instance
workday.customeraccounts: CustomerGroup
Fields
- id? string - Id of the instance
- descriptor? string - A preview of the instance
workday.customeraccounts: CustomerInvoice
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.
- adjustmentReason? AdjustmentReason -
- taxAmount? record {} - The total tax amount for the document with sign.
- disputeDate? string - The date you place the customer invoice in dispute.
- 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
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
Fields
- descriptor? string - A preview of the instance
workday.customeraccounts: DisputeReasonDisplay
Fields
- descriptor? string - A preview of the instance
workday.customeraccounts: ErrorModelReference
Fields
- 'error string - A description of the error
workday.customeraccounts: FacetsModelReferenceInner
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
collection something or other
Fields
- data? CustomerInvoice[] -
- total? int -
workday.customeraccounts: InlineResponse2001
collection something or other
Fields
- data? PrintRun[] -
- total? int -
workday.customeraccounts: InlineResponse2002
collection something or other
Fields
- data? CustomerView[] -
- total? int -
workday.customeraccounts: InstanceModelReference
Fields
- id string - wid / id / reference id
- descriptor? string - A description of the instance
- href? string - A link to the instance
workday.customeraccounts: Invoice
Fields
- Fields Included from *InstanceModelReference
workday.customeraccounts: InvoicePDFDisplay
Fields
- name? string - The name of the PDF file associated with the customer invoice.
- id? string - Id of the instance
workday.customeraccounts: InvoiceStatus
Fields
- Fields Included from *InvoiceStatusDisplay
workday.customeraccounts: InvoiceStatusDisplay
Fields
- id? string - Id of the instance
- descriptor? string - A preview of the instance
workday.customeraccounts: InvoiceType
Fields
- Fields Included from *InvoiceTypeDisplay
- descriptor string
- anydata...
workday.customeraccounts: InvoiceTypeDisplay
Fields
- descriptor? string - A preview of the instance
workday.customeraccounts: MultipleInstanceModelReference
Fields
- total? int -
- data? InstanceModelReference[] -
workday.customeraccounts: PaymentStatus
Fields
- Fields Included from *PaymentStatusDisplay
workday.customeraccounts: PaymentStatusDisplay
Fields
- id? string - Id of the instance
- descriptor? string - A preview of the instance
workday.customeraccounts: PaymentTerms
Fields
- Fields Included from *InstanceModelReference
workday.customeraccounts: PDF
Fields
- Fields Included from *InvoicePDFDisplay
workday.customeraccounts: PrintRun
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
Fields
- Fields Included from *InstanceModelReference
workday.customeraccounts: ProxyConfig
Closed record
Proxy server configurations to be used with the HTTP client endpoint.
Fields
- host string(default "") - Host name of the proxy server
- port int(default 0) - Proxy server port
- userName string(default "") - Proxy server username
- password string(default "") - Proxy server password
workday.customeraccounts: RelatedAdjustmentDisplay
Fields
- id? string - Id of the instance
- href? string - A link to the instance
- descriptor? string - A preview of the instance
workday.customeraccounts: RelatedAdjustmentReasonDisplay
Fields
- descriptor? string - A preview of the instance
workday.customeraccounts: RelatedInvoice
Fields
- Fields Included from *InstanceModelReference
workday.customeraccounts: RemitFromCustomer
Fields
- Fields Included from *InstanceModelReference
workday.customeraccounts: TypeRef
Fields
- Fields Included from *InstanceModelReference
workday.customeraccounts: ValidationErrorModelReference
Fields
- Fields Included from *ErrorModelReference
- error string
- anydata...
- errors? ErrorModelReference[] - An array of validation errors
workday.customeraccounts: ViewCustomerPayment
Fields
- id? string - Id of the instance
- descriptor? string - A preview of the instance
workday.customeraccounts: ViewRemittanceDetails
Fields
- id? string - Id of the instance
Array types
workday.customeraccounts: FacetsModelReference
FacetsModelReference