1. SuiteCloud Platform
  2. SuiteTalk Web Services
  3. SuiteTalk REST Web Services Records Guide
  4. REST Web Services Supported Records
  5. Paycheck Journal

Paycheck Journal

A paycheck journal record exposes a paycheck journal to REST web services.

This record:

For information about using the REST API Browser, see The REST API Browser.

Record ID

The record ID for a paycheck journal REST record is paycheckjournal.

Prerequisites

Before you can use this record with REST web services, you must enable the payroll and payroll journal features.

Actions

The following actions are available for the paycheck journal record:

  • Customize Form

  • Delete

  • New Body Field

  • New Column Field

  • Reset

  • Save

  • Save and New

Elements Related to Taxation Features

The paycheck journal record has the following tax-related fields that are not exposed to REST:

  • companytax

  • employeetax

Note:

REST web services do not support legacy tax features. To work with taxation through REST web services, you must have the SuiteTax feature enabled. For more information about using SuiteTax, see SuiteTax.

Code Samples

The following code sample shows how to create a paycheck journal:

            curl --request POST \
  --url {{COMPANY_URL}}/services/rest/record/v1/paycheckJournal \
  --header 'content-type: application/json' \
  --data '{
  "employee": {
    "id": 3
  },
  "account": {
    "id": 21
  },
  "earning": {
    "items": [
      {
        "amount": 10000,
        "payrollItem": {
          "id": "4"
        }
      }
    ]
  }
}

The following code sample shows how to delete a paycheck journal earning:

            curl --request PATCH \
  --url {{COMPANY_URL}}services/rest/record/v1/paycheckJournal/4 \
  --header 'content-type: application/json' \
  --data '{
  "earning": {
    "items": []
  }
}

The following code sample shows how to get a paycheck journal:

            curl --request GET \
  --url {{COMPANY_URL}}/services/rest/record/v1/paycheckJournal/5

Related Topics

General Notices