Skip to content
/
Retrieves an invoice by I...

Retrieves an invoice by ID

Request

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

This endpoint retrieves an invoice by ID.

The following is an example request.

GET {{baseURL}}/pay-int-api/invoices/{{invoiceId}} HTTP/1.1
Authorization: Bearer {{accessToken}}
x-api-version: 1.0

The response includes the invoice's status, amounts, customer details, line items, and its full history of status changes, along with the hosted payment page URL the customer uses to pay. It's useful for checking an invoice's current state, such as confirming if it's still in Draft, has been Published, or has moved to Paid.

See Also:
To list invoices, see GET /pay-int-api/invoices.
To create an invoice, see POST /pay-int-api/invoices.
To update an invoice, see PUT /pay-int-api/invoices/{invoiceId}.
To delete an invoice, see DELETE /pay-int-api/invoices/{invoiceId}.

Security
Bearer
Path
invoiceIdstring, (uuid)required

Specifies the identifier of the invoice to retrieve.

Example:9be2f3a4-5b6c-4d7e-8f9a-0b1c2d3e4f70
Headers
x-api-versionstring

Specifies the API version to use for the request.

Example: 1.0

Example:1.0
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: 1.0'

Responses

OK

Bodyapplication/json
idstring or null, (uuid)

Indicates the invoice identifier.

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

Example:"9be2f3a4-5b6c-4d7e-8f9a-0b1c2d3e4f70"
numberstring or null

Indicates an identifier for the invoice.

It is meant for display and reference purposes. This is distinct from 'id'.

Example: INV-00042

Example:"INV-00042"
statusinteger, (int32)

Possible values:

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

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 (as $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:

IdName
1Card (for credit card)
2ElectronicCheck

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

Indicates the merchant's contact information used on invoices and payment flows.

customerIdstring or null, (uuid)

Indicates 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

Indicates the customer's information for the invoice.

lineItemsArray of objects or null

Line items for the invoice.

isCustomerUpdatedboolean

Indicates the customer's details have changed since this invoice was created or last saved.

It indicates to the merchant that the customer info shown is out of sync with what's stored on the invoice.

This value is used only if the invoice is in 'Draft' status, This value is false invoices other than Draft statuses. It is false for Draft invoices where the customer data has not changed.

Example: true

Example:true
isLineItemsUpdatedboolean

For internal use only.

Do not use.

fullUrlstring or null

Indicates the URL to the invoice's public payment page.

These are generated by Flute and are the hosted page the customer opens to pays.

Example: https://pay.flute.com/invoices/39a95e35-6d50-45ec-884b-c2417edf005d

Example:"https://pay.flute.com/invoices/39a95e35-6d50-45ec-884b-c2417edf005d"
shortUrlstring or null

Indicates a shortened version of the URL to the invoice's public payment page.

These are generated by Flute and are the hosted page the customer opens to pays.

Examp[le: https://s.flute.com/745iZYxF83t

Example:"https://s.flute.com/745iZYxF83t"
markedAsPaidboolean or null

Indicates the invoice was manually marked as paid.

If true, the invoice was marked as paid without a processed transaction.
If false, the invoice was not manually marked as paid.

Example: true

Example:true
transactionIdstring or null, (uuid)

Indicates the identifier of the transaction associated with the invoice's payment.

Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6

Example:"3fa85f64-5717-4562-b3fc-2c963f66afa6"
achAllowFasterProcessingboolean or null

Indicates faster processing is allowed for the invoice's ACH payment.

If true, faster processing is allowed.
If false, faster processing is not allowed.

Example: true

Example:true
historyArray of objects or null

Indicates the invoice's history of status changes and events.

zeroCostProcessingOptionIdinteger or null, (int32)

Indicates the identifier of 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:

IdType
1None
2CashDiscount
3DualPricing
4Surcharge

Example: 3

Example:3
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:

TypeId
None1
CashDiscount2
DualPricing3
Surcharge4

Example: DualPricing

Example:"DualPricing"
useCardPriceboolean or null

Indicates which price the customer sees under dual pricing.

Available only when zeroCostProcessingOption is DualPricing, and when invoice is in Published or Paid status.

If true, dual pricing is used and the card price is shown.
If false, dual pricing is used and the cash price is shown.
If null or omitted, a different zero cost processing option applies.

Example: true

Example:true
invoiceCalculationsobject

Indicates the invoice's calculated amounts broken out by payment method type.

Response
{
  "id": "9be2f3a4-5b6c-4d7e-8f9a-0b1c2d3e4f70",
  "number": "INV-00042",
  "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": [
    {
      "productName": "RollerMouse Wireless Mouse",
      "unitTypeId": 1,
      "unitPrice": 18.99,
      "id": "d0f6d7e8-9f0a-4b1c-2d3e-4f5a6b7c8d14",
      "lineItemId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
      "description": "RollerMouse Design Collection, Limited Edition Wireless Mouse",
      "sku": "24474771",
      "quantity": 10,
      "discountPercentage": 1.5,
      "totalAmount": 3219.45
    }
  ],
  "isCustomerUpdated": true,
  "isLineItemsUpdated": true,
  "fullUrl": "https://pay.flute.com/invoices/39a95e35-6d50-45ec-884b-c2417edf005d",
  "shortUrl": "https://s.flute.com/745iZYxF83t",
  "markedAsPaid": true,
  "transactionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "achAllowFasterProcessing": true,
  "history": [
    {
      "id": "c1d2e3f4-5a6b-4c7d-8e9f-0a1b2c3d4e5f",
      "invoiceId": "9be2f3a4-5b6c-4d7e-8f9a-0b1c2d3e4f70",
      "typeId": 1,
      "typeName": "Created",
      "errorCode": "string",
      "errorMessage": "Recipient not available",
      "notificationId": "2f6f0a49-7b3e-4a2d-9c1f-5e6d7a8b9c0d",
      "notificationType": "Email",
      "notificationTypeId": 1,
      "notificationTemplateType": "InvoicePublished",
      "notificationTemplateTypeId": 1,
      "notificationTarget": "peppared@example.com",
      "transactionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "paymentMethodTypeId": 2,
      "createdOn": "2026-02-19T20:24:52.934Z"
    }
  ],
  "zeroCostProcessingOptionId": 3,
  "zeroCostProcessingOption": "DualPricing",
  "useCardPrice": true,
  "invoiceCalculations": {
    "debitCard": {
      "subTotalAmount": 3219.45,
      "totalAmount": 3219.45,
      "shippingAmount": 129.99,
      "taxAmount": 273.65,
      "taxPercentage": 8.5,
      "feesAmount": 35,
      "feesPercentage": 10.25,
      "discountAmount": 48.29,
      "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": 273.65,
      "taxPercentage": 8.5,
      "feesAmount": 35,
      "feesPercentage": 10.25,
      "discountAmount": 48.29,
      "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": 273.65,
      "taxPercentage": 8.5,
      "feesAmount": 35,
      "feesPercentage": 10.25,
      "discountAmount": 48.29,
      "discountPercentage": 1.5,
      "surchargeAmount": 6.45,
      "surchargePercentage": 1.5,
      "cashDiscountAmount": 10.55,
      "cashDiscountPercentage": 1.5
    }
  }
}