Sign in

v1

latestOpenAPI 3.1.02026-07-242735131.1 MB
Invoices

Show Contractor Invoice

Shows a single Contractor Invoice record.

Scopes

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

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": {
      "amount": 350000,
      "approved_at": "2024-06-05T00:00:00Z",
      "contractor_invoice_schedule_id": "9f8e7d6c-5b4a-3c2d-1e0f-a1b2c3d4e5f6",
      "currency": "BRL",
      "date": "2024-06-01",
      "description": "Mobile developer payment.",
      "due_date": "2024-06-15",
      "fx_rate": 1.12,
      "id": "663e0b79-c893-45ff-a1b2-f6dcabc098b5",
      "items": [
        {
          "amount": 5000,
          "description": "Description",
          "type": "manual"
        }
      ],
      "number": "ABC123",
      "paid_out_at": "2024-06-05T12:00:00Z",
      "pay_out_method": "swift_our",
      "processing_fee": 500,
      "processing_fee_currency": "USD",
      "processing_fee_payer": "company",
      "source_amount": 350000,
      "source_currency": "BRL",
      "status": "paid_out",
      "target_amount": 350000,
      "target_currency": "BRL"
    }
  }
}