/PartialPayments
  • 16 Oct 2024
  • PDF

/PartialPayments

  • PDF

Article summary

Post
/PartialPayments
Security
HTTP
Type bearer

Bearer Authorization Token

Body parameters
object
Amount
number (double) Required
Minimum0.01
BillingCompany
string | null
Min length0
Max length100
BillingContact
string | null
Min length0
Max length250
BranchName
string | null
Min length0
Max length50
InvoiceNumber
integer (int32) | null
PaymentDate
string (date-time) Required
PaymentMethod
string Required
Min length1
Max length20
PaymentNote
string | null
Min length0
Max length2147483647
PaymentReference
string Required
Min length1
Max length50
object
Amount
number (double) Required
Minimum0.01
BillingCompany
string | null
Min length0
Max length100
BillingContact
string | null
Min length0
Max length250
BranchName
string | null
Min length0
Max length50
InvoiceNumber
integer (int32) | null
PaymentDate
string (date-time) Required
PaymentMethod
string Required
Min length1
Max length20
PaymentNote
string | null
Min length0
Max length2147483647
PaymentReference
string Required
Min length1
Max length50
object
Amount
number (double) Required
Minimum0.01
BillingCompany
string | null
Min length0
Max length100
BillingContact
string | null
Min length0
Max length250
BranchName
string | null
Min length0
Max length50
InvoiceNumber
integer (int32) | null
PaymentDate
string (date-time) Required
PaymentMethod
string Required
Min length1
Max length20
PaymentNote
string | null
Min length0
Max length2147483647
PaymentReference
string Required
Min length1
Max length50
object
Amount
number (double) Required
Minimum0.01
BillingCompany
string | null
Min length0
Max length100
BillingContact
string | null
Min length0
Max length250
BranchName
string | null
Min length0
Max length50
InvoiceNumber
integer (int32) | null
PaymentDate
string (date-time) Required
PaymentMethod
string Required
Min length1
Max length20
PaymentNote
string | null
Min length0
Max length2147483647
PaymentReference
string Required
Min length1
Max length50
object
Amount
number (double) Required
Minimum0.01
BillingCompany
string | null
Min length0
Max length100
BillingContact
string | null
Min length0
Max length250
BranchName
string | null
Min length0
Max length50
InvoiceNumber
integer (int32) | null
PaymentDate
string (date-time) Required
PaymentMethod
string Required
Min length1
Max length20
PaymentNote
string | null
Min length0
Max length2147483647
PaymentReference
string Required
Min length1
Max length50
object
Amount
number (double) Required
Minimum0.01
BillingCompany
string | null
Min length0
Max length100
BillingContact
string | null
Min length0
Max length250
BranchName
string | null
Min length0
Max length50
InvoiceNumber
integer (int32) | null
PaymentDate
string (date-time) Required
PaymentMethod
string Required
Min length1
Max length20
PaymentNote
string | null
Min length0
Max length2147483647
PaymentReference
string Required
Min length1
Max length50
object
Amount
number (double) Required
Minimum0.01
BillingCompany
string | null
Min length0
Max length100
BillingContact
string | null
Min length0
Max length250
BranchName
string | null
Min length0
Max length50
InvoiceNumber
integer (int32) | null
PaymentDate
string (date-time) Required
PaymentMethod
string Required
Min length1
Max length20
PaymentNote
string | null
Min length0
Max length2147483647
PaymentReference
string Required
Min length1
Max length50
object
Amount
number (double) Required
Minimum0.01
BillingCompany
string | null
Min length0
Max length100
BillingContact
string | null
Min length0
Max length250
BranchName
string | null
Min length0
Max length50
InvoiceNumber
integer (int32) | null
PaymentDate
string (date-time) Required
PaymentMethod
string Required
Min length1
Max length20
PaymentNote
string | null
Min length0
Max length2147483647
PaymentReference
string Required
Min length1
Max length50
object
Amount
number (double) Required
Minimum0.01
BillingCompany
string | null
Min length0
Max length100
BillingContact
string | null
Min length0
Max length250
BranchName
string | null
Min length0
Max length50
InvoiceNumber
integer (int32) | null
PaymentDate
string (date-time) Required
PaymentMethod
string Required
Min length1
Max length20
PaymentNote
string | null
Min length0
Max length2147483647
PaymentReference
string Required
Min length1
Max length50
object
Amount
number (double) Required
Minimum0.01
BillingCompany
string | null
Min length0
Max length100
BillingContact
string | null
Min length0
Max length250
BranchName
string | null
Min length0
Max length50
InvoiceNumber
integer (int32) | null
PaymentDate
string (date-time) Required
PaymentMethod
string Required
Min length1
Max length20
PaymentNote
string | null
Min length0
Max length2147483647
PaymentReference
string Required
Min length1
Max length50
object
Amount
number (double) Required
Minimum0.01
BillingCompany
string | null
Min length0
Max length100
BillingContact
string | null
Min length0
Max length250
BranchName
string | null
Min length0
Max length50
InvoiceNumber
integer (int32) | null
PaymentDate
string (date-time) Required
PaymentMethod
string Required
Min length1
Max length20
PaymentNote
string | null
Min length0
Max length2147483647
PaymentReference
string Required
Min length1
Max length50
object
Amount
number (double) Required
Minimum0.01
BillingCompany
string | null
Min length0
Max length100
BillingContact
string | null
Min length0
Max length250
BranchName
string | null
Min length0
Max length50
InvoiceNumber
integer (int32) | null
PaymentDate
string (date-time) Required
PaymentMethod
string Required
Min length1
Max length20
PaymentNote
string | null
Min length0
Max length2147483647
PaymentReference
string Required
Min length1
Max length50
object
Amount
number (double) Required
Minimum0.01
BillingCompany
string | null
Min length0
Max length100
BillingContact
string | null
Min length0
Max length250
BranchName
string | null
Min length0
Max length50
InvoiceNumber
integer (int32) | null
PaymentDate
string (date-time) Required
PaymentMethod
string Required
Min length1
Max length20
PaymentNote
string | null
Min length0
Max length2147483647
PaymentReference
string Required
Min length1
Max length50
object
Amount
number (double) Required
Minimum0.01
BillingCompany
string | null
Min length0
Max length100
BillingContact
string | null
Min length0
Max length250
BranchName
string | null
Min length0
Max length50
InvoiceNumber
integer (int32) | null
PaymentDate
string (date-time) Required
PaymentMethod
string Required
Min length1
Max length20
PaymentNote
string | null
Min length0
Max length2147483647
PaymentReference
string Required
Min length1
Max length50
object
Amount
number (double) Required
Minimum0.01
BillingCompany
string | null
Min length0
Max length100
BillingContact
string | null
Min length0
Max length250
BranchName
string | null
Min length0
Max length50
InvoiceNumber
integer (int32) | null
PaymentDate
string (date-time) Required
PaymentMethod
string Required
Min length1
Max length20
PaymentNote
string | null
Min length0
Max length2147483647
PaymentReference
string Required
Min length1
Max length50
object
Amount
number (double) Required
Minimum0.01
BillingCompany
string | null
Min length0
Max length100
BillingContact
string | null
Min length0
Max length250
BranchName
string | null
Min length0
Max length50
InvoiceNumber
integer (int32) | null
PaymentDate
string (date-time) Required
PaymentMethod
string Required
Min length1
Max length20
PaymentNote
string | null
Min length0
Max length2147483647
PaymentReference
string Required
Min length1
Max length50
object
Amount
number (double) Required
Minimum0.01
BillingCompany
string | null
Min length0
Max length100
BillingContact
string | null
Min length0
Max length250
BranchName
string | null
Min length0
Max length50
InvoiceNumber
integer (int32) | null
PaymentDate
string (date-time) Required
PaymentMethod
string Required
Min length1
Max length20
PaymentNote
string | null
Min length0
Max length2147483647
PaymentReference
string Required
Min length1
Max length50
object
Amount
number (double) Required
Minimum0.01
BillingCompany
string | null
Min length0
Max length100
BillingContact
string | null
Min length0
Max length250
BranchName
string | null
Min length0
Max length50
InvoiceNumber
integer (int32) | null
PaymentDate
string (date-time) Required
PaymentMethod
string Required
Min length1
Max length20
PaymentNote
string | null
Min length0
Max length2147483647
PaymentReference
string Required
Min length1
Max length50
object
Amount
number (double) Required
Minimum0.01
BillingCompany
string | null
Min length0
Max length100
BillingContact
string | null
Min length0
Max length250
BranchName
string | null
Min length0
Max length50
InvoiceNumber
integer (int32) | null
PaymentDate
string (date-time) Required
PaymentMethod
string Required
Min length1
Max length20
PaymentNote
string | null
Min length0
Max length2147483647
PaymentReference
string Required
Min length1
Max length50
object
Amount
number (double) Required
Minimum0.01
BillingCompany
string | null
Min length0
Max length100
BillingContact
string | null
Min length0
Max length250
BranchName
string | null
Min length0
Max length50
InvoiceNumber
integer (int32) | null
PaymentDate
string (date-time) Required
PaymentMethod
string Required
Min length1
Max length20
PaymentNote
string | null
Min length0
Max length2147483647
PaymentReference
string Required
Min length1
Max length50
object
Amount
number (double) Required
Minimum0.01
BillingCompany
string | null
Min length0
Max length100
BillingContact
string | null
Min length0
Max length250
BranchName
string | null
Min length0
Max length50
InvoiceNumber
integer (int32) | null
PaymentDate
string (date-time) Required
PaymentMethod
string Required
Min length1
Max length20
PaymentNote
string | null
Min length0
Max length2147483647
PaymentReference
string Required
Min length1
Max length50
object
Amount
number (double) Required
Minimum0.01
BillingCompany
string | null
Min length0
Max length100
BillingContact
string | null
Min length0
Max length250
BranchName
string | null
Min length0
Max length50
InvoiceNumber
integer (int32) | null
PaymentDate
string (date-time) Required
PaymentMethod
string Required
Min length1
Max length20
PaymentNote
string | null
Min length0
Max length2147483647
PaymentReference
string Required
Min length1
Max length50
object
Amount
number (double) Required
Minimum0.01
BillingCompany
string | null
Min length0
Max length100
BillingContact
string | null
Min length0
Max length250
BranchName
string | null
Min length0
Max length50
InvoiceNumber
integer (int32) | null
PaymentDate
string (date-time) Required
PaymentMethod
string Required
Min length1
Max length20
PaymentNote
string | null
Min length0
Max length2147483647
PaymentReference
string Required
Min length1
Max length50
object
Amount
number (double) Required
Minimum0.01
BillingCompany
string | null
Min length0
Max length100
BillingContact
string | null
Min length0
Max length250
BranchName
string | null
Min length0
Max length50
InvoiceNumber
integer (int32) | null
PaymentDate
string (date-time) Required
PaymentMethod
string Required
Min length1
Max length20
PaymentNote
string | null
Min length0
Max length2147483647
PaymentReference
string Required
Min length1
Max length50
object
Amount
number (double) Required
Minimum0.01
BillingCompany
string | null
Min length0
Max length100
BillingContact
string | null
Min length0
Max length250
BranchName
string | null
Min length0
Max length50
InvoiceNumber
integer (int32) | null
PaymentDate
string (date-time) Required
PaymentMethod
string Required
Min length1
Max length20
PaymentNote
string | null
Min length0
Max length2147483647
PaymentReference
string Required
Min length1
Max length50
object
Amount
number (double) Required
Minimum0.01
BillingCompany
string | null
Min length0
Max length100
BillingContact
string | null
Min length0
Max length250
BranchName
string | null
Min length0
Max length50
InvoiceNumber
integer (int32) | null
PaymentDate
string (date-time) Required
PaymentMethod
string Required
Min length1
Max length20
PaymentNote
string | null
Min length0
Max length2147483647
PaymentReference
string Required
Min length1
Max length50
object
Amount
number (double) Required
Minimum0.01
BillingCompany
string | null
Min length0
Max length100
BillingContact
string | null
Min length0
Max length250
BranchName
string | null
Min length0
Max length50
InvoiceNumber
integer (int32) | null
PaymentDate
string (date-time) Required
PaymentMethod
string Required
Min length1
Max length20
PaymentNote
string | null
Min length0
Max length2147483647
PaymentReference
string Required
Min length1
Max length50
object
Amount
number (double) Required
Minimum0.01
BillingCompany
string | null
Min length0
Max length100
BillingContact
string | null
Min length0
Max length250
BranchName
string | null
Min length0
Max length50
InvoiceNumber
integer (int32) | null
PaymentDate
string (date-time) Required
PaymentMethod
string Required
Min length1
Max length20
PaymentNote
string | null
Min length0
Max length2147483647
PaymentReference
string Required
Min length1
Max length50
object
Amount
number (double) Required
Minimum0.01
BillingCompany
string | null
Min length0
Max length100
BillingContact
string | null
Min length0
Max length250
BranchName
string | null
Min length0
Max length50
InvoiceNumber
integer (int32) | null
PaymentDate
string (date-time) Required
PaymentMethod
string Required
Min length1
Max length20
PaymentNote
string | null
Min length0
Max length2147483647
PaymentReference
string Required
Min length1
Max length50
object
Amount
number (double) Required
Minimum0.01
BillingCompany
string | null
Min length0
Max length100
BillingContact
string | null
Min length0
Max length250
BranchName
string | null
Min length0
Max length50
InvoiceNumber
integer (int32) | null
PaymentDate
string (date-time) Required
PaymentMethod
string Required
Min length1
Max length20
PaymentNote
string | null
Min length0
Max length2147483647
PaymentReference
string Required
Min length1
Max length50
object
Amount
number (double) Required
Minimum0.01
BillingCompany
string | null
Min length0
Max length100
BillingContact
string | null
Min length0
Max length250
BranchName
string | null
Min length0
Max length50
InvoiceNumber
integer (int32) | null
PaymentDate
string (date-time) Required
PaymentMethod
string Required
Min length1
Max length20
PaymentNote
string | null
Min length0
Max length2147483647
PaymentReference
string Required
Min length1
Max length50
object
Amount
number (double) Required
Minimum0.01
BillingCompany
string | null
Min length0
Max length100
BillingContact
string | null
Min length0
Max length250
BranchName
string | null
Min length0
Max length50
InvoiceNumber
integer (int32) | null
PaymentDate
string (date-time) Required
PaymentMethod
string Required
Min length1
Max length20
PaymentNote
string | null
Min length0
Max length2147483647
PaymentReference
string Required
Min length1
Max length50
object
Amount
number (double) Required
Minimum0.01
BillingCompany
string | null
Min length0
Max length100
BillingContact
string | null
Min length0
Max length250
BranchName
string | null
Min length0
Max length50
InvoiceNumber
integer (int32) | null
PaymentDate
string (date-time) Required
PaymentMethod
string Required
Min length1
Max length20
PaymentNote
string | null
Min length0
Max length2147483647
PaymentReference
string Required
Min length1
Max length50
object
Amount
number (double) Required
Minimum0.01
BillingCompany
string | null
Min length0
Max length100
BillingContact
string | null
Min length0
Max length250
BranchName
string | null
Min length0
Max length50
InvoiceNumber
integer (int32) | null
PaymentDate
string (date-time) Required
PaymentMethod
string Required
Min length1
Max length20
PaymentNote
string | null
Min length0
Max length2147483647
PaymentReference
string Required
Min length1
Max length50
object
Amount
number (double) Required
Minimum0.01
BillingCompany
string | null
Min length0
Max length100
BillingContact
string | null
Min length0
Max length250
BranchName
string | null
Min length0
Max length50
InvoiceNumber
integer (int32) | null
PaymentDate
string (date-time) Required
PaymentMethod
string Required
Min length1
Max length20
PaymentNote
string | null
Min length0
Max length2147483647
PaymentReference
string Required
Min length1
Max length50
object
Amount
number (double) Required
Minimum0.01
BillingCompany
string | null
Min length0
Max length100
BillingContact
string | null
Min length0
Max length250
BranchName
string | null
Min length0
Max length50
InvoiceNumber
integer (int32) | null
PaymentDate
string (date-time) Required
PaymentMethod
string Required
Min length1
Max length20
PaymentNote
string | null
Min length0
Max length2147483647
PaymentReference
string Required
Min length1
Max length50
object
Amount
number (double) Required
Minimum0.01
BillingCompany
string | null
Min length0
Max length100
BillingContact
string | null
Min length0
Max length250
BranchName
string | null
Min length0
Max length50
InvoiceNumber
integer (int32) | null
PaymentDate
string (date-time) Required
PaymentMethod
string Required
Min length1
Max length20
PaymentNote
string | null
Min length0
Max length2147483647
PaymentReference
string Required
Min length1
Max length50
object
Amount
number (double) Required
Minimum0.01
BillingCompany
string | null
Min length0
Max length100
BillingContact
string | null
Min length0
Max length250
BranchName
string | null
Min length0
Max length50
InvoiceNumber
integer (int32) | null
PaymentDate
string (date-time) Required
PaymentMethod
string Required
Min length1
Max length20
PaymentNote
string | null
Min length0
Max length2147483647
PaymentReference
string Required
Min length1
Max length50
object
Amount
number (double) Required
Minimum0.01
BillingCompany
string | null
Min length0
Max length100
BillingContact
string | null
Min length0
Max length250
BranchName
string | null
Min length0
Max length50
InvoiceNumber
integer (int32) | null
PaymentDate
string (date-time) Required
PaymentMethod
string Required
Min length1
Max length20
PaymentNote
string | null
Min length0
Max length2147483647
PaymentReference
string Required
Min length1
Max length50
object
Amount
number (double) Required
Minimum0.01
BillingCompany
string | null
Min length0
Max length100
BillingContact
string | null
Min length0
Max length250
BranchName
string | null
Min length0
Max length50
InvoiceNumber
integer (int32) | null
PaymentDate
string (date-time) Required
PaymentMethod
string Required
Min length1
Max length20
PaymentNote
string | null
Min length0
Max length2147483647
PaymentReference
string Required
Min length1
Max length50
object
Amount
number (double) Required
Minimum0.01
BillingCompany
string | null
Min length0
Max length100
BillingContact
string | null
Min length0
Max length250
BranchName
string | null
Min length0
Max length50
InvoiceNumber
integer (int32) | null
PaymentDate
string (date-time) Required
PaymentMethod
string Required
Min length1
Max length20
PaymentNote
string | null
Min length0
Max length2147483647
PaymentReference
string Required
Min length1
Max length50
Responses
200

OK

string
string
string
string
string
string
string
string
string
string
string
string
string
string
string
string
string
string
string
string
string
string
string
string
string
string
string
string
string
string
string
string
string
string
string
string
string
string
string
string

Was this article helpful?

What's Next
Changing your password will log you out immediately. Use the new password to log back in.
First name must have atleast 2 characters. Numbers and special characters are not allowed.
Last name must have atleast 1 characters. Numbers and special characters are not allowed.
Enter a valid email
Enter a valid password
Your profile has been successfully updated.