Jobs API
Endpoint Index
| Action | Endpoint |
|---|---|
| Fetch Documents Job for Transaction | GET /document/{tenantLocator}/documents/transaction/{locator}/jobs/{jobLocator} |
| Fetch Multiple Documents Jobs for Transaction | GET /document/{tenantLocator}/documents/transaction/{locator}/jobs/list |
| Fetch Documents Job for Segment | GET /document/{tenantLocator}/documents/segment/{locator}/jobs/{jobLocator} |
| Fetch Multiple Documents Jobs for Segment | GET /document/{tenantLocator}/documents/segment/{locator}/jobs/list |
| Fetch Documents Job for Quote | GET /document/{tenantLocator}/documents/quote/{locator}/jobs/{jobLocator} |
| Fetch Multiple Documents Jobs for Quote | GET /document/{tenantLocator}/documents/quote/{locator}/jobs/list |
| Trigger Timed Out Documents Job for Transaction | POST /document/{tenantLocator}/documents/transaction/{locator}/trigger |
| Trigger Timed Out Documents Job for Segment | POST /document/{tenantLocator}/documents/segment/{locator}/trigger |
| Trigger Timed Out Documents Job for Quote | POST /document/{tenantLocator}/documents/quote/{locator}/trigger |
| Fetch Installments Jobs for Quotes | GET /billing/{tenantLocator}/jobs/installments/quotes/{locator}/list |
| Fetch Installments Jobs for Policy Transactions | GET /billing/{tenantLocator}/jobs/installments/transactions/{locator}/list |
| Fetch Invoice Jobs for Quotes | GET /billing/{tenantLocator}/jobs/invoices/quotes/{locator}/list |
| Fetch Invoice Jobs for Policies | GET /billing/{tenantLocator}/jobs/invoices/policies/{locator}/list |
| Fetch Delinquency Grace Job | GET /billing/{tenantLocator}/jobs/delinquencies/{delinquencyLocator}/list |
| Fetch Create Delinquencies Job Data for Invoice | GET /billing/{tenantLocator}/jobs/delinquencies/invoices/{invoiceLocator}/list |
Documents Jobs
GET /document/{tenantLocator}/documents/transaction/{locator}/jobs/{jobLocator}Request Parameters:
| Name | Position | Type | Required |
|---|---|---|---|
| tenantLocator | path | uuid | required |
| locator | path | locator | required |
| jobLocator | path | locator | required |
Response:DocumentsJob
Security Group:documents  Permission:read
GET /document/{tenantLocator}/documents/transaction/{locator}/jobs/listRequest Parameters:
| Name | Position | Type | Required |
|---|---|---|---|
| tenantLocator | path | uuid | required |
| locator | path | locator | required |
| offset | query | int? | optional |
| count | query | int? | optional |
Response:DocumentsJobSummary[]
Security Group:documents  Permission:read
GET /document/{tenantLocator}/documents/segment/{locator}/jobs/{jobLocator}Request Parameters:
| Name | Position | Type | Required |
|---|---|---|---|
| tenantLocator | path | uuid | required |
| locator | path | locator | required |
| jobLocator | path | locator | required |
Response:DocumentsJob
Security Group:documents  Permission:read
GET /document/{tenantLocator}/documents/segment/{locator}/jobs/listRequest Parameters:
| Name | Position | Type | Required |
|---|---|---|---|
| tenantLocator | path | uuid | required |
| locator | path | locator | required |
| offset | query | int? | optional |
| count | query | int? | optional |
Response:DocumentsJobSummary[]
Security Group:documents  Permission:read
GET /document/{tenantLocator}/documents/quote/{locator}/jobs/{jobLocator}Request Parameters:
| Name | Position | Type | Required |
|---|---|---|---|
| tenantLocator | path | uuid | required |
| locator | path | locator | required |
| jobLocator | path | locator | required |
Response:DocumentsJob
Security Group:documents  Permission:read
GET /document/{tenantLocator}/documents/quote/{locator}/jobs/listRequest Parameters:
| Name | Position | Type | Required |
|---|---|---|---|
| tenantLocator | path | uuid | required |
| locator | path | locator | required |
| offset | query | int? | optional |
| count | query | int? | optional |
Response:DocumentsJobSummary[]
Security Group:documents  Permission:read
DocumentsJob
¶requiredlocator locatorreferenceLocator locatorcompletedAt datetimedocumentTrigger Enum validated | priced | accepted | issued | underwritten | generatedprocessingErrors stringreferenceType Enum quote | policy | invoice | transaction | segment | termstatus Enum finished | failed | runningcreatedAt datetimecreatedBy uuidchildrenJobs locator[]documents DocumentJobInfo[]
DocumentJobInfo
¶requiredlocator locatorstaticName stringname stringdocumentInstanceState stringprocessingErrors stringstate string (deprecated)
DocumentsJobSummary
¶requiredlocator locatorreferenceType Enum quote | policy | invoice | transaction | segment | termstatus Enum finished | failed | running
Note
The /list endpoints above will return an empty array if the entity does not exist for the given locator. An HTTP 404 error will not be generated.
Job Retrigger
POST /document/{tenantLocator}/documents/transaction/{locator}/triggerRequest Parameters:
| Name | Position | Type | Required |
|---|---|---|---|
| tenantLocator | path | uuid | required |
| locator | path | locator | required |
Response:DocumentsJobSummary
Security Group:documents  Permission:trigger
POST /document/{tenantLocator}/documents/segment/{locator}/triggerRequest Parameters:
| Name | Position | Type | Required |
|---|---|---|---|
| tenantLocator | path | uuid | required |
| locator | path | locator | required |
Response:DocumentsJobSummary
Security Group:documents  Permission:trigger
POST /document/{tenantLocator}/documents/quote/{locator}/triggerRequest Parameters:
| Name | Position | Type | Required |
|---|---|---|---|
| tenantLocator | path | uuid | required |
| locator | path | locator | required |
Response:DocumentsJobSummary
Security Group:documents  Permission:trigger
Installment Jobs
GET /billing/{tenantLocator}/jobs/installments/quotes/{locator}/listRequest Parameters:
| Name | Position | Type | Required |
|---|---|---|---|
| tenantLocator | path | uuid | required |
| locator | path | locator | required |
| offset | query | int? | optional |
| count | query | int? | optional |
Response:InstallmentJobData[]
Security Group:jobs  Permissions:read,list
GET /billing/{tenantLocator}/jobs/installments/transactions/{locator}/listRequest Parameters:
| Name | Position | Type | Required |
|---|---|---|---|
| tenantLocator | path | uuid | required |
| locator | path | locator | required |
| offset | query | int? | optional |
| count | query | int? | optional |
Response:InstallmentJobData[]
Security Group:jobs  Permissions:read,list
InstallmentJobData
¶requiredlocator locatorlatticeLocator locatorreferenceLocator locatorcompletedAt datetimeinstallmentLocators stringjobStatus Enum finished | failed | runningjobType Enum createOrUpdate | invalidate | unbillprocessingErrors stringreferenceType Enum quote | transactioncreatedAt datetime
Invoice Jobs
This endpoint will be removed in a future release.
GET /billing/{tenantLocator}/jobs/invoices/quotes/{locator}/listRequest Parameters:
| Name | Position | Type | Required |
|---|---|---|---|
| tenantLocator | path | uuid | required |
| locator | path | locator | required |
| offset | query | int? | optional |
| count | query | int? | optional |
Response:InvoiceGenerationJob[]
Security Group:jobs  Permissions:read,list
This endpoint will be removed in a future release.
GET /billing/{tenantLocator}/jobs/invoices/policies/{locator}/listRequest Parameters:
| Name | Position | Type | Required |
|---|---|---|---|
| tenantLocator | path | uuid | required |
| locator | path | locator | required |
| offset | query | int? | optional |
| count | query | int? | optional |
Response:InvoiceGenerationJob[]
Security Group:jobs  Permissions:read,list
InvoiceGenerationJob
¶requiredlocator locatorinvoiceGenerationScheduleLocator locatorgenerateTime datetimecompletedAt datetimejobStatus Enum finished | failed | runningprocessingErrors stringcreatedAt datetimecreatedBy uuidinvoiceGenerationInstances InvoiceGenerationInstance[]
InvoiceGenerationInstance
¶requiredlocator locatorinvoiceGenerationJobLocator locatorinvoiceLocator locatorgenerateTime datetimecompletedAt datetimejobStatus Enum finished | failed | runningprocessingErrors stringcreatedAt datetimecreatedBy uuid
Delinquency Jobs
GET /billing/{tenantLocator}/jobs/delinquencies/{delinquencyLocator}/listRequest Parameters:
| Name | Position | Type | Required |
|---|---|---|---|
| tenantLocator | path | uuid | required |
| delinquencyLocator | path | locator | required |
| offset | query | int? | optional |
| count | query | int? | optional |
Response:GraceJobData[]
Security Group:jobs  Permissions:read,list
GraceJobData
¶requiredlocator locatordelinquencyLocator locatorjobStatus Enum finished | failed | runningupdatedAt datetimecreatedAt datetimeoptionaloutcome string?processingErrors string?
GET /billing/{tenantLocator}/jobs/delinquencies/invoices/{invoiceLocator}/listRequest Parameters:
| Name | Position | Type | Required |
|---|---|---|---|
| tenantLocator | path | uuid | required |
| invoiceLocator | path | locator | required |
| offset | query | int? | optional |
| count | query | int? | optional |
Response:DelinquencyCreateJobData[]
Security Group:jobs  Permissions:read,list
DelinquencyCreateJobData
¶requiredlocator locatorinvoiceLocator locatordueTime datetimejobStatus Enum finished | failed | runningupdatedAt datetimecreatedAt datetimedelinquencyLocators locator[]optionalprocessingErrors string?