logo

InvoicesSettings

Retrieves invoice settings for a specific merchant.

SecurityBearer or Bearer or Bearer or Bearer
Request
path Parameters
merchantId
required
string <uuid>

The ID of the merchant.

header Parameters
x-api-version
string
Responses
200

OK

403

Forbidden

404

Not Found

get/pay-int-api/merchants/{merchantId}/invoices/settings
Request samples 
Response samples 
application/json
{
  • "merchantId": "c3073b9d-edd0-49f2-a28d-b7ded8ff9a8b",
  • "dueDateAfterDays": 0,
  • "taxPercentage": 0,
  • "isDiscountEnabled": true,
  • "discountPercentage": 0,
  • "isShippingFeeEnabled": true,
  • "shippingFeeAmount": 0,
  • "isFeesEnabled": true,
  • "feesPercentage": 0,
  • "notes": "string",
  • "paymentMethodTypeId": 0,
  • "cardPaymentProcessorId": "db82121d-3317-4452-ab36-552196b0f55a",
  • "achPaymentProcessorId": "7795a840-221a-45e0-9419-a69eaa3463ff",
  • "allowStaffToSetDiscountAndLineItemDiscount": true,
  • "allowManuallyEnterLineItems": true,
  • "isSmsNotificationAfterPaymentEnabled": true,
  • "isSmsNotificationAfterPaymentFailedEnabled": true,
  • "canOverWriteInvoiceLineItemPrice": true,
  • "newZcpFeatureEnabled": true
}
Updates invoice settings for a specific merchant.
SecurityBearer or Bearer or Bearer or Bearer 
Request 
path Parameters
merchantId
required
string <uuid> 
The ID of the merchant to update settings for.


 
header Parameters
x-api-version
string
 
Request Body schema: application/json
The invoice settings update request.


dueDateAfterDays
integer or null <int32> 
 
taxPercentage
number or null <double> 
 
isDiscountEnabled
boolean
 
discountPercentage
number or null <double> 
 
isShippingFeeEnabled
boolean
 
shippingFeeAmount
number or null <double> 
 
isFeesEnabled
boolean
 
feesPercentage
number or null <double> 
 
notes
string or null
 
paymentMethodTypeId
integer or null <int32> 
 
cardPaymentProcessorId
string or null <uuid> 
 
achPaymentProcessorId
string or null <uuid> 
 
allowStaffToSetDiscountAndLineItemDiscount
boolean
 
allowManuallyEnterLineItems
boolean
 
isSmsNotificationAfterPaymentEnabled
boolean
 
isSmsNotificationAfterPaymentFailedEnabled
boolean
 
achAllowFasterProcessing
boolean or null
 
canOverWriteInvoiceLineItemPrice
boolean
 
Responses 
200
Invoice settings updated successfully


400
Bad Request


403
Forbidden


404
Not Found


500
Internal Server Error


put/pay-int-api/merchants/{merchantId}/invoices/settings
Request samples 
application/json
{
  • "dueDateAfterDays": 0,
  • "taxPercentage": 0,
  • "isDiscountEnabled": true,
  • "discountPercentage": 0,
  • "isShippingFeeEnabled": true,
  • "shippingFeeAmount": 0,
  • "isFeesEnabled": true,
  • "feesPercentage": 0,
  • "notes": "string",
  • "paymentMethodTypeId": 0,
  • "cardPaymentProcessorId": "db82121d-3317-4452-ab36-552196b0f55a",
  • "achPaymentProcessorId": "7795a840-221a-45e0-9419-a69eaa3463ff",
  • "allowStaffToSetDiscountAndLineItemDiscount": true,
  • "allowManuallyEnterLineItems": true,
  • "isSmsNotificationAfterPaymentEnabled": true,
  • "isSmsNotificationAfterPaymentFailedEnabled": true,
  • "achAllowFasterProcessing": true,
  • "canOverWriteInvoiceLineItemPrice": true
}
Response samples 
application/json
{
  • "errors": {
    },
  • "details": "Validation failed: \n -- Email: 'Email' is not a valid email address. Severity: Error",
  • "statusCode": 400,
  • "source": "<Service>",
  • "exceptionType": "FluentValidation.ValidationException",
  • "correlationId": "aa6cfcd0-0295-4a4c-b074-8c901f114fee",
  • "entityId": null,
  • "errorCode": null
}
➔ Next to LineItems