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.

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)

post/v1/contractor-invoice-schedules

Request

Base URL
https://gateway.remote.com
URL
https://gateway.remote.com/v1/contractor-invoice-schedules
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

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": [
      {
        "currency": "USD",
        "employment_id": "663e0b79-c893-45ff-a1b2-f6dcabc098b5",
        "errors": {
          "employment_id": [
            "not found"
          ]
        },
        "items": [
          {
            "amount": 5000,
            "description": "Description"
          }
        ],
        "note": "Contractor payment schedules.",
        "nr_occurrences": 15,
        "number": "XYZ0001",
        "periodicity": "bi_weekly",
        "start_date": "2024-06-01"
      }
    ],
    "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"
      }
    ]
  }
}

Changes

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