API Documentation
Authentication
Users
Entities
- GETList entities
- GETAPI to get entities by type
- Get entities id
- GETList entity addresses
- GETList entity taxes
- GETAPI to get entities by type with filters
- POSTAPI to create an entity
- POSTCreate entities
- Post entities id addresses
- POSTCreate entity taxes
- PUTUpdate entity
- PUTUpdate entity address
- PUTUpdate entity tax
- DELAPI to delete an entity
- Delete entities id addresses addressid
- DELDelete entity tax
Catalog
Billing
Contracts
- GETGet contracts
- Get contracts contractid milestones
- GETList contract plans
- GETGet id
- Post contracts contractid milestones
- POSTAdd plan to contract
- Post contracts contractid plans contractplanid invoices
- POSTCreate milestones
- POSTAdd taxes to contract
- Post contracts import
- Post contracts import bulk
- PUTUpdate contract plan
- PUTChange contract plan
- PUTUpdate contract tax
- PUTUpdate contract
- DELDelete contractPlanId
- DELDelete contractPlanItemMilestoneId
- DELRemove contract tax
Invoices
- GETGet invoices
- Get invoices id payments
- GETAPI to get invoice details by ID
- GETList invoice templates
- POSTCreate invoices
- POSTAPI to create a batch of invoices
- Post invoices id payments
- Post invoices invoiceid document
- POSTAPI to create invoice item
- POSTAPI to update invoice status and dates
- POSTSync invoice revenue
- POSTAPI to sync an invoice with usage data
- POSTCreate invoice template
- Put invoices id payments paymentid
- PUTUpdate invoice
- PUTAPI to update invoice item
- PUTUpdate invoice template
- Delete invoices id payments paymentid
- DELDelete payment file
- DELDelete invoice file
- DELDelete invoice template
Payments
Metering
Events
Jobs
State Machine
Workflows
FX Rates
Collections
Apps
Webhooks
Attributes
Email templates
FSM (object lifecycle)
- GETAPI to get state machines
- GETAPI to get all actions for a model
- GETAPI to get all states for a model
- POSTAPI to create a state machine
- POSTAPI to get all available actions for multiple model instances
- POSTAPI to undo the last transition on a model
- POSTAPI to enqueue a bulk transition job on multiple model instances
Masters
Organisation attributes
Organisation settings
API to parse contract details for an existing job
curl --request POST \
--url https://api.getenso.ai/jobs/{jobId}/parse-contract-details \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"detailsToExtract": "<unknown>"
}
'{
"status": "success",
"message": "Success",
"data": {}
}Jobs
API to parse contract details for an existing job
API to parse contract details for an existing job
POST
/
jobs
/
{jobId}
/
parse-contract-details
API to parse contract details for an existing job
curl --request POST \
--url https://api.getenso.ai/jobs/{jobId}/parse-contract-details \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"detailsToExtract": "<unknown>"
}
'{
"status": "success",
"message": "Success",
"data": {}
}SystemUser permission:
JobService:getJobById, JobService:updateAuthorizations
JWT bearer token obtained from POST /auth/system-login using your client credentials.
Path Parameters
ID of the job
Query Parameters
stakeholders_only | plans_only | all
Optional customer name, used in plans_only mode
Body
application/json
⌘I