In addition to calculating a paycheck, the api will generate one of several
predefined reports in the form of a byte array. It is up to the client to
generate a report from the byte array.

Report model

GET https://calculators.symmetry.com/api/print

Parameters

NameTypeDescription
formatstringCan be model or fields. Default model. model returns json model object. fields returns an array of field objects. Field objects has properties such as field name, label value, default value, regex, and help text value.
typestringCan be all, checktop, checkmiddle, checkbottom, earnings, paystub (if finalpay calculator), or omitted (empty string ""). Default value is omitted. Adds a map of reports in the form Map where the key id the name of the report and the value is a byte array.

📘

Important note:

For the response below, model and checktop are the request parameters.

Response

{
    "content": {
        "calculator": {
            "checkDate": 1451410278007,
            "state": "AL",
            "voluntaryDeductions": [
                {
                    "deductionName": "",
                    "deductionAmount": 0,
                    "deductionMethodType": "PERCENT_OF_GROSS",
                    "exemptFederal": false,
                    "exemptFica": false,
                    "exemptState": false,
                    "exemptLocal": false,
                    "benefitType": "_Custom"
                }
            ],
            "grossPay": 0,
            "federalFilingStatusType": "SINGLE",
            "federalAllowances": 0,
            "payFrequency": "WEEKLY",
            "exemptFederal": false,
            "exemptFica": false,
            "grossPayType": "ANNUALLY",
            "grossPayYTD": 0,
            "additionalFederalWithholding": 0,
            "roundFederalWithholding": false,
            "exemptMedicare": false
        },
        "grossPay": 0,
        "netPay": 0,
        "federal": 0,
        "medicare": 0,
        "fica": 0,
        "eic": 0,
        "localeTaxes": [
            {
                "name": "",
                "value": 0
            }
        ],
        "checkDate": 1451410278007,
        "voluntaryDeductions": [
            {
                "name": "",
                "value": 0
            }
        ],
        "checkNumber": "",
        "companyName": "",
        "companyAddressLine1": "",
        "companyAddressLine2": "",
        "companyAddressLine3": "",
        "employeeName": "",
        "employeeAddressLine1": "",
        "employeeAddressLine2": "",
        "employeeAddressLine3": "",
        "companyNameOnCheck": false,
        "checkNumberOnCheck": false,
        "remarks": "",
        "stateTaxes": [
            {
                "name": "",
                "value": 0
            }
        ],
        "id": "",
        "state": 0
    },
    "_links": {
        "self": {
            "href": "https://calculators.symmetry.com/api/print?format=model&type="
        },
        "create": {
            "href": "https://calculators.symmetry.com/api/print?report=all&showcalc=false"
        }
    }
}

Create report

POST https://calculators.symmetry.com/api/print

Parameters

NameTypeDescription
reportstringCan be all, checktop, checkmiddle, checkbottom, earnings, paystub (if finalpay calculator), or omitted (empty string ""). Default value is omitted. Adds a map of reports in the form Map where the key id the name of the report and the value is a byte array.

📘

Important note:

For the response below, checktop is the request parameter.

Response

{
    "content": {
        "Check on top": "JVBERi0xLjQKJeLjz9MKMiAwIG9iago8PC9MZW5ndGggNTQyL0ZpbHRlci9GbGF0ZURlY29kZT4+c3RyZWFtCnic7VY7T8MwEN79KzwwlCGpHSduOvIqYgCBlIkFBZoiUKEi7cK/J6kfjc92FUcglrRDLrm7776c75EvdF4gxnFOOC6WiGBiXyLKYpILuSOaRhmjMWc4okl7N11QnONihShu//UrmtDT4r0xfkWRNJXewiEklDTqEcqAMAKlDYd0JvG6NzqUhB8YLEklihAGojB5KJEQBqKkuUQRgjfHwK5NQa4CtSFXaIJFAGLoe53O5LGqN/hys16X9RaXn0uM908uqs/dtkU9clYki1liI9JkmsynCaFZ6x9JMxdCRnncFLiFcEJiQvbO0gI4RwdhQCZ4w0e+UdSR/9Wo96v81dPfb+WMca2KujeeVrYLHxx3OmswmCNRsOCEnepVFYwdn2QD7TwJPHZhDZ6jEa/rzXaL78vv/UsII2deSRLPHf6dphEWvqYxKQG1h9yiWlZ1ubap6YEqPDKax1lm+6tu3mvdsxgSA2ofsZuLM5uVHtDCN4QVmO2QFVB7WN1Wy7eXsq5sZnqGC/8QZtYeMJkBtYfZ2bp8Lj9KmxgnhnsIMe3KnUUP1J2oHgachDKYqSKeOWscqL0MgF0Ig1xVa+4sZqD2MgB2IQzmqjLnzsIFalUecJY+6Z9jDNHUwEib+Kn6VjvInVjaA8wcDSQlT7HeVTvfQAQRQhLVcT5I4/Idl2+f5RtUZ0YGx8U7Lt5x8Y6Ld1y8evFeFegB/QD8O936CmVuZHN0cmVhbQplbmRvYmoKNCAwIG9iago8PC9QYXJlbnQgMyAwIFIvQ29udGVudHMgMiAwIFIvVHlwZS9QYWdlL1Jlc291cmNlczw8L1Byb2NTZXQgWy9QREYgL1RleHQgL0ltYWdlQiAvSW1hZ2VDIC9JbWFnZUldL0ZvbnQ8PC9GMSAxIDAgUj4+Pj4vTWVkaWFCb3hbMCAwIDU5NSA4NDJdPj4KZW5kb2JqCjEgMCBvYmoKPDwvQmFzZUZvbnQvSGVsdmV0aWNhL1R5cGUvRm9udC9FbmNvZGluZy9XaW5BbnNpRW5jb2RpbmcvU3VidHlwZS9UeXBlMT4+CmVuZG9iagozIDAgb2JqCjw8L0lUWFQoMi4xLjcpL1R5cGUvUGFnZXMvQ291bnQgMS9LaWRzWzQgMCBSXT4+CmVuZG9iago1IDAgb2JqCjw8L1R5cGUvQ2F0YWxvZy9QYWdlcyAzIDAgUj4+CmVuZG9iago2IDAgb2JqCjw8L1Byb2R1Y2VyKGlUZXh0IDIuMS43IGJ5IDFUM1hUKS9Nb2REYXRlKEQ6MjAxNTEyMjkwOTM2MDItMDgnMDAnKS9DcmVhdGlvbkRhdGUoRDoyMDE1MTIyOTA5MzYwMi0wOCcwMCcpPj4KZW5kb2JqCnhyZWYKMCA3CjAwMDAwMDAwMDAgNjU1MzUgZiAKMDAwMDAwMDc4MSAwMDAwMCBuIAowMDAwMDAwMDE1IDAwMDAwIG4gCjAwMDAwMDA4NjkgMDAwMDAgbiAKMDAwMDAwMDYyNCAwMDAwMCBuIAowMDAwMDAwOTMyIDAwMDAwIG4gCjAwMDAwMDA5NzcgMDAwMDAgbiAKdHJhaWxlcgo8PC9Sb290IDUgMCBSL0lEIFs8OTc2MTFmOGEyNDE0MjdjZWEwNDkyMjdiYmVmN2MwMGY+PDcyOTAyMjEwMjBhNTI0ODc5NjgzZGZkMTVmNDI4MTlhPl0vSW5mbyA2IDAgUi9TaXplIDc+PgpzdGFydHhyZWYKMTA5OQolJUVPRgo="
    },
    "_links": {
        "self": {
            "href": "https://calculators.symmetry.com/api/print?report=all&showcalc=false"
        }
    }
}

Jump to top