Get Work Invoices
get
/workInvoices
Request
Query Parameters
-
expand: string
Comma-delimited string of child resource names that you want to expand so that the contents return with the parent in the same GET request.
-
fields: string
Comma-delimited string of field names that you wanted returned in a GET request.
-
limit: integer(int32)
Positive integer value that specifies the maximum number of items returned by the server.
-
offset: integer(int32)
Non-negative integer values that specifies the index of the first item to be returned. The offset index begins at 0. By default, the offset is 0, which returns all items starting from the first item in the collection.
-
orderBy: string
Comma-separated string of field names, each optionally followed by asc or desc, that specifies the order of items returned in the response payload.
-
q: string
Filter (a 'where'clause) to restrict the items returned in the collection. By default, no filtering is applied.
-
totalResults: boolean
Boolean value that specifies whether to calculate the totalResults property. By default, this value is set to false indicating that totalResults is not calculated.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/vnd.oracle.resource+json;type=collection
Default Response
Default Response.
Nested Schema : workInvoices
Type:
Show Source
object
-
activities:
activities
-
dateSent:
dateSent
Date this work invoice was sent to payroll.
-
documents:
documents
-
domainName: string
Database domain where this data is stored.
-
driverGid: string
The GID of the driver for this work invoice.
-
insertDate:
insertDate
Read Only:
true
insert date -
links: array
links
Read Only:
true
-
revenue:
revenue
The sell side revenue.
-
secondaryDriverGid: string
If driven by a team, the secondary driver ID.
-
shipments:
shipments
-
statuses:
statuses
-
updateDate:
updateDate
Read Only:
true
update date -
workInvoiceGid: string
The GID for the work invoice.
-
workInvoiceNumber: string
The GID for the work invoice from a business standpoint; if a corrected work invoice is generated, this number will be retained.
-
workInvoiceXid: string
The XID for the work invoice.
Nested Schema : activities
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : documents
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : shipments
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : statuses
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : workInvoices.activities
Type:
Show Source
object
-
activityDate:
activityDate
Date activity was performed.
-
destLocationGid: string
Destination location of the activity.
-
distance:
distance
Distance for the activity.
-
domainName: string
Database domain where this data is stored.
-
duration:
duration
Duration for the activity.
-
itemPackageCount: number
(int64)
Package item count.
-
links: array
links
Read Only:
true
-
payableIndicatorGid: string
Indicates the payable state of this activity (ex: Payable, Not Payable, Display as Zero, etc.).
-
sequence: number
(int32)
The line number of the activity record.
-
shipmentSpecialServiceSeq: number
(int64)
Shipment special service sequence
-
shipUnitCount: number
(int64)
Count for the activity (such as number of ship units).
-
sourceLocationGid: string
Source location of the activity.
-
specialServiceGid: string
Special Service GID for the activity performed.
-
volume:
volume
Volume for the activity.
-
weight:
weight
Weight for the activity.
Nested Schema : amountType
Type:
Show Source
object
-
unit: string
Unit of measure
-
value: number
Numeric value that specifies an amount
Nested Schema : dateTimeType
Type:
Show Source
object
-
timezone: string
Timezone in Olson database format
-
value: string
(date-time)
Date in ISO 8601 format
Nested Schema : workInvoices.documents
Type:
Show Source
object
-
contentManagementSystemGid: string
No description.
-
documentCmsId: string
A GUID to associate the document with content stored on its remote CMS. Valid when document_type=CMS.
-
documentDefGid: string
No description.
-
documentFilename: string
No description.
-
documentGid: string
No description.
-
documentMimeType: string
No description.
-
documentTrackingNum: string
No description.
-
documentType: string
No description.
-
documentUrl: string
No description.
-
documentXid: string
No description.
-
domainName: string
No description.
-
effectiveDate:
effectiveDate
represents effective date for a document
-
expirationDate:
expirationDate
Represents expiration date for a document.
-
generatedAt:
generatedAt
If preparation, date/time content was last generated
-
links: array
links
Read Only:
true
-
ownerDataQueryTypeGid: string
No description.
- relatedDocumentGid: string
-
reportGid: string
The report associated with the document attachment, if content was generated by the report subsystem.
-
uploadedAt:
uploadedAt
If attachment, date/time content was last updated
-
usedAs: string
Represents the classification of a document.(C/I/L/T)
-
userDefined1IconGid: string
No description.
-
userDefined2IconGid: string
No description.
-
userDefined3IconGid: string
No description.
-
userDefined4IconGid: string
No description.
-
userDefined5IconGid: string
No description.
Nested Schema : generatedAt
If preparation, date/time content was last generated
Match All
Show Source
Nested Schema : currencyType
Type:
Show Source
object
-
currency: string
ISO 4217 currency code
-
value: number
Numeric value that specifies a currency
Nested Schema : workInvoices.shipments
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
shipmentGid: string
The XID for the shipment related to the work invoice.
Nested Schema : workInvoices.statuses
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
statusTypeGid: string
The status type.
-
statusValueGid: string
The value of the status type.