Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Next »

3.18.01

The Work Order Invoice REST API is used to retrieve work order invoice PDFs from S3 for a specified work order.

On this page:

Related pages:

Resource URL Summary

Retrieve the details of the latest Work Order Invoice for a specific Work Order

GET /seiapi/v3/trans/WorkOrder/${WorkOrderNum}/Invoice

Retrieve a list of all Work Order Invoices for a specific Work Order

GET /seiapi/v3/trans/WorkOrder/${WorkOrderNum}/Invoices

Retrieve the details of a specific Work Order Invoice for a specific Work Order

GET /seiapi/v3/trans/WorkOrder/${WorkOrderNum}/Invoice/${FileName}

API Specific Parameters

ParameterDescription
${FileName}

Identifies the Invoice file name.

File name format is: Invoice.<yyyyMMdd>.<HHmmss>.pdf

ParameterDescription
yyyyMMddDate format
HHmmssTime format

${WorkOrderNum}

Identifies the Work Order Object.

HTTP Headers

This API uses the default ServiceMobility HTTP Headers.

 


API Specifics

Retrieve the details of the latest Work Order Invoice for a specific Work Order

This REST API will return the latest Work Order Invoice for the Work Order with the specified ID. The Work Order with the specified ID must already exist in the system.

URL

GET /seiapi/v3/trans/WorkOrder/${WorkOrderNum}/Invoice

HTTP Request Body

This request does not require a request body. 

HTTP Response Body

On success, an HTTP response code of 200 will be returned, and the response body will contain the actual invoice PDF as an attachment.

Retrieve a list of all Work Order Invoices for a specific Work Order

This REST API will return a list of all valid Work Order Invoices for the Work Order with the specified ID. The Work Order with the specified ID must already exist in the system.

URL

GET /seiapi/v3/trans/WorkOrder/${WorkOrderNum}/Invoices

HTTP Request Body

This request does not require a request body. 

HTTP Response Body

On success, an HTTP response code of 200 will be returned, and the response body will contain a Work Order Invoices Object. Otherwise, on error, the response body will contain a descriptive reason for the error.

Work Order Invoices Object

Retrieve the details of a specific Work Order Invoice for a specific Work Order

This REST API will return the Work Order Invoice with the specified file name for the Work Order with the specified ID. Both the Work Order with the specified ID and the Work Order Invoice with the specified file name must already exist in the system.

URL

GET /seiapi/v3/trans/WorkOrder/${WorkOrderNum}/Invoice/${FileName}

HTTP Request Body

This request does not require a request body. 

HTTP Response Body

On success, an HTTP response code of 200 will be returned, and the response body will contain the actual invoice PDF as an attachment.

  • No labels