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 Early Invoicing Job	GET /billing/{tenantLocator}/jobs/earlyInvoicing/{jobLocator}
Fetch Early Invoicing Jobs for Account	GET /billing/{tenantLocator}/jobs/earlyInvoicing/accounts/{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
Fetch Delinquency Event Jobs	GET /billing/{tenantLocator}/jobs/delinquencies/{delinquencyLocator}/events/list

Documents Jobs

Fetch Documents Job for Transaction

fetchDocumentsJobForTransaction

GET /document/{tenantLocator}/documents/transaction/{locator}/jobs/{jobLocator}

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
locator	path	string	required
jobLocator	path	string	required

Response:DocumentsJob
Security Group:documents   Permission:read

Fetch Multiple Documents Jobs for Transaction

fetchMultipleDocumentsJobsForTransaction

GET /document/{tenantLocator}/documents/transaction/{locator}/jobs/list

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
locator	path	string	required
offset	query	int?	optional
count	query	int?	optional
extended	query	boolean?	optional

Response:DocumentJobListResponse
Security Group:documents   Permission:read

Fetch Documents Job for Segment

fetchDocumentsJobForSegment

GET /document/{tenantLocator}/documents/segment/{locator}/jobs/{jobLocator}

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
locator	path	string	required
jobLocator	path	string	required

Response:DocumentsJob
Security Group:documents   Permission:read

Fetch Multiple Documents Jobs for Segment

fetchMultipleDocumentsJobsForSegment

GET /document/{tenantLocator}/documents/segment/{locator}/jobs/list

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
locator	path	string	required
offset	query	int?	optional
count	query	int?	optional
extended	query	boolean?	optional

Response:DocumentJobListResponse
Security Group:documents   Permission:read

Fetch Documents Job for Quote

fetchDocumentsJobForQuote

GET /document/{tenantLocator}/documents/quote/{locator}/jobs/{jobLocator}

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
locator	path	string	required
jobLocator	path	string	required

Response:DocumentsJob
Security Group:documents   Permission:read

Fetch Multiple Documents Jobs for Quote

fetchMultipleDocumentsJobsForQuote

GET /document/{tenantLocator}/documents/quote/{locator}/jobs/list

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
locator	path	string	required
offset	query	int?	optional
count	query	int?	optional
extended	query	boolean?	optional

Response:DocumentJobListResponse
Security Group:documents   Permission:read

DocumentJobListResponse

required
listCompleted boolean
items DocumentsJobSummary[]

DocumentsJob

required
locator string
referenceLocator string
completedAt datetime
documentTrigger Enum validated | priced | accepted | issued | underwritten | generated
processingErrors string
referenceType Enum quote | policy | invoice | transaction | segment | term
status Enum running | finished | failed
createdAt datetime
createdBy uuid
childrenJobs string[]
documents DocumentJobInfo[]

DocumentJobInfo

required
locator string
staticName string
name string
documentInstanceState string
processingErrors string
state string (deprecated)

DocumentsJobSummary

required
locator string
referenceType Enum quote | policy | invoice | transaction | segment | term
status Enum running | finished | failed

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

Trigger Timed Out Documents Job for Transaction

triggerTimedOutDocumentsJobForTransaction

POST /document/{tenantLocator}/documents/transaction/{locator}/trigger

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
locator	path	string	required

Response:DocumentsJobSummary
Security Group:documents   Permission:trigger

Trigger Timed Out Documents Job for Segment

triggerTimedOutDocumentsJobForSegment

POST /document/{tenantLocator}/documents/segment/{locator}/trigger

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
locator	path	string	required

Response:DocumentsJobSummary
Security Group:documents   Permission:trigger

Trigger Timed Out Documents Job for Quote

triggerTimedOutDocumentsJobForQuote

POST /document/{tenantLocator}/documents/quote/{locator}/trigger

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
locator	path	string	required

Response:DocumentsJobSummary
Security Group:documents   Permission:trigger

Installment Jobs

Fetch Installments Jobs for Quotes

fetchInstallmentsJobDataForQuotes

GET /billing/{tenantLocator}/jobs/installments/quotes/{locator}/list

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
locator	path	string	required
offset	query	int?	optional
count	query	int?	optional
extended	query	boolean?	optional

Response:InstallmentJobDataListResponse
Security Group:jobs   Permissions:read,list

Fetch Installments Jobs for Policy Transactions

fetchInstallmentsJobDataForTransactions

GET /billing/{tenantLocator}/jobs/installments/transactions/{locator}/list

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
locator	path	string	required
offset	query	int?	optional
count	query	int?	optional
extended	query	boolean?	optional

Response:InstallmentJobDataListResponse
Security Group:jobs   Permissions:read,list

InstallmentJobDataListResponse

required
listCompleted boolean
items InstallmentJobData[]

InstallmentJobData

required
locator locator
latticeLocator locator
referenceLocator locator
completedAt datetime
installmentLocators string
jobStatus Enum running | finished | failed
jobType Enum createOrUpdate | invalidate | unbill
processingErrors string
referenceType Enum quote | transaction
createdAt datetime

Invoice Jobs

Normal Invoicing

Fetch Invoice Jobs for Quotes

Deprecated

fetchInvoiceJobDataForQuotes

This endpoint will be removed in a future release.

GET /billing/{tenantLocator}/jobs/invoices/quotes/{locator}/list

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
locator	path	string	required
offset	query	int?	optional
count	query	int?	optional

Response:InvoiceJobDataListResponse
Security Group:jobs   Permissions:read,list

Fetch Invoice Jobs for Policies

Deprecated

fetchInvoiceJobDataForPolicies

This endpoint will be removed in a future release.

GET /billing/{tenantLocator}/jobs/invoices/policies/{locator}/list

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
locator	path	string	required
offset	query	int?	optional
count	query	int?	optional

Response:InvoiceJobDataListResponse
Security Group:jobs   Permissions:read,list

InvoiceGenerationJob

required
locator string
invoiceGenerationScheduleLocator string
generateTime datetime
completedAt datetime
jobStatus Enum running | finished | failed
processingErrors string
createdAt datetime
createdBy uuid
invoiceGenerationInstances InvoiceGenerationInstance[]

InvoiceGenerationInstance

required
locator string
invoiceGenerationJobLocator string
invoiceLocator string
generateTime datetime
completedAt datetime
jobStatus Enum running | finished | failed
processingErrors string
createdAt datetime
createdBy uuid

Early Invoicing

Fetch Early Invoicing Job

fetchEarlyInvoicingJob

GET /billing/{tenantLocator}/jobs/earlyInvoicing/{jobLocator}

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
jobLocator	path	string	required

Response:EarlyInvoicingJobData
Security Group:jobs   Permission:read

EarlyInvoicingJobData

required
locator string
earlyInvoicingGenerationData EarlyInvoicingGenerationData
jobStatus Enum running | finished | failed
createdAt datetime
invoiceLocators string[]

optional
completedAt datetime?
processingErrors string?

EarlyInvoicingGenerationData

required
accountLocator string
installmentsToBeInvoiced string[]

optional
timezone string?
invoiceDueTime datetime?

Fetch Early Invoicing Jobs for Account

fetchEarlyInvoicingJobsForAccount

GET /billing/{tenantLocator}/jobs/earlyInvoicing/accounts/{locator}/list

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
locator	path	string	required
offset	query	int?	optional
count	query	int?	optional

Response:ListPageResponseEarlyInvoicingJobData
Security Group:jobs   Permissions:read,list

ListPageResponseEarlyInvoicingJobData

required
listCompleted boolean
items EarlyInvoicingJobData[]

InvoiceJobDataListResponse

required
listCompleted boolean
items InvoiceGenerationJob[]

Delinquency Jobs

Fetch Delinquency Grace Job

fetchDelinquencyGraceJob

GET /billing/{tenantLocator}/jobs/delinquencies/{delinquencyLocator}/list

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
delinquencyLocator	path	string	required
offset	query	int?	optional
count	query	int?	optional
extended	query	boolean?	optional

Response:GraceJobDataListResponse
Security Group:jobs   Permissions:read,list

GraceJobDataListResponse

required
listCompleted boolean
items GraceJobData[]

GraceJobData

required
locator locator
delinquencyLocator locator
jobStatus Enum running | finished | failed
updatedAt datetime
createdAt datetime

optional
outcome string?
processingErrors string?

Fetch Create Delinquencies Job Data for Invoice

fetchCreateDelinquenciesJobDataForInvoice

GET /billing/{tenantLocator}/jobs/delinquencies/invoices/{invoiceLocator}/list

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
invoiceLocator	path	string	required
offset	query	int?	optional
count	query	int?	optional
extended	query	boolean?	optional

Response:DelinquencyCreateJobDataListResponse
Security Group:jobs   Permissions:read,list

DelinquencyCreateJobDataListResponse

required
listCompleted boolean
items DelinquencyCreateJobData[]

DelinquencyCreateJobData

required
locator locator
invoiceLocator locator
dueTime datetime
jobStatus Enum running | finished | failed
updatedAt datetime
createdAt datetime
delinquencyLocators locator[]

optional
processingErrors string?

Fetch Delinquency Event Jobs

fetchDelinquencyEventJobs

GET /billing/{tenantLocator}/jobs/delinquencies/{delinquencyLocator}/events/list

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
delinquencyLocator	path	string	required
offset	query	int?	optional
count	query	int?	optional

Response:DelinquencyEventJobDataListResponse
Security Group:jobs   Permissions:read,list

DelinquencyEventJobDataListResponse

required
listCompleted boolean
items DelinquencyEventJobData[]

DelinquencyEventJobData

required
locator string
delinquencyEventLocator string
delinquencyLocator string
jobStatus Enum running | finished | failed
triggerTime datetime
updatedAt datetime
createdAt datetime
updatedDelinquencyEventLocators string[]

optional
rescheduledByLocator string?
cancellationType Enum? cancellationRequested | rescheduled | tenantRetired | delinquencySettled | delinquencyHeld
cancelled boolean?
processingErrors string?