---
updatedAt: 2026-05-14T14:32:15.000Z
agentTools:
  projectIndex: https://docs.oysterhr.com/v0.1/llms.txt
---

# Retrieve all payroll net values

Returns company's payroll net values for a given payroll period. For access to this endpoint, please contact api-support@oysterhr.com

# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "title": "Endpoints",
    "version": "v0.1"
  },
  "components": {
    "securitySchemes": {
      "bearer_auth": {
        "type": "http",
        "scheme": "bearer"
      }
    },
    "schemas": {
      "amount": {
        "type": "object",
        "properties": {
          "decimal": {
            "type": "string",
            "pattern": "^\\d+([.]\\d+)?$"
          },
          "currencyCode": {
            "type": "string",
            "minLength": 3,
            "maxLength": 3
          }
        },
        "required": [
          "decimal",
          "currencyCode"
        ]
      },
      "meta": {
        "type": "object",
        "properties": {
          "items": {
            "type": "integer"
          },
          "count": {
            "type": "integer"
          },
          "page": {
            "type": "integer"
          },
          "pages": {
            "type": "integer"
          },
          "firstUrl": {
            "type": "string"
          },
          "lastUrl": {
            "type": "string"
          },
          "pageUrl": {
            "type": "string"
          },
          "nextUrl": {
            "type": "string"
          },
          "prevUrl": {
            "type": "string"
          },
          "deprecation": {
            "type": "object",
            "properties": {
              "at": {
                "type": "string"
              },
              "sunset": {
                "type": "string"
              },
              "link": {
                "type": "object",
                "properties": {
                  "rel": {
                    "type": "string"
                  },
                  "url": {
                    "type": "string"
                  }
                }
              }
            }
          }
        },
        "required": [
          "items",
          "count",
          "page",
          "pages",
          "firstUrl",
          "lastUrl",
          "pageUrl",
          "nextUrl",
          "prevUrl"
        ]
      },
      "payrollNetValue": {
        "type": "object",
        "properties": {
          "countryCode": {
            "type": "string"
          },
          "engagementId": {
            "type": "string"
          },
          "payrollProviderComponent": {
            "type": "string"
          },
          "oysterCategory": {
            "type": "string"
          },
          "paymentCategory": {
            "type": "string"
          },
          "amount": {
            "$ref": "#/components/schemas/amount"
          },
          "payrollMonth": {
            "type": "string"
          },
          "payrollYear": {
            "type": "string"
          },
          "cycle": {
            "type": "object",
            "properties": {
              "number": {
                "type": "integer"
              },
              "frequency": {
                "type": "string",
                "enum": [
                  "MONTHLY",
                  "SEMI_MONTHLY",
                  "BI_WEEKLY"
                ]
              },
              "type": {
                "type": "string",
                "enum": [
                  "ON_CYCLE",
                  "OFF_CYCLE",
                  "ROUND_UP_CYCLE"
                ]
              },
              "startDate": {
                "type": "string"
              },
              "endDate": {
                "type": "string"
              }
            },
            "required": [
              "number",
              "frequency",
              "type",
              "startDate",
              "endDate"
            ]
          }
        },
        "required": [
          "countryCode",
          "engagementId",
          "payrollProviderComponent",
          "oysterCategory",
          "paymentCategory",
          "amount",
          "payrollMonth",
          "payrollYear",
          "cycle"
        ]
      },
      "payrollNetValues": {
        "type": "array",
        "items": {
          "$ref": "#/components/schemas/payrollNetValue"
        }
      }
    }
  },
  "paths": {
    "/v0.1/payroll_net_values": {
      "get": {
        "summary": "Retrieve all payroll net values",
        "tags": [
          "Payroll Net Values"
        ],
        "description": "Returns company's payroll net values for a given payroll period. For access to this endpoint, please contact api-support@oysterhr.com",
        "security": [
          {
            "bearer_auth": [
              "read"
            ]
          }
        ],
        "parameters": [
          {
            "name": "payroll_period",
            "in": "query",
            "required": true,
            "description": "Payroll period (YYYY-MM format)",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "engagement_ids[]",
            "in": "query",
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "required": false,
            "description": "Filter by engagement IDs"
          },
          {
            "name": "page",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer"
            }
          },
          {
            "name": "per_page",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful",
            "content": {
              "application/json": {
                "examples": {
                  "No payroll net values": {
                    "value": {
                      "data": [],
                      "meta": {
                        "items": 100,
                        "count": 0,
                        "page": 1,
                        "pages": 1,
                        "firstUrl": "/v0.1/payroll_net_values?payrollPeriod=2023-07&page=1&perPage=100",
                        "lastUrl": "/v0.1/payroll_net_values?payrollPeriod=2023-07&page=1&perPage=100",
                        "pageUrl": "/v0.1/payroll_net_values?payrollPeriod=2023-07&page=1&perPage=100",
                        "nextUrl": "/v0.1/payroll_net_values?payrollPeriod=2023-07&page=&perPage=100",
                        "prevUrl": "/v0.1/payroll_net_values?payrollPeriod=2023-07&page=&perPage=100"
                      }
                    }
                  },
                  "Successful": {
                    "value": {
                      "data": [
                        {
                          "countryCode": "GB",
                          "engagementId": "A5540727",
                          "payrollProviderComponent": "Excess holiday - Amount",
                          "oysterCategory": "Not Applicable",
                          "paymentCategory": "Not Applicable",
                          "amount": {
                            "decimal": "100.0",
                            "currencyCode": "GBP"
                          },
                          "payrollMonth": "7",
                          "payrollYear": "2023",
                          "cycle": {
                            "number": 1,
                            "frequency": "MONTHLY",
                            "type": "ON_CYCLE",
                            "startDate": "2023-07-01",
                            "endDate": "2023-07-31"
                          }
                        }
                      ],
                      "meta": {
                        "items": 100,
                        "count": 1,
                        "page": 1,
                        "pages": 1,
                        "firstUrl": "/v0.1/payroll_net_values?payrollPeriod=2023-07&page=1&perPage=100",
                        "lastUrl": "/v0.1/payroll_net_values?payrollPeriod=2023-07&page=1&perPage=100",
                        "pageUrl": "/v0.1/payroll_net_values?payrollPeriod=2023-07&page=1&perPage=100",
                        "nextUrl": "/v0.1/payroll_net_values?payrollPeriod=2023-07&page=&perPage=100",
                        "prevUrl": "/v0.1/payroll_net_values?payrollPeriod=2023-07&page=&perPage=100"
                      }
                    }
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "data": {
                      "$ref": "#/components/schemas/payrollNetValues"
                    },
                    "meta": {
                      "$ref": "#/components/schemas/meta"
                    }
                  },
                  "required": [
                    "data",
                    "meta"
                  ]
                }
              }
            }
          }
        }
      }
    }
  },
  "servers": [
    {
      "url": "https://api.oysterhr.com",
      "description": "Production server"
    },
    {
      "url": "https://api-sandbox.oysterhr.com",
      "description": "Sandbox server"
    }
  ]
}
```