{
  "enum": [
    "accrued_holiday",
    "additional_fee",
    "allowance",
    "bonus",
    "commission",
    "deduction",
    "deposit",
    "deposit_refund",
    "employer_cost",
    "expense",
    "health_allowance",
    "health_benefit",
    "health_insurance_fee",
    "legal_fee",
    "management_fee",
    "milestone",
    "offcycle",
    "other",
    "overtime",
    "pension",
    "pro_rata",
    "setup_fee",
    "severance",
    "shield_service",
    "signing_bonus",
    "signing_bonus_employer_cost",
    "refund",
    "task",
    "time_off",
    "vat",
    "withholding_tax",
    "work"
  ],
  "type": "string",
  "x-internal": true,
  "description": "Type of invoice adjustment."
}

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/InvoiceAdjustmentTypeEnum"
  },
  "x-internal": true
}

{
  "enum": [
    "bonus",
    "commission",
    "deduction",
    "expense",
    "other",
    "overtime",
    "time_off",
    "vat"
  ],
  "type": "string",
  "x-internal": true,
  "description": "Type of invoice adjustment."
}

{
  "type": "object",
  "required": [
    "id",
    "contract_type"
  ],
  "properties": {
    "id": {
      "type": "string",
      "example": "rhCTiRd9Mad41RwjsFWw-",
      "description": "Unique identifier of a Deel contract."
    },
    "name": {
      "type": "string",
      "example": "Lisandro Shanahan-Dynamic Web Specialist",
      "description": "Contract title."
    },
    "contract_type": {
      "type": "string",
      "example": "pay_as_you_go_time_based",
      "description": "Type of Deel contract."
    }
  }
}

{
  "enum": [
    "pending",
    "paid",
    "processing",
    "canceled",
    "skipped",
    "failed",
    "refunded"
  ],
  "type": "string",
  "example": "pending",
  "nullable": false,
  "description": "invoice's allowed contract types"
}

{
  "type": "object",
  "title": "Contractor",
  "required": [
    "name"
  ],
  "properties": {
    "name": {
      "type": "string",
      "default": ""
    }
  }
}

{
  "type": "object",
  "required": [
    "data"
  ],
  "properties": {
    "data": {
      "$ref": "#/components/schemas/InvoiceDownloadObject"
    }
  },
  "x-internal": true
}

{
  "type": "object",
  "required": [
    "data"
  ],
  "properties": {
    "data": {
      "$ref": "#/components/schemas/InvoiceDownloadObject"
    }
  },
  "x-internal": true
}

{
  "type": "object",
  "required": [
    "url"
  ],
  "properties": {
    "url": {
      "type": "string",
      "example": "https://s3URL/letsdeel.com/invoices/12345.pdf",
      "nullable": true,
      "description": "URL to requested invoice to download."
    }
  }
}

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/Invoice"
  }
}

{
  "type": "object",
  "required": [
    "data",
    "page"
  ],
  "properties": {
    "data": {
      "$ref": "#/components/schemas/InvoiceList"
    },
    "page": {
      "$ref": "#/components/schemas/PageInfoWithoutCursorNew"
    }
  },
  "x-internal": true
}

{
  "type": "object",
  "properties": {
    "rows": {
      "$ref": "#/components/schemas/InvoiceList"
    }
  }
}

{
  "enum": [
    "pending",
    "paid",
    "processing",
    "canceled",
    "skipped",
    "failed",
    "refunded"
  ],
  "type": "string",
  "example": "paid",
  "nullable": false,
  "description": "Current status of the invoice."
}

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/InvoiceStatusEnum"
  },
  "description": "filter invoices by current status, show a invoice if its status is in this list"
}

{
  "enum": [
    "PAYMENT",
    "EOR_DEPOSIT",
    "EOR_FIRST_PAYMENT",
    "EOR_TERMINATION_OFFCYCLE",
    "SIGNING_BONUS",
    "REFUND_STATEMENT",
    "EOR_TAX_RULING",
    "GP_DEPOSIT_STATEMENT",
    "GP_FUNDING_STATEMENT",
    "GLOBAL_PAYROLL_FEES",
    "SHIELD_DEPOSIT",
    "EOR_MANAGEMENT_FEE"
  ],
  "type": "string",
  "example": "GP_DEPOSIT_STATEMENT",
  "nullable": false,
  "description": "invoice's type"
}

{
  "type": "object",
  "required": [
    "id",
    "name"
  ],
  "properties": {
    "id": {
      "$ref": "#/components/schemas/UniqueObjectIdentifier",
      "description": "Unique identifier for the job title in Deel platform."
    },
    "name": {
      "type": "string",
      "example": "3D Artist",
      "nullable": false,
      "description": "Job title."
    }
  },
  "x-internal": true
}

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/JobTitle"
  },
  "x-internal": true
}

{
  "type": "object",
  "required": [
    "data",
    "page"
  ],
  "properties": {
    "data": {
      "$ref": "#/components/schemas/JobTitleList"
    },
    "page": {
      "type": "object",
      "required": [
        "cursor"
      ],
      "properties": {
        "cursor": {
          "type": "string",
          "example": "eyJvZmZzZXQiOjEwMCwibGltaXQiOjEwMCwiZmlsdGVyVHlwZSI6ImFsbCJ9",
          "description": "Use for pagination to get next set of records after the given cursor."
        }
      }
    }
  },
  "x-internal": true
}

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/LegalEntityType"
  }
}

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/BasicLegalEntity"
  },
  "x-internal": true
}

{
  "type": "object",
  "properties": {
    "data": {
      "$ref": "#/components/schemas/LegalEntityList"
    }
  },
  "x-internal": true
}

{
  "type": "string",
  "x-internal": true
}

{
  "enum": [
    "individual",
    "company"
  ],
  "type": "string",
  "x-internal": true
}

{
  "type": "object",
  "required": [
    "description",
    "type"
  ],
  "properties": {
    "type": {
      "enum": [
        "VISA_APPLICATION_FOR_PERSONAL_TRIP",
        "VISA_APPLICATION_FOR_BUSINESS_TRIP",
        "VISA_RENEWAL_CERTIFICATE",
        "NO_OBJECTION_CERTIFICATE_FOR_TRAVELLING",
        "BANK_VERIFICATION_OR_SALARY_CERTIFICATE",
        "CUSTOMISED"
      ],
      "type": "string"
    },
    "description": {
      "type": "string",
      "minLength": 25,
      "description": "Description of the letter (minimum 25 characters)"
    },
    "includeQRCode": {
      "type": "boolean",
      "description": "Flag indicating whether to include a QR code"
    }
  }
}

{
  "type": "object",
  "required": [
    "value"
  ],
  "properties": {
    "value": {
      "type": "string",
      "example": "b29a5ff0-bdb5-11ed-afa1-0242ac120002",
      "description": "Manager's unique identifier."
    }
  }
}

{
  "enum": [
    "Single",
    "Married",
    "Widowed",
    "Divorced",
    "Separated",
    "Registered Partnership",
    "Common Law"
  ],
  "type": "string",
  "x-internal": true
}

{
  "type": "object",
  "properties": {
    "created": {
      "type": "string",
      "format": "date-time"
    },
    "location": {
      "type": "string",
      "description": "resource location URI"
    },
    "lastModified": {
      "type": "string",
      "format": "date-time"
    },
    "resourceType": {
      "enum": [
        "User",
        "Group"
      ],
      "type": "string"
    }
  },
  "description": "Resource metadata."
}

{
  "type": "object",
  "required": [
    "documents_required"
  ],
  "properties": {
    "is_main_income": {
      "type": "boolean"
    },
    "documents_required": {
      "type": "boolean",
      "description": "Require the contractor to upload necessary compliance documents as per their country’s labor laws."
    }
  },
  "x-internal": true,
  "description": "Additional custom info about a contract"
}

{
  "type": "object",
  "nullable": false,
  "required": [
    "amount",
    "approval_requested",
    "reviewed_by",
    "reported_by",
    "id",
    "title",
    "description",
    "status",
    "created_at"
  ],
  "properties": {
    "id": {
      "$ref": "#/components/schemas/UniqueObjectIdentifier",
      "description": "Unique identifier for the milestone."
    },
    "title": {
      "type": "string",
      "example": "Sprint 1",
      "nullable": false,
      "description": "Title of milestone."
    },
    "amount": {
      "type": "string",
      "example": "900.00",
      "description": "Amount to be paid for the milestone."
    },
    "status": {
      "type": "string",
      "example": "pending",
      "nullable": false,
      "description": "Current status of milestone."
    },
    "created_at": {
      "$ref": "#/components/schemas/DateTimeString"
    },
    "description": {
      "type": "string",
      "example": "Sprint #1",
      "nullable": false,
      "description": "Description of milestone."
    },
    "reported_by": {
      "type": "object",
      "nullable": false,
      "required": [
        "id",
        "full_name"
      ],
      "properties": {
        "id": {
          "$ref": "#/components/schemas/UniqueObjectIdentifier",
          "description": "Reporter's unique Deel id."
        },
        "full_name": {
          "type": "string",
          "example": "Jane Doe",
          "nullable": false,
          "description": "Reporter's full name."
        }
      },
      "description": "Milestone creator."
    },
    "reviewed_by": {
      "type": "object",
      "nullable": true,
      "required": [
        "id",
        "full_name"
      ],
      "properties": {
        "id": {
          "$ref": "#/components/schemas/UniqueObjectIdentifier",
          "description": "Reviewer's unique Deel id."
        },
        "full_name": {
          "type": "string",
          "example": "Jane Doe",
          "nullable": false,
          "description": "Reviewer's full name."
        }
      },
      "description": "Reviewer's information."
    },
    "approval_requested": {
      "type": "boolean",
      "example": false,
      "description": "Indicates if the contractor has requested the approval for the milestone."
    }
  },
  "x-internal": true
}

{
  "type": "object",
  "required": [
    "data"
  ],
  "properties": {
    "data": {
      "$ref": "#/components/schemas/Milestone"
    }
  },
  "x-internal": true
}

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/Milestone"
  },
  "x-internal": true
}

{
  "type": "object",
  "required": [
    "data"
  ],
  "properties": {
    "data": {
      "$ref": "#/components/schemas/MilestoneList"
    }
  },
  "x-internal": true
}

{
  "type": "object",
  "nullable": false,
  "required": [
    "amount",
    "title",
    "description"
  ],
  "properties": {
    "title": {
      "type": "string",
      "example": "Sprint 2",
      "nullable": false,
      "description": "Title of milestone."
    },
    "amount": {
      "type": "string",
      "example": "900.00",
      "nullable": false,
      "description": "Amount to be paid for the milestone."
    },
    "description": {
      "type": "string",
      "example": "Sprint #2",
      "nullable": false,
      "description": "Description of milestone."
    }
  },
  "x-internal": true
}

{
  "type": "object",
  "required": [
    "status"
  ],
  "properties": {
    "reason": {
      "type": "string",
      "nullable": true
    },
    "status": {
      "enum": [
        "approved",
        "declined"
      ],
      "type": "string",
      "nullable": false
    }
  },
  "x-internal": true
}

{
  "type": "object",
  "required": [
    "data"
  ],
  "properties": {
    "data": {
      "$ref": "#/components/schemas/MilestoneReviewToCreate"
    }
  },
  "x-internal": true
}

{
  "type": "object",
  "required": [
    "status",
    "ids"
  ],
  "properties": {
    "ids": {
      "type": "array",
      "items": {
        "type": "number",
        "nullable": false,
        "description": "ID of an existing milestone record"
      },
      "maxItems": 1000,
      "minItems": 1
    },
    "reason": {
      "type": "string",
      "nullable": true
    },
    "status": {
      "enum": [
        "approved",
        "declined"
      ],
      "type": "string",
      "nullable": false
    }
  },
  "x-internal": true
}

{
  "type": "object",
  "required": [
    "data"
  ],
  "properties": {
    "data": {
      "$ref": "#/components/schemas/MilestoneReviewsToCreate"
    }
  },
  "x-internal": true
}

{
  "type": "object",
  "required": [
    "data"
  ],
  "properties": {
    "data": {
      "$ref": "#/components/schemas/MilestoneProperties"
    }
  },
  "x-internal": true
}

{
  "allOf": [
    {
      "$ref": "#/components/schemas/MilestoneProperties"
    },
    {
      "$ref": "#/components/schemas/FileObject"
    }
  ],
  "x-internal": true
}

{
  "type": "object",
  "properties": {
    "count": {
      "type": "integer",
      "description": "The number of monthly payments"
    }
  },
  "description": "Monthly payment details for the user"
}

{
  "type": "object",
  "required": [
    "familyName",
    "givenName"
  ],
  "properties": {
    "givenName": {
      "type": "string",
      "example": "Jane",
      "description": "User's given name. Also known as first name."
    },
    "familyName": {
      "type": "string",
      "example": "Doe",
      "description": "User's family name."
    }
  }
}

{
  "type": "string",
  "example": "US",
  "maxLength": 2,
  "minLength": 2,
  "x-internal": true
}

{
  "type": "number",
  "default": 0,
  "example": 15,
  "minimum": 0,
  "description": "Days before to notice the termination of contract for eather party."
}

{
  "type": "object",
  "nullable": false,
  "required": [
    "id",
    "status",
    "description",
    "date_submitted",
    "created_at",
    "currency_code",
    "amount",
    "reported_by"
  ],
  "properties": {
    "id": {
      "$ref": "#/components/schemas/UniqueObjectIdentifier"
    },
    "amount": {
      "type": "string",
      "example": "200.00",
      "nullable": false,
      "description": "Amount of off-cycle payment."
    },
    "status": {
      "$ref": "#/components/schemas/InvoiceAdjustmentStatusEnum"
    },
    "created_at": {
      "$ref": "#/components/schemas/DateTimeStringRequired"
    },
    "description": {
      "type": "string",
      "example": "Yearly bonus.",
      "nullable": false,
      "description": "Description of the off-cycle payment entry."
    },
    "reported_by": {
      "type": "object",
      "nullable": false,
      "required": [
        "id",
        "full_name"
      ],
      "properties": {
        "id": {
          "$ref": "#/components/schemas/UniqueObjectIdentifier",
          "description": "Profile id of the creator."
        },
        "full_name": {
          "type": "string",
          "example": "John Smith",
          "nullable": false,
          "description": "Full name of the creator."
        }
      }
    },
    "currency_code": {
      "$ref": "#/components/schemas/CurrencyCodeRequired"
    },
    "date_submitted": {
      "$ref": "#/components/schemas/DateTimeStringRequired"
    }
  },
  "x-internal": true
}

{
  "type": "object",
  "required": [
    "data"
  ],
  "properties": {
    "data": {
      "$ref": "#/components/schemas/OffCyclePayment"
    }
  },
  "x-internal": true
}

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/OffCyclePayment"
  },
  "x-internal": true
}

{
  "type": "object",
  "required": [
    "data"
  ],
  "properties": {
    "data": {
      "$ref": "#/components/schemas/OffCyclePaymentList"
    }
  },
  "x-internal": true
}

{
  "type": "object",
  "nullable": false,
  "required": [
    "date_submitted",
    "amount"
  ],
  "properties": {
    "amount": {
      "type": "number",
      "example": 2500,
      "minimum": 0,
      "nullable": false,
      "description": "Amount to be paid. Must be a positive number."
    },
    "description": {
      "type": "string",
      "nullable": false,
      "description": "Description of off-cycle payment."
    },
    "date_submitted": {
      "$ref": "#/components/schemas/DateStringRequired"
    }
  },
  "x-internal": true,
  "description": "Details of invoice adjustment to create."
}

{
  "type": "object",
  "required": [
    "data"
  ],
  "properties": {
    "data": {
      "$ref": "#/components/schemas/OffCyclePaymentToCreate"
    }
  },
  "x-internal": true
}

{
  "enum": [
    "offcycle"
  ],
  "type": "string",
  "x-internal": true,
  "description": "Type for Off-cycle payments"
}