Jump to

• Request
• Response

Create an interim payables document

post

/fscmRestApi/resources/11.13.18.05/interimDocumentsPayables

Request

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.
• Upsert-Mode:
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "PaymentReasonComments":{
            "maxLength":"240",
            "type":"string",
            "description":"Comments regarding the payment reason.",
            "nullable":true
        },
        "AttributeTwo":{
            "maxLength":"150",
            "type":"string",
            "description":"Attribute two of the user descriptive flexfield.",
            "nullable":true
        },
        "GlobalAttributeNumberThree":{
            "type":"number",
            "description":"Numeric attribute three of the global descriptive flexfield.",
            "nullable":true
        },
        "PaymentAmount":{
            "type":"number",
            "description":"The amount of the payment.",
            "nullable":false
        },
        "GlobalAttributeFifteen":{
            "maxLength":"150",
            "type":"string",
            "description":"Attribute fifteen of the global descriptive flexfield.",
            "nullable":true
        },
        "DocumentAmount":{
            "type":"number",
            "description":"The amount specified in the document.",
            "nullable":true
        },
        "CallingApplicationDocumentUniqueReferenceOne":{
            "maxLength":"100",
            "type":"string",
            "description":"Document unique reference one of the calling application.",
            "nullable":false
        },
        "PaymentCurrencyBankCharges":{
            "type":"integer",
            "description":"The bank charges in the payment currency.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "GlobalAttributeDateFour":{
            "type":"string",
            "description":"Document four of the global descriptive flexfield.",
            "format":"date",
            "nullable":true
        },
        "LegalEntityIdentifier":{
            "type":"number",
            "description":"Unique identifier of the legal entity.",
            "nullable":false
        },
        "DoumentSequenceIdentifer":{
            "type":"number",
            "description":"Indicates the type of the document.",
            "nullable":true
        },
        "CallingApplicationDocumentUniqueReferenceThree":{
            "maxLength":"100",
            "type":"string",
            "description":"Document unique reference three of the calling application.",
            "nullable":true
        },
        "PaymentDate":{
            "type":"string",
            "description":"Date when payment was made.",
            "format":"date",
            "nullable":true
        },
        "DeliveryChannelCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Code that indicates the delivery channel.",
            "nullable":true
        },
        "RemittanceMessageThree":{
            "maxLength":"150",
            "type":"string",
            "description":"Remittance message three of the interim payables document.",
            "nullable":true
        },
        "AllowRemovingDocumentFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether document removal is allowed.",
            "nullable":false
        },
        "DiscountDate":{
            "type":"string",
            "description":"The computed date of the discount.",
            "format":"date",
            "nullable":true
        },
        "GlobalAttributeDateOne":{
            "type":"string",
            "description":"Document one of the global descriptive flexfield.",
            "format":"date",
            "nullable":true
        },
        "PaymentGroupingNumber":{
            "type":"integer",
            "description":"The payment grouping number.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "PaymentMethodCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Code that indicates the payment method.",
            "nullable":false
        },
        "PaymentCurrencyDiscountTaken":{
            "type":"number",
            "description":"The discount taken in the payment currency.",
            "nullable":true
        },
        "GlobalAttributeDateTwo":{
            "type":"string",
            "description":"Document two of the global descriptive flexfield.",
            "format":"date",
            "nullable":true
        },
        "AttributeTen":{
            "maxLength":"150",
            "type":"string",
            "description":"Attribute ten of the user descriptive flexfield.",
            "nullable":true
        },
        "CallingApplicationDocumentUniqueReferenceTwo":{
            "maxLength":"100",
            "type":"string",
            "description":"Document unique reference two of the calling application.",
            "nullable":true
        },
        "GlobalAttributeFourteen":{
            "maxLength":"150",
            "type":"string",
            "description":"Attribute fourteen of the global descriptive flexfield.",
            "nullable":true
        },
        "GlobalAttributeTwelve":{
            "maxLength":"150",
            "type":"string",
            "description":"Attribute twelve of the global descriptive flexfield.",
            "nullable":true
        },
        "PaymentFormatCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Code that indicates the payment format.",
            "nullable":true
        },
        "InvoiceExternalPayeePartySiteIdentifier":{
            "type":"integer",
            "description":"Unique identifier of the invoice external payee party site.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "GlobalAttributeEight":{
            "maxLength":"150",
            "type":"string",
            "description":"Attribute eight of the global descriptive flexfield.",
            "nullable":true
        },
        "GlobalAttributeNumberFour":{
            "type":"number",
            "description":"Numeric attribute four of the global descriptive flexfield.",
            "nullable":true
        },
        "AttributeThree":{
            "maxLength":"150",
            "type":"string",
            "description":"Attribute three of the user descriptive flexfield.",
            "nullable":true
        },
        "AttributeEleven":{
            "maxLength":"150",
            "type":"string",
            "description":"Attribute eleven of the user descriptive flexfield.",
            "nullable":true
        },
        "AttributeCategory":{
            "maxLength":"150",
            "type":"string",
            "description":"Category that the attribute belongs to.",
            "nullable":true
        },
        "GlobalAttributeEleven":{
            "maxLength":"150",
            "type":"string",
            "description":"Attribute eleven of the global descriptive flexfield.",
            "nullable":true
        },
        "GlobalAttributeEighteen":{
            "maxLength":"150",
            "type":"string",
            "description":"Attribute eighteen of the global descriptive flexfield.",
            "nullable":true
        },
        "GlobalAttributeTwenty":{
            "maxLength":"150",
            "type":"string",
            "description":"Attribute twenty of the global descriptive flexfield.",
            "nullable":true
        },
        "RelationshipIdentifier":{
            "type":"integer",
            "description":"The unique identifier of the relationship between payee and supplier that sends the invoice.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "ProcessType":{
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the type of process.",
            "nullable":true
        },
        "GlobalAttributeFive":{
            "maxLength":"150",
            "type":"string",
            "description":"Attribute five of the global descriptive flexfield.",
            "nullable":true
        },
        "DocumentCurrencyPaymentAmount":{
            "type":"number",
            "description":"The amount to be paid in document currency.",
            "nullable":true
        },
        "AttributeFifteen":{
            "maxLength":"150",
            "type":"string",
            "description":"Attribute fifteen of the user descriptive flexfield.",
            "nullable":true
        },
        "GlobalAttributeNine":{
            "maxLength":"150",
            "type":"string",
            "description":"Attribute nine of the global descriptive flexfield.",
            "nullable":true
        },
        "InterestRate":{
            "type":"number",
            "description":"The rate of interest.",
            "nullable":true
        },
        "AttributeSeven":{
            "maxLength":"150",
            "type":"string",
            "description":"Attribute seven of the user descriptive flexfield.",
            "nullable":true
        },
        "CallingApplicationDocumentReferenceNumber":{
            "type":"integer",
            "description":"Reference number of the calling application document.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "RemitToLocationIdentifier":{
            "type":"integer",
            "description":"Unique identifier of the remit-to location.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "PurchaseOrderNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"The purchase order number.",
            "nullable":true
        },
        "DocumentCurrencyTaxAmount":{
            "type":"number",
            "description":"The tax amount in the document currency.",
            "nullable":true
        },
        "DocumentPayableId":{
            "type":"integer",
            "description":"Finds the document payable data that matches the primary key criteria specified.",
            "nullable":true,
            "x-hints":{
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "GlobalAttributeCategory":{
            "maxLength":"150",
            "type":"string",
            "description":"Category that the global attribute belongs to.",
            "nullable":true
        },
        "PayeePartyIdentifier":{
            "type":"integer",
            "description":"Unique identifier of the payee party.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "GlobalAttributeOne":{
            "maxLength":"150",
            "type":"string",
            "description":"Attribute one of the global descriptive flexfield.",
            "nullable":true
        },
        "InvoiceExternalSupplierSiteIdentifier":{
            "type":"integer",
            "description":"Unique identifier of the invoice external supplier.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "CallingApplicationDocumentReferenceNumberOne":{
            "maxLength":"100",
            "type":"string",
            "description":"Reference number one of the calling application document.",
            "nullable":true
        },
        "InvoicingLegalEntityIdentifier":{
            "maxLength":"18",
            "type":"string",
            "description":"Unique identifier of the invoicing legal entity.",
            "nullable":true
        },
        "PaymentCurrencyCode":{
            "maxLength":"10",
            "type":"string",
            "description":"Code that indicates the payment currency.",
            "nullable":false
        },
        "AttributeNine":{
            "maxLength":"150",
            "type":"string",
            "description":"Attribute nine of the user descriptive flexfield.",
            "nullable":true
        },
        "AttributeFive":{
            "maxLength":"150",
            "type":"string",
            "description":"Attribute five of the user descriptive flexfield.",
            "nullable":true
        },
        "AttributeOne":{
            "maxLength":"150",
            "type":"string",
            "description":"Attribute one of the user descriptive flexfield.",
            "nullable":true
        },
        "PaymentProfileIdentifier":{
            "type":"integer",
            "description":"Unique identifier of the payment profile.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "DocumentDate":{
            "type":"string",
            "description":"Date when the document was created.",
            "format":"date",
            "nullable":true
        },
        "PayGroupCode":{
            "maxLength":"25",
            "type":"string",
            "description":"Code that indicates the category that suppliers or invoices belong to. Valid values are Employees, Merchandise, Nonmerchandise, Government, Domestic, and International.",
            "nullable":true
        },
        "DocumentCurrencyCode":{
            "maxLength":"10",
            "type":"string",
            "description":"Code that indicates the document currency.",
            "nullable":true
        },
        "GlobalAttributeDateFive":{
            "type":"string",
            "description":"Document five of the global descriptive flexfield.",
            "format":"date",
            "nullable":true
        },
        "DocumentCategoryCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Code that indicates the document category.",
            "nullable":true
        },
        "RemittanceMessageTwo":{
            "maxLength":"150",
            "type":"string",
            "description":"Remittance message two of the interim payables document.",
            "nullable":true
        },
        "RemittanceMessageOne":{
            "maxLength":"150",
            "type":"string",
            "description":"Remittance message one of the interim payables document.",
            "nullable":true
        },
        "GlobalAttributeTwo":{
            "maxLength":"150",
            "type":"string",
            "description":"Attribute two of the global descriptive flexfield.",
            "nullable":true
        },
        "SupplierSiteIdentifier":{
            "type":"integer",
            "description":"Unique identifier of the supplier site.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "DocumentSequenceValue":{
            "type":"number",
            "description":"Unique identifier of the document sequence.",
            "nullable":true
        },
        "AttributeEight":{
            "maxLength":"150",
            "type":"string",
            "description":"Attribute eight of the user descriptive flexfield.",
            "nullable":true
        },
        "GlobalAttributeThree":{
            "maxLength":"150",
            "type":"string",
            "description":"Attribute three of the global descriptive flexfield.",
            "nullable":true
        },
        "AttributeThirteen":{
            "maxLength":"150",
            "type":"string",
            "description":"Attribute thirteen of the user descriptive flexfield.",
            "nullable":true
        },
        "AmountWithheld":{
            "type":"number",
            "description":"The amount withheld in a transaction.",
            "nullable":true
        },
        "AnticipatedValueDate":{
            "type":"string",
            "description":"The anticipated value date.",
            "format":"date",
            "nullable":true
        },
        "UniqueRemittanceIdentifier":{
            "maxLength":"256",
            "type":"string",
            "description":"Unique identifier of the remittance provided by the payee.",
            "nullable":true
        },
        "CallingApplicationDocumentUniqueReferenceFive":{
            "maxLength":"100",
            "type":"string",
            "description":"Document unique reference five of the calling application.",
            "nullable":true
        },
        "GlobalAttributeTen":{
            "maxLength":"150",
            "type":"string",
            "description":"Attribute ten of the global descriptive flexfield.",
            "nullable":true
        },
        "InvoiceExternalPayeeIdentifier":{
            "type":"integer",
            "description":"Unique identifier of the invoice external payee.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "GlobalAttributeDateThree":{
            "type":"string",
            "description":"Document three of the global descriptive flexfield.",
            "format":"date",
            "nullable":true
        },
        "GlobalAttributeThirteen":{
            "maxLength":"150",
            "type":"string",
            "description":"Attribute thirteen of the global descriptive flexfield.",
            "nullable":true
        },
        "GlobalAttributeNumberFive":{
            "type":"number",
            "description":"Numeric attribute five of the global descriptive flexfield.",
            "nullable":true
        },
        "OrganizationIdentifier":{
            "type":"integer",
            "description":"Unique identifier of the organization.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "GlobalAttributeNumberTwo":{
            "type":"number",
            "description":"Numeric attribute two of the global descriptive flexfield.",
            "nullable":true
        },
        "BankChargeAmount":{
            "type":"number",
            "description":"Calculated bank charges amount.",
            "nullable":true
        },
        "ExternalBankAccountIdentifier":{
            "type":"integer",
            "description":"Unique identifier of an external bank account.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "GlobalAttributeNinteen":{
            "maxLength":"150",
            "type":"string",
            "description":"Attribute nineteen of the global descriptive flexfield.",
            "nullable":true
        },
        "CallingApplicationIdentifier":{
            "type":"integer",
            "description":"Unique identifier of the calling application.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "BankAssignedReferenceCode":{
            "maxLength":"30",
            "type":"string",
            "description":"The bank assigned reference code.",
            "nullable":true
        },
        "PaymentDueDate":{
            "type":"string",
            "description":"Date when payment is due.",
            "format":"date",
            "nullable":true
        },
        "InvoicingOrganizationIdentifier":{
            "type":"integer",
            "description":"Unique identifier of the invoicing organization.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "DocumentCurrencyChargeAmount":{
            "type":"number",
            "description":"The charge amount in the document currency.",
            "nullable":true
        },
        "PaymentReasonCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Code that indicates the reason for payment.",
            "nullable":true
        },
        "InternalBankAccountIdentifier":{
            "type":"integer",
            "description":"Unique identifier of the internal bank account.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "GlobalAttributeSeventeen":{
            "maxLength":"150",
            "type":"string",
            "description":"Attribute seventeen of the global descriptive flexfield.",
            "nullable":true
        },
        "GlobalAttributeNumberOne":{
            "type":"number",
            "description":"Numeric attribute one of the global descriptive flexfield.",
            "nullable":true
        },
        "GlobalAttributeSixteen":{
            "maxLength":"150",
            "type":"string",
            "description":"Attribute sixteen of the global descriptive flexfield.",
            "nullable":true
        },
        "PaymentProcessTransactionTypeCode":{
            "maxLength":"100",
            "type":"string",
            "description":"Code that indicates the payment process transaction code.",
            "nullable":false
        },
        "CallingApplicationDocumentUniqueReferenceFour":{
            "maxLength":"100",
            "type":"string",
            "description":"Document unique reference four of the calling application.",
            "nullable":true
        },
        "AttributeFourteen":{
            "maxLength":"150",
            "type":"string",
            "description":"Attribute fourteen of the user descriptive flexfield.",
            "nullable":true
        },
        "SettlementPriority":{
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the priority for executing a payment.",
            "nullable":true
        },
        "UniqueRemittanceIdentifierCheckDigit":{
            "maxLength":"30",
            "type":"string",
            "description":"The check digit that validates the unique remittance identifier.",
            "nullable":true
        },
        "GlobalAttributeSeven":{
            "maxLength":"150",
            "type":"string",
            "description":"Attribute seven of the global descriptive flexfield.",
            "nullable":true
        },
        "ExclusivePaymentFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether a payment is exclusive.",
            "nullable":false
        },
        "GlobalAttributeFour":{
            "maxLength":"150",
            "type":"string",
            "description":"Attribute four of the global descriptive flexfield.",
            "nullable":true
        },
        "AttributeTwelve":{
            "maxLength":"150",
            "type":"string",
            "description":"Attribute twelve of the user descriptive flexfield.",
            "nullable":true
        },
        "InvoiceExternalPayeePartyIdentifier":{
            "type":"integer",
            "description":"Unique identifier of the invoice external payee party.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "DocumentType":{
            "maxLength":"30",
            "type":"string",
            "description":"Value of the document sequence.",
            "nullable":true
        },
        "GlobalAttributeSix":{
            "maxLength":"150",
            "type":"string",
            "description":"Attribute six of the global descriptive flexfield.",
            "nullable":true
        },
        "OrganizationType":{
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the type of the organization.",
            "nullable":true
        },
        "PayeePartySiteIdentifier":{
            "type":"integer",
            "description":"Unique identifier of the payee party site.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "InvoicingOrganizationType":{
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the type of the invoicing organization.",
            "nullable":true
        },
        "DocumentDescription":{
            "maxLength":"255",
            "type":"string",
            "description":"Description of the document.",
            "nullable":true
        },
        "AttributeSix":{
            "maxLength":"150",
            "type":"string",
            "description":"Attribute six of the user descriptive flexfield.",
            "nullable":true
        },
        "AttributeFour":{
            "maxLength":"150",
            "type":"string",
            "description":"Attribute four of the user descriptive flexfield.",
            "nullable":true
        },
        "PaymentFunction":{
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true
        },
        "BankChargeBearer":{
            "maxLength":"80",
            "type":"string",
            "description":"Bearer of the bank charge.",
            "nullable":true
        }
    }
}

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 : interimDocumentsPayables-item-response

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "PaymentReasonComments":{
            "maxLength":"240",
            "type":"string",
            "description":"Comments regarding the payment reason.",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeTwo":{
            "maxLength":"150",
            "type":"string",
            "description":"Attribute two of the user descriptive flexfield.",
            "nullable":true,
            "x-queryable":true
        },
        "GlobalAttributeNumberThree":{
            "type":"number",
            "description":"Numeric attribute three of the global descriptive flexfield.",
            "nullable":true,
            "x-queryable":true
        },
        "PaymentAmount":{
            "type":"number",
            "description":"The amount of the payment.",
            "nullable":false,
            "x-queryable":true
        },
        "GlobalAttributeFifteen":{
            "maxLength":"150",
            "type":"string",
            "description":"Attribute fifteen of the global descriptive flexfield.",
            "nullable":true,
            "x-queryable":true
        },
        "DocumentAmount":{
            "type":"number",
            "description":"The amount specified in the document.",
            "nullable":true,
            "x-queryable":true
        },
        "CallingApplicationDocumentUniqueReferenceOne":{
            "maxLength":"100",
            "type":"string",
            "description":"Document unique reference one of the calling application.",
            "nullable":false,
            "x-queryable":true
        },
        "PaymentCurrencyBankCharges":{
            "type":"integer",
            "description":"The bank charges in the payment currency.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "GlobalAttributeDateFour":{
            "type":"string",
            "description":"Document four of the global descriptive flexfield.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "LegalEntityIdentifier":{
            "type":"number",
            "description":"Unique identifier of the legal entity.",
            "nullable":false,
            "x-queryable":true
        },
        "DoumentSequenceIdentifer":{
            "type":"number",
            "description":"Indicates the type of the document.",
            "nullable":true,
            "x-queryable":true
        },
        "CallingApplicationDocumentUniqueReferenceThree":{
            "maxLength":"100",
            "type":"string",
            "description":"Document unique reference three of the calling application.",
            "nullable":true,
            "x-queryable":true
        },
        "PaymentDate":{
            "type":"string",
            "description":"Date when payment was made.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "DeliveryChannelCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Code that indicates the delivery channel.",
            "nullable":true,
            "x-queryable":true
        },
        "RemittanceMessageThree":{
            "maxLength":"150",
            "type":"string",
            "description":"Remittance message three of the interim payables document.",
            "nullable":true,
            "x-queryable":true
        },
        "AllowRemovingDocumentFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether document removal is allowed.",
            "nullable":false,
            "x-queryable":true
        },
        "DiscountDate":{
            "type":"string",
            "description":"The computed date of the discount.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "GlobalAttributeDateOne":{
            "type":"string",
            "description":"Document one of the global descriptive flexfield.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "PaymentGroupingNumber":{
            "type":"integer",
            "description":"The payment grouping number.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PaymentMethodCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Code that indicates the payment method.",
            "nullable":false,
            "x-queryable":true
        },
        "PaymentCurrencyDiscountTaken":{
            "type":"number",
            "description":"The discount taken in the payment currency.",
            "nullable":true,
            "x-queryable":true
        },
        "GlobalAttributeDateTwo":{
            "type":"string",
            "description":"Document two of the global descriptive flexfield.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeTen":{
            "maxLength":"150",
            "type":"string",
            "description":"Attribute ten of the user descriptive flexfield.",
            "nullable":true,
            "x-queryable":true
        },
        "CallingApplicationDocumentUniqueReferenceTwo":{
            "maxLength":"100",
            "type":"string",
            "description":"Document unique reference two of the calling application.",
            "nullable":true,
            "x-queryable":true
        },
        "GlobalAttributeFourteen":{
            "maxLength":"150",
            "type":"string",
            "description":"Attribute fourteen of the global descriptive flexfield.",
            "nullable":true,
            "x-queryable":true
        },
        "GlobalAttributeTwelve":{
            "maxLength":"150",
            "type":"string",
            "description":"Attribute twelve of the global descriptive flexfield.",
            "nullable":true,
            "x-queryable":true
        },
        "PaymentFormatCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Code that indicates the payment format.",
            "nullable":true,
            "x-queryable":true
        },
        "InvoiceExternalPayeePartySiteIdentifier":{
            "type":"integer",
            "description":"Unique identifier of the invoice external payee party site.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "GlobalAttributeEight":{
            "maxLength":"150",
            "type":"string",
            "description":"Attribute eight of the global descriptive flexfield.",
            "nullable":true,
            "x-queryable":true
        },
        "GlobalAttributeNumberFour":{
            "type":"number",
            "description":"Numeric attribute four of the global descriptive flexfield.",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeThree":{
            "maxLength":"150",
            "type":"string",
            "description":"Attribute three of the user descriptive flexfield.",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeEleven":{
            "maxLength":"150",
            "type":"string",
            "description":"Attribute eleven of the user descriptive flexfield.",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeCategory":{
            "maxLength":"150",
            "type":"string",
            "description":"Category that the attribute belongs to.",
            "nullable":true,
            "x-queryable":true
        },
        "GlobalAttributeEleven":{
            "maxLength":"150",
            "type":"string",
            "description":"Attribute eleven of the global descriptive flexfield.",
            "nullable":true,
            "x-queryable":true
        },
        "GlobalAttributeEighteen":{
            "maxLength":"150",
            "type":"string",
            "description":"Attribute eighteen of the global descriptive flexfield.",
            "nullable":true,
            "x-queryable":true
        },
        "GlobalAttributeTwenty":{
            "maxLength":"150",
            "type":"string",
            "description":"Attribute twenty of the global descriptive flexfield.",
            "nullable":true,
            "x-queryable":true
        },
        "RelationshipIdentifier":{
            "type":"integer",
            "description":"The unique identifier of the relationship between payee and supplier that sends the invoice.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ProcessType":{
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the type of process.",
            "nullable":true,
            "x-queryable":true
        },
        "GlobalAttributeFive":{
            "maxLength":"150",
            "type":"string",
            "description":"Attribute five of the global descriptive flexfield.",
            "nullable":true,
            "x-queryable":true
        },
        "DocumentCurrencyPaymentAmount":{
            "type":"number",
            "description":"The amount to be paid in document currency.",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeFifteen":{
            "maxLength":"150",
            "type":"string",
            "description":"Attribute fifteen of the user descriptive flexfield.",
            "nullable":true,
            "x-queryable":true
        },
        "GlobalAttributeNine":{
            "maxLength":"150",
            "type":"string",
            "description":"Attribute nine of the global descriptive flexfield.",
            "nullable":true,
            "x-queryable":true
        },
        "InterestRate":{
            "type":"number",
            "description":"The rate of interest.",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeSeven":{
            "maxLength":"150",
            "type":"string",
            "description":"Attribute seven of the user descriptive flexfield.",
            "nullable":true,
            "x-queryable":true
        },
        "CallingApplicationDocumentReferenceNumber":{
            "type":"integer",
            "description":"Reference number of the calling application document.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "RemitToLocationIdentifier":{
            "type":"integer",
            "description":"Unique identifier of the remit-to location.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PurchaseOrderNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"The purchase order number.",
            "nullable":true,
            "x-queryable":true
        },
        "DocumentCurrencyTaxAmount":{
            "type":"number",
            "description":"The tax amount in the document currency.",
            "nullable":true,
            "x-queryable":true
        },
        "DocumentPayableId":{
            "type":"integer",
            "description":"Finds the document payable data that matches the primary key criteria specified.",
            "nullable":true,
            "x-hints":{
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "GlobalAttributeCategory":{
            "maxLength":"150",
            "type":"string",
            "description":"Category that the global attribute belongs to.",
            "nullable":true,
            "x-queryable":true
        },
        "PayeePartyIdentifier":{
            "type":"integer",
            "description":"Unique identifier of the payee party.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ValidationErrorMessage":{
            "type":"string",
            "description":"Error messages related to the payment method validation failure.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "GlobalAttributeOne":{
            "maxLength":"150",
            "type":"string",
            "description":"Attribute one of the global descriptive flexfield.",
            "nullable":true,
            "x-queryable":true
        },
        "InvoiceExternalSupplierSiteIdentifier":{
            "type":"integer",
            "description":"Unique identifier of the invoice external supplier.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CallingApplicationDocumentReferenceNumberOne":{
            "maxLength":"100",
            "type":"string",
            "description":"Reference number one of the calling application document.",
            "nullable":true,
            "x-queryable":true
        },
        "InvoicingLegalEntityIdentifier":{
            "maxLength":"18",
            "type":"string",
            "description":"Unique identifier of the invoicing legal entity.",
            "nullable":true,
            "x-queryable":true
        },
        "PaymentCurrencyCode":{
            "maxLength":"10",
            "type":"string",
            "description":"Code that indicates the payment currency.",
            "nullable":false,
            "x-queryable":true
        },
        "AttributeNine":{
            "maxLength":"150",
            "type":"string",
            "description":"Attribute nine of the user descriptive flexfield.",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeFive":{
            "maxLength":"150",
            "type":"string",
            "description":"Attribute five of the user descriptive flexfield.",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeOne":{
            "maxLength":"150",
            "type":"string",
            "description":"Attribute one of the user descriptive flexfield.",
            "nullable":true,
            "x-queryable":true
        },
        "PaymentProfileIdentifier":{
            "type":"integer",
            "description":"Unique identifier of the payment profile.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "DocumentDate":{
            "type":"string",
            "description":"Date when the document was created.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "PayGroupCode":{
            "maxLength":"25",
            "type":"string",
            "description":"Code that indicates the category that suppliers or invoices belong to. Valid values are Employees, Merchandise, Nonmerchandise, Government, Domestic, and International.",
            "nullable":true,
            "x-queryable":true
        },
        "DocumentCurrencyCode":{
            "maxLength":"10",
            "type":"string",
            "description":"Code that indicates the document currency.",
            "nullable":true,
            "x-queryable":true
        },
        "GlobalAttributeDateFive":{
            "type":"string",
            "description":"Document five of the global descriptive flexfield.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "DocumentCategoryCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Code that indicates the document category.",
            "nullable":true,
            "x-queryable":true
        },
        "RemittanceMessageTwo":{
            "maxLength":"150",
            "type":"string",
            "description":"Remittance message two of the interim payables document.",
            "nullable":true,
            "x-queryable":true
        },
        "RemittanceMessageOne":{
            "maxLength":"150",
            "type":"string",
            "description":"Remittance message one of the interim payables document.",
            "nullable":true,
            "x-queryable":true
        },
        "GlobalAttributeTwo":{
            "maxLength":"150",
            "type":"string",
            "description":"Attribute two of the global descriptive flexfield.",
            "nullable":true,
            "x-queryable":true
        },
        "SupplierSiteIdentifier":{
            "type":"integer",
            "description":"Unique identifier of the supplier site.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "DocumentSequenceValue":{
            "type":"number",
            "description":"Unique identifier of the document sequence.",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeEight":{
            "maxLength":"150",
            "type":"string",
            "description":"Attribute eight of the user descriptive flexfield.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "GlobalAttributeThree":{
            "maxLength":"150",
            "type":"string",
            "description":"Attribute three of the global descriptive flexfield.",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeThirteen":{
            "maxLength":"150",
            "type":"string",
            "description":"Attribute thirteen of the user descriptive flexfield.",
            "nullable":true,
            "x-queryable":true
        },
        "AmountWithheld":{
            "type":"number",
            "description":"The amount withheld in a transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "AnticipatedValueDate":{
            "type":"string",
            "description":"The anticipated value date.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "UniqueRemittanceIdentifier":{
            "maxLength":"256",
            "type":"string",
            "description":"Unique identifier of the remittance provided by the payee.",
            "nullable":true,
            "x-queryable":true
        },
        "CallingApplicationDocumentUniqueReferenceFive":{
            "maxLength":"100",
            "type":"string",
            "description":"Document unique reference five of the calling application.",
            "nullable":true,
            "x-queryable":true
        },
        "GlobalAttributeTen":{
            "maxLength":"150",
            "type":"string",
            "description":"Attribute ten of the global descriptive flexfield.",
            "nullable":true,
            "x-queryable":true
        },
        "InvoiceExternalPayeeIdentifier":{
            "type":"integer",
            "description":"Unique identifier of the invoice external payee.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "GlobalAttributeDateThree":{
            "type":"string",
            "description":"Document three of the global descriptive flexfield.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "GlobalAttributeThirteen":{
            "maxLength":"150",
            "type":"string",
            "description":"Attribute thirteen of the global descriptive flexfield.",
            "nullable":true,
            "x-queryable":true
        },
        "GlobalAttributeNumberFive":{
            "type":"number",
            "description":"Numeric attribute five of the global descriptive flexfield.",
            "nullable":true,
            "x-queryable":true
        },
        "OrganizationIdentifier":{
            "type":"integer",
            "description":"Unique identifier of the organization.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "GlobalAttributeNumberTwo":{
            "type":"number",
            "description":"Numeric attribute two of the global descriptive flexfield.",
            "nullable":true,
            "x-queryable":true
        },
        "BankChargeAmount":{
            "type":"number",
            "description":"Calculated bank charges amount.",
            "nullable":true,
            "x-queryable":true
        },
        "ExternalBankAccountIdentifier":{
            "type":"integer",
            "description":"Unique identifier of an external bank account.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "GlobalAttributeNinteen":{
            "maxLength":"150",
            "type":"string",
            "description":"Attribute nineteen of the global descriptive flexfield.",
            "nullable":true,
            "x-queryable":true
        },
        "CallingApplicationIdentifier":{
            "type":"integer",
            "description":"Unique identifier of the calling application.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "BankAssignedReferenceCode":{
            "maxLength":"30",
            "type":"string",
            "description":"The bank assigned reference code.",
            "nullable":true,
            "x-queryable":true
        },
        "ValidationSuccessIndicator":{
            "type":"string",
            "description":"Indicates whether the document validation based on the payment method was successful.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PaymentDueDate":{
            "type":"string",
            "description":"Date when payment is due.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "InvoicingOrganizationIdentifier":{
            "type":"integer",
            "description":"Unique identifier of the invoicing organization.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "DocumentCurrencyChargeAmount":{
            "type":"number",
            "description":"The charge amount in the document currency.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"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.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "PaymentReasonCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Code that indicates the reason for payment.",
            "nullable":true,
            "x-queryable":true
        },
        "InternalBankAccountIdentifier":{
            "type":"integer",
            "description":"Unique identifier of the internal bank account.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "GlobalAttributeSeventeen":{
            "maxLength":"150",
            "type":"string",
            "description":"Attribute seventeen of the global descriptive flexfield.",
            "nullable":true,
            "x-queryable":true
        },
        "GlobalAttributeNumberOne":{
            "type":"number",
            "description":"Numeric attribute one of the global descriptive flexfield.",
            "nullable":true,
            "x-queryable":true
        },
        "GlobalAttributeSixteen":{
            "maxLength":"150",
            "type":"string",
            "description":"Attribute sixteen of the global descriptive flexfield.",
            "nullable":true,
            "x-queryable":true
        },
        "PaymentProcessTransactionTypeCode":{
            "maxLength":"100",
            "type":"string",
            "description":"Code that indicates the payment process transaction code.",
            "nullable":false,
            "x-queryable":true
        },
        "CallingApplicationDocumentUniqueReferenceFour":{
            "maxLength":"100",
            "type":"string",
            "description":"Document unique reference four of the calling application.",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeFourteen":{
            "maxLength":"150",
            "type":"string",
            "description":"Attribute fourteen of the user descriptive flexfield.",
            "nullable":true,
            "x-queryable":true
        },
        "SettlementPriority":{
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the priority for executing a payment.",
            "nullable":true,
            "x-queryable":true
        },
        "UniqueRemittanceIdentifierCheckDigit":{
            "maxLength":"30",
            "type":"string",
            "description":"The check digit that validates the unique remittance identifier.",
            "nullable":true,
            "x-queryable":true
        },
        "GlobalAttributeSeven":{
            "maxLength":"150",
            "type":"string",
            "description":"Attribute seven of the global descriptive flexfield.",
            "nullable":true,
            "x-queryable":true
        },
        "ExclusivePaymentFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether a payment is exclusive.",
            "nullable":false,
            "x-queryable":true
        },
        "GlobalAttributeFour":{
            "maxLength":"150",
            "type":"string",
            "description":"Attribute four of the global descriptive flexfield.",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeTwelve":{
            "maxLength":"150",
            "type":"string",
            "description":"Attribute twelve of the user descriptive flexfield.",
            "nullable":true,
            "x-queryable":true
        },
        "InvoiceExternalPayeePartyIdentifier":{
            "type":"integer",
            "description":"Unique identifier of the invoice external payee party.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "DocumentType":{
            "maxLength":"30",
            "type":"string",
            "description":"Value of the document sequence.",
            "nullable":true,
            "x-queryable":true
        },
        "GlobalAttributeSix":{
            "maxLength":"150",
            "type":"string",
            "description":"Attribute six of the global descriptive flexfield.",
            "nullable":true,
            "x-queryable":true
        },
        "OrganizationType":{
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the type of the organization.",
            "nullable":true,
            "x-queryable":true
        },
        "PayeePartySiteIdentifier":{
            "type":"integer",
            "description":"Unique identifier of the payee party site.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "InvoicingOrganizationType":{
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the type of the invoicing organization.",
            "nullable":true,
            "x-queryable":true
        },
        "DocumentDescription":{
            "maxLength":"255",
            "type":"string",
            "description":"Description of the document.",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeSix":{
            "maxLength":"150",
            "type":"string",
            "description":"Attribute six of the user descriptive flexfield.",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeFour":{
            "maxLength":"150",
            "type":"string",
            "description":"Attribute four of the user descriptive flexfield.",
            "nullable":true,
            "x-queryable":true
        },
        "PaymentFunction":{
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "BankChargeBearer":{
            "maxLength":"80",
            "type":"string",
            "description":"Bearer of the bank charge.",
            "nullable":true,
            "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