Jump to

• Request
• Response

Create an invoice line

post

/fscmRestApi/resources/11.13.18.05/publicSectorInvoices/{publicSectorInvoicesUniqID}/child/BillLine

Request

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Path Parameters

• 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>

Body ()

The following table describes the body parameters in the request for this task.

Root Schema : publicSectorInvoices-BillLine-item

Type: object

Show Source

• 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.

{
    "properties":{
        "AgencyId":{
            "format":"int64",
            "type":"integer",
            "description":"Unique identifier of the agency associated with the row."
        },
        "CurrencyCode":{
            "maxLength":3,
            "type":"string",
            "description":"Indicates the currency used for the transaction. Passed from the source application."
        },
        "Description":{
            "maxLength":100,
            "type":"string",
            "description":"Description of the fee passed from the source application or of the fee (service charge) passed from the payment application."
        },
        "DiscountAmount":{
            "type":"number",
            "description":"The discount to the amount paid. Passed from the source application."
        },
        "Invoice":{
            "maxLength":50,
            "type":"string",
            "description":"The invoice number for the associated bill header."
        },
        "InvoiceLine":{
            "format":"int64",
            "type":"integer",
            "description":"The invoice line number."
        },
        "InvoiceLineAmount":{
            "type":"number",
            "description":"Amount that represents the quantity times the price, plus any discounts, minus any surcharges."
        },
        "LatestInvoice":{
            "maxLength":50,
            "type":"string",
            "description":"Most recent Invoice adjusted in the chain of adjustments."
        },
        "LatestLine":{
            "format":"int64",
            "type":"integer",
            "description":"Most recent Invoice line adjusted in the chain of adjustments."
        },
        "NextAdjustmentInvoice":{
            "maxLength":50,
            "type":"string",
            "description":"Invoice adjusted next in the chain of adjustments."
        },
        "NextAdjustmentLine":{
            "format":"int64",
            "type":"integer",
            "description":"Invoice line adjusted next in the chain of adjustments."
        },
        "OriginalInvoice":{
            "maxLength":50,
            "type":"string",
            "description":"Original invoice number."
        },
        "OriginalLine":{
            "format":"int64",
            "type":"integer",
            "description":"Original invoice line."
        },
        "Price":{
            "type":"number",
            "description":"The fee amount or unit price."
        },
        "PriorAdjustmentInvoice":{
            "maxLength":50,
            "type":"string",
            "description":"Invoice adjusted prior in the chain of adjustments."
        },
        "PriorAdjustmentLine":{
            "format":"int64",
            "type":"integer",
            "description":"Invoice line adjusted prior in the chain of adjustments."
        },
        "Quantity":{
            "format":"int64",
            "type":"integer",
            "description":"The unit quantity."
        },
        "SurchargeAmount":{
            "type":"number",
            "description":"The surcharge on the amount paid. Passed from the source application."
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Back to Top

Response

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : publicSectorInvoices-BillLine-item

Type: object

Show Source

• 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.

{
    "properties":{
        "AgencyId":{
            "format":"int64",
            "type":"integer",
            "description":"Unique identifier of the agency associated with the row."
        },
        "CurrencyCode":{
            "maxLength":3,
            "type":"string",
            "description":"Indicates the currency used for the transaction. Passed from the source application."
        },
        "Description":{
            "maxLength":100,
            "type":"string",
            "description":"Description of the fee passed from the source application or of the fee (service charge) passed from the payment application."
        },
        "DiscountAmount":{
            "type":"number",
            "description":"The discount to the amount paid. Passed from the source application."
        },
        "Invoice":{
            "maxLength":50,
            "type":"string",
            "description":"The invoice number for the associated bill header."
        },
        "InvoiceLine":{
            "format":"int64",
            "type":"integer",
            "description":"The invoice line number."
        },
        "InvoiceLineAmount":{
            "type":"number",
            "description":"Amount that represents the quantity times the price, plus any discounts, minus any surcharges."
        },
        "LatestInvoice":{
            "maxLength":50,
            "type":"string",
            "description":"Most recent Invoice adjusted in the chain of adjustments."
        },
        "LatestLine":{
            "format":"int64",
            "type":"integer",
            "description":"Most recent Invoice line adjusted in the chain of adjustments."
        },
        "NextAdjustmentInvoice":{
            "maxLength":50,
            "type":"string",
            "description":"Invoice adjusted next in the chain of adjustments."
        },
        "NextAdjustmentLine":{
            "format":"int64",
            "type":"integer",
            "description":"Invoice line adjusted next in the chain of adjustments."
        },
        "OriginalInvoice":{
            "maxLength":50,
            "type":"string",
            "description":"Original invoice number."
        },
        "OriginalLine":{
            "format":"int64",
            "type":"integer",
            "description":"Original invoice line."
        },
        "Price":{
            "type":"number",
            "description":"The fee amount or unit price."
        },
        "PriorAdjustmentInvoice":{
            "maxLength":50,
            "type":"string",
            "description":"Invoice adjusted prior in the chain of adjustments."
        },
        "PriorAdjustmentLine":{
            "format":"int64",
            "type":"integer",
            "description":"Invoice line adjusted prior in the chain of adjustments."
        },
        "Quantity":{
            "format":"int64",
            "type":"integer",
            "description":"The unit quantity."
        },
        "SurchargeAmount":{
            "type":"number",
            "description":"The surcharge on the amount paid. Passed from the source application."
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Back to Top