Contractors
Invoice Schedules

List Contractor Invoice Schedules

Changed on

Lists Contractor Invoice Schedule records.

Authentication

This endpoint accepts any one of the following token types:

  • Company-scoped access token (OAuth2AuthorizationCode) — obtained through the Authorization Code flow or the Refresh Token flow. See Authentication for partners.
  • Customer API token (CustomerAPIToken) — generated by the customer on their Integration Settings page. See Authorization for customers.

Scopes

CategoryRead only ScopeWrite only Scope (read access implicit)
Manage invoices (invoices)-Manage invoices (invoices:write)
get/v1/contractor-invoice-schedules

Request

  • Base URL: https://gateway.remote.com
  • URL: https://gateway.remote.com/v1/contractor-invoice-schedules
  • Auth: HTTP bearer and OAuth 2 (authorization code, authorization URL /auth/oauth2/authorize, token URL /auth/oauth2/token, scopes: https://gateway.remote.com/company.manage, invoices:write, invoices, all:write)

Query parameters

start_date_fromstring date

UTC date in ISO 8601 format

Example:2021-07-01

Filters contractor invoice schedules by start date greater than or equal to the value.

start_date_tostring date

UTC date in ISO 8601 format

Example:2021-07-01

Filters contractor invoice schedules by start date less than or equal to the value.

next_invoice_date_fromstring date

UTC date in ISO 8601 format

Example:2021-07-01

Filters contractor invoice schedules by next invoice date greater than or equal to the value.

next_invoice_date_tostring date

UTC date in ISO 8601 format

Example:2021-07-01

Filters contractor invoice schedules by next invoice date less than or equal to the value.

status'inactive' | 'completed' | 'active' | 'processing' | 'pending_company_action' | 'pending_contractor_action' | 'generation_failed_unrelated_to_withdrawal_method'

Status to filter contractor invoice schedules by.

Skipped schedules (deleted) are always excluded from listings, so deleted is not a valid filter value here — see ContractorInvoiceScheduleStatus for the full set of states a schedule can report.

  • 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.
Example:active

Filters contractor invoice schedules by status matching the value.

employment_idstring uuid

A unique identifier in UUID v4 format.

Example:663e0b79-c893-45ff-a1b2-f6dcabc098b5

Filters contractor invoice schedules by employment id matching the value.

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.
Example:monthly

Filters contractor invoice schedules by periodicity matching the value.

currencystring

Filters contractor invoice schedules by currency matching the value.

sort_by'number' | 'total_amount' | 'next_invoice_at' | 'start_date' | 'nr_occurrences'

Field to sort by

order'asc' | 'desc'

Sort order

pageinteger

Starts fetching records after the given page

page_sizeinteger

Number of items per page

Response

Success

Example response

{
  "contractor_invoice_schedules": [
    {
      "currency": "BRL",
      "custom_days": [
        1,
        15
      ],
      "employment_id": "3a4b5c6d-7e8f-9a0b-1c2d-3e4f5a6b7c8d",
      "id": "663e0b79-c893-45ff-a1b2-f6dcabc098b5",
      "items": [
        {
          "amount": 5000,
          "description": "Description"
        }
      ],
      "next_invoice_at": "2024-06-15T00:00:00Z",
      "note": "Mobile developer payment.",
      "nr_occurrences": 10,
      "number": "ABC123",
      "periodicity": "semi_monthly",
      "start_date": "2024-06-01",
      "status": "active",
      "total_amount": 500000
    }
  ],
  "current_page": 1,
  "total_count": 1,
  "total_pages": 1
}

Changes

  • 072424a83e5fRevision changes
    • info

      added the optional property /// to the response with the status

  • b20509567450Revision changes
    • warning

      added the new deleted enum value to the /// response property for the response status