---
title: "List Contractor Invoice Schedules"
method: GET
path: "/v1/contractor-invoice-schedules"
tags: ["Invoice Schedules"]
---

# List Contractor Invoice Schedules

`GET /v1/contractor-invoice-schedules`

Lists Contractor Invoice Schedule records.

## Scopes

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

## Query parameters

- `start_date_from` string, date — UTC date in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format
- `start_date_to` string, date — UTC date in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format
- `next_invoice_date_from` string, date — UTC date in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format
- `next_invoice_date_to` string, date — UTC date in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format
- `status` 'inactive' | 'completed' | 'active' | 'processing' | 'pending_company_action' | 'pending_contractor_action' | 'generation_failed_unrelated_to_withdrawal_method' — Current record state. - `active`: Once an invoice is generated, and a withdrawal method has been set, then it's set to active. - `processing`: Ephemeral status indicating that we are currently attempting to generate a contractor invoice from the scheduled contractor invoice. - `pending_company_action`: Company needs to trigger some actions related to payment configuration. - `pending_contractor_action`: When schedule is blocked by contractor onboarding or invoice generation failed due to withdrawal methods issues that needs contractor action. - `generation_failed_unrelated_to_withdrawal_method`: Generation failed for any other reason. - `completed`: Number of generated contractor invoices has been reached. - `inactive`: Does not create any further contractor invoices but it's still possible for the employer to activate it again.
- `employment_id` string, uuid — Identifier of the employment being terminated.
- `periodicity` 'bi_weekly' | 'monthly' | 'semi_monthly' | 'weekly' — Defines how often contractor invoices will be generated. - `bi_weekly`: Invoices will be generated every other week, on the given day of the week based on the start date. - `monthly`: Invoices will be generated once a month. - `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. 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. - `weekly`: Invoices will be generated each week.
- `currency` string
- `sort_by` 'number' | 'total_amount' | 'next_invoice_at' | 'start_date' | 'nr_occurrences'
- `order` 'asc' | 'desc'
- `page` integer
- `page_size` integer

## Response `200`

Success

- ListContractorInvoiceSchedulesResponse — Paginated response schema listing all Contractor Invoice Schedules.
  - `data` object
    - `contractor_invoice_schedules` ContractorInvoiceSchedule[]
      - `currency` string, nullable, required — Currency code of the SWIFT fee. Only present when processing_fee is set.
      - `employment_id` string, uuid, required — Employment identifier.
      - `id` string, uuid, required — Schedule identifier.
      - `items` ContractorInvoiceScheduleItem[], required — List of invoice items that composes the overall invoice amount.
        - `amount` integer, required — Amount, in cents.
        - `description` string, required — Describes invoice item intent.
      - `next_invoice_at` string, datetime, nullable — Date time which next invoice will be generated.
      - `note` string, nullable — Custom defined note.
      - `nr_occurrences` integer, nullable — Count of remaining invoices that should be generated.
      - `number` string, nullable — Invoice identifier.
      - `periodicity` 'bi_weekly' | 'monthly' | 'semi_monthly' | 'weekly', required — Defines how often contractor invoices will be generated. - `bi_weekly`: Invoices will be generated every other week, on the given day of the week based on the start date. - `monthly`: Invoices will be generated once a month. - `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. 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. - `weekly`: Invoices will be generated each week.
      - `start_date` string, date, required — Date which invoices generation will start.
      - `status` 'inactive' | 'completed' | 'active' | 'processing' | 'pending_company_action' | 'pending_contractor_action' | 'generation_failed_unrelated_to_withdrawal_method', required — Current record state. - `active`: Once an invoice is generated, and a withdrawal method has been set, then it's set to active. - `processing`: Ephemeral status indicating that we are currently attempting to generate a contractor invoice from the scheduled contractor invoice. - `pending_company_action`: Company needs to trigger some actions related to payment configuration. - `pending_contractor_action`: When schedule is blocked by contractor onboarding or invoice generation failed due to withdrawal methods issues that needs contractor action. - `generation_failed_unrelated_to_withdrawal_method`: Generation failed for any other reason. - `completed`: Number of generated contractor invoices has been reached. - `inactive`: Does not create any further contractor invoices but it's still possible for the employer to activate it again.
      - `total_amount` integer, required — Overall amount that is calculated by summing all invoice items.
    - `current_page` integer — The current page among all of the total_pages
    - `total_count` integer — The total number of records in the result
    - `total_pages` integer — The total number of pages the user can go through

## Other responses

- `401` — Unauthorized
- `403` — Forbidden
- `404` — Not Found

---

[API](https://skmtc.net/remote-com/apis/remote.md) · [All operations](https://skmtc.net/remote-com/apis/remote/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/remote-com/remote/versions/7e6a0c61ac82/schema)