Sign in

v1

latestOpenAPI 3.1.02026-07-242735131.1 MB
Invoice Schedules

Create Contractor Invoice Schedules

Creates many invoice schedules records. It's supposed to return two lists: one containing created records, and another one containing the schedules that failed to be inserted.

Scopes

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

Request body

Example request

{
  "contractor_invoice_schedules": [
    {
      "currency": "BRL",
      "employment_id": "663e0b79-c893-45ff-a1b2-f6dcabc098b5",
      "items": [
        {
          "amount": 5000,
          "description": "Description"
        }
      ],
      "note": "A note to make it clear why schedule is needed.",
      "nr_occurrences": 10,
      "number": "CIS0001",
      "periodicity": "monthly",
      "start_date": "2024-06-01"
    },
    {
      "currency": "USD",
      "employment_id": "663e0b79-c893-45ff-a1b2-f6dcabc098b5",
      "items": [
        {
          "amount": 5000,
          "description": "Description"
        }
      ],
      "note": "Contractor payment schedules.",
      "nr_occurrences": 15,
      "number": "XYZ0001",
      "periodicity": "bi_weekly",
      "start_date": "2024-06-01"
    }
  ]
}

Response

All entries have been created

Example response

{
  "data": {
    "failures": [],
    "successes": [
      {
        "currency": "BRL",
        "employment_id": "663e0b79-c893-45ff-a1b2-f6dcabc098b5",
        "id": "663e0b79-c893-45ff-a1b2-f6dcabc098b5",
        "items": [
          {
            "amount": 5000,
            "description": "Description"
          }
        ],
        "note": "A note to make it clear why schedule is needed.",
        "nr_occurrences": 10,
        "number": "CIS0001",
        "periodicity": "monthly",
        "start_date": "2024-06-01"
      }
    ]
  }
}