> ## Documentation Index > Fetch the complete documentation index at: https://docs.zivio.com/llms.txt > Use this file to discover all available pages before exploring further. # Get a Invoice ## OpenAPI ````yaml /api-reference/v4/openapi.json get /invoices/{id} openapi: 3.1.0 info: title: API V4 version: '4' description: >- OAuth 2.0 secured API. Obtain an access token using client credentials to access protected endpoints. The regional endpoints listed below serve every Zivio organisation, so each request — including the token request — must carry a `zivio-tenant-id` header identifying yours. Requests without it are rejected with a 404 before any token is checked. contact: name: API Support email: support@zivio.com servers: - url: https://api.zivio.net/api/v4 description: Global API Router - url: https://api.eu.zivio.net/api/v4 description: EU Data Region - url: https://api.uk.zivio.net/api/v4 description: UK Data Region - url: https://api.us.zivio.net/api/v4 description: US Data Region security: - oauth2: [] tenantId: [] paths: /invoices/{id}: get: tags: - Invoices summary: Get a Invoice operationId: getInvoicesById parameters: - name: id in: path required: true schema: type: integer description: Invoice ID example: 123 responses: '200': description: Invoice details content: application/json: schema: $ref: '#/components/schemas/Invoice' example: id: 101 external_id: EXT-1001 external_provider: Example external_provider description: Complete redesign of corporate website with modern UX status: unpaid project_summary: >- Website Redesign Project - Complete redesign of corporate website with modern UX vatable: true reference_number: INV-20240001 self_bill: false subtype: standard type: credit_note client: null client_org: null supplier: id: 101 name: Acme Corporation email: user1@example.com vetting_status: PASSED tax_number: Example tax_number tax_registered: true milestone_id: 501 line_item_sheet_id: 501 sent_at: '2024-01-16T10:30:00+00:00' dated_on: '2024-01-16' due_on: '2024-01-16' client_due_on: '2024-01-16' payment_terms_in_days: 30 client_payment_terms_in_days: 30 paid_at: '2024-01-16T10:30:00+00:00' is_credit_note: false credit_note_id: 501 credit_note_reason: null manual_client_tax_type: id: 101 label: Example label country_code: Example country_code rate: '1500.00' domestic_recharge: true tax_reference: 101 archived: true custom_fields: department: Engineering priority: high cost_code: CC-001 created_at: '2024-01-16T10:30:00+00:00' updated_at: '2024-01-16T10:30:00+00:00' net_total: cents: 150000 currency: GBP tax_total: cents: 150000 currency: GBP total: cents: 150000 currency: GBP cis_amount_due: cents: 150000 currency: GBP cis_deductible: cents: 150000 currency: GBP cis_deduction_total: cents: 150000 currency: GBP cis_rate: id: 101 label: Example label country_code: Example country_code rate: '1500.00' domestic_recharge: true tax_reference: 101 archived: true custom_fields: department: Engineering priority: high cost_code: CC-001 created_at: '2024-01-16T10:30:00+00:00' updated_at: '2024-01-16T10:30:00+00:00' cis_contractor: null cis_subcontractor: null invoice_items: - id: 101 external_id: EXT-1001 external_provider: Example external_provider invoice_id: 501 description: Complete redesign of corporate website with modern UX billing_start: '2024-01-16' billing_end: '2024-01-16' unit_type: Example unit_type milestone_id: 501 line_item_sheet_id: 501 unit_cost: cents: 150000 currency: GBP quantity: '1500.00' discount: 1500 net_total_price: null tax_total: cents: 150000 currency: GBP tax_rate: '1500.00' total_price: null cis_type: id: 101 label: Example label country_code: Example country_code rate: '1500.00' domestic_recharge: true tax_reference: 101 archived: true custom_fields: department: Engineering priority: high cost_code: CC-001 created_at: '2024-01-16T10:30:00+00:00' updated_at: '2024-01-16T10:30:00+00:00' tax_type: id: 101 label: Example label country_code: Example country_code rate: '1500.00' domestic_recharge: true tax_reference: 101 archived: true custom_fields: department: Engineering priority: high cost_code: CC-001 created_at: '2024-01-16T10:30:00+00:00' updated_at: '2024-01-16T10:30:00+00:00' manual_client_tax_type: null invoice_item_taxes: - id: 101 invoice_item_id: 501 tax_type: null tax_rate: '1500.00' tax_amount: cents: 150000 currency: GBP sales_tax_amount: cents: 150000 currency: GBP ccy: GBP position: 101 created_at: '2024-01-16T10:30:00+00:00' updated_at: '2024-01-16T10:30:00+00:00' - id: 102 invoice_item_id: 502 tax_type: null tax_rate: '1500.00' tax_amount: cents: 300000 currency: GBP sales_tax_amount: cents: 300000 currency: GBP ccy: GBP position: 102 created_at: '2024-01-17T10:30:00+00:00' updated_at: '2024-01-17T10:30:00+00:00' created_at: '2024-01-16T10:30:00+00:00' updated_at: '2024-01-16T10:30:00+00:00' manual_tax_type: id: 101 label: Example label country_code: Example country_code rate: '1500.00' domestic_recharge: true tax_reference: 101 archived: true custom_fields: department: Engineering priority: high cost_code: CC-001 created_at: '2024-01-16T10:30:00+00:00' updated_at: '2024-01-16T10:30:00+00:00' - id: 102 external_id: EXT-1002 external_provider: Example external_provider invoice_id: 502 description: Native iOS and Android application billing_start: '2024-01-17' billing_end: '2024-01-17' unit_type: Example unit_type milestone_id: 502 line_item_sheet_id: 502 unit_cost: cents: 300000 currency: GBP quantity: '1500.00' discount: 1500 net_total_price: null tax_total: cents: 300000 currency: GBP tax_rate: '1500.00' total_price: null cis_type: id: 102 label: Example label country_code: Example country_code rate: '1500.00' domestic_recharge: true tax_reference: 102 archived: true custom_fields: department: Engineering priority: high cost_code: CC-001 created_at: '2024-01-17T10:30:00+00:00' updated_at: '2024-01-17T10:30:00+00:00' tax_type: id: 102 label: Example label country_code: Example country_code rate: '1500.00' domestic_recharge: true tax_reference: 102 archived: true custom_fields: department: Engineering priority: high cost_code: CC-001 created_at: '2024-01-17T10:30:00+00:00' updated_at: '2024-01-17T10:30:00+00:00' manual_client_tax_type: null invoice_item_taxes: - id: 102 invoice_item_id: 502 tax_type: null tax_rate: '1500.00' tax_amount: cents: 300000 currency: GBP sales_tax_amount: cents: 300000 currency: GBP ccy: GBP position: 102 created_at: '2024-01-17T10:30:00+00:00' updated_at: '2024-01-17T10:30:00+00:00' - id: 103 invoice_item_id: 503 tax_type: null tax_rate: '1500.00' tax_amount: cents: 450000 currency: GBP sales_tax_amount: cents: 450000 currency: GBP ccy: GBP position: 103 created_at: '2024-01-18T10:30:00+00:00' updated_at: '2024-01-18T10:30:00+00:00' created_at: '2024-01-17T10:30:00+00:00' updated_at: '2024-01-17T10:30:00+00:00' manual_tax_type: id: 102 label: Example label country_code: Example country_code rate: '1500.00' domestic_recharge: true tax_reference: 102 archived: true custom_fields: department: Engineering priority: high cost_code: CC-001 created_at: '2024-01-17T10:30:00+00:00' updated_at: '2024-01-17T10:30:00+00:00' approved_at: '2024-01-16T10:30:00+00:00' approved_by: id: 101 first_name: Demo last_name: User email: user1@example.com org_id: 501 org_name: Acme Corporation level_1_approved_at: '2024-01-16T10:30:00+00:00' level_1_approved_by: id: 101 first_name: Demo last_name: User email: user1@example.com org_id: 501 org_name: Acme Corporation rejected_at: '2024-01-16T10:30:00+00:00' rejected_by: id: 101 first_name: Demo last_name: User email: user1@example.com org_id: 501 org_name: Acme Corporation rejected_reason: null custom_fields: department: Engineering priority: high cost_code: CC-001 created_at: '2024-01-16T10:30:00+00:00' updated_at: '2024-01-16T10:30:00+00:00' project: id: 101 title: Website Redesign Project description: Complete redesign of corporate website with modern UX '401': description: >- Unauthorized - the access token is missing, expired, revoked or malformed content: application/json: schema: $ref: '#/components/schemas/Error' example: error: invalid_token error_description: >- The access token provided is expired, revoked, malformed, or invalid for other reasons '403': description: Forbidden - insufficient scope or access denied content: application/json: schema: $ref: '#/components/schemas/Error' examples: insufficient_scope: summary: Token lacks required scope value: error: insufficient_scope error_description: >- The request requires higher privileges than provided by the access token required_scope: invoices:read provided_scopes: - welcome:read access_denied: summary: User cannot access this resource value: message: You do not have permission to access this resource '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/Error' example: message: Record not found security: - oauth2: - invoices:read tenantId: [] components: schemas: Invoice: type: object properties: id: type: integer external_id: type: string external_provider: type: string description: type: string status: type: string enum: - draft - unpaid - paid - level_1_approved - approved - rejected example: draft project_summary: type: string vatable: type: boolean example: true reference_number: type: string self_bill: type: boolean example: true subtype: type: string type: type: string enum: - invoice - credit_note - all example: invoice client: type: string client_org: type: string supplier: oneOf: - $ref: '#/components/schemas/EmbeddedSupplier' - type: 'null' milestone_id: type: integer line_item_sheet_id: type: integer sent_at: type: string dated_on: type: string due_on: type: string client_due_on: type: string payment_terms_in_days: type: integer client_payment_terms_in_days: type: integer paid_at: type: string is_credit_note: type: boolean example: true credit_note_id: type: integer credit_note_reason: type: string manual_client_tax_type: oneOf: - $ref: '#/components/schemas/TaxType' - type: 'null' net_total: $ref: '#/components/schemas/Money' tax_total: $ref: '#/components/schemas/Money' total: $ref: '#/components/schemas/Money' cis_amount_due: $ref: '#/components/schemas/Money' cis_deductible: $ref: '#/components/schemas/Money' cis_deduction_total: $ref: '#/components/schemas/Money' cis_rate: oneOf: - $ref: '#/components/schemas/TaxType' - type: 'null' cis_contractor: type: boolean example: true cis_subcontractor: type: boolean example: true invoice_items: type: array items: $ref: '#/components/schemas/InvoiceItem' approved_at: type: string approved_by: oneOf: - $ref: '#/components/schemas/EmbeddedUser' - type: 'null' level_1_approved_at: type: string level_1_approved_by: oneOf: - $ref: '#/components/schemas/EmbeddedUser' - type: 'null' rejected_at: type: string rejected_by: oneOf: - $ref: '#/components/schemas/EmbeddedUser' - type: 'null' rejected_reason: type: string custom_fields: type: object additionalProperties: type: string description: Key-value pairs of custom field data created_at: type: string updated_at: type: string project: oneOf: - $ref: '#/components/schemas/EmbeddedProject' - type: 'null' Error: type: object description: Error envelope returned by every non-2xx V4 response properties: error: type: string example: insufficient_scope error_description: type: string message: type: string details: type: object additionalProperties: true required_scope: type: string example: projects:read provided_scopes: type: array items: type: string EmbeddedSupplier: type: object properties: id: type: integer name: type: string email: type: string vetting_status: type: string enum: - NOT REGISTERED - PASSED - FAILED - PENDING example: NOT REGISTERED tax_number: type: string tax_registered: type: boolean example: true TaxType: type: object properties: id: type: integer label: type: string country_code: type: string rate: type: string domestic_recharge: type: boolean example: true tax_reference: type: integer archived: type: boolean example: true custom_fields: type: object additionalProperties: type: string description: Key-value pairs of custom field data created_at: type: string updated_at: type: string Money: type: object properties: cents: type: integer example: 150000 currency: type: string example: GBP InvoiceItem: type: object properties: id: type: integer external_id: type: integer external_provider: type: string invoice_id: type: integer description: type: string billing_start: type: string billing_end: type: string unit_type: type: string milestone_id: type: integer line_item_sheet_id: type: integer unit_cost: $ref: '#/components/schemas/Money' quantity: type: string discount: type: string net_total_price: type: string tax_total: $ref: '#/components/schemas/Money' tax_rate: type: string total_price: type: string cis_type: oneOf: - $ref: '#/components/schemas/TaxType' - type: 'null' tax_type: oneOf: - $ref: '#/components/schemas/TaxType' - type: 'null' manual_client_tax_type: type: string invoice_item_taxes: type: array items: $ref: '#/components/schemas/InvoiceItemTax' created_at: type: string updated_at: type: string manual_tax_type: oneOf: - $ref: '#/components/schemas/TaxType' - type: 'null' EmbeddedUser: type: object properties: id: type: integer first_name: type: string last_name: type: string email: type: string org_id: type: integer org_name: type: string EmbeddedProject: type: object properties: id: type: integer title: type: string description: type: string InvoiceItemTax: type: object properties: id: type: integer invoice_item_id: type: integer tax_type: type: string tax_rate: type: string tax_amount: $ref: '#/components/schemas/Money' sales_tax_amount: $ref: '#/components/schemas/Money' ccy: type: string position: type: integer created_at: type: string updated_at: type: string securitySchemes: oauth2: type: oauth2 description: >- OAuth 2.0 client credentials. The access token from POST /oauth/token is sent as a bearer token. Request only the scopes you need. flows: clientCredentials: tokenUrl: https://api.zivio.net/api/v4/oauth/token scopes: bank_accounts:read: Read bank account details on suppliers and the org. catalogs:read: Read catalog items. cost_centers:read: Read cost center records. eoi_responses:read: Read responses to expressions of interest. eois:read: Read expressions of interest. offers:read: Read offers for projects. org_units:read: Read your organization unit hierarchy. org_users:read: Read members of your organization. resources:read: Read resource (worker) records. sales_invoices:read: Read invoices issued to clients. sales_milestones:read: Read milestones on sales engagements. skill_categories:read: Read the skill category taxonomy. skill_taxonomies:read: Read skill taxonomy structure. skills:read: Read individual skills. supplier_documents:read: Read documents uploaded by suppliers. supplier_lists:read: Read curated lists of suppliers. supplier_users:read: Read users belonging to supplier organizations. tax_types:read: Read configured tax types. users:read: Read user profiles. variation_orders:read: Read variation orders on projects. welcome:read: 'Required: confirms your identity to the application.' bid_evaluations:read: >- Read evaluation scorecards for bids, including criterion scores and quality, cost and total scores. bid_evaluations:write: >- Score bids against a project's quality criteria and override calculated cost scores. bids:read: Read bids submitted on projects. bids:write: >- Shortlist, select, eliminate and reinstate bids submitted on projects. invoices:read: Read invoices on projects. invoices:write: Create and update invoices. notes:read: Read notes on projects and EOIs. notes:write: Create and update notes on projects and EOIs. project_approvals:read: Read project approval workflows. project_approvals:write: Create and update project approval workflows. project_conversations:read: Read messages exchanged with suppliers on a project. project_conversations:write: Send messages to suppliers on a project. project_invitations:read: Read supplier invitations on projects. project_invitations:write: Invite suppliers to bid on projects. project_questions:read: Read supplier clarification questions on projects. project_questions:write: Answer and approve supplier clarification questions. projects:read: Read projects. projects:write: Create and update projects. milestones:read: Read milestones on projects. milestones:write: Create and update milestones. orgs:read: Read organization records. orgs:write: Create and update organization records. purchase_orders:read: Read purchase orders. purchase_orders:write: Create and update purchase orders. reviews:read: Read reviews left on suppliers. reviews:write: Create and update reviews. suppliers:read: Read supplier profiles. suppliers:write: Create and update supplier profiles. raw_scorecard_entries:write: Create and update raw scorecard entries. raw_scorecard_entries:read: Read raw scorecard entries. tasks:read: >- Read the acting user's task queue, including outstanding approvals and items to review. tasks:write: Complete and dismiss tasks in the acting user's task queue. act_as_user: >- Make requests as another user within the token holder's delegation boundary. tenantId: type: apiKey name: zivio-tenant-id in: header description: >- Your Zivio organisation identifier. The regional API endpoints serve every Zivio organisation, so each request must identify yours. ````