API Reference
Log In
API Reference

Payroll object

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "period_start": "2019-08-24",
  "period_end": "2019-08-24",
  "payday": "2019-08-24",
  "status": "open",
  "payrollCalculation": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "payslips": [
        {
          "type": "string",
          "date": "2019-08-24",
          "payment_method": "string",
          "working_hours": 0,
          "gross_pay": {
            "amount": 0,
            "currency": "string"
          },
          "net_pay": {
            "amount": 0,
            "currency": "string"
          },
          "earnings": [
            {
              "type": "string",
              "name": "string",
              "amount": 0,
              "currency": "string"
            }
          ],
          "deductions": [
            {
              "type": "string",
              "name": "string",
              "amount": 0,
              "currency": "string"
            }
          ],
          "taxes": [
            {
              "type": "string",
              "name": "string",
              "amount": 0,
              "currency": "string"
            }
          ],
          "person_id": "f44f491f-40a2-43f4-9e5c-b56edd4f2ebb",
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "payments": [
            {
              "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
              "payslip_id": "4c69b385-5dae-4225-8596-911518500e4c",
              "status": "string",
              "components": [
                "string"
              ],
              "date_requested": "2019-08-24T14:15:22Z",
              "date_approved": "2019-08-24T14:15:22Z",
              "payer": "symmetrical",
              "bank_account": "string",
              "currency": "string"
            }
          ]
        }
      ],
      "status": "open",
      "calculation_date": "2019-08-24T14:15:22Z",
      "errors": [
        {
          "code": "string",
          "message": "string",
          "object_type": "string",
          "object_id": "string"
        }
      ],
      "warnings": [
        {
          "code": "string",
          "message": "string",
          "object_type": "string",
          "object_id": "string"
        }
      ]
    }
  ],
  "contract_type": "string",
  "name": "string",
  "employees": [
    {
      "national_id": "string",
      "date_of_birth": "string",
      "sex": "string",
      "first_name": "string",
      "middle_name": "string",
      "last_name": "string",
      "emails": [
        {
          "type": "string",
          "data": "string"
        }
      ],
      "phone_number": [
        {
          "type": "string",
          "data": "string"
        }
      ],
      "residence": {
        "address1": "string",
        "address2": "string",
        "city": "string",
        "state": "string",
        "postal_code": "string",
        "country": "string",
        "phone": "string",
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "ssn": "string",
      "eid": "string",
      "company_id": "b2e6a1c3-1a5e-44ae-a8fd-81f76fd715cf"
    }
  ],
  "errors": [
    {
      "code": "string",
      "message": "string",
      "object_type": "string",
      "object_id": "string"
    }
  ],
  "warnings": [
    {
      "code": "string",
      "message": "string",
      "object_type": "string",
      "object_id": "string"
    }
  ],
  "company_id": "b2e6a1c3-1a5e-44ae-a8fd-81f76fd715cf",
  "type": "standard"
}