Oyster HR · Schema

creditNote

Human ResourcesGlobal EmploymentPayrollEmployer of RecordContractorsComplianceRemote Work

Properties

Name	Type	Description
id	string
referenceCode	string
type	string
status	string
payrollMonth	string
payrollYear	string
issueDate	string
totalAmount	object
amountRemaining	object
customer	object
files	objectnull
appliedToInvoices	arraynull

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/oyster-hr/json-schema/oyster-hr-credit-note-schema.json",
  "title": "creditNote",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/oyster-hr-credit-notes-api-openapi.yml#/components/schemas/creditNote",
  "type": "object",
  "required": [
    "id",
    "referenceCode",
    "type",
    "status",
    "payrollMonth",
    "payrollYear",
    "issueDate",
    "totalAmount",
    "amountRemaining"
  ],
  "properties": {
    "id": {
      "type": "string"
    },
    "referenceCode": {
      "type": "string"
    },
    "type": {
      "type": "string"
    },
    "status": {
      "type": "string"
    },
    "payrollMonth": {
      "type": "string"
    },
    "payrollYear": {
      "type": "string"
    },
    "issueDate": {
      "type": "string",
      "format": "date"
    },
    "totalAmount": {
      "$ref": "#/$defs/amount"
    },
    "amountRemaining": {
      "$ref": "#/$defs/amount"
    },
    "customer": {
      "type": "object",
      "required": [
        "id",
        "name"
      ],
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "files": {
      "type": [
        "object",
        "null"
      ],
      "required": [
        "document"
      ],
      "properties": {
        "document": {
          "type": "object",
          "required": [
            "title",
            "url",
            "contentType"
          ],
          "properties": {
            "title": {
              "type": "string"
            },
            "url": {
              "type": "string"
            },
            "contentType": {
              "type": "string"
            }
          }
        }
      }
    },
    "appliedToInvoices": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": "object",
        "required": [
          "id",
          "referenceCode",
          "appliedAt",
          "amount"
        ],
        "properties": {
          "id": {
            "type": "string"
          },
          "referenceCode": {
            "type": "string"
          },
          "amount": {
            "$ref": "#/$defs/amount"
          },
          "appliedAt": {
            "type": "string",
            "format": "date-time"
          }
        }
      }
    }
  },
  "$defs": {
    "amount": {
      "type": "object",
      "properties": {
        "decimal": {
          "type": "string",
          "pattern": "^\\d+([.]\\d+)?$"
        },
        "currencyCode": {
          "type": "string",
          "minLength": 3,
          "maxLength": 3
        }
      },
      "required": [
        "decimal",
        "currencyCode"
      ]
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this

find_json_schemasBrowse and filter every JSON Schema in the catalog.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This JSON Schema

curl "https://apis.io/api/v1/json-schemas/oyster-hr-credit-note"

All schemas

curl "https://apis.io/api/v1/json-schemas?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.