Update an invoice line
patch
/fscmRestApi/resources/11.13.18.05/publicSectorInvoices/{publicSectorInvoicesUniqID}/child/BillLine/{BillLineUniqID}
Request
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Path Parameters
-
BillLineUniqID: integer
This is the hash key of the attributes which make up the composite key--- AgencyId, Invoice and InvoiceLine ---for the Bill Lines resource and used to uniquely identify an instance of Bill Lines. The client should not generate the hash key value. Instead, the client should query on the Bill Lines collection resource with a filter on the primary key values in order to navigate to a specific instance of Bill Lines.
For example: BillLine?q=AgencyId=<value1>;Invoice=<value2>;InvoiceLine=<value3> -
publicSectorInvoicesUniqID: integer
This is the hash key of the attributes which make up the composite key--- AgencyId and Invoice ---for the Invoices resource and used to uniquely identify an instance of Invoices. The client should not generate the hash key value. Instead, the client should query on the Invoices collection resource with a filter on the primary key values in order to navigate to a specific instance of Invoices.
For example: publicSectorInvoices?q=AgencyId=<value1>;Invoice=<value2>
The following table describes the body parameters in the request for this task.
Root Schema : publicSectorInvoices-BillLine-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int64)
Unique identifier of the agency associated with the row.
-
CurrencyCode(optional):
string
Maximum Length:
3
Indicates the currency used for the transaction. Passed from the source application. -
Description(optional):
string
Maximum Length:
100
Description of the fee passed from the source application or of the fee (service charge) passed from the payment application. -
DiscountAmount(optional):
number
The discount to the amount paid. Passed from the source application.
-
Invoice(optional):
string
Maximum Length:
50
The invoice number for the associated bill header. -
InvoiceLine(optional):
integer(int64)
The invoice line number.
-
InvoiceLineAmount(optional):
number
Amount that represents the quantity times the price, plus any discounts, minus any surcharges.
-
LatestInvoice(optional):
string
Maximum Length:
50
Most recent Invoice adjusted in the chain of adjustments. -
LatestLine(optional):
integer(int64)
Most recent Invoice line adjusted in the chain of adjustments.
-
links(optional):
array Items
Title:
Items
Link Relations -
NextAdjustmentInvoice(optional):
string
Maximum Length:
50
Invoice adjusted next in the chain of adjustments. -
NextAdjustmentLine(optional):
integer(int64)
Invoice line adjusted next in the chain of adjustments.
-
OriginalInvoice(optional):
string
Maximum Length:
50
Original invoice number. -
OriginalLine(optional):
integer(int64)
Original invoice line.
-
Price(optional):
number
The fee amount or unit price.
-
PriorAdjustmentInvoice(optional):
string
Maximum Length:
50
Invoice adjusted prior in the chain of adjustments. -
PriorAdjustmentLine(optional):
integer(int64)
Invoice line adjusted prior in the chain of adjustments.
-
Quantity(optional):
integer(int64)
The unit quantity.
-
SurchargeAmount(optional):
number
The surcharge on the amount paid. Passed from the source application.
Nested Schema : link
Type:
Show Source
object
-
href(optional):
string
Title:
hyperlink reference
The URI to the related resource. -
rel(optional):
string
Title:
relation
The name of the relation to the resource instance. Example: self.
Response
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Default Response
The following table describes the default response for this task.
Root Schema : publicSectorInvoices-BillLine-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int64)
Unique identifier of the agency associated with the row.
-
CurrencyCode(optional):
string
Maximum Length:
3
Indicates the currency used for the transaction. Passed from the source application. -
Description(optional):
string
Maximum Length:
100
Description of the fee passed from the source application or of the fee (service charge) passed from the payment application. -
DiscountAmount(optional):
number
The discount to the amount paid. Passed from the source application.
-
Invoice(optional):
string
Maximum Length:
50
The invoice number for the associated bill header. -
InvoiceLine(optional):
integer(int64)
The invoice line number.
-
InvoiceLineAmount(optional):
number
Amount that represents the quantity times the price, plus any discounts, minus any surcharges.
-
LatestInvoice(optional):
string
Maximum Length:
50
Most recent Invoice adjusted in the chain of adjustments. -
LatestLine(optional):
integer(int64)
Most recent Invoice line adjusted in the chain of adjustments.
-
links(optional):
array Items
Title:
Items
Link Relations -
NextAdjustmentInvoice(optional):
string
Maximum Length:
50
Invoice adjusted next in the chain of adjustments. -
NextAdjustmentLine(optional):
integer(int64)
Invoice line adjusted next in the chain of adjustments.
-
OriginalInvoice(optional):
string
Maximum Length:
50
Original invoice number. -
OriginalLine(optional):
integer(int64)
Original invoice line.
-
Price(optional):
number
The fee amount or unit price.
-
PriorAdjustmentInvoice(optional):
string
Maximum Length:
50
Invoice adjusted prior in the chain of adjustments. -
PriorAdjustmentLine(optional):
integer(int64)
Invoice line adjusted prior in the chain of adjustments.
-
Quantity(optional):
integer(int64)
The unit quantity.
-
SurchargeAmount(optional):
number
The surcharge on the amount paid. Passed from the source application.
Nested Schema : link
Type:
Show Source
object
-
href(optional):
string
Title:
hyperlink reference
The URI to the related resource. -
rel(optional):
string
Title:
relation
The name of the relation to the resource instance. Example: self.