Invoice Schedules
Show Contractor Invoice Schedule
Shows a single Contractor Invoice Schedule record
Scopes
| Category | Read only Scope | Write only Scope (read access implicit) |
|---|---|---|
| Manage invoices (invoices) | View invoices (invoices:read) | Manage invoices (invoices:write) |
get/v1/contractor-invoice-schedules/{id}
Request
- Base URL: https://gateway.remote.com
- URL: https://gateway.remote.com/v1/contractor-invoice-schedules/{id}
- Auth: HTTP bearer and OAuth 2 (authorization code, authorization URL /auth/oauth2/authorize, token URL /auth/oauth2/token, scopes: https://gateway.remote.com/company.manage, invoices:read, invoices:write, invoices, all:write, all:read)
Path parameters
idstring uuid required
Identifier of the employment being terminated.
Example:663e0b79-c893-45ff-a1b2-f6dcabc098b5
Resource unique identifier
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
}
}
}Changes
No recorded changes to this operation across all 1 revision of this API.