Skip to content
/
Updates an invoice settin...

Updates an invoice setting

Request

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

This endpoint updates the specified invoice setting.

Care must be taken to complete all the fields with the existing information.
Security
Bearer
Path
merchantIdstring, (uuid)required

Specifies the identifier of the merchant.

Example:46063d32-10fa-44cb-b118-20ddd085ce3f
Headers
x-api-versionstring
Bodyapplication/json

The invoice settings update request.

dueDateAfterDaysinteger or null, (int32)
taxPercentagenumber or null, (double)

Specifies the tax percentage.

Example: 8.50 (as 8.50%)

Example:8.5
isDiscountEnabledboolean

Specifies the discount is enabled.

If true, enable the the discount.
If false, do not enable the the discount

Example: true

Example:true
discountPercentagenumber or null, (double)

Specifies the discount percentage.

Example: 1.5 (as 1.5%)

Example:1.5
isShippingFeeEnabledboolean

Specifies 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)

Specifies the fees percentage.

Example: 10.25 (as 10.25%)

Example:10.25
notesstring or null
paymentMethodTypeIdinteger or null, (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
achAllowFasterProcessingboolean or null
canOverWriteInvoiceLineItemPriceboolean
curl -i -X PUT \
  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 'Content-Type: application/json' \
  -H 'x-api-version: string' \
  -d '{
    "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,
    "achAllowFasterProcessing": true,
    "canOverWriteInvoiceLineItemPrice": true
  }'

Responses

Invoice settings updated successfully

Response
No content