service-payrollchecks-node

Payroll checks microservice

This is payroll checks microservice from Pip.Services library.

The microservice currently supports the following deployment options:

• Deployment platforms: Standalone Process, Seneca, Lambda
• External APIs: HTTP/REST, Seneca, Lambda
• Persistence: Flat Files, MongoDB

This microservice has no dependencies on other microservices.

Quick Links:

• Download Links
• Development Guide
• Configuration Guide
• Deployment Guide
• Client SDKs
  • Node.js SDK
• Communication Protocols
  • HTTP Version 1
  • Seneca Version 1
  • Lambda Version 1

Contract

Logical contract of the microservice is presented below. For physical implementation (HTTP/REST, Thrift, Seneca, Lambda, etc.), please, refer to documentation of the specific protocol.

class PayrollCheckV1 implements IStringIdentifiable {
    public id: string;
    public number?: string;
    public party_id: string;
    public state?: string;
    public state_details?: string;

    public period_from?: Date;
    public period_to?: Date;

    public create_time?: Date;
    public update_time?: Date;
    public paid_time?: Date;
    
    public payment_method_id?: string;
    public payment_id?: string;
    public check_number?: string;
    
    public income?: IncomeItemV1[];
    public income_total: number;
    public ytd_income_total?: number;

    public deductions?: DeductionItemV1[];
    public deductions_total?: number;
    public ytd_deductions_total?: number;

    public net_total: number;
    public ytd_net_total?: number;
}

class PayrollCheckStateV1 {
    public static New: string = "new";
    public static Canceled: string = "canceled";
    public static Paid: string = "paid";
    public static Failed: string = "failed";
}

interface IPayrollChecksV1 {
    getChecks(correlationId: string, filter: FilterParams, paging: PagingParams): Promise<DataPage<PayrollCheckV1>>;

    getCheckById(correlationId: string, check_id: string): Promise<PayrollCheckV1>;

    createCheck(correlationId: string, check: PayrollCheckV1): Promise<PayrollCheckV1>;

    updateCheck(correlationId: string, check: PayrollCheckV1): Promise<PayrollCheckV1>;

    deleteCheckById(correlationId: string, check_id: string): Promise<PayrollCheckV1>;
}

Download

Right now the only way to get the microservice is to check it out directly from github repository

git clone [e-mail]:pip-services-ecommerce2/service-payrollchecks-node.git

Pip.Service team is working to implement packaging and make stable releases available for your as zip downloadable archieves.

Run

Add config.yml file to the root of the microservice folder and set configuration parameters. As the starting point you can use example configuration from config.example.yml file.

Example of microservice configuration

- descriptor: "pip-services-container:container-info:default:default:1.0"
  name: "service-payrollchecks"
  description: "PayrollChecks microservice"

- descriptor: "pip-services-commons:logger:console:default:1.0"
  level: "trace"

- descriptor: "service-payrollchecks:persistence:file:default:1.0"
  path: "./data/payroll_checks.json"

- descriptor: "service-payrollchecks:controller:default:default:1.0"

- descriptor: "service-payrollchecks:service:http:default:1.0"
  connection:
    protocol: "http"
    host: "0.0.0.0"
    port: 8080

For more information on the microservice configuration see Configuration Guide.

Start the microservice using the command:

node run

Use

The easiest way to work with the microservice is to use client SDK. The complete list of available client SDKs for different languages is listed in the Quick Links

If you use Node.js then you should add dependency to the client SDK into package.json file of your project

{
    ...
    "dependencies": {
        ....
        "client-payrollchecks-node": "^1.0.*",
        ...
    }
}

Inside your code get the reference to the client SDK

let sdk = new require('client-payrollchecks-node');

Define client configuration parameters that match configuration of the microservice external API

// Client configuration
let config = {
    connection: {
        protocol: 'http',
        host: 'localhost', 
        port: 8080
    }
};

Instantiate the client and open connection to the microservice

// Create the client instance
let client = sdk.PayrollChecksHttpClientV1(config);

// Connect to the microservice
await client.open(null);

// Work with the microservice
    ...

Now the client is ready to perform operations

// Create a new payroll_check
let payrollCheck = {
    id: '2',
    party_id: '2',
    income: [
        {
            description: 'task 3',
            total: 700,
            hours: 50,
            rate: 14
        },
        {
            description: 'task 4',
            total: 1680,
            hours: 120,
            rate: 14
        },
    ],
    deductions: [
        {
            description: 'commission 5',
            total: 35,
            ytd_total: 5
        }
    ],
    state: PayrollCheckStateV1.New,
    income_total: 0,
    net_total: 2340
};

payrollCheck = await client.createCheck(
    null,
    payrollCheck
);

// Get the list of payroll_checks
let page = await client.getChecks(
    null,
    {
        party_id: '2',
        state: PayrollCheckStateV1.New
    },
    {
        total: true,
        skip: 0,
        take: 10
    }
);

Acknowledgements

This microservice was created and currently maintained by Denis Kuznetsov.