Update invoice late fees configuration

PATCH 
/invoices/:invoiceId/late-fees-configuration

API to update invoice late fees configuration by invoice id

Request

Version stringrequired

API Version

Available optionsv3

invoiceId stringrequired

Invoice Id

application/json

application/json

Body

Bodyrequired

altIdstringrequired

location Id / company Id based on altType

altTypestringrequired
Alt Type
Available optionslocation
lateFeesConfigurationobjectrequired

late fees configuration

Example (auto)

{
  "altId": "6578278e879ad2646715ba9c",
  "altType": "location",
  "lateFeesConfiguration": {
    "enable": true,
    "value": 10,
    "type": "fixed",
    "frequency": {
      "intervalCount": 10,
      "interval": "day"
    },
    "grace": {
      "intervalCount": 10,
      "interval": "day"
    },
    "maxLateFees": {
      "type": "fixed",
      "value": "10"
    }
  }
}

application/json

Successful response

application/json

Schema

Schema

_idstringrequired

Invoice Id

statusstringrequired
Invoice Status
Available optionsdraftsentpayment_processingpaidvoidpartially_paid
liveModebooleanrequired

Live Mode

amountPaidnumberrequired

Amount Paid

altIdstringrequired

Location Id or Agency Id

altTypestringrequired
Available optionslocation
namestringrequired

Name of the invoice

businessDetailsobjectrequired

Business Details

invoiceNumbernumberrequired

Invoice Number

currencystringrequired

Currency

contactDetailsobjectrequired

Contact Details

issueDatestringrequired

Issue date in YYYY-MM-DD format

dueDatestringrequired

Due date in YYYY-MM-DD format

discountobject

Discount

invoiceItemsstring[]required

Invoice Items

totalnumberrequired

Total Amount

titlestringrequired

Title

amountDuenumberrequired

Total Amount Due

createdAtstringrequired

created at

updatedAtstringrequired

updated at

automaticTaxesEnabledboolean

Automatic taxes enabled for the Invoice

automaticTaxesCalculatedboolean

Is Automatic taxes calculated for the Invoice items

paymentScheduleobject

split invoice into payment schedule summing up to full invoice amount

Example (auto)

{
  "_id": "6578278e879ad2646715ba9c",
  "status": "draft",
  "liveMode": false,
  "amountPaid": 0,
  "altId": "6578278e879ad2646715ba9c",
  "altType": "location",
  "name": "New Invoice",
  "businessDetails": {
    "name": "Alex",
    "address": {
      "addressLine1": "9931 Beechwood",
      "city": "St. Houston",
      "state": "TX",
      "countryCode": "USA",
      "postalCode": "559-6993"
    },
    "phoneNo": "+1-214-559-6993",
    "website": "www.example.com"
  },
  "invoiceNumber": "19",
  "currency": "USD",
  "contactDetails": {
    "id": "c6tZZU0rJBf30ZXx9Gli",
    "phoneNo": "+1-214-559-6993",
    "email": "[email protected]",
    "customFields": [],
    "name": "Alex",
    "address": {
      "countryCode": "US"
    }
  },
  "issueDate": "2023-01-01",
  "dueDate": "2023-01-01",
  "discount": {
    "type": "percentage",
    "value": 0
  },
  "invoiceItems": [
    {
      "taxes": [],
      "_id": "c6tZZU0rJBf30ZXx9Gli",
      "productId": "c6tZZU0rJBf30ZXx9Gli",
      "priceId": "c6tZZU0rJBf30ZXx9Gli",
      "currency": "USD",
      "name": "Macbook Pro",
      "qty": 1,
      "amount": 999
    }
  ],
  "total": 999,
  "title": "INVOICE",
  "amountDue": 999,
  "createdAt": "2023-12-12T09:27:42.355Z",
  "updatedAt": "2023-12-12T09:27:42.355Z",
  "automaticTaxesEnabled": true,
  "automaticTaxesCalculated": true,
  "paymentSchedule": {}
}