--- title: "Retrieve an invoice" method: GET path: "/invoices/{invoiceId}" tags: ["Invoices"] --- # Retrieve an invoice `GET /invoices/{invoiceId}` Retrieves the full details of an invoice using its unique `invoiceId`. This endpoint returns all invoice metadata, contacts, items, organization info, and calculated financial totals including tax, discount, and shipping. ## Path parameters - `invoiceId` string, required ## Response `200` OK - InvoiceGetResponse — Full response returned when retrieving an existing invoice by ID. - `id` string — Unique identifier for the invoice. - `acquisitionTransactionId` string — Identifier of the acquisition transaction. - `acquisitionReturnTransactionId` string — ID of the return transaction, if applicable. - `bankPaymentInstruction` string — Bank instructions for manual payment (if any). - `companyName` string — Company that owns the invoice. - `createdOn` string, date-time — ISO 8601 timestamp of when the invoice was created. - `currency` string — ISO 4217 currency code. - `customerReference` string — Optional reference code from the customer. - `dueDate` string, date-time — Due date for the invoice. - `eguiNumber` string — EGUI number for tax compliance (if applicable). - `items` InvoiceItemResponse[] — List of items in the invoice. - `id` string — Unique identifier for the invoice item. - `acquisitionTransactionItemId` string — ID of the original transaction item. - `display` string — Display name of the item. - `invoiceId` string — ID of the parent invoice. - `parentId` string — ID of the parent item, if this is a child item. - `childItems` string[] — Array of any child items (usually empty). - `productFormat` string — Format of the product (e.g., DIGITAL, PHYSICAL). - `productPath` string — Catalog identifier or path for the product. - `productType` string — Type of product (BASE, ADD-ON, etc). - `listPrice` number — Unit price of the item before tax. - `freeTrialPeriod` string — Free trial duration, if applicable. - `period` string — Subscription billing period (e.g., monthly). - `periodCount` integer — Number of billing periods. - `periodEndDate` string, date-time — Date when the billing period ends. - `periodPrice` number — Price charged for this billing period. - `shippingPrice` number — Cost of shipping applied to this item. - `totalPreShippingPrice` number — Item total before shipping and tax. - `itemTaxes` object[] — Taxes applied to this item. - `id` string — Tax line ID. - `itemId` string — ID of the invoice item this tax applies to. - `value` number — Amount of tax applied. - `taxRate` number — Tax rate percentage. - `fromGross` boolean — Whether tax was calculated from gross. - `description` string — Optional tax line description. - `taxType` string — Type of tax applied. - `subscription` boolean — Whether this is a subscription item. - `autoRenew` boolean — If this item auto-renews. - `taxExempt` boolean — Whether this item is exempt from tax. - `quantity` integer — Quantity of the product purchased. - `siblingPosition` integer — Position of this item relative to others. - `extendedItemDescription` string — Detailed description of the item. - `status` 'CANCELED' | 'OPEN' | 'PAYMENT_ACCEPTED' | 'COMPLETE' | 'PAID' | 'PENDING' | 'VOID' — Invoice lifecycle status (uppercase). - OPEN: Awaiting finalization - PENDING: Awaiting payment - PAYMENT_ACCEPTED: Payment processing - COMPLETE: Fully completed - PAID: Legacy status (deprecated, use COMPLETE) - CANCELED: Canceled before completion - VOID: Voided after completion - `language` string — Language code used for the invoice. - `invoiceOrderType` string — The type of order, if specified. - `invoiceSecret` string — Secure token for viewing the invoice. - `invoiceType` 'CREDIT_MEMO' | 'INVOICE' | 'FULL_TAX_REFUND' | 'PARTIAL_REFUND' | 'FULL_REFUND' | 'PAYMENT_INVOICE' — Invoice classification type - `netTermsDays` integer — Net terms in days, if defined. - `orderApprovalType` string — Indicates the invoice's approval mechanism. - `orderIsResumable` boolean — Indicates if the order is resumable. - `orderReference` string — Human-readable reference for the order. - `paymentDate` string, date-time — Date payment was received according to rfc3339 https://www.rfc-editor.org/rfc/rfc3339#section-5.6. - `paymentReceiverAddress` Address — Address details used for invoice delivery and billing. - `id` string — Unique identifier for the address. - `addressLine1` string — Primary street address. - `addressLine2` string — Secondary street address (e.g., suite or unit). - `city` string — City or locality. - `region` string — State, province, or region. - `postalCode` string — Postal or ZIP code. - `country` string — Country code in ISO 3166-1 alpha-2 format. - `regionCustom` string, nullable — Custom region string if region is not standardized. - `addressServiceId` string — Optional ID from an external address service. - `paymentReceiver` Contact — Contact details used in invoice communication and processing. - `id` string — Unique ID for the contact. - `email` string — Email address of the contact. - `firstName` string — First name of the contact. - `lastName` string — Last name of the contact. - `fullName` string — Full name of the contact (if applicable). - `companyName` string — Company name this contact represents. - `phoneNumber` string — Contact's phone number. - `website` string — Website URL for the contact or company. - `contactType` string — Role of the contact in the invoice (e.g., SHIP-TO, BILL-TO, PAYMENT_FACILITATOR). - `contactServiceId` string — Optional reference to an external service’s contact ID. - `contactOrganizationId` string — Optional reference to an external service’s organization ID. - `purchaser` Contact — Contact details used in invoice communication and processing. - `id` string — Unique ID for the contact. - `email` string — Email address of the contact. - `firstName` string — First name of the contact. - `lastName` string — Last name of the contact. - `fullName` string — Full name of the contact (if applicable). - `companyName` string — Company name this contact represents. - `phoneNumber` string — Contact's phone number. - `website` string — Website URL for the contact or company. - `contactType` string — Role of the contact in the invoice (e.g., SHIP-TO, BILL-TO, PAYMENT_FACILITATOR). - `contactServiceId` string — Optional reference to an external service’s contact ID. - `contactOrganizationId` string — Optional reference to an external service’s organization ID. - `purchaserAddress` Address — Address details used for invoice delivery and billing. - `id` string — Unique identifier for the address. - `addressLine1` string — Primary street address. - `addressLine2` string — Secondary street address (e.g., suite or unit). - `city` string — City or locality. - `region` string — State, province, or region. - `postalCode` string — Postal or ZIP code. - `country` string — Country code in ISO 3166-1 alpha-2 format. - `regionCustom` string, nullable — Custom region string if region is not standardized. - `addressServiceId` string — Optional ID from an external address service. - `purchaserOrganization` InvoiceOrganization — Organization data associated with a contact. - `organizationId` string — Unique ID for the organization. - `organizationName` string — Full legal name of the organization. - `organizationType` string — Type of business entity. - `organizationReference` string — Optional reference code for this organization. - `receiver` Contact — Contact details used in invoice communication and processing. - `id` string — Unique ID for the contact. - `email` string — Email address of the contact. - `firstName` string — First name of the contact. - `lastName` string — Last name of the contact. - `fullName` string — Full name of the contact (if applicable). - `companyName` string — Company name this contact represents. - `phoneNumber` string — Contact's phone number. - `website` string — Website URL for the contact or company. - `contactType` string — Role of the contact in the invoice (e.g., SHIP-TO, BILL-TO, PAYMENT_FACILITATOR). - `contactServiceId` string — Optional reference to an external service’s contact ID. - `contactOrganizationId` string — Optional reference to an external service’s organization ID. - `receiverAddress` Address — Address details used for invoice delivery and billing. - `id` string — Unique identifier for the address. - `addressLine1` string — Primary street address. - `addressLine2` string — Secondary street address (e.g., suite or unit). - `city` string — City or locality. - `region` string — State, province, or region. - `postalCode` string — Postal or ZIP code. - `country` string — Country code in ISO 3166-1 alpha-2 format. - `regionCustom` string, nullable — Custom region string if region is not standardized. - `addressServiceId` string — Optional ID from an external address service. - `receiverOrganization` InvoiceOrganization — Organization data associated with a contact. - `organizationId` string — Unique ID for the organization. - `organizationName` string — Full legal name of the organization. - `organizationType` string — Type of business entity. - `organizationReference` string — Optional reference code for this organization. - `refunds` string[] — List of any refunds applied to the invoice. - `reminderDate` string, date-time — Date a reminder was sent (if applicable). - `shippingTotal` number — Total shipping cost. - `subTotal` number — Subtotal before tax and discounts. - `siteId` string — FastSpring site identifier. - `siteMainUrl` string — Main URL for the site. - `siteSupportEmail` string — Support email address for the store. - `taxExemptionId` string — Tax exemption ID (if applicable). - `taxRate` number — Tax rate applied to the invoice. - `taxType` string — Type of tax applied to the invoice. - `totalOrderValue` number — Final amount due for the order. - `totalDiscountValue` number — Total discount amount. - `totalListPriceValue` number — Total price before any discounting. - `totalTaxValue` number — Total tax amount applied. - `updatedOn` string, date-time — Timestamp for when the invoice was last updated. - `version` string — Version of the invoice schema. - `notes` string — Freeform notes for the invoice. - `tagsJson` string — Stringified JSON metadata tags attached to the invoice. Returned in GET responses if set at creation. ## Other responses - `401` — Authentication credentials are missing or invalid. - `404` — Not found - `429` — Rate limit exceeded. Retry after the number of seconds specified in the Retry-After header. - `500` — Internal server error. --- [API](https://skmtc.dev/fastspring/apis/fastspring-api-accounts.md) · [All operations](https://skmtc.dev/fastspring/apis/fastspring-api-accounts/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/fastspring/fastspring-api-accounts/revisions/ae2f0b97db3e/schema)