Client / Packaging Defaults

Get client packaging defaults

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

GET

/sp/client/packaging-defaults/{client_id}

curl --request GET \
  --url https://api.catch-e.com/sp/client/packaging-defaults/{client_id} \
  --header 'Authorization: <api-key>'

{
  "_links": {
    "self": {
      "href": "https://api.catch-e.com/sp/client/packaging-defaults/100000"
    }
  },
  "aba_description": "<string>",
  "aba_self_balancing_flag": "yes",
  "apca_number": "<string>",
  "bank_account_enabled_flag": "yes",
  "bank_account_name": "<string>",
  "bank_account_name_short": "<string>",
  "bank_account_number": 123456789,
  "bank_bsb": "987-654",
  "client_id": 100000,
  "client_packaging_default_id": "11988414583439111138",
  "financial_institution_id": "<string>",
  "pay_run_processing_state": null,
  "pay_run_start": null,
  "pay_run_start2": null,
  "pay_run_start3": null,
  "pay_run_weekend_treatment": null,
  "payroll_fbt": null,
  "payroll_gst": null,
  "payroll_itc": null,
  "payroll_lcc": null,
  "payroll_post_tax": null,
  "payroll_pre_tax": null,
  "report_delivery_type": "email",
  "report_groups": [
    "11989672791877169799",
    "11989672791877169800"
  ],
  "taxable_sales": "all-items"
}

Authorizations

Authorizationstringheaderrequired

For accessing the API a valid token must be passed in all the queries in the 'Authorization' header.

A valid token is generated by the API and returned by the /authenticate method by supplying a valid username and password.

The following syntax must be used in the 'Authorization' header :

Bearer aaaaaa/bbbbbb.ccccccc.dddddd

Path Parameters

client_idstringrequired

Client Id

Maximum string length: 10

Pattern: ^[1-9]{1}[0-9]*$

Response

Success

_linksobject

Show child attributes

aba_descriptionstring

Disbursements (ABA) Description

aba_self_balancing_flagenum<string>default:yes

Add balancing row to Disbursements (ABA) files

Available options: yes, no

apca_numberstring

Bank APCA (BSB)

bank_account_enabled_flagenum<string>

Available options: yes, no

bank_account_namestring

Bank Account Name

bank_account_name_shortstring

Abbreviated Bank Account Name

bank_account_numberstring

Bank Account number

Example: 123456789

bank_bsbstring

Bank BSB

Example: 987-654

client_idstring

Client Id

Example: 100000

client_packaging_default_idstring

Client Packaging Default Id

Example: 11988414583439111138

financial_institution_idstring

Financial Institution

pay_run_processing_stateenum<string>default:null

Available options: VIC, NSW, ACT, QLD, WA, SA, TAS, NT, NZ

pay_run_startintegerdefault:null

pay_run_start2integerdefault:null

pay_run_start3integerdefault:null

pay_run_weekend_treatmentenum<string>default:null

Available options: leave-as-weekend, pay-on-friday, pay-on-monday

payroll_fbtstringdefault:null

payroll_gststringdefault:null

payroll_itcstringdefault:null

payroll_lccstringdefault:null

payroll_post_taxstringdefault:null

payroll_pre_taxstringdefault:null

report_delivery_typeenum<string>default:email

Available options: email, post

report_groupsstring[]

taxable_salesenum<string>default:all-items

Available options: only-fees, all-items

Still need help? Ask the team