Skip to content

Retrieves a merchant's invoice settings by ID

Request

GET {{baseURL}}/pay-int-api/merchants/{{merchantId}}/invoices/settings

Security
Bearer
Path
merchantIdstring, (uuid)required

Specifies the identifier of the merchant.

Example:46063d32-10fa-44cb-b118-20ddd085ce3f
Headers
x-api-versionstring
curl -i -X GET \
  https://developer.flute.com/_mock/api-reference/pay-int-api/merchants/46063d32-10fa-44cb-b118-20ddd085ce3f/invoices/settings \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'x-api-version: string'

Responses

OK

Bodyapplication/json
merchantIdstring, (uuid)

Indicates the identifier of the merchant.

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

Example:"46063d32-10fa-44cb-b118-20ddd085ce3f"
dueDateAfterDaysinteger or null, (int32)
taxPercentagenumber or null, (double)

Indicates the tax percentage.

Example: 8.50 (as 8.50%)

Example:8.5
isDiscountEnabledboolean

Indicates the discount is enabled.

If true, the discount is enabled.
If false, the discount is not enabled.

Example: true

Example:true
discountPercentagenumber or null, (double)

Indicates the discount percentage.

Example: 1.5 (as 1.5%)

Example:1.5
isShippingFeeEnabledboolean

Indicates the shipping fee is enabled.

If true, the shipping fee is enabled.
If false, the shipping fee is not enabled.

Example: true

Example:true
shippingFeeAmountnumber or null, (double)
isFeesEnabledboolean

Specifies fees are enabled.

If true, fees are enabled.
If false, fees are not enabled.

Example: true

Example:true
feesPercentagenumber or null, (double)

Indicates the fees percentage.

Example: 10.25 (as 10.25%)

Example:10.25
notesstring or null
paymentMethodTypeIdinteger, (int32)

Indicates the payment method type identifier.

Value values:

IdName
1Card (for credit card)
2ElectronicCheck

Example: 2

Example:2
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"
allowStaffToSetDiscountAndLineItemDiscountboolean
allowManuallyEnterLineItemsboolean
isSmsNotificationAfterPaymentEnabledboolean
isSmsNotificationAfterPaymentFailedEnabledboolean
canOverWriteInvoiceLineItemPriceboolean
newZcpFeatureEnabledboolean
Response
{
  "merchantId": "46063d32-10fa-44cb-b118-20ddd085ce3f",
  "dueDateAfterDays": 0,
  "taxPercentage": 8.5,
  "isDiscountEnabled": true,
  "discountPercentage": 1.5,
  "isShippingFeeEnabled": true,
  "shippingFeeAmount": 0.1,
  "isFeesEnabled": true,
  "feesPercentage": 10.25,
  "notes": "string",
  "paymentMethodTypeId": 2,
  "cardPaymentProcessorId": "78723ff2-d47e-460b-b838-d602bdf0e1bc",
  "achPaymentProcessorId": "9925a0b0-eb18-4d74-8967-7e0cf6af0729",
  "allowStaffToSetDiscountAndLineItemDiscount": true,
  "allowManuallyEnterLineItems": true,
  "isSmsNotificationAfterPaymentEnabled": true,
  "isSmsNotificationAfterPaymentFailedEnabled": true,
  "canOverWriteInvoiceLineItemPrice": true,
  "newZcpFeatureEnabled": true
}