eedm.contribution-payroll-deductions.v8.1.0.contribution-payroll-deductions.json Maven / Gradle / Ivy

Go to download
{
  "title" : "Contribution Payroll Deductions",
  "description" : "The details of payroll deductions related to contributions.",
  "version" : "8.1.0",
  "type" : "object",
  "properties" : {
    "metadata" : {
      "$ref" : "resource:/eedm/metadata.json"
    },
    "id" : {
      "title" : "ID",
      "description" : "The global identifier of the contribution payroll-deduction.",
      "type" : "string",
      "format" : "guid",
      "pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
    },
    "arrangement" : {
      "title" : "Arrangement",
      "description" : "The arrangement details related to the payroll deduction.",
      "type" : "object",
      "properties" : {
        "id" : {
          "title" : "ID",
          "description" : "The global identifier for the Arrangement.",
          "type" : "string",
          "format" : "guid",
          "pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
        }
      },
      "links" : [ {
        "rel" : "self",
        "href" : "/payroll-deduction-arrangements/{id}",
        "targetSchema" : {
          "$ref" : "payroll-deduction-arrangements.json#"
        }
      } ],
      "additionalProperties" : false,
      "required" : [ "id" ]
    },
    "deductedOn" : {
      "title" : "Deducted On",
      "description" : "The date the payroll deduction was made.",
      "type" : "string",
      "format" : "date",
      "pattern" : "^(-?(?:[1-9][0-9]*)?[0-9]{4})-(1[0-2]|0[1-9])-(3[0-1]|0[1-9]|[1-2][0-9])$"
    },
    "amount" : {
      "title" : "Amount",
      "description" : "The amount that was deducted from the payroll.",
      "format" : "currency",
      "type" : "object",
      "properties" : {
        "value" : {
          "title" : "Value",
          "description" : "The monetary value",
          "type" : "number"
        },
        "currency" : {
          "title" : "Currency",
          "description" : "The ISO 4217 currency code",
          "enum" : [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWL" ],
          "type" : "string"
        }
      },
      "additionalProperties" : false,
      "required" : [ "value", "currency" ]
    }
  },
  "required" : [ "id", "arrangement", "deductedOn", "amount" ],
  "additionalProperties" : false,
  "links" : [ {
    "rel" : "filter",
    "encType" : "application/x-www-form-urlencoded",
    "method" : "GET",
    "href" : "/contribution-payroll-deductions?criteria={\"arrangement\": {\"id\": $id}}",
    "title" : "Arrangement",
    "description" : "The arrangement details related to the payroll deduction.",
    "schema" : {
      "type" : "object",
      "properties" : {
        "arrangement" : {
          "type" : "object",
          "properties" : {
            "id" : {
              "type" : "string",
              "format" : "guid",
              "pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
            }
          }
        }
      }
    },
    "targetSchema" : {
      "$ref" : "contribution-payroll-deductions.json#"
    }
  }, {
    "rel" : "filter",
    "encType" : "application/x-www-form-urlencoded",
    "method" : "GET",
    "href" : "/contribution-payroll-deductions?criteria={\"deductedOn\": $deductedOn}",
    "title" : "Deducted On",
    "description" : "The date the payroll deduction was made.",
    "schema" : {
      "type" : "object",
      "properties" : {
        "deductedOn" : {
          "type" : "string",
          "format" : "date",
          "pattern" : "^(-?(?:[1-9][0-9]*)?[0-9]{4})-(1[0-2]|0[1-9])-(3[0-1]|0[1-9]|[1-2][0-9])$"
        }
      }
    },
    "targetSchema" : {
      "$ref" : "contribution-payroll-deductions.json#"
    }
  } ]
}