Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Status
colourGreen
title3.18.01

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

Panel
borderColorgrey
bgColorwhitesmoke

On this page:

Table of Contents
maxLevel2

Related pages:

Resource URL Summary

Panel
borderColorgrey
bgColorwhitesmoke
borderStylesolid

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.

Include Page
_URI Default HTTP Headers
_URI Default HTTP Headers

 


API Specifics

Panel
borderColor#D3D3D3

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

Panel
borderColorgrey
bgColorwhitesmoke
borderStylesolid

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.

Panel
borderColor#D3D3D3

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

Panel
borderColorgrey
bgColorwhitesmoke
borderStylesolid

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.

Insert excerpt
Work Order Invoices Object
Work Order Invoices Object
Panel
borderColor#D3D3D3

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

Panel
borderColorgrey
bgColorwhitesmoke
borderStylesolid

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.