Last active
November 26, 2018 22:12
-
-
Save IntuitDeveloperRelations/d7f929edd1c38ebbf8e3c85c71b7f15d to your computer and use it in GitHub Desktop.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| { | |
| "/accounting/AccountingTransactionLine" : { | |
| "type" : "object", | |
| "allOf" : [ { | |
| "$ref" : "/Entity" | |
| }, { | |
| "type" : "object", | |
| "properties" : { | |
| "description" : { | |
| "type" : "string", | |
| "description" : "User entered description for the line. Default value typically copied from the item." | |
| }, | |
| "amount" : { | |
| "type" : "string", | |
| "format" : "amount", | |
| "description" : "Amount on each line" | |
| }, | |
| "contact" : { | |
| "$ref" : "/network/Contact", | |
| "@access" : { | |
| "allow" : "external" | |
| }, | |
| "description" : "Contact Details for Customer/Vendor/Employee" | |
| } | |
| } | |
| } ], | |
| "definitions" : { | |
| "ItemTrait" : { | |
| "type" : "object", | |
| "properties" : { | |
| "item" : { | |
| "$ref" : "/items/Item", | |
| "@access" : { | |
| "allow" : "external" | |
| }, | |
| "description" : "Item(Product/Service) - always required on an item line" | |
| }, | |
| "quantity" : { | |
| "type" : "string", | |
| "format" : "decimal", | |
| "description" : "Quantity of item" | |
| }, | |
| "rate" : { | |
| "type" : "string", | |
| "format" : "rate", | |
| "description" : "Rate of item" | |
| } | |
| }, | |
| "@access" : { | |
| "allow" : "external" | |
| }, | |
| "@since" : { | |
| "introduced" : "1.4.0" | |
| }, | |
| "@typecode" : "9f3dabf2d8" | |
| } | |
| }, | |
| "scope" : "public", | |
| "lifecycle" : "R1", | |
| "@since" : { | |
| "introduced" : "1.4.0" | |
| }, | |
| "@access" : { | |
| "allow" : "external" | |
| }, | |
| "@queryoptions" : { | |
| "queryable" : false, | |
| "sortable" : false | |
| }, | |
| "provider" : { | |
| "service" : "transactions2", | |
| "read" : true, | |
| "write" : true, | |
| "delete" : false | |
| }, | |
| "@typecode" : "7f93a63032" | |
| }, | |
| "/payroll/definitions/BaseDeductionItem" : { | |
| "type" : "object", | |
| "allOf" : [ { | |
| "$ref" : "/payroll/definitions/BasePayrollItem" | |
| }, { | |
| "type" : "object", | |
| "properties" : { | |
| "amount" : { | |
| "type" : "string", | |
| "format" : "rate", | |
| "@queryoptions" : { | |
| "sortable" : false, | |
| "queryable" : false | |
| }, | |
| "description" : "The default amount deducted from the employees of the employer. If null refer to DeductionType for this value." | |
| }, | |
| "annualMaximum" : { | |
| "type" : "string", | |
| "format" : "amount", | |
| "@queryoptions" : { | |
| "sortable" : false, | |
| "queryable" : false | |
| }, | |
| "description" : "The maximum amount to withhold for this deduction in a tax year" | |
| }, | |
| "active" : { | |
| "type" : "boolean", | |
| "@queryoptions" : { | |
| "sortable" : false | |
| }, | |
| "description" : "whether this deduction should be applied (i.e. whether it should be included on calculations)" | |
| } | |
| } | |
| } ], | |
| "@since" : { | |
| "introduced" : "1.2.0" | |
| }, | |
| "@access" : { | |
| "allow" : "external" | |
| }, | |
| "@typecode" : "8f01ac1692", | |
| "description" : "Deduction Items are configured in order for the engine to create deductions on a payslip. Payslip deductions include health care which are created based on these deduction items, but also 401k employee contributions which are not." | |
| }, | |
| "/payroll/definitions/BasePayrollItem" : { | |
| "type" : "object", | |
| "allOf" : [ { | |
| "$ref" : "/Entity" | |
| }, { | |
| "type" : "object", | |
| "properties" : { | |
| "effectiveDate" : { | |
| "type" : "string", | |
| "format" : "date", | |
| "@queryoptions" : { | |
| "sortable" : false, | |
| "queryable" : false | |
| }, | |
| "description" : "Date when it becomes active" | |
| }, | |
| "endDate" : { | |
| "type" : "string", | |
| "format" : "date", | |
| "@queryoptions" : { | |
| "sortable" : false | |
| }, | |
| "description" : "Date when it became inactive, a null endDate indicates continuously active after effectiveDate" | |
| } | |
| } | |
| } ], | |
| "@since" : { | |
| "introduced" : "1.2.0" | |
| }, | |
| "@access" : { | |
| "allow" : "external" | |
| }, | |
| "@typecode" : "4a8b03b851", | |
| "description" : "a payroll item is something an ER or EE sets up in order to enable an engine to be able to create a line or lines (i.e. compensation, deduction, or contribution) on payslips. Some payroll items are setup to enable a direct way of creating a single line whereas others are setup to enable more involved calculations that may create multiple lines." | |
| }, | |
| "/payroll/definitions/BaseCompensationItem" : { | |
| "type" : "object", | |
| "allOf" : [ { | |
| "$ref" : "/payroll/definitions/BasePayrollItem" | |
| }, { | |
| "type" : "object", | |
| "properties" : { | |
| "amount" : { | |
| "type" : "string", | |
| "format" : "amount", | |
| "description" : "The default amount paid for this compensation. On an EmployeeCompensation, it is the default amount paid to that employee. On an EmployerCompensation, it is the default amount paid to employees of that employer. The semantics of null is that no default is set at this level and so a default should be read through the chain. This \"read-through\" is used during payroll run: If there is no value specified during payroll run, payroll run will use the default on the EmployeeCompensation. If there is no default specified in the EmployeeCompensation, payroll run will use the default on the EmployerCompensation. If there is no default specified in the EmployerCompensation, payroll run will use the default of the statutory type. This is the semantic meaning of null, but read-through is not used to return values. If an EmployeeCompensation does not have a default, GETs to it will show null rather than the value from EmployerCompensation. Only payroll run will do the actual read-through.\n" | |
| }, | |
| "timeWorked" : { | |
| "$ref" : "/common/TimeQuantity", | |
| "description" : "The default amount of time worked for this compensation. Same semantics as 'amount' above." | |
| }, | |
| "multiplier" : { | |
| "type" : "string", | |
| "format" : "decimal", | |
| "description" : "A multiplier (e.g. 1.5) to the \"base rate\", amount. Same semantics as 'amount' above." | |
| }, | |
| "active" : { | |
| "type" : "boolean", | |
| "description" : "whether this compensation should be applied (i.e. whether it should be included on calculations)" | |
| } | |
| } | |
| } ], | |
| "@since" : { | |
| "introduced" : "1.2.0" | |
| }, | |
| "@access" : { | |
| "allow" : "external" | |
| }, | |
| "@typecode" : "97f0c0cf3b" | |
| }, | |
| "/payroll/definitions/BaseBenefitItem" : { | |
| "type" : "object", | |
| "allOf" : [ { | |
| "$ref" : "/payroll/definitions/BasePayrollItem" | |
| }, { | |
| "type" : "object", | |
| "properties" : { | |
| "employeeSetup" : { | |
| "$ref" : "#/definitions/ContributionSetup", | |
| "@queryoptions" : { | |
| "sortable" : false, | |
| "queryable" : false | |
| }, | |
| "description" : "Employee contribution set up for this benefit. It includes amount to be contributed, and cappings" | |
| }, | |
| "employerSetup" : { | |
| "$ref" : "#/definitions/ContributionSetup", | |
| "@queryoptions" : { | |
| "sortable" : false, | |
| "queryable" : false | |
| }, | |
| "description" : "Employer contribution set up for this benefit. It includes amount to be contributed, and cappings" | |
| }, | |
| "taxesPaidBy" : { | |
| "$ref" : "#/definitions/TaxesPaidByType", | |
| "@queryoptions" : { | |
| "sortable" : false, | |
| "queryable" : false | |
| }, | |
| "description" : "Field used to represent who pays the taxes for the benefit" | |
| }, | |
| "active" : { | |
| "type" : "boolean", | |
| "@queryoptions" : { | |
| "sortable" : false | |
| }, | |
| "description" : "Whether this benefit should be applied (i.e. whether it should be included on calculations)" | |
| } | |
| } | |
| } ], | |
| "definitions" : { | |
| "ContributionSetup" : { | |
| "type" : "object", | |
| "properties" : { | |
| "amount" : { | |
| "type" : "string", | |
| "format" : "rate", | |
| "@queryoptions" : { | |
| "sortable" : false, | |
| "queryable" : false | |
| }, | |
| "description" : "The amount to be contributed for the benefit" | |
| }, | |
| "cappings" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/CappingType" | |
| }, | |
| "@queryoptions" : { | |
| "sortable" : false, | |
| "queryable" : false | |
| }, | |
| "description" : "Define how cappings are applied. It defines the amount and the frequency (when the capping is reset)" | |
| } | |
| }, | |
| "@since" : { | |
| "introduced" : "1.2.0" | |
| }, | |
| "@access" : { | |
| "allow" : "external" | |
| }, | |
| "@typecode" : "f57dbabc61" | |
| }, | |
| "CappingType" : { | |
| "type" : "object", | |
| "properties" : { | |
| "amount" : { | |
| "type" : "string", | |
| "format" : "amount", | |
| "@queryoptions" : { | |
| "sortable" : false, | |
| "queryable" : false | |
| }, | |
| "description" : "A fixed amount to be used as the limit for the contributions in the frequency specified." | |
| }, | |
| "frequency" : { | |
| "enum" : [ "ByPeriod", "ByFiscalYear", "Quaterly" ], | |
| "type" : "string", | |
| "@queryoptions" : { | |
| "sortable" : false, | |
| "queryable" : false | |
| }, | |
| "description" : "The amount of time for which this capping applies" | |
| } | |
| }, | |
| "@since" : { | |
| "introduced" : "1.2.0" | |
| }, | |
| "@access" : { | |
| "allow" : "external" | |
| }, | |
| "@typecode" : "2769a301e8" | |
| }, | |
| "TaxesPaidByType" : { | |
| "type" : "string", | |
| "@since" : { | |
| "introduced" : "1.2.0" | |
| }, | |
| "@access" : { | |
| "allow" : "external" | |
| }, | |
| "@queryoptions" : { | |
| "sortable" : false, | |
| "queryable" : false | |
| } | |
| } | |
| }, | |
| "@since" : { | |
| "introduced" : "1.2.0" | |
| }, | |
| "@access" : { | |
| "allow" : "external" | |
| }, | |
| "@typecode" : "44a6e40021", | |
| "description" : "A benefit an employer offers to employees. Examples includes fringe benefits like personal use of company car as well as Health Saving Accounts" | |
| }, | |
| "/payroll/definitions/BasePensionItem" : { | |
| "type" : "object", | |
| "allOf" : [ { | |
| "$ref" : "/payroll/definitions/BasePayrollItem" | |
| }, { | |
| "type" : "object", | |
| "properties" : { | |
| "employeeSetup" : { | |
| "$ref" : "#/definitions/ContributionSetup", | |
| "@queryoptions" : { | |
| "sortable" : false, | |
| "queryable" : false | |
| }, | |
| "description" : "Employee contribution set up for this pension. It includes amount to be contributed, and cappings" | |
| }, | |
| "employerSetup" : { | |
| "$ref" : "#/definitions/ContributionSetup", | |
| "@queryoptions" : { | |
| "sortable" : false, | |
| "queryable" : false | |
| }, | |
| "description" : "Employer contribution set up for this pension. It includes amount to be contributed, and cappings" | |
| }, | |
| "active" : { | |
| "type" : "boolean", | |
| "@queryoptions" : { | |
| "sortable" : false | |
| }, | |
| "description" : "Whether this pension should be applied (i.e. whether it should be included on calculations)" | |
| } | |
| } | |
| } ], | |
| "definitions" : { | |
| "ContributionSetup" : { | |
| "type" : "object", | |
| "properties" : { | |
| "amount" : { | |
| "type" : "string", | |
| "format" : "rate", | |
| "@queryoptions" : { | |
| "sortable" : false, | |
| "queryable" : false | |
| }, | |
| "description" : "The amount to be contributed for the pension" | |
| }, | |
| "cappings" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/CappingType" | |
| }, | |
| "@queryoptions" : { | |
| "sortable" : false, | |
| "queryable" : false | |
| }, | |
| "description" : "Define how cappings are applied. It defines the amount and the frequency (when the capping is reset)" | |
| } | |
| }, | |
| "@since" : { | |
| "introduced" : "1.2.0" | |
| }, | |
| "@access" : { | |
| "allow" : "external" | |
| }, | |
| "@typecode" : "264c00a9fd" | |
| }, | |
| "CappingType" : { | |
| "type" : "object", | |
| "properties" : { | |
| "amount" : { | |
| "type" : "string", | |
| "format" : "amount", | |
| "@queryoptions" : { | |
| "sortable" : false, | |
| "queryable" : false | |
| }, | |
| "description" : "A fixed amount to be used as the limit for the contributions in the frequency specified." | |
| }, | |
| "frequency" : { | |
| "enum" : [ "ByPeriod", "ByFiscalYear", "Quarterly" ], | |
| "type" : "string", | |
| "@queryoptions" : { | |
| "sortable" : false, | |
| "queryable" : false | |
| }, | |
| "description" : "The amount of time for which this capping applies" | |
| } | |
| }, | |
| "@since" : { | |
| "introduced" : "1.2.0" | |
| }, | |
| "@access" : { | |
| "allow" : "external" | |
| }, | |
| "@typecode" : "e792a3703f" | |
| } | |
| }, | |
| "@since" : { | |
| "introduced" : "1.2.0" | |
| }, | |
| "@access" : { | |
| "allow" : "external" | |
| }, | |
| "@typecode" : "63c30798a9", | |
| "description" : "Pensions in this context include traditional defined benefit pensions as well as defined contribution schemes like 401k. A pension item is setup in order to enable engine calculations to be run that create deduction and employer contribution lines on payslips." | |
| }, | |
| "/payroll/employee/EmployeeBenefit" : { | |
| "type" : "object", | |
| "allOf" : [ { | |
| "$ref" : "/payroll/definitions/BaseBenefitItem" | |
| }, { | |
| "type" : "object", | |
| "properties" : { | |
| "employee" : { | |
| "$ref" : "/network/Contact", | |
| "@access" : { | |
| "allow" : "external" | |
| }, | |
| "@queryoptions" : { | |
| "sortable" : false | |
| }, | |
| "description" : "Global id of the employee who has this benefit." | |
| }, | |
| "employerBenefit" : { | |
| "$ref" : "/payroll/employer/EmployerBenefit", | |
| "@access" : { | |
| "allow" : "external" | |
| }, | |
| "@queryoptions" : { | |
| "sortable" : false | |
| }, | |
| "description" : "Global id of the employer benefit associated with this employee benefit." | |
| } | |
| }, | |
| "additionalProperties" : false | |
| } ], | |
| "scope" : "public", | |
| "lifecycle" : "R1", | |
| "@since" : { | |
| "introduced" : "1.2.0" | |
| }, | |
| "@access" : { | |
| "allow" : "external" | |
| }, | |
| "provider" : { | |
| "service" : "payroll", | |
| "crud" : true | |
| }, | |
| "@typecode" : "bb2dfddc1a" | |
| }, | |
| "/payroll/employee/EmployeePension" : { | |
| "type" : "object", | |
| "allOf" : [ { | |
| "$ref" : "/payroll/definitions/BasePensionItem" | |
| }, { | |
| "type" : "object", | |
| "properties" : { | |
| "employee" : { | |
| "$ref" : "/network/Contact", | |
| "@access" : { | |
| "allow" : "external" | |
| }, | |
| "@queryoptions" : { | |
| "sortable" : false | |
| }, | |
| "description" : "Global id of the employee who has this pension." | |
| }, | |
| "employerPension" : { | |
| "$ref" : "/payroll/employer/EmployerPension", | |
| "@access" : { | |
| "allow" : "external" | |
| }, | |
| "@queryoptions" : { | |
| "sortable" : false | |
| }, | |
| "description" : "Global id of the employer pension associated with this employee pension." | |
| } | |
| }, | |
| "additionalProperties" : false | |
| } ], | |
| "scope" : "public", | |
| "lifecycle" : "R1", | |
| "@since" : { | |
| "introduced" : "1.2.0" | |
| }, | |
| "@access" : { | |
| "allow" : "external" | |
| }, | |
| "provider" : { | |
| "service" : "payroll", | |
| "crud" : true | |
| }, | |
| "@typecode" : "1aa66698f4" | |
| }, | |
| "/payroll/employee/EmployeeCompensation" : { | |
| "type" : "object", | |
| "allOf" : [ { | |
| "$ref" : "/payroll/definitions/BaseCompensationItem" | |
| }, { | |
| "type" : "object", | |
| "properties" : { | |
| "employee" : { | |
| "$ref" : "/network/Contact", | |
| "@access" : { | |
| "allow" : "external" | |
| }, | |
| "description" : "Parent employee" | |
| }, | |
| "employerCompensation" : { | |
| "$ref" : "/payroll/employer/EmployerCompensation", | |
| "document" : true, | |
| "@access" : { | |
| "allow" : "external" | |
| }, | |
| "description" : "Related EmployerCompensation. EmployerCompensation contains details of compensation policy and default values. Details of how default values are applied is documented in BaseCompensationItem." | |
| } | |
| }, | |
| "additionalProperties" : false | |
| } ], | |
| "scope" : "public", | |
| "lifecycle" : "R1", | |
| "@since" : { | |
| "introduced" : "1.2.0" | |
| }, | |
| "@access" : { | |
| "allow" : "external" | |
| }, | |
| "provider" : { | |
| "service" : "payroll", | |
| "crud" : true | |
| }, | |
| "@typecode" : "f5455e0cb3" | |
| }, | |
| "/payroll/employee/EmployeeDeduction" : { | |
| "type" : "object", | |
| "allOf" : [ { | |
| "$ref" : "/payroll/definitions/BaseDeductionItem" | |
| }, { | |
| "type" : "object", | |
| "properties" : { | |
| "employee" : { | |
| "$ref" : "/network/Contact", | |
| "@access" : { | |
| "allow" : "external" | |
| }, | |
| "@queryoptions" : { | |
| "sortable" : false | |
| }, | |
| "description" : "Global id of the employee who has this deduction." | |
| }, | |
| "employerDeduction" : { | |
| "$ref" : "/payroll/employer/EmployerDeduction", | |
| "@access" : { | |
| "allow" : "external" | |
| }, | |
| "@queryoptions" : { | |
| "sortable" : false | |
| }, | |
| "description" : "Global id of the employer deduction associated with this employee deduction." | |
| } | |
| }, | |
| "additionalProperties" : false | |
| } ], | |
| "scope" : "public", | |
| "lifecycle" : "R1", | |
| "@since" : { | |
| "introduced" : "1.2.0" | |
| }, | |
| "@access" : { | |
| "allow" : "external" | |
| }, | |
| "provider" : { | |
| "service" : "payroll", | |
| "crud" : true | |
| }, | |
| "@typecode" : "12e0b42bd4" | |
| }, | |
| "/payroll/employer/EmployerBenefit" : { | |
| "type" : "object", | |
| "allOf" : [ { | |
| "$ref" : "/payroll/definitions/BaseBenefitItem" | |
| }, { | |
| "type" : "object", | |
| "properties" : { | |
| "employer" : { | |
| "$ref" : "/Company", | |
| "@access" : { | |
| "allow" : "external" | |
| }, | |
| "@queryoptions" : { | |
| "sortable" : false | |
| }, | |
| "description" : "Global id of the employer" | |
| }, | |
| "name" : { | |
| "type" : "string", | |
| "@queryoptions" : { | |
| "sortable" : false, | |
| "queryable" : false | |
| }, | |
| "description" : "The name of this benefit. If null refer to Statutory Type for this value." | |
| }, | |
| "statutoryBenefitPolicy" : { | |
| "type" : "string", | |
| "@queryoptions" : { | |
| "sortable" : false, | |
| "queryable" : false | |
| }, | |
| "description" : "The statutory policy of this benefit. It may enforce restrictions on the employer policy such as amount boundaries, cappings, etc." | |
| } | |
| }, | |
| "additionalProperties" : false | |
| } ], | |
| "scope" : "public", | |
| "lifecycle" : "R1", | |
| "@since" : { | |
| "introduced" : "1.2.0" | |
| }, | |
| "@access" : { | |
| "allow" : "external" | |
| }, | |
| "provider" : { | |
| "service" : "payroll", | |
| "crud" : true | |
| }, | |
| "@typecode" : "2e7f52d20c" | |
| }, | |
| "/payroll/employer/EmployerPension" : { | |
| "type" : "object", | |
| "allOf" : [ { | |
| "$ref" : "/payroll/definitions/BasePensionItem" | |
| }, { | |
| "type" : "object", | |
| "properties" : { | |
| "employer" : { | |
| "$ref" : "/Company", | |
| "@access" : { | |
| "allow" : "external" | |
| }, | |
| "@queryoptions" : { | |
| "sortable" : false | |
| }, | |
| "description" : "Global id of the employer" | |
| }, | |
| "name" : { | |
| "type" : "string", | |
| "@queryoptions" : { | |
| "sortable" : false, | |
| "queryable" : false | |
| }, | |
| "description" : "The name of this pension. If null refer to Statutory Type for this value." | |
| }, | |
| "statutoryPensionPolicy" : { | |
| "type" : "string", | |
| "@queryoptions" : { | |
| "sortable" : false, | |
| "queryable" : false | |
| }, | |
| "description" : "The statutory policy of this pension. It may enforce restrictions on the employer policy such as amount boundaries, cappings, etc." | |
| } | |
| }, | |
| "additionalProperties" : false | |
| } ], | |
| "scope" : "public", | |
| "lifecycle" : "R1", | |
| "@since" : { | |
| "introduced" : "1.2.0" | |
| }, | |
| "@access" : { | |
| "allow" : "external" | |
| }, | |
| "provider" : { | |
| "service" : "payroll", | |
| "crud" : true | |
| }, | |
| "@typecode" : "7c20eefc9b", | |
| "description" : "A pension an employer provides to employees" | |
| }, | |
| "/payroll/employer/EmployerCompensation" : { | |
| "type" : "object", | |
| "allOf" : [ { | |
| "$ref" : "/payroll/definitions/BaseCompensationItem" | |
| }, { | |
| "type" : "object", | |
| "properties" : { | |
| "employer" : { | |
| "$ref" : "/Company", | |
| "@access" : { | |
| "allow" : "external" | |
| }, | |
| "description" : "Parent company" | |
| }, | |
| "name" : { | |
| "type" : "string", | |
| "description" : "The name of this compensation. If null refer to Statutory Type for this value." | |
| }, | |
| "statutoryCompensationPolicy" : { | |
| "type" : "string", | |
| "description" : "The statutory policy of this compensation. Links the compensation to a set of rules that apply during paycheck calculation and form filing. The rules, e.g. amount boundaries, cappings etc. will be expressed in the EmployerCompensationMetaModel" | |
| } | |
| }, | |
| "additionalProperties" : false | |
| } ], | |
| "scope" : "public", | |
| "lifecycle" : "R1", | |
| "@since" : { | |
| "introduced" : "1.2.0" | |
| }, | |
| "@access" : { | |
| "allow" : "external" | |
| }, | |
| "provider" : { | |
| "service" : "payroll", | |
| "crud" : true | |
| }, | |
| "@typecode" : "28d0717e96", | |
| "description" : "A form of compensation an employer pays to their employees" | |
| }, | |
| "/payroll/employer/EmployerDeduction" : { | |
| "type" : "object", | |
| "allOf" : [ { | |
| "$ref" : "/payroll/definitions/BaseDeductionItem" | |
| }, { | |
| "type" : "object", | |
| "properties" : { | |
| "employer" : { | |
| "$ref" : "/Company", | |
| "@access" : { | |
| "allow" : "external" | |
| }, | |
| "@queryoptions" : { | |
| "sortable" : false | |
| }, | |
| "description" : "Global id of the employer" | |
| }, | |
| "name" : { | |
| "type" : "string", | |
| "@queryoptions" : { | |
| "sortable" : false, | |
| "queryable" : false | |
| }, | |
| "description" : "The name of this deduction. If null refer to Statutory Type for this value." | |
| }, | |
| "statutoryDeductionPolicy" : { | |
| "type" : "string", | |
| "@queryoptions" : { | |
| "sortable" : false, | |
| "queryable" : false | |
| }, | |
| "description" : "The statutory policy of this deduction. It may enforce restrictions on the employer policy such as amount boundaries, cappings, etc." | |
| } | |
| }, | |
| "additionalProperties" : false | |
| } ], | |
| "scope" : "public", | |
| "lifecycle" : "R1", | |
| "@since" : { | |
| "introduced" : "1.2.0" | |
| }, | |
| "@access" : { | |
| "allow" : "external" | |
| }, | |
| "provider" : { | |
| "service" : "payroll", | |
| "crud" : true | |
| }, | |
| "@typecode" : "6eaad03d1e", | |
| "description" : "A deduction an employee can have taken from their net pay. eg. loan repayment" | |
| }, | |
| "/consumer/PPStudentLoanInterestWks" : { | |
| "scope" : "public", | |
| "lifecycle" : "R1", | |
| "provider" : { | |
| "service" : "CTDS", | |
| "read" : true, | |
| "write" : true, | |
| "delete" : true | |
| } | |
| }, | |
| "/timetracking/WorkerTimeTrackingDetails" : { | |
| "type" : "object", | |
| "allOf" : [ { | |
| "$ref" : "/Entity" | |
| }, { | |
| "type" : "object", | |
| "properties" : { | |
| "approvedToDate" : { | |
| "type" : "string", | |
| "format" : "date", | |
| "document" : true, | |
| "description" : "Any timesheet whose date (which takes the timesheet's timezone into account) property is prior to this value is considered approved and is locked from editing. \n\nNOTE: When updating the approvedToDate, if the value is greater than the submitted_to date for this user, both properties will be updated. \nThis is the equivalent of a manager/admin submitting time on a user's behalf.\n" | |
| }, | |
| "submittedToDate" : { | |
| "type" : "string", | |
| "format" : "date", | |
| "document" : true, | |
| "description" : "Any timesheet whose date property is prior to this value is considered submitted by the user and\nthe user will be unable to edit this time.\n" | |
| } | |
| } | |
| } ], | |
| "scope" : "public", | |
| "lifecycle" : "R1", | |
| "@since" : { | |
| "introduced" : "1.9.70" | |
| }, | |
| "@access" : { | |
| "allow" : "external" | |
| }, | |
| "provider" : { | |
| "read" : true, | |
| "update" : true, | |
| "create" : false, | |
| "delete" : false | |
| }, | |
| "@typecode" : "ecbceb4349" | |
| }, | |
| "/V4" : { | |
| "type" : "object", | |
| "properties" : { | |
| "companies" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "/Company" | |
| }, | |
| "document" : true, | |
| "@access" : { | |
| "allow" : "external" | |
| }, | |
| "description" : "Access to QuickBooks company resources" | |
| }, | |
| "entities" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "/Entity" | |
| }, | |
| "description" : "Access to all entities" | |
| } | |
| }, | |
| "scope" : "public", | |
| "lifecycle" : "R1", | |
| "@since" : { | |
| "introduced" : "1.0.0" | |
| }, | |
| "@access" : { | |
| "allow" : "external" | |
| }, | |
| "provider" : { | |
| "service" : "fabric" | |
| }, | |
| "@typecode" : "db1d297cec", | |
| "description" : "Provides API access to Intuit" | |
| }, | |
| "/common/ExternalId" : { | |
| "type" : "object", | |
| "properties" : { | |
| "externalRefId" : { | |
| "type" : "string", | |
| "description" : "Index/foreign key for this external Id, this is the index reference if the providers stores multiple external reference IDs." | |
| }, | |
| "namespaceId" : { | |
| "type" : "string", | |
| "description" : "the domain that generates the ID." | |
| }, | |
| "realmId" : { | |
| "type" : "string", | |
| "description" : "the company id that the entity belongs to." | |
| }, | |
| "typeId" : { | |
| "type" : "string" | |
| }, | |
| "localId" : { | |
| "type" : "string", | |
| "description" : "The actual reference id value." | |
| } | |
| }, | |
| "@since" : { | |
| "introduced" : "1.0.0" | |
| }, | |
| "@access" : { | |
| "allow" : "external" | |
| }, | |
| "@typecode" : "d5a9bb29f9", | |
| "description" : "contains alternate ID keys. Use this field to communicate alternate primary IDs that the entity may have used to expose in API or referencing from external sources." | |
| }, | |
| "/common/NameValue" : { | |
| "type" : "object", | |
| "properties" : { | |
| "name" : { | |
| "type" : "string", | |
| "description" : "name of the attribute" | |
| }, | |
| "value" : { | |
| "type" : "string", | |
| "description" : "value of the attribute" | |
| } | |
| }, | |
| "@since" : { | |
| "introduced" : "1.0.0" | |
| }, | |
| "@access" : { | |
| "allow" : "external" | |
| }, | |
| "@typecode" : "b8b1c1258e", | |
| "description" : "Name value description" | |
| }, | |
| "/common/AddressTypeEnum" : { | |
| "enum" : [ "MAILING", "DELIVERY", "OTHER" ], | |
| "type" : "string", | |
| "@since" : { | |
| "introduced" : "1.5.0" | |
| }, | |
| "@access" : { | |
| "allow" : "external" | |
| }, | |
| "description" : "Different address types, please add more as you need" | |
| }, | |
| "/common/TimeQuantity" : { | |
| "type" : "object", | |
| "properties" : { | |
| "unit" : { | |
| "type" : "string", | |
| "description" : "The unit type for this time worked total. eg. HOURS, DAYS, WEEKS" | |
| }, | |
| "value" : { | |
| "type" : "string", | |
| "format" : "decimal", | |
| "description" : "The amount of time worked in 'unit' units." | |
| } | |
| }, | |
| "@since" : { | |
| "introduced" : "1.2.0" | |
| }, | |
| "@access" : { | |
| "allow" : "external" | |
| }, | |
| "@typecode" : "6a527c1cf1", | |
| "description" : "a quantity of time" | |
| }, | |
| "/common/Metadata" : { | |
| "type" : "object", | |
| "properties" : { | |
| "created" : { | |
| "type" : "string", | |
| "format" : "date-time", | |
| "description" : "Time of entity creation" | |
| }, | |
| "updated" : { | |
| "type" : "string", | |
| "format" : "date-time", | |
| "description" : "Time of last modification" | |
| } | |
| }, | |
| "@since" : { | |
| "introduced" : "1.0.0" | |
| }, | |
| "@access" : { | |
| "allow" : "external" | |
| }, | |
| "@typecode" : "50db8a51ab" | |
| }, | |
| "/common/Address" : { | |
| "type" : "object", | |
| "allOf" : [ { | |
| "type" : "object", | |
| "properties" : { | |
| "types" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "./AddressTypeEnum" | |
| }, | |
| "description" : "Indicates for what purpose this address is used. ex:- shipping, billing etc." | |
| }, | |
| "freeFormAddressLine" : { | |
| "type" : "string", | |
| "description" : "Free form address input including city, state, zip and etc. This is basically the user input field, all other fields will be derived based on variability." | |
| }, | |
| "addressComponents" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "./NameValue" | |
| }, | |
| "description" : "Readonly map field that contains parsed/validated address components, name are address components such as city, state, zip and etc. The component name varies depending on regional settings and will be determined by variability." | |
| }, | |
| "addressFormatFormula" : { | |
| "type" : "string", | |
| "description" : "This is a readonly field that contains a string that shows how to format and print address components into a single free form address line. It may contain line breaks. An example for US address formulat looks like this {address_line_1}\\n{address_line2}\\n{city},{state},{zip_code}. The format is determined by variability." | |
| }, | |
| "formattedAddress" : { | |
| "type" : "string", | |
| "description" : "This is a readonly field that contains the formatted address using addressComponents and the addressFormatFormula. Most UI or consumers just need this field for display purpose." | |
| }, | |
| "primary" : { | |
| "type" : "boolean", | |
| "description" : "true if the address is primary" | |
| }, | |
| "verificationDate" : { | |
| "type" : "string", | |
| "description" : "Verification date" | |
| }, | |
| "active" : { | |
| "type" : "boolean", | |
| "description" : "Specifies this address is active or inactive" | |
| } | |
| } | |
| } ], | |
| "@since" : { | |
| "introduced" : "1.0.0" | |
| }, | |
| "@access" : { | |
| "allow" : "external" | |
| }, | |
| "@typecode" : "db70db4d4a" | |
| }, | |
| "/common/Telephone" : { | |
| "type" : "object", | |
| "allOf" : [ { | |
| "type" : "object", | |
| "properties" : { | |
| "number" : { | |
| "type" : "string", | |
| "maxLength" : 30, | |
| "description" : "telephone number" | |
| }, | |
| "extension" : { | |
| "type" : "string", | |
| "maxLength" : 50, | |
| "description" : "phone extension" | |
| }, | |
| "primary" : { | |
| "type" : "boolean", | |
| "description" : "true if the telephone is primary" | |
| } | |
| } | |
| } ], | |
| "@since" : { | |
| "introduced" : "1.0.0" | |
| }, | |
| "@access" : { | |
| "allow" : "external" | |
| }, | |
| "@typecode" : "a167565692" | |
| }, | |
| "/Entity" : { | |
| "type" : "object", | |
| "properties" : { | |
| "id" : { | |
| "type" : "string", | |
| "format" : "ID", | |
| "description" : "Globally-unique identifier for a resource. New ID namespace for V4." | |
| }, | |
| "externalIds" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "/common/ExternalId" | |
| } | |
| }, | |
| "entityVersion" : { | |
| "type" : "string", | |
| "description" : "The current version of the entity returned by the providers. Retrieved value to be provided unaltered with all change operations" | |
| }, | |
| "deleted" : { | |
| "type" : "boolean", | |
| "description" : "Set for deleted entities." | |
| }, | |
| "meta" : { | |
| "$ref" : "/common/Metadata", | |
| "@access" : { | |
| "allow" : "external" | |
| }, | |
| "description" : "Contains meta-data details common to all entities in the system such as who/what/when created and/or modified the entity. All entities are required to support these fields" | |
| }, | |
| "metaContext" : { | |
| "type" : "string", | |
| "description" : "The temporary placeholder for any tool data to be passed in for entity. Its deprecated and the use of it will be blocked in near future" | |
| }, | |
| "hash" : { | |
| "type" : "string", | |
| "description" : "A hash is calculated for an entity that is stored using all the fields of an entity. This field is used deduplication purposes" | |
| } | |
| }, | |
| "scope" : "public", | |
| "lifecycle" : "R1", | |
| "@since" : { | |
| "introduced" : "1.0.0" | |
| }, | |
| "@access" : { | |
| "allow" : "external" | |
| }, | |
| "provider" : { | |
| "service" : "fabric", | |
| "read" : true | |
| }, | |
| "@typecode" : "dfa2090f42", | |
| "description" : "All directly addressable entities derive from this base class." | |
| }, | |
| "/wip/tracking/tracking" : { | |
| "provider" : { | |
| "service" : "tracking", | |
| "write" : true | |
| } | |
| }, | |
| "/wip/marketing/campaign" : { | |
| "provider" : { | |
| "service" : "marketing-campaign", | |
| "write" : true | |
| } | |
| }, | |
| "/network/relationships/Employee" : { | |
| "type" : "object", | |
| "allOf" : [ { | |
| "type" : "object", | |
| "properties" : { | |
| "owner" : { | |
| "$ref" : "/network/Contact", | |
| "description" : "The owner is a Contact of type ORG which represents the employer" | |
| }, | |
| "contact" : { | |
| "$ref" : "/network/Contact", | |
| "description" : "The contact is of type PERSON which represents the employed person" | |
| }, | |
| "timeTrackingDetails" : { | |
| "$ref" : "/timetracking/WorkerTimeTrackingDetails", | |
| "@since" : { | |
| "introduced" : "1.9.70" | |
| }, | |
| "description" : "Time tracking related properties relevant to an employee" | |
| }, | |
| "compensations" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "/payroll/employee/EmployeeCompensation" | |
| }, | |
| "@access" : { | |
| "allow" : "external" | |
| }, | |
| "document" : true, | |
| "description" : "The compensation types this employee can receive on a payslip" | |
| }, | |
| "deductions" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "/payroll/employee/EmployeeDeduction" | |
| }, | |
| "@access" : { | |
| "allow" : "external" | |
| }, | |
| "description" : "The deductions types which can be applied to this employee" | |
| }, | |
| "pensions" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "/payroll/employee/EmployeePension" | |
| }, | |
| "@access" : { | |
| "allow" : "external" | |
| }, | |
| "description" : "The pension types which can be applied to this employee" | |
| }, | |
| "benefits" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "/payroll/employee/EmployeeBenefit" | |
| }, | |
| "@access" : { | |
| "allow" : "external" | |
| }, | |
| "description" : "The benefit types which can be applied to this employee" | |
| } | |
| }, | |
| "additionalProperties" : false | |
| } ], | |
| "scope" : "public", | |
| "lifecycle" : "R1", | |
| "@since" : { | |
| "introduced" : "1.5.0" | |
| }, | |
| "@access" : { | |
| "allow" : "external" | |
| }, | |
| "provider" : { | |
| "read" : true, | |
| "write" : true, | |
| "delete" : false | |
| }, | |
| "@typecode" : "46f9098b55" | |
| }, | |
| "/network/Contact" : { | |
| "type" : "object", | |
| "allOf" : [ { | |
| "$ref" : "/Entity" | |
| }, { | |
| "type" : "object", | |
| "properties" : { | |
| "type" : { | |
| "$ref" : "/network/definitions/ContactTypeEnum", | |
| "description" : "Specifies if the entity is a person or organization." | |
| }, | |
| "mergedFrom" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "/network/Contact" | |
| }, | |
| "description" : "a list of contacts that got merged into the current contact" | |
| }, | |
| "mergedTo" : { | |
| "$ref" : "/network/Contact", | |
| "description" : "the contact that the current contact got merged into" | |
| }, | |
| "contactMethods" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "/network/definitions/ContactMethod" | |
| }, | |
| "description" : "a list of contact information" | |
| }, | |
| "displayName" : { | |
| "type" : "string", | |
| "maxLength" : 500, | |
| "description" : "The name of the person or organization as displayed." | |
| }, | |
| "subLevel" : { | |
| "type" : "integer", | |
| "format" : "int32", | |
| "description" : "The sublevel of this contact with respect to its parent" | |
| }, | |
| "profiles" : { | |
| "$ref" : "#/definitions/Profiles", | |
| "document" : true, | |
| "description" : "properties that may vary in each Contact" | |
| } | |
| } | |
| } ], | |
| "definitions" : { | |
| "Profiles" : { | |
| "type" : "object", | |
| "properties" : { | |
| "employee" : { | |
| "$ref" : "/network/relationships/Employee", | |
| "@access" : { | |
| "allow" : "external" | |
| }, | |
| "description" : "Non-null when this networkEntity has an employee relationship" | |
| } | |
| }, | |
| "@since" : { | |
| "introduced" : "1.5.0" | |
| }, | |
| "@access" : { | |
| "allow" : "external" | |
| }, | |
| "@typecode" : "080a10120d" | |
| } | |
| }, | |
| "scope" : "public", | |
| "lifecycle" : "R1", | |
| "@since" : { | |
| "introduced" : "1.5.0" | |
| }, | |
| "@access" : { | |
| "allow" : "external" | |
| }, | |
| "provider" : { | |
| "service" : "network", | |
| "read" : true, | |
| "write" : true, | |
| "delete" : false | |
| }, | |
| "@typecode" : "9d699e9608" | |
| }, | |
| "/network/definitions/ContactMethod" : { | |
| "type" : "object", | |
| "properties" : { | |
| "primary" : { | |
| "type" : "boolean", | |
| "description" : "true if the ContactMethod is primary" | |
| }, | |
| "labels" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "/network/definitions/ContactMethodLabelEnum" | |
| }, | |
| "description" : "label identifying the users usage of this contact method i.e either home, work etc." | |
| }, | |
| "telephones" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "/common/Telephone" | |
| }, | |
| "description" : "List of phone numbers. To add primary email, please add or set a telephone number with primary field set to true." | |
| }, | |
| "addresses" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "/common/Address" | |
| }, | |
| "description" : "List of addresses. To add primary address, please add or set an address with primary field set to true." | |
| } | |
| }, | |
| "scope" : "public", | |
| "lifecycle" : "R1", | |
| "@since" : { | |
| "introduced" : "1.5.0" | |
| }, | |
| "@access" : { | |
| "allow" : "external" | |
| }, | |
| "provider" : { | |
| "read" : true, | |
| "write" : true, | |
| "delete" : true | |
| }, | |
| "@typecode" : "a4f1de3113" | |
| }, | |
| "/network/definitions/ContactMethodLabelEnum" : { | |
| "enum" : [ "BILLING", "BUSINESS", "HOME", "SHIPPING", "PUBLIC", "LEGAL", "OTHER" ], | |
| "type" : "string", | |
| "@since" : { | |
| "introduced" : "1.5.0" | |
| }, | |
| "description" : "Labels associated with ContactMethod" | |
| }, | |
| "/network/definitions/ContactTypeEnum" : { | |
| "enum" : [ "ORG", "PERSON" ], | |
| "type" : "string", | |
| "@since" : { | |
| "introduced" : "1.5.0" | |
| }, | |
| "description" : "type of contact" | |
| }, | |
| "/Company" : { | |
| "type" : "object", | |
| "allOf" : [ { | |
| "$ref" : "/Entity" | |
| }, { | |
| "type" : "object", | |
| "properties" : { | |
| "entities" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "/Entity" | |
| }, | |
| "heading" : "BATCH", | |
| "description" : "Access to all entities" | |
| }, | |
| "companyInfo" : { | |
| "$ref" : "/company/CompanyInfo", | |
| "@access" : { | |
| "allow" : "external" | |
| }, | |
| "document" : true, | |
| "heading" : "Company" | |
| }, | |
| "employeeContacts" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "/network/Contact" | |
| }, | |
| "meta" : "filter=employee", | |
| "document" : true, | |
| "description" : "will return only those contacts that have an employee relationship" | |
| } | |
| } | |
| } ], | |
| "scope" : "public", | |
| "lifecycle" : "R1", | |
| "@since" : { | |
| "introduced" : "1.0.0" | |
| }, | |
| "@access" : { | |
| "allow" : "external" | |
| }, | |
| "provider" : { | |
| "service" : "company", | |
| "crud" : true | |
| }, | |
| "@typecode" : "29605765d7" | |
| }, | |
| "/company/EmployerInfo" : { | |
| "type" : "object", | |
| "properties" : { | |
| "employees" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "/network/Contact" | |
| } | |
| }, | |
| "compensations" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "/payroll/employer/EmployerCompensation" | |
| }, | |
| "document" : true, | |
| "description" : "The compensation types employees of this employer can receive on a payslip" | |
| }, | |
| "deductions" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "/payroll/employer/EmployerDeduction" | |
| }, | |
| "@access" : { | |
| "allow" : "external" | |
| }, | |
| "description" : "The available deductions from net pay for employees of this employer" | |
| }, | |
| "pensions" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "/payroll/employer/EmployerPension" | |
| }, | |
| "@access" : { | |
| "allow" : "external" | |
| }, | |
| "description" : "The employer pension types that employees of this employer can receive" | |
| }, | |
| "benefits" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "/payroll/employer/EmployerBenefit" | |
| }, | |
| "@access" : { | |
| "allow" : "external" | |
| }, | |
| "description" : "The employer benefit types that employees of this employer can receive" | |
| } | |
| }, | |
| "scope" : "public", | |
| "lifecycle" : "R1", | |
| "@since" : { | |
| "introduced" : "1.2.0" | |
| }, | |
| "@access" : { | |
| "allow" : "external" | |
| }, | |
| "provider" : { | |
| "service" : "payroll", | |
| "read" : true, | |
| "write" : true, | |
| "delete" : true | |
| }, | |
| "@typecode" : "68b783096e" | |
| }, | |
| "/company/definitions/CompanyChannelInfo" : { | |
| "type" : "object", | |
| "properties" : { | |
| "userAgentString" : { | |
| "type" : "string", | |
| "description" : "the user agent of the calling client from which a company create request is recieved." | |
| }, | |
| "mktTrackingParams" : { | |
| "type" : "string" | |
| }, | |
| "semTracking" : { | |
| "type" : "string" | |
| }, | |
| "sourceCode" : { | |
| "type" : "string", | |
| "description" : "source via which company was created" | |
| }, | |
| "sourceAnswer" : { | |
| "type" : "string", | |
| "description" : "where did the user hear about QuickBooks" | |
| } | |
| }, | |
| "scope" : "public", | |
| "lifecycle" : "R1", | |
| "@since" : { | |
| "introduced" : "1.9.58" | |
| }, | |
| "@access" : { | |
| "allow" : "external" | |
| }, | |
| "provider" : { | |
| "service" : "company", | |
| "create" : true, | |
| "read" : true, | |
| "update" : true | |
| }, | |
| "@typecode" : "ea2a55a158", | |
| "description" : "information indicating the channel/sales/marketing information related to company creation" | |
| }, | |
| "/company/definitions/CompanyAgentInfo" : { | |
| "type" : "object", | |
| "properties" : { | |
| "salesForceOpportunityId" : { | |
| "type" : "string" | |
| }, | |
| "isExistingUserThroughSalesTool" : { | |
| "type" : "boolean" | |
| }, | |
| "salesToolAdminUserName" : { | |
| "type" : "string" | |
| }, | |
| "salesToolAdminPassword" : { | |
| "type" : "string" | |
| } | |
| }, | |
| "scope" : "public", | |
| "lifecycle" : "R1", | |
| "@since" : { | |
| "introduced" : "1.9.58" | |
| }, | |
| "@access" : { | |
| "allow" : "external" | |
| }, | |
| "provider" : { | |
| "service" : "company", | |
| "create" : true, | |
| "read" : true, | |
| "update" : true | |
| }, | |
| "@typecode" : "d8f24c0986", | |
| "description" : "information specified when a company is created by agents via SFDC" | |
| }, | |
| "/company/CompanyInfo" : { | |
| "type" : "object", | |
| "properties" : { | |
| "companyName" : { | |
| "type" : "string", | |
| "@access" : { | |
| "allow" : "external" | |
| }, | |
| "minLength" : 2, | |
| "maxLength" : 150, | |
| "description" : "The name the company does business under (DBA name in the US)" | |
| }, | |
| "industryType" : { | |
| "type" : "string", | |
| "@access" : { | |
| "allow" : "external" | |
| }, | |
| "minLength" : 2, | |
| "maxLength" : 38, | |
| "description" : "Business Category or Industry type" | |
| }, | |
| "partner" : { | |
| "type" : "string", | |
| "description" : "the partner channel via which the company is created. eg: Mobile iOS/Android/iPad etc." | |
| }, | |
| "companyType" : { | |
| "type" : "string", | |
| "description" : "Firm on non-firm" | |
| }, | |
| "parentCompanyId" : { | |
| "type" : "string", | |
| "description" : "Parent Company Id if applicable for a client creation" | |
| }, | |
| "createdDate" : { | |
| "type" : "string", | |
| "format" : "date-time", | |
| "description" : "Date on which company was created" | |
| }, | |
| "contactMethods" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "/network/definitions/ContactMethod" | |
| }, | |
| "description" : "a list of contact information" | |
| }, | |
| "employerInfo" : { | |
| "$ref" : "/company/EmployerInfo", | |
| "@access" : { | |
| "allow" : "external" | |
| }, | |
| "document" : true, | |
| "heading" : "Employer", | |
| "description" : "Information about the employer" | |
| }, | |
| "eula_accepted_version" : { | |
| "type" : "string" | |
| }, | |
| "eula_accepted_date" : { | |
| "type" : "string", | |
| "format" : "date-time", | |
| "description" : "Date on which EULA accepted." | |
| }, | |
| "eula_accepted_user_id" : { | |
| "type" : "string", | |
| "description" : "user who accepted EULA" | |
| } | |
| }, | |
| "scope" : "public", | |
| "lifecycle" : "R1", | |
| "@since" : { | |
| "introduced" : "1.0.0" | |
| }, | |
| "@access" : { | |
| "allow" : "external" | |
| }, | |
| "provider" : { | |
| "service" : "company", | |
| "create" : true, | |
| "read" : true, | |
| "update" : true | |
| }, | |
| "@typecode" : "ff66bebc10", | |
| "description" : "Company Profile API allows for creation, read and update of basic profile information for the company. It does not setup the company with any offering entitlements." | |
| } | |
| } |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment