> ## Documentation Index
> Fetch the complete documentation index at: https://developer.remote.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Create Contractor Invoice Schedules

Creates many invoice schedules records.
It's supposed to return two lists: one containing created records, and another one containing the schedules that failed to be inserted.


## Scopes

| Category | Read only Scope | Write only Scope (read access implicit) |
|---|---|---|
| Manage invoices (`invoices`) | - | Manage invoices (`invoices:write`) |


# OpenAPI definition

```json
{
  "components": {
    "schemas": {
      "CurrencyCode": {
        "description": "Currency code of the SWIFT fee. Only present when processing_fee is set.",
        "example": "BRL",
        "maxLength": 3,
        "minLength": 3,
        "nullable": true,
        "title": "CurrencyCode",
        "type": "string"
      },
      "BulkContractorInvoiceScheduleCreateParams": {
        "additionalProperties": false,
        "description": "Schema defining a bulk creation payload.",
        "example": {
          "contractor_invoice_schedules": [
            {
              "currency": "BRL",
              "employment_id": "663e0b79-c893-45ff-a1b2-f6dcabc098b5",
              "items": [
                {
                  "amount": 5000,
                  "description": "Description"
                }
              ],
              "note": "A note to make it clear why schedule is needed.",
              "nr_occurrences": 10,
              "number": "CIS0001",
              "periodicity": "monthly",
              "start_date": "2024-06-01"
            },
            {
              "currency": "USD",
              "employment_id": "663e0b79-c893-45ff-a1b2-f6dcabc098b5",
              "items": [
                {
                  "amount": 5000,
                  "description": "Description"
                }
              ],
              "note": "Contractor payment schedules.",
              "nr_occurrences": 15,
              "number": "XYZ0001",
              "periodicity": "bi_weekly",
              "start_date": "2024-06-01"
            }
          ]
        },
        "properties": {
          "contractor_invoice_schedules": {
            "description": "List of invoice schedules payload.",
            "items": {
              "$ref": "#/components/schemas/ContractorInvoiceScheduleCreateParams"
            },
            "maxItems": 200,
            "minItems": 1,
            "type": "array"
          }
        },
        "required": [
          "contractor_invoice_schedules"
        ],
        "title": "BulkContractorInvoiceScheduleCreateParams",
        "type": "object"
      },
      "NotFoundResponse": {
        "description": "Returned when the requested resource does not exist or is not accessible with the current authentication credentials.",
        "example": {
          "message": "{resource} not found"
        },
        "properties": {
          "message": {
            "description": "A message indicating which resource was not found.",
            "pattern": "Not Found",
            "type": "string"
          }
        },
        "title": "NotFoundResponse",
        "type": "object"
      },
      "ContractorInvoiceScheduleCreateParams": {
        "additionalProperties": false,
        "description": "Payload shape used to create invoice schedules.",
        "example": {
          "currency": "BRL",
          "employment_id": "663e0b79-c893-45ff-a1b2-f6dcabc098b5",
          "items": [
            {
              "amount": 5000,
              "description": "Description"
            }
          ],
          "note": "A note to make it clear why schedule is needed.",
          "nr_occurrences": 10,
          "number": "CIS0001",
          "periodicity": "monthly",
          "start_date": "2024-06-01"
        },
        "properties": {
          "currency": {
            "$ref": "#/components/schemas/CurrencyCode"
          },
          "employment_id": {
            "description": "Employment identifier",
            "example": "663e0b79-c893-45ff-a1b2-f6dcabc098b5",
            "format": "uuid",
            "type": "string"
          },
          "items": {
            "description": "List of invoice items that composes the overall invoice amount.",
            "example": [
              {
                "amount": 5000,
                "description": "Description"
              }
            ],
            "items": {
              "$ref": "#/components/schemas/ContractorInvoiceScheduleItem"
            },
            "maxItems": 10,
            "minItems": 1,
            "type": "array"
          },
          "note": {
            "description": "Custom defined note.",
            "example": "A note to make it clear why schedule is needed.",
            "type": "string"
          },
          "nr_occurrences": {
            "description": "Count of invoices that should be generated during schedule lifetime.",
            "example": 10,
            "minimum": 1,
            "type": "integer"
          },
          "number": {
            "description": "Invoice identifier.",
            "example": "CIS0001",
            "maxLength": 10,
            "minLength": 1,
            "type": "string"
          },
          "periodicity": {
            "$ref": "#/components/schemas/ContractorInvoiceSchedulePeriodicity"
          },
          "start_date": {
            "description": "Date of the first contractor invoice generation.",
            "example": "2024-06-01",
            "format": "date",
            "type": "string"
          }
        },
        "required": [
          "employment_id",
          "currency",
          "start_date",
          "periodicity",
          "items"
        ],
        "title": "ContractorInvoiceScheduleCreateParams",
        "type": "object"
      },
      "UuidSlug": {
        "description": "Identifier of the employment being terminated.",
        "example": "663e0b79-c893-45ff-a1b2-f6dcabc098b5",
        "format": "uuid",
        "title": "UuidSlug",
        "type": "string"
      },
      "ContractorInvoiceScheduleCreateResponseFailure": {
        "additionalProperties": false,
        "description": "Set of invoice schedule attributes with failed validation.",
        "example": {
          "currency": "USD",
          "employment_id": "663e0b79-c893-45ff-a1b2-f6dcabc098b5",
          "errors": {
            "employment_id": [
              "not found"
            ]
          },
          "items": [
            {
              "amount": 5000,
              "description": "Description"
            }
          ],
          "note": "Contractor payment schedules.",
          "nr_occurrences": 15,
          "number": "XYZ0001",
          "periodicity": "bi_weekly",
          "start_date": "2024-06-01"
        },
        "properties": {
          "currency": {
            "$ref": "#/components/schemas/CurrencyCode"
          },
          "employment_id": {
            "description": "Employment identifier",
            "example": "663e0b79-c893-45ff-a1b2-f6dcabc098b5",
            "format": "uuid",
            "type": "string"
          },
          "errors": {
            "additionalProperties": false,
            "properties": {
              "currency": {
                "items": {
                  "type": "string"
                },
                "type": "array"
              },
              "employment_id": {
                "items": {
                  "type": "string"
                },
                "type": "array"
              },
              "items": {
                "items": {
                  "additionalProperties": false,
                  "properties": {
                    "amount": {
                      "items": {
                        "type": "string"
                      },
                      "type": "array"
                    },
                    "description": {
                      "items": {
                        "type": "string"
                      },
                      "type": "array"
                    }
                  },
                  "type": "object"
                },
                "type": "array"
              },
              "note": {
                "items": {
                  "type": "string"
                },
                "type": "array"
              },
              "nr_occurrences": {
                "items": {
                  "type": "string"
                },
                "type": "array"
              },
              "number": {
                "items": {
                  "type": "string"
                },
                "type": "array"
              },
              "periodicity": {
                "items": {
                  "type": "string"
                },
                "type": "array"
              },
              "start_date": {
                "items": {
                  "type": "string"
                },
                "type": "array"
              }
            },
            "type": "object"
          },
          "items": {
            "description": "List of invoice items that composes the overall invoice amount.",
            "example": [
              {
                "amount": 5000,
                "description": "Description"
              }
            ],
            "items": {
              "$ref": "#/components/schemas/ContractorInvoiceScheduleItem"
            },
            "maxItems": 10,
            "minItems": 1,
            "type": "array"
          },
          "note": {
            "description": "Custom defined note.",
            "example": "A note to make it clear why schedule is needed.",
            "type": "string"
          },
          "nr_occurrences": {
            "description": "Count of invoices that should be generated during schedule lifetime.",
            "example": 10,
            "minimum": 1,
            "type": "integer"
          },
          "number": {
            "description": "Invoice identifier.",
            "example": "CIS0001",
            "maxLength": 10,
            "minLength": 1,
            "type": "string"
          },
          "periodicity": {
            "$ref": "#/components/schemas/ContractorInvoiceSchedulePeriodicity"
          },
          "start_date": {
            "description": "Date of the first contractor invoice generation.",
            "example": "2024-06-01",
            "format": "date",
            "type": "string"
          }
        },
        "required": [
          "employment_id",
          "currency",
          "start_date",
          "periodicity",
          "items",
          "errors"
        ],
        "title": "ContractorInvoiceScheduleCreateResponseFailure",
        "type": "object"
      },
      "ContractorInvoiceSchedulePeriodicity": {
        "description": "Defines how often contractor invoices will be generated.\n\n- `bi_weekly`: Invoices will be generated every other week, on the given day of the week based on the start date.\n- `monthly`: Invoices will be generated once a month.\n- `semi_monthly`: Invoices will be generated at fixed dates twice a month (with 14 days of difference between each other), depending on the start date.\n   In months with just 30 days, if `start_date` is set to the 31st day, then generation occurs in the last of day of the month.\n- `weekly`: Invoices will be generated each week.\n",
        "enum": [
          "bi_weekly",
          "monthly",
          "semi_monthly",
          "weekly"
        ],
        "example": "monthly",
        "nullable": false,
        "title": "ContractorInvoiceSchedulePeriodicity",
        "type": "string"
      },
      "ContractorInvoiceScheduleItem": {
        "additionalProperties": false,
        "description": "Line Item schema for a Contractor Invoice Schedule",
        "example": {
          "amount": 5000,
          "description": "Description"
        },
        "properties": {
          "amount": {
            "description": "Amount, in cents.",
            "type": "integer"
          },
          "description": {
            "description": "Describes invoice item intent.",
            "type": "string"
          }
        },
        "required": [
          "amount",
          "description"
        ],
        "title": "ContractorInvoiceScheduleItem",
        "type": "object"
      },
      "ForbiddenResponse": {
        "description": "Returned when the authenticated user or token does not have permission to perform the requested action. Check that the token has the required OAuth2 scopes and that the user has the necessary role.",
        "example": {
          "message": "Forbidden"
        },
        "properties": {
          "message": {
            "pattern": "Forbidden",
            "type": "string"
          }
        },
        "required": [
          "message"
        ],
        "title": "ForbiddenResponse",
        "type": "object"
      },
      "ContractorInvoiceScheduleCreateResponseSuccess": {
        "additionalProperties": false,
        "description": "Set of invoice schedule attributes that were successfully created.",
        "example": {
          "currency": "BRL",
          "employment_id": "663e0b79-c893-45ff-a1b2-f6dcabc098b5",
          "id": "663e0b79-c893-45ff-a1b2-f6dcabc098b5",
          "items": [
            {
              "amount": 5000,
              "description": "Description"
            }
          ],
          "note": "A note to make it clear why schedule is needed.",
          "nr_occurrences": 10,
          "number": "CIS0001",
          "periodicity": "monthly",
          "start_date": "2024-06-01"
        },
        "properties": {
          "currency": {
            "$ref": "#/components/schemas/CurrencyCode"
          },
          "employment_id": {
            "description": "Employment identifier",
            "example": "663e0b79-c893-45ff-a1b2-f6dcabc098b5",
            "format": "uuid",
            "type": "string"
          },
          "id": {
            "$ref": "#/components/schemas/UuidSlug"
          },
          "items": {
            "description": "List of invoice items that composes the overall invoice amount.",
            "example": [
              {
                "amount": 5000,
                "description": "Description"
              }
            ],
            "items": {
              "$ref": "#/components/schemas/ContractorInvoiceScheduleItem"
            },
            "maxItems": 10,
            "minItems": 1,
            "type": "array"
          },
          "note": {
            "description": "Custom defined note.",
            "example": "A note to make it clear why schedule is needed.",
            "type": "string"
          },
          "nr_occurrences": {
            "description": "Count of invoices that should be generated during schedule lifetime.",
            "example": 10,
            "minimum": 1,
            "type": "integer"
          },
          "number": {
            "description": "Invoice identifier.",
            "example": "CIS0001",
            "maxLength": 10,
            "minLength": 1,
            "type": "string"
          },
          "periodicity": {
            "$ref": "#/components/schemas/ContractorInvoiceSchedulePeriodicity"
          },
          "start_date": {
            "description": "Date of the first contractor invoice generation.",
            "example": "2024-06-01",
            "format": "date",
            "type": "string"
          }
        },
        "required": [
          "employment_id",
          "currency",
          "start_date",
          "periodicity",
          "items",
          "id"
        ],
        "title": "ContractorInvoiceScheduleCreateResponseSuccess",
        "type": "object"
      }
    },
    "securitySchemes": {
      "CustomerAPIToken": {
        "description": "Authenticate using API Key generated by the customer in their Integration Settings page.\n",
        "scheme": "bearer",
        "type": "http"
      },
      "OAuth2": {
        "description": "Authenticate using OAuth 2.0 protocol.\n",
        "flows": {
          "authorizationCode": {
            "authorizationUrl": "/auth/oauth2/authorize",
            "scopes": {
              "company_department:read": "company_department:read",
              "webhook:write": "webhook:write",
              "magic_link:write": "magic_link:write",
              "offboarding:write": "offboarding:write",
              "custom_field:write": "custom_field:write",
              "address:write": "address:write",
              "expense:read": "expense:read",
              "employment:write": "employment:write",
              "identity_verification:write": "identity_verification:write",
              "timesheet:write": "timesheet:write",
              "travel_letter:write": "travel_letter:write",
              "incentive:read": "incentive:read",
              "personal_detail:read": "personal_detail:read",
              "invoices:write": "invoices:write",
              "work_authorization:write": "work_authorization:write",
              "timeoff:write": "timeoff:write",
              "company_structure:read": "company_structure:read",
              "benefit_renewal:write": "benefit_renewal:write",
              "benefit_offer:read": "benefit_offer:read",
              "employment_documents": "employment_documents",
              "onboarding:write": "onboarding:write",
              "payroll_run:read": "payroll_run:read",
              "risk_reserve:write": "risk_reserve:write",
              "invoices": "invoices",
              "resignation_letter:read": "resignation_letter:read",
              "resignation:read": "resignation:read",
              "convert_currency:read": "convert_currency:read",
              "employments": "employments",
              "probation_document:read": "probation_document:read",
              "company_admin": "company_admin",
              "payroll": "payroll",
              "help_center_article:read": "help_center_article:read",
              "timesheet:read": "timesheet:read",
              "custom_field_value:write": "custom_field_value:write",
              "company_currencies:read": "company_currencies:read",
              "payslip:read": "payslip:read",
              "pay_item:write": "pay_item:write",
              "resignation:write": "resignation:write",
              "custom_field:read": "custom_field:read",
              "payroll_calendar:read": "payroll_calendar:read",
              "contract_amendment:write": "contract_amendment:write",
              "offboarding:read": "offboarding:read",
              "timeoff:read": "timeoff:read",
              "probation_document:write": "probation_document:write",
              "country:read": "country:read",
              "webhook:read": "webhook:read",
              "company_department:write": "company_department:write",
              "company_manager:read": "company_manager:read",
              "pay_item:read": "pay_item:read",
              "contract_amendment:read": "contract_amendment:read",
              "company:read": "company:read",
              "sso_configuration:write": "sso_configuration:write",
              "benefit_offer:write": "benefit_offer:write",
              "contract_eligibility:write": "contract_eligibility:write",
              "benefit_renewal:read": "benefit_renewal:read",
              "background_check:read": "background_check:read",
              "custom_field_value:read": "custom_field_value:read",
              "expense:write": "expense:write",
              "identity_verification:read": "identity_verification:read",
              "address:read": "address:read",
              "document:write": "document:write",
              "time_and_attendance": "time_and_attendance",
              "employment_payments": "employment_payments",
              "form:read": "form:read",
              "work_authorization:read": "work_authorization:read",
              "invoices:read": "invoices:read",
              "incentive:write": "incentive:write",
              "employment:read": "employment:read",
              "contract:read": "contract:read",
              "company_manager:write": "company_manager:write",
              "travel_letter:read": "travel_letter:read",
              "document:read": "document:read",
              "sso_configuration:read": "sso_configuration:read"
            },
            "tokenUrl": "/auth/oauth2/token"
          },
          "clientCredentials": {
            "scopes": {
              "company:read": "company:read",
              "company:write": "company:write",
              "company_admin": "company_admin",
              "company_management": "company_management",
              "convert_currency:read": "convert_currency:read",
              "country:read": "country:read",
              "employment_documents": "employment_documents",
              "employment_payments": "employment_payments",
              "employments": "employments",
              "help_center_article:read": "help_center_article:read",
              "invoices": "invoices",
              "payroll": "payroll",
              "payroll_calendar:read": "payroll_calendar:read",
              "pricing_plan:read": "pricing_plan:read",
              "pricing_plan:write": "pricing_plan:write",
              "time_and_attendance": "time_and_attendance",
              "webhook:read": "webhook:read",
              "webhook:write": "webhook:write"
            },
            "tokenUrl": "/auth/oauth2/token"
          }
        },
        "type": "oauth2"
      },
      "OAuth2AuthorizationCode": {
        "description": "Authenticate as the token authorizer using `authorization_code` / `refresh_token` grants in the OAuth 2.0 protocol.\n",
        "flows": {
          "authorizationCode": {
            "authorizationUrl": "/auth/oauth2/authorize",
            "refreshUrl": "/auth/oauth2/token",
            "scopes": {
              "company_department:read": "company_department:read",
              "webhook:write": "webhook:write",
              "magic_link:write": "magic_link:write",
              "offboarding:write": "offboarding:write",
              "custom_field:write": "custom_field:write",
              "address:write": "address:write",
              "expense:read": "expense:read",
              "employment:write": "employment:write",
              "identity_verification:write": "identity_verification:write",
              "timesheet:write": "timesheet:write",
              "travel_letter:write": "travel_letter:write",
              "incentive:read": "incentive:read",
              "personal_detail:read": "personal_detail:read",
              "invoices:write": "invoices:write",
              "work_authorization:write": "work_authorization:write",
              "timeoff:write": "timeoff:write",
              "company_structure:read": "company_structure:read",
              "benefit_renewal:write": "benefit_renewal:write",
              "benefit_offer:read": "benefit_offer:read",
              "employment_documents": "employment_documents",
              "onboarding:write": "onboarding:write",
              "payroll_run:read": "payroll_run:read",
              "risk_reserve:write": "risk_reserve:write",
              "invoices": "invoices",
              "resignation_letter:read": "resignation_letter:read",
              "resignation:read": "resignation:read",
              "convert_currency:read": "convert_currency:read",
              "employments": "employments",
              "probation_document:read": "probation_document:read",
              "company_admin": "company_admin",
              "payroll": "payroll",
              "help_center_article:read": "help_center_article:read",
              "timesheet:read": "timesheet:read",
              "custom_field_value:write": "custom_field_value:write",
              "company_currencies:read": "company_currencies:read",
              "payslip:read": "payslip:read",
              "pay_item:write": "pay_item:write",
              "resignation:write": "resignation:write",
              "custom_field:read": "custom_field:read",
              "payroll_calendar:read": "payroll_calendar:read",
              "contract_amendment:write": "contract_amendment:write",
              "offboarding:read": "offboarding:read",
              "timeoff:read": "timeoff:read",
              "probation_document:write": "probation_document:write",
              "country:read": "country:read",
              "webhook:read": "webhook:read",
              "company_department:write": "company_department:write",
              "company_manager:read": "company_manager:read",
              "pay_item:read": "pay_item:read",
              "contract_amendment:read": "contract_amendment:read",
              "company:read": "company:read",
              "sso_configuration:write": "sso_configuration:write",
              "benefit_offer:write": "benefit_offer:write",
              "contract_eligibility:write": "contract_eligibility:write",
              "benefit_renewal:read": "benefit_renewal:read",
              "background_check:read": "background_check:read",
              "custom_field_value:read": "custom_field_value:read",
              "expense:write": "expense:write",
              "identity_verification:read": "identity_verification:read",
              "address:read": "address:read",
              "document:write": "document:write",
              "time_and_attendance": "time_and_attendance",
              "employment_payments": "employment_payments",
              "form:read": "form:read",
              "work_authorization:read": "work_authorization:read",
              "invoices:read": "invoices:read",
              "incentive:write": "incentive:write",
              "employment:read": "employment:read",
              "contract:read": "contract:read",
              "company_manager:write": "company_manager:write",
              "travel_letter:read": "travel_letter:read",
              "document:read": "document:read",
              "sso_configuration:read": "sso_configuration:read"
            },
            "tokenUrl": "/auth/oauth2/token"
          }
        },
        "type": "oauth2"
      }
    }
  },
  "info": {
    "title": "Contractors",
    "version": "1.0.0"
  },
  "openapi": "3.1.0",
  "paths": {
    "/v1/contractor-invoice-schedules": {
      "post": {
        "callbacks": {},
        "deprecated": false,
        "description": "Creates many invoice schedules records.\nIt's supposed to return two lists: one containing created records, and another one containing the schedules that failed to be inserted.\n\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage invoices (`invoices`) | - | Manage invoices (`invoices:write`) |\n",
        "operationId": "post_v1_contractor-invoice-schedules",
        "parameters": [],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/BulkContractorInvoiceScheduleCreateParams"
              }
            }
          },
          "description": "Bulk creation payload",
          "required": true
        },
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "additionalProperties": false,
                  "description": "Response containing the lists of succeeded and failed schedules.",
                  "example": {
                    "data": {
                      "failures": [],
                      "successes": [
                        {
                          "currency": "BRL",
                          "employment_id": "663e0b79-c893-45ff-a1b2-f6dcabc098b5",
                          "id": "663e0b79-c893-45ff-a1b2-f6dcabc098b5",
                          "items": [
                            {
                              "amount": 5000,
                              "description": "Description"
                            }
                          ],
                          "note": "A note to make it clear why schedule is needed.",
                          "nr_occurrences": 10,
                          "number": "CIS0001",
                          "periodicity": "monthly",
                          "start_date": "2024-06-01"
                        }
                      ]
                    }
                  },
                  "properties": {
                    "data": {
                      "additionalProperties": false,
                      "properties": {
                        "failures": {
                          "items": {
                            "$ref": "#/components/schemas/ContractorInvoiceScheduleCreateResponseFailure"
                          },
                          "type": "array"
                        },
                        "successes": {
                          "items": {
                            "$ref": "#/components/schemas/ContractorInvoiceScheduleCreateResponseSuccess"
                          },
                          "type": "array"
                        }
                      },
                      "required": [
                        "successes",
                        "failures"
                      ],
                      "type": "object"
                    }
                  },
                  "required": [
                    "data"
                  ],
                  "title": "BulkContractorInvoiceScheduleCreateResponse",
                  "type": "object"
                }
              }
            },
            "description": "All entries have been created"
          },
          "207": {
            "content": {
              "application/json": {
                "schema": {
                  "additionalProperties": false,
                  "description": "Response containing the lists of succeeded and failed schedules.",
                  "example": {
                    "data": {
                      "failures": [
                        {
                          "currency": "USD",
                          "employment_id": "663e0b79-c893-45ff-a1b2-f6dcabc098b5",
                          "errors": {
                            "employment_id": [
                              "not found"
                            ]
                          },
                          "items": [
                            {
                              "amount": 5000,
                              "description": "Description"
                            }
                          ],
                          "note": "Contractor payment schedules.",
                          "nr_occurrences": 15,
                          "number": "XYZ0001",
                          "periodicity": "bi_weekly",
                          "start_date": "2024-06-01"
                        }
                      ],
                      "successes": [
                        {
                          "currency": "BRL",
                          "employment_id": "663e0b79-c893-45ff-a1b2-f6dcabc098b5",
                          "id": "663e0b79-c893-45ff-a1b2-f6dcabc098b5",
                          "items": [
                            {
                              "amount": 5000,
                              "description": "Description"
                            }
                          ],
                          "note": "A note to make it clear why schedule is needed.",
                          "nr_occurrences": 10,
                          "number": "CIS0001",
                          "periodicity": "monthly",
                          "start_date": "2024-06-01"
                        }
                      ]
                    }
                  },
                  "properties": {
                    "data": {
                      "additionalProperties": false,
                      "properties": {
                        "failures": {
                          "items": {
                            "$ref": "#/components/schemas/ContractorInvoiceScheduleCreateResponseFailure"
                          },
                          "type": "array"
                        },
                        "successes": {
                          "items": {
                            "$ref": "#/components/schemas/ContractorInvoiceScheduleCreateResponseSuccess"
                          },
                          "type": "array"
                        }
                      },
                      "required": [
                        "successes",
                        "failures"
                      ],
                      "type": "object"
                    }
                  },
                  "required": [
                    "data"
                  ],
                  "title": "BulkContractorInvoiceScheduleCreateResponse",
                  "type": "object"
                }
              }
            },
            "description": "Multiple successes and failures"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ForbiddenResponse"
                }
              }
            },
            "description": "Forbidden"
          },
          "404": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/NotFoundResponse"
                }
              }
            },
            "description": "Not Found"
          },
          "422": {
            "content": {
              "application/json": {
                "schema": {
                  "additionalProperties": false,
                  "description": "Response containing the lists of succeeded and failed schedules.",
                  "example": {
                    "data": {
                      "failures": [
                        {
                          "currency": "USD",
                          "employment_id": "663e0b79-c893-45ff-a1b2-f6dcabc098b5",
                          "errors": {
                            "employment_id": [
                              "not found"
                            ]
                          },
                          "items": [
                            {
                              "amount": 5000,
                              "description": "Description"
                            }
                          ],
                          "note": "Contractor payment schedules.",
                          "nr_occurrences": 15,
                          "number": "XYZ0001",
                          "periodicity": "bi_weekly",
                          "start_date": "2024-06-01"
                        }
                      ],
                      "successes": []
                    }
                  },
                  "properties": {
                    "data": {
                      "additionalProperties": false,
                      "properties": {
                        "failures": {
                          "items": {
                            "$ref": "#/components/schemas/ContractorInvoiceScheduleCreateResponseFailure"
                          },
                          "type": "array"
                        },
                        "successes": {
                          "items": {
                            "$ref": "#/components/schemas/ContractorInvoiceScheduleCreateResponseSuccess"
                          },
                          "type": "array"
                        }
                      },
                      "required": [
                        "successes",
                        "failures"
                      ],
                      "type": "object"
                    }
                  },
                  "required": [
                    "data"
                  ],
                  "title": "BulkContractorInvoiceScheduleCreateResponse",
                  "type": "object"
                }
              }
            },
            "description": "All entries had failed"
          }
        },
        "security": [
          {
            "CustomerAPIToken": [
              "https://gateway.remote.com/company.manage",
              "invoices:write",
              "invoices",
              "all:write"
            ],
            "OAuth2AuthorizationCode": [
              "https://gateway.remote.com/company.manage",
              "invoices:write",
              "invoices",
              "all:write"
            ]
          }
        ],
        "summary": "Create Contractor Invoice Schedules",
        "tags": [
          "Invoice Schedules"
        ]
      }
    }
  },
  "security": [
    {
      "OAuth2": []
    }
  ],
  "servers": [
    {
      "url": "https://gateway.remote.com/",
      "variables": {}
    },
    {
      "url": "https://gateway.remote-sandbox.com/",
      "variables": {}
    }
  ],
  "tags": [
    {
      "name": "Employments"
    }
  ],
  "webhooks": {
    "contractor_invoice.employer_paid": {
      "post": {
        "deprecated": false,
        "description": "This event is triggered when Remote has confirmed receipt of the employer's\nfunds for a contractor invoice (the associated outstanding payment moves to\n`paid_in`). Payout to the contractor has not happened yet.\n\nThe payload is stateless. Use the contractor invoice ID and employment ID to retrieve current details.\n",
        "operationId": "contractor_invoice.employer_paid",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "example": {
                  "company_id": "123-example",
                  "contractor_invoice_id": "123-example",
                  "employment_id": "123-example",
                  "event_type": "contractor_invoice.employer_paid"
                },
                "properties": {
                  "company_id": {
                    "description": "The unique identifier of the related company.",
                    "type": "string"
                  },
                  "contractor_invoice_id": {
                    "description": "The unique identifier of the contractor invoice.",
                    "type": "string"
                  },
                  "employment_id": {
                    "description": "The unique identifier of the related employment.",
                    "type": "string"
                  },
                  "event_type": {
                    "description": "The webhook event type identifier.",
                    "type": "string"
                  }
                },
                "required": [
                  "event_type",
                  "contractor_invoice_id",
                  "employment_id",
                  "company_id"
                ]
              }
            }
          }
        },
        "responses": {
          "2XX": {
            "description": "Any 200 response confirms that the webhook was delivered."
          }
        },
        "security": [],
        "summary": "contractor_invoice.employer_paid",
        "tags": [
          "Invoices"
        ]
      }
    },
    "contractor_invoice.issued": {
      "post": {
        "deprecated": false,
        "description": "This event is triggered when a contractor invoice is issued for the first time —\neither submitted by the contractor on creation, or transitioned out of `draft`.\n\nThe payload is stateless. Use the contractor invoice ID and employment ID to retrieve current details.\n",
        "operationId": "contractor_invoice.issued",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "example": {
                  "company_id": "123-example",
                  "contractor_invoice_id": "123-example",
                  "employment_id": "123-example",
                  "event_type": "contractor_invoice.issued"
                },
                "properties": {
                  "company_id": {
                    "description": "The unique identifier of the related company.",
                    "type": "string"
                  },
                  "contractor_invoice_id": {
                    "description": "The unique identifier of the contractor invoice.",
                    "type": "string"
                  },
                  "employment_id": {
                    "description": "The unique identifier of the related employment.",
                    "type": "string"
                  },
                  "event_type": {
                    "description": "The webhook event type identifier.",
                    "type": "string"
                  }
                },
                "required": [
                  "event_type",
                  "contractor_invoice_id",
                  "employment_id",
                  "company_id"
                ]
              }
            }
          }
        },
        "responses": {
          "2XX": {
            "description": "Any 200 response confirms that the webhook was delivered."
          }
        },
        "security": [],
        "summary": "contractor_invoice.issued",
        "tags": [
          "Invoices"
        ]
      }
    },
    "contractor_invoice.paid_out": {
      "post": {
        "deprecated": false,
        "description": "This event is triggered when a contractor invoice has been paid out — funds\nhave been delivered to the contractor. This is the terminal lifecycle event.\n\nThe payload is stateless. Use the contractor invoice ID and employment ID to retrieve current details.\n",
        "operationId": "contractor_invoice.paid_out",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "example": {
                  "company_id": "123-example",
                  "contractor_invoice_id": "123-example",
                  "employment_id": "123-example",
                  "event_type": "contractor_invoice.paid_out"
                },
                "properties": {
                  "company_id": {
                    "description": "The unique identifier of the related company.",
                    "type": "string"
                  },
                  "contractor_invoice_id": {
                    "description": "The unique identifier of the contractor invoice.",
                    "type": "string"
                  },
                  "employment_id": {
                    "description": "The unique identifier of the related employment.",
                    "type": "string"
                  },
                  "event_type": {
                    "description": "The webhook event type identifier.",
                    "type": "string"
                  }
                },
                "required": [
                  "event_type",
                  "contractor_invoice_id",
                  "employment_id",
                  "company_id"
                ]
              }
            }
          }
        },
        "responses": {
          "2XX": {
            "description": "Any 200 response confirms that the webhook was delivered."
          }
        },
        "security": [],
        "summary": "contractor_invoice.paid_out",
        "tags": [
          "Invoices"
        ]
      }
    },
    "contractor_invoice.payment_initiated": {
      "post": {
        "deprecated": false,
        "description": "This event is triggered when an employer initiates payment on a contractor invoice\nfor the first time (transition to `pending_payment` from `issued` or `approved`).\n\nThe payload is stateless. Use the contractor invoice ID and employment ID to retrieve current details.\n",
        "operationId": "contractor_invoice.payment_initiated",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "example": {
                  "company_id": "123-example",
                  "contractor_invoice_id": "123-example",
                  "employment_id": "123-example",
                  "event_type": "contractor_invoice.payment_initiated"
                },
                "properties": {
                  "company_id": {
                    "description": "The unique identifier of the related company.",
                    "type": "string"
                  },
                  "contractor_invoice_id": {
                    "description": "The unique identifier of the contractor invoice.",
                    "type": "string"
                  },
                  "employment_id": {
                    "description": "The unique identifier of the related employment.",
                    "type": "string"
                  },
                  "event_type": {
                    "description": "The webhook event type identifier.",
                    "type": "string"
                  }
                },
                "required": [
                  "event_type",
                  "contractor_invoice_id",
                  "employment_id",
                  "company_id"
                ]
              }
            }
          }
        },
        "responses": {
          "2XX": {
            "description": "Any 200 response confirms that the webhook was delivered."
          }
        },
        "security": [],
        "summary": "contractor_invoice.payment_initiated",
        "tags": [
          "Invoices"
        ]
      }
    },
    "employment.contractor_management_plan.updated": {
      "post": {
        "deprecated": false,
        "description": "This event is triggered when a contractor's plan changes between Contractor Management (CM)\nand Contractor Management Plus (CM+).\n\nThe payload is stateless. Use the employment endpoint to retrieve the current plan details.\n",
        "operationId": "employment.contractor_management_plan.updated",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "example": {
                  "company_id": "129d02bc-dd6a-11ed-ac99-cb057df06a33",
                  "employment_id": "2614f814-b08e-4c8e-8c4d-ddbcc4692d99",
                  "event_type": "employment.contractor_management_plan.updated"
                },
                "properties": {
                  "company_id": {
                    "description": "The unique identifier of the related company.",
                    "type": "string"
                  },
                  "employment_id": {
                    "description": "The unique identifier of the related employment.",
                    "type": "string"
                  },
                  "event_type": {
                    "description": "The webhook event type identifier.",
                    "type": "string"
                  }
                },
                "required": [
                  "event_type",
                  "employment_id",
                  "company_id"
                ]
              }
            }
          }
        },
        "responses": {
          "2XX": {
            "description": "Any 200 response confirms that the webhook was delivered."
          }
        },
        "security": [],
        "summary": "employment.contractor_management_plan.updated",
        "tags": [
          "Employments"
        ]
      }
    },
    "employment.contractor_of_record_termination.cancelled": {
      "post": {
        "deprecated": false,
        "description": "This event is triggered when a contractor of record termination request is cancelled.\n\nThe payload is stateless. Use the termination request ID and employment ID to retrieve the current details.\n",
        "operationId": "employment.contractor_of_record_termination.cancelled",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "example": {
                  "company_id": "123-example",
                  "employment_id": "123-example",
                  "event_type": "employment.contractor_of_record_termination.cancelled",
                  "termination_request_id": "123-example"
                },
                "properties": {
                  "company_id": {
                    "description": "The unique identifier of the related company.",
                    "type": "string"
                  },
                  "employment_id": {
                    "description": "The unique identifier of the related employment.",
                    "type": "string"
                  },
                  "event_type": {
                    "description": "The webhook event type identifier.",
                    "type": "string"
                  },
                  "termination_request_id": {
                    "description": "The unique identifier of the termination request.",
                    "type": "string"
                  }
                },
                "required": [
                  "event_type",
                  "termination_request_id",
                  "employment_id",
                  "company_id"
                ]
              }
            }
          }
        },
        "responses": {
          "2XX": {
            "description": "Any 200 response confirms that the webhook was delivered."
          }
        },
        "security": [],
        "summary": "employment.contractor_of_record_termination.cancelled",
        "tags": [
          "Employments"
        ]
      }
    },
    "employment.cor_hiring.invoice_created": {
      "post": {
        "deprecated": false,
        "description": "This event is triggered when a invoice report is created for a employment.",
        "operationId": "employment.cor_hiring.invoice_created",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "example": {
                  "company_id": "f2a1b3c4-d5e6-7f8g-9h0i-j1k2l3m4n5o6",
                  "employment_id": "f8e9d2c7-3a1b-4f5c-9e6d-8b7a2c1d0e3f",
                  "event_type": "employment.cor_hiring.invoice_created",
                  "invoice_report_id": "c7f8e9d2-3a1b-4f5c-9e6d-8b7a2c1d0e3f"
                },
                "properties": {
                  "company_id": {
                    "type": "string"
                  },
                  "employment_id": {
                    "type": "string"
                  },
                  "event_type": {
                    "type": "string"
                  },
                  "invoice_report_id": {
                    "type": "string"
                  }
                },
                "required": [
                  "event_type",
                  "employment_id",
                  "invoice_report_id",
                  "company_id"
                ]
              }
            }
          }
        },
        "responses": {
          "2XX": {
            "description": "Any 200 response confirms that the webhook was delivered."
          }
        },
        "security": [],
        "summary": "employment.cor_hiring.invoice_created",
        "tags": [
          "COR Hiring"
        ]
      }
    },
    "employment.cor_hiring.proof_of_payment_accepted": {
      "post": {
        "deprecated": false,
        "description": "This event is triggered when a proof of payment is accepted for a contractor of record employment.",
        "operationId": "employment.cor_hiring.proof_of_payment_accepted",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "example": {
                  "company_id": "f2a1b3c4-d5e6-7f8g-9h0i-j1k2l3m4n5o6",
                  "employment_id": "f8e9d2c7-3a1b-4f5c-9e6d-8b7a2c1d0e3f",
                  "event_type": "employment.cor_hiring.proof_of_payment_accepted",
                  "proof_of_payment_id": "c7f8e9d2-3a1b-4f5c-9e6d-8b7a2c1d0e3f"
                },
                "properties": {
                  "company_id": {
                    "type": "string"
                  },
                  "employment_id": {
                    "type": "string"
                  },
                  "event_type": {
                    "type": "string"
                  },
                  "proof_of_payment_id": {
                    "type": "string"
                  }
                },
                "required": [
                  "event_type",
                  "employment_id",
                  "proof_of_payment_id",
                  "company_id"
                ]
              }
            }
          }
        },
        "responses": {
          "2XX": {
            "description": "Any 200 response confirms that the webhook was delivered."
          }
        },
        "security": [],
        "summary": "employment.cor_hiring.proof_of_payment_accepted",
        "tags": [
          "COR Hiring"
        ]
      }
    },
    "employment.cor_hiring.proof_of_payment_submitted": {
      "post": {
        "deprecated": false,
        "description": "This event is triggered when a proof of payment is submitted for a contractor of record employment.",
        "operationId": "employment.cor_hiring.proof_of_payment_submitted",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "example": {
                  "company_id": "f2a1b3c4-d5e6-7f8g-9h0i-j1k2l3m4n5o6",
                  "employment_id": "f8e9d2c7-3a1b-4f5c-9e6d-8b7a2c1d0e3f",
                  "event_type": "employment.cor_hiring.proof_of_payment_submitted",
                  "proof_of_payment_id": "c7f8e9d2-3a1b-4f5c-9e6d-8b7a2c1d0e3f"
                },
                "properties": {
                  "company_id": {
                    "type": "string"
                  },
                  "employment_id": {
                    "type": "string"
                  },
                  "event_type": {
                    "type": "string"
                  },
                  "proof_of_payment_id": {
                    "type": "string"
                  }
                },
                "required": [
                  "event_type",
                  "employment_id",
                  "proof_of_payment_id",
                  "company_id"
                ]
              }
            }
          }
        },
        "responses": {
          "2XX": {
            "description": "Any 200 response confirms that the webhook was delivered."
          }
        },
        "security": [],
        "summary": "employment.cor_hiring.proof_of_payment_submitted",
        "tags": [
          "COR Hiring"
        ]
      }
    }
  }
}
```