TRANXACT.AI Help

HRMS · Pay Processing

Direct Deposits

Who is paid where, masked to the last four, and the pay periods each account is in force. A change is asked for, approved by somebody else, and paid from the next pay period.

Type REST8 operationsBase path /api/hrms/direct-depositsPublished as /api/v1/direct-deposits

Download specification (OpenAPI 3.1) Screen: Direct Deposits

Overview

PackageHRMS
AuthenticationBearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key
AuthorizationThe caller's roles must hold HRMS › Direct Deposits on the Roles screen: display for GET, add for POST, change for PUT, delete for DELETE; an action needs the grant of the button that runs it on the screen.
Tablehr.direct_deposit_board · kept per company (and organisational unit where it has one)
RecordRead only; key id
RulesThe same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail.

API reference

8 operations. Open one for its parameters, bodies, responses and a sample request.

GET/api/hrms/direct-depositsList direct deposits

Query parameters

NameDescriptionExample
limitRows per page (50 by default, at most 200)limit=100
offsetRows to skipoffset=200
qFree-text search over the search columnsq=acme
sortcolumn:asc or column:desc, several separated by commassort=created_at:desc
filterA JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sortedfilter={"col":"status","op":"eq","value":"open"}
<field>=<value>Shorthand for "field is value" 

Response 200

{
  "rows": [
    {
      "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "employee_no": "EMP-000001",
      "employee_name": "Example",
      "sequence_no": 10,
      "bank_name": "Example",
      "account_name": "Example",
      "account_type": "text",
      "country": "US",
      "routing_masked": "text",
      "ifsc_masked": "text",
      "iban_masked": "text",
      "account_masked": "text",
      "split_type": "text"
    }
  ],
  "count": 1
}

Sample request

curl "https://demo.tranxact.ai/api/hrms/direct-deposits?limit=20" \
  -H "Authorization: Bearer $TOKEN"
GET/api/hrms/direct-deposits/{id}Read one direct-deposit account

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "employee_no": "EMP-000001",
  "employee_name": "Example",
  "sequence_no": 10,
  "bank_name": "Example",
  "account_name": "Example",
  "account_type": "text",
  "country": "US",
  "routing_masked": "text",
  "ifsc_masked": "text",
  "iban_masked": "text",
  "account_masked": "text",
  "split_type": "text"
}

404 when no record with that id is visible to the caller.

Sample request

curl "https://demo.tranxact.ai/api/hrms/direct-deposits/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/hrms/direct-deposits/requestRequest

Request body

The keys this action reads (* = required; "one of" lists the only values):

employeeId, reason, accounts, bank_name, routing_number, ifsc, iban, bank_code, account_number, account_type

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X POST "https://demo.tranxact.ai/api/hrms/direct-deposits/request" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"employeeId":"value","reason":"value","accounts":"value","bank_name":"value","routing_number":"value","ifsc":"value"}'
POST/api/hrms/direct-deposits/{id}/prenotePrenote

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

The keys this action reads (* = required; "one of" lists the only values):

result; result one of confirmed|failed

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X POST "https://demo.tranxact.ai/api/hrms/direct-deposits/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/prenote" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"result;":"value"}'
POST/api/hrms/direct-depositsPost direct deposits

No body is required.

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X POST "https://demo.tranxact.ai/api/hrms/direct-deposits" \
  -H "Authorization: Bearer $TOKEN"
POST/api/hrms/direct-deposits/{id}/copyCopy

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

The keys this action reads (* = required; "one of" lists the only values):

overrides, preview, withLines

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X POST "https://demo.tranxact.ai/api/hrms/direct-deposits/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"overrides":"value","preview":"value","withLines":"value"}'
PUT/api/hrms/direct-deposits/{id}Put direct deposits

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

No body is required.

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X PUT "https://demo.tranxact.ai/api/hrms/direct-deposits/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
DELETE/api/hrms/direct-deposits/{id}Delete direct deposits

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

No body is required.

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X DELETE "https://demo.tranxact.ai/api/hrms/direct-deposits/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"

Data model

Every field of a direct-deposit account, as the API returns it. Field names are the JSON keys; any of them can be filtered and sorted on a list.

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
employee_iduuidread onlyEmployee id
employee_notextread onlyEmployee no
employee_nametextread onlyEmployee name
sequence_nointegerread onlySequence no
bank_nametextread onlyBank name
account_nametextread onlyAccount name
account_typetextread onlyAccount type
countrytextread onlyCountry
routing_maskedtextread onlyRouting masked
ifsc_maskedtextread onlyIfsc masked
iban_maskedtextread onlyIban masked
account_maskedtextread onlyAccount masked
split_typetextread onlySplit type
split_amountnumericread onlySplit amount
split_percentnumericread onlySplit percent
statustextread onlyStatus
effective_fromdateread onlyEffective from
effective_todateread onlyEffective to
prenote_statustextread onlyPrenote status
source_request_iduuidread onlySource request id
source_request_notextread onlySource request no
created_attimestamp with time zoneread onlyCreated at

Errors

StatusMeaning
400The request could not be read: a filter that is not JSON, a bad parameter
401No credential, or it is wrong, revoked or expired
403The caller's roles do not hold HRMS › Direct Deposits for this verb, or the address or origin is not allowed
404No record with that id is visible to the caller
409A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else
422Refused by the same validation as the screen; the error names the field and why

Every error is JSON: {"error": "a sentence saying what was wrong"}, with field where it applies.