Get all payment terms headers
get
/fscmRestApi/resources/11.13.18.05/payablesPaymentTerms
Request
Query Parameters
-
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 -
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:- PrimaryKey: Finds the payment terms.
Finder Variables:- termsId; integer; A unique identifier for the payment term.
- findByDate: Finds the payment terms with the specified date.
Finder Variables:- fromDate; string; The date when the payment term becomes valid.
- toDate; string; The date when the payment term becomes invalid.
- PrimaryKey: Finds the payment terms.
-
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.
-
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 -
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 fields. 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
You can use these queryable attributes to filter this collection resource using the q query parameter:- createdBy; string; The user who created the record.
- creationDate; string; The date when the record was created.
- cutoffDay; integer; The day of the month, after which an invoice's due or discount dates will roll to a future month.
- description; string; The information describing the payment term.
- enabledFlag; boolean; Indicates if the term is enabled.
- fromDate; string; The date when the payment term becomes valid.
- lastUpdateDate; string; The date when the record was last updated.
- lastUpdateLogin; string; The session login associated to the user who last updated the record.
- lastUpdatedBy; string; The user who last updated the record.
- name; string; The name of the payment term.
- rank; integer; A unique ranking to rate the invoice payment terms against the purchase order payment terms in accordance with the Prompt Payment Act.
- setId; integer; Identifies a set of reference data shared across business units and other entities. Also known as the Reference Data Sets, they are used to filter reference data in transactional UIs.
- termsId; integer; A unique identifier for the payment term.
- toDate; string; The date when the payment term becomes invalid.
-
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".
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 : payablesPaymentTerms
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
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: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : payablesPaymentTerms-item-response
Type:
Show Source
object
-
createdBy: string
Read Only:
true
Maximum Length:64
The user who created the record. -
creationDate: string
(date-time)
Read Only:
true
The date when the record was created. -
cutoffDay: integer
Title:
Cutoff Day
The day of the month, after which an invoice's due or discount dates will roll to a future month. -
description: string
Title:
Description
Maximum Length:240
The information describing the payment term. -
enabledFlag: boolean
Maximum Length:
1
Default Value:true
Indicates if the term is enabled. -
fromDate: string
(date)
Title:
From Date
The date when the payment term becomes valid. -
lastUpdateDate: string
(date-time)
Read Only:
true
The date when the record was last updated. -
lastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the record. -
lastUpdateLogin: string
Read Only:
true
Maximum Length:32
The session login associated to the user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
name: string
Title:
Name
Maximum Length:50
The name of the payment term. -
payablesPaymentTermsLines: array
Payment Terms Lines
Title:
Payment Terms Lines
The payables payment terms lines resource is used to manage the details about payment term lines that assist in determining the installment amount and the due date of each installment. -
payablesPaymentTermsSets: array
Payment Terms Sets
Title:
Payment Terms Sets
The payables payment terms sets resource is used to manage the details about payments terms associated to the reference data set. -
payablesPaymentTermsTranslations: array
Payment Terms Translations
Title:
Payment Terms Translations
The payables payment terms translations resource is used to manage the details about payments terms and the languages that the contents of the columns are translated in the supported languages. -
rank: integer
(int64)
Title:
Rank
A unique ranking to rate the invoice payment terms against the purchase order payment terms in accordance with the Prompt Payment Act. -
setId: integer
(int64)
Title:
Set Code
Read Only:true
Identifies a set of reference data shared across business units and other entities. Also known as the Reference Data Sets, they are used to filter reference data in transactional UIs. -
termsId: integer
(int64)
A unique identifier for the payment term.
-
toDate: string
(date)
Title:
To Date
The date when the payment term becomes invalid.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Payment Terms Lines
Type:
array
Title:
Payment Terms Lines
The payables payment terms lines resource is used to manage the details about payment term lines that assist in determining the installment amount and the due date of each installment.
Show Source
Nested Schema : Payment Terms Sets
Type:
array
Title:
Payment Terms Sets
The payables payment terms sets resource is used to manage the details about payments terms associated to the reference data set.
Show Source
Nested Schema : Payment Terms Translations
Type:
array
Title:
Payment Terms Translations
The payables payment terms translations resource is used to manage the details about payments terms and the languages that the contents of the columns are translated in the supported languages.
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.
Nested Schema : payablesPaymentTerms-payablesPaymentTermsLines-item-response
Type:
Show Source
object
-
amountDue: number
Title:
Amount Due
The maximum payment amount that is due by a certain date. -
calendar: string
Title:
Calendar
Maximum Length:30
The name of the special calendar associated with the term line. -
dayOfMonth: integer
Title:
Day of Month
The day of the month used to calculate the due date of an invoice payment line. -
days: integer
Title:
Days
The number of days after the terms date, used to calculate the due date of an invoice payment line. -
duePercent: number
Title:
Due
The percentage of a payment due by a certain date. -
firstDiscountDayOfMonth: integer
Title:
Day of Month
The day of the month used to calculate the discount date for an invoice payment line. -
firstDiscountDays: integer
Title:
Days
The number of days after the terms date, used to calculate a discount date for an invoice payment line. -
firstDiscountMonthsForward: integer
Title:
Months Ahead
The number of months ahead used to calculate a discount date for an invoice payment line. -
firstDiscountPercent: number
Title:
Discount
The percentage used to calculate the discount available for an invoice payment line. -
fixedDate: string
(date)
Title:
Fixed Date
Payment term attribute that indicates the payment due date. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
monthsAhead: integer
Title:
Months Ahead
The number of months ahead, used to calculate the due date of an invoice payment line. -
secondDiscountDayOfMonth: integer
Title:
Day of Month
The day of the month used to calculate a second discount available for an invoice payment line. -
secondDiscountDays: integer
Title:
Days
The number of days after the terms date, used to calculate a second discount available for an invoice payment line. -
secondDiscountMonthsForward: integer
Title:
Months Ahead
The number of months ahead, used to calculate a discount available for an invoice payment line. -
secondDiscountPercent: number
Title:
Discount
The percentage used to calculate the second discount available for an invoice payment line. -
sequenceNumber: integer
The number of the payment term line.
-
termsId: integer
A unique identifier for the payment term.
-
thirdDiscountDayOfMonth: integer
Title:
Day of Month
The day of the month used to calculate a third discount for an invoice payment line. -
thirdDiscountDays: integer
Title:
Days
The number of days after the terms date, used to calculate a third discount for an invoice payment line. -
thirdDiscountMonthsForward: integer
Title:
Months Ahead
The number of months ahead, used to calculate a third discount for an invoice payment line. -
thirdDiscountPercent: number
Title:
Discount
The percentage used to calculate a third discount available for an invoice payment line.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : payablesPaymentTerms-payablesPaymentTermsSets-item-response
Type:
Show Source
object
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
setName: string
Title:
Set Name
Read Only:true
Maximum Length:80
The name of the set ID.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : payablesPaymentTerms-payablesPaymentTermsTranslations-item-response
Type:
Show Source
object
-
description: string
Maximum Length:
240
The information that describes the payment term. -
language: string
Maximum Length:
4
Indicates the language code that the contents of the translatable columns are translated. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
name: string
Maximum Length:
50
The name of the payment term. -
termsId: integer
(int64)
A unique identifier for the payment term.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source