Sign in

v1

latestOpenAPI 3.1.02026-07-242735131.1 MB
Invoice Schedules

Updates Contractor Invoice Schedule

Updates a contractor invoice schedule record

Scopes

CategoryRead only ScopeWrite only Scope (read access implicit)
Manage invoices (invoices)-Manage invoices (invoices:write)
put/v1/contractor-invoice-schedules/{id}

Path parameters

idstring uuid required

Identifier of the employment being terminated.

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

Resource unique identifier

Request body

currencystring nullable

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

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

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"
}

Response

Success

Example response

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