Get Stops
get
/bills/{invoiceGid}/stops
Request
Path Parameters
-
invoiceGid(required): string
Resource ID
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 : bills.stops
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
endDate:
endDate
End date.
-
equipmentNumber: string
The equipment number on the invoice.
-
equipmentPrefix: string
Equipment prefix.
-
invoiceStopReasonGid: string
The invoice stop reason GID.
-
links: array
links
Read Only:
true
-
locationGid: string
The GID for the location on the invoice.
-
locationRefnum: string
A reference number for the location on the invoice.
-
locationRefnumQualGid: string
The location reference number qualifier GID.
-
refnums:
refnums
-
seals:
seals
-
startDate:
startDate
Start date.
-
stopSeqNo: string
Stop sequence number.
Nested Schema : refnums
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : seals
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
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 : bills.stops.refnums
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
invoiceStopRefnumQualGid: string
The invoice stop reference number qualifier GID.
-
links: array
links
Read Only:
true
-
referenceNumber: string
Reference number.
Nested Schema : bills.stops.seals
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
sealNumber: string
The number of the seal that was placed on the piece of equipment.
-
sealSequence: number
(int32)
A one-up number to allow several seals being placed on a piece of equipment at the same stop.