Retrieves an invoice's details

Request

GET {{baseURL}}/pay-int-api/invoices/{{invoiceId}}

Security

Bearer

Path

invoiceIdstring, (uuid)required

The identifier of the invoice to retrieve.

Example:9be2f3a4-5b6c-4d7e-8f9a-0b1c2d3e4f70

x-api-versionstring

curl -i -X GET \
  https://developer.flute.com/_mock/api-reference/pay-int-api/invoices/9be2f3a4-5b6c-4d7e-8f9a-0b1c2d3e4f70 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'x-api-version: string'

Responses

Bodyapplication/json

idstring, (uuid)

numberstring or null

statusinteger, (int32)

Possible values:

Value	Name
1	Draft
2	Published
3	Paid
4	Expired
5	Canceled
6	ProcessingPayment
7	Refunded

Example: 2

Example:2

issueDatestring or null, (date-time)

Indicates the date-time (in an ISO 8601 date-time UTC format) of the invoice's issue.

Examples: 2026-02-19T20:24:52.934Z

Example:"2026-02-19T20:24:52.934Z"

dueDatestring or null, (date-time)

Indicates the date-time (in an ISO 8601 date-time UTC format) of the invoice due date.

Examples: 2026-02-19T20:24:52.934Z

Example:"2026-02-19T20:24:52.934Z"

paymentDatestring or null, (date-time)

Indicates the date-time (in an ISO 8601 date-time UTC format) of the invoice payment.

Examples: 2026-02-19T20:24:52.934Z

Example:"2026-02-19T20:24:52.934Z"

cardPaymentProcessorIdstring or null, (uuid)

Indicates an identifier for the credit card payment processor handling a transaction.

example: acf3a4b5-6c7d-4e8f-9a0b-1c2d3e4f5a81

Example:"acf3a4b5-6c7d-4e8f-9a0b-1c2d3e4f5a81"

achPaymentProcessorIdstring or null, (uuid)

Specifies an identifier for the automated clearing house (ACH) payment processor handling a transaction.

Example: 9925a0b0-eb18-4d74-8967-7e0cf6af0729

Example:"9925a0b0-eb18-4d74-8967-7e0cf6af0729"

additionalNotesstring or null

Indicates additional notes or comments.

Example: Extension permitted for 30 days.

Example:"Extension permitted for 30 days."

subTotalAmountnumber, (double)

Specifies the transaction's subtotal amount.

This includes the base amount, tips, taxes, and discounts.

Example: 3219.45

Example:3219.45

shippingAmountnumber, (double)

Indicates the shipping amount (in USD).

Example: 129.99

Example:129.99

totalAmountnumber, (double)

Specifies the transaction's total amount.

This includes the base amount, tips, taxes, shipping, discounts, and other charges.

Example: 3219.45

Example:3219.45

taxPercentagenumber, (double)

Indicates the tax percentage.

Example: 8.50 (as 8.50%)

Example:8.5

feesPercentagenumber, (double)

Indicates the fees percentage.

Example: 10.25 (as 10.25%)

Example:10.25

discountPercentagenumber, (double)

Indicates the discount percentage.

Example: 1.5 (as 1.5%)

Example:1.5

surchargeAmountnumber, (double)

Identifies the amount (in USD) when a surcharge is applicable.

This is a surcharge on the base amount. This surcharge was calculated using the preset percentage from surchargePercentage.

Example: 6.45

Example:6.45

surchargePercentagenumber, (double)

Identifies the surcharge percentage.

This is a surcharge on the base amount. This value is surcharge percentage rate. This surcharge percentage calculates the surcharge amount for surchargeAmount.

Example: 1.5 (as 1.5%)

Example:1.5

cashDiscountAmountnumber, (double)

Identifies the discount amount (in USD) when a cash (or cash-equivalent) discount is applied.

This discount was calculated using the preset percentage from cashDiscountRate.

Example: 10.55

Example:10.55

cashDiscountPercentagenumber, (double)

Identifies the discount percentage for a cash (or cash-equivalent) discount.

This value is percentage rate for the discount. This discount percentage calculates the discount amount for cashDiscountAmount.

Example: 1.5 (as 1.5%)

Example:1.5

paymentMethodTypeIdinteger or null, (int32)

Indicates the payment method type identifier.

Value values:

Id	Name
1	Card (for credit card)
2	ElectronicCheck

Example: 2

Example:2

merchantIdstring, (uuid)

Indicates the identifier of the merchant.

Example: 46063d32-10fa-44cb-b118-20ddd085ce3f

Example:"46063d32-10fa-44cb-b118-20ddd085ce3f"

merchantContactInfoIdstring or null, (uuid)

Indicates the merchant’s stored contact information record used on invoices and payment flows.

Example: bdf4b5c6-7d8e-4f9a-0b1c-2d3e4f5a6b92

Example:"bdf4b5c6-7d8e-4f9a-0b1c-2d3e4f5a6b92"

merchantContactInfoobject

customerIdstring or null, (uuid)

Specifies the customer identifier.

This is used when saving the payment method.
If this value is provided, the payment method is saved to the specified customer.
If this value is not provided, a new customer record is created.

Example: fd9198a4-eb6f-4620-9603-4f4638289de5

Example:"fd9198a4-eb6f-4620-9603-4f4638289de5"

customerobject

lineItemsArray of objects or null

isCustomerUpdatedboolean

isLineItemsUpdatedboolean

fullUrlstring or null

shortUrlstring or null

markedAsPaidboolean or null

transactionIdstring or null, (uuid)

achAllowFasterProcessingboolean or null

historyArray of objects or null

zeroCostProcessingOptionIdinteger or null, (int32)

ZCP Option Id Available when invoice is in Published or Paid status

zeroCostProcessingOptionstring or null

Specifies using the type of zero cost processing.

Zero cost processing has the customer covering the card fees and not the merchant.

Available when invoice is in Published or Paid status

Possible values:

Type	Id
None	1
CashDiscount	2
DualPricing	3
Surcharge	4

Example: DualPricing

Example:"DualPricing"

useCardPriceboolean or null

Available for ZCP Option == Dual pricing only, when invoice is in Published or Paid status true - dual pricing, use card price false - dual pricing, use cash price null - other ZCP option

invoiceCalculationsobject

Response

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "number": "string",
  "status": 2,
  "issueDate": "2026-02-19T20:24:52.934Z",
  "dueDate": "2026-02-19T20:24:52.934Z",
  "paymentDate": "2026-02-19T20:24:52.934Z",
  "cardPaymentProcessorId": "acf3a4b5-6c7d-4e8f-9a0b-1c2d3e4f5a81",
  "achPaymentProcessorId": "9925a0b0-eb18-4d74-8967-7e0cf6af0729",
  "additionalNotes": "Extension permitted for 30 days.",
  "subTotalAmount": 3219.45,
  "shippingAmount": 129.99,
  "totalAmount": 3219.45,
  "taxPercentage": 8.5,
  "feesPercentage": 10.25,
  "discountPercentage": 1.5,
  "surchargeAmount": 6.45,
  "surchargePercentage": 1.5,
  "cashDiscountAmount": 10.55,
  "cashDiscountPercentage": 1.5,
  "paymentMethodTypeId": 2,
  "merchantId": "46063d32-10fa-44cb-b118-20ddd085ce3f",
  "merchantContactInfoId": "bdf4b5c6-7d8e-4f9a-0b1c-2d3e4f5a6b92",
  "merchantContactInfo": {
    "addressLine1": "21 E. Main Street",
    "addressLine2": "Office 3",
    "city": "Chicago",
    "zip": "60612",
    "countryId": 1,
    "stateId": 4,
    "stateName": "Illinois",
    "email": "peppared@example.com",
    "businessPhoneNumber": "+14155552309"
  },
  "customerId": "fd9198a4-eb6f-4620-9603-4f4638289de5",
  "customer": {
    "firstName": "Alexandro",
    "lastName": "Peppared",
    "companyName": "Peppared Street Cafe",
    "email": "peppared@example.com",
    "mobilePhoneNumber": "+14155552309",
    "isMobileNumberSmsNotificationsEnabled": true,
    "useBillingAsShippingAddress": true,
    "billingAddress": {
      "line1": "21 E. Main Street",
      "line2": "Apt. Block 6",
      "city": "Chicago",
      "zip": "60612",
      "countryId": 1,
      "stateId": 1,
      "stateName": "Illinois"
    },
    "shippingAddress": {
      "line1": "21 E. Main Street",
      "line2": "Apt. Block 6",
      "city": "Chicago",
      "zip": "60612",
      "countryId": 1,
      "stateId": 1,
      "stateName": "Illinois"
    }
  },
  "lineItems": [
    {
      "id": "d0f6d7e8-9f0a-4b1c-2d3e-4f5a6b7c8d14",
      "lineItemId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
      "unitTypeId": 1,
      "productName": "RollerMouse Wireless Mouse",
      "description": "RollerMouse Design Collection, Limited Edition Wireless Mouse",
      "sku": "24474771",
      "unitPrice": 18.99,
      "quantity": 10,
      "discountPercentage": 1.5,
      "totalAmount": 3219.45
    }
  ],
  "isCustomerUpdated": true,
  "isLineItemsUpdated": true,
  "fullUrl": "string",
  "shortUrl": "string",
  "markedAsPaid": true,
  "transactionId": "75906707-8c31-479c-b354-aa805c4cefbc",
  "achAllowFasterProcessing": true,
  "history": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "invoiceId": "4f163819-178d-470c-a246-d6768476a6ec",
      "typeId": 0,
      "typeName": "string",
      "errorCode": "string",
      "errorMessage": "Recipient not available",
      "notificationId": "2d591c23-85b1-4e8c-a6bd-74d89f8955c5",
      "notificationType": "string",
      "notificationTypeId": 0,
      "notificationTemplateType": "string",
      "notificationTemplateTypeId": 0,
      "notificationTarget": "string",
      "transactionId": "75906707-8c31-479c-b354-aa805c4cefbc",
      "paymentMethodTypeId": 2,
      "createdOn": "2026-02-19T20:24:52.934Z"
    }
  ],
  "zeroCostProcessingOptionId": 0,
  "zeroCostProcessingOption": "DualPricing",
  "useCardPrice": true,
  "invoiceCalculations": {
    "debitCard": {
      "subTotalAmount": 3219.45,
      "totalAmount": 3219.45,
      "shippingAmount": 129.99,
      "taxAmount": 0.1,
      "taxPercentage": 0.1,
      "description": null,
      "example": null,
      "feesAmount": 35,
      "feesPercentage": 10.25,
      "discountAmount": 0.1,
      "discountPercentage": 1.5,
      "surchargeAmount": 6.45,
      "surchargePercentage": 1.5,
      "cashDiscountAmount": 10.55,
      "cashDiscountPercentage": 1.5
    },
    "creditCard": {
      "subTotalAmount": 3219.45,
      "totalAmount": 3219.45,
      "shippingAmount": 129.99,
      "taxAmount": 0.1,
      "taxPercentage": 0.1,
      "description": null,
      "example": null,
      "feesAmount": 35,
      "feesPercentage": 10.25,
      "discountAmount": 0.1,
      "discountPercentage": 1.5,
      "surchargeAmount": 6.45,
      "surchargePercentage": 1.5,
      "cashDiscountAmount": 10.55,
      "cashDiscountPercentage": 1.5
    },
    "ach": {
      "subTotalAmount": 3219.45,
      "totalAmount": 3219.45,
      "shippingAmount": 129.99,
      "taxAmount": 0.1,
      "taxPercentage": 0.1,
      "description": null,
      "example": null,
      "feesAmount": 35,
      "feesPercentage": 10.25,
      "discountAmount": 0.1,
      "discountPercentage": 1.5,
      "surchargeAmount": 6.45,
      "surchargePercentage": 1.5,
      "cashDiscountAmount": 10.55,
      "cashDiscountPercentage": 1.5
    }
  }
}