Invoices

Show Contractor Invoice

Shows a single Contractor Invoice record.

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:read and all:write work too.

Token type	Category	Read only Scope	Write only Scope (read access implicit)
Company-scoped access token	Manage invoices (invoices)	View invoices (invoices:read)	Manage invoices (invoices:write)
Company-scoped access token (assertion)	Manage invoices (invoices)	View invoices (invoices:read)	Manage invoices (invoices:write)
Customer API token	Manage invoices (invoices)	View invoices (invoices:read)	Manage invoices (invoices:write)

get/v1/contractor-invoices/{id}

Request

Base URL
https://gateway.remote.com
URL
https://gateway.remote.com/v1/contractor-invoices/{id}
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:read
- or OAuth 2
  Authorization code: /auth/oauth2/authorize
  Token URL: /auth/oauth2/token scopes: all:read
- 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:read
- or OAuth 2
  Client credentials
  Token URL: /auth/oauth2/token scopes: all:read
- or OAuth 2
  Client credentials
  Token URL: /auth/oauth2/token scopes: all:write
- or HTTP bearer

Path parameters

idstring uuid required

A unique identifier in UUID v4 format.

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",
      "payment": {
        "amount_due": 350000,
        "billing_document_id": null,
        "currency": "USD",
        "due_date": "2024-06-15",
        "pay_in_method": "bank_transfer",
        "reference": "TR0000000042",
        "status": "awaiting_payment"
      },
      "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"
    }
  }
}

Changes

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