Get an interim payables document
get
/fscmRestApi/resources/11.13.18.05/interimDocumentsPayables/{DocumentPayableId}
Request
Path Parameters
-
DocumentPayableId(required): integer
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
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:
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 : interimDocumentsPayables-item-response
Type:
Show Source
object
-
AllowRemovingDocumentFlag: boolean
Maximum Length:
1
Indicates whether document removal is allowed. -
AmountWithheld: number
The amount withheld in a transaction.
-
AnticipatedValueDate: string
(date)
The anticipated value date.
-
AttributeCategory: string
Maximum Length:
150
Category that the attribute belongs to. -
AttributeEight: string
Maximum Length:
150
Attribute eight of the user descriptive flexfield. -
AttributeEleven: string
Maximum Length:
150
Attribute eleven of the user descriptive flexfield. -
AttributeFifteen: string
Maximum Length:
150
Attribute fifteen of the user descriptive flexfield. -
AttributeFive: string
Maximum Length:
150
Attribute five of the user descriptive flexfield. -
AttributeFour: string
Maximum Length:
150
Attribute four of the user descriptive flexfield. -
AttributeFourteen: string
Maximum Length:
150
Attribute fourteen of the user descriptive flexfield. -
AttributeNine: string
Maximum Length:
150
Attribute nine of the user descriptive flexfield. -
AttributeOne: string
Maximum Length:
150
Attribute one of the user descriptive flexfield. -
AttributeSeven: string
Maximum Length:
150
Attribute seven of the user descriptive flexfield. -
AttributeSix: string
Maximum Length:
150
Attribute six of the user descriptive flexfield. -
AttributeTen: string
Maximum Length:
150
Attribute ten of the user descriptive flexfield. -
AttributeThirteen: string
Maximum Length:
150
Attribute thirteen of the user descriptive flexfield. -
AttributeThree: string
Maximum Length:
150
Attribute three of the user descriptive flexfield. -
AttributeTwelve: string
Maximum Length:
150
Attribute twelve of the user descriptive flexfield. -
AttributeTwo: string
Maximum Length:
150
Attribute two of the user descriptive flexfield. -
BankAssignedReferenceCode: string
Maximum Length:
30
The bank assigned reference code. -
BankChargeAmount: number
Calculated bank charges amount.
-
BankChargeBearer: string
Maximum Length:
80
Bearer of the bank charge. -
CallingApplicationDocumentReferenceNumber: integer
(int64)
Reference number of the calling application document.
-
CallingApplicationDocumentReferenceNumberOne: string
Maximum Length:
100
Reference number one of the calling application document. -
CallingApplicationDocumentUniqueReferenceFive: string
Maximum Length:
100
Document unique reference five of the calling application. -
CallingApplicationDocumentUniqueReferenceFour: string
Maximum Length:
100
Document unique reference four of the calling application. -
CallingApplicationDocumentUniqueReferenceOne: string
Maximum Length:
100
Document unique reference one of the calling application. -
CallingApplicationDocumentUniqueReferenceThree: string
Maximum Length:
100
Document unique reference three of the calling application. -
CallingApplicationDocumentUniqueReferenceTwo: string
Maximum Length:
100
Document unique reference two of the calling application. -
CallingApplicationIdentifier: integer
(int64)
Unique identifier of the calling application.
-
DeliveryChannelCode: string
Maximum Length:
30
Code that indicates the delivery channel. -
DiscountDate: string
(date)
The computed date of the discount.
-
DocumentAmount: number
The amount specified in the document.
-
DocumentCategoryCode: string
Maximum Length:
30
Code that indicates the document category. -
DocumentCurrencyChargeAmount: number
The charge amount in the document currency.
-
DocumentCurrencyCode: string
Maximum Length:
10
Code that indicates the document currency. -
DocumentCurrencyPaymentAmount: number
The amount to be paid in document currency.
-
DocumentCurrencyTaxAmount: number
The tax amount in the document currency.
-
DocumentDate: string
(date)
Date when the document was created.
-
DocumentDescription: string
Maximum Length:
255
Description of the document. -
DocumentPayableId: integer
Finds the document payable data that matches the primary key criteria specified.
-
DocumentSequenceValue: number
Unique identifier of the document sequence.
-
DocumentType: string
Maximum Length:
30
Value of the document sequence. -
DoumentSequenceIdentifer: number
Indicates the type of the document.
-
ExclusivePaymentFlag: boolean
Maximum Length:
1
Indicates whether a payment is exclusive. -
ExternalBankAccountIdentifier: integer
(int64)
Unique identifier of an external bank account.
-
GlobalAttributeCategory: string
Maximum Length:
150
Category that the global attribute belongs to. -
GlobalAttributeDateFive: string
(date)
Document five of the global descriptive flexfield.
-
GlobalAttributeDateFour: string
(date)
Document four of the global descriptive flexfield.
-
GlobalAttributeDateOne: string
(date)
Document one of the global descriptive flexfield.
-
GlobalAttributeDateThree: string
(date)
Document three of the global descriptive flexfield.
-
GlobalAttributeDateTwo: string
(date)
Document two of the global descriptive flexfield.
-
GlobalAttributeEight: string
Maximum Length:
150
Attribute eight of the global descriptive flexfield. -
GlobalAttributeEighteen: string
Maximum Length:
150
Attribute eighteen of the global descriptive flexfield. -
GlobalAttributeEleven: string
Maximum Length:
150
Attribute eleven of the global descriptive flexfield. -
GlobalAttributeFifteen: string
Maximum Length:
150
Attribute fifteen of the global descriptive flexfield. -
GlobalAttributeFive: string
Maximum Length:
150
Attribute five of the global descriptive flexfield. -
GlobalAttributeFour: string
Maximum Length:
150
Attribute four of the global descriptive flexfield. -
GlobalAttributeFourteen: string
Maximum Length:
150
Attribute fourteen of the global descriptive flexfield. -
GlobalAttributeNine: string
Maximum Length:
150
Attribute nine of the global descriptive flexfield. -
GlobalAttributeNinteen: string
Maximum Length:
150
Attribute nineteen of the global descriptive flexfield. -
GlobalAttributeNumberFive: number
Numeric attribute five of the global descriptive flexfield.
-
GlobalAttributeNumberFour: number
Numeric attribute four of the global descriptive flexfield.
-
GlobalAttributeNumberOne: number
Numeric attribute one of the global descriptive flexfield.
-
GlobalAttributeNumberThree: number
Numeric attribute three of the global descriptive flexfield.
-
GlobalAttributeNumberTwo: number
Numeric attribute two of the global descriptive flexfield.
-
GlobalAttributeOne: string
Maximum Length:
150
Attribute one of the global descriptive flexfield. -
GlobalAttributeSeven: string
Maximum Length:
150
Attribute seven of the global descriptive flexfield. -
GlobalAttributeSeventeen: string
Maximum Length:
150
Attribute seventeen of the global descriptive flexfield. -
GlobalAttributeSix: string
Maximum Length:
150
Attribute six of the global descriptive flexfield. -
GlobalAttributeSixteen: string
Maximum Length:
150
Attribute sixteen of the global descriptive flexfield. -
GlobalAttributeTen: string
Maximum Length:
150
Attribute ten of the global descriptive flexfield. -
GlobalAttributeThirteen: string
Maximum Length:
150
Attribute thirteen of the global descriptive flexfield. -
GlobalAttributeThree: string
Maximum Length:
150
Attribute three of the global descriptive flexfield. -
GlobalAttributeTwelve: string
Maximum Length:
150
Attribute twelve of the global descriptive flexfield. -
GlobalAttributeTwenty: string
Maximum Length:
150
Attribute twenty of the global descriptive flexfield. -
GlobalAttributeTwo: string
Maximum Length:
150
Attribute two of the global descriptive flexfield. -
InterestRate: number
The rate of interest.
-
InternalBankAccountIdentifier: integer
(int64)
Unique identifier of the internal bank account.
-
InvoiceExternalPayeeIdentifier: integer
(int64)
Unique identifier of the invoice external payee.
-
InvoiceExternalPayeePartyIdentifier: integer
(int64)
Unique identifier of the invoice external payee party.
-
InvoiceExternalPayeePartySiteIdentifier: integer
(int64)
Unique identifier of the invoice external payee party site.
-
InvoiceExternalSupplierSiteIdentifier: integer
(int64)
Unique identifier of the invoice external supplier.
-
InvoicingLegalEntityIdentifier: string
Maximum Length:
18
Unique identifier of the invoicing legal entity. -
InvoicingOrganizationIdentifier: integer
(int64)
Unique identifier of the invoicing organization.
-
InvoicingOrganizationType: string
Maximum Length:
30
Indicates the type of the invoicing organization. -
LegalEntityIdentifier: number
Unique identifier of the legal entity.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
Read Only:
true
It's used to implement optimistic locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried. -
OrganizationIdentifier: integer
(int64)
Unique identifier of the organization.
-
OrganizationType: string
Maximum Length:
30
Indicates the type of the organization. -
PayeePartyIdentifier: integer
(int64)
Unique identifier of the payee party.
-
PayeePartySiteIdentifier: integer
(int64)
Unique identifier of the payee party site.
-
PayGroupCode: string
Maximum Length:
25
Code that indicates the category that suppliers or invoices belong to. Valid values are Employees, Merchandise, Nonmerchandise, Government, Domestic, and International. -
PaymentAmount: number
The amount of the payment.
-
PaymentCurrencyBankCharges: integer
(int64)
The bank charges in the payment currency.
-
PaymentCurrencyCode: string
Maximum Length:
10
Code that indicates the payment currency. -
PaymentCurrencyDiscountTaken: number
The discount taken in the payment currency.
-
PaymentDate: string
(date)
Date when payment was made.
-
PaymentDueDate: string
(date)
Date when payment is due.
-
PaymentFormatCode: string
Maximum Length:
30
Code that indicates the payment format. -
PaymentFunction: string
Maximum Length:
30
Code that indicates the function or purpose of the payment. Valid values are present in the IBY_PAYMENT_FUNCTIONS lookup. Values include SUPPLIER_PAYMENT, CUSTOMER_REFUNDS, and so on. -
PaymentGroupingNumber: integer
(int64)
The payment grouping number.
-
PaymentMethodCode: string
Maximum Length:
30
Code that indicates the payment method. -
PaymentProcessTransactionTypeCode: string
Maximum Length:
100
Code that indicates the payment process transaction code. -
PaymentProfileIdentifier: integer
(int64)
Unique identifier of the payment profile.
-
PaymentReasonCode: string
Maximum Length:
30
Code that indicates the reason for payment. -
PaymentReasonComments: string
Maximum Length:
240
Comments regarding the payment reason. -
ProcessType: string
Maximum Length:
30
Indicates the type of process. -
PurchaseOrderNumber: string
Maximum Length:
255
The purchase order number. -
RelationshipIdentifier: integer
(int64)
The unique identifier of the relationship between payee and supplier that sends the invoice.
-
RemittanceMessageOne: string
Maximum Length:
150
Remittance message one of the interim payables document. -
RemittanceMessageThree: string
Maximum Length:
150
Remittance message three of the interim payables document. -
RemittanceMessageTwo: string
Maximum Length:
150
Remittance message two of the interim payables document. -
RemitToLocationIdentifier: integer
(int64)
Unique identifier of the remit-to location.
-
SettlementPriority: string
Maximum Length:
30
Indicates the priority for executing a payment. -
SupplierSiteIdentifier: integer
(int64)
Unique identifier of the supplier site.
-
UniqueRemittanceIdentifier: string
Maximum Length:
256
Unique identifier of the remittance provided by the payee. -
UniqueRemittanceIdentifierCheckDigit: string
Maximum Length:
30
The check digit that validates the unique remittance identifier. -
ValidationErrorMessage: string
Read Only:
true
Error messages related to the payment method validation failure. -
ValidationSuccessIndicator: string
Read Only:
true
Indicates whether the document validation based on the payment method was successful.
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.