API docs by Redocly

Contract Installment API (1.0.0)

Download OpenAPI specification:Download

API for managing contract installments

Contract Installment

Contract installment management operations

Get all contract installments

Retrieve a list of all contract installments with optional filtering and pagination

Authorizations:
ApiKeyAuth
query Parameters
page
integer >= 1
Default: 1

Page number for pagination

per_page
integer [ 1 .. 100 ]
Default: 25

Number of items per page

sort
string

Sort field

company_namespace
Array of strings

Company namespace for filtering

contract
string

Filter by contract ID

status
string
Enum: "pending" "paid" "overdue" "cancelled"

Filter by payment status

due_date_from
string <date>

Filter by due date from

due_date_to
string <date>

Filter by due date to

_id
Array of strings

Filter by ID

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "paging": {
    }
}

Create a new contract installment

Create a new contract installment

Authorizations:
ApiKeyAuth
Request Body schema: application/json
contract
required
string

Contract ID reference

installment_number
required
integer

Installment sequence number

due_date
required
string <date>

Due date for this installment

amount
required
number <float>

Installment amount

currency
string
Default: "USD"

Currency code

late_fee
number <float>
Default: 0

Late fee charged if overdue

discount_applied
number <float>
Default: 0

Discount applied to this installment

interest_rate
number <float>
Default: 0

Interest rate for this installment

grace_period_days
integer
Default: 0

Grace period in days before marking overdue

auto_pay_enabled
boolean
Default: false

Whether auto-pay is enabled for this installment

notes
string

Additional notes

custom_fields
object

Custom fields for additional data

company_namespace
Array of strings

Company namespace

Responses

Request samples

Content type
application/json
{
  • "contract": "507f1f77bcf86cd799439012",
  • "installment_number": 1,
  • "due_date": "2024-01-15",
  • "amount": 1500,
  • "currency": "USD",
  • "late_fee": 0,
  • "discount_applied": 0,
  • "interest_rate": 0,
  • "grace_period_days": 0,
  • "auto_pay_enabled": false,
  • "notes": "string",
  • "custom_fields": { },
  • "company_namespace": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Get contract installment by ID

Retrieve a specific contract installment by its ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Contract installment ID

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Update contract installment

Update an existing contract installment

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Contract installment ID

Request Body schema: application/json
due_date
string <date>

Due date for this installment

amount
number <float>

Installment amount

status
string
Enum: "pending" "paid" "overdue" "cancelled"

Payment status

payment_date
string <date>

Date when payment was made

payment_amount
number <float>

Amount actually paid

payment_method
string
Enum: "cash" "check" "credit_card" "bank_transfer" "other"

Payment method used

payment_reference
string

Payment reference number

late_fee
number <float>

Late fee charged if overdue

discount_applied
number <float>

Discount applied to this installment

interest_rate
number <float>

Interest rate for this installment

grace_period_days
integer

Grace period in days before marking overdue

auto_pay_enabled
boolean

Whether auto-pay is enabled for this installment

notes
string

Additional notes

custom_fields
object

Custom fields for additional data

company_namespace
Array of strings

Company namespace

Responses

Request samples

Content type
application/json
{
  • "due_date": "2019-08-24",
  • "amount": 0,
  • "status": "pending",
  • "payment_date": "2019-08-24",
  • "payment_amount": 0,
  • "payment_method": "cash",
  • "payment_reference": "string",
  • "late_fee": 0,
  • "discount_applied": 0,
  • "interest_rate": 0,
  • "grace_period_days": 0,
  • "auto_pay_enabled": true,
  • "notes": "string",
  • "custom_fields": { },
  • "company_namespace": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Delete contract installment

Delete a contract installment by ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Contract installment ID

Responses

Response samples

Content type
application/json
{
  • "success": true
}

Mark installment as paid

Mark a contract installment as paid

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Contract installment ID

Request Body schema: application/json
payment_date
required
string <date>

Date of payment

payment_amount
required
number <float>

Amount paid

payment_method
string
Enum: "cash" "check" "credit_card" "bank_transfer" "other"

Payment method used

payment_reference
string

Payment reference number

notes
string

Payment notes

Responses

Request samples

Content type
application/json
{
  • "payment_date": "2019-08-24",
  • "payment_amount": 0,
  • "payment_method": "cash",
  • "payment_reference": "string",
  • "notes": "string"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Get overdue installments

Get all overdue contract installments

Authorizations:
ApiKeyAuth
query Parameters
page
integer >= 1
Default: 1

Page number for pagination

per_page
integer [ 1 .. 100 ]
Default: 25

Number of items per page

days_overdue
integer >= 0

Minimum days overdue

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "paging": {
    }
}