Skip to content

Publishes an invoice

Request

POST {{baseURL}}/pay-int-api/invoices/publish

Security
Bearer
Headers
x-api-versionstring
Bodyapplication/json

The request containing the details for publishing the invoice.

dueDatestring or null, (date-time)

Specifies the date-time (in an ISO 8601 date-time UTC format) the invoice is due.

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

Example:"2026-02-19T20:24:52.934Z"
cardPaymentProcessorIdstring or null, (uuid)

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

Example: 78723ff2-d47e-460b-b838-d602bdf0e1bc

Example:"78723ff2-d47e-460b-b838-d602bdf0e1bc"
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."
shippingAmountnumber or null, (double)

Specifies the shipping amount (in USD).

Example: 129.99

Example:129.99
taxPercentagenumber or null, (double)

Specifies the tax percentage.

Example: 8.50 (as 8.50%)

Example:8.5
feesPercentagenumber or null, (double)

Specifies the fees percentage.

Example: 10.25 (as 10.25%)

Example:10.25
discountPercentagenumber or null, (double)

Specifies the discount percentage.

Example: 1.5 (as 1.5%)

Example:1.5
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"
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-4f4638289d

Example:"fd9198a4-eb6f-4620-9603-4f4638289d"
achAllowFasterProcessingboolean or null
customerobject
lineItemsArray of objects or null
canPriceBeForceOverridedboolean
idstring or null, (uuid)
curl -i -X POST \
  https://developer.flute.com/_mock/api-reference/pay-int-api/invoices/publish \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'x-api-version: string' \
  -d '{
    "dueDate": "2026-02-19T20:24:52.934Z",
    "cardPaymentProcessorId": "78723ff2-d47e-460b-b838-d602bdf0e1bc",
    "achPaymentProcessorId": "9925a0b0-eb18-4d74-8967-7e0cf6af0729",
    "additionalNotes": "Extension permitted for 30 days.",
    "shippingAmount": 129.99,
    "taxPercentage": 8.5,
    "feesPercentage": 10.25,
    "discountPercentage": 1.5,
    "merchantContactInfoId": "bdf4b5c6-7d8e-4f9a-0b1c-2d3e4f5a6b92",
    "customerId": "fd9198a4-eb6f-4620-9603-4f4638289d",
    "achAllowFasterProcessing": true,
    "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
      }
    ],
    "canPriceBeForceOverrided": true,
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  }'

Responses

OK

Bodyapplication/json
idstring, (uuid)
Response
{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08" }