Charge

Retrieve A Specific Charge

HTTP Request

GET /api/v1/charges/{id}

Interactive Demo

📋 Description: Retrieves detailed information about a specific charge associated with a lease or contract, providing insights into financial obligations and accounting entries within the Nakisa Lease Accounting Suite.

Parameters

Name	In	Type	Required	Description
id	path	integer	true	Unique identifier for the resource

Example Values

Parameter	Example	Type
id	20000001	path

Responses

Status	Meaning	Description	Schema
200	OK	Successfully retrieved charge.	ResponseChargeDto

Example Responses

{
  "code": "OK",
  "errors": {
    "all": []
  },
  "object": {
    "id": 20000001,
    "displayId": "CHG-0001",
    "name": "Office Supplies Purchase",
    "description": "Charge for Q1 office supplies procurement.",
    "dueDate": "2025-12-31",
    "amount": 1250.5,
    "hasPostedDocument": false,
    "fiscalYear": 2025,
    "fiscalPeriod": 3,
    "expenseCategory": {
      "id": 101,
      "displayId": "EC-2025-001",
      "status": {
        "name": "ACTIVE",
        "captionKey": "enum.objectStatus.active",
        "active": true,
        "caption": "Active"
      },
      "name": "Lease Payment",
      "expenseCategoryType": "PAYMENT"
    },
    "unitId": 30001,
    "unitDisplayId": "UNIT-0005",
    "activationGroupId": 4001,
    "vendorPaymentSplits": [],
    "numberRangeIdentifierValue": "BU-01",
    "numberRangeIdentifierType": {
      "name": "COMPANY_CODE"
    },
    "numberRangeType": {
      "name": "CONTRACT"
    },
    "allowsSystemGenerateNewId": true
  }
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Update A Specific Charge

HTTP Request

PUT /api/v1/charges/{id}

Interactive Demo

📋 Description: Updates the details of a specific charge identified by its ID within the Nakisa Lease Accounting Suite, ensuring that financial obligations and accounting entries related to leases and contracts are accurately maintained.

Parameters

Name	In	Type	Required	Description
id	path	integer	true	Unique identifier for the resource
body	body	ChargeDto	false	Request body containing the updated financial obligation details for the specified lease contract, including relevant accounting entry information.

Example Values

Parameter	Example	Type
id	20000001	path

Body Parameters

{
  "id": 20000001,
  "displayId": "CHG-0001",
  "name": "Office Supplies Purchase",
  "description": "Charge for Q1 office supplies procurement.",
  "dueDate": "2025-12-31",
  "amount": 1250.5,
  "hasPostedDocument": false,
  "fiscalYear": 2025,
  "fiscalPeriod": 3,
  "expenseCategory": {
    "id": 101,
    "displayId": "EC-2025-001",
    "status": {
      "name": "ACTIVE",
      "captionKey": "enum.objectStatus.active",
      "active": true,
      "caption": "Active"
    },
    "name": "Lease Payment",
    "expenseCategoryType": "PAYMENT"
  },
  "unitId": 30001,
  "unitDisplayId": "UNIT-0005",
  "activationGroupId": 4001,
  "vendorPaymentSplits": [],
  "numberRangeIdentifierValue": "BU-01",
  "numberRangeIdentifierType": {
    "name": "COMPANY_CODE"
  },
  "numberRangeType": {
    "name": "CONTRACT"
  },
  "allowsSystemGenerateNewId": true
}

Responses

Status	Meaning	Description	Schema
200	OK	Charge successfully updated.	ResponseChargeDto

Example Responses

{
  "code": "OK",
  "errors": {
    "all": []
  },
  "object": {
    "id": 20000001,
    "displayId": "CHG-0001",
    "name": "Office Supplies Purchase",
    "description": "Charge for Q1 office supplies procurement.",
    "dueDate": "2025-12-31",
    "amount": 1250.5,
    "hasPostedDocument": false,
    "fiscalYear": 2025,
    "fiscalPeriod": 3,
    "expenseCategory": {
      "id": 101,
      "displayId": "EC-2025-001",
      "status": {
        "name": "ACTIVE",
        "captionKey": "enum.objectStatus.active",
        "active": true,
        "caption": "Active"
      },
      "name": "Lease Payment",
      "expenseCategoryType": "PAYMENT"
    },
    "unitId": 30001,
    "unitDisplayId": "UNIT-0005",
    "activationGroupId": 4001,
    "vendorPaymentSplits": [],
    "numberRangeIdentifierValue": "BU-01",
    "numberRangeIdentifierType": {
      "name": "COMPANY_CODE"
    },
    "numberRangeType": {
      "name": "CONTRACT"
    },
    "allowsSystemGenerateNewId": true
  }
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Delete A Specific Charge

HTTP Request

DELETE /api/v1/charges/{id}

Interactive Demo

📋 Description: Deletes a specified charge from the Nakisa Lease Accounting Suite, ensuring the accurate management of financial obligations and contract entries within the lease accounting framework.

Parameters

Name	In	Type	Required	Description
id	path	integer	true	Unique identifier for the resource

Example Values

Parameter	Example	Type
id	20000001	path

Responses

Status	Meaning	Description	Schema
200	OK	Charge successfully deleted.	ResponseVoid

Example Responses

{
  "code": "OK",
  "errors": {
    "all": []
  },
  "object": {}
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Partially Update A Charge

HTTP Request

PATCH /api/v1/charges/{id}

Interactive Demo

📋 Description: Updates the details of a specific charge associated with a lease or contract in the Nakisa Lease Accounting Suite, allowing for adjustments to financial obligations and accounting entries.

Parameters

Name	In	Type	Required	Description
id	path	integer	true	Unique identifier for the resource
body	body	JsonPatch	false	Request body containing updated financial obligation details for the specified lease contract, including relevant accounting entry adjustments.

Example Values

Parameter	Example	Type
id	20000001	path
body	{"op":"replace","path":"/name","value":"patched contract"}	body

Body Parameters

{
  "op": "replace",
  "path": "/name",
  "value": "patched contract"
}

Responses

Status	Meaning	Description	Schema
200	OK	Successfully patched charge.	ResponseChargeDto

Example Responses

{
  "code": "OK",
  "errors": {
    "all": []
  },
  "object": {
    "id": 20000001,
    "displayId": "CHG-0001",
    "name": "Office Supplies Purchase",
    "description": "Charge for Q1 office supplies procurement.",
    "dueDate": "2025-12-31",
    "amount": 1250.5,
    "hasPostedDocument": false,
    "fiscalYear": 2025,
    "fiscalPeriod": 3,
    "expenseCategory": {
      "id": 101,
      "displayId": "EC-2025-001",
      "status": {
        "name": "ACTIVE",
        "captionKey": "enum.objectStatus.active",
        "active": true,
        "caption": "Active"
      },
      "name": "Lease Payment",
      "expenseCategoryType": "PAYMENT"
    },
    "unitId": 30001,
    "unitDisplayId": "UNIT-0005",
    "activationGroupId": 4001,
    "vendorPaymentSplits": [],
    "numberRangeIdentifierValue": "BU-01",
    "numberRangeIdentifierType": {
      "name": "COMPANY_CODE"
    },
    "numberRangeType": {
      "name": "CONTRACT"
    },
    "allowsSystemGenerateNewId": true
  }
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Create Or Update A Charge

HTTP Request

PUT /api/v1/charges/createOrUpdate

Interactive Demo

📋 Description: Creates or updates financial obligations related to leases and contracts within the Nakisa Lease Accounting Suite, ensuring accurate accounting entries are maintained.

Parameters

Name	In	Type	Required	Description
body	body	ChargeDto	false	Request body containing the lease and contract details, including financial obligations and accounting entries, for creating or updating charge records within the Nakisa Lease Accounting Suite.

Body Parameters

{
  "id": 20000001,
  "displayId": "CHG-0001",
  "name": "Office Supplies Purchase",
  "description": "Charge for Q1 office supplies procurement.",
  "dueDate": "2025-12-31",
  "amount": 1250.5,
  "hasPostedDocument": false,
  "fiscalYear": 2025,
  "fiscalPeriod": 3,
  "expenseCategory": {
    "id": 101,
    "displayId": "EC-2025-001",
    "status": {
      "name": "ACTIVE",
      "captionKey": "enum.objectStatus.active",
      "active": true,
      "caption": "Active"
    },
    "name": "Lease Payment",
    "expenseCategoryType": "PAYMENT"
  },
  "unitId": 30001,
  "unitDisplayId": "UNIT-0005",
  "activationGroupId": 4001,
  "vendorPaymentSplits": [],
  "numberRangeIdentifierValue": "BU-01",
  "numberRangeIdentifierType": {
    "name": "COMPANY_CODE"
  },
  "numberRangeType": {
    "name": "CONTRACT"
  },
  "allowsSystemGenerateNewId": true
}

Responses

Status	Meaning	Description	Schema
200	OK	Charge successfully created or updated.	ResponseChargeDto

Example Responses

{
  "code": "OK",
  "errors": {
    "all": []
  },
  "object": {
    "id": 20000001,
    "displayId": "CHG-0001",
    "name": "Office Supplies Purchase",
    "description": "Charge for Q1 office supplies procurement.",
    "dueDate": "2025-12-31",
    "amount": 1250.5,
    "hasPostedDocument": false,
    "fiscalYear": 2025,
    "fiscalPeriod": 3,
    "expenseCategory": {
      "id": 101,
      "displayId": "EC-2025-001",
      "status": {
        "name": "ACTIVE",
        "captionKey": "enum.objectStatus.active",
        "active": true,
        "caption": "Active"
      },
      "name": "Lease Payment",
      "expenseCategoryType": "PAYMENT"
    },
    "unitId": 30001,
    "unitDisplayId": "UNIT-0005",
    "activationGroupId": 4001,
    "vendorPaymentSplits": [],
    "numberRangeIdentifierValue": "BU-01",
    "numberRangeIdentifierType": {
      "name": "COMPANY_CODE"
    },
    "numberRangeType": {
      "name": "CONTRACT"
    },
    "allowsSystemGenerateNewId": true
  }
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Bulk Create Or Update Charges

HTTP Request

PUT /api/v1/charges/createOrUpdate/bulk

Interactive Demo

📋 Description: Creates or updates multiple charges in bulk within the Nakisa Lease Accounting Suite, streamlining the management of leases, contracts, and financial obligations for efficient accounting entry processing.

Parameters

Name	In	Type	Required	Description
body	body	ChargeDto	false	Request body containing bulk charge data for lease and contract financial obligations, including relevant accounting entry details for creation or updates.

Body Parameters

[
  {
    "id": 20000001,
    "displayId": "CHG-0001",
    "name": "Office Supplies Purchase",
    "description": "Charge for Q1 office supplies procurement.",
    "dueDate": "2025-12-31",
    "amount": 1250.5,
    "hasPostedDocument": false,
    "fiscalYear": 2025,
    "fiscalPeriod": 3,
    "expenseCategory": {
      "id": 101,
      "displayId": "EC-2025-001",
      "status": {
        "name": "ACTIVE",
        "captionKey": "enum.objectStatus.active",
        "active": true,
        "caption": "Active"
      },
      "name": "Lease Payment",
      "expenseCategoryType": "PAYMENT"
    },
    "unitId": 30001,
    "unitDisplayId": "UNIT-0005",
    "activationGroupId": 4001,
    "vendorPaymentSplits": [],
    "numberRangeIdentifierValue": "BU-01",
    "numberRangeIdentifierType": {
      "name": "COMPANY_CODE"
    },
    "numberRangeType": {
      "name": "CONTRACT"
    },
    "allowsSystemGenerateNewId": true
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	Charges successfully created or updated in bulk.	ResponseListChargeDto

Example Responses

{
  "code": "OK",
  "errors": {
    "all": []
  },
  "object": [
    {
      "id": 20000001,
      "displayId": "CHG-0001",
      "name": "Office Supplies Purchase",
      "description": "Charge for Q1 office supplies procurement.",
      "dueDate": "2025-12-31",
      "amount": 1250.5,
      "hasPostedDocument": false,
      "fiscalYear": 2025,
      "fiscalPeriod": 3,
      "expenseCategory": {
        "id": 101,
        "displayId": "EC-2025-001",
        "status": {
          "name": "ACTIVE",
          "captionKey": "enum.objectStatus.active",
          "active": true,
          "caption": "Active"
        },
        "name": "Lease Payment",
        "expenseCategoryType": "PAYMENT"
      },
      "unitId": 30001,
      "unitDisplayId": "UNIT-0005",
      "activationGroupId": 4001,
      "vendorPaymentSplits": [],
      "numberRangeIdentifierValue": "BU-01",
      "numberRangeIdentifierType": {
        "name": "COMPANY_CODE"
      },
      "numberRangeType": {
        "name": "CONTRACT"
      },
      "allowsSystemGenerateNewId": true
    }
  ]
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Update Charges In Bulk

HTTP Request

PUT /api/v1/charges/bulk

Interactive Demo

📋 Description: Updates multiple charges in bulk for leases and contracts within the Nakisa Lease Accounting Suite, ensuring accurate financial obligation management and streamlined accounting entries.

Parameters

Name	In	Type	Required	Description
body	body	ChargeDto	false	Request body containing a collection of charge entries, including lease details and associated financial obligations, for bulk processing within the Nakisa Lease Accounting Suite.

Body Parameters

[
  {
    "id": 20000001,
    "displayId": "CHG-0001",
    "name": "Office Supplies Purchase",
    "description": "Charge for Q1 office supplies procurement.",
    "dueDate": "2025-12-31",
    "amount": 1250.5,
    "hasPostedDocument": false,
    "fiscalYear": 2025,
    "fiscalPeriod": 3,
    "expenseCategory": {
      "id": 101,
      "displayId": "EC-2025-001",
      "status": {
        "name": "ACTIVE",
        "captionKey": "enum.objectStatus.active",
        "active": true,
        "caption": "Active"
      },
      "name": "Lease Payment",
      "expenseCategoryType": "PAYMENT"
    },
    "unitId": 30001,
    "unitDisplayId": "UNIT-0005",
    "activationGroupId": 4001,
    "vendorPaymentSplits": [],
    "numberRangeIdentifierValue": "BU-01",
    "numberRangeIdentifierType": {
      "name": "COMPANY_CODE"
    },
    "numberRangeType": {
      "name": "CONTRACT"
    },
    "allowsSystemGenerateNewId": true
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	Charges successfully updated in bulk.	ResponseListChargeDto

Example Responses

{
  "code": "OK",
  "errors": {
    "all": []
  },
  "object": [
    {
      "id": 20000001,
      "displayId": "CHG-0001",
      "name": "Office Supplies Purchase",
      "description": "Charge for Q1 office supplies procurement.",
      "dueDate": "2025-12-31",
      "amount": 1250.5,
      "hasPostedDocument": false,
      "fiscalYear": 2025,
      "fiscalPeriod": 3,
      "expenseCategory": {
        "id": 101,
        "displayId": "EC-2025-001",
        "status": {
          "name": "ACTIVE",
          "captionKey": "enum.objectStatus.active",
          "active": true,
          "caption": "Active"
        },
        "name": "Lease Payment",
        "expenseCategoryType": "PAYMENT"
      },
      "unitId": 30001,
      "unitDisplayId": "UNIT-0005",
      "activationGroupId": 4001,
      "vendorPaymentSplits": [],
      "numberRangeIdentifierValue": "BU-01",
      "numberRangeIdentifierType": {
        "name": "COMPANY_CODE"
      },
      "numberRangeType": {
        "name": "CONTRACT"
      },
      "allowsSystemGenerateNewId": true
    }
  ]
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Create Charges In Bulk

HTTP Request

POST /api/v1/charges/bulk

Interactive Demo

📋 Description: Submits multiple charges in bulk for processing within the Nakisa Lease Accounting Suite, facilitating efficient management of lease-related financial obligations and accounting entries.

Parameters

Name	In	Type	Required	Description
body	body	ChargeDto	false	Request body containing a collection of lease and contract financial obligation data for bulk processing of accounting entries.

Body Parameters

[
  {
    "id": 20000001,
    "displayId": "CHG-0001",
    "name": "Office Supplies Purchase",
    "description": "Charge for Q1 office supplies procurement.",
    "dueDate": "2025-12-31",
    "amount": 1250.5,
    "hasPostedDocument": false,
    "fiscalYear": 2025,
    "fiscalPeriod": 3,
    "expenseCategory": {
      "id": 101,
      "displayId": "EC-2025-001",
      "status": {
        "name": "ACTIVE",
        "captionKey": "enum.objectStatus.active",
        "active": true,
        "caption": "Active"
      },
      "name": "Lease Payment",
      "expenseCategoryType": "PAYMENT"
    },
    "unitId": 30001,
    "unitDisplayId": "UNIT-0005",
    "activationGroupId": 4001,
    "vendorPaymentSplits": [],
    "numberRangeIdentifierValue": "BU-01",
    "numberRangeIdentifierType": {
      "name": "COMPANY_CODE"
    },
    "numberRangeType": {
      "name": "CONTRACT"
    },
    "allowsSystemGenerateNewId": true
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	Charges successfully created in bulk.	ResponseListChargeDto

Example Responses

{
  "code": "OK",
  "errors": {
    "all": []
  },
  "object": [
    {
      "id": 20000001,
      "displayId": "CHG-0001",
      "name": "Office Supplies Purchase",
      "description": "Charge for Q1 office supplies procurement.",
      "dueDate": "2025-12-31",
      "amount": 1250.5,
      "hasPostedDocument": false,
      "fiscalYear": 2025,
      "fiscalPeriod": 3,
      "expenseCategory": {
        "id": 101,
        "displayId": "EC-2025-001",
        "status": {
          "name": "ACTIVE",
          "captionKey": "enum.objectStatus.active",
          "active": true,
          "caption": "Active"
        },
        "name": "Lease Payment",
        "expenseCategoryType": "PAYMENT"
      },
      "unitId": 30001,
      "unitDisplayId": "UNIT-0005",
      "activationGroupId": 4001,
      "vendorPaymentSplits": [],
      "numberRangeIdentifierValue": "BU-01",
      "numberRangeIdentifierType": {
        "name": "COMPANY_CODE"
      },
      "numberRangeType": {
        "name": "CONTRACT"
      },
      "allowsSystemGenerateNewId": true
    }
  ]
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Delete Charges In Bulk

HTTP Request

DELETE /api/v1/charges/bulk

Interactive Demo

📋 Description: Deletes multiple charge entries in bulk from the Nakisa Lease Accounting Suite, streamlining the management of financial obligations associated with leases and contracts.

Parameters

Name	In	Type	Required	Description
body	body	array[integer]	false	Request body containing an array of charge identifiers to facilitate the bulk deletion of financial obligations related to leases and contracts within the Nakisa Lease Accounting Suite.

Body Parameters

[
  0
]

Responses

Status	Meaning	Description	Schema
200	OK	Charges successfully deleted in bulk.	ResponseVoid

Example Responses

{
  "code": "OK",
  "errors": {
    "all": []
  },
  "object": {}
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Update Ai-Generated Charges

HTTP Request

PUT /api/v1/charges/ai/update-charges

Interactive Demo

📋 Description: Updates existing charge records within the Nakisa Lease Accounting Suite, ensuring accurate reflection of financial obligations associated with leases and contracts. This operation facilitates the maintenance of precise accounting entries by allowing modifications to charge details.

Parameters

Name	In	Type	Required	Description
body	body	ChargeLightDto	false	Request body containing updated charge information related to lease contracts, including financial obligations and accounting entries.

Body Parameters

[
  {
    "amount": "1500.00",
    "description": "Rent payment for January 2025",
    "dueDate": "2025-01-31",
    "expenseCategory": "PAYMENT",
    "id": 20000001,
    "name": "Monthly Rent Payment",
    "unitId": 30001,
    "unitDisplayId": "UNIT-0005",
    "vendorPaymentSplits": "Vendor A: 50%, Vendor B: 50%"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	AI-generated charges successfully updated.	Inline

Example Responses

[
  {
    "id": 20000001,
    "displayId": "CHG-0001",
    "name": "Office Supplies Purchase",
    "description": "Charge for Q1 office supplies procurement.",
    "dueDate": "2025-12-31",
    "amount": 1250.5,
    "hasPostedDocument": false,
    "fiscalYear": 2025,
    "fiscalPeriod": 3,
    "expenseCategory": {
      "id": 101,
      "displayId": "EC-2025-001",
      "status": {
        "name": "ACTIVE",
        "captionKey": "enum.objectStatus.active",
        "active": true,
        "caption": "Active"
      },
      "name": "Lease Payment",
      "expenseCategoryType": "PAYMENT"
    },
    "unitId": 30001,
    "unitDisplayId": "UNIT-0005",
    "activationGroupId": 4001,
    "vendorPaymentSplits": [],
    "numberRangeIdentifierValue": "BU-01",
    "numberRangeIdentifierType": {
      "name": "COMPANY_CODE"
    },
    "numberRangeType": {
      "name": "CONTRACT"
    },
    "allowsSystemGenerateNewId": true
  }
]

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[ChargeDto]	false	none	[Data transfer object representing a financial charge associated with a lease or contract, encapsulating key details necessary for accounting entries and financial obligation management within the Nakisa Lease Accounting Suite.]
» id	integer(int64)	false	none	Unique identifier for the resource
» displayId	string	false	none	Unique identifier for the display
» name	string	true	none	Name of the resource
» description	string¦null	false	none	Description of the resource
» dueDate	string(date)	true	none	Due date of the resource
» amount	number(double)	true	none	Amount value
» hasPostedDocument	boolean	false	none	Whether the resource has has posted document
» fiscalYear	integer(int64)	false	none	Numeric value representing fiscalYear
» fiscalPeriod	integer(int64)	false	none	Numeric value representing fiscalPeriod
» expenseCategory	ExpenseCategoryLite	true	none	Data transfer object representing a simplified categorization of expenses related to leases and contracts within the Nakisa Lease Accounting Suite, facilitating efficient tracking and management of financial obligations and accounting entries.
»» id	integer(int64)	false	none	Unique identifier for the resource
»» displayId	string	false	none	Unique identifier for the display
»» status	Status	false	none	Represents the object status with localized captions and activity state.
»»» name	string	false	none	Enum name representing the object status.
»»» captionKey	string	false	none	Localization key for the object status caption.
»»» active	boolean	false	none	Indicates whether the status is active.
»»» caption	string	false	none	Localized caption of the object status.
»» name	string	false	none	Name of the resource
»» expenseCategoryType	string	false	none	Type of the expense category
» unitId	integer(int64)	true	none	Unique identifier for the unit
» unitDisplayId	string	false	none	Unique identifier for the unit display
» activationGroupId	integer(int64)	true	none	Unique identifier for the activation group
» vendorPaymentSplits	[VendorPaymentSplitDto]	false	none	List of vendorPaymentSplits items
»» percentage	number(double)	false	none	Percentage value
»» calculateTax	boolean	false	none	Boolean flag indicating calculateTax status
»» taxExemptionPercentage	number(double)	false	none	Percentage of tax exemption
»» partner	PartnerLite	false	none	Data transfer object representing a simplified partner profile within the Nakisa Lease Accounting Suite, encompassing essential details related to lease agreements, financial obligations, and accounting entries.
»»» id	integer(int64)	false	none	Unique identifier for the resource
»»» displayId	string	false	none	Unique identifier for the display
»»» status	Status	false	none	Represents the object status with localized captions and activity state.
»»» name	string	false	none	Name of the resource
»»» erpSystemDisplayId	string	false	none	Unique identifier for the erp system display
»» partnerRole	PartnerRoleLite	false	none	Data transfer object representing a simplified partner role within the Nakisa Lease Accounting Suite, encompassing essential attributes related to lease agreements, contracts, and financial obligations for streamlined accounting entry management.
»»» id	integer(int64)	false	none	Unique identifier for the resource
»»» displayId	string	false	none	Unique identifier for the display
»»» status	Status	false	none	Represents the object status with localized captions and activity state.
»»» name	string	false	none	Name of the resource
»» taxCodeDetermination	TaxCodeDeterminationDetails	false	none	Data structure representing the details of tax code determination related to leases and contracts within the Nakisa Lease Accounting Suite, facilitating accurate financial obligation tracking and accounting entry management.
»»» id	integer(int64)	false	none	Unique identifier for the resource
»»» displayId	string	false	none	Unique identifier for the display
»»» companyId	integer(int64)	false	none	Unique identifier for the company
»»» partnerId	integer(int64)	false	none	none
»»» taxJurisdictionId	integer(int64)	false	none	Unique identifier for the tax jurisdiction
»»» taxJurisdictionDisplayId	string	false	none	Unique identifier for the tax jurisdiction display
»»» defaultTaxCodeId	integer(int64)	false	none	Unique identifier for the default tax code
»»» defaultTaxCodeDisplayId	string	false	none	Unique identifier for the default tax code display
»»» defaultExemptionTaxCodeId	integer(int64)	false	none	Unique identifier for the default exemption tax code
»»» defaultExemptionTaxCodeDisplayId	string	false	none	Unique identifier for the default exemption tax code display
»»» defaultExemptionPercentage	number(double)	false	none	Percentage of default exemption
»»» mapping	TaxCodeExpenseCategoryMappingDetails	false	none	Data transfer object representing the mapping of tax codes to expense categories within the Nakisa Lease Accounting Suite, facilitating accurate accounting entries and compliance with financial obligations related to leases and contracts.
»»»» isLeaseExpense	boolean	false	none	Whether the resource is lease expense
»»»» nonLeaseTaxCodeId	integer(int64)	false	none	Unique identifier for the non lease tax code
»»»» nonLeaseTaxCodeDisplayId	string	false	none	Unique identifier for the non lease tax code display
»»»» nonLeaseExemptionTaxCodeId	integer(int64)	false	none	Unique identifier for the non lease exemption tax code
»»»» nonLeaseExemptionTaxCodeDisplayId	string	false	none	Unique identifier for the non lease exemption tax code display
»»»» nonLeaseExemptionTaxPercentage	number(double)	false	none	Percentage of non lease exemption tax
»»»» principalTaxCodeId	integer(int64)	false	none	Unique identifier for the principal tax code
»»»» principalTaxCodeDisplayId	string	false	none	Unique identifier for the principal tax code display
»»»» principalExemptionTaxCodeId	integer(int64)	false	none	Unique identifier for the principal exemption tax code
»»»» principalExemptionTaxCodeDisplayId	string	false	none	Unique identifier for the principal exemption tax code display
»»»» principalExemptionTaxPercentage	number(double)	false	none	Percentage of principal exemption tax
» numberRangeIdentifierValue	string	false	none	Unique identifier for the range of numbers associated with a lease or contract, facilitating accurate tracking of financial obligations and accounting entries within the Nakisa Lease Accounting Suite.
» numberRangeIdentifierType	INumberRangeIdentifierType	false	none	Data structure representing a numerical range identifier used in the Nakisa Lease Accounting Suite to categorize and manage leases, contracts, and financial obligations within accounting entries.
»» name	string	true	none	Name of the resource
» numberRangeType	INumberRangeType	false	none	Data structure representing a numerical range utilized in the Nakisa Lease Accounting Suite, essential for defining financial obligations and accounting entries associated with leases and contracts.
»» name	string	true	none	Name of the resource
» allowsSystemGenerateNewId	boolean	false	none	Unique identifier for the allows system generate new

Enumerated Values

Attribute	Value
expenseCategoryType	CASH_INCENTIVE, CASUALTY, EXPECTED_GRV, INCENTIVE, NON_LEASE, PAYMENT, PURCHASE_OPTION, TERMINATION_OPTION
name	ACTIVE, CREATED, DECOMMISSIONED, DISABLED

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

List All Charges

HTTP Request

GET /api/v1/charges

Interactive Demo

📋 Description: Retrieves a list of charges associated with leases and contracts, providing insights into financial obligations and accounting entries within the Nakisa Lease Accounting Suite.

Parameters

Name	In	Type	Required	Description
page	query	integer	false	Page number (0-indexed)
size	query	integer	false	Number of items per page
sort	query	array[string]	false	Sorting criteria in format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

Default Values

Parameter	Default	Type
page	0	query
size	20	query

Parameter Constraints

Parameter	Constraints
page	Min: 0
size	Min: 1, Max: 100

Responses

Status	Meaning	Description	Schema
200	OK	Successfully retrieved list of charges.	PageChargeDto

Example Responses

{
  "totalElements": 10000001,
  "totalPages": 100,
  "pageable": {
    "pageNumber": 0,
    "unpaged": false,
    "paged": true,
    "pageSize": 100,
    "offset": 0,
    "sort": {
      "unsorted": false,
      "sorted": true,
      "empty": false
    }
  },
  "numberOfElements": 100,
  "size": 100,
  "content": [],
  "number": 0,
  "sort": {
    "unsorted": false,
    "sorted": true,
    "empty": false
  },
  "first": true,
  "last": false,
  "empty": false
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Create A New Charge

HTTP Request

POST /api/v1/charges

Interactive Demo

📋 Description: Creates a new charge entry within the Nakisa Lease Accounting Suite, allowing users to record financial obligations associated with leases and contracts for accurate accounting and reporting.

Parameters

Name	In	Type	Required	Description
body	body	ChargeDto	false	Request body containing the financial obligation details for a lease contract, including relevant accounting entry information.

Body Parameters

{
  "id": 20000001,
  "displayId": "CHG-0001",
  "name": "Office Supplies Purchase",
  "description": "Charge for Q1 office supplies procurement.",
  "dueDate": "2025-12-31",
  "amount": 1250.5,
  "hasPostedDocument": false,
  "fiscalYear": 2025,
  "fiscalPeriod": 3,
  "expenseCategory": {
    "id": 101,
    "displayId": "EC-2025-001",
    "status": {
      "name": "ACTIVE",
      "captionKey": "enum.objectStatus.active",
      "active": true,
      "caption": "Active"
    },
    "name": "Lease Payment",
    "expenseCategoryType": "PAYMENT"
  },
  "unitId": 30001,
  "unitDisplayId": "UNIT-0005",
  "activationGroupId": 4001,
  "vendorPaymentSplits": [],
  "numberRangeIdentifierValue": "BU-01",
  "numberRangeIdentifierType": {
    "name": "COMPANY_CODE"
  },
  "numberRangeType": {
    "name": "CONTRACT"
  },
  "allowsSystemGenerateNewId": true
}

Responses

Status	Meaning	Description	Schema
200	OK	Charge successfully created.	ResponseChargeDto

Example Responses

{
  "code": "OK",
  "errors": {
    "all": []
  },
  "object": {
    "id": 20000001,
    "displayId": "CHG-0001",
    "name": "Office Supplies Purchase",
    "description": "Charge for Q1 office supplies procurement.",
    "dueDate": "2025-12-31",
    "amount": 1250.5,
    "hasPostedDocument": false,
    "fiscalYear": 2025,
    "fiscalPeriod": 3,
    "expenseCategory": {
      "id": 101,
      "displayId": "EC-2025-001",
      "status": {
        "name": "ACTIVE",
        "captionKey": "enum.objectStatus.active",
        "active": true,
        "caption": "Active"
      },
      "name": "Lease Payment",
      "expenseCategoryType": "PAYMENT"
    },
    "unitId": 30001,
    "unitDisplayId": "UNIT-0005",
    "activationGroupId": 4001,
    "vendorPaymentSplits": [],
    "numberRangeIdentifierValue": "BU-01",
    "numberRangeIdentifierType": {
      "name": "COMPANY_CODE"
    },
    "numberRangeType": {
      "name": "CONTRACT"
    },
    "allowsSystemGenerateNewId": true
  }
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Search Charges With Filters

HTTP Request

POST /api/v1/charges/search

Interactive Demo

📋 Description: Submits a request to search for charges related to leases and contracts, enabling users to identify financial obligations and corresponding accounting entries efficiently.

Parameters

Name	In	Type	Required	Description
page	query	integer	false	Page number (0-indexed)
size	query	integer	false	Number of items per page
sort	query	array[string]	false	Sorting criteria in format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
body	body	object	false	Request body containing search criteria and filters for retrieving lease-related charges, including contract details and associated financial obligations.

Default Values

Parameter	Default	Type
page	0	query
size	20	query

Parameter Constraints

Parameter	Constraints
page	Min: 0
size	Min: 1, Max: 100

Body Parameters

{}

Responses

Status	Meaning	Description	Schema
200	OK	Successfully retrieved filtered list of charges.	PageChargeDto

Example Responses

{
  "totalElements": 10000001,
  "totalPages": 100,
  "pageable": {
    "pageNumber": 0,
    "unpaged": false,
    "paged": true,
    "pageSize": 100,
    "offset": 0,
    "sort": {
      "unsorted": false,
      "sorted": true,
      "empty": false
    }
  },
  "numberOfElements": 100,
  "size": 100,
  "content": [],
  "number": 0,
  "sort": {
    "unsorted": false,
    "sorted": true,
    "empty": false
  },
  "first": true,
  "last": false,
  "empty": false
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Generate Charges Using Ai

HTTP Request

POST /api/v1/charges/ai

Interactive Demo

📋 Description: Creates a new charge entry within the Nakisa Lease Accounting Suite, facilitating the management of financial obligations related to leases and contracts.

Parameters

Name	In	Type	Required	Description
body	body	ChargesAiRequest	false	Request body containing the lease and contract details necessary for creating a financial obligation entry in the Nakisa Lease Accounting Suite.

Body Parameters

{
  "prompt": "Create monthly rent charges for 2025",
  "chargesJsonArray": "[{\"name\":\"Existing Charge\",\"amount\":1000}]",
  "messageHistory": [
    "Create charges for Q1",
    "Add rent payments"
  ],
  "unitsJsonArray": "[{\"id\":30001,\"displayId\":\"UNIT-0001\"}]",
  "calculateVendorPaymentSplits": true,
  "partnersJsonArray": "[{\"id\":50001,\"name\":\"Vendor A\"}]"
}

Responses

Status	Meaning	Description	Schema
200	OK	Successfully generated charges using AI.	ChargesAiResponse

Example Responses

{
  "response": "I've created 12 monthly rent charges for 2025.",
  "error": "string",
  "llm": {
    "charges": []
  },
  "command": "CREATE",
  "parameter": "monthly rent 2025"
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Save Ai-Generated Charges

HTTP Request

POST /api/v1/charges/ai/save-charges

Interactive Demo

📋 Description: Submits and saves charge entries related to leases and contracts within the Nakisa Lease Accounting Suite, ensuring accurate accounting for financial obligations.

Parameters

Name	In	Type	Required	Description
body	body	ChargeLightDto	false	Request body containing the lease charge details, including contract identifiers and financial obligation data, necessary for creating accounting entries in the Nakisa Lease Accounting Suite.

Body Parameters

[
  {
    "amount": "1500.00",
    "description": "Rent payment for January 2025",
    "dueDate": "2025-01-31",
    "expenseCategory": "PAYMENT",
    "id": 20000001,
    "name": "Monthly Rent Payment",
    "unitId": 30001,
    "unitDisplayId": "UNIT-0005",
    "vendorPaymentSplits": "Vendor A: 50%, Vendor B: 50%"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	AI-generated charges successfully saved.	Inline

Example Responses

[
  {
    "id": 20000001,
    "displayId": "CHG-0001",
    "name": "Office Supplies Purchase",
    "description": "Charge for Q1 office supplies procurement.",
    "dueDate": "2025-12-31",
    "amount": 1250.5,
    "hasPostedDocument": false,
    "fiscalYear": 2025,
    "fiscalPeriod": 3,
    "expenseCategory": {
      "id": 101,
      "displayId": "EC-2025-001",
      "status": {
        "name": "ACTIVE",
        "captionKey": "enum.objectStatus.active",
        "active": true,
        "caption": "Active"
      },
      "name": "Lease Payment",
      "expenseCategoryType": "PAYMENT"
    },
    "unitId": 30001,
    "unitDisplayId": "UNIT-0005",
    "activationGroupId": 4001,
    "vendorPaymentSplits": [],
    "numberRangeIdentifierValue": "BU-01",
    "numberRangeIdentifierType": {
      "name": "COMPANY_CODE"
    },
    "numberRangeType": {
      "name": "CONTRACT"
    },
    "allowsSystemGenerateNewId": true
  }
]

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[ChargeDto]	false	none	[Data transfer object representing a financial charge associated with a lease or contract, encapsulating key details necessary for accounting entries and financial obligation management within the Nakisa Lease Accounting Suite.]
» id	integer(int64)	false	none	Unique identifier for the resource
» displayId	string	false	none	Unique identifier for the display
» name	string	true	none	Name of the resource
» description	string¦null	false	none	Description of the resource
» dueDate	string(date)	true	none	Due date of the resource
» amount	number(double)	true	none	Amount value
» hasPostedDocument	boolean	false	none	Whether the resource has has posted document
» fiscalYear	integer(int64)	false	none	Numeric value representing fiscalYear
» fiscalPeriod	integer(int64)	false	none	Numeric value representing fiscalPeriod
» expenseCategory	ExpenseCategoryLite	true	none	Data transfer object representing a simplified categorization of expenses related to leases and contracts within the Nakisa Lease Accounting Suite, facilitating efficient tracking and management of financial obligations and accounting entries.
»» id	integer(int64)	false	none	Unique identifier for the resource
»» displayId	string	false	none	Unique identifier for the display
»» status	Status	false	none	Represents the object status with localized captions and activity state.
»»» name	string	false	none	Enum name representing the object status.
»»» captionKey	string	false	none	Localization key for the object status caption.
»»» active	boolean	false	none	Indicates whether the status is active.
»»» caption	string	false	none	Localized caption of the object status.
»» name	string	false	none	Name of the resource
»» expenseCategoryType	string	false	none	Type of the expense category
» unitId	integer(int64)	true	none	Unique identifier for the unit
» unitDisplayId	string	false	none	Unique identifier for the unit display
» activationGroupId	integer(int64)	true	none	Unique identifier for the activation group
» vendorPaymentSplits	[VendorPaymentSplitDto]	false	none	List of vendorPaymentSplits items
»» percentage	number(double)	false	none	Percentage value
»» calculateTax	boolean	false	none	Boolean flag indicating calculateTax status
»» taxExemptionPercentage	number(double)	false	none	Percentage of tax exemption
»» partner	PartnerLite	false	none	Data transfer object representing a simplified partner profile within the Nakisa Lease Accounting Suite, encompassing essential details related to lease agreements, financial obligations, and accounting entries.
»»» id	integer(int64)	false	none	Unique identifier for the resource
»»» displayId	string	false	none	Unique identifier for the display
»»» status	Status	false	none	Represents the object status with localized captions and activity state.
»»» name	string	false	none	Name of the resource
»»» erpSystemDisplayId	string	false	none	Unique identifier for the erp system display
»» partnerRole	PartnerRoleLite	false	none	Data transfer object representing a simplified partner role within the Nakisa Lease Accounting Suite, encompassing essential attributes related to lease agreements, contracts, and financial obligations for streamlined accounting entry management.
»»» id	integer(int64)	false	none	Unique identifier for the resource
»»» displayId	string	false	none	Unique identifier for the display
»»» status	Status	false	none	Represents the object status with localized captions and activity state.
»»» name	string	false	none	Name of the resource
»» taxCodeDetermination	TaxCodeDeterminationDetails	false	none	Data structure representing the details of tax code determination related to leases and contracts within the Nakisa Lease Accounting Suite, facilitating accurate financial obligation tracking and accounting entry management.
»»» id	integer(int64)	false	none	Unique identifier for the resource
»»» displayId	string	false	none	Unique identifier for the display
»»» companyId	integer(int64)	false	none	Unique identifier for the company
»»» partnerId	integer(int64)	false	none	none
»»» taxJurisdictionId	integer(int64)	false	none	Unique identifier for the tax jurisdiction
»»» taxJurisdictionDisplayId	string	false	none	Unique identifier for the tax jurisdiction display
»»» defaultTaxCodeId	integer(int64)	false	none	Unique identifier for the default tax code
»»» defaultTaxCodeDisplayId	string	false	none	Unique identifier for the default tax code display
»»» defaultExemptionTaxCodeId	integer(int64)	false	none	Unique identifier for the default exemption tax code
»»» defaultExemptionTaxCodeDisplayId	string	false	none	Unique identifier for the default exemption tax code display
»»» defaultExemptionPercentage	number(double)	false	none	Percentage of default exemption
»»» mapping	TaxCodeExpenseCategoryMappingDetails	false	none	Data transfer object representing the mapping of tax codes to expense categories within the Nakisa Lease Accounting Suite, facilitating accurate accounting entries and compliance with financial obligations related to leases and contracts.
»»»» isLeaseExpense	boolean	false	none	Whether the resource is lease expense
»»»» nonLeaseTaxCodeId	integer(int64)	false	none	Unique identifier for the non lease tax code
»»»» nonLeaseTaxCodeDisplayId	string	false	none	Unique identifier for the non lease tax code display
»»»» nonLeaseExemptionTaxCodeId	integer(int64)	false	none	Unique identifier for the non lease exemption tax code
»»»» nonLeaseExemptionTaxCodeDisplayId	string	false	none	Unique identifier for the non lease exemption tax code display
»»»» nonLeaseExemptionTaxPercentage	number(double)	false	none	Percentage of non lease exemption tax
»»»» principalTaxCodeId	integer(int64)	false	none	Unique identifier for the principal tax code
»»»» principalTaxCodeDisplayId	string	false	none	Unique identifier for the principal tax code display
»»»» principalExemptionTaxCodeId	integer(int64)	false	none	Unique identifier for the principal exemption tax code
»»»» principalExemptionTaxCodeDisplayId	string	false	none	Unique identifier for the principal exemption tax code display
»»»» principalExemptionTaxPercentage	number(double)	false	none	Percentage of principal exemption tax
» numberRangeIdentifierValue	string	false	none	Unique identifier for the range of numbers associated with a lease or contract, facilitating accurate tracking of financial obligations and accounting entries within the Nakisa Lease Accounting Suite.
» numberRangeIdentifierType	INumberRangeIdentifierType	false	none	Data structure representing a numerical range identifier used in the Nakisa Lease Accounting Suite to categorize and manage leases, contracts, and financial obligations within accounting entries.
»» name	string	true	none	Name of the resource
» numberRangeType	INumberRangeType	false	none	Data structure representing a numerical range utilized in the Nakisa Lease Accounting Suite, essential for defining financial obligations and accounting entries associated with leases and contracts.
»» name	string	true	none	Name of the resource
» allowsSystemGenerateNewId	boolean	false	none	Unique identifier for the allows system generate new

Enumerated Values

Attribute	Value
expenseCategoryType	CASH_INCENTIVE, CASUALTY, EXPECTED_GRV, INCENTIVE, NON_LEASE, PAYMENT, PURCHASE_OPTION, TERMINATION_OPTION
name	ACTIVE, CREATED, DECOMMISSIONED, DISABLED

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Get Sum Of Charges Due On Or Before A Date

HTTP Request

GET /api/v1/charges/sum/due-on-or-before

Interactive Demo

📋 Description: Calculates and returns the total sum of charge amounts that are due on or before the specified date for a given activation group. Useful for forecasting and cash flow planning.

Parameters

Name	In	Type	Required	Description
date	query	string(date)	true	The cutoff date to filter charges due on or before this date.
activationGroupId	query	integer(int64)	true	The unique identifier of the activation group to calculate charge sum for.

Responses

Status	Meaning	Description	Schema
200	OK	Successfully calculated sum of charges due on or before the specified date.	number

Example Responses

0.1

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Get Sum Of Charges By Expense Category

HTTP Request

GET /api/v1/charges/sum/by-expense-category

Interactive Demo

📋 Description: Calculates and returns the total sum of charge amounts for a specific expense category within a given activation group. Useful for category-wise expense analysis.

Parameters

Name	In	Type	Required	Description
expenseCategory	query	string	true	The expense category to filter charges by.
activationGroupId	query	integer(int64)	true	The unique identifier of the activation group to calculate charge sum for.

Responses

Status	Meaning	Description	Schema
200	OK	Successfully calculated sum of charges for the specified expense category.	number

Example Responses

0.1

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Get Sum Of Charges By Multiple Expense Categories

HTTP Request

GET /api/v1/charges/sum/by-expense-categories

Interactive Demo

📋 Description: Calculates and returns the total sum of charge amounts for multiple expense categories within a given activation group. Useful for aggregated expense analysis across related categories.

Parameters

Name	In	Type	Required	Description
expenseCategory	query	array[string]	true	Array of expense categories to filter charges by.
activationGroupId	query	integer(int64)	true	The unique identifier of the activation group to calculate charge sum for.

Responses

Status	Meaning	Description	Schema
200	OK	Successfully calculated sum of charges for the specified expense categories.	number

Example Responses

0.1

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Get Sum Of Charges By Specific Due Date

HTTP Request

GET /api/v1/charges/sum/by-due-date

Interactive Demo

📋 Description: Calculates and returns the total sum of charge amounts that are due on a specific date for a given activation group. Useful for understanding payment obligations on a particular date.

Parameters

Name	In	Type	Required	Description
dueDate	query	string(date)	true	The specific due date to filter charges.
activationGroupId	query	integer(int64)	true	The unique identifier of the activation group to calculate charge sum for.

Responses

Status	Meaning	Description	Schema
200	OK	Successfully calculated sum of charges for the specified due date.	number

Example Responses

0.1

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Get Sum Of All Charges

HTTP Request

GET /api/v1/charges/sum/all

Interactive Demo

📋 Description: Calculates and returns the total sum of all charge amounts for a specified activation group. This aggregation provides a quick overview of total financial obligations.

Parameters

Name	In	Type	Required	Description
activationGroupId	query	integer(int64)	true	The unique identifier of the activation group to calculate charge sum for.

Responses

Status	Meaning	Description	Schema
200	OK	Successfully calculated sum of all charges.	number

Example Responses

0.1

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

---