string GlobalPayrollDownloadGrossToNetGpReportResponse
{
  "type": "string"
}
object GlobalPayrollG2NReport
{
  "type": "object",
  "properties": {
    "net_pay": {
      "type": "string",
      "nullable": true
    },
    "ee_loans": {
      "type": "string",
      "nullable": true
    },
    "contract_id": {
      "type": "string"
    },
    "cost_center": {
      "type": "string",
      "nullable": true
    },
    "annual_bonus": {
      "type": "number",
      "nullable": true
    },
    "car_allowance": {
      "type": "number",
      "nullable": true
    },
    "ee_income_tax": {
      "type": "string",
      "nullable": true
    },
    "employee_name": {
      "type": "string",
      "nullable": true
    },
    "employer_cost": {
      "type": "string",
      "nullable": true
    },
    "esp_deduction": {
      "type": "number",
      "nullable": true
    },
    "funding_amount": {
      "type": "number",
      "nullable": true
    },
    "home_allowance": {
      "type": "string",
      "nullable": true
    },
    "employee_number": {
      "type": "number",
      "nullable": true
    },
    "backdated_salary": {
      "type": "string",
      "nullable": true
    },
    "employee_division": {
      "type": "string",
      "nullable": true
    },
    "employee_job_title": {
      "type": "string",
      "nullable": true
    },
    "employee_department": {
      "type": "string",
      "nullable": true
    },
    "er_occupational_risk": {
      "type": "string",
      "nullable": true
    },
    "pension_contribution": {
      "type": "number",
      "nullable": true
    },
    "employer_contribution": {
      "type": "string",
      "nullable": true
    },
    "employment_status_tag_internal": {
      "type": "string",
      "nullable": true
    }
  }
}
object GlobalPayrollG2NReportContainer
{
  "type": "object",
  "required": [
    "data"
  ],
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/GlobalPayrollG2NReport"
      }
    }
  },
  "x-internal": true
}
object HRDocumentInfo
{
  "type": "object",
  "required": [
    "id",
    "name"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "Document Id."
    },
    "name": {
      "type": "string",
      "example": "Standard verification letter",
      "description": "Name of the document."
    }
  }
}
object HealthInsuranceProvider
{
  "type": "object",
  "properties": {
    "id": {
      "$ref": "#/components/schemas/UniqueObjectIdentifier",
      "description": "Unique identifier of a health insurance provider."
    },
    "name": {
      "type": "string",
      "example": "United Healthcare VSP Vision & Delta Dental: Singles Only",
      "description": "Name of insurance provider."
    },
    "type": {
      "type": "string",
      "example": "PLAN",
      "description": "Insurance type."
    },
    "plans": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "$ref": "#/components/schemas/UniqueObjectIdentifier",
            "description": "Insurance plan id."
          },
          "name": {
            "type": "string",
            "example": "USA Healthcare Plan",
            "description": "Insurance plan name."
          },
          "price": {
            "type": "string",
            "example": "570.00",
            "nullable": true,
            "description": "Insurance price."
          },
          "currency": {
            "type": "string",
            "example": "USD",
            "description": "Insurance payment currency."
          },
          "is_enabled": {
            "type": "boolean"
          }
        }
      }
    },
    "currency": {
      "type": "string",
      "example": "USD",
      "description": "Payment currency."
    },
    "is_unisure": {
      "type": "boolean"
    },
    "attachments": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "$ref": "#/components/schemas/UniqueObjectIdentifier"
          },
          "label": {
            "type": "string",
            "example": "Deel USA Health Care Packet.pdf"
          }
        }
      },
      "description": "File attachments."
    },
    "ending_rule": {
      "type": "string",
      "example": "END_OF_MONTH",
      "description": "Insurance cycle ending rule."
    },
    "fixed_price": {
      "type": "boolean",
      "description": "URL to price info."
    },
    "home_page_url": {
      "type": "string",
      "example": "https://bit.ly/3uW72fp",
      "description": "Insurance provider's home page url."
    },
    "days_to_cancel": {
      "type": "string",
      "format": "nullable",
      "description": "Days to cancel the insurance."
    },
    "pricing_info_link": {
      "type": "string",
      "format": "nullable",
      "description": "URL to price info."
    },
    "client_info_banner": {
      "type": "string",
      "format": "nullable",
      "description": "Health insurance info banner."
    },
    "is_available_for_new_quotes": {
      "type": "boolean"
    }
  },
  "description": "Health insurance provider."
}
string HiringStatusEnum
{
  "enum": [
    "active",
    "inactive",
    "onboarding"
  ],
  "type": "string",
  "x-internal": true
}
object HrVerificationLettersAndDocumentsListContainer
{
  "type": "object",
  "required": [
    "data"
  ],
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/HRDocumentInfo"
      }
    }
  },
  "x-internal": true
}
object HrisCompensation
{
  "type": "object",
  "required": [
    "gross_annual_salary",
    "currency"
  ],
  "properties": {
    "currency": {
      "type": "string",
      "example": "USD",
      "maxLength": 3,
      "minLength": 3
    },
    "gross_annual_salary": {
      "type": "number",
      "format": "float"
    }
  }
}
object HrisContractBase
{
  "type": "object",
  "required": [
    "start_date",
    "employment_type",
    "contract_oid"
  ],
  "properties": {
    "end_date": {
      "$ref": "#/components/schemas/DateString"
    },
    "start_date": {
      "$ref": "#/components/schemas/DateStringRequired"
    },
    "contract_oid": {
      "type": "string",
      "example": "pdcMQe0cXCCXWTkqkdytw",
      "description": "The Hris Direct employee contract ID"
    },
    "employee_number": {
      "type": "number"
    }
  }
}
object HrisDirectEmployee
{
  "type": "object",
  "required": [
    "employee_details",
    "team_information",
    "job_information",
    "compensation",
    "contract"
  ],
  "properties": {
    "contract": {
      "oneOf": [
        {
          "$ref": "#/components/schemas/HrisContractBase"
        },
        {
          "$ref": "#/components/schemas/HrisContractBase"
        }
      ]
    },
    "compensation": {
      "$ref": "#/components/schemas/HrisCompensation"
    },
    "vacation_info": {
      "type": "object",
      "nullable": true,
      "required": [
        "vacation_accrual_start_date",
        "vacation_yearly_policy"
      ],
      "properties": {
        "vacation_yearly_policy": {
          "type": "number",
          "maximum": 365,
          "minimum": 1
        },
        "vacation_accrual_start_date": {
          "type": "string",
          "format": "date"
        }
      }
    },
    "job_information": {
      "oneOf": [
        {
          "$ref": "#/components/schemas/HrisJobInformationTitleId"
        },
        {
          "$ref": "#/components/schemas/HrisJobInformationTitleName"
        }
      ]
    },
    "employee_details": {
      "$ref": "#/components/schemas/HrisDirectEmployeeDetails"
    },
    "team_information": {
      "$ref": "#/components/schemas/HrisTeamInformation"
    }
  }
}
object HrisDirectEmployeeContainer
{
  "type": "object",
  "required": [
    "data"
  ],
  "properties": {
    "data": {
      "$ref": "#/components/schemas/HrisDirectEmployeeResponse"
    }
  },
  "x-internal": true
}
object HrisDirectEmployeeDetails
{
  "type": "object",
  "required": [
    "first_name",
    "last_name",
    "email",
    "work_email",
    "nationality",
    "country"
  ],
  "properties": {
    "email": {
      "type": "string",
      "example": "john.doe@domain.com",
      "maxLength": 255,
      "minLength": 3
    },
    "state": {
      "type": "string",
      "example": "AC",
      "maxLength": 50,
      "minLength": 1
    },
    "country": {
      "type": "string",
      "example": "BR",
      "maxLength": 2,
      "minLength": 2
    },
    "last_name": {
      "type": "string",
      "example": "Doe",
      "maxLength": 100,
      "minLength": 3
    },
    "first_name": {
      "type": "string",
      "example": "John",
      "maxLength": 100,
      "minLength": 3
    },
    "work_email": {
      "type": "string",
      "example": "john.doe@domain.com",
      "maxLength": 255,
      "minLength": 3
    },
    "nationality": {
      "type": "string",
      "example": "CA",
      "maxLength": 2,
      "minLength": 2
    }
  }
}
object HrisDirectEmployeeResponse
{
  "allOf": [
    {
      "$ref": "#/components/schemas/HrisDirectEmployee"
    },
    {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "example": "6733c95b-df52-419e-906d-6904d3117dab",
          "description": "The Hris Direct employee ID"
        }
      }
    }
  ]
}
object HrisJobInformationBase
{
  "type": "object",
  "required": [
    "seniority_id"
  ],
  "properties": {
    "seniority_id": {
      "type": "number"
    }
  }
}
object HrisJobInformationTitleId
{
  "allOf": [
    {
      "$ref": "#/components/schemas/HrisJobInformationBase"
    },
    {
      "type": "object",
      "required": [
        "seniority_id",
        "job_title_id"
      ],
      "properties": {
        "job_title_id": {
          "type": "number"
        }
      }
    }
  ]
}
object HrisJobInformationTitleName
{
  "allOf": [
    {
      "$ref": "#/components/schemas/HrisJobInformationBase"
    },
    {
      "type": "object",
      "required": [
        "seniority_id",
        "job_title_name"
      ],
      "properties": {
        "job_title_name": {
          "type": "string",
          "example": "BE Software Engineer"
        }
      }
    }
  ]
}
object HrisTeamInformation
{
  "type": "object",
  "required": [
    "team_id",
    "legal_entity_id"
  ],
  "properties": {
    "team_id": {
      "type": "number"
    },
    "legal_entity_id": {
      "type": "number"
    }
  }
}
object InputToCreateFileRef
{
  "type": "object",
  "required": [
    "data"
  ],
  "properties": {
    "data": {
      "type": "object",
      "required": [
        "content_type"
      ],
      "properties": {
        "content_type": {
          "$ref": "#/components/schemas/FileRefTypeEnum"
        }
      }
    }
  },
  "x-internal": true
}
object InputToCreatePgoTask
{
  "type": "object",
  "required": [
    "data"
  ],
  "properties": {
    "data": {
      "$ref": "#/components/schemas/PgoTaskToCreate"
    }
  },
  "x-internal": true
}
object InputToDeletePgoTask
{
  "type": "object",
  "required": [
    "data"
  ],
  "properties": {
    "data": {
      "$ref": "#/components/schemas/PgoTaskToDelete"
    }
  },
  "x-internal": true
}
object InputToPatchContractExternalId
{
  "type": "object",
  "required": [
    "data"
  ],
  "properties": {
    "data": {
      "$ref": "#/components/schemas/ContractExternalIdToPatch"
    }
  },
  "x-internal": true
}
object InputToShieldContract
{
  "type": "object",
  "required": [
    "data"
  ],
  "properties": {
    "data": {
      "type": "object",
      "nullable": false,
      "required": [
        "agreement_id"
      ],
      "properties": {
        "agreement_id": {
          "type": "number",
          "nullable": false,
          "description": "MSA contract id (agreement)."
        }
      },
      "x-internal": false
    }
  },
  "x-internal": true
}
object InternalPeople
{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier for the user"
    },
    "team": {
      "type": "string",
      "description": "Name of the team that the user belongs to"
    },
    "email": {
      "type": "string",
      "description": "Email address of the user"
    },
    "state": {
      "type": "string",
      "description": "State where the user is located"
    },
    "country": {
      "type": "string",
      "description": "ISO 3166-1 alpha-2 code of the country where the user is located"
    },
    "pic_url": {
      "type": "string",
      "description": "URL of the user's profile picture"
    },
    "team_id": {
      "type": "integer",
      "description": "Unique identifier for the team that the user belongs to"
    },
    "payments": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Payment"
      },
      "description": "List of payment objects representing the user's payment history"
    },
    "timezone": {
      "type": "string",
      "description": "Time zone of the user's location"
    },
    "full_name": {
      "type": "string",
      "description": "Full name of the user"
    },
    "job_title": {
      "type": "string",
      "description": "Title of the user's role"
    },
    "last_name": {
      "type": "string",
      "description": "Last name of the user"
    },
    "seniority": {
      "type": "string",
      "description": "Seniority level of the user's role"
    },
    "birth_date": {
      "type": "string",
      "description": "Date of birth of the user in ISO format (yyyy-mm-dd)"
    },
    "department": {
      "type": "string",
      "description": "Name of the department that the user belongs to"
    },
    "first_name": {
      "type": "string",
      "description": "First name of the user"
    },
    "start_date": {
      "type": "string",
      "description": "Date when the user started their current employment in ISO format (yyyy-mm-dd)"
    },
    "work_email": {
      "type": "string",
      "description": "Work email address of the user"
    },
    "employments": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Employment"
      },
      "description": "List of employment objects representing the user's employment history"
    },
    "hiring_type": {
      "type": "string",
      "description": "Type of employment contract that the user has"
    },
    "country_name": {
      "type": "string",
      "description": "Name of the country where the user is located"
    },
    "has_deel_user": {
      "type": "boolean",
      "description": "Indicates whether the user has a Deel account or not"
    },
    "hiring_status": {
      "type": "string",
      "description": "Hiring status of the user"
    },
    "work_location": {
      "type": "string",
      "description": "Name of the user's work location"
    },
    "contract_types": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "List of contract types that the user has had in the past and/or currently has"
    },
    "direct_manager": {
      "type": "string",
      "description": "Name of the user's direct manager"
    },
    "direct_reports": {
      "type": "string",
      "description": "Names of the user's direct reports"
    },
    "personal_email": {
      "type": "string",
      "description": "Personal email address of the user"
    },
    "completion_date": {
      "type": "string",
      "description": "Date when the user's current employment is expected to end in ISO format (yyyy-mm-ddThh:mm:ss.sssZ)"
    },
    "monthly_payment": {
      "$ref": "#/components/schemas/MonthlyPayment",
      "description": "Object representing the user's monthly payment information"
    },
    "client_legal_entity": {
      "$ref": "#/components/schemas/PeopleClientLegalEntity",
      "description": "Object representing the client legal entity that the user is associated with"
    },
    "hourly_report_total": {
      "type": "string",
      "description": "Total amount of hours worked by the user in ISO format (hh:mm:ss)"
    },
    "direct_reports_count": {
      "type": "integer",
      "description": "Number of direct reports that the user has"
    }
  },
  "description": "People object representing a Deel"
}
object InternalPeopleContainer
{
  "type": "object",
  "required": [
    "data"
  ],
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/InternalPeople"
      }
    }
  }
}
object InvitationsOfBasicContract
{
  "type": "object",
  "properties": {
    "client_email": {
      "$ref": "#/components/schemas/EmailType"
    },
    "worker_email": {
      "$ref": "#/components/schemas/EmailType"
    }
  },
  "x-internal": true
}
object InviteTeamMemberToSign
{
  "type": "object",
  "required": [
    "contract_oid",
    "contract_name",
    "invitee_id",
    "invitee_name"
  ],
  "properties": {
    "invitee_id": {
      "type": "number",
      "nullable": false
    },
    "contract_oid": {
      "type": "string",
      "nullable": false
    },
    "invitee_name": {
      "type": "string",
      "nullable": false
    },
    "contract_name": {
      "type": "string",
      "nullable": false
    }
  }
}
object Invoice
{
  "type": "object",
  "required": [
    "id",
    "status",
    "currency",
    "created_at",
    "total",
    "label",
    "paid_at",
    "vat_total",
    "vat_percentage",
    "vat_id",
    "is_overdue",
    "issued_at",
    "due_date",
    "contract_id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "example": "rhCTiRd9Mad41RwjsFWw-",
      "description": "Unique identifier of the invoice."
    },
    "label": {
      "type": "string",
      "example": "INV-2023-4",
      "description": "Label of the invoice."
    },
    "total": {
      "type": "string",
      "example": 1000,
      "description": "Total invoice amount including Fee and VAT."
    },
    "status": {
      "$ref": "#/components/schemas/InvoiceStatusEnum"
    },
    "vat_id": {
      "type": "string",
      "nullable": true,
      "description": "VAT identification number."
    },
    "paid_at": {
      "$ref": "#/components/schemas/DateTimeString"
    },
    "currency": {
      "$ref": "#/components/schemas/CurrencyCode"
    },
    "due_date": {
      "$ref": "#/components/schemas/DateString",
      "description": "Due date for the invoice payment."
    },
    "issued_at": {
      "$ref": "#/components/schemas/DateString",
      "description": "Timestamp when the invoice was issued."
    },
    "vat_total": {
      "type": "string",
      "example": 210,
      "nullable": true,
      "description": "Amount of VAT."
    },
    "created_at": {
      "$ref": "#/components/schemas/DateTimeString"
    },
    "is_overdue": {
      "type": "boolean",
      "example": true,
      "nullable": true,
      "description": "Indicates if the invoice is overdue."
    },
    "contract_id": {
      "$ref": "#/components/schemas/DateString",
      "description": "Due date for the invoice payment."
    },
    "vat_percentage": {
      "type": "string",
      "example": 21,
      "nullable": true,
      "description": "VAT percentage."
    }
  }
}
object InvoiceAdjustment
{
  "allOf": [
    {
      "$ref": "#/components/schemas/BasicInvoiceAdjustment"
    },
    {
      "$ref": "#/components/schemas/InvoiceAdjustmentApproversContainer"
    }
  ],
  "x-internal": true
}
object InvoiceAdjustmentApprover
{
  "type": "object",
  "required": [
    "full_name",
    "email",
    "approved"
  ],
  "properties": {
    "email": {
      "type": "string"
    },
    "approved": {
      "type": "boolean"
    },
    "full_name": {
      "type": "string"
    }
  },
  "x-internal": true
}
array InvoiceAdjustmentApproverList
{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/InvoiceAdjustmentApprover"
  },
  "x-internal": true
}
object InvoiceAdjustmentApproversContainer
{
  "type": "object",
  "required": [
    "approvers"
  ],
  "properties": {
    "approvers": {
      "$ref": "#/components/schemas/InvoiceAdjustmentApproverList"
    }
  },
  "x-internal": true
}
object InvoiceAdjustmentAttachmentContainer
{
  "type": "object",
  "required": [
    "data"
  ],
  "properties": {
    "data": {
      "$ref": "#/components/schemas/AttachmentFileRef"
    }
  },
  "x-internal": true
}
object InvoiceAdjustmentContainer
{
  "type": "object",
  "required": [
    "data"
  ],
  "properties": {
    "data": {
      "$ref": "#/components/schemas/InvoiceAdjustment"
    }
  },
  "x-internal": true
}
object InvoiceAdjustmentCreated
{
  "type": "object",
  "required": [
    "created"
  ],
  "properties": {
    "id": {
      "$ref": "#/components/schemas/UniqueObjectIdentifier",
      "nullable": true
    },
    "status": {
      "$ref": "#/components/schemas/InvoiceAdjustmentStatusEnum"
    },
    "created": {
      "type": "boolean",
      "nullable": false
    },
    "created_at": {
      "$ref": "#/components/schemas/DateTimeString"
    }
  },
  "x-internal": true,
  "description": "Details of invoice adjustment created."
}
object InvoiceAdjustmentCreatedContainer
{
  "type": "object",
  "required": [
    "data"
  ],
  "properties": {
    "data": {
      "$ref": "#/components/schemas/InvoiceAdjustmentCreated"
    }
  },
  "x-internal": true
}
array InvoiceAdjustmentList
{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/BasicInvoiceAdjustment"
  },
  "x-internal": true
}
object InvoiceAdjustmentListContainer
{
  "type": "object",
  "required": [
    "data",
    "page"
  ],
  "properties": {
    "data": {
      "$ref": "#/components/schemas/InvoiceAdjustmentList"
    },
    "page": {
      "$ref": "#/components/schemas/PageInfoWithoutCursorNew"
    }
  },
  "x-internal": true
}
object InvoiceAdjustmentPendingForApproval
{
  "type": "object",
  "required": [
    "contract_name",
    "contract_oid",
    "adjustment_id",
    "adjustment_type",
    "event_type"
  ],
  "properties": {
    "team_id": {
      "type": "string",
      "nullable": false
    },
    "approvers": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "id",
          "name"
        ],
        "properties": {
          "id": {
            "type": "string"
          },
          "name": {
            "type": "string"
          }
        }
      }
    },
    "event_type": {
      "type": "string",
      "nullable": false
    },
    "contract_oid": {
      "type": "string",
      "nullable": false
    },
    "adjustment_id": {
      "type": "string",
      "nullable": false
    },
    "contract_name": {
      "type": "string",
      "nullable": false
    },
    "adjustment_type": {
      "type": "string",
      "nullable": false
    }
  }
}
object InvoiceAdjustmentReviewToCreate
{
  "type": "object",
  "required": [
    "status",
    "reason"
  ],
  "properties": {
    "reason": {
      "type": "string",
      "nullable": false
    },
    "status": {
      "enum": [
        "approved",
        "declined"
      ],
      "type": "string",
      "nullable": false
    }
  },
  "x-internal": true
}
object InvoiceAdjustmentReviewToCreateContainer
{
  "type": "object",
  "required": [
    "data"
  ],
  "properties": {
    "data": {
      "$ref": "#/components/schemas/InvoiceAdjustmentReviewToCreate"
    }
  },
  "x-internal": true
}
object InvoiceAdjustmentReviewsToCreate
{
  "type": "object",
  "required": [
    "status",
    "ids",
    "reason"
  ],
  "properties": {
    "ids": {
      "$ref": "#/components/schemas/TimesheetIdItems"
    },
    "reason": {
      "type": "string",
      "nullable": false
    },
    "status": {
      "enum": [
        "approved",
        "declined"
      ],
      "type": "string",
      "nullable": false
    }
  },
  "x-internal": true
}
object InvoiceAdjustmentReviewsToCreateContainer
{
  "type": "object",
  "required": [
    "data"
  ],
  "properties": {
    "data": {
      "$ref": "#/components/schemas/InvoiceAdjustmentReviewsToCreate"
    }
  },
  "x-internal": true
}
object InvoiceAdjustmentSearchContainer
{
  "type": "object",
  "properties": {
    "limit": {
      "type": "string",
      "default": "10",
      "pattern": "^\\d{1,5}$",
      "nullable": false,
      "maxLength": 5,
      "description": "Return a page of results with given number of records."
    },
    "types": {
      "oneOf": [
        {
          "$ref": "#/components/schemas/InvoiceAdjustmentTypeEnumList"
        },
        {
          "$ref": "#/components/schemas/InvoiceAdjustmentTypeEnum"
        }
      ]
    },
    "offset": {
      "type": "string",
      "default": "10",
      "pattern": "^\\d{1,5}$",
      "nullable": false,
      "maxLength": 5
    },
    "date_to": {
      "$ref": "#/components/schemas/DateString"
    },
    "statuses": {
      "oneOf": [
        {
          "$ref": "#/components/schemas/InvoiceAdjustmentStatusEnumList"
        },
        {
          "$ref": "#/components/schemas/InvoiceAdjustmentStatusEnum"
        }
      ]
    },
    "date_from": {
      "$ref": "#/components/schemas/DateString"
    },
    "invoice_id": {
      "type": "string",
      "nullable": false
    },
    "contract_id": {
      "type": "string",
      "nullable": false
    },
    "reporter_id": {
      "type": "string",
      "nullable": false
    },
    "contract_types": {
      "oneOf": [
        {
          "$ref": "#/components/schemas/ContractTypeEnumList"
        },
        {
          "$ref": "#/components/schemas/ContractTypeEnum"
        }
      ]
    },
    "order_direction": {
      "$ref": "#/components/schemas/SortDirEnum"
    }
  },
  "x-internal": true,
  "description": "This is a model to make it easier to understand and restrict search parameters"
}
string InvoiceAdjustmentStatusEnum
{
  "enum": [
    "approved",
    "declined",
    "not_payable",
    "paid",
    "pending",
    "processing",
    null
  ],
  "type": "string",
  "nullable": true,
  "x-internal": true,
  "description": "status of invoice adjustment"
}
array InvoiceAdjustmentStatusEnumList
{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/InvoiceAdjustmentStatusEnum"
  },
  "x-internal": true
}
object InvoiceAdjustmentToCreate
{
  "type": "object",
  "required": [
    "contract_id",
    "date_submitted",
    "type",
    "description",
    "amount"
  ],
  "properties": {
    "type": {
      "$ref": "#/components/schemas/InvoiceAdjustmentTypeToCreateEnum"
    },
    "amount": {
      "type": "number",
      "example": 2500,
      "minimum": 0,
      "nullable": false,
      "description": "Amount to be paid. Must be a positive number."
    },
    "contract_id": {
      "type": "string",
      "nullable": false,
      "description": "Id of a Deel contract."
    },
    "description": {
      "type": "string",
      "example": "Bonus for being awesome.",
      "maxLength": 30000,
      "description": "Description of the adjustment."
    },
    "date_submitted": {
      "$ref": "#/components/schemas/DateStringRequired"
    },
    "paymentCycleId": {
      "type": "number",
      "nullable": true,
      "description": "ID of an existing active payment cycle - required if type is \"vat\""
    }
  },
  "x-internal": true,
  "description": "Details of invoice adjustment to create."
}
object InvoiceAdjustmentToCreateContainer
{
  "type": "object",
  "required": [
    "data"
  ],
  "properties": {
    "data": {
      "$ref": "#/components/schemas/InvoiceAdjustmentToCreate"
    }
  },
  "x-internal": true
}
object InvoiceAdjustmentToCreateWithFile
{
  "allOf": [
    {
      "$ref": "#/components/schemas/InvoiceAdjustmentToCreate"
    },
    {
      "$ref": "#/components/schemas/FileObject"
    }
  ],
  "x-internal": true
}
object InvoiceAdjustmentToUpdate
{
  "type": "object",
  "required": [
    "description"
  ],
  "properties": {
    "amount": {
      "type": "number",
      "minimum": 0,
      "nullable": false
    },
    "description": {
      "type": "string",
      "nullable": false,
      "maxLength": 30000
    }
  },
  "x-internal": true,
  "description": "Details of invoice adjustment to update."
}
object InvoiceAdjustmentToUpdateContainer
{
  "type": "object",
  "required": [
    "data"
  ],
  "properties": {
    "data": {
      "$ref": "#/components/schemas/InvoiceAdjustmentToUpdate"
    }
  },
  "x-internal": true
}
Load more schemas