{ "swagger": "2.0", "info": { "description": "Returns customer accounts information including customers, invoices, adjustments, and payments.", "version": "v1", "title": "customerAccounts", "x-workday-internal-source": "xo", "x-workday-internal-routing": "Public", "x-workday-internal-protected-usage-enabled": false, "x-workday-internal-service-container-id": "ba74f44bc90e107329f63b52450c0040" }, "host": "", "basePath": "/customerAccounts/v1", "tags": [ { "name": "customers", "description": "Use this REST API to retrieve basic customer profile information including credit details, payment terms and total balance." }, { "name": "invoicePDFs", "description": "Use this REST API to retrieve printed customer invoice PDF documents." }, { "name": "invoices", "description": "Use this REST API to retrieve customer invoices." }, { "name": "payments", "description": "Use this REST API to record customer payments and retrieve basic customer payments information." } ], "schemes": [ "https" ], "paths": { "/payments/{ID}/remittanceDetails/{subresourceID}": { "get": { "tags": [ "payments" ], "summary": "Retrieves a single customer invoice payment remittance line instance.", "description": "Retrieves a customer invoice payment remittance line with the specified ID.\n\nSecured By Domain: Process: Customer Invoice Payment\n\nScope: Customer Accounts", "produces": [ "application/json" ], "parameters": [ { "name": "ID", "in": "path", "description": "The Workday ID of the resource.\n\nAccepts:\n- **Workday ID**: Workday ID (32-character lowercase hexadecimal string).\n- **Reference ID**: Workday reference ID (Type=Value). Valid types: Customer_Payment_for_Invoices_Reference_ID", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|(Customer_Payment_for_Invoices_Reference_ID)=\\S+)$" }, { "name": "subresourceID", "in": "path", "description": "The Workday ID of the subresource.\n\nAccepts:\n- **Workday ID**: Workday ID (32-character lowercase hexadecimal string).", "required": true, "type": "string", "pattern": "^([0-9a-f]{32})$" } ], "responses": { "200": { "description": "Successful response. A successful response can return no matched data.", "schema": { "$ref": "#/definitions/viewRemittanceDetails_17b89f3dcfab1000056c7a877cbe00f1" } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "401": { "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "403": { "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "404": { "description": "Resource not found. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/ERROR_MODEL_REFERENCE" } } }, "x-workday-internal-try-enabled": "false", "x-workday-operation-id": "17b89f3dcfab1000056f5129a4a500f3", "x-workday-secured-by-domains": [ "Process: Customer Invoice Payment" ] } }, "/customers/{ID}": { "get": { "tags": [ "customers" ], "summary": "Retrieves a single customer instance.", "description": "Retrieves a customer with the specified ID.\n\nSecured By Domain: View: Customer\n\nScope: Customers", "produces": [ "application/json" ], "parameters": [ { "name": "ID", "in": "path", "description": "The Workday ID of the resource.\n\nAccepts:\n- **Workday ID**: Workday ID (32-character lowercase hexadecimal string).\n- **Reference ID**: Workday reference ID (Type=Value). Valid types: Customer_Reference_ID, Customer_ID", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|(Customer_Reference_ID|Customer_ID)=\\S+)$" } ], "responses": { "200": { "description": "Successful response. A successful response can return no matched data.", "schema": { "$ref": "#/definitions/customerView_6f49b2c25ade10000ffd8fc9fba00011" } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "401": { "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "403": { "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "404": { "description": "Resource not found. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/ERROR_MODEL_REFERENCE" } } }, "x-workday-internal-try-enabled": "true", "x-workday-operation-id": "6f49b2c25ade10000e8d6eb9a8f6000f", "x-workday-secured-by-domains": [ "View: Customer" ] } }, "/payments/{ID}": { "get": { "tags": [ "payments" ], "summary": "Retrieves a single customer invoice payment instance.", "description": "Retrieves a customer invoice payment with the specified ID.\n\nSecured By Domain: Process: Customer Invoice Payment\n\nScope: Customer Accounts", "produces": [ "application/json" ], "parameters": [ { "name": "ID", "in": "path", "description": "The Workday ID of the resource.\n\nAccepts:\n- **Workday ID**: Workday ID (32-character lowercase hexadecimal string).\n- **Reference ID**: Workday reference ID (Type=Value). Valid types: Customer_Payment_for_Invoices_Reference_ID", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|(Customer_Payment_for_Invoices_Reference_ID)=\\S+)$" } ], "responses": { "200": { "description": "Successful response. A successful response can return no matched data.", "schema": { "$ref": "#/definitions/viewCustomerPayment_e53233d2427c100015e5b5017dfd011f" } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "401": { "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "403": { "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "404": { "description": "Resource not found. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/ERROR_MODEL_REFERENCE" } } }, "x-workday-internal-try-enabled": "false", "x-workday-operation-id": "e53233d2427c100015e6847551190121", "x-workday-secured-by-domains": [ "Process: Customer Invoice Payment" ] } }, "/invoices/{ID}": { "get": { "tags": [ "invoices" ], "summary": "Retrieves a single customer invoice or adjustment instance.", "description": "Retrieves a customer invoice or adjustment with the specified ID.\n\nSecured By Domain: Process: Customer Invoice - View, Process: Project Billing - View\n\nScope: Customer Accounts, Project Billing", "produces": [ "application/json" ], "parameters": [ { "name": "ID", "in": "path", "description": "The Workday ID of the resource.\n\nAccepts:\n- **Workday ID**: Workday ID (32-character lowercase hexadecimal string).\n- **Reference ID**: Workday reference ID (Type=Value). Valid types: Customer_Invoice_Reference_ID, Customer_Invoice_Adjustment_Reference_ID", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|(Customer_Invoice_Reference_ID|Customer_Invoice_Adjustment_Reference_ID)=\\S+)$" } ], "responses": { "200": { "description": "Successful response. A successful response can return no matched data.", "schema": { "$ref": "#/definitions/customerInvoice_454806779bee100004de1cfb95640008" } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "401": { "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "403": { "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "404": { "description": "Resource not found. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/ERROR_MODEL_REFERENCE" } } }, "x-workday-internal-try-enabled": "true", "x-workday-operation-id": "454806779bee100004df49d18200000b", "x-workday-secured-by-domains": [ "Process: Customer Invoice - View", "Process: Project Billing - View" ] } }, "/invoicePDFs": { "get": { "tags": [ "invoicePDFs" ], "description": "\n\nSecured By Domain: Process: Customer Invoice - View, Process: Project Billing - View\n\nScope: Customer Accounts, Project Billing\n\nContains attachment(s) only", "produces": [ "application/octet-stream", "application/json" ], "parameters": [ { "name": "limit", "in": "query", "description": "The maximum number of objects in a single response. The default is 20. The maximum is 100.", "required": false, "type": "integer", "format": "int64" }, { "name": "offset", "in": "query", "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": false, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "Successful response. A successful response can return no matched data.", "schema": { "type": "file" } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "401": { "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "403": { "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "404": { "description": "Resource not found. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/ERROR_MODEL_REFERENCE" } } }, "x-workday-internal-try-enabled": "false", "x-workday-operation-id": "434ca66db8cb1000100aa98803e9000c", "x-workday-secured-by-domains": [ "Process: Customer Invoice - View", "Process: Project Billing - View" ] } }, "/invoicePDFs/{ID}": { "get": { "tags": [ "invoicePDFs" ], "summary": "Retrieves a single customer invoice PDF instance.", "description": "Retrieves a customer invoice PDF with the specified ID.\n\nSecured By Domain: Process: Customer Invoice - View, Process: Project Billing - View\n\nScope: Customer Accounts, Project Billing\n\nContains attachment(s) only", "produces": [ "application/octet-stream", "application/json" ], "parameters": [ { "name": "ID", "in": "path", "description": "The Workday ID of the resource.\n\nAccepts:\n- **Workday ID**: Workday ID (32-character lowercase hexadecimal string).\n- **Reference ID**: Workday reference ID (Type=Value). Valid types: Document_ID, Integration_Service_Component_ID, File_ID", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|(Document_ID|Integration_Service_Component_ID|File_ID)=\\S+)$" } ], "responses": { "200": { "description": "Successful response. A successful response can return no matched data.", "schema": { "type": "file" } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "401": { "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "403": { "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "404": { "description": "Resource not found. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/ERROR_MODEL_REFERENCE" } } }, "x-workday-internal-try-enabled": "false", "x-workday-operation-id": "434ca66db8cb1000100aa98803e9000c", "x-workday-secured-by-domains": [ "Process: Customer Invoice - View", "Process: Project Billing - View" ] } }, "/payments": { "get": { "tags": [ "payments" ], "description": "\n\nSecured By Domain: Process: Customer Invoice Payment\n\nScope: Customer Accounts", "produces": [ "application/json" ], "parameters": [ { "name": "limit", "in": "query", "description": "The maximum number of objects in a single response. The default is 20. The maximum is 100.", "required": false, "type": "integer", "format": "int64" }, { "name": "offset", "in": "query", "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": false, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "Successful response. A successful response can return no matched data.", "schema": { "type": "object", "properties": { "total": { "type": "integer", "format": "int64" }, "data": { "type": "array", "items": { "$ref": "#/definitions/viewCustomerPayment_e53233d2427c100015e5b5017dfd011f" } } } } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "401": { "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "403": { "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "404": { "description": "Resource not found. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/ERROR_MODEL_REFERENCE" } } }, "x-workday-internal-try-enabled": "false", "x-workday-operation-id": "e53233d2427c100015e6847551190121", "x-workday-secured-by-domains": [ "Process: Customer Invoice Payment" ] }, "post": { "tags": [ "payments" ], "summary": "Creates customer invoice payments.", "description": "Creates a single customer invoice payment header instance with the specified data. \n\nIn the request body, specify at least these required fields: company {id}, type {id}, payment amount and currency, payment date, and payment type {id}. Specify the remitFromCustomer {id} if the ready to auto-apply option is set to true. \n\nThis endpoint is equivalent to the Record Customer Payment task in Workday.\n\nSecured By Domain: Process: Customer Invoice Payment\n\nScope: Customer Accounts", "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "createCustomerPayment", "required": true, "schema": { "$ref": "#/definitions/createCustomerPayment_acb8755e2a5c10000944fa9215030016" } } ], "responses": { "201": { "description": "Resource created.", "schema": { "$ref": "#/definitions/createCustomerPayment_acb8755e2a5c10000944fa9215030016" } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)\n| Severity | Error Code | Validation Message |\n --- | --- | --- |\n| Critical | A144 | Enter a company. |\n| Critical | A145 | To set the ready to auto-apply option to yes, select a remit-from customer. |\n| Critical | A146 | Enter a payment currency. |\n| Critical | A147 | Enter a payment type. |\n| Critical | A149 | Enter a payment date. |\n| Critical | A150 | Payment types with a payment method of \"Credit Card\" or \"Direct Debit\" are not supported. |\n| Critical | A152 | Enter a total payment amount greater than 0. |", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "401": { "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "403": { "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "404": { "description": "Resource not found. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/ERROR_MODEL_REFERENCE" } } }, "x-workday-internal-try-enabled": "false", "x-workday-operation-id": "acb8755e2a5c10000946632fe88c001c", "x-workday-secured-by-domains": [ "Process: Customer Invoice Payment" ] } }, "/invoices": { "get": { "tags": [ "invoices" ], "summary": "Retrieves a collection of customer invoices and adjustments.", "description": "Retrieves all customer invoices and adjustments. \n\nYou can filter the invoice and adjustments using the following query parameters: company, billToCustomer, invoiceStatus, paymentStatus, transactionType, fromDueDate, toDueDate, fromInvoiceDate, toInvoiceDate.\n\nSecured By Domain: Process: Customer Invoice - View, Process: Project Billing - View\n\nScope: Customer Accounts, Project Billing", "produces": [ "application/json" ], "parameters": [ { "name": "billToCustomer", "in": "query", "description": "The customer on the invoice.", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" }, { "name": "company", "in": "query", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" }, { "name": "fromDueDate", "in": "query", "description": "The due date of the customer invoice or invoice adjustment as of the defined reporting date, formatted as YYYY-MM-DD.", "required": false, "type": "string", "format": "date" }, { "name": "fromInvoiceDate", "in": "query", "description": "The date of the customer invoice, formatted as YYYY-MM-DD.", "required": false, "type": "string", "format": "date" }, { "name": "invoiceStatus", "in": "query", "description": "The current status of an invoice document.\n\nInclude invoices with these invoice statuses:\nApproved (91b0d382d50848e898733757caa9f84a), \nCanceled (dc76c9b6446c11de98360015c5e6daf6), \nDenied (dc76c7cc446c11de98360015c5e6daf6), \nDraft (dc76c4fc446c11de98360015c5e6daf6), \nIncomplete(e264bc68581342baa70ab61bf71032fe), \nIn Progress (dc76c8bc446c11de98360015c5e6daf6).", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" }, { "name": "limit", "in": "query", "description": "The maximum number of objects in a single response. The default is 20. The maximum is 100.", "required": false, "type": "integer", "format": "int64" }, { "name": "offset", "in": "query", "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": false, "type": "integer", "format": "int64" }, { "name": "paymentStatus", "in": "query", "description": "The payment status of an invoice document. \n\nInclude invoices with these payments statuses:\nPaid (d9e4362a446c11de98360015c5e6daf6), \nUnpaid (d9e43940446c11de98360015c5e6daf6), \nPartially Paid (d9e43706446c11de98360015c5e6daf6).", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" }, { "name": "toDueDate", "in": "query", "description": "The due date of the customer invoice or invoice adjustment as of the defined reporting date, formatted as YYYY-MM-DD.", "required": false, "type": "string", "format": "date" }, { "name": "toInvoiceDate", "in": "query", "description": "The date of the customer invoice, formatted as YYYY-MM-DD.", "required": false, "type": "string", "format": "date" }, { "name": "transactionType", "in": "query", "description": "The transaction type of this customer transaction. Use the string \"invoice\" or \"adjustment\" to filter to retrieve either only invoices or adjustments.", "required": false, "type": "string" } ], "responses": { "200": { "description": "Successful response. A successful response can return no matched data.", "schema": { "type": "object", "properties": { "total": { "type": "integer", "format": "int64" }, "data": { "type": "array", "items": { "$ref": "#/definitions/customerInvoice_454806779bee100004de1cfb95640008" } } } } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "401": { "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "403": { "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "404": { "description": "Resource not found. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/ERROR_MODEL_REFERENCE" } } }, "x-workday-internal-try-enabled": "true", "x-workday-operation-id": "454806779bee100004df49d18200000b", "x-workday-secured-by-domains": [ "Process: Customer Invoice - View", "Process: Project Billing - View" ] } }, "/invoices/{ID}/printRuns/{subresourceID}": { "get": { "tags": [ "invoices" ], "summary": "Retrieves a single customer invoice print run.", "description": "Retrieves a customer invoice print run with the specified subresource ID for the specified customer invoice or adjustment.\n\nSecured By Domain: Process: Customer Invoice - View, Process: Project Billing - View\n\nScope: Customer Accounts, Project Billing", "produces": [ "application/json" ], "parameters": [ { "name": "ID", "in": "path", "description": "The Workday ID of the resource.\n\nAccepts:\n- **Workday ID**: Workday ID (32-character lowercase hexadecimal string).\n- **Reference ID**: Workday reference ID (Type=Value). Valid types: Customer_Invoice_Reference_ID, Customer_Invoice_Adjustment_Reference_ID", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|(Customer_Invoice_Reference_ID|Customer_Invoice_Adjustment_Reference_ID)=\\S+)$" }, { "name": "subresourceID", "in": "path", "description": "The Workday ID of the subresource.\n\nAccepts:\n- **Workday ID**: Workday ID (32-character lowercase hexadecimal string).", "required": true, "type": "string", "pattern": "^([0-9a-f]{32})$" } ], "responses": { "200": { "description": "Successful response. A successful response can return no matched data.", "schema": { "$ref": "#/definitions/printRun_2872e600aaf31000090b5d1de881000b" } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "401": { "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "403": { "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "404": { "description": "Resource not found. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/ERROR_MODEL_REFERENCE" } } }, "x-workday-internal-try-enabled": "true", "x-workday-operation-id": "2872e600aaf31000090bc95dab48000d", "x-workday-secured-by-domains": [ "Process: Customer Invoice - View", "Process: Project Billing - View" ] } }, "/invoices/{ID}/printRuns": { "get": { "tags": [ "invoices" ], "summary": "Retrieves a collection of customer invoice print runs for the specified customer invoice or adjustment.", "description": "Retrieves all customer invoice print runs for the specified customer invoice or adjustment.\n\nSecured By Domain: Process: Customer Invoice - View, Process: Project Billing - View\n\nScope: Customer Accounts, Project Billing", "produces": [ "application/json" ], "parameters": [ { "name": "ID", "in": "path", "description": "The Workday ID of the resource.\n\nAccepts:\n- **Workday ID**: Workday ID (32-character lowercase hexadecimal string).\n- **Reference ID**: Workday reference ID (Type=Value). Valid types: Customer_Invoice_Reference_ID, Customer_Invoice_Adjustment_Reference_ID", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|(Customer_Invoice_Reference_ID|Customer_Invoice_Adjustment_Reference_ID)=\\S+)$" }, { "name": "limit", "in": "query", "description": "The maximum number of objects in a single response. The default is 20. The maximum is 100.", "required": false, "type": "integer", "format": "int64" }, { "name": "offset", "in": "query", "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": false, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "Successful response. A successful response can return no matched data.", "schema": { "type": "object", "properties": { "total": { "type": "integer", "format": "int64" }, "data": { "type": "array", "items": { "$ref": "#/definitions/printRun_2872e600aaf31000090b5d1de881000b" } } } } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "401": { "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "403": { "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "404": { "description": "Resource not found. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/ERROR_MODEL_REFERENCE" } } }, "x-workday-internal-try-enabled": "true", "x-workday-operation-id": "2872e600aaf31000090bc95dab48000d", "x-workday-secured-by-domains": [ "Process: Customer Invoice - View", "Process: Project Billing - View" ] } }, "/customers": { "get": { "tags": [ "customers" ], "summary": "Retrieves a collection of customers.", "description": "Retrieves all customers. \n\nYou can filter the customers using the following query parameters: name.\n\nSecured By Domain: View: Customer\n\nScope: Customers", "produces": [ "application/json" ], "parameters": [ { "name": "limit", "in": "query", "description": "The maximum number of objects in a single response. The default is 20. The maximum is 100.", "required": false, "type": "integer", "format": "int64" }, { "name": "name", "in": "query", "required": false, "type": "string" }, { "name": "offset", "in": "query", "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": false, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "Successful response. A successful response can return no matched data.", "schema": { "type": "object", "properties": { "total": { "type": "integer", "format": "int64" }, "data": { "type": "array", "items": { "$ref": "#/definitions/customerView_6f49b2c25ade10000ffd8fc9fba00011" } } } } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "401": { "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "403": { "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "404": { "description": "Resource not found. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/ERROR_MODEL_REFERENCE" } } }, "x-workday-internal-try-enabled": "true", "x-workday-operation-id": "6f49b2c25ade10000e8d6eb9a8f6000f", "x-workday-secured-by-domains": [ "View: Customer" ] } }, "/payments/{ID}/remittanceDetails": { "post": { "tags": [ "payments" ], "summary": "Creates customer invoice payment remittance lines.", "description": "Creates customer invoice payment lines with the specified data for the specified customer invoice payment ID. \n\nTo create a single instance, specify the single JSON object in the request body. To create multiple instances, specify \"bulk=true\" as a query parameter. You must specify the JSON object collection in data[ ] in the request body. The maximum collection size is 100.\n\nIn the request body, specify at least one of these required fields: billToCustomer{id}, invoice {id}, or amountToPay.\n\nSecured By Domain: Process: Customer Invoice Payment\n\nScope: Customer Accounts", "produces": [ "application/json" ], "parameters": [ { "name": "ID", "in": "path", "description": "The Workday ID of the resource.\n\nAccepts:\n- **Workday ID**: Workday ID (32-character lowercase hexadecimal string).\n- **Reference ID**: Workday reference ID (Type=Value). Valid types: Customer_Payment_for_Invoices_Reference_ID", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|(Customer_Payment_for_Invoices_Reference_ID)=\\S+)$" }, { "in": "body", "name": "createRemittanceDetails", "required": true, "schema": { "$ref": "#/definitions/createRemittanceDetails_c4802df362a6100002fb64e6b98e00e6" } } ], "responses": { "201": { "description": "Resource created.", "schema": { "$ref": "#/definitions/createRemittanceDetails_c4802df362a6100002fb64e6b98e00e6" } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)\n| Severity | Error Code | Validation Message |\n --- | --- | --- |\n| Critical | A148 | Ensure the invoice company on the remittance detail matches the payment company. |\n| Critical | A151 | Ensure the invoice you select for the remittance detail match the payment currency. |\n| Critical | A153 | Ensure the currency in the amount to pay of the remittance details matches the payment currency. |\n| Critical | A154 | Remittance lines may only be added to payments with payment status in progress or draft, and with payment application status unapplied. |\n| Critical | A155 | Either bill-to customer or invoice must be specified for the remittance detail. |\n| Critical | A157 | Remittance advice may not be added to cross-currency payments. |", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "401": { "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "403": { "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "404": { "description": "Resource not found. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/ERROR_MODEL_REFERENCE" } } }, "x-workday-internal-try-enabled": "false", "x-workday-operation-id": "c4802df362a6100002fcbc1545a800e8", "x-workday-secured-by-domains": [ "Process: Customer Invoice Payment" ] } } }, "securityDefinitions": { "OAuth2": { "type": "oauth2", "authorizationUrl": "https://", "flow": "implicit" } }, "definitions": { "INSTANCE_MODEL_REFERENCE": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "Workday Id or Reference Id of the instance.", "pattern": "^(([0-9a-f]{32})|(\\S+=\\S+))$" }, "descriptor": { "type": "string", "description": "The display name of the instance", "readOnly": true }, "href": { "type": "string", "description": "A link to the instance", "readOnly": true } } }, "ERROR_MODEL_REFERENCE": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string", "description": "A description of the error" }, "code": { "type": "string", "description": "The code that corresponds to the error message. Use the error code to drive programmatic error-handling behavior. Don't use error message strings for this purpose because they are subject to change" }, "field": { "type": "string", "description": "The field related to the error" }, "path": { "type": "string", "description": "The path of the field related to the error" }, "severity": { "type": "string", "description": "Severity of the validation (e.g. Critical, Warning)." }, "internalMessage": { "type": "string", "description": "Internal message providing additional context for the validation (e.g. representation content validation details)." } } }, "VALIDATION_ERROR_MODEL_REFERENCE": { "allOf": [ { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string", "description": "A description of the error" }, "errors": { "type": "array", "description": "An array of validation errors", "items": { "$ref": "#/definitions/ERROR_MODEL_REFERENCE" } } } } ] }, "FACETS_MODEL_REFERENCE": { "type": "array", "items": { "type": "object", "description": "This object represents the possible facets for this resource", "readOnly": true, "properties": { "descriptor": { "type": "string", "description": "A description of the facet" }, "facetParameter": { "type": "string", "description": "The alias used to select the facet" }, "values": { "type": "array", "description": "the facet values", "items": { "type": "object", "properties": { "count": { "type": "integer", "format": "int32", "description": "The number of instances returned by this facet" }, "id": { "type": "string", "description": "Workday Id or Reference Id of the instance.", "pattern": "^(([0-9a-f]{32})|(\\S+=\\S+))$" }, "descriptor": { "type": "string", "description": "A description of the facet" }, "href": { "type": "string", "description": "A link to the instance", "readOnly": true } }, "required": [ "id" ] } } } } }, "MULTIPLE_INSTANCE_MODEL_REFERENCE": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" } } } }, "WorkdayId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Workday ID (32-character lowercase hexadecimal string).", "example": "a3f5b554007d20e98360015c5e6daf6" }, "WorkdayReferenceId_invoices": { "type": "string", "pattern": "^(Customer_Invoice_Reference_ID|Customer_Invoice_Adjustment_Reference_ID)=\\S+$", "description": "Workday reference ID (Type=Value). Valid types: Customer_Invoice_Reference_ID, Customer_Invoice_Adjustment_Reference_ID", "example": "Customer_Invoice_Reference_ID=21002" }, "ResourceIdPathValue_invoices": {}, "company_454806779bee100004de1d18a6800009": { "allOf": [ { "$ref": "#/definitions/companyDisplay_454806779bee100012868f74a4de125e" }, {} ], "description": "The company for the customer invoice." }, "invoiceType_454806779bee10001555335a57a4127f": { "allOf": [ { "$ref": "#/definitions/invoiceTypeDisplay_454806779bee1000171c7f7347d612a2" }, {} ], "description": "An invoice type for the associated customer invoice." }, "adjustmentReason_ea22ae003e8f100003ff6fe709020057": { "allOf": [ { "$ref": "#/definitions/relatedAdjustmentReasonDisplay_ea22ae003e8f10000b96a781d0770086" }, {} ], "description": "The reason for the customer invoice adjustment. Only returns reason for customer invoice adjustments." }, "relatedInvoice_ea22ae003e8f100003ff702208870059": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "Customer invoice associated with the invoice adjustment. This field is empty for customer invoices." }, "paymentStatus_454806779bee100015553345672c127e": { "allOf": [ { "$ref": "#/definitions/paymentStatusDisplay_454806779bee100015be3e7130161284" }, {} ], "description": "The document payment status for an invoice document." }, "currency_ea22ae003e8f100003ff7033ef99005b": { "allOf": [ { "$ref": "#/definitions/currencyDisplay_ea22ae003e8f1000113e1136deee008c" }, {} ], "description": "The transaction currency of the customer invoice." }, "billToCustomer_b5f6a7e6fd141000090ddc8fcdab00ec": { "allOf": [ { "$ref": "#/definitions/customerDisplay_b5f6a7e6fd1410000904c22f10a500ea" }, {} ], "description": "The customer on the invoice." }, "billToCustomerAddress_6fae704362ee1000095084fe10ee02e8": { "allOf": [ { "$ref": "#/definitions/billToAddressDisplay_6fae704362ee1000094eadc444eb02d9" }, {} ], "description": "The Bill-To address for the customer on the customer invoice." }, "invoiceStatus_454806779bee10001555336692021280": { "allOf": [ { "$ref": "#/definitions/invoiceStatusDisplay_454806779bee10001671ec898aac128b" }, {} ], "description": "The current status of the Invoice Document." }, "customerInvoice_454806779bee100004de1cfb95640008": { "allOf": [ { "type": "object", "properties": { "invoiceDate": { "type": "string", "format": "date", "example": "2026-11-02T08:00:00.000Z", "description": "The date of the customer invoice.", "x-workday-type": "Date" }, "transactionType": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The type of customer invoice document, either Invoice or Adjustment.", "x-workday-type": "Text" }, "withholdingAmount": { "type": "object", "description": "The tax amount that you withhold from the customer invoice.", "properties": { "value": { "type": "string", "example": "99999999999.999999", "description": "The amount, represented as a decimal string with up to 20 integer digit(s) and up to 6 decimal digit(s). May be negative. Omitted from the response when the amount is zero.", "pattern": "^-?\\d{1,20}(\\.\\d{1,6})?$" }, "currency": { "type": "string", "example": "USD", "description": "The ISO 4217 code identifying the currency of the amount." } }, "x-workday-type": "Currency" }, "company": { "$ref": "#/definitions/company_454806779bee100004de1d18a6800009" }, "inCollection": { "type": "boolean", "example": true, "description": "A flag when set to true, places the invoices into collections.", "x-workday-type": "Boolean" }, "netAmount": { "type": "object", "description": "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.", "properties": { "value": { "type": "string", "example": "99999999999.999999", "description": "The amount, represented as a decimal string with up to 20 integer digit(s) and up to 6 decimal digit(s). May be negative. Omitted from the response when the amount is zero.", "pattern": "^-?\\d{1,20}(\\.\\d{1,6})?$" }, "currency": { "type": "string", "example": "USD", "description": "The ISO 4217 code identifying the currency of the amount." } }, "x-workday-type": "Currency" }, "disputeAmount": { "type": "object", "description": "The amount you dispute on a customer invoice.", "properties": { "value": { "type": "string", "example": "99999999999.999999", "description": "The amount, represented as a decimal string with up to 20 integer digit(s) and up to 6 decimal digit(s). May be negative. Omitted from the response when the amount is zero.", "pattern": "^-?\\d{1,20}(\\.\\d{1,6})?$" }, "currency": { "type": "string", "example": "USD", "description": "The ISO 4217 code identifying the currency of the amount." } }, "x-workday-type": "Currency" }, "dueAmount": { "type": "object", "description": "The amount due for the customer invoice. The value can be positive or negative.", "properties": { "value": { "type": "string", "example": "99999999999.999999", "description": "The amount, represented as a decimal string with up to 20 integer digit(s) and up to 6 decimal digit(s). May be negative. Omitted from the response when the amount is zero.", "pattern": "^-?\\d{1,20}(\\.\\d{1,6})?$" }, "currency": { "type": "string", "example": "USD", "description": "The ISO 4217 code identifying the currency of the amount." } }, "x-workday-type": "Currency" }, "invoiceType": { "$ref": "#/definitions/invoiceType_454806779bee10001555335a57a4127f" }, "poNumber": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The purchase order number specified on the customer invoice.", "x-workday-type": "Text" }, "relatedAdjustments": { "type": "array", "description": "Adjustments for a customer Invoice.", "items": { "$ref": "#/definitions/relatedAdjustments_ea22ae003e8f100003ff7017bed70058" }, "x-workday-type": "Multi-instance" }, "adjustmentReason": { "$ref": "#/definitions/adjustmentReason_ea22ae003e8f100003ff6fe709020057" }, "taxAmount": { "type": "object", "description": "The total tax amount for the document with sign.", "properties": { "value": { "type": "string", "example": "99999999999.999999", "description": "The amount, represented as a decimal string with up to 20 integer digit(s) and up to 6 decimal digit(s). May be negative. Omitted from the response when the amount is zero.", "pattern": "^-?\\d{1,20}(\\.\\d{1,6})?$" }, "currency": { "type": "string", "example": "USD", "description": "The ISO 4217 code identifying the currency of the amount." } }, "x-workday-type": "Currency" }, "disputeDate": { "type": "string", "format": "date", "example": "2026-11-02T08:00:00.000Z", "description": "The date you place the customer invoice in dispute.", "x-workday-type": "Date" }, "relatedInvoice": { "$ref": "#/definitions/relatedInvoice_ea22ae003e8f100003ff702208870059" }, "paymentStatus": { "$ref": "#/definitions/paymentStatus_454806779bee100015553345672c127e" }, "currency": { "$ref": "#/definitions/currency_ea22ae003e8f100003ff7033ef99005b" }, "memo": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The memo for the customer invoice.", "x-workday-type": "Text" }, "disputeReasons": { "type": "array", "description": "The reasons for invoice dispute.", "items": { "$ref": "#/definitions/disputeReasonDisplay_ea22ae003e8f1000071353909aa6006a" }, "x-workday-type": "Multi-instance" }, "billToCustomer": { "$ref": "#/definitions/billToCustomer_b5f6a7e6fd141000090ddc8fcdab00ec" }, "dueDate": { "type": "string", "format": "date", "example": "2026-11-02T08:00:00.000Z", "description": "The due date of the customer invoice or invoice adjustment as of the defined reporting date.", "x-workday-type": "Date" }, "inDispute": { "type": "boolean", "example": true, "description": "True if the invoice is in dispute.", "x-workday-type": "Boolean" }, "billToCustomerAddress": { "$ref": "#/definitions/billToCustomerAddress_6fae704362ee1000095084fe10ee02e8" }, "invoiceStatus": { "$ref": "#/definitions/invoiceStatus_454806779bee10001555336692021280" }, "retentionAmount": { "type": "object", "description": "Total retention amount from invoice lines.", "properties": { "value": { "type": "string", "example": "99999999999.999999", "description": "The amount, represented as a decimal string with up to 20 integer digit(s) and up to 6 decimal digit(s). May be negative. Omitted from the response when the amount is zero.", "pattern": "^-?\\d{1,20}(\\.\\d{1,6})?$" }, "currency": { "type": "string", "example": "USD", "description": "The ISO 4217 code identifying the currency of the amount." } }, "x-workday-type": "Currency" }, "totalAmount": { "type": "object", "description": "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.", "properties": { "value": { "type": "string", "example": "99999999999.999999", "description": "The amount, represented as a decimal string with up to 20 integer digit(s) and up to 6 decimal digit(s). May be negative. Omitted from the response when the amount is zero.", "pattern": "^-?\\d{1,20}(\\.\\d{1,6})?$" }, "currency": { "type": "string", "example": "USD", "description": "The ISO 4217 code identifying the currency of the amount." } }, "x-workday-type": "Currency" }, "invoiceNumber": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The customer invoice number.", "x-workday-type": "Text" }, "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" }, "href": { "type": "string", "description": "A link to the instance" }, "id": { "type": "string", "description": "The id for Customer Invoice Document" } } } ] }, "ResourceIdPathValue_printRuns": {}, "pdf_2872e600aaf3100017ce30bcabd6003e": { "allOf": [ { "$ref": "#/definitions/invoicePDFDisplay_2872e600aaf3100017d702a7fa960040" }, {} ], "description": "The PDF file associated with a customer invoice for a given printing run." }, "printRunType_2872e600aaf310000d58e10605e30027": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The print run type of the Customer Invoice Printing Run." }, "printRun_2872e600aaf31000090b5d1de881000b": { "allOf": [ { "type": "object", "properties": { "pdf": { "$ref": "#/definitions/pdf_2872e600aaf3100017ce30bcabd6003e" }, "printedDateTime": { "type": "string", "format": "date-time", "example": "2026-11-02T08:00:00.000Z", "description": "The date when the customer invoice was printed.", "x-workday-type": "Date" }, "deliveryMethod": { "type": "array", "description": "The delivery method associated with the print run of the customer invoice.", "items": { "$ref": "#/definitions/deliveryMethodDisplay_2872e600aaf310001620b7746c190032" }, "x-workday-type": "Multi-instance" }, "printRunType": { "$ref": "#/definitions/printRunType_2872e600aaf310000d58e10605e30027" }, "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" }, "id": { "type": "string", "description": "The id for Customer Invoice Printing Run" } } } ] }, "WorkdayReferenceId_invoicePDFs": { "type": "string", "pattern": "^(Document_ID|Integration_Service_Component_ID|File_ID)=\\S+$", "description": "Workday reference ID (Type=Value). Valid types: Document_ID, Integration_Service_Component_ID, File_ID", "example": "Document_ID=21002" }, "ResourceIdPathValue_invoicePDFs": {}, "WorkdayReferenceId_customers": { "type": "string", "pattern": "^(Customer_Reference_ID|Customer_ID)=\\S+$", "description": "Workday reference ID (Type=Value). Valid types: Customer_Reference_ID, Customer_ID", "example": "Customer_Reference_ID=21002" }, "ResourceIdPathValue_customers": {}, "paymentTerms_89bd3613f2ed10000efbeeadab6d0034": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The default payment terms for the customer or \\~sponsor\\~" }, "category_89bd3613f2ed10000f374fd397e30039": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The category for the customer. A customer can only be in 1 customer category." }, "customerView_6f49b2c25ade10000ffd8fc9fba00011": { "allOf": [ { "type": "object", "properties": { "paymentTerms": { "$ref": "#/definitions/paymentTerms_89bd3613f2ed10000efbeeadab6d0034" }, "satisfactionScore": { "type": "integer", "example": "99999999999", "description": "The customer satisfaction score.", "x-workday-type": "Numeric" }, "name": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The name of the customer.", "x-workday-type": "Text" }, "primaryPhone": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The primary phone number of the customer.", "x-workday-type": "Text" }, "commercialCreditScore": { "type": "integer", "example": "99999999999", "description": "The Dun and Bradstreet Commercial credit score of the customer.", "x-workday-type": "Numeric" }, "groups": { "type": "array", "description": "The customer group a customer belongs to. A customer can be part of multiple customer groups.", "items": { "$ref": "#/definitions/groups_89bd3613f2ed10000f27eb70f3aa0036" }, "x-workday-type": "Multi-instance" }, "compositeRiskScore": { "type": "integer", "example": "99999999999", "description": "The Dun and Bradstreet risk score of the customer.", "x-workday-type": "Numeric" }, "category": { "$ref": "#/definitions/category_89bd3613f2ed10000f374fd397e30039" }, "totalBalance": { "type": "object", "description": "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.", "properties": { "value": { "type": "string", "example": "99999999999.999999", "description": "The amount, represented as a decimal string with up to 20 integer digit(s) and up to 6 decimal digit(s). May be negative. Omitted from the response when the amount is zero.", "pattern": "^-?\\d{1,20}(\\.\\d{1,6})?$" }, "currency": { "type": "string", "example": "USD", "description": "The ISO 4217 code identifying the currency of the amount." } }, "x-workday-type": "Currency" }, "creditLimit": { "type": "object", "description": "The maximum credit limit for the customer.", "properties": { "value": { "type": "string", "example": "99999999999.999999", "description": "The amount, represented as a decimal string with up to 20 integer digit(s) and up to 6 decimal digit(s). Must not be negative. Omitted from the response when the amount is zero.", "pattern": "^\\d{1,20}(\\.\\d{1,6})?$" }, "currency": { "type": "string", "example": "USD", "description": "The ISO 4217 code identifying the currency of the amount." } }, "x-workday-type": "Currency" }, "id": { "type": "string", "description": "The id for Customer" }, "Customer_Reference_ID": { "type": "string", "description": "Reference id of the instance" }, "Customer_ID": { "type": "string", "description": "Reference id of the instance" } } } ] }, "WorkdayReferenceId_payments": { "type": "string", "pattern": "^(Customer_Payment_for_Invoices_Reference_ID)=\\S+$", "description": "Workday reference ID (Type=Value). Valid types: Customer_Payment_for_Invoices_Reference_ID", "example": "Customer_Payment_for_Invoices_Reference_ID=21002" }, "ResourceIdPathValue_payments": {}, "viewCustomerPayment_e53233d2427c100015e5b5017dfd011f": { "allOf": [ { "type": "object", "properties": { "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" }, "id": { "type": "string", "description": "Workday Id or Reference Id of the instance." }, "Customer_Payment_for_Invoices_Reference_ID": { "type": "string", "description": "Reference id of the instance" } } } ] }, "company_acb8755e2a5c10000944fadc811f001a": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The company for the customer invoice." }, "remitFromCustomer_a5e8680980e310000bcc72814bdc00ed": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The customer for the invoice." }, "type_acb8755e2a5c10000944fab4cb6a0017": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The payment type for the reporting transaction." }, "createCustomerPayment_acb8755e2a5c10000944fa9215030016": { "allOf": [ { "type": "object", "properties": { "company": { "$ref": "#/definitions/company_acb8755e2a5c10000944fadc811f001a" }, "date": { "type": "string", "format": "date", "example": "2026-11-02T08:00:00.000Z", "description": "The date the customer payment was made.", "x-workday-type": "Date" }, "remitFromCustomer": { "$ref": "#/definitions/remitFromCustomer_a5e8680980e310000bcc72814bdc00ed" }, "memo": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "A memo associated with the customer payment.", "x-workday-type": "Text" }, "reference": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "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.", "x-workday-type": "Text" }, "transactionNumber": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The transaction number for the reporting transaction.", "x-workday-type": "Text" }, "readyToAutoApply": { "type": "boolean", "example": true, "description": "True if the customer payment is ready for automatic application for a cash sale.", "x-workday-type": "Boolean" }, "type": { "$ref": "#/definitions/type_acb8755e2a5c10000944fab4cb6a0017" }, "amount": { "type": "object", "description": "The amount of the customer payment in transaction currency.", "properties": { "value": { "type": "string", "example": "99999999999.999", "description": "The amount, represented as a decimal string with up to 15 integer digit(s) and up to 3 decimal digit(s). May be negative. Omitted from the response when the amount is zero.", "pattern": "^-?\\d{1,15}(\\.\\d{1,3})?$" }, "currency": { "type": "string", "example": "USD", "description": "The ISO 4217 code identifying the currency of the amount." } }, "x-workday-type": "Currency" }, "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" }, "id": { "type": "string", "description": "The id for Customer Payment for Invoices" } } } ] }, "ResourceIdPathValue_remittanceDetails": {}, "viewRemittanceDetails_17b89f3dcfab1000056c7a877cbe00f1": { "allOf": [ { "type": "object", "properties": { "id": { "type": "string", "description": "Workday Id or Reference Id of the instance." } } } ] }, "billToCustomer_c4802df362a6100003fff37f553a00eb": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The bill-to customer or sponsor specified on the invoice line of the customer payment." }, "invoice_53f0b4fc8cb210001bc7a99530cf01ab": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The invoice associated with the payment remittance." }, "createRemittanceDetails_c4802df362a6100002fb64e6b98e00e6": { "allOf": [ { "type": "object", "properties": { "amountToPay": { "type": "object", "description": "The amount to pay specified on the invoice line of the customer payment.", "properties": { "value": { "type": "string", "example": "99999999999.999", "description": "The amount, represented as a decimal string with up to 15 integer digit(s) and up to 3 decimal digit(s). May be negative. Omitted from the response when the amount is zero.", "pattern": "^-?\\d{1,15}(\\.\\d{1,3})?$" }, "currency": { "type": "string", "example": "USD", "description": "The ISO 4217 code identifying the currency of the amount." } }, "x-workday-type": "Currency" }, "billToCustomer": { "$ref": "#/definitions/billToCustomer_c4802df362a6100003fff37f553a00eb" }, "invoice": { "$ref": "#/definitions/invoice_53f0b4fc8cb210001bc7a99530cf01ab" }, "id": { "type": "string", "description": "The id for Customer Payment Remittance Advice" } } } ] }, "companyDisplay_454806779bee100012868f74a4de125e": { "allOf": [ { "type": "object", "properties": { "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" }, "id": { "type": "string", "description": "The id for Company \nExample(s): Company_Reference_ID=Sample_Value" }, "Company_Reference_ID": { "type": "string", "description": "Reference id of the instance" } } } ] }, "invoiceTypeDisplay_454806779bee1000171c7f7347d612a2": { "allOf": [ { "type": "object", "properties": { "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" }, "Customer_Invoice_Type_ID": { "type": "string", "description": "Reference id of the instance" } } } ] }, "relatedAdjustmentDisplay_ea22ae003e8f1000076f15328dc70070": { "allOf": [ { "type": "object", "properties": { "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" }, "href": { "type": "string", "description": "A link to the instance" }, "id": { "type": "string", "description": "The id for Customer Invoice Adjustment" } } } ] }, "relatedAdjustmentReasonDisplay_ea22ae003e8f10000b96a781d0770086": { "allOf": [ { "type": "object", "properties": { "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" }, "Adjustment_Reason_ID": { "type": "string", "description": "Reference id of the instance" } } } ] }, "paymentStatusDisplay_454806779bee100015be3e7130161284": { "allOf": [ { "type": "object", "properties": { "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" }, "id": { "type": "string", "description": "The id for Document Payment Status \nExample(s): Document_Payment_Status_ID=Sample_Value" }, "Document_Payment_Status_ID": { "type": "string", "description": "Reference id of the instance" } } } ] }, "currencyDisplay_ea22ae003e8f1000113e1136deee008c": { "allOf": [ { "type": "object", "properties": { "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" }, "Currency_ID": { "type": "string", "description": "Reference id of the instance" } } } ] }, "disputeReasonDisplay_ea22ae003e8f1000071353909aa6006a": { "allOf": [ { "type": "object", "properties": { "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" }, "Dispute_Reason_ID": { "type": "string", "description": "Reference id of the instance" } } } ] }, "customerDisplay_b5f6a7e6fd1410000904c22f10a500ea": { "allOf": [ { "type": "object", "properties": { "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" }, "id": { "type": "string", "description": "The id for Customer \nExample(s): Customer_Reference_ID=Sample_Value, Customer_ID=Sample_Value" }, "Customer_Reference_ID": { "type": "string", "description": "Reference id of the instance" }, "Customer_ID": { "type": "string", "description": "Reference id of the instance" } } } ] }, "countryRegionDisplay_6fae704362ee10000974dae97e9102ef": { "allOf": [ { "type": "object", "properties": { "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" }, "Country_Region_ID": { "type": "string", "description": "Reference id of the instance" } } } ] }, "countryDisplay_6fae704362ee1000096afa6dcf9002ec": { "allOf": [ { "type": "object", "properties": { "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" }, "ISO_3166-1_Alpha-3_Code": { "type": "string", "description": "Reference id of the instance" } } } ] }, "countryRegion_6fae704362ee1000094eae57a3f402e4": { "allOf": [ { "$ref": "#/definitions/countryRegionDisplay_6fae704362ee10000974dae97e9102ef" }, {} ], "description": "The region of the country of the bill-to customer." }, "country_6fae704362ee1000094eae22e9bc02df": { "allOf": [ { "$ref": "#/definitions/countryDisplay_6fae704362ee1000096afa6dcf9002ec" }, {} ], "description": "The country of the bill-to customer." }, "billToAddressDisplay_6fae704362ee1000094eadc444eb02d9": { "allOf": [ { "type": "object", "properties": { "regionSubdivision1": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The subdivision of the region of the bill-to customer.", "x-workday-type": "Text" }, "countryRegion": { "$ref": "#/definitions/countryRegion_6fae704362ee1000094eae57a3f402e4" }, "addressLine3": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The third address line for the bill-to customer.", "x-workday-type": "Text" }, "citySubdivision1": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The subdivision of the city of the bill-to customer.", "x-workday-type": "Text" }, "addressLine1": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The first address line for the bill-to customer.", "x-workday-type": "Text" }, "addressLine4": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The fourth address line for the bill-to customer.", "x-workday-type": "Text" }, "city": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The city of the bill-to customer.", "x-workday-type": "Text" }, "citySubdivision2": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The second subdivision of the city of the bill-to customer.", "x-workday-type": "Text" }, "country": { "$ref": "#/definitions/country_6fae704362ee1000094eae22e9bc02df" }, "addressLine2": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The second address line for the bill-to customer.", "x-workday-type": "Text" }, "regionSubdivision2": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The second subdivision of the region of the bill-to customer.", "x-workday-type": "Text" }, "postalCode": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The postal code of the bill-to customer.", "x-workday-type": "Text" }, "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" }, "id": { "type": "string", "description": "The id for Address" } } } ] }, "invoiceStatusDisplay_454806779bee10001671ec898aac128b": { "allOf": [ { "type": "object", "properties": { "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" }, "id": { "type": "string", "description": "The id for Document Status \nExample(s): Document_Status_ID=Sample_Value" }, "Document_Status_ID": { "type": "string", "description": "Reference id of the instance" } } } ] }, "relatedAdjustments_ea22ae003e8f100003ff7017bed70058": { "allOf": [ { "$ref": "#/definitions/relatedAdjustmentDisplay_ea22ae003e8f1000076f15328dc70070" }, { "properties": { "id": { "type": "string", "description": "The id for Customer Invoice Adjustment" } } } ] }, "invoicePDFDisplay_2872e600aaf3100017d702a7fa960040": { "allOf": [ { "type": "object", "properties": { "name": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The name of the PDF file associated with the customer invoice.", "x-workday-type": "Text" }, "id": { "type": "string", "description": "The id for Repository Document (Abstract)" } } } ] }, "deliveryMethodDisplay_2872e600aaf310001620b7746c190032": { "allOf": [ { "type": "object", "properties": { "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" }, "Delivery_Method_Reference_ID": { "type": "string", "description": "Reference id of the instance" } } } ] }, "customerGroup_89bd3613f2ed10000f549a4139d9003b": { "allOf": [ { "type": "object", "properties": { "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" }, "id": { "type": "string", "description": "The id for Customer Group" } } } ] }, "groups_89bd3613f2ed10000f27eb70f3aa0036": { "allOf": [ { "$ref": "#/definitions/customerGroup_89bd3613f2ed10000f549a4139d9003b" }, { "properties": { "id": { "type": "string", "description": "The id for Customer Group" } } } ] } } }