Update an invoice data
patch
/fscmRestApi/resources/11.13.18.05/publicSectorInvoices/{publicSectorInvoicesUniqID}
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>
The following table describes the body parameters in the request for this task.
Root Schema : publicSectorInvoices-item
Type:
Show Source
object
-
AccountingDate(optional):
string(date)
The accounting date.
-
Address1(optional):
string
Maximum Length:
240
The first line of the applicant or customer address. -
Address2(optional):
string
Maximum Length:
240
The second line of the applicant or customer address. -
Address3(optional):
string
Maximum Length:
240
The third line of the applicant or customer address. -
Address4(optional):
string
Maximum Length:
240
The fourth line of the applicant or customer address. -
AgencyId(optional):
integer(int64)
Unique identifier of the agency associated with the row.
-
BankAccountKey(optional):
string
Maximum Length:
30
The remit to bank account type. -
BankCode(optional):
string
Maximum Length:
30
The remit to bank code for the organization. -
BillLine(optional):
array Bill Lines
Title:
Bill Lines
The invoices resource is used to view, create or update invoices. -
BillToMedia(optional):
string
Maximum Length:
20
Indicates the media used for billing such as print or email. -
BillType(optional):
string
Maximum Length:
15
Determines the default invoice values for invoice form and invoice number ID. Passed from the source application. -
City(optional):
string
Maximum Length:
60
City of the applicant or customer address. -
Country(optional):
string
Maximum Length:
3
Country for the applicant or customer address. -
County(optional):
string
Maximum Length:
60
County for the applicant or customer address. -
CurrencyCode(optional):
string
Maximum Length:
3
Indicates the currency used for the transaction. Passed from the source application. -
Description(optional):
string
Maximum Length:
50
Description of the invoice. -
DueDate(optional):
string(date)
The date on which the payment is due.
-
EmailAddress(optional):
string
Maximum Length:
320
The applicant or customer email address. -
FirstName(optional):
string
Maximum Length:
150
The applicant or customer first name. -
Invoice(optional):
string
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(optional):
number
The sum of all invoice line amounts.
-
InvoiceDate(optional):
string(date)
The invoice date.
-
InvoiceFormId(optional):
string
Maximum Length:
20
Unique identifier for the invoice form layout to print. Derived from BNP_BILL_TYPE. -
InvoiceType(optional):
string
Maximum Length:
30
The type of invoice. -
LastName(optional):
string
Maximum Length:
150
The applicant or customer last name. -
LatestInvoice(optional):
string
Maximum Length:
50
Most recent invoice adjusted in the chain of adjustments. -
links(optional):
array Items
Title:
Items
Link Relations -
LocationId(optional):
integer(int64)
Unique identifier for the party address information. Derived from PBL_PARTY_LOCATION_USE using PARTY_ID.
-
MiddleName(optional):
string
Maximum Length:
60
The applicant or customer middle name. -
NameSuffix(optional):
string
Maximum Length:
30
The applicant or customer name suffix. -
NextAdjustmentInvoice(optional):
string
Maximum Length:
50
Invoice adjusted subsequently in the chain of adjustments. -
OriginalInvoice(optional):
string
Maximum Length:
50
Original invoice number. -
PartyId(optional):
integer(int64)
Attribute used to derive party information for a person, group or organization. Passed from the source application.
-
PersonName(optional):
string
Maximum Length:
450
The applicant or customer name. -
PostalCode(optional):
string
Maximum Length:
20
Postal code for applicant or customer address. -
PostalPlus4Code(optional):
string
Maximum Length:
10
The Postal plus4 code for applicant or customer address. -
PreferredContactMethod(optional):
string
Maximum Length:
30
The method by which a person prefers to be contacted. Passed from the source application. -
PreferredContactPersonId(optional):
integer(int64)
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(optional):
string
Maximum Length:
50
Invoice adjusted previously in the chain of adjustments. -
ProfileId(optional):
integer(int64)
Attribute used to derive cashier id information if payment is made through a cashier.
-
Province(optional):
string
Maximum Length:
60
Region code for the applicant or customer address in non-US countries. -
SourceTransactionKey(optional):
integer(int64)
Unique identifier of the source transaction. Passed from the source application.
-
State(optional):
string
Maximum Length:
60
The state for applicant or customer address. -
TransactionOrigin(optional):
string
Maximum Length:
30
Indicates where a transaction originated. Passed from the source application.
Nested Schema : Bill Lines
Type:
array
Title:
Bill Lines
The invoices resource is used to view, create or update invoices.
Show Source
Nested Schema : publicSectorInvoices-BillLine-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int64)
Unique identifier of the agency associated with the row.
-
CurrencyCode(optional):
string
Maximum Length:
3
Indicates the currency used for the transaction. Passed from the source application. -
Description(optional):
string
Maximum Length:
100
Description of the fee passed from the source application or of the fee (service charge) passed from the payment application. -
DiscountAmount(optional):
number
The discount to the amount paid. Passed from the source application.
-
Invoice(optional):
string
Maximum Length:
50
The invoice number for the associated bill header. -
InvoiceLine(optional):
integer(int64)
The invoice line number.
-
InvoiceLineAmount(optional):
number
Amount that represents the quantity times the price, plus any discounts, minus any surcharges.
-
LatestInvoice(optional):
string
Maximum Length:
50
Most recent Invoice adjusted in the chain of adjustments. -
LatestLine(optional):
integer(int64)
Most recent Invoice line adjusted in the chain of adjustments.
-
links(optional):
array Items
Title:
Items
Link Relations -
NextAdjustmentInvoice(optional):
string
Maximum Length:
50
Invoice adjusted next in the chain of adjustments. -
NextAdjustmentLine(optional):
integer(int64)
Invoice line adjusted next in the chain of adjustments.
-
OriginalInvoice(optional):
string
Maximum Length:
50
Original invoice number. -
OriginalLine(optional):
integer(int64)
Original invoice line.
-
Price(optional):
number
The fee amount or unit price.
-
PriorAdjustmentInvoice(optional):
string
Maximum Length:
50
Invoice adjusted prior in the chain of adjustments. -
PriorAdjustmentLine(optional):
integer(int64)
Invoice line adjusted prior in the chain of adjustments.
-
Quantity(optional):
integer(int64)
The unit quantity.
-
SurchargeAmount(optional):
number
The surcharge on the amount paid. Passed from the source application.
Nested Schema : link
Type:
Show Source
object
-
href(optional):
string
Title:
hyperlink reference
The URI to the related resource. -
rel(optional):
string
Title:
relation
The name of the relation to the resource instance. Example: self.
Response
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Default Response
The following table describes the default response for this task.
Root Schema : publicSectorInvoices-item
Type:
Show Source
object
-
AccountingDate(optional):
string(date)
The accounting date.
-
Address1(optional):
string
Maximum Length:
240
The first line of the applicant or customer address. -
Address2(optional):
string
Maximum Length:
240
The second line of the applicant or customer address. -
Address3(optional):
string
Maximum Length:
240
The third line of the applicant or customer address. -
Address4(optional):
string
Maximum Length:
240
The fourth line of the applicant or customer address. -
AgencyId(optional):
integer(int64)
Unique identifier of the agency associated with the row.
-
BankAccountKey(optional):
string
Maximum Length:
30
The remit to bank account type. -
BankCode(optional):
string
Maximum Length:
30
The remit to bank code for the organization. -
BillLine(optional):
array Bill Lines
Title:
Bill Lines
The invoices resource is used to view, create or update invoices. -
BillToMedia(optional):
string
Maximum Length:
20
Indicates the media used for billing such as print or email. -
BillType(optional):
string
Maximum Length:
15
Determines the default invoice values for invoice form and invoice number ID. Passed from the source application. -
City(optional):
string
Maximum Length:
60
City of the applicant or customer address. -
Country(optional):
string
Maximum Length:
3
Country for the applicant or customer address. -
County(optional):
string
Maximum Length:
60
County for the applicant or customer address. -
CurrencyCode(optional):
string
Maximum Length:
3
Indicates the currency used for the transaction. Passed from the source application. -
Description(optional):
string
Maximum Length:
50
Description of the invoice. -
DueDate(optional):
string(date)
The date on which the payment is due.
-
EmailAddress(optional):
string
Maximum Length:
320
The applicant or customer email address. -
FirstName(optional):
string
Maximum Length:
150
The applicant or customer first name. -
Invoice(optional):
string
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(optional):
number
The sum of all invoice line amounts.
-
InvoiceDate(optional):
string(date)
The invoice date.
-
InvoiceFormId(optional):
string
Maximum Length:
20
Unique identifier for the invoice form layout to print. Derived from BNP_BILL_TYPE. -
InvoiceType(optional):
string
Maximum Length:
30
The type of invoice. -
LastName(optional):
string
Maximum Length:
150
The applicant or customer last name. -
LatestInvoice(optional):
string
Maximum Length:
50
Most recent invoice adjusted in the chain of adjustments. -
links(optional):
array Items
Title:
Items
Link Relations -
LocationId(optional):
integer(int64)
Unique identifier for the party address information. Derived from PBL_PARTY_LOCATION_USE using PARTY_ID.
-
MiddleName(optional):
string
Maximum Length:
60
The applicant or customer middle name. -
NameSuffix(optional):
string
Maximum Length:
30
The applicant or customer name suffix. -
NextAdjustmentInvoice(optional):
string
Maximum Length:
50
Invoice adjusted subsequently in the chain of adjustments. -
OriginalInvoice(optional):
string
Maximum Length:
50
Original invoice number. -
PartyId(optional):
integer(int64)
Attribute used to derive party information for a person, group or organization. Passed from the source application.
-
PersonName(optional):
string
Maximum Length:
450
The applicant or customer name. -
PostalCode(optional):
string
Maximum Length:
20
Postal code for applicant or customer address. -
PostalPlus4Code(optional):
string
Maximum Length:
10
The Postal plus4 code for applicant or customer address. -
PreferredContactMethod(optional):
string
Maximum Length:
30
The method by which a person prefers to be contacted. Passed from the source application. -
PreferredContactPersonId(optional):
integer(int64)
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(optional):
string
Maximum Length:
50
Invoice adjusted previously in the chain of adjustments. -
ProfileId(optional):
integer(int64)
Attribute used to derive cashier id information if payment is made through a cashier.
-
Province(optional):
string
Maximum Length:
60
Region code for the applicant or customer address in non-US countries. -
SourceTransactionKey(optional):
integer(int64)
Unique identifier of the source transaction. Passed from the source application.
-
State(optional):
string
Maximum Length:
60
The state for applicant or customer address. -
TransactionOrigin(optional):
string
Maximum Length:
30
Indicates where a transaction originated. Passed from the source application.
Nested Schema : Bill Lines
Type:
array
Title:
Bill Lines
The invoices resource is used to view, create or update invoices.
Show Source
Nested Schema : publicSectorInvoices-BillLine-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int64)
Unique identifier of the agency associated with the row.
-
CurrencyCode(optional):
string
Maximum Length:
3
Indicates the currency used for the transaction. Passed from the source application. -
Description(optional):
string
Maximum Length:
100
Description of the fee passed from the source application or of the fee (service charge) passed from the payment application. -
DiscountAmount(optional):
number
The discount to the amount paid. Passed from the source application.
-
Invoice(optional):
string
Maximum Length:
50
The invoice number for the associated bill header. -
InvoiceLine(optional):
integer(int64)
The invoice line number.
-
InvoiceLineAmount(optional):
number
Amount that represents the quantity times the price, plus any discounts, minus any surcharges.
-
LatestInvoice(optional):
string
Maximum Length:
50
Most recent Invoice adjusted in the chain of adjustments. -
LatestLine(optional):
integer(int64)
Most recent Invoice line adjusted in the chain of adjustments.
-
links(optional):
array Items
Title:
Items
Link Relations -
NextAdjustmentInvoice(optional):
string
Maximum Length:
50
Invoice adjusted next in the chain of adjustments. -
NextAdjustmentLine(optional):
integer(int64)
Invoice line adjusted next in the chain of adjustments.
-
OriginalInvoice(optional):
string
Maximum Length:
50
Original invoice number. -
OriginalLine(optional):
integer(int64)
Original invoice line.
-
Price(optional):
number
The fee amount or unit price.
-
PriorAdjustmentInvoice(optional):
string
Maximum Length:
50
Invoice adjusted prior in the chain of adjustments. -
PriorAdjustmentLine(optional):
integer(int64)
Invoice line adjusted prior in the chain of adjustments.
-
Quantity(optional):
integer(int64)
The unit quantity.
-
SurchargeAmount(optional):
number
The surcharge on the amount paid. Passed from the source application.
Nested Schema : link
Type:
Show Source
object
-
href(optional):
string
Title:
hyperlink reference
The URI to the related resource. -
rel(optional):
string
Title:
relation
The name of the relation to the resource instance. Example: self.