setClientPackagingDefaults

Overview

This method sets the salary packaging defaults for a client.

This method requires the ClientPackagingDefaults:Set permission to be associated with your role.

Permissions

The permission for this api is stored in [gb_api_permissions]permission as 'ClientPackagingDefaults:Set'.

Only roles with a stored link to this permission in [gb_role_api_permissions] can run this api.

HTTP Method

Use the HTTP Method 'PUT' for consuming this web service.

URL Examples

https://api.demo.catch-e.com/sp/client/packaging-defaults/1234 https://api.{{environment}}.catch-e.com/sp/client/packaging-defaults/1234 https://api.test.catch-e.com/sp/client/packaging-defaults/1234

Input Fields (Header)

Key	Format	Notes	Mandatory
Audit-User-Id	string	(Optional) User Id to use for audit purposes. Up to 5 digits. Requires the Audit:UserIdOverride permission.	No

Path Parameters

Key	Format	Notes	Mandatory
client_id	string	The Client Id. A positive whole number, up to 10 digits, with no leading zeros.	Yes

Input Fields (JSON)

Key	Format	Notes	Mandatory
pay_run_start	integer		No
pay_run_start2	integer		No
pay_run_start3	integer		No
taxable_sales	string	Allowed values: `only-fees`, `all-items`.	No
pay_run_processing_state	string	Allowed values: `VIC`, `NSW`, `ACT`, `QLD`, `WA`, `SA`, `TAS`, `NT`, `NZ`.	No
pay_run_weekend_treatment	string	Allowed values: `leave-as-weekend`, `pay-on-friday`, `pay-on-monday`.	No
report_delivery_type	string	Allowed values: `email`, `post`. Default `email`.	No
report_groups	array of strings		No
payroll_pre_tax	string		No
payroll_post_tax	string		No
payroll_fbt	string		No
payroll_lcc	string		No
payroll_gst	string		No
payroll_itc	string		No
bank_account_enabled_flag	string	Allowed values: `yes`, `no`.	No
financial_institution_id	string	Financial Institution.	No
bank_account_name	string	Bank Account Name.	No
bank_account_name_short	string	Abbreviated Bank Account Name.	No
bank_bsb	string	Bank BSB.	No
bank_account_number	string	Bank Account number.	No
apca_number	string	Bank APCA (BSB).	No
aba_description	string	Disbursements (ABA) Description.	No
aba_self_balancing_flag	string	Add balancing row to Disbursements (ABA) files. Allowed values: `yes`, `no`. Default `yes`.	No

Example

{ "taxable_sales": "only-fees", "pay_run_processing_state": "VIC", "pay_run_weekend_treatment": "pay-on-monday", "report_delivery_type": "email", "aba_self_balancing_flag": "yes" }

Response Details

Success

200 - OK

Returns the client's packaging defaults.

Field	Format	Notes
client_packaging_default_id	string	Client Packaging Default Id.
client_id	string	Client Id.
pay_run_start	integer
pay_run_start2	integer
pay_run_start3	integer
taxable_sales	string	Values: `only-fees`, `all-items`.
pay_run_processing_state	string	Values: `VIC`, `NSW`, `ACT`, `QLD`, `WA`, `SA`, `TAS`, `NT`, `NZ`.
pay_run_weekend_treatment	string	Values: `leave-as-weekend`, `pay-on-friday`, `pay-on-monday`.
report_delivery_type	string	Values: `email`, `post`.
report_groups	array of strings
payroll_pre_tax	string
payroll_post_tax	string
payroll_fbt	string
payroll_lcc	string
payroll_gst	string
payroll_itc	string
bank_account_enabled_flag	string	Values: `yes`, `no`.
financial_institution_id	string	Financial Institution.
bank_account_name	string	Bank Account Name.
bank_account_name_short	string	Abbreviated Bank Account Name.
bank_bsb	string	Bank BSB.
bank_account_number	string	Bank Account number.
apca_number	string	Bank APCA (BSB).
aba_description	string	Disbursements (ABA) Description.
aba_self_balancing_flag	string	Add balancing row to Disbursements (ABA) files. Values: `yes`, `no`.

{ "_links": { "self": { "href": "https://api.catch-e.loc/sp/client/packaging-defaults/1234" } }, "client_packaging_default_id": "89", "client_id": "1234", "pay_run_start": 1, "pay_run_start2": null, "pay_run_start3": null, "taxable_sales": "all-items", "pay_run_processing_state": "NSW", "pay_run_weekend_treatment": "pay-on-friday", "report_delivery_type": "email", "report_groups": [ "string" ], "payroll_pre_tax": "string", "payroll_post_tax": "string", "payroll_fbt": "string", "payroll_lcc": "string", "payroll_gst": "string", "payroll_itc": "string", "bank_account_enabled_flag": "yes", "financial_institution_id": "12", "bank_account_name": "[ACCOUNT-NAME]", "bank_account_name_short": "[SHORT-NAME]", "bank_bsb": "[BSB]", "bank_account_number": "[ACCOUNT-NUMBER]", "apca_number": "[APCA-NUMBER]", "aba_description": "string", "aba_self_balancing_flag": "yes" }

Error Response Details

Validation Message	Comments
401 - Unauthorized	1. You have not authenticated before running this API or 2. The token_timeout of the current session has passed. You need to authenticate again.

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Unauthorized", "status": 401, "detail": "Unauthorized" }

Validation Message	Comments
403 - Forbidden	- You do not have permissions for this request. - Go to System Roles and enter 'web_services' - Navigate to the Roles / APIs tab to make sure the permission you need to run this API is checked.

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Forbidden", "status": 403, "detail": "Forbidden" }

Validation Message	Comments
404 - Not Found	The client does not exist.

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Not Found", "status": 404, "detail": "Not Found" }

Validation Message	Comments
406 - Not Acceptable	The Accept header of the request does not match a response format this API supports.

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Not Acceptable", "status": 406, "detail": "Not Acceptable" }

Validation Message	Comments
415 - Unsupported Media Type	The Content-Type of the request is not supported by this API.

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Unsupported Media Type", "status": 415, "detail": "Not Acceptable" }

Validation Message	Comments
422 - Unprocessable Entity	One or more input fields failed validation. The field name and message are returned in `validation_messages`.

{ "warning_messages": {}, "validation_messages": { "fieldName": { "validationExceptionCode": "A textual description of the validation exception" } }, "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Unprocessable Entity", "status": 422, "detail": "Failed Validation" }

Validation Message	Comments
500 - Internal Error	An unexpected error occurred on the server.

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "string", "status": 599, "detail": "string" }

Validation Message	Comments
default - Unexpected Error	Any other unexpected error.

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "string", "status": 599, "detail": "string" }

Was this helpful?

Still need help? Ask the team