v1

latestOpenAPI 3.0.02026-07-2475182625.5 KB

Invoices

Retrieve an invoice

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.

get/invoices/{invoiceId}

Path parameters

invoiceIdstring required

Example:ABCD0EF1GHIJKLMNOPQRSTUVWXYZ

The unique identifier of the invoice to retrieve.

Response

idstring

Unique identifier for the invoice.

acquisitionTransactionIdstring

Identifier of the acquisition transaction.

acquisitionReturnTransactionIdstring

ID of the return transaction, if applicable.

bankPaymentInstructionstring

Bank instructions for manual payment (if any).

companyNamestring

Company that owns the invoice.

createdOnstring date-time

ISO 8601 timestamp of when the invoice was created.

currencystring

ISO 4217 currency code.

customerReferencestring

Optional reference code from the customer.

dueDatestring date-time

Due date for the invoice.

eguiNumberstring

EGUI number for tax compliance (if applicable).

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

languagestring

Language code used for the invoice.

invoiceOrderTypestring

The type of order, if specified.

invoiceSecretstring

Secure token for viewing the invoice.

Invoice classification type

netTermsDaysinteger

Net terms in days, if defined.

orderApprovalTypestring

Indicates the invoice's approval mechanism.

orderIsResumableboolean

Indicates if the order is resumable.

orderReferencestring

Human-readable reference for the order.

paymentDatestring date-time

Date payment was received according to rfc3339 https://www.rfc-editor.org/rfc/rfc3339#section-5.6.

refundsstring[]

List of any refunds applied to the invoice.

reminderDatestring date-time

Date a reminder was sent (if applicable).

shippingTotalnumber

Total shipping cost.

subTotalnumber

Subtotal before tax and discounts.

siteIdstring

FastSpring site identifier.

siteMainUrlstring

Main URL for the site.

siteSupportEmailstring

Support email address for the store.

taxExemptionIdstring

Tax exemption ID (if applicable).

taxRatenumber

Tax rate applied to the invoice.

taxTypestring

Type of tax applied to the invoice.

totalOrderValuenumber

Final amount due for the order.

totalDiscountValuenumber

Total discount amount.

totalListPriceValuenumber

Total price before any discounting.

totalTaxValuenumber

Total tax amount applied.

updatedOnstring date-time

Timestamp for when the invoice was last updated.

versionstring

Version of the invoice schema.

notesstring

Freeform notes for the invoice.

tagsJsonstring

Stringified JSON metadata tags attached to the invoice. Returned in GET responses if set at creation.

Example response

{
  "id": "ABCD0EF1GHIJKLMNOPQRSTUVWXYZ",
  "acquisitionTransactionId": "ABCD0EF1GHIJKLMNOPQRSTUVWXYZ",
  "companyName": "recipient@example.com",
  "createdOn": "2026-04-02T16:08:24Z",
  "currency": "USD",
  "dueDate": "2026-12-31T00:00:00Z",
  "items": [
    {
      "id": "AB0CDE1FGHIJKL2M3N4OPQRS5T6U",
      "acquisitionTransactionItemId": "aB0Cd1E2FGh3Ij-K4LMNop",
      "display": "Sample Product Display Name",
      "invoiceId": "ABCD0EF1GHIJKLMNOPQRSTUVWXYZ",
      "productFormat": "DIGITAL",
      "productPath": "sample-product",
      "productType": "BASE",
      "listPrice": 25,
      "totalPreShippingPrice": 100,
      "itemTaxes": [
        {
          "id": "ABCDEF0G1HI2JK3LMN4OPQRSTU5V",
          "itemId": "AB0CDE1FGHIJKL2M3N4OPQRS5T6U",
          "value": 6,
          "taxRate": 6,
          "taxType": "US_SALES_TAX"
        }
      ],
      "quantity": 4,
      "extendedItemDescription": "Extended product description with additional details."
    }
  ],
  "status": "COMPLETE",
  "language": "en",
  "invoiceSecret": "TAX01ABCDEFGHIJ2KLMNOP3QRSTUV4WXYZABC5DEFGHIJKLMNOPQ",
  "invoiceType": "INVOICE",
  "netTermsDays": 10,
  "orderReference": "ABC012345-6789-01234",
  "paymentDate": "2026-12-31T23:10:30Z",
  "paymentReceiverAddress": {
    "id": "ABC0DEFGHIJKL1MNOP23Q4RSTUVW",
    "addressLine1": "123 Main Street",
    "addressLine2": "Suite 100",
    "city": "Metropolis",
    "region": "CA",
    "postalCode": "12345",
    "country": "US"
  },
  "paymentReceiver": {
    "id": "ABC0DEFGHI1JKL2MN3OPQRS4TUVW",
    "email": "recipient@example.com",
    "firstName": "John",
    "lastName": "Smith",
    "fullName": "John Smith",
    "companyName": "Example Company",
    "phoneNumber": "+1 555 000-0001",
    "website": "https://example.com",
    "contactType": "SHIP-TO"
  },
  "purchaser": {
    "id": "ABC0DEFGHI1JKL2MN3OPQRS4TUVW",
    "email": "recipient@example.com",
    "firstName": "John",
    "lastName": "Smith",
    "fullName": "John Smith",
    "companyName": "Example Company",
    "phoneNumber": "+1 555 000-0001",
    "website": "https://example.com",
    "contactType": "SHIP-TO"
  },
  "purchaserAddress": {
    "id": "ABC0DEFGHIJKL1MNOP23Q4RSTUVW",
    "addressLine1": "123 Main Street",
    "addressLine2": "Suite 100",
    "city": "Metropolis",
    "region": "CA",
    "postalCode": "12345",
    "country": "US"
  },
  "purchaserOrganization": {
    "organizationId": "ORGABCDEFGHIJKLMNOPQRST0U1VWX",
    "organizationName": "Example Company",
    "organizationType": "S Corporation",
    "organizationReference": "REF-001"
  },
  "receiver": {
    "id": "ABC0DEFGHI1JKL2MN3OPQRS4TUVW",
    "email": "recipient@example.com",
    "firstName": "John",
    "lastName": "Smith",
    "fullName": "John Smith",
    "companyName": "Example Company",
    "phoneNumber": "+1 555 000-0001",
    "website": "https://example.com",
    "contactType": "SHIP-TO"
  },
  "receiverAddress": {
    "id": "ABC0DEFGHIJKL1MNOP23Q4RSTUVW",
    "addressLine1": "123 Main Street",
    "addressLine2": "Suite 100",
    "city": "Metropolis",
    "region": "CA",
    "postalCode": "12345",
    "country": "US"
  },
  "receiverOrganization": {
    "organizationId": "ORGABCDEFGHIJKLMNOPQRST0U1VWX",
    "organizationName": "Example Company",
    "organizationType": "S Corporation",
    "organizationReference": "REF-001"
  },
  "refunds": [],
  "subTotal": 59.8,
  "siteId": "ABC0DE1GHIJ2",
  "taxRate": 6,
  "taxType": "US_SALES_TAX",
  "totalOrderValue": 63.39,
  "totalTaxValue": 3.59,
  "version": "2",
  "notes": "Add notes here.",
  "tagsJson": "{\"costCenter\": \"CC-1042\", \"purchaseOrder\": \"PO-2026-Q2-0042\"}"
}