Get all invoice data
get
/fscmRestApi/resources/11.13.18.05/publicSectorInvoices
Request
Query Parameters
-
dependency: string
This parameter specifies dependencies which are attributes that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The attributes specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the attributes will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency attributes. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource attributes. Only the specified attributes are returned, which means that if no attributes are specified, no attributes are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource attributes. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
finder: string
Used as a predefined finder to search the collection.
Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables:- simpleSearchFinder: Finds any invoice with an invoice ID or person name that matches the criteria specified. Finder Variables:
- value; string; The unique identifer for the invoice ID or the person name.
- PrimaryKey: Finds invoices that match the primary key criteria specified. Finder Variables:
- AgencyId; integer; Unique identifier of the agency associated with the row.
- BillType; string; Used to classify invoices into groups of invoice documents that have similar characteristics. They are also used to assign sequence numbers to invoices.
- Invoice; string; Unique invoice value.
- simpleSearchFinder: Finds any invoice with an invoice ID or person name that matches the criteria specified. Finder Variables:
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified attributes. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2 -
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Response
Supported Media Types
- application/vnd.oracle.adf.resourcecollection+json
Default Response
The following table describes the default response for this task.
Root Schema : publicSectorInvoices
Type:
Show Source
object
-
count(optional):
integer
Title:
Count
The number of resource instances returned in the current range. -
hasMore(optional):
boolean
Title:
HasMore
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false. -
items(optional):
array Items
Title:
Items
The items in the collection. -
limit(optional):
integer
Title:
Limit
The actual paging size used by the server. -
links(optional):
array Items
Title:
Items
The link relations associated with the resource instance. -
offset(optional):
integer
Title:
Offset
The offset value used in the current page.
Nested Schema : Items
Type:
array
Title:
Items
The link relations associated with the resource instance.
Show Source
Nested 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.
-
BalanceAmount(optional):
number
Balance amount to be paid.
-
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. -
Billable(optional):
string
Maximum Length:
1
Indicates whether an invoice is billable. The default value is Yes. -
BillLine(optional):
array Bill Lines
Title:
Bill Lines
The invoices resource is used to view, create or update invoices. -
BillStatus(optional):
string
Maximum Length:
30
The current status of the bill. -
BillToContactId(optional):
integer(int64)
Bill to customer site use identifier on an invoice in Fusion Receivables.
-
BillToCustomerId(optional):
integer(int64)
Bill to customer identifier on an invoice in Fusion Receivables.
-
BillToMedia(optional):
string
Maximum Length:
20
Indicates the media used for billing such as print or email. -
BillToSiteUseId(optional):
integer(int64)
Bill to site use identifier on an invoice in Fusion Receivables.
-
BillType(optional):
string
Maximum Length:
15
Determines the default invoice values for invoice form and invoice number ID. Passed from the source application. -
BusBusinessName(optional):
string
Maximum Length:
100
Business entity name. -
BusDbaBusinessName(optional):
string
Maximum Length:
100
The doing business as name of the business entity. -
BusinessEntityId(optional):
string
Maximum Length:
50
Unique identifier for the business entity. -
BusinessEntityPartyId(optional):
integer(int64)
Unique identifier for the business party.
-
BusinessLocationPartyId(optional):
integer(int64)
Unique identifier for the business location party ID.
-
BusinessProfileId(optional):
integer(int64)
Unique identifier for the business profile.
-
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. -
CustomerTrxId(optional):
integer(int64)
Transaction identifier on an invoice in Fusion Receivables.
-
CustTrxTypeId(optional):
integer(int64)
Transaction type identifier on an invoice in Fusion Receivables.
-
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. -
InvoiceStatus(optional):
string
Maximum Length:
30
The current status of the invoice system. -
InvoiceSystem(optional):
string
Maximum Length:
30
The invoice system to which the bill has been sent. -
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. -
OrgId(optional):
integer(int64)
The unique identifier of the business unit associated with an invoice in Fusion Receivables.
-
OriginalInvoice(optional):
string
Maximum Length:
50
Original invoice number. -
OwnerAddress1(optional):
string
Maximum Length:
240
First line of the owner address. -
OwnerAddress2(optional):
string
Maximum Length:
240
Second line of the owner address. -
OwnerAddress3(optional):
string
Maximum Length:
240
Third line of the owner address. -
OwnerAddress4(optional):
string
Maximum Length:
240
Fourth line of the owner address. -
OwnerCity(optional):
string
Maximum Length:
60
City associated with the owner address. -
OwnerCountry(optional):
string
Maximum Length:
3
Country associated with the owner address. -
OwnerCounty(optional):
string
Maximum Length:
60
County associated with the owner address. -
OwnerPostalCode(optional):
string
Maximum Length:
60
Postal code associated with the owner address. -
OwnerPostalPlusFourCode(optional):
string
Maximum Length:
10
Postal plus-four code associated with the owner address. -
OwnerProvince(optional):
string
Maximum Length:
60
Province associated with the owner address. -
OwnerState(optional):
string
Maximum Length:
60
State associated with the owner address. -
PartyId(optional):
integer(int64)
Attribute used to derive party information for a person, group or organization. Passed from the source application.
-
PaymentStatus(optional):
string
Maximum Length:
30
The payment status of the bill. -
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. -
TermId(optional):
integer(int64)
The payment terms applicable to a fee item that assessed and due.
-
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.
-
BillType(optional):
string
Maximum Length:
15
Determines default invoice values, such as invoice form and invoice number ID. Passed from the source application. -
Classification(optional):
string
Maximum Length:
3
The classification passed from the source application. -
CurrencyCode(optional):
string
Maximum Length:
3
Indicates the currency used for the transaction. Passed from the source application. -
CustomerTrxLineId(optional):
integer(int64)
Transaction line identifier on an invoice line in Fusion Receivables.
-
DepartmentId(optional):
string
Maximum Length:
30
Unique identifier of the department. -
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.
-
ExpirationDate(optional):
string(date-time)
The expiration date of the license.
-
FeeItemId(optional):
string
Maximum Length:
30
Unique identifier for the fee item. -
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.
-
IssueDate(optional):
string(date-time)
Invoice issue date.
-
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 -
MemoLineId(optional):
integer(int64)
Memo line identifier on an invoice line in Fusion Receivables.
-
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.
-
RecordId(optional):
string
Maximum Length:
50
Unique identifier for the record. -
RecordType(optional):
string
Maximum Length:
30
The type of record passed from the source application. -
RenewalDate(optional):
string(date-time)
The renewal date of the license.
-
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.