> ## Documentation Index > Fetch the complete documentation index at: https://docs.cadanapay.com/llms.txt > Use this file to discover all available pages before exploring further. # Get Invoice > Get invoice details ## OpenAPI ````yaml /openapi/workforce-management.yaml get /v1/invoices/{invoiceId} openapi: 3.0.0 info: description: APIs for interacting with Cadana Payroll Platform version: 1.0.0 title: Business Workforce Management termsOfService: https://cadanapay.com/terms-and-conditions contact: email: api@cadanapay.com license: name: Apache 2.0 url: http://www.apache.org/licenses/LICENSE-2.0.html servers: - url: https://api.cadanapay.com description: Prod Server - url: https://dev-api.cadanapay.com description: Dev Server security: - Authorization: [] tags: - name: Custom Auth description: APIs for interacting with Custom Authentication - name: Persons description: APIs for interacting with the HR module - name: Milestones description: APIs for milestone-based contractor pay - name: Instant Pay description: APIs for interacting with Instant Pay functionality - name: Users description: APIs for interacting with employee/contractor Cadana accounts - name: Files description: APIs for interacting with file uploads - name: Payrolls description: APIs for interacting with Payroll - name: Platform description: Platform APIs for interacting with businesses - name: Businesses description: APIs for interacting with Business - name: Contracts description: APIs for interacting with contracts - name: Sandbox description: APIs for relevant sandbox simulations - name: Invoices description: APIs for interacting with invoices - name: Reimbursements description: APIs for interacting with reimbursements - name: Entities description: >- APIs for managing legal sub-entities (subsidiaries, branches) under a parent business paths: /v1/invoices/{invoiceId}: get: tags: - Invoices summary: Get Invoice description: Get invoice details operationId: getInvoice parameters: - $ref: '#/components/parameters/invoiceId' - $ref: '#/components/parameters/XMultiTenantKey' responses: '200': $ref: '#/components/responses/GetInvoiceResponse' '404': $ref: '#/components/responses/NotFoundError' 5XX: $ref: '#/components/responses/InternalError' security: - Authorization: [] components: parameters: invoiceId: name: invoiceId in: path description: The unique identifier for the invoice required: true schema: type: string format: uuid XMultiTenantKey: name: X-MultiTenantKey in: header required: false schema: type: string description: >- Required when using a Platform API token. The tenant key identifying which business to operate on. responses: GetInvoiceResponse: description: get invoice response content: application/json: schema: $ref: '#/components/schemas/invoice' examples: invoiceResponse: $ref: '#/components/examples/invoiceResponse' NotFoundError: description: Requested resource was not found content: application/json: schema: $ref: '#/components/schemas/NotFoundError' InternalError: description: Internal error content: application/json: schema: $ref: '#/components/schemas/InternalError' schemas: invoice: type: object description: An invoice document properties: id: $ref: '#/components/schemas/uuid' status: type: string enum: - pending - approved - rejected - partially paid - paid - overdue - cancelled example: paid source: type: string enum: - SYSTEM - USER - REIMBURSEMENT - PAYROLL - CONTRACTOR_SUBMITTED description: >- Origin of the invoice. Only invoices with source CONTRACTOR_SUBMITTED are reviewable via the review endpoint. example: CONTRACTOR_SUBMITTED invoiceNumber: type: string example: '1764332528' description: Human-readable invoice number date: type: string format: date example: '2025-11-28' description: Invoice date dueDate: type: string format: date example: '2025-11-26' description: Payment due date from: $ref: '#/components/schemas/invoiceParty' description: Invoice issuer billTo: $ref: '#/components/schemas/invoiceParty' description: Invoice recipient items: type: array items: $ref: '#/components/schemas/invoiceLineItem' subtotal: $ref: '#/components/schemas/amount' description: Subtotal before any adjustments total: $ref: '#/components/schemas/amount' description: Total amount due baseCurrency: type: string example: USD description: Base currency for the invoice fxRates: type: object description: Exchange rates used in this invoice additionalProperties: type: number format: float example: USD-EUR: 0.863673 USD-PHP: 58.208258 purpose: type: string example: Payment Processing Fee description: Purpose of the invoice notes: type: string example: Payment for services rendered description: Additional notes createdTimestamp: type: integer format: int64 example: 1764332530 description: Unix timestamp when invoice was created lastUpdatedTimestamp: type: integer format: int64 example: 1764339673 description: Unix timestamp when invoice was last updated NotFoundError: description: Not Found allOf: - $ref: '#/components/schemas/Error' example: code: resource_not_found message: Requested resource could not be found. InternalError: description: Internal server error allOf: - $ref: '#/components/schemas/Error' example: code: internal_error message: An unexpected error occurred. Please try again later. uuid: type: string format: uuid example: 8ef9a712-cdae-4110-b1ea-9ba95abbee6e invoiceParty: type: object description: Details of a party on an invoice (issuer or recipient) properties: name: type: string example: Example Company LLC address: type: string example: 123 Main Street, Suite 100, New York City, NY 10001 email: type: string format: email example: billing@example.com phoneNumber: $ref: '#/components/schemas/phoneNumber' invoiceLineItem: type: object description: A line item on an invoice properties: personId: $ref: '#/components/schemas/uuid' description: Person ID (for payroll items) description: type: string example: John Doe category: type: string description: >- Line-item category. Direct-employment payrolls produce `NET_PAYROLL` plus fee items; EOR payrolls produce `GROSS_PAYROLL` and `EMPLOYER_CONTRIBUTION`. enum: - NET_PAYROLL - GROSS_PAYROLL - EMPLOYER_CONTRIBUTION - PAYMENT_PROCESSING_FEE - CONTRACTOR_FEE - EMPLOYEE_FEE example: NET_PAYROLL amount: $ref: '#/components/schemas/amount' description: Unit amount in base currency originalAmount: $ref: '#/components/schemas/amount' description: Amount in original currency (if different from base) fxRate: type: number format: float description: Exchange rate applied (if currency conversion occurred) example: 58.21 quantity: type: integer example: 1 total: $ref: '#/components/schemas/amount' description: Total amount in base currency amount: type: object required: - amount - currency properties: amount: type: integer description: value in lowest denomination example: 10000 currency: type: string description: currency example: USD Error: type: object properties: code: description: A machine parsable error code type: string enum: - invalid_request_body - resource_not_found - forbidden - internal_error message: description: A human readable message describing the error type: string phoneNumber: type: object description: Person's phone number properties: countryCode: type: string example: '1' number: type: string example: '2345678901' examples: invoiceResponse: summary: Invoice Response Example value: id: 3fa85f64-5717-4562-b3fc-2c963f66afa6 status: paid invoiceNumber: INV-2024-001 date: '2024-03-15' dueDate: '2024-03-30' from: name: Acme Corp address: 123 Business St, Suite 100, San Francisco, CA 94105 email: billing@example.com phoneNumber: countryCode: '1' number: '4155551234' billTo: name: Example Corp address: 456 Innovation Ave, Austin, TX 78701 email: accounts@example.com phoneNumber: countryCode: '1' number: '5125555678' items: - personId: 7c9e6679-7425-40de-944b-e07fc1f90ae7 description: John Doe - Consulting Services category: NET_PAYROLL amount: amount: 350000 currency: USD quantity: 1 total: amount: 350000 currency: USD - personId: 8d7f5678-8536-41ef-a55c-f18ad2c01bf8 description: Jane Smith - Development Work category: NET_PAYROLL originalAmount: amount: 150000 currency: EUR amount: amount: 162500 currency: USD fxRate: 1.0833 quantity: 1 total: amount: 162500 currency: USD - description: International Transfer Fees category: PAYMENT_PROCESSING_FEE amount: amount: 2500 currency: USD quantity: 1 total: amount: 2500 currency: USD - description: Service Fee category: CONTRACTOR_FEE amount: amount: 5000 currency: USD quantity: 2 total: amount: 10000 currency: USD subtotal: amount: 525000 currency: USD total: amount: 525000 currency: USD baseCurrency: USD fxRates: USD-EUR: 0.92 EUR-USD: 1.0833 purpose: Professional Services notes: Payment for services rendered in March 2024 createdTimestamp: 1710504000 lastUpdatedTimestamp: 1710590400 securitySchemes: Authorization: type: http scheme: bearer bearerFormat: API_SECRET_KEY ````