---
title: "Gets an Invoice by Id"
method: GET
path: "/financials/invoices/{invoice_id}"
tags: ["Invoice"]
---

# Gets an Invoice by Id

`GET /financials/invoices/{invoice_id}`

Return an Invoice based on Invoice Id.

## Path parameters

- `invoice_id` integer, required

## Headers

- `x-api-key` string, required

## Response `200`

Invoice with a header and all details

- InvoiceAPI — Invoice API output
  - `id` integer — Invoice Identifier
  - `invoice_number` string — Invoice Number
  - `is_auto_bill` boolean — If Auto Bill is set to true
  - `client_id` integer — Client Identifier for the client associated with the invoice
  - `lead_id` integer — Lead Identifier of the lead associated with the invoice
  - `dropin_id` integer — DropInIdentifier
  - `payment_due` string, date — Payment Due Date
  - `paid_on` string, date-time — Paid On Date Time
  - `paid_on_date` string, date — Paid On Date
  - `location_id` integer — Location Identifier
  - `location` string — Location
  - `reservation_id` integer — Class Reservation Identifier
  - `discount_amount` number — Discount Amount
  - `discount_percentage` number — Discount Percent
  - `payment_method_id` integer — Payment Method Identifier
  - `payment_method_expiration_date` string, date — Payment Method Expiration Date
  - `invoice_header_status_id` integer — Invoice Header Status Identifier
  - `invoice_header_status` string — Invoice Header Status
  - `gross_line_discounts` number — Gross Line Discounts
  - `net_line_discounts` number — Net Line Discounts
  - `gross_header_discounts` number — Gross Header Discounts
  - `gross_total_discounts` number — Gross Total Discounts
  - `net_total_discounts` number — Net Total Discounts
  - `gross_revenue_adjustment` number — Gross Revenue Adjustment
  - `refunded_revenue` number — Refunded Revenue
  - `gross_revenue` number — Gross Revenue
  - `post_header_gross_revenue` number — Post Header Gross Revenue
  - `net_revenue` number — Net Revenue
  - `post_header_net_revenue` number — Post Header Net Revenue
  - `gross_tax` number — Gross Tax
  - `refunded_tax` number — Refunded Tax
  - `final_refunded_amount` number — Final Refunded Amount
  - `final_tax` number — Final Tax
  - `final_charge` number — Final Charge
  - `refundable_final_charge` number — Refundable Final Charge
  - `paid_amount` number — Paid Amount
  - `unpaid_amount` number — Unpaid Amount
  - `notes` string — Notes
  - `invoice_footer` string — Invoice Footer
  - `created` Created — Record creation data.
    - `created_by_id` integer — Unique ID of the user that created the record.
    - `created_by` string — Name of the user that created the record.
    - `created_on_datetime` string, date-time — Datetime on which the record was created.
  - `updated` Updated — Update info
    - `updated_by_id` integer — Unique ID of the user that last updated the record.
    - `updated_by` string — Name of the user that most recently updated the record.
    - `updated_on_datetime` string, date-time — Datetime on which the record was last updated.
  - `last_status_change_by` integer — Last Status Change by (User Identifier)
  - `invoice_details` InvoiceDetailAPI[] — Invoice Details
    - `product_id` integer — Product Identifier
    - `product` string — Product Name
    - `product_variant_id` integer — Product Variant Identifier
    - `product_variant` string — Product Variant
    - `product_type_id` integer — Product Type Identifier
    - `product_type` string — Product Type
    - `revenue_category_id` integer — Revenue Category Id
    - `revenue_category` string — Revenue Category
    - `cost_per_unit` number — Cost Per Unit
    - `list_price` number — List Price
    - `sales_price` number — Sales Price
    - `quantity` integer — Quantity
    - `inventory_returns` integer — Inventory Returns
    - `price_adjustment` number — Price Adjustment
    - `net_inventory_issued` integer — Net Inventory Issued
    - `expected_revenue` number — Expected Revenue
    - `gross_line_discount` number — Gross Line Discount
    - `net_line_discount` number — Net Line Discount
    - `discount_amount` number — Discount Amount
    - `discount_percentage` number — Discount Percentage
    - `gross_header_discount` number — Gross Header Discout
    - `net_header_discount` number — Net Header Discount
    - `header_discount_amount` number — Header Discount Amount
    - `header_discount_percentage` number — Header Discount Percentage
    - `gross_total_discount` number — Gross Total Discount
    - `net_total_discount` number — Net Total Discount
    - `gross_revenue_adjustment` number — Gross Revenue Adjustment
    - `net_revenue_adjustment` number — Net Revenue Adjustment
    - `refunded_revenue` number — Refunded Revenue
    - `gross_revenue` number — Gross Revenue
    - `post_header_gross_revenue` number — Post Header Gross Revenue
    - `net_revenue` number — Net Revenue
    - `post_header_net_revenue` number — Post Header Net Revenue
    - `tax_rate_id` integer — Tax Rate Identifier
    - `tax_rate` number — Tax Rate
    - `gross_tax` number — Gross Tax
    - `refunded_tax` number — Refunded Tax
    - `final_refunded_amount` number — Final Refunded Amount
    - `final_tax` number — Final Tax
    - `final_charge` number — Final Charge
    - `refundable_final_charge` number — Refundable Final Charge
    - `history` string — History of the Invoice Detail
    - `created` Created — Record creation data.
      - `created_by_id` integer — Unique ID of the user that created the record.
      - `created_by` string — Name of the user that created the record.
      - `created_on_datetime` string, date-time — Datetime on which the record was created.
    - `Updated` Updated — Update info
      - `updated_by_id` integer — Unique ID of the user that last updated the record.
      - `updated_by` string — Name of the user that most recently updated the record.
      - `updated_on_datetime` string, date-time — Datetime on which the record was last updated.
    - `is_setup_fee` boolean — If the Invoice Details is for setup fee for a membership
    - `invoice_detail_display_type_id` integer — Invoice Detail Display Type Identifier
    - `invoice_detail_display_type` string — Invoice Detail Display Type
    - `fee` number — Fee
    - `refunded_fee` number — Refunded Fee
    - `fee_tax` number — Fee Tax
  - `wodify_validation_result` string — The purpose of this attribute is to save any UserException message, that is, and user friendly message that should be shown to the end user. All methods should have, just like service actions: - an UserException with Abort Transaction = Yes, and a Log Error = No - an AllExceptions with Abort Transaction = Yes, and a Log Error = Yes With this, any known issue that we don't consider an error log, like a business validation, we raise it to be catch in the UserException and we don't log it. Then, in the OnResponse of the full REST service, the Build_Response_JSON action will take care on the output json format. An Exception will have the default formatted error message. If its an AllException, it will log the error so that we can fix it. If its a UserException, it will deliver as an error but it won't log it as an error. A success output will not have this attribute, the Build_Response_JSON will remove it from the final output.

---

[API](https://skmtc.net/wodify/apis/leads.md) · [All operations](https://skmtc.net/wodify/apis/leads/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/wodify/leads/revisions/974500ca0714/schema)