Create an invoice line
post
/fscmRestApi/resources/11.13.18.05/publicSectorInvoices/{publicSectorInvoicesUniqID}/child/BillLine
Request
Path Parameters
-
publicSectorInvoicesUniqID(required): string
This is the hash key of the attributes which make up the composite key--- AgencyId, Invoice and BillType ---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>;BillType=<value3>
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
AgencyId: integer
Default Value:
1
Unique identifier of the agency associated with the row. -
BillType: string
Maximum Length:
15
Determines default invoice values, such as invoice form and invoice number ID. Passed from the source application. -
Classification: string
Maximum Length:
3
The classification passed from the source application. -
CurrencyCode: string
Maximum Length:
3
Indicates the currency used for the transaction. Passed from the source application. -
CustomerTrxLineId: integer
(int64)
Transaction line identifier on an invoice line in Fusion Receivables.
-
DepartmentId: string
Maximum Length:
30
Unique identifier of the department. -
Description: 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: number
The discount to the amount paid. Passed from the source application.
-
ExpirationDate: string
(date-time)
The expiration date of the license.
-
FeeItemId: string
Maximum Length:
30
Unique identifier for the fee item. -
Invoice: string
Maximum Length:
50
The invoice number for the associated bill header. -
InvoiceLine: integer
The invoice line number.
-
InvoiceLineAmount: number
Title:
Invoice Line Amount
Amount that represents the quantity times the price, plus any discounts, minus any surcharges. -
IssueDate: string
(date-time)
Invoice issue date.
-
LatestInvoice: string
Maximum Length:
50
Most recent Invoice adjusted in the chain of adjustments. -
LatestLine: integer
Most recent Invoice line adjusted in the chain of adjustments.
-
MemoLineId: integer
(int64)
Memo line identifier on an invoice line in Fusion Receivables.
-
NextAdjustmentInvoice: string
Maximum Length:
50
Invoice adjusted next in the chain of adjustments. -
NextAdjustmentLine: integer
Invoice line adjusted next in the chain of adjustments.
-
OriginalInvoice: string
Maximum Length:
50
Original invoice number. -
OriginalLine: integer
Original invoice line.
-
Price: number
Title:
Invoice Price
The fee amount or unit price. -
PriorAdjustmentInvoice: string
Maximum Length:
50
Invoice adjusted prior in the chain of adjustments. -
PriorAdjustmentLine: integer
Invoice line adjusted prior in the chain of adjustments.
-
Quantity: integer
Title:
Invoice Quantity
The unit quantity. -
RecordId: string
Maximum Length:
50
Unique identifier for the record. -
RecordType: string
Maximum Length:
30
The type of record passed from the source application. -
RenewalDate: string
(date-time)
The renewal date of the license.
-
SurchargeAmount: number
The surcharge on the amount paid. Passed from the source application.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version(required):
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : publicSectorInvoices-BillLine-item-response
Type:
Show Source
object
-
AgencyId: integer
Default Value:
1
Unique identifier of the agency associated with the row. -
BillType: string
Maximum Length:
15
Determines default invoice values, such as invoice form and invoice number ID. Passed from the source application. -
Classification: string
Maximum Length:
3
The classification passed from the source application. -
CurrencyCode: string
Maximum Length:
3
Indicates the currency used for the transaction. Passed from the source application. -
CustomerTrxLineId: integer
(int64)
Transaction line identifier on an invoice line in Fusion Receivables.
-
DepartmentId: string
Maximum Length:
30
Unique identifier of the department. -
Description: 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: number
The discount to the amount paid. Passed from the source application.
-
ExpirationDate: string
(date-time)
The expiration date of the license.
-
FeeItemId: string
Maximum Length:
30
Unique identifier for the fee item. -
Invoice: string
Maximum Length:
50
The invoice number for the associated bill header. -
InvoiceLine: integer
The invoice line number.
-
InvoiceLineAmount: number
Title:
Invoice Line Amount
Amount that represents the quantity times the price, plus any discounts, minus any surcharges. -
IssueDate: string
(date-time)
Invoice issue date.
-
LatestInvoice: string
Maximum Length:
50
Most recent Invoice adjusted in the chain of adjustments. -
LatestLine: integer
Most recent Invoice line adjusted in the chain of adjustments.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MemoLineId: integer
(int64)
Memo line identifier on an invoice line in Fusion Receivables.
-
NextAdjustmentInvoice: string
Maximum Length:
50
Invoice adjusted next in the chain of adjustments. -
NextAdjustmentLine: integer
Invoice line adjusted next in the chain of adjustments.
-
OriginalInvoice: string
Maximum Length:
50
Original invoice number. -
OriginalLine: integer
Original invoice line.
-
Price: number
Title:
Invoice Price
The fee amount or unit price. -
PriorAdjustmentInvoice: string
Maximum Length:
50
Invoice adjusted prior in the chain of adjustments. -
PriorAdjustmentLine: integer
Invoice line adjusted prior in the chain of adjustments.
-
Quantity: integer
Title:
Invoice Quantity
The unit quantity. -
RecordId: string
Maximum Length:
50
Unique identifier for the record. -
RecordType: string
Maximum Length:
30
The type of record passed from the source application. -
RenewalDate: string
(date-time)
The renewal date of the license.
-
SurchargeAmount: number
The surcharge on the amount paid. Passed from the source application.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.