Updates Contractor Invoice Schedule

put

https://gateway.remote.com/v1/contractor-invoice-schedules/{id}

Updates a contractor invoice schedule record

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

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

uuid

required

Resource unique identifier

Body Params

Update parameters

Payload shape used to update invoice schedules.

currency

string | null

Currency code of the SWIFT fee. Only present when processing_fee is set.

custom_days

array of integers | null

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.

ContractorInvoiceScheduleCustomDays

items

array of objects

List of invoice items that composes the overall invoice amount.

items

note

string | null

Custom defined note.

nr_occurrences

integer | null

Count of remaining invoices that should be generated.

number

string | null

Invoice identifier.

periodicity

string

enum

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.

Allowed:

start_date

date

UTC date in ISO 8601 format

status

string

enum

Allowed:

Responses

Callback

Language

Credentials

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success

401Unauthorized

403Forbidden

404Not Found

422Unprocessable Entity