REST API for Oracle Public Sector Permitting and Licensing

Update an invoice data

patch

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

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.

Supported Media Types

application/json

Root Schema : schema

Type: object

Show Source

AccountingDate: string (date)

The accounting date.
Address1: string

Maximum Length: 240

The first line of the applicant or customer address.
Address2: string

Maximum Length: 240

The second line of the applicant or customer address.
Address3: string

Maximum Length: 240

The third line of the applicant or customer address.
Address4: string

Maximum Length: 240

The fourth line of the applicant or customer address.
BalanceAmount: number

Balance amount to be paid.
BankAccountKey: string

Maximum Length: 30

The remit to bank account type.
BankCode: string

Maximum Length: 30

The remit to bank code for the organization.
Billable: string

Maximum Length: 1

Default Value: N

Indicates whether an invoice is billable. The default value is Yes.
BillLine: array Bill Lines

Title: Bill Lines

The bill lines resource is used to view, create or update invoice lines.
BillStatus: string

Maximum Length: 30

The current status of the bill.
BillToContactId: integer (int64)

Bill to customer site use identifier on an invoice in Fusion Receivables.
BillToCustomerId: integer (int64)

Bill to customer identifier on an invoice in Fusion Receivables.
BillToMedia: string

Maximum Length: 20

Indicates the media used for billing such as print or email.
BillToSiteUseId: integer (int64)

Bill to site use identifier on an invoice in Fusion Receivables.
BillType: string

Maximum Length: 15

Determines the default invoice values for invoice form and invoice number ID. Passed from the source application.
BusBusinessName: string

Maximum Length: 100

Business entity name.
BusDbaBusinessName: string

Maximum Length: 100

The doing business as name of the business entity.
BusinessEntityId: string

Maximum Length: 50

Unique identifier for the business entity.
BusinessEntityPartyId: integer (int64)

Unique identifier for the business party.
BusinessLocationPartyId: integer (int64)

Unique identifier for the business location party ID.
BusinessProfileId: integer (int64)

Unique identifier for the business profile.
City: string

Maximum Length: 60

City of the applicant or customer address.
Country: string

Maximum Length: 3

Country for the applicant or customer address.
County: string

Maximum Length: 60

County for the applicant or customer address.
CurrencyCode: string

Title: Currency

Maximum Length: 3

Indicates the currency used for the transaction. Passed from the source application.
CustomerTrxId: integer (int64)

Transaction identifier on an invoice in Fusion Receivables.
CustTrxTypeId: integer (int64)

Transaction type identifier on an invoice in Fusion Receivables.
Description: string

Title: Invoice Description

Maximum Length: 50

Description of the invoice.
DueDate: string (date)

The date on which the payment is due.
EmailAddress: string

Maximum Length: 320

The applicant or customer email address.
FirstName: string

Maximum Length: 150

The applicant or customer first name.
InvoiceAmount: number

Title: Invoice Amount

The sum of all invoice line amounts.
InvoiceDate: string (date)

Title: Invoice Date

The invoice date.
InvoiceFormId: string

Maximum Length: 20

Unique identifier for the invoice form layout to print. Derived from BNP_BILL_TYPE.
InvoiceStatus: string

Maximum Length: 30

The current status of the invoice system.
InvoiceSystem: string

Maximum Length: 30

The invoice system to which the bill has been sent.
InvoiceType: string

Maximum Length: 30

Default Value: ORA_INVOICE

The type of invoice.
LastName: string

Maximum Length: 150

The applicant or customer last name.
LatestInvoice: string

Maximum Length: 50

Most recent invoice adjusted in the chain of adjustments.
LocationId: integer

Unique identifier for the party address information. Derived from PBL_PARTY_LOCATION_USE using PARTY_ID.
MiddleName: string

Maximum Length: 60

The applicant or customer middle name.
NameSuffix: string

Maximum Length: 30

The applicant or customer name suffix.
NextAdjustmentInvoice: string

Maximum Length: 50

Invoice adjusted subsequently in the chain of adjustments.
OrgId: integer (int64)

The unique identifier of the business unit associated with an invoice in Fusion Receivables.
OriginalInvoice: string

Maximum Length: 50

Original invoice number.
OwnerAddress1: string

Maximum Length: 240

First line of the owner address.
OwnerAddress2: string

Maximum Length: 240

Second line of the owner address.
OwnerAddress3: string

Maximum Length: 240

Third line of the owner address.
OwnerAddress4: string

Maximum Length: 240

Fourth line of the owner address.
OwnerCity: string

Maximum Length: 60

City associated with the owner address.
OwnerCountry: string

Maximum Length: 3

Country associated with the owner address.
OwnerCounty: string

Maximum Length: 60

County associated with the owner address.
OwnerPostalCode: string

Maximum Length: 60

Postal code associated with the owner address.
OwnerPostalPlusFourCode: string

Maximum Length: 10

Postal plus-four code associated with the owner address.
OwnerProvince: string

Maximum Length: 60

Province associated with the owner address.
OwnerState: string

Maximum Length: 60

State associated with the owner address.
PartyId: integer

Attribute used to derive party information for a person, group or organization. Passed from the source application.
PaymentStatus: string

Maximum Length: 30

The payment status of the bill.
PersonName: string

Title: Person Name

Maximum Length: 450

The applicant or customer name.
PostalCode: string

Maximum Length: 20

Postal code for applicant or customer address.
PostalPlus4Code: string

Maximum Length: 10

The Postal plus4 code for applicant or customer address.
PreferredContactMethod: string

Maximum Length: 30

The method by which a person prefers to be contacted. Passed from the source application.
PreferredContactPersonId: integer

Unique identifier of the preferred contact for a given party. Used to derive PARTY_ID from table PBL_PARTY_CONTACT_POINTS in order to derive contact name from PBL_PERSON_PROFILE table. Passed from source application.
PriorAdjustmentInvoice: string

Maximum Length: 50

Invoice adjusted previously in the chain of adjustments.
ProfileId: integer (int64)

Attribute used to derive cashier id information if payment is made through a cashier.
Province: string

Maximum Length: 60

Region code for the applicant or customer address in non-US countries.
SourceTransactionKey: integer

Unique identifier of the source transaction. Passed from the source application.
State: string

Maximum Length: 60

The state for applicant or customer address.
TermId: integer (int64)

The payment terms applicable to a fee item that assessed and due.
TransactionOrigin: string

Maximum Length: 30

Indicates where a transaction originated. Passed from the source application.

{
    "type":"object",
    "properties":{
        "ProfileId":{
            "type":"integer",
            "description":"Attribute used to derive cashier id information if payment is made through a cashier.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "OwnerAddress2":{
            "maxLength":"240",
            "type":"string",
            "description":"Second line of the owner address.",
            "nullable":true
        },
        "OwnerAddress1":{
            "maxLength":"240",
            "type":"string",
            "description":"First line of the owner address.",
            "nullable":true
        },
        "OwnerAddress4":{
            "maxLength":"240",
            "type":"string",
            "description":"Fourth line of the owner address.",
            "nullable":true
        },
        "OwnerAddress3":{
            "maxLength":"240",
            "type":"string",
            "description":"Third line of the owner address.",
            "nullable":true
        },
        "BusinessProfileId":{
            "type":"integer",
            "description":"Unique identifier for the business profile.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":"3",
            "type":"string",
            "description":"Indicates the currency used for the transaction. Passed from the source application.",
            "nullable":true
        },
        "BusBusinessName":{
            "maxLength":"100",
            "type":"string",
            "description":"Business entity name.",
            "nullable":true
        },
        "SourceTransactionKey":{
            "type":"integer",
            "description":"Unique identifier of the source transaction. Passed from the source application.",
            "nullable":true
        },
        "NameSuffix":{
            "maxLength":"30",
            "type":"string",
            "description":"The applicant or customer name suffix.",
            "nullable":true
        },
        "PreferredContactMethod":{
            "maxLength":"30",
            "type":"string",
            "description":"The method by which a person prefers to be contacted. Passed from the source application.",
            "nullable":true
        },
        "OwnerCounty":{
            "maxLength":"60",
            "type":"string",
            "description":"County associated with the owner address.",
            "nullable":true
        },
        "PaymentStatus":{
            "maxLength":"30",
            "type":"string",
            "description":"The payment status of the bill.",
            "nullable":true
        },
        "LatestInvoice":{
            "maxLength":"50",
            "type":"string",
            "description":"Most recent invoice adjusted in the chain of adjustments.",
            "nullable":true
        },
        "BillToSiteUseId":{
            "type":"integer",
            "description":"Bill to site use identifier on an invoice in Fusion Receivables.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "BusinessLocationPartyId":{
            "type":"integer",
            "description":"Unique identifier for the business location party ID.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "CustomerTrxId":{
            "type":"integer",
            "description":"Transaction identifier on an invoice in Fusion Receivables.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "BillStatus":{
            "maxLength":"30",
            "type":"string",
            "description":"The current status of the bill.",
            "nullable":true
        },
        "City":{
            "maxLength":"60",
            "type":"string",
            "description":"City of the applicant or customer address.",
            "nullable":true
        },
        "Province":{
            "maxLength":"60",
            "type":"string",
            "description":"Region code for the applicant or customer address in non-US countries.",
            "nullable":true
        },
        "EmailAddress":{
            "maxLength":"320",
            "type":"string",
            "description":"The applicant or customer email address.",
            "nullable":true
        },
        "PostalPlus4Code":{
            "maxLength":"10",
            "type":"string",
            "description":"The Postal plus4 code for applicant or customer address.",
            "nullable":true
        },
        "State":{
            "maxLength":"60",
            "type":"string",
            "description":"The state for applicant or customer address.",
            "nullable":true
        },
        "Country":{
            "maxLength":"3",
            "type":"string",
            "description":"Country for the applicant or customer address.",
            "nullable":true
        },
        "LastName":{
            "maxLength":"150",
            "type":"string",
            "description":"The applicant or customer last name.",
            "nullable":true
        },
        "BankAccountKey":{
            "maxLength":"30",
            "type":"string",
            "description":"The remit to bank account type.",
            "nullable":true
        },
        "PreferredContactPersonId":{
            "type":"integer",
            "description":"Unique identifier of the preferred contact for a given party. Used to derive PARTY_ID from table PBL_PARTY_CONTACT_POINTS in order to derive contact name from PBL_PERSON_PROFILE table. Passed from source application.",
            "nullable":true
        },
        "BusinessEntityId":{
            "maxLength":"50",
            "type":"string",
            "description":"Unique identifier for the business entity.",
            "nullable":true
        },
        "Description":{
            "title":"Invoice Description",
            "maxLength":"50",
            "type":"string",
            "description":"Description of the invoice.",
            "nullable":false
        },
        "BillToCustomerId":{
            "type":"integer",
            "description":"Bill to customer identifier on an invoice in Fusion Receivables.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "CustTrxTypeId":{
            "type":"integer",
            "description":"Transaction type identifier on an invoice in Fusion Receivables.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "OwnerCountry":{
            "maxLength":"3",
            "type":"string",
            "description":"Country associated with the owner address.",
            "nullable":true
        },
        "PostalCode":{
            "maxLength":"20",
            "type":"string",
            "description":"Postal code for applicant or customer address.",
            "nullable":true
        },
        "InvoiceAmount":{
            "title":"Invoice Amount",
            "type":"number",
            "description":"The sum of all invoice line amounts.",
            "nullable":true
        },
        "AccountingDate":{
            "type":"string",
            "description":"The accounting date.",
            "format":"date",
            "nullable":true
        },
        "County":{
            "maxLength":"60",
            "type":"string",
            "description":"County for the applicant or customer address.",
            "nullable":true
        },
        "PriorAdjustmentInvoice":{
            "maxLength":"50",
            "type":"string",
            "description":"Invoice adjusted previously in the chain of adjustments.",
            "nullable":true
        },
        "Address4":{
            "maxLength":"240",
            "type":"string",
            "description":"The fourth line of the applicant or customer address.",
            "nullable":true
        },
        "BillToMedia":{
            "maxLength":"20",
            "type":"string",
            "description":"Indicates the media used for billing such as print or email.",
            "nullable":true
        },
        "InvoiceFormId":{
            "maxLength":"20",
            "type":"string",
            "description":"Unique identifier for the invoice form layout to print. Derived from BNP_BILL_TYPE.",
            "nullable":true
        },
        "OwnerProvince":{
            "maxLength":"60",
            "type":"string",
            "description":"Province associated with the owner address.",
            "nullable":true
        },
        "InvoiceDate":{
            "title":"Invoice Date",
            "type":"string",
            "description":"The invoice date.",
            "format":"date",
            "nullable":true
        },
        "DueDate":{
            "type":"string",
            "description":"The date on which the payment is due.",
            "format":"date",
            "nullable":true
        },
        "TermId":{
            "type":"integer",
            "description":"The payment terms applicable to a fee item that assessed and due.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "NextAdjustmentInvoice":{
            "maxLength":"50",
            "type":"string",
            "description":"Invoice adjusted subsequently in the chain of adjustments.",
            "nullable":true
        },
        "OwnerState":{
            "maxLength":"60",
            "type":"string",
            "description":"State associated with the owner address.",
            "nullable":true
        },
        "BillType":{
            "maxLength":"15",
            "type":"string",
            "description":"Determines the default invoice values for invoice form and invoice number ID. Passed from the source application.",
            "nullable":true
        },
        "PersonName":{
            "title":"Person Name",
            "maxLength":"450",
            "type":"string",
            "description":"The applicant or customer name.",
            "nullable":true
        },
        "BalanceAmount":{
            "type":"number",
            "description":"Balance amount to be paid.",
            "nullable":true
        },
        "FirstName":{
            "maxLength":"150",
            "type":"string",
            "description":"The applicant or customer first name.",
            "nullable":true
        },
        "BillLine":{
            "title":"Bill Lines",
            "type":"array",
            "description":"The bill lines resource is used to view, create or update invoice lines.",
            "items":{
                "$ref":"#/components/schemas/publicSectorInvoices-BillLine-item-patch-request"
            }
        },
        "Billable":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether an invoice is billable. The default value is Yes.",
            "nullable":true,
            "default":"N"
        },
        "BusDbaBusinessName":{
            "maxLength":"100",
            "type":"string",
            "description":"The doing business as name of the business entity.",
            "nullable":true
        },
        "OwnerPostalPlusFourCode":{
            "maxLength":"10",
            "type":"string",
            "description":"Postal plus-four code associated with the owner address.",
            "nullable":true
        },
        "Address2":{
            "maxLength":"240",
            "type":"string",
            "description":"The second line of the applicant or customer address.",
            "nullable":true
        },
        "LocationId":{
            "type":"integer",
            "description":"Unique identifier for the party address information. Derived from PBL_PARTY_LOCATION_USE using PARTY_ID.",
            "nullable":false
        },
        "TransactionOrigin":{
            "maxLength":"30",
            "type":"string",
            "description":"Indicates where a transaction originated. Passed from the source application.",
            "nullable":true
        },
        "Address3":{
            "maxLength":"240",
            "type":"string",
            "description":"The third line of the applicant or customer address.",
            "nullable":true
        },
        "OwnerCity":{
            "maxLength":"60",
            "type":"string",
            "description":"City associated with the owner address.",
            "nullable":true
        },
        "BankCode":{
            "maxLength":"30",
            "type":"string",
            "description":"The remit to bank code for the organization.",
            "nullable":true
        },
        "Address1":{
            "maxLength":"240",
            "type":"string",
            "description":"The first line of the applicant or customer address.",
            "nullable":true
        },
        "MiddleName":{
            "maxLength":"60",
            "type":"string",
            "description":"The applicant or customer middle name.",
            "nullable":true
        },
        "BillToContactId":{
            "type":"integer",
            "description":"Bill to customer site use identifier on an invoice in Fusion Receivables.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "InvoiceSystem":{
            "maxLength":"30",
            "type":"string",
            "description":"The invoice system to which the bill has been sent.",
            "nullable":true
        },
        "InvoiceType":{
            "maxLength":"30",
            "type":"string",
            "description":"The type of invoice.",
            "nullable":true,
            "default":"ORA_INVOICE"
        },
        "BusinessEntityPartyId":{
            "type":"integer",
            "description":"Unique identifier for the business party.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "OrgId":{
            "type":"integer",
            "description":"The unique identifier of the business unit associated with an invoice in Fusion Receivables.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "OwnerPostalCode":{
            "maxLength":"60",
            "type":"string",
            "description":"Postal code associated with the owner address.",
            "nullable":true
        },
        "PartyId":{
            "type":"integer",
            "description":"Attribute used to derive party information for a person, group or organization. Passed from the source application.",
            "nullable":true
        },
        "OriginalInvoice":{
            "maxLength":"50",
            "type":"string",
            "description":"Original invoice number.",
            "nullable":true
        },
        "InvoiceStatus":{
            "maxLength":"30",
            "type":"string",
            "description":"The current status of the invoice system.",
            "nullable":true
        }
    }
}

Nested Schema : Bill Lines

Type: array

Title: Bill Lines

The bill lines resource is used to view, create or update invoice lines.

Show Source

Array of: object publicSectorInvoices-BillLine-item-patch-request

{
    "title":"Bill Lines",
    "type":"array",
    "description":"The bill lines resource is used to view, create or update invoice lines.",
    "items":{
        "$ref":"#/components/schemas/publicSectorInvoices-BillLine-item-patch-request"
    }
}

Nested Schema : publicSectorInvoices-BillLine-item-patch-request

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "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.",
            "nullable":true
        },
        "CustomerTrxLineId":{
            "type":"integer",
            "description":"Transaction line identifier on an invoice line in Fusion Receivables.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "SurchargeAmount":{
            "type":"number",
            "description":"The surcharge on the amount paid. Passed from the source application.",
            "nullable":true
        },
        "PriorAdjustmentInvoice":{
            "maxLength":"50",
            "type":"string",
            "description":"Invoice adjusted prior in the chain of adjustments.",
            "nullable":true
        },
        "CurrencyCode":{
            "maxLength":"3",
            "type":"string",
            "description":"Indicates the currency used for the transaction. Passed from the source application.",
            "nullable":true
        },
        "PriorAdjustmentLine":{
            "type":"integer",
            "description":"Invoice line adjusted prior in the chain of adjustments.",
            "nullable":true
        },
        "FeeItemId":{
            "maxLength":"30",
            "type":"string",
            "description":"Unique identifier for the fee item.",
            "nullable":true
        },
        "RecordType":{
            "maxLength":"30",
            "type":"string",
            "description":"The type of record passed from the source application.",
            "nullable":true
        },
        "Classification":{
            "maxLength":"3",
            "type":"string",
            "description":"The classification passed from the source application.",
            "nullable":true
        },
        "RecordId":{
            "maxLength":"50",
            "type":"string",
            "description":"Unique identifier for the record.",
            "nullable":true
        },
        "NextAdjustmentInvoice":{
            "maxLength":"50",
            "type":"string",
            "description":"Invoice adjusted next in the chain of adjustments.",
            "nullable":true
        },
        "MemoLineId":{
            "type":"integer",
            "description":"Memo line identifier on an invoice line in Fusion Receivables.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "BillType":{
            "maxLength":"15",
            "type":"string",
            "description":"Determines default invoice values, such as invoice form and invoice number ID. Passed from the source application.",
            "nullable":true
        },
        "LatestInvoice":{
            "maxLength":"50",
            "type":"string",
            "description":"Most recent Invoice adjusted in the chain of adjustments.",
            "nullable":true
        },
        "LatestLine":{
            "type":"integer",
            "description":"Most recent Invoice line adjusted in the chain of adjustments.",
            "nullable":true
        },
        "Quantity":{
            "title":"Invoice Quantity",
            "type":"integer",
            "description":"The unit quantity.",
            "nullable":true
        },
        "IssueDate":{
            "type":"string",
            "description":"Invoice issue date.",
            "format":"date-time",
            "nullable":true
        },
        "DiscountAmount":{
            "type":"number",
            "description":"The discount to the amount paid. Passed from the source application.",
            "nullable":true
        },
        "RenewalDate":{
            "type":"string",
            "description":"The renewal date of the license.",
            "format":"date-time",
            "nullable":true
        },
        "InvoiceLineAmount":{
            "title":"Invoice Line Amount",
            "type":"number",
            "description":"Amount that represents the quantity times the price, plus any discounts, minus any surcharges.",
            "nullable":true
        },
        "OriginalLine":{
            "type":"integer",
            "description":"Original invoice line.",
            "nullable":true
        },
        "OriginalInvoice":{
            "maxLength":"50",
            "type":"string",
            "description":"Original invoice number.",
            "nullable":true
        },
        "ExpirationDate":{
            "type":"string",
            "description":"The expiration date of the license.",
            "format":"date-time",
            "nullable":true
        },
        "Price":{
            "title":"Invoice Price",
            "type":"number",
            "description":"The fee amount or unit price.",
            "nullable":true
        },
        "DepartmentId":{
            "maxLength":"30",
            "type":"string",
            "description":"Unique identifier of the department.",
            "nullable":true
        },
        "NextAdjustmentLine":{
            "type":"integer",
            "description":"Invoice line adjusted next in the chain of adjustments.",
            "nullable":true
        }
    }
}

Response

Supported Media Types

application/json

Default Response

The following table describes the default response for this task.

Headers

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.

Root Schema : publicSectorInvoices-item-response

Type: object

Show Source

AccountingDate: string (date)

The accounting date.
Address1: string

Maximum Length: 240

The first line of the applicant or customer address.
Address2: string

Maximum Length: 240

The second line of the applicant or customer address.
Address3: string

Maximum Length: 240

The third line of the applicant or customer address.
Address4: string

Maximum Length: 240

The fourth line of the applicant or customer address.
AgencyId: integer

Default Value: 1

Unique identifier of the agency associated with the row.
BalanceAmount: number

Balance amount to be paid.
BankAccountKey: string

Maximum Length: 30

The remit to bank account type.
BankCode: string

Maximum Length: 30

The remit to bank code for the organization.
Billable: string

Maximum Length: 1

Default Value: N

Indicates whether an invoice is billable. The default value is Yes.
BillLine: array Bill Lines

Title: Bill Lines

The bill lines resource is used to view, create or update invoice lines.
BillStatus: string

Maximum Length: 30

The current status of the bill.
BillToContactId: integer (int64)

Bill to customer site use identifier on an invoice in Fusion Receivables.
BillToCustomerId: integer (int64)

Bill to customer identifier on an invoice in Fusion Receivables.
BillToMedia: string

Maximum Length: 20

Indicates the media used for billing such as print or email.
BillToSiteUseId: integer (int64)

Bill to site use identifier on an invoice in Fusion Receivables.
BillType: string

Maximum Length: 15

Determines the default invoice values for invoice form and invoice number ID. Passed from the source application.
BusBusinessName: string

Maximum Length: 100

Business entity name.
BusDbaBusinessName: string

Maximum Length: 100

The doing business as name of the business entity.
BusinessEntityId: string

Maximum Length: 50

Unique identifier for the business entity.
BusinessEntityPartyId: integer (int64)

Unique identifier for the business party.
BusinessLocationPartyId: integer (int64)

Unique identifier for the business location party ID.
BusinessProfileId: integer (int64)

Unique identifier for the business profile.
City: string

Maximum Length: 60

City of the applicant or customer address.
Country: string

Maximum Length: 3

Country for the applicant or customer address.
County: string

Maximum Length: 60

County for the applicant or customer address.
CurrencyCode: string

Title: Currency

Maximum Length: 3

Indicates the currency used for the transaction. Passed from the source application.
CustomerTrxId: integer (int64)

Transaction identifier on an invoice in Fusion Receivables.
CustTrxTypeId: integer (int64)

Transaction type identifier on an invoice in Fusion Receivables.
Description: string

Title: Invoice Description

Maximum Length: 50

Description of the invoice.
DueDate: string (date)

The date on which the payment is due.
EmailAddress: string

Maximum Length: 320

The applicant or customer email address.
FirstName: string

Maximum Length: 150

The applicant or customer first name.
Invoice: string

Title: Invoice ID

Maximum Length: 50

Unique invoice value generated using Auto Number Rule configured for the bill type for this transaction. RULE_ID is derived from the BNP_BILL_TYPE table.
InvoiceAmount: number

Title: Invoice Amount

The sum of all invoice line amounts.
InvoiceDate: string (date)

Title: Invoice Date

The invoice date.
InvoiceFormId: string

Maximum Length: 20

Unique identifier for the invoice form layout to print. Derived from BNP_BILL_TYPE.
InvoiceStatus: string

Maximum Length: 30

The current status of the invoice system.
InvoiceSystem: string

Maximum Length: 30

The invoice system to which the bill has been sent.
InvoiceType: string

Maximum Length: 30

Default Value: ORA_INVOICE

The type of invoice.
LastName: string

Maximum Length: 150

The applicant or customer last name.
LatestInvoice: string

Maximum Length: 50

Most recent invoice adjusted in the chain of adjustments.
links: array Links

Title: Links

The link relations associated with the resource instance.
LocationId: integer

Unique identifier for the party address information. Derived from PBL_PARTY_LOCATION_USE using PARTY_ID.
MiddleName: string

Maximum Length: 60

The applicant or customer middle name.
NameSuffix: string

Maximum Length: 30

The applicant or customer name suffix.
NextAdjustmentInvoice: string

Maximum Length: 50

Invoice adjusted subsequently in the chain of adjustments.
OrgId: integer (int64)

The unique identifier of the business unit associated with an invoice in Fusion Receivables.
OriginalInvoice: string

Maximum Length: 50

Original invoice number.
OwnerAddress1: string

Maximum Length: 240

First line of the owner address.
OwnerAddress2: string

Maximum Length: 240

Second line of the owner address.
OwnerAddress3: string

Maximum Length: 240

Third line of the owner address.
OwnerAddress4: string

Maximum Length: 240

Fourth line of the owner address.
OwnerCity: string

Maximum Length: 60

City associated with the owner address.
OwnerCountry: string

Maximum Length: 3

Country associated with the owner address.
OwnerCounty: string

Maximum Length: 60

County associated with the owner address.
OwnerPostalCode: string

Maximum Length: 60

Postal code associated with the owner address.
OwnerPostalPlusFourCode: string

Maximum Length: 10

Postal plus-four code associated with the owner address.
OwnerProvince: string

Maximum Length: 60

Province associated with the owner address.
OwnerState: string

Maximum Length: 60

State associated with the owner address.
PartyId: integer

Attribute used to derive party information for a person, group or organization. Passed from the source application.
PaymentStatus: string

Maximum Length: 30

The payment status of the bill.
PersonName: string

Title: Person Name

Maximum Length: 450

The applicant or customer name.
PostalCode: string

Maximum Length: 20

Postal code for applicant or customer address.
PostalPlus4Code: string

Maximum Length: 10

The Postal plus4 code for applicant or customer address.
PreferredContactMethod: string

Maximum Length: 30

The method by which a person prefers to be contacted. Passed from the source application.
PreferredContactPersonId: integer

Unique identifier of the preferred contact for a given party. Used to derive PARTY_ID from table PBL_PARTY_CONTACT_POINTS in order to derive contact name from PBL_PERSON_PROFILE table. Passed from source application.
PriorAdjustmentInvoice: string

Maximum Length: 50

Invoice adjusted previously in the chain of adjustments.
ProfileId: integer (int64)

Attribute used to derive cashier id information if payment is made through a cashier.
Province: string

Maximum Length: 60

Region code for the applicant or customer address in non-US countries.
SourceTransactionKey: integer

Unique identifier of the source transaction. Passed from the source application.
State: string

Maximum Length: 60

The state for applicant or customer address.
TermId: integer (int64)

The payment terms applicable to a fee item that assessed and due.
TransactionOrigin: string

Maximum Length: 30

Indicates where a transaction originated. Passed from the source application.

{
    "type":"object",
    "properties":{
        "ProfileId":{
            "type":"integer",
            "description":"Attribute used to derive cashier id information if payment is made through a cashier.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "OwnerAddress2":{
            "maxLength":"240",
            "type":"string",
            "description":"Second line of the owner address.",
            "nullable":true,
            "x-queryable":true
        },
        "OwnerAddress1":{
            "maxLength":"240",
            "type":"string",
            "description":"First line of the owner address.",
            "nullable":true,
            "x-queryable":true
        },
        "OwnerAddress4":{
            "maxLength":"240",
            "type":"string",
            "description":"Fourth line of the owner address.",
            "nullable":true,
            "x-queryable":true
        },
        "Invoice":{
            "title":"Invoice ID",
            "maxLength":"50",
            "type":"string",
            "description":"Unique invoice value generated using Auto Number Rule configured for the bill type for this transaction. RULE_ID is derived from the BNP_BILL_TYPE table.",
            "nullable":false,
            "x-queryable":true
        },
        "OwnerAddress3":{
            "maxLength":"240",
            "type":"string",
            "description":"Third line of the owner address.",
            "nullable":true,
            "x-queryable":true
        },
        "BusinessProfileId":{
            "type":"integer",
            "description":"Unique identifier for the business profile.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":"3",
            "type":"string",
            "description":"Indicates the currency used for the transaction. Passed from the source application.",
            "nullable":true,
            "x-queryable":true
        },
        "BusBusinessName":{
            "maxLength":"100",
            "type":"string",
            "description":"Business entity name.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SourceTransactionKey":{
            "type":"integer",
            "description":"Unique identifier of the source transaction. Passed from the source application.",
            "nullable":true,
            "x-queryable":true
        },
        "NameSuffix":{
            "maxLength":"30",
            "type":"string",
            "description":"The applicant or customer name suffix.",
            "nullable":true,
            "x-queryable":true
        },
        "PreferredContactMethod":{
            "maxLength":"30",
            "type":"string",
            "description":"The method by which a person prefers to be contacted. Passed from the source application.",
            "nullable":true,
            "x-queryable":true
        },
        "OwnerCounty":{
            "maxLength":"60",
            "type":"string",
            "description":"County associated with the owner address.",
            "nullable":true,
            "x-queryable":true
        },
        "PaymentStatus":{
            "maxLength":"30",
            "type":"string",
            "description":"The payment status of the bill.",
            "nullable":true,
            "x-queryable":true
        },
        "LatestInvoice":{
            "maxLength":"50",
            "type":"string",
            "description":"Most recent invoice adjusted in the chain of adjustments.",
            "nullable":true,
            "x-queryable":true
        },
        "BillToSiteUseId":{
            "type":"integer",
            "description":"Bill to site use identifier on an invoice in Fusion Receivables.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "BusinessLocationPartyId":{
            "type":"integer",
            "description":"Unique identifier for the business location party ID.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CustomerTrxId":{
            "type":"integer",
            "description":"Transaction identifier on an invoice in Fusion Receivables.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "BillStatus":{
            "maxLength":"30",
            "type":"string",
            "description":"The current status of the bill.",
            "nullable":true,
            "x-queryable":true
        },
        "City":{
            "maxLength":"60",
            "type":"string",
            "description":"City of the applicant or customer address.",
            "nullable":true,
            "x-queryable":true
        },
        "Province":{
            "maxLength":"60",
            "type":"string",
            "description":"Region code for the applicant or customer address in non-US countries.",
            "nullable":true,
            "x-queryable":true
        },
        "EmailAddress":{
            "maxLength":"320",
            "type":"string",
            "description":"The applicant or customer email address.",
            "nullable":true,
            "x-queryable":true
        },
        "PostalPlus4Code":{
            "maxLength":"10",
            "type":"string",
            "description":"The Postal plus4 code for applicant or customer address.",
            "nullable":true,
            "x-queryable":true
        },
        "State":{
            "maxLength":"60",
            "type":"string",
            "description":"The state for applicant or customer address.",
            "nullable":true,
            "x-queryable":true
        },
        "Country":{
            "maxLength":"3",
            "type":"string",
            "description":"Country for the applicant or customer address.",
            "nullable":true,
            "x-queryable":true
        },
        "LastName":{
            "maxLength":"150",
            "type":"string",
            "description":"The applicant or customer last name.",
            "nullable":true,
            "x-queryable":true
        },
        "BankAccountKey":{
            "maxLength":"30",
            "type":"string",
            "description":"The remit to bank account type.",
            "nullable":true,
            "x-queryable":true
        },
        "PreferredContactPersonId":{
            "type":"integer",
            "description":"Unique identifier of the preferred contact for a given party. Used to derive PARTY_ID from table PBL_PARTY_CONTACT_POINTS in order to derive contact name from PBL_PERSON_PROFILE table. Passed from source application.",
            "nullable":true,
            "x-queryable":true
        },
        "BusinessEntityId":{
            "maxLength":"50",
            "type":"string",
            "description":"Unique identifier for the business entity.",
            "nullable":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Invoice Description",
            "maxLength":"50",
            "type":"string",
            "description":"Description of the invoice.",
            "nullable":false,
            "x-queryable":true
        },
        "BillToCustomerId":{
            "type":"integer",
            "description":"Bill to customer identifier on an invoice in Fusion Receivables.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AgencyId":{
            "type":"integer",
            "description":"Unique identifier of the agency associated with the row.",
            "nullable":false,
            "default":"1",
            "x-queryable":true
        },
        "CustTrxTypeId":{
            "type":"integer",
            "description":"Transaction type identifier on an invoice in Fusion Receivables.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "OwnerCountry":{
            "maxLength":"3",
            "type":"string",
            "description":"Country associated with the owner address.",
            "nullable":true,
            "x-queryable":true
        },
        "PostalCode":{
            "maxLength":"20",
            "type":"string",
            "description":"Postal code for applicant or customer address.",
            "nullable":true,
            "x-queryable":true
        },
        "InvoiceAmount":{
            "title":"Invoice Amount",
            "type":"number",
            "description":"The sum of all invoice line amounts.",
            "nullable":true,
            "x-queryable":true
        },
        "AccountingDate":{
            "type":"string",
            "description":"The accounting date.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "County":{
            "maxLength":"60",
            "type":"string",
            "description":"County for the applicant or customer address.",
            "nullable":true,
            "x-queryable":true
        },
        "PriorAdjustmentInvoice":{
            "maxLength":"50",
            "type":"string",
            "description":"Invoice adjusted previously in the chain of adjustments.",
            "nullable":true,
            "x-queryable":true
        },
        "Address4":{
            "maxLength":"240",
            "type":"string",
            "description":"The fourth line of the applicant or customer address.",
            "nullable":true,
            "x-queryable":true
        },
        "BillToMedia":{
            "maxLength":"20",
            "type":"string",
            "description":"Indicates the media used for billing such as print or email.",
            "nullable":true,
            "x-queryable":true
        },
        "InvoiceFormId":{
            "maxLength":"20",
            "type":"string",
            "description":"Unique identifier for the invoice form layout to print. Derived from BNP_BILL_TYPE.",
            "nullable":true,
            "x-queryable":true
        },
        "OwnerProvince":{
            "maxLength":"60",
            "type":"string",
            "description":"Province associated with the owner address.",
            "nullable":true,
            "x-queryable":true
        },
        "InvoiceDate":{
            "title":"Invoice Date",
            "type":"string",
            "description":"The invoice date.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "DueDate":{
            "type":"string",
            "description":"The date on which the payment is due.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "TermId":{
            "type":"integer",
            "description":"The payment terms applicable to a fee item that assessed and due.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "NextAdjustmentInvoice":{
            "maxLength":"50",
            "type":"string",
            "description":"Invoice adjusted subsequently in the chain of adjustments.",
            "nullable":true,
            "x-queryable":true
        },
        "OwnerState":{
            "maxLength":"60",
            "type":"string",
            "description":"State associated with the owner address.",
            "nullable":true,
            "x-queryable":true
        },
        "BillType":{
            "maxLength":"15",
            "type":"string",
            "description":"Determines the default invoice values for invoice form and invoice number ID. Passed from the source application.",
            "nullable":true,
            "x-queryable":true
        },
        "PersonName":{
            "title":"Person Name",
            "maxLength":"450",
            "type":"string",
            "description":"The applicant or customer name.",
            "nullable":true,
            "x-queryable":true
        },
        "BalanceAmount":{
            "type":"number",
            "description":"Balance amount to be paid.",
            "nullable":true,
            "x-queryable":true
        },
        "FirstName":{
            "maxLength":"150",
            "type":"string",
            "description":"The applicant or customer first name.",
            "nullable":true,
            "x-queryable":true
        },
        "BillLine":{
            "title":"Bill Lines",
            "type":"array",
            "description":"The bill lines resource is used to view, create or update invoice lines.",
            "items":{
                "$ref":"#/components/schemas/publicSectorInvoices-BillLine-item-response"
            }
        },
        "Billable":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether an invoice is billable. The default value is Yes.",
            "nullable":true,
            "default":"N",
            "x-queryable":true
        },
        "BusDbaBusinessName":{
            "maxLength":"100",
            "type":"string",
            "description":"The doing business as name of the business entity.",
            "nullable":true,
            "x-queryable":true
        },
        "OwnerPostalPlusFourCode":{
            "maxLength":"10",
            "type":"string",
            "description":"Postal plus-four code associated with the owner address.",
            "nullable":true,
            "x-queryable":true
        },
        "Address2":{
            "maxLength":"240",
            "type":"string",
            "description":"The second line of the applicant or customer address.",
            "nullable":true,
            "x-queryable":true
        },
        "LocationId":{
            "type":"integer",
            "description":"Unique identifier for the party address information. Derived from PBL_PARTY_LOCATION_USE using PARTY_ID.",
            "nullable":false,
            "x-queryable":true
        },
        "TransactionOrigin":{
            "maxLength":"30",
            "type":"string",
            "description":"Indicates where a transaction originated. Passed from the source application.",
            "nullable":true,
            "x-queryable":true
        },
        "Address3":{
            "maxLength":"240",
            "type":"string",
            "description":"The third line of the applicant or customer address.",
            "nullable":true,
            "x-queryable":true
        },
        "OwnerCity":{
            "maxLength":"60",
            "type":"string",
            "description":"City associated with the owner address.",
            "nullable":true,
            "x-queryable":true
        },
        "BankCode":{
            "maxLength":"30",
            "type":"string",
            "description":"The remit to bank code for the organization.",
            "nullable":true,
            "x-queryable":true
        },
        "Address1":{
            "maxLength":"240",
            "type":"string",
            "description":"The first line of the applicant or customer address.",
            "nullable":true,
            "x-queryable":true
        },
        "MiddleName":{
            "maxLength":"60",
            "type":"string",
            "description":"The applicant or customer middle name.",
            "nullable":true,
            "x-queryable":true
        },
        "BillToContactId":{
            "type":"integer",
            "description":"Bill to customer site use identifier on an invoice in Fusion Receivables.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "InvoiceSystem":{
            "maxLength":"30",
            "type":"string",
            "description":"The invoice system to which the bill has been sent.",
            "nullable":true,
            "x-queryable":true
        },
        "InvoiceType":{
            "maxLength":"30",
            "type":"string",
            "description":"The type of invoice.",
            "nullable":true,
            "default":"ORA_INVOICE",
            "x-queryable":true
        },
        "BusinessEntityPartyId":{
            "type":"integer",
            "description":"Unique identifier for the business party.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "OrgId":{
            "type":"integer",
            "description":"The unique identifier of the business unit associated with an invoice in Fusion Receivables.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "OwnerPostalCode":{
            "maxLength":"60",
            "type":"string",
            "description":"Postal code associated with the owner address.",
            "nullable":true,
            "x-queryable":true
        },
        "PartyId":{
            "type":"integer",
            "description":"Attribute used to derive party information for a person, group or organization. Passed from the source application.",
            "nullable":true,
            "x-queryable":true
        },
        "OriginalInvoice":{
            "maxLength":"50",
            "type":"string",
            "description":"Original invoice number.",
            "nullable":true,
            "x-queryable":true
        },
        "InvoiceStatus":{
            "maxLength":"30",
            "type":"string",
            "description":"The current status of the invoice system.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Bill Lines

Type: array

Title: Bill Lines

The bill lines resource is used to view, create or update invoice lines.

Show Source

Array of: object publicSectorInvoices-BillLine-item-response

{
    "title":"Bill Lines",
    "type":"array",
    "description":"The bill lines resource is used to view, create or update invoice lines.",
    "items":{
        "$ref":"#/components/schemas/publicSectorInvoices-BillLine-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : publicSectorInvoices-BillLine-item-response

Type: object

Show Source

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.

{
    "type":"object",
    "properties":{
        "Invoice":{
            "maxLength":"50",
            "type":"string",
            "description":"The invoice number for the associated bill header.",
            "nullable":false,
            "x-queryable":true
        },
        "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.",
            "nullable":true,
            "x-queryable":true
        },
        "AgencyId":{
            "type":"integer",
            "description":"Unique identifier of the agency associated with the row.",
            "nullable":false,
            "default":"1",
            "x-queryable":true
        },
        "CustomerTrxLineId":{
            "type":"integer",
            "description":"Transaction line identifier on an invoice line in Fusion Receivables.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SurchargeAmount":{
            "type":"number",
            "description":"The surcharge on the amount paid. Passed from the source application.",
            "nullable":true,
            "x-queryable":true
        },
        "PriorAdjustmentInvoice":{
            "maxLength":"50",
            "type":"string",
            "description":"Invoice adjusted prior in the chain of adjustments.",
            "nullable":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "maxLength":"3",
            "type":"string",
            "description":"Indicates the currency used for the transaction. Passed from the source application.",
            "nullable":true,
            "x-queryable":true
        },
        "PriorAdjustmentLine":{
            "type":"integer",
            "description":"Invoice line adjusted prior in the chain of adjustments.",
            "nullable":true,
            "x-queryable":true
        },
        "FeeItemId":{
            "maxLength":"30",
            "type":"string",
            "description":"Unique identifier for the fee item.",
            "nullable":true,
            "x-queryable":true
        },
        "RecordType":{
            "maxLength":"30",
            "type":"string",
            "description":"The type of record passed from the source application.",
            "nullable":true,
            "x-queryable":true
        },
        "Classification":{
            "maxLength":"3",
            "type":"string",
            "description":"The classification passed from the source application.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RecordId":{
            "maxLength":"50",
            "type":"string",
            "description":"Unique identifier for the record.",
            "nullable":true,
            "x-queryable":true
        },
        "NextAdjustmentInvoice":{
            "maxLength":"50",
            "type":"string",
            "description":"Invoice adjusted next in the chain of adjustments.",
            "nullable":true,
            "x-queryable":true
        },
        "MemoLineId":{
            "type":"integer",
            "description":"Memo line identifier on an invoice line in Fusion Receivables.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "BillType":{
            "maxLength":"15",
            "type":"string",
            "description":"Determines default invoice values, such as invoice form and invoice number ID. Passed from the source application.",
            "nullable":true,
            "x-queryable":true
        },
        "LatestInvoice":{
            "maxLength":"50",
            "type":"string",
            "description":"Most recent Invoice adjusted in the chain of adjustments.",
            "nullable":true,
            "x-queryable":true
        },
        "InvoiceLine":{
            "type":"integer",
            "description":"The invoice line number.",
            "nullable":false,
            "x-hints":{
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "LatestLine":{
            "type":"integer",
            "description":"Most recent Invoice line adjusted in the chain of adjustments.",
            "nullable":true,
            "x-queryable":true
        },
        "Quantity":{
            "title":"Invoice Quantity",
            "type":"integer",
            "description":"The unit quantity.",
            "nullable":true,
            "x-queryable":true
        },
        "IssueDate":{
            "type":"string",
            "description":"Invoice issue date.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "DiscountAmount":{
            "type":"number",
            "description":"The discount to the amount paid. Passed from the source application.",
            "nullable":true,
            "x-queryable":true
        },
        "RenewalDate":{
            "type":"string",
            "description":"The renewal date of the license.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "InvoiceLineAmount":{
            "title":"Invoice Line Amount",
            "type":"number",
            "description":"Amount that represents the quantity times the price, plus any discounts, minus any surcharges.",
            "nullable":true,
            "x-queryable":true
        },
        "OriginalLine":{
            "type":"integer",
            "description":"Original invoice line.",
            "nullable":true,
            "x-queryable":true
        },
        "OriginalInvoice":{
            "maxLength":"50",
            "type":"string",
            "description":"Original invoice number.",
            "nullable":true,
            "x-queryable":true
        },
        "ExpirationDate":{
            "type":"string",
            "description":"The expiration date of the license.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "Price":{
            "title":"Invoice Price",
            "type":"number",
            "description":"The fee amount or unit price.",
            "nullable":true,
            "x-queryable":true
        },
        "DepartmentId":{
            "maxLength":"30",
            "type":"string",
            "description":"Unique identifier of the department.",
            "nullable":true,
            "x-queryable":true
        },
        "NextAdjustmentLine":{
            "type":"integer",
            "description":"Invoice line adjusted next in the chain of adjustments.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

changeIndicator: string

Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Links

BillLine

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

Parameters:

publicSectorInvoicesUniqID: $request.path.publicSectorInvoicesUniqID

The bill lines resource is used to view, create or update invoice lines.