Get an invoice data
get
/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>
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields 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 fields 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 fields. 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 fields. Only the specified fields are returned, which means that if no fields are specified, no fields 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 fields. 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 -
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
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.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version(required):
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : publicSectorInvoices-item-response
Type:
Show Source
object
-
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.
Nested Schema : Bill Lines
Type:
array
Title:
Bill Lines
The bill lines resource is used to view, create or update invoice lines.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorInvoices-BillLine-item-response
Type:
Show Source
object
-
AgencyId: integer
Default Value:
1
Unique identifier of the agency associated with the row. -
BillType: string
Maximum Length:
15
Determines default invoice values, such as invoice form and invoice number ID. Passed from the source application. -
Classification: string
Maximum Length:
3
The classification passed from the source application. -
CurrencyCode: string
Maximum Length:
3
Indicates the currency used for the transaction. Passed from the source application. -
CustomerTrxLineId: integer
(int64)
Transaction line identifier on an invoice line in Fusion Receivables.
-
DepartmentId: string
Maximum Length:
30
Unique identifier of the department. -
Description: string
Maximum Length:
100
Description of the fee passed from the source application or of the fee (service charge) passed from the payment application. -
DiscountAmount: number
The discount to the amount paid. Passed from the source application.
-
ExpirationDate: string
(date-time)
The expiration date of the license.
-
FeeItemId: string
Maximum Length:
30
Unique identifier for the fee item. -
Invoice: string
Maximum Length:
50
The invoice number for the associated bill header. -
InvoiceLine: integer
The invoice line number.
-
InvoiceLineAmount: number
Title:
Invoice Line Amount
Amount that represents the quantity times the price, plus any discounts, minus any surcharges. -
IssueDate: string
(date-time)
Invoice issue date.
-
LatestInvoice: string
Maximum Length:
50
Most recent Invoice adjusted in the chain of adjustments. -
LatestLine: integer
Most recent Invoice line adjusted in the chain of adjustments.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MemoLineId: integer
(int64)
Memo line identifier on an invoice line in Fusion Receivables.
-
NextAdjustmentInvoice: string
Maximum Length:
50
Invoice adjusted next in the chain of adjustments. -
NextAdjustmentLine: integer
Invoice line adjusted next in the chain of adjustments.
-
OriginalInvoice: string
Maximum Length:
50
Original invoice number. -
OriginalLine: integer
Original invoice line.
-
Price: number
Title:
Invoice Price
The fee amount or unit price. -
PriorAdjustmentInvoice: string
Maximum Length:
50
Invoice adjusted prior in the chain of adjustments. -
PriorAdjustmentLine: integer
Invoice line adjusted prior in the chain of adjustments.
-
Quantity: integer
Title:
Invoice Quantity
The unit quantity. -
RecordId: string
Maximum Length:
50
Unique identifier for the record. -
RecordType: string
Maximum Length:
30
The type of record passed from the source application. -
RenewalDate: string
(date-time)
The renewal date of the license.
-
SurchargeAmount: number
The surcharge on the amount paid. Passed from the source application.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Links
- BillLine
-
Operation: /fscmRestApi/resources/11.13.18.05/publicSectorInvoices/{publicSectorInvoicesUniqID}/child/BillLineParameters:
- publicSectorInvoicesUniqID:
$request.path.publicSectorInvoicesUniqID
The bill lines resource is used to view, create or update invoice lines. - publicSectorInvoicesUniqID: