Invoice Schedules

Updates Contractor Invoice Schedule

Updates a contractor invoice schedule record

Authentication

This endpoint accepts any one of the following token types:

Company-scoped access token (OAuth2AuthorizationCode) — obtained by a company manager through the Authorization Code flow or the Refresh Token flow. See Authentication for partners.
Company-scoped access token (assertion) (OAuth2CompanyManagerAssertion) — obtained through the urn:ietf:params:oauth:grant-type:jwt-bearer grant for a company manager. See OAuth Assertion.
Customer API token (CustomerAPIToken) — generated by the customer on their Integration Settings page, with the scopes they choose there. See Authorization for customers.

Scopes

Any one of the scopes in a token type's row is enough. all:write works too.

Token type	Category	Read only Scope	Write only Scope (read access implicit)
Company-scoped access token	Manage invoices (invoices)	-	Manage invoices (invoices:write)
Company-scoped access token (assertion)	Manage invoices (invoices)	-	Manage invoices (invoices:write)
Customer API token	Manage invoices (invoices)	-	Manage invoices (invoices:write)

patch/v1/contractor-invoice-schedules/{id}

Request

Base URL
https://gateway.remote.com
URL
https://gateway.remote.com/v1/contractor-invoice-schedules/{id}
Auth
- OAuth 2
  Authorization code: /auth/oauth2/authorize
  Token URL: /auth/oauth2/token scopes: https://gateway.remote.com/company.manage
- or OAuth 2
  Authorization code: /auth/oauth2/authorize
  Token URL: /auth/oauth2/token scopes: invoices:write
- or OAuth 2
  Authorization code: /auth/oauth2/authorize
  Token URL: /auth/oauth2/token scopes: all:write
- or OAuth 2
  Client credentials
  Token URL: /auth/oauth2/token scopes: invoices:write
- or OAuth 2
  Client credentials
  Token URL: /auth/oauth2/token scopes: all:write
- or HTTP bearer

Path parameters

idstring uuid required

A unique identifier in UUID v4 format.

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

Resource unique identifier

Request body

currencystring nullable

Currency code in ISO 4217 format.

custom_daysinteger[] nullable

The two calendar days of the month on which invoices are generated. Only applies when periodicity is semi_monthly; must be omitted (or null) for every other periodicity.

When omitted for a semi_monthly schedule, the two days are derived from start_date: the start day and the day 14 days apart from it. Supply this field only to pick a cycle other than that default.

One of the two days must be the day of start_date, the days must be distinct, and they cannot resolve to the same day within a month.

notestring nullable

Custom defined note.

nr_occurrencesinteger nullable

Count of remaining invoices that should be generated.

numberstring nullable

Invoice identifier.

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.

start_datestring date

UTC date in ISO 8601 format

status'inactive' | 'deleted' | 'active' | 'processing'

Example request

{
  "currency": "USD",
  "items": [
    {
      "amount": 5000,
      "description": "Description"
    }
  ],
  "note": "Contractor invoice note",
  "nr_occurrences": 8,
  "number": "Num321",
  "periodicity": "monthly",
  "start_date": "2021-07-01",
  "status": "inactive"
}

Response

Success

Example response

{
  "data": {
    "contractor_invoice_schedule": {
      "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
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.