Jump to

• Request
• Response

Get payables options for all business units

get

/fscmRestApi/resources/11.13.18.05/payablesOptions

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 payables options with the specified primary key.
    Finder Variables:
    • businessUnitId; integer; The unique business unit identifier.
• 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:
  

  • AccountingDateBasis; string; The date based on which accounting date is set during invoice entry.
  • IncomeTaxCombinedFilingProgram; string; Indicates whether the organization participates in the Combined Filing Program for income tax reporting.
  • USSGLTransactionCode; string; The USSGL Transaction Code for automatically generated interest invoices.
  • USSGLTrxDescriptiveFlexfieldContext; string; The USSGL Transaction Code descriptive flexfield context column.
  • accountForPayment; string; Defines when the accounting entries for payments will be created.
  • allowAddressChange; string; Indicates if changes to the supplier payment address on manual payments or quick payments is allowed.
  • allowAdjustmentsToPaidInvoicesFlag; boolean; Indicates whether adjustments to paid invoices is allowed.
  • allowFinalMatchingFlag; boolean; Indicates whether final matching to purchase orders is allowed.
  • allowForceApprovalFlag; boolean; Indicates the payables processors overrides the workflow and can manually approve invoices.
  • allowInvoiceBackdatingForSelfServiceInvoicesFlag; boolean; Indicates whether a self-service invoice can have an invoice date prior to the system date.
  • allowInvoiceDocumentCategoryOverrideFlag; boolean; Indicates whether users can override the default document category assigned to an invoice.
  • allowMatchingDistributionOverrideFlag; boolean; Indicates whether the users can override the matching Accounting Flexfield for an invoice distribution matched to a purchase order distribution line.
  • allowOverrideOfSupplierSiteBankAccountFlag; boolean; Indicate whether a user can charge the remit-to bank at the payment creation time.
  • allowPayeeOverrideForThirdPartyPaymentsFlag; boolean; Allow override of remit-to supplier and address for third-party payments.
  • allowPaymentDateBeforeTheSystemDateFlag; boolean; Indicates if the payment date can be prior to the system date.
  • allowPaymentDocumentCategoryOverrideFlag; boolean; Indicates whether users can override the default document category (Sequential Numbering) for payments.
  • allowRemitToSupplierOverrideForThirdPartyPaymentsFlag; boolean; Allow override of remit-to supplier and address for third-party payments.
  • allowUnitPriceChangeForQuantityBasedMatchesForSelfServiceInvoices; string; A setting that indicates whether the unit price change is allowed for purchase orders matched to self-service invoices.
  • alwaysTakeDiscFlag; boolean; Indicates if an available discount for the supplier will be taken, regardless of when the invoice is paid.
  • amountTolerances; string; Services tolerance template identifier.
  • attachmentMandatoryForSelfServiceInvoicesFlag; boolean; Makes attachments mandatory for invoices created through the supplier portal.
  • bankChargeDeductionType; string; The type of deduction for bank charges. Valid values are Standard, Negotiated, or None.
  • budgetDateBasis; string; The date based on which the budget date will be derived whether it is the accounting date, invoice date, or system date.
  • businessUnitId; integer; Indicates the business unit ID for the Payables options.
  • businessUnitName; string; Indicates the business unit name for the Payables and Procurement options.
  • createInterestInvoicesFlag; boolean; Indicates whether interest invoices are automatically created for past due invoice payments.
  • createdBy; string; The user who created the record.
  • creationDate; string; The date when the record was created.
  • disallowAttachmentDeleteFlag; boolean; Prevents the deletion of attachments for approved or validated invoices.
  • discountAllocationMethod; string; The method for distributing discount amounts taken on invoice payments.
  • enableInvoiceAccountCodingWorkflowFlag; boolean; Indicates the Invoice Routing option is enabled for the business unit.
  • enableInvoiceApprovalFlag; boolean; Indicates whether invoice approval is enabled.
  • excludeFreightFromDiscountCalculationFlag; boolean; Indicates that freight is excluded from the calculation when identifying the discount.
  • excludeTaxFromDiscountCalculationFlag; boolean; Indicates the tax amount is to be excluded from the invoice amount when the invoice amount has an applicable discount calculated.
  • federalIdentificationNumber; string; The Federal Tax Identification number of the company.
  • glDateFromReceiptFlag; boolean; The date used as the accounting date during invoice entry.
  • includeWitholdingDistInIncometaxreports; string; Indicates whether or not to include withholding distribution in income tax reports.
  • incomeTaxRegion; string; The default income tax region assigned to invoice lines for 1099 suppliers.
  • interestAllocationMethodFlag; boolean; The method used to display the interest allocation in the accounting option label. The value Y indicates that the interest allocation method is all invoice lines and the value N indicates that the interest allocation method is single distribution.
  • interestExpenseDistribution; string; The Accounting Flexfield identifier for the interest expense account.
  • invoiceCurrency; string; The invoice currency code that defaults on the invoices associated with the business unit.
  • 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.
  • ledgerCurrency; string; The currency of the ledger that the business unit is associated.
  • ledgerId; integer; The name of the ledger that the business unit is associated.
  • limitInvoiceToSinglePurchaseOrderForSelfServiceInvoicesFlag; boolean; Indicates whether a self-service invoice can be matched to multiple purchase orders.
  • locationId; integer; The identifier for the headquarters location of your company.
  • minimumInterestAmount; number; The minimum interest amount owed on a past due invoice for an interest invoice to be automatically created.
  • payDateBasis; string; The date used for selecting invoices for payment.
  • payGroup; string; The default pay group code used to group a category of suppliers or invoices into a single pay run. For example: employees, merchandise, nonmerchandise, government, domestic, and international.
  • paymentCurrency; string; The payment currency code that defaults on the invoices associated with the business unit.
  • paymentPriority; integer; A unique number between 1 (high) and 99 (low) that represents the priority of payment.
  • paymentRequestPayGroup; string; The default pay group code for payment requests. It is used to group a category of invoices into a single pay run. Invoices could be sorted into groups for payment such as employees, merchandise, nonmerchandise, government, domestic, and international.
  • paymentRequestPaymentPriority; integer; A unique number between 1 being high and 99 being low, that represents the priority of payment.
  • paymentRequestPaymentTerms; string; The default payment terms identifier for payment requests.
  • paymentTerms; string; The payment terms identifier that defaults on the supplier sites associated with the business unit.
  • prepaymentPaymentTerms; string; The default payment terms for a prepayment. For example, a company may want to have immediate payment terms for all their prepayment type invoices.
  • quantityTolerances; string; A unique identifier for a tolerance template that is used for goods tolerance.
  • recalculateInvoiceInstallmentsFlag; boolean; Indicates the ability to recalculate payment installments.
  • receiptAcceptanceDays; integer; The number of days in a receipt acceptance period.
  • requireAccountingBeforeApproval; string; Indicates the accounting preference when invoice approval is enabled. The value N indicates that the accounting will happen regardless of approval status. The value Y indicates accounting is required before approval and the value A indicates that the approval is required before accounting.
  • requireConversionRateEntryForPaymentsFlag; boolean; Indicates if conversion rates must be entered for multiple currency payments.
  • requireInvoiceGroup; string; The setting that indicates whether an invoice group is mandatory during invoice entry.
  • requireValidationBeforeApprovalFlag; boolean; Indicates that the Invoice Approval Workflow does not select any invoice for processing unless the invoice status is Validated.
  • settlementDays; integer; The number of days added to the system date to calculate a settlement date for a prepayment.
  • showAvailablePrepaymentsDuringInvoiceEntryFlag; boolean; Indicates whether available prepayments are shown during invoice entry.
  • supplierTaxRegion; string; A value of Y indicates that the supplier tax region is used as the default Income Tax Region for 1099 invoice lines.
  • termsDateBasis; string; The date used in combination with the payment terms and the invoice amount to create an invoice scheduled payment.
  • transferPOdistributionAdditionalInformationFlag; boolean; A value of Y indicates the system will transfer descriptive flexfield information from a purchase order shipment to an invoice line and from the purchase order distribution to an invoice distribution during the purchase order matching.
  • useDistributionFromPurchaseOrderFlag; boolean; Indicates whether the prepayment account should be built or defaulted.
• 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 Top

Response

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.

Body ()

Root Schema : payablesOptions

Type: object

Show Source

• 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.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"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."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/payablesOptions-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"BusinessObject"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object payablesOptions-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/payablesOptions-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : payablesOptions-item-response

Type: object

Show Source

• accountForPayment: string
  Title: Account for Payment

  Maximum Length: 30

  Default Value: BOTH

  Defines when the accounting entries for payments will be created.
• AccountingDateBasis: string
  Title: Accounting Date Basis

  Maximum Length: 25

  Default Value: INVOICE

  The date based on which accounting date is set during invoice entry.
• allowAddressChange: string
  Title: Allow override of supplier site address for single payments

  Maximum Length: 1

  Default Value: N

  Indicates if changes to the supplier payment address on manual payments or quick payments is allowed.
• allowAdjustmentsToPaidInvoicesFlag: boolean
  Title: Allow adjustments to paid invoices

  Maximum Length: 1

  Default Value: false

  Indicates whether adjustments to paid invoices is allowed.
• allowFinalMatchingFlag: boolean
  Title: Allow final matching

  Maximum Length: 1

  Default Value: false

  Indicates whether final matching to purchase orders is allowed.
• allowForceApprovalFlag: boolean
  Title: Allow force approval

  Maximum Length: 1

  Default Value: false

  Indicates the payables processors overrides the workflow and can manually approve invoices.
• allowInvoiceBackdatingForSelfServiceInvoicesFlag: boolean
  Title: Allow invoice backdating

  Maximum Length: 1

  Indicates whether a self-service invoice can have an invoice date prior to the system date.
• allowInvoiceDocumentCategoryOverrideFlag: boolean
  Title: Allow document category override

  Maximum Length: 1

  Default Value: false

  Indicates whether users can override the default document category assigned to an invoice.
• allowMatchingDistributionOverrideFlag: boolean
  Title: Allow matching distribution override

  Maximum Length: 1

  Default Value: false

  Indicates whether the users can override the matching Accounting Flexfield for an invoice distribution matched to a purchase order distribution line.
• allowOverrideOfSupplierSiteBankAccountFlag: boolean
  Title: Allow override of supplier site bank account

  Maximum Length: 1

  Default Value: false

  Indicate whether a user can charge the remit-to bank at the payment creation time.
• allowPayeeOverrideForThirdPartyPaymentsFlag: boolean
  Title: Allow payee override for third-party payments

  Maximum Length: 1

  Default Value: false

  Allow override of remit-to supplier and address for third-party payments.
• allowPaymentDateBeforeTheSystemDateFlag: boolean
  Title: Allow payment date before the system date

  Maximum Length: 1

  Default Value: false

  Indicates if the payment date can be prior to the system date.
• allowPaymentDocumentCategoryOverrideFlag: boolean
  Title: Allow document category override

  Maximum Length: 1

  Default Value: false

  Indicates whether users can override the default document category (Sequential Numbering) for payments.
• allowRemitToSupplierOverrideForThirdPartyPaymentsFlag: boolean
  Title: Allow remit-to supplier override for third-party payments

  Maximum Length: 1

  Default Value: false

  Allow override of remit-to supplier and address for third-party payments.
• allowUnitPriceChangeForQuantityBasedMatchesForSelfServiceInvoices: string
  Title: Allow Unit Price Change for Quantity-Based Matches

  Maximum Length: 30

  A setting that indicates whether the unit price change is allowed for purchase orders matched to self-service invoices.
• alwaysTakeDiscFlag: boolean
  Title: Always take discount

  Maximum Length: 1

  Default Value: false

  Indicates if an available discount for the supplier will be taken, regardless of when the invoice is paid.
• amountTolerances: string
  Services tolerance template identifier.
• attachmentMandatoryForSelfServiceInvoicesFlag: boolean
  Title: Require Attachment

  Maximum Length: 1

  Default Value: false

  Makes attachments mandatory for invoices created through the supplier portal.
• bankChargeDeductionType: string
  Maximum Length: 1

  The type of deduction for bank charges. Valid values are Standard, Negotiated, or None.
• budgetDateBasis: string
  Title: Budget Date Basis

  Maximum Length: 25

  Default Value: ACC

  The date based on which the budget date will be derived whether it is the accounting date, invoice date, or system date.
• businessUnitId: integer (int64)
  Indicates the business unit ID for the Payables options.
• businessUnitName: string
  Indicates the business unit name for the Payables and Procurement options.
• createdBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the record.
• createInterestInvoicesFlag: boolean
  Title: Create interest invoices

  Maximum Length: 1

  Default Value: false

  Indicates whether interest invoices are automatically created for past due invoice payments.
• creationDate: string (date-time)
  Read Only: true

  The date when the record was created.
• disallowAttachmentDeleteFlag: boolean
  Title: Prevent Deletion of Invoice Attachments

  Maximum Length: 1

  Default Value: false

  Prevents the deletion of attachments for approved or validated invoices.
• discountAllocationMethod: string
  Title: Discount Allocation Method

  Maximum Length: 25

  Default Value: SYSTEM

  The method for distributing discount amounts taken on invoice payments.
• enableInvoiceAccountCodingWorkflowFlag: boolean
  Title: Enable invoice account coding workflow

  Maximum Length: 1

  Default Value: false

  Indicates the Invoice Routing option is enabled for the business unit.
• enableInvoiceApprovalFlag: boolean
  Title: Enable invoice approval

  Maximum Length: 1

  Default Value: false

  Indicates whether invoice approval is enabled.
• excludeFreightFromDiscountCalculationFlag: boolean
  Title: Exclude freight from calculation

  Maximum Length: 1

  Default Value: false

  Indicates that freight is excluded from the calculation when identifying the discount.
• excludeTaxFromDiscountCalculationFlag: boolean
  Title: Exclude tax from calculation

  Maximum Length: 1

  Default Value: false

  Indicates the tax amount is to be excluded from the invoice amount when the invoice amount has an applicable discount calculated.
• federalIdentificationNumber: string
  Maximum Length: 20

  The Federal Tax Identification number of the company.
• glDateFromReceiptFlag: boolean
  Title: Accounting Date Basis

  Maximum Length: 25

  Default Value: false

  The date used as the accounting date during invoice entry.
• includeWitholdingDistInIncometaxreports: string
  Title: Include withholding distributions in income tax reports

  Maximum Length: 1

  Default Value: N

  Indicates whether or not to include withholding distribution in income tax reports.
• IncomeTaxCombinedFilingProgram: string
  Title: Use combined filing program

  Maximum Length: 1

  Default Value: N

  Indicates whether the organization participates in the Combined Filing Program for income tax reporting.
• incomeTaxRegion: string
  Title: Income Tax Region

  Maximum Length: 10

  The default income tax region assigned to invoice lines for 1099 suppliers.
• interestAllocationMethodFlag: boolean
  Title: Interest Allocation Method

  Maximum Length: 1

  Default Value: false

  The method used to display the interest allocation in the accounting option label. The value Y indicates that the interest allocation method is all invoice lines and the value N indicates that the interest allocation method is single distribution.
• interestExpenseDistribution: string
  The Accounting Flexfield identifier for the interest expense account.
• invoiceCurrency: string
  Title: Invoice Currency

  Maximum Length: 15

  The invoice currency code that defaults on the invoices associated with the business unit.
• 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.
• ledgerCurrency: string
  Maximum Length: 15

  The currency of the ledger that the business unit is associated.
• ledgerId: integer (int64)
  The name of the ledger that the business unit is associated.
• limitInvoiceToSinglePurchaseOrderForSelfServiceInvoicesFlag: boolean
  Title: Limit invoice to single purchase order

  Maximum Length: 1

  Indicates whether a self-service invoice can be matched to multiple purchase orders.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• locationId: integer (int64)
  The identifier for the headquarters location of your company.
• minimumInterestAmount: number
  Title: Minimum Interest Amount

  The minimum interest amount owed on a past due invoice for an interest invoice to be automatically created.
• payDateBasis: string
  Title: Pay Date Basis

  Maximum Length: 25

  Default Value: DISCOUNT

  The date used for selecting invoices for payment.
• payGroup: string
  Title: Pay Group

  Maximum Length: 25

  The default pay group code used to group a category of suppliers or invoices into a single pay run. For example: employees, merchandise, nonmerchandise, government, domestic, and international.
• paymentCurrency: string
  Title: Payment Currency

  Maximum Length: 15

  The payment currency code that defaults on the invoices associated with the business unit.
• paymentPriority: integer
  Title: Payment Priority

  A unique number between 1 (high) and 99 (low) that represents the priority of payment.
• paymentRequestPayGroup: string
  Title: Pay Group

  Maximum Length: 25

  The default pay group code for payment requests. It is used to group a category of invoices into a single pay run. Invoices could be sorted into groups for payment such as employees, merchandise, nonmerchandise, government, domestic, and international.
• paymentRequestPaymentPriority: integer
  Title: Payment Priority

  A unique number between 1 being high and 99 being low, that represents the priority of payment.
• paymentRequestPaymentTerms: string
  The default payment terms identifier for payment requests.
• paymentTerms: string
  The payment terms identifier that defaults on the supplier sites associated with the business unit.
• prepaymentPaymentTerms: string
  The default payment terms for a prepayment. For example, a company may want to have immediate payment terms for all their prepayment type invoices.
• quantityTolerances: string
  A unique identifier for a tolerance template that is used for goods tolerance.
• recalculateInvoiceInstallmentsFlag: boolean
  Title: Recalculate invoice installments

  Maximum Length: 1

  Default Value: false

  Indicates the ability to recalculate payment installments.
• receiptAcceptanceDays: integer (int64)
  Title: Receipt Acceptance Days

  The number of days in a receipt acceptance period.
• requireAccountingBeforeApproval: string
  Title: Require accounting before approval

  Maximum Length: 30

  Default Value: N

  Indicates the accounting preference when invoice approval is enabled. The value N indicates that the accounting will happen regardless of approval status. The value Y indicates accounting is required before approval and the value A indicates that the approval is required before accounting.
• requireConversionRateEntryForPaymentsFlag: boolean
  Title: Require conversion rate entry

  Maximum Length: 1

  Default Value: false

  Indicates if conversion rates must be entered for multiple currency payments.
• requireInvoiceGroup: string
  Title: Require invoice grouping

  Maximum Length: 1

  The setting that indicates whether an invoice group is mandatory during invoice entry.
• requireValidationBeforeApprovalFlag: boolean
  Title: Require validation before approval

  Maximum Length: 1

  Default Value: false

  Indicates that the Invoice Approval Workflow does not select any invoice for processing unless the invoice status is Validated.
• settlementDays: integer (int64)
  Title: Settlement Days

  The number of days added to the system date to calculate a settlement date for a prepayment.
• showAvailablePrepaymentsDuringInvoiceEntryFlag: boolean
  Title: Show available prepayments during invoice entry

  Maximum Length: 1

  Default Value: false

  Indicates whether available prepayments are shown during invoice entry.
• supplierTaxRegion: string
  Title: Use supplier tax region

  Maximum Length: 1

  Default Value: N

  A value of Y indicates that the supplier tax region is used as the default Income Tax Region for 1099 invoice lines.
• termsDateBasis: string
  Title: Terms Date Basis

  Maximum Length: 25

  Default Value: Invoice

  The date used in combination with the payment terms and the invoice amount to create an invoice scheduled payment.
• transferPOdistributionAdditionalInformationFlag: boolean
  Title: Transfer PO distribution additional information

  Maximum Length: 1

  Default Value: false

  A value of Y indicates the system will transfer descriptive flexfield information from a purchase order shipment to an invoice line and from the purchase order distribution to an invoice distribution during the purchase order matching.
• useDistributionFromPurchaseOrderFlag: boolean
  Title: Use distribution from purchase order

  Maximum Length: 1

  Default Value: false

  Indicates whether the prepayment account should be built or defaulted.
• USSGLTransactionCode: string
  Maximum Length: 30

  The USSGL Transaction Code for automatically generated interest invoices.
• USSGLTrxDescriptiveFlexfieldContext: string
  Maximum Length: 30

  The USSGL Transaction Code descriptive flexfield context column.

{
    "type":"object",
    "properties":{
        "requireInvoiceGroup":{
            "title":"Require invoice grouping",
            "maxLength":"1",
            "type":"string",
            "description":"The setting that indicates whether an invoice group is mandatory during invoice entry.",
            "nullable":true,
            "x-queryable":true
        },
        "interestAllocationMethodFlag":{
            "title":"Interest Allocation Method",
            "maxLength":"1",
            "type":"boolean",
            "description":"The method used to display the interest allocation in the accounting option label. The value Y indicates that the interest allocation method is all invoice lines and the value N indicates that the interest allocation method is single distribution.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "lastUpdateDate":{
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "lastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"The session login associated to the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "discountAllocationMethod":{
            "title":"Discount Allocation Method",
            "maxLength":"25",
            "type":"string",
            "description":"The method for distributing discount amounts taken on invoice payments.",
            "nullable":true,
            "default":"SYSTEM",
            "x-queryable":true
        },
        "disallowAttachmentDeleteFlag":{
            "title":"Prevent Deletion of Invoice Attachments",
            "maxLength":"1",
            "type":"boolean",
            "description":"Prevents the deletion of attachments for approved or validated invoices.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "paymentPriority":{
            "title":"Payment Priority",
            "type":"integer",
            "description":"A unique number between 1 (high) and 99 (low) that represents the priority of payment.",
            "nullable":false,
            "x-queryable":true
        },
        "allowFinalMatchingFlag":{
            "title":"Allow final matching",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether final matching to purchase orders is allowed.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "interestExpenseDistribution":{
            "type":"string",
            "description":"The Accounting Flexfield identifier for the interest expense account.",
            "nullable":true,
            "x-queryable":true
        },
        "allowPayeeOverrideForThirdPartyPaymentsFlag":{
            "title":"Allow payee override for third-party payments",
            "maxLength":"1",
            "type":"boolean",
            "description":"Allow override of remit-to supplier and address for third-party payments.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "showAvailablePrepaymentsDuringInvoiceEntryFlag":{
            "title":"Show available prepayments during invoice entry",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether available prepayments are shown during invoice entry.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "allowPaymentDocumentCategoryOverrideFlag":{
            "title":"Allow document category override",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether users can override the default document category (Sequential Numbering) for payments.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "receiptAcceptanceDays":{
            "title":"Receipt Acceptance Days",
            "type":"integer",
            "description":"The number of days in a receipt acceptance period.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "allowInvoiceDocumentCategoryOverrideFlag":{
            "title":"Allow document category override",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether users can override the default document category assigned to an invoice.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "paymentRequestPaymentTerms":{
            "type":"string",
            "description":"The default payment terms identifier for payment requests.",
            "nullable":true,
            "x-queryable":true
        },
        "amountTolerances":{
            "type":"string",
            "description":"Services tolerance template identifier.",
            "nullable":true,
            "x-queryable":true
        },
        "paymentTerms":{
            "type":"string",
            "description":"The payment terms identifier that defaults on the supplier sites associated with the business unit.",
            "nullable":true,
            "x-queryable":true
        },
        "enableInvoiceAccountCodingWorkflowFlag":{
            "title":"Enable invoice account coding workflow",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates the Invoice Routing option is enabled for the business unit.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "lastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "businessUnitName":{
            "type":"string",
            "description":"Indicates the business unit name for the Payables and Procurement options.",
            "nullable":true,
            "x-queryable":true
        },
        "allowInvoiceBackdatingForSelfServiceInvoicesFlag":{
            "title":"Allow invoice backdating",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether a self-service invoice can have an invoice date prior to the system date.",
            "nullable":true,
            "x-queryable":true
        },
        "limitInvoiceToSinglePurchaseOrderForSelfServiceInvoicesFlag":{
            "title":"Limit invoice to single purchase order",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether a self-service invoice can be matched to multiple purchase orders.",
            "nullable":true,
            "x-queryable":true
        },
        "useDistributionFromPurchaseOrderFlag":{
            "title":"Use distribution from purchase order",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the prepayment account should be built or defaulted.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "glDateFromReceiptFlag":{
            "title":"Accounting Date Basis",
            "maxLength":"25",
            "type":"boolean",
            "description":"The date used as the accounting date during invoice entry.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "creationDate":{
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "allowAdjustmentsToPaidInvoicesFlag":{
            "title":"Allow adjustments to paid invoices",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether adjustments to paid invoices is allowed.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "excludeTaxFromDiscountCalculationFlag":{
            "title":"Exclude tax from calculation",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates the tax amount is to be excluded from the invoice amount when the invoice amount has an applicable discount calculated.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "includeWitholdingDistInIncometaxreports":{
            "title":"Include withholding distributions in income tax reports",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether or not to include withholding distribution in income tax reports.",
            "nullable":true,
            "default":"N",
            "x-queryable":true
        },
        "allowOverrideOfSupplierSiteBankAccountFlag":{
            "title":"Allow override of supplier site bank account",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicate whether a user can charge the remit-to bank at the payment creation time.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "transferPOdistributionAdditionalInformationFlag":{
            "title":"Transfer PO distribution additional information",
            "maxLength":"1",
            "type":"boolean",
            "description":"A value of Y indicates the system will transfer descriptive flexfield information from a purchase order shipment to an invoice line and from the purchase order distribution to an invoice distribution during the purchase order matching.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "ledgerId":{
            "type":"integer",
            "description":"The name of the ledger that the business unit is associated.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "alwaysTakeDiscFlag":{
            "title":"Always take discount",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if an available discount for the supplier will be taken, regardless of when the invoice is paid.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "prepaymentPaymentTerms":{
            "type":"string",
            "description":"The default payment terms for a prepayment. For example, a company may want to have immediate payment terms for all their prepayment type invoices.",
            "nullable":true,
            "x-queryable":true
        },
        "attachmentMandatoryForSelfServiceInvoicesFlag":{
            "title":"Require Attachment",
            "maxLength":"1",
            "type":"boolean",
            "description":"Makes attachments mandatory for invoices created through the supplier portal.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "allowForceApprovalFlag":{
            "title":"Allow force approval",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates the payables processors overrides the workflow and can manually approve invoices.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "excludeFreightFromDiscountCalculationFlag":{
            "title":"Exclude freight from calculation",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates that freight is excluded from the calculation when identifying the discount.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "paymentCurrency":{
            "title":"Payment Currency",
            "maxLength":"15",
            "type":"string",
            "description":"The payment currency code that defaults on the invoices associated with the business unit.",
            "nullable":true,
            "x-queryable":true
        },
        "allowUnitPriceChangeForQuantityBasedMatchesForSelfServiceInvoices":{
            "title":"Allow Unit Price Change for Quantity-Based Matches",
            "maxLength":"30",
            "type":"string",
            "description":"A setting that indicates whether the unit price change is allowed for purchase orders matched to self-service invoices.",
            "nullable":true,
            "x-queryable":true
        },
        "AccountingDateBasis":{
            "title":"Accounting Date Basis",
            "maxLength":"25",
            "type":"string",
            "description":"The date based on which accounting date is set during invoice entry.",
            "nullable":true,
            "default":"INVOICE",
            "x-queryable":true
        },
        "allowAddressChange":{
            "title":"Allow override of supplier site address for single payments",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates if changes to the supplier payment address on manual payments or quick payments is allowed.",
            "nullable":true,
            "default":"N",
            "x-queryable":true
        },
        "requireConversionRateEntryForPaymentsFlag":{
            "title":"Require conversion rate entry",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if conversion rates must be entered for multiple currency payments.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "businessUnitId":{
            "type":"integer",
            "description":"Indicates the business unit ID for the Payables options.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:APPLCORE_SETID_DETERMINANT_TYPE":"BU"
            },
            "x-queryable":true
        },
        "invoiceCurrency":{
            "title":"Invoice Currency",
            "maxLength":"15",
            "type":"string",
            "description":"The invoice currency code that defaults on the invoices associated with the business unit.",
            "nullable":true,
            "x-queryable":true
        },
        "termsDateBasis":{
            "title":"Terms Date Basis",
            "maxLength":"25",
            "type":"string",
            "description":"The date used in combination with the payment terms and the invoice amount to create an invoice scheduled payment.",
            "nullable":true,
            "default":"Invoice",
            "x-queryable":true
        },
        "locationId":{
            "type":"integer",
            "description":"The identifier for the headquarters location of your company.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "createInterestInvoicesFlag":{
            "title":"Create interest invoices",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether interest invoices are automatically created for past due invoice payments.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "federalIdentificationNumber":{
            "maxLength":"20",
            "type":"string",
            "description":"The Federal Tax Identification number of the company.",
            "nullable":true,
            "x-queryable":true
        },
        "minimumInterestAmount":{
            "title":"Minimum Interest Amount",
            "type":"number",
            "description":"The minimum interest amount owed on a past due invoice for an interest invoice to be automatically created.",
            "nullable":true,
            "x-queryable":true
        },
        "bankChargeDeductionType":{
            "maxLength":"1",
            "type":"string",
            "description":"The type of deduction for bank charges. Valid values are Standard, Negotiated, or None.",
            "nullable":true,
            "x-queryable":true
        },
        "allowPaymentDateBeforeTheSystemDateFlag":{
            "title":"Allow payment date before the system date",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if the payment date can be prior to the system date.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "ledgerCurrency":{
            "maxLength":"15",
            "type":"string",
            "description":"The currency of the ledger that the business unit is associated.",
            "nullable":false,
            "x-queryable":true
        },
        "IncomeTaxCombinedFilingProgram":{
            "title":"Use combined filing program",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the organization participates in the Combined Filing Program for income tax reporting.",
            "nullable":true,
            "default":"N",
            "x-queryable":true
        },
        "USSGLTrxDescriptiveFlexfieldContext":{
            "maxLength":"30",
            "type":"string",
            "description":"The USSGL Transaction Code descriptive flexfield context column.",
            "nullable":true,
            "x-queryable":true
        },
        "paymentRequestPaymentPriority":{
            "title":"Payment Priority",
            "type":"integer",
            "description":"A unique number between 1 being high and 99 being low, that represents the priority of payment.",
            "nullable":false,
            "x-queryable":true
        },
        "incomeTaxRegion":{
            "title":"Income Tax Region",
            "maxLength":"10",
            "type":"string",
            "description":"The default income tax region assigned to invoice lines for 1099 suppliers.",
            "nullable":true,
            "x-queryable":true
        },
        "paymentRequestPayGroup":{
            "title":"Pay Group",
            "maxLength":"25",
            "type":"string",
            "description":"The default pay group code for payment requests. It is used to group a category of invoices into a single pay run. Invoices could be sorted into groups for payment such as employees, merchandise, nonmerchandise, government, domestic, and international.",
            "nullable":true,
            "x-queryable":true
        },
        "recalculateInvoiceInstallmentsFlag":{
            "title":"Recalculate invoice installments",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates the ability to recalculate payment installments.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "supplierTaxRegion":{
            "title":"Use supplier tax region",
            "maxLength":"1",
            "type":"string",
            "description":"A value of Y indicates that the supplier tax region is used as the default Income Tax Region for 1099 invoice lines.",
            "nullable":true,
            "default":"N",
            "x-queryable":true
        },
        "enableInvoiceApprovalFlag":{
            "title":"Enable invoice approval",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether invoice approval is enabled.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "quantityTolerances":{
            "type":"string",
            "description":"A unique identifier for a tolerance template that is used for goods tolerance.",
            "nullable":true,
            "x-queryable":true
        },
        "requireAccountingBeforeApproval":{
            "title":"Require accounting before approval",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the accounting preference when invoice approval is enabled. The value N indicates that the accounting will happen regardless of approval status. The value Y indicates accounting is required before approval and the value A indicates that the approval is required before accounting.",
            "nullable":true,
            "default":"N",
            "x-queryable":true
        },
        "budgetDateBasis":{
            "title":"Budget Date Basis",
            "maxLength":"25",
            "type":"string",
            "description":"The date based on which the budget date will be derived whether it is the accounting date, invoice date, or system date.",
            "nullable":true,
            "default":"ACC",
            "x-queryable":true
        },
        "allowRemitToSupplierOverrideForThirdPartyPaymentsFlag":{
            "title":"Allow remit-to supplier override for third-party payments",
            "maxLength":"1",
            "type":"boolean",
            "description":"Allow override of remit-to supplier and address for third-party payments.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "payGroup":{
            "title":"Pay Group",
            "maxLength":"25",
            "type":"string",
            "description":"The default pay group code used to group a category of suppliers or invoices into a single pay run. For example: employees, merchandise, nonmerchandise, government, domestic, and international.",
            "nullable":true,
            "x-queryable":true
        },
        "requireValidationBeforeApprovalFlag":{
            "title":"Require validation before approval",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates that the Invoice Approval Workflow does not select any invoice for processing unless the invoice status is Validated.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "USSGLTransactionCode":{
            "maxLength":"30",
            "type":"string",
            "description":"The USSGL Transaction Code for automatically generated interest invoices.",
            "nullable":true,
            "x-queryable":true
        },
        "allowMatchingDistributionOverrideFlag":{
            "title":"Allow matching distribution override",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the users can override the matching Accounting Flexfield for an invoice distribution matched to a purchase order distribution line.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "accountForPayment":{
            "title":"Account for Payment",
            "maxLength":"30",
            "type":"string",
            "description":"Defines when the accounting entries for payments will be created.",
            "nullable":false,
            "default":"BOTH",
            "x-queryable":true
        },
        "createdBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "payDateBasis":{
            "title":"Pay Date Basis",
            "maxLength":"25",
            "type":"string",
            "description":"The date used for selecting invoices for payment.",
            "nullable":true,
            "default":"DISCOUNT",
            "x-queryable":true
        },
        "settlementDays":{
            "title":"Settlement Days",
            "type":"integer",
            "description":"The number of days added to the system date to calculate a settlement date for a prepayment.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top