Jump to

• Request
• Response

Get all payables invoices

get

/fscmRestApi/resources/11.13.18.05/payablesInvoicesInSupplierPortal

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 invoice in Supplier Portal that matches the specified primary key.
    Finder Variables
    • InvoiceId; integer; Unique identifier of the invoice.
• 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:
  

  • ApprovalStatus; string; Status that indicates the current stage of the invoice in the approval process.
  • ApprovalStatusLookupCode; string; Code that identifies the approval status of the invoice.
  • BankAccount; string; Bank account to which the invoice payment is remitted.
  • BusinessUnit; string; Business unit associated with the invoice.
  • ControlAmount; number; Amount compared with the total tax amount calculated for the invoice.
  • CreatedBy; string; The user who created the record.
  • CreationDate; string; The date when the record was created.
  • Description; string; A brief description of the invoice.
  • DueDate; string; The date when the invoice installment is due for payment.
  • ExternalBankAccountId; integer; Unique identifier of the external bank account.
  • FirstPartyTaxRegistrationId; integer; Unique identifier of the first party tax registration.
  • FirstPartyTaxRegistrationNumber; string; Tax registration number of the first party.
  • InvoiceAmount; number; Invoice amount in the transaction currency.
  • InvoiceCurrency; string; Currency code used on the invoice.
  • InvoiceDate; string; The date specified on the supplier invoice.
  • InvoiceGroup; string; Invoice group assigned to the invoice for reporting and payment purposes.
  • InvoiceId; integer; The unique identifier of the invoice, is generated while creating the invoice.
  • InvoiceNumber; string; Number that identifies the invoice.
  • InvoiceSource; string; Source from which the invoice was created. A list of accepted values is defined in the source lookup.
  • InvoiceStatus; string; Status of the invoice.
  • InvoiceStatusLookupCode; string; Code that identifies the invoice status.
  • InvoiceType; string; Type of invoice. A list of accepted values is defined in the invoice type lookup.
  • InvoiceTypeLookupCode; string; Code that identifies the invoice type.
  • LastUpdateDate; string; The date when the record was last updated.
  • LastUpdatedBy; string; The user who last updated the record.
  • LegalEntity; string; Legal entity associated with the invoice.
  • POHeaderId; integer; The unique identifier of the purchase order document number that's matched to the invoice.
  • PaidStatus; string; Indicates whether the invoice has been paid. Valid values are: P (Partially Paid), N (Unpaid), and Y (Fully Paid).
  • PartyId; integer; The unique identifier of the party associated with the supplier or party associated with the employee or customers for payment request type of invoices.
  • PaymentCurrency; string; Currency used to make the payment.
  • PaymentNumber; string; Number that identifies the payment.
  • PaymentStatusLookupCode; string; Code that identifies the payment status.
  • PurchaseOrderNumber; string; Purchase order document number matched to the invoice.
  • Requester; string; Name of the person who requested the goods or services.
  • RequesterEmail; string; Email address of the requester associated with the invoice.
  • RequesterId; integer; Unique identifier of the requester associated with the invoice.
  • SelfAssessedTaxAmount; number; Total self-assessed tax amount on the invoice.
  • Supplier; string; Name of the supplier on the invoice.
  • SupplierAddress; string; Address of the supplier associated with the invoice.
  • SupplierSite; string; Supplier site associated with the invoice.
  • SupplierTaxRegistrationNumber; string; Tax registration number of the supplier.
  • UniqueRemittanceIdentifier; string; Unique identifier for a remittance. This value contains reference information related to a payment.
  • UniqueRemittanceIdentifierCheckDigit; string; Check digit associated with the unique remittance identifier.
  • VendorId; integer; The unique identifier of the supplier on the interface invoice.
  • VendorSiteId; integer; Unique identifier of the supplier site associated with the invoice.
• 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: string
  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: string
  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 : payablesInvoicesInSupplierPortal

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":{
        "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."
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/payablesInvoicesInSupplierPortal-item-response"
            }
        },
        "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"
            }
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        }
    },
    "x-hints":{
        "usage":"BusinessObject"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object payablesInvoicesInSupplierPortal-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/payablesInvoicesInSupplierPortal-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 : payablesInvoicesInSupplierPortal-item-response

Type: object

Show Source

• ApprovalStatus: string
  Read Only: true

  Maximum Length: 80

  Status that indicates the current stage of the invoice in the approval process.
• ApprovalStatusLookupCode: string
  Title: Match Option

  Read Only: true

  Maximum Length: 30

  Code that identifies the approval status of the invoice.
• BankAccount: string
  Maximum Length: 255

  Bank account to which the invoice payment is remitted.
• BusinessUnit: string
  Title: Business Unit

  Maximum Length: 240

  Business unit associated with the invoice.
• ControlAmount: number
  Title: Control Amount

  Amount compared with the total tax amount calculated for the invoice.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the record was created.
• Description: string
  Title: Description

  Maximum Length: 240

  A brief description of the invoice.
• DueDate: string (date)
  Read Only: true

  The date when the invoice installment is due for payment.
• ExternalBankAccountId: integer (int64)
  Unique identifier of the external bank account.
• FirstPartyTaxRegistrationId: integer (int64)
  Title: First-Party Tax Registration Number

  Unique identifier of the first party tax registration.
• FirstPartyTaxRegistrationNumber: string
  Maximum Length: 50

  Tax registration number of the first party.
• InvoiceAmount: number
  Title: Amount

  Invoice amount in the transaction currency.
• InvoiceCurrency: string
  Title: Invoice Currency

  Maximum Length: 15

  Currency code used on the invoice.
• InvoiceDate: string (date)
  Title: Invoice Date

  The date specified on the supplier invoice.
• InvoiceGroup: string
  Maximum Length: 255

  Invoice group assigned to the invoice for reporting and payment purposes.
• InvoiceId: integer (int64)
  Title: Invoice ID

  The unique identifier of the invoice, is generated while creating the invoice.
• InvoiceNumber: string
  Title: Invoice Number

  Maximum Length: 50

  Number that identifies the invoice.
• InvoiceSource: string
  Maximum Length: 255

  Source from which the invoice was created. A list of accepted values is defined in the source lookup.
• InvoiceStatus: string
  Read Only: true

  Maximum Length: 255

  Status of the invoice.
• InvoiceStatusLookupCode: string
  Code that identifies the invoice status.
• InvoiceType: string
  Maximum Length: 255

  Type of invoice. A list of accepted values is defined in the invoice type lookup.
• InvoiceTypeLookupCode: string
  Title: Invoice Type

  Maximum Length: 25

  Code that identifies the invoice type.
• ispInvoiceRestAttachments: array Attachments
  Title: Attachments

  An attachment represents a file, URL, or text associated with a payables invoice in Supplier Portal. Examples include invoice images, supporting documents, and supplier provided documents.
• ispInvoiceRestLines: array Invoice Lines
  Title: Invoice Lines

  An invoice line represents goods, services, taxes, or other charges billed on a payables invoice in Supplier Portal. Examples include item lines, tax lines, and freight lines.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  The date when the record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the record.
• LegalEntity: string
  Title: Legal Entity Name

  Maximum Length: 240

  Legal entity associated with the invoice.
• LegalEntityIdentifier: string
  Maximum Length: 255

  The unique identifier of the legal entity on the interface invoice.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PaidStatus: string
  Read Only: true

  Maximum Length: 80

  Indicates whether the invoice has been paid. Valid values are: P (Partially Paid), N (Unpaid), and Y (Fully Paid).
• PartyId: integer (int64)
  The unique identifier of the party associated with the supplier or party associated with the employee or customers for payment request type of invoices.
• PaymentCurrency: string
  Title: Payment Currency

  Maximum Length: 15

  Currency used to make the payment.
• PaymentNumber: string
  Read Only: true

  Maximum Length: 30

  Number that identifies the payment.
• PaymentStatusLookupCode: string
  Title: Match Option

  Read Only: true

  Maximum Length: 30

  Code that identifies the payment status.
• POHeaderId: integer (int64)
  Read Only: true

  The unique identifier of the purchase order document number that's matched to the invoice.
• PurchaseOrderNumber: string
  Title: Order

  Maximum Length: 30

  Purchase order document number matched to the invoice.
• Requester: string
  Title: Name

  Maximum Length: 240

  Name of the person who requested the goods or services.
• RequesterEmail: string
  Maximum Length: 2000

  Email address of the requester associated with the invoice.
• RequesterId: integer (int64)
  Title: Requester

  Unique identifier of the requester associated with the invoice.
• SelfAssessedTaxAmount: number
  Read Only: true

  Total self-assessed tax amount on the invoice.
• Supplier: string
  Title: Name

  Maximum Length: 360

  Name of the supplier on the invoice.
• SupplierAddress: string
  Read Only: true

  Address of the supplier associated with the invoice.
• SupplierSite: string
  Title: Site

  Maximum Length: 240

  Supplier site associated with the invoice.
• SupplierTaxRegistrationNumber: string
  Title: Registration Number

  Maximum Length: 50

  Tax registration number of the supplier.
• UniqueRemittanceIdentifier: string
  Maximum Length: 256

  Unique identifier for a remittance. This value contains reference information related to a payment.
• UniqueRemittanceIdentifierCheckDigit: string
  Maximum Length: 2

  Check digit associated with the unique remittance identifier.
• VendorId: integer (int64)
  Title: Supplier

  The unique identifier of the supplier on the interface invoice.
• VendorSiteId: integer (int64)
  Title: Supplier Site

  Unique identifier of the supplier site associated with the invoice.

{
    "type":"object",
    "properties":{
        "ApprovalStatus":{
            "maxLength":80,
            "type":"string",
            "description":"Status that indicates the current stage of the invoice in the approval process.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ApprovalStatusLookupCode":{
            "title":"Match Option",
            "maxLength":30,
            "type":"string",
            "description":"Code that identifies the approval status of the invoice.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BankAccount":{
            "maxLength":255,
            "type":"string",
            "description":"Bank account to which the invoice payment is remitted.",
            "nullable":true,
            "x-queryable":true
        },
        "BusinessUnit":{
            "title":"Business Unit",
            "maxLength":240,
            "type":"string",
            "description":"Business unit associated with the invoice.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ControlAmount":{
            "title":"Control Amount",
            "type":"number",
            "description":"Amount compared with the total tax amount calculated for the invoice.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"A brief description of the invoice.",
            "nullable":true,
            "x-queryable":true
        },
        "DueDate":{
            "type":"string",
            "description":"The date when the invoice installment is due for payment.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ExternalBankAccountId":{
            "type":"integer",
            "description":"Unique identifier of the external bank account.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "FirstPartyTaxRegistrationId":{
            "title":"First-Party Tax Registration Number",
            "type":"integer",
            "description":"Unique identifier of the first party tax registration.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "FirstPartyTaxRegistrationNumber":{
            "maxLength":50,
            "type":"string",
            "description":"Tax registration number of the first party.",
            "nullable":true,
            "x-queryable":true
        },
        "InvoiceAmount":{
            "title":"Amount",
            "type":"number",
            "description":"Invoice amount in the transaction currency.",
            "nullable":false,
            "x-queryable":true
        },
        "InvoiceCurrency":{
            "title":"Invoice Currency",
            "maxLength":15,
            "type":"string",
            "description":"Currency code used on the invoice.",
            "nullable":false,
            "x-queryable":true
        },
        "InvoiceDate":{
            "title":"Invoice Date",
            "type":"string",
            "description":"The date specified on the supplier invoice.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "InvoiceGroup":{
            "maxLength":255,
            "type":"string",
            "description":"Invoice group assigned to the invoice for reporting and payment purposes.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "BatchName"
                ]
            },
            "x-queryable":true
        },
        "InvoiceId":{
            "title":"Invoice ID",
            "type":"integer",
            "description":"The unique identifier of the invoice, is generated while creating the invoice.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "InvoiceNumber":{
            "title":"Invoice Number",
            "maxLength":50,
            "type":"string",
            "description":"Number that identifies the invoice.",
            "nullable":false,
            "x-queryable":true
        },
        "InvoiceSource":{
            "maxLength":255,
            "type":"string",
            "description":"Source from which the invoice was created. A list of accepted values is defined in the source lookup.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "InvoiceSource1"
                ]
            },
            "x-queryable":true
        },
        "InvoiceStatus":{
            "maxLength":255,
            "type":"string",
            "description":"Status of the invoice.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "InvoiceStatusLookupCode":{
            "type":"string",
            "description":"Code that identifies the invoice status.",
            "nullable":false,
            "x-queryable":true
        },
        "InvoiceType":{
            "maxLength":255,
            "type":"string",
            "description":"Type of invoice. A list of accepted values is defined in the invoice type lookup.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "InvoiceType1"
                ]
            },
            "x-queryable":true
        },
        "InvoiceTypeLookupCode":{
            "title":"Invoice Type",
            "maxLength":25,
            "type":"string",
            "description":"Code that identifies the invoice type.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LegalEntity":{
            "title":"Legal Entity Name",
            "maxLength":240,
            "type":"string",
            "description":"Legal entity associated with the invoice.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "LegalEntityIdentifier"
                ]
            },
            "x-queryable":true
        },
        "LegalEntityIdentifier":{
            "maxLength":255,
            "type":"string",
            "description":"The unique identifier of the legal entity on the interface invoice.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "LeLegalEntityId"
                ]
            }
        },
        "POHeaderId":{
            "type":"integer",
            "description":"The unique identifier of the purchase order document number that's matched to the invoice.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PaidStatus":{
            "maxLength":80,
            "type":"string",
            "description":"Indicates whether the invoice has been paid. Valid values are: P (Partially Paid), N (Unpaid), and Y (Fully Paid).",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PartyId":{
            "type":"integer",
            "description":"The unique identifier of the party associated with the supplier or party associated with the employee or customers for payment request type of invoices.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PaymentCurrency":{
            "title":"Payment Currency",
            "maxLength":15,
            "type":"string",
            "description":"Currency used to make the payment.",
            "nullable":false,
            "x-queryable":true
        },
        "PaymentNumber":{
            "maxLength":30,
            "type":"string",
            "description":"Number that identifies the payment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PaymentStatusLookupCode":{
            "title":"Match Option",
            "maxLength":30,
            "type":"string",
            "description":"Code that identifies the payment status.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PurchaseOrderNumber":{
            "title":"Order",
            "maxLength":30,
            "type":"string",
            "description":"Purchase order document number matched to the invoice.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "BusinessUnit",
                    "Supplier"
                ]
            },
            "x-queryable":true
        },
        "Requester":{
            "title":"Name",
            "maxLength":240,
            "type":"string",
            "description":"Name of the person who requested the goods or services.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "RequesterId"
                ]
            },
            "x-queryable":true
        },
        "RequesterEmail":{
            "maxLength":2000,
            "type":"string",
            "description":"Email address of the requester associated with the invoice.",
            "nullable":true,
            "x-queryable":true
        },
        "RequesterId":{
            "title":"Requester",
            "type":"integer",
            "description":"Unique identifier of the requester associated with the invoice.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SelfAssessedTaxAmount":{
            "type":"number",
            "description":"Total self-assessed tax amount on the invoice.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Supplier":{
            "title":"Name",
            "maxLength":360,
            "type":"string",
            "description":"Name of the supplier on the invoice.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SupplierAddress":{
            "type":"string",
            "description":"Address of the supplier associated with the invoice.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "VendorSiteId"
                ]
            },
            "x-queryable":true
        },
        "SupplierSite":{
            "title":"Site",
            "maxLength":240,
            "type":"string",
            "description":"Supplier site associated with the invoice.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "BusinessUnit",
                    "ProcurementBU",
                    "Supplier"
                ]
            },
            "x-queryable":true
        },
        "SupplierTaxRegistrationNumber":{
            "title":"Registration Number",
            "maxLength":50,
            "type":"string",
            "description":"Tax registration number of the supplier.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "UniqueRemittanceIdentifier":{
            "maxLength":256,
            "type":"string",
            "description":"Unique identifier for a remittance. This value contains reference information related to a payment.",
            "nullable":true,
            "x-queryable":true
        },
        "UniqueRemittanceIdentifierCheckDigit":{
            "maxLength":2,
            "type":"string",
            "description":"Check digit associated with the unique remittance identifier.",
            "nullable":true,
            "x-queryable":true
        },
        "VendorId":{
            "title":"Supplier",
            "type":"integer",
            "description":"The unique identifier of the supplier on the interface invoice.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "VendorSiteId":{
            "title":"Supplier Site",
            "type":"integer",
            "description":"Unique identifier of the supplier site associated with the invoice.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ispInvoiceRestAttachments":{
            "title":"Attachments",
            "type":"array",
            "description":"An attachment represents a file, URL, or text associated with a payables invoice in Supplier Portal. Examples include invoice images, supporting documents, and supplier provided documents.",
            "items":{
                "$ref":"#/components/schemas/payablesInvoicesInSupplierPortal-ispInvoiceRestAttachments-item-response"
            }
        },
        "ispInvoiceRestLines":{
            "title":"Invoice Lines",
            "type":"array",
            "description":"An invoice line represents goods, services, taxes, or other charges billed on a payables invoice in Supplier Portal. Examples include item lines, tax lines, and freight lines.",
            "items":{
                "$ref":"#/components/schemas/payablesInvoicesInSupplierPortal-ispInvoiceRestLines-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Attachments

Type: array

Title: Attachments

An attachment represents a file, URL, or text associated with a payables invoice in Supplier Portal. Examples include invoice images, supporting documents, and supplier provided documents.

Show Source

• Array of: object payablesInvoicesInSupplierPortal-ispInvoiceRestAttachments-item-response

{
    "title":"Attachments",
    "type":"array",
    "description":"An attachment represents a file, URL, or text associated with a payables invoice in Supplier Portal. Examples include invoice images, supporting documents, and supplier provided documents.",
    "items":{
        "$ref":"#/components/schemas/payablesInvoicesInSupplierPortal-ispInvoiceRestAttachments-item-response"
    }
}

Nested Schema : Invoice Lines

Type: array

Title: Invoice Lines

An invoice line represents goods, services, taxes, or other charges billed on a payables invoice in Supplier Portal. Examples include item lines, tax lines, and freight lines.

Show Source

• Array of: object payablesInvoicesInSupplierPortal-ispInvoiceRestLines-item-response

{
    "title":"Invoice Lines",
    "type":"array",
    "description":"An invoice line represents goods, services, taxes, or other charges billed on a payables invoice in Supplier Portal. Examples include item lines, tax lines, and freight lines.",
    "items":{
        "$ref":"#/components/schemas/payablesInvoicesInSupplierPortal-ispInvoiceRestLines-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 : payablesInvoicesInSupplierPortal-ispInvoiceRestAttachments-item-response

Type: object

Show Source

• AsyncTrackerId: string
  Title: Asynchronous Upload Tracker Id

  Unique identifier of the asynchronous process that tracks attachment processing.
• AttachedDocumentId: integer (int64)
  Title: Attached Document Id

  Unique identifier of the attached document.
• Category: string
  Maximum Length: 255

  Document category used for assigning sequential numbers to documents.
• ContentRepositoryFileShared: boolean
  Title: Shared

  Indicates whether the file in the content repository is shared.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 255

  The user who created the record.
• CreatedByUserName: string
  Title: Created By User Name

  Read Only: true

  The user name of the user who created the record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the record was created.
• Description: string
  Title: Description

  Maximum Length: 255

  A brief description of the attachment.
• DmDocumentId: string
  Maximum Length: 255

  Unique identifier of the document in the document management repository.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  Folder path of the document in the document management repository.
• DmVersionNumber: string
  Maximum Length: 255

  Version number of the document in the document management repository.
• DownloadInfo: string
  Title: DownloadInfo

  Parameter information used to download the attachment.
• ErrorStatusCode: string
  Title: Error Status Code

  Code that identifies the attachment processing status.
• ErrorStatusMessage: string
  Title: Error Status Message

  Message that describes the attachment processing status.
• ExpirationDate: string (date-time)
  Title: Expiration Date

  The date when the attachment expires.
• FileContents: string (byte)
  Title: File Contents

  Contents of the attached file.
• FileName: string
  Title: File Name

  Maximum Length: 2048

  Name of the attached file.
• FileUrl: string
  Title: File Url

  URL of the attached file.
• FileWebImage: string (byte)
  Title: File Web Image

  Read Only: true

  Web image associated with the attached file.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  The date when the record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 255

  The user who last updated the record.
• LastUpdatedByUserName: string
  Title: Last Updated By User

  Read Only: true

  The user name of the user who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PostProcessingAction: string
  Title: PostProcessingAction

  Action performed after attachment processing is complete.
• Title: string
  Title: Title

  Title of the attachment.
• Type: string
  Maximum Length: 255

  Type of attachment.
• UploadedFileContentType: string
  Title: Uploaded File Content Type

  Content type of the uploaded file.
• UploadedFileLength: integer
  Title: File Size

  Size of the uploaded file.
• UploadedFileName: string
  Title: Uploaded File Name

  Name of the uploaded file.
• UploadedText: string
  Title: Uploaded Text

  Text uploaded for the attachment.
• Uri: string
  Title: Uri

  Maximum Length: 4000

  The unique reference number to identify the image with the invoice.
• Url: string
  Title: Url

  Maximum Length: 4000

  URL associated with the attachment.

{
    "type":"object",
    "properties":{
        "AsyncTrackerId":{
            "title":"Asynchronous Upload Tracker Id",
            "type":"string",
            "description":"Unique identifier of the asynchronous process that tracks attachment processing.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        },
        "AttachedDocumentId":{
            "title":"Attached Document Id",
            "type":"integer",
            "description":"Unique identifier of the attached document.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "Category":{
            "maxLength":255,
            "type":"string",
            "description":"Document category used for assigning sequential numbers to documents.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Indicates whether the file in the content repository is shared.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":255,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "CreatedByUserName":{
            "title":"Created By User Name",
            "type":"string",
            "description":"The user name of the user who created the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":255,
            "type":"string",
            "description":"A brief description of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmDocumentId":{
            "maxLength":255,
            "type":"string",
            "description":"Unique identifier of the document in the document management repository.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":1000,
            "type":"string",
            "description":"Folder path of the document in the document management repository.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DmVersionNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Version number of the document in the document management repository.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"Parameter information used to download the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"Code that identifies the attachment processing status.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"Message that describes the attachment processing status.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The date when the attachment expires.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"Contents of the attached file.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":2048,
            "type":"string",
            "description":"Name of the attached file.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"URL of the attached file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileWebImage":{
            "title":"File Web Image",
            "type":"string",
            "description":"Web image associated with the attached file.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide",
                "PAYLOADHINT":"Show"
            }
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "FMT_FORMAT":"d-MMM-yyyy HH:mm:ss"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":255,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "LastUpdatedByUserName":{
            "title":"Last Updated By User",
            "type":"string",
            "description":"The user name of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "PostProcessingAction":{
            "title":"PostProcessingAction",
            "type":"string",
            "description":"Action performed after attachment processing is complete.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"Title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Type":{
            "maxLength":255,
            "type":"string",
            "description":"Type of attachment.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"Content type of the uploaded file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"Size of the uploaded file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"Name of the uploaded file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"Text uploaded for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":4000,
            "type":"string",
            "description":"The unique reference number to identify the image with the invoice.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "Url":{
            "title":"Url",
            "maxLength":4000,
            "type":"string",
            "description":"URL associated with the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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."
        }
    }
}

Nested Schema : payablesInvoicesInSupplierPortal-ispInvoiceRestLines-item-response

Type: object

Show Source

• AssessableValue: number
  Title: Assessable Value

  Deemed price at which a product is valued by a tax authority for tax calculation purposes.
• AvailableQuantity: string
  Quantity of items received against a purchase order schedule that are available for matching to an invoice.
• ConsumptionAdviceLineNumber: number
  Title: Consumption Advice Line

  Line number of the consumption advice associated with the invoice line.
• ConsumptionAdviceNumber: string
  Title: Consumption Advice

  Maximum Length: 20

  Number of the consumption advice associated with the invoice line.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the invoice line was created.
• Description: string
  Title: Description

  Maximum Length: 240

  A brief description of the invoice line.
• FinalDischargeLocation: string
  Read Only: true

  Maximum Length: 1082

  Final discharge location used for tax calculation on the invoice line.
• FinalDischargeLocationCode: string
  Maximum Length: 1082

  The code that identifies the location of final discharge.
• IncludedTaxAmount: number
  Read Only: true

  Amount of tax included in the invoice line.
• IncomeTaxRegion: string
  Title: Income Tax Region

  Maximum Length: 10

  Reporting region associated with the invoice line for a 1099 supplier.
• IntendedUse: string
  Maximum Length: 240

  Tax driver used to determine and calculate taxes applicable to the invoice line.
• IntendedUseClassifId: integer (int64)
  Title: Intended Use

  Unique identifier of the intended use code entered by the user.
• IntendedUseCode: string
  Code that identifies the intended use for tax calculation.
• Item: string
  Maximum Length: 255

  Name of the inventory item associated with the invoice line.
• ItemDescription: string
  Read Only: true

  Description of the item associated with the invoice line.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  The date when the invoice line was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the invoice line.
• LineAmount: number
  Title: Line Amount

  Invoice line amount in the invoice currency.
• LineNumber: integer (int64)
  Title: Line Number

  Unique number that identifies the invoice line.
• LineSource: string
  Read Only: true

  Maximum Length: 255

  Source from which the invoice line was created. A list of accepted values is defined in the line source lookup.
• LineType: string
  Maximum Length: 255

  Type of invoice line. A list of accepted values is defined in the invoice line type lookup.
• LineTypeLookupCode: string
  Title: Line Type

  Maximum Length: 25

  The type of the invoice line. The value must be provided while creating an invoice line. The valid values are Item, Freight, and Miscellaneous. A list of accepted values is defined in the lookup type INVOICE LINE TYPE and can be reviewed using the Setup and Maintenance work area, and the Manage Payables Lookups task.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• POHeaderId: integer (int64)
  Read Only: true

  The unique identifier of the purchase order document number that's matched to the invoice.
• ProductCategory: string
  Maximum Length: 240

  Taxable nature of a noninventory item used for tax calculation and tax reporting purposes.
• ProductCategoryCodePath: string
  Title: Product Category

  Maximum Length: 240

  Hierarchy path of the product category code used for tax calculation.
• ProductFiscalClassification: string
  Maximum Length: 240

  Tax classification used by a tax authority to categorize a product.
• ProductFiscalClassificationCode: string
  Code that identifies the product fiscal classification used for tax calculation.
• ProductFiscalClassificationType: string
  Type of product fiscal classification used for tax calculation.
• ProductType: string
  Maximum Length: 80

  Type of product derived from the inventory item attributes. Valid values are goods and services.
• PurchaseOrderLineNumber: number
  Title: Line

  Purchase order line number matched to the invoice line.
• PurchaseOrderNumber: string
  Title: Order

  Maximum Length: 30

  Purchase order document number matched to the invoice line.
• PurchaseOrderScheduleLineNumber: number
  Title: Schedule

  Purchase order schedule line number matched to the invoice line.
• Quantity: number
  Title: Quantity

  Quantity of items invoiced on the invoice line.
• RcvTransactionId: integer
  Read Only: true

  Unique identifier of the receipt transaction matched to the invoice line.
• ReceiptLineNumber: integer (int64)
  The line number of the receipt associated with the invoice line.
• ReceiptNumber: string
  Maximum Length: 255

  The receipt number of the material associated with the invoice line.
• Retainage: number
  Amount withheld as retainage against the invoice line.
• RetainageRemaining: number
  Remaining amount withheld as retainage against the invoice line.
• RetainedInvoiceLineNumber: integer
  Line number of the retained invoice associated with the invoice line.
• RetainedInvoiceNumber: integer (int64)
  Invoice number of the retained invoice associated with the invoice line.
• ShipFromLocation: string
  Read Only: true

  Maximum Length: 1082

  Code that identifies the ship-from location.
• ShipFromLocationId: integer (int64)
  Title: Ship-from Location

  The unique identifier of the ship-from location.
• ShipToLocation: string
  Title: Name

  Maximum Length: 60

  Location to which the supplier ships the goods or services.
• ShipToLocationCode: string
  Maximum Length: 255

  The user-entered ship to location code that helps to uniquely identify a ship to location.
• SupplierItem: string
  Read Only: true

  Maximum Length: 300

  Supplier item number from the purchase order schedule line.
• TaxClassification: string
  Title: Tax Classification

  Maximum Length: 30

  Tax classification code used for tax calculation.
• TaxControlAmount: number
  Title: Tax Control Amount

  Amount used to ensure that the calculated tax matches the tax amount on the physical document.
• TaxRateName: string
  Read Only: true

  Maximum Length: 255

  Name of the tax rate associated with the invoice line.
• TransactionBusinessCategory: string
  Maximum Length: 255

  Transaction category assigned to the invoice line for tax calculation purposes.
• TransactionBusinessCategoryCodePath: string
  Title: Transaction Business Category

  Maximum Length: 240

  Hierarchy path of the transaction business category code used for tax calculation.
• UnitPrice: number
  Title: Unit Price

  Unit price of the good or service.
• UOM: string
  Maximum Length: 25

  Unit of measure used for the invoiced quantity.
• UserDefinedFiscalClassification: string
  Maximum Length: 240

  Classification used for tax requirements that can't be defined using existing fiscal classification types.
• UserDefinedFiscalClassificationCode: string
  Title: User-Defined Fiscal Classification

  Maximum Length: 240

  Code that identifies the user-defined fiscal classification used for tax calculation.

{
    "type":"object",
    "properties":{
        "AssessableValue":{
            "title":"Assessable Value",
            "type":"number",
            "description":"Deemed price at which a product is valued by a tax authority for tax calculation purposes.",
            "nullable":true,
            "x-queryable":true
        },
        "AvailableQuantity":{
            "type":"string",
            "description":"Quantity of items received against a purchase order schedule that are available for matching to an invoice.",
            "nullable":true,
            "x-queryable":true
        },
        "ConsumptionAdviceLineNumber":{
            "title":"Consumption Advice Line",
            "type":"number",
            "description":"Line number of the consumption advice associated with the invoice line.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ConsumptionAdviceNumber":{
            "title":"Consumption Advice",
            "maxLength":20,
            "type":"string",
            "description":"Number of the consumption advice associated with the invoice line.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the invoice line was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"A brief description of the invoice line.",
            "nullable":true,
            "x-queryable":true
        },
        "FinalDischargeLocation":{
            "maxLength":1082,
            "type":"string",
            "description":"Final discharge location used for tax calculation on the invoice line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FinalDischargeLocationCode":{
            "maxLength":1082,
            "type":"string",
            "description":"The code that identifies the location of final discharge.",
            "nullable":true,
            "x-queryable":true
        },
        "IncludedTaxAmount":{
            "type":"number",
            "description":"Amount of tax included in the invoice line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IncomeTaxRegion":{
            "title":"Income Tax Region",
            "maxLength":10,
            "type":"string",
            "description":"Reporting region associated with the invoice line for a 1099 supplier.",
            "nullable":true,
            "x-queryable":true
        },
        "IntendedUse":{
            "maxLength":240,
            "type":"string",
            "description":"Tax driver used to determine and calculate taxes applicable to the invoice line.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "IntendedUseCode"
                ]
            },
            "x-queryable":true
        },
        "IntendedUseClassifId":{
            "title":"Intended Use",
            "type":"integer",
            "description":"Unique identifier of the intended use code entered by the user.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "IntendedUseCode":{
            "type":"string",
            "description":"Code that identifies the intended use for tax calculation.",
            "nullable":true,
            "x-queryable":true
        },
        "Item":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the inventory item associated with the invoice line.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ItemDescription":{
            "type":"string",
            "description":"Description of the item associated with the invoice line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when the invoice line was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the invoice line.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LineAmount":{
            "title":"Line Amount",
            "type":"number",
            "description":"Invoice line amount in the invoice currency.",
            "nullable":true,
            "x-queryable":true
        },
        "LineNumber":{
            "title":"Line Number",
            "type":"integer",
            "description":"Unique number that identifies the invoice line.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LineSource":{
            "maxLength":255,
            "type":"string",
            "description":"Source from which the invoice line was created. A list of accepted values is defined in the line source lookup.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "Source1"
                ]
            },
            "x-queryable":true
        },
        "LineType":{
            "maxLength":255,
            "type":"string",
            "description":"Type of invoice line. A list of accepted values is defined in the invoice line type lookup.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "Type1"
                ]
            },
            "x-queryable":true
        },
        "LineTypeLookupCode":{
            "title":"Line Type",
            "maxLength":25,
            "type":"string",
            "description":"The type of the invoice line. The value must be provided while creating an invoice line. The valid values are Item, Freight, and Miscellaneous. A list of accepted values is defined in the lookup type INVOICE LINE TYPE and can be reviewed using the Setup and Maintenance work area, and the Manage Payables Lookups task.",
            "nullable":false,
            "x-queryable":true
        },
        "POHeaderId":{
            "type":"integer",
            "description":"The unique identifier of the purchase order document number that's matched to the invoice.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ProductCategory":{
            "maxLength":240,
            "type":"string",
            "description":"Taxable nature of a noninventory item used for tax calculation and tax reporting purposes.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ProductCategoryCodePath":{
            "title":"Product Category",
            "maxLength":240,
            "type":"string",
            "description":"Hierarchy path of the product category code used for tax calculation.",
            "nullable":true,
            "x-queryable":true
        },
        "ProductFiscalClassification":{
            "maxLength":240,
            "type":"string",
            "description":"Tax classification used by a tax authority to categorize a product.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "ProductFiscalClassificationCode",
                    "ProductFiscalClassificationType"
                ]
            },
            "x-queryable":true
        },
        "ProductFiscalClassificationCode":{
            "type":"string",
            "description":"Code that identifies the product fiscal classification used for tax calculation.",
            "nullable":true,
            "x-queryable":true
        },
        "ProductFiscalClassificationType":{
            "type":"string",
            "description":"Type of product fiscal classification used for tax calculation.",
            "nullable":true,
            "x-queryable":true
        },
        "ProductType":{
            "maxLength":80,
            "type":"string",
            "description":"Type of product derived from the inventory item attributes. Valid values are goods and services.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PurchaseOrderLineNumber":{
            "title":"Line",
            "type":"number",
            "description":"Purchase order line number matched to the invoice line.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PurchaseOrderNumber":{
            "title":"Order",
            "maxLength":30,
            "type":"string",
            "description":"Purchase order document number matched to the invoice line.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PurchaseOrderScheduleLineNumber":{
            "title":"Schedule",
            "type":"number",
            "description":"Purchase order schedule line number matched to the invoice line.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Quantity":{
            "title":"Quantity",
            "type":"number",
            "description":"Quantity of items invoiced on the invoice line.",
            "nullable":true,
            "x-queryable":true
        },
        "RcvTransactionId":{
            "type":"integer",
            "description":"Unique identifier of the receipt transaction matched to the invoice line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReceiptLineNumber":{
            "type":"integer",
            "description":"The line number of the receipt associated with the invoice line.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "ReceiptNumber":{
            "maxLength":255,
            "type":"string",
            "description":"The receipt number of the material associated with the invoice line.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "ReceiptNum"
                ]
            },
            "x-queryable":true
        },
        "Retainage":{
            "type":"number",
            "description":"Amount withheld as retainage against the invoice line.",
            "nullable":true,
            "x-queryable":true
        },
        "RetainageRemaining":{
            "type":"number",
            "description":"Remaining amount withheld as retainage against the invoice line.",
            "nullable":true,
            "x-queryable":true
        },
        "RetainedInvoiceLineNumber":{
            "type":"integer",
            "description":"Line number of the retained invoice associated with the invoice line.",
            "nullable":true,
            "x-queryable":true
        },
        "RetainedInvoiceNumber":{
            "type":"integer",
            "description":"Invoice number of the retained invoice associated with the invoice line.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ShipFromLocation":{
            "maxLength":1082,
            "type":"string",
            "description":"Code that identifies the ship-from location.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ShipFromLocationId":{
            "title":"Ship-from Location",
            "type":"integer",
            "description":"The unique identifier of the ship-from location.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ShipToLocation":{
            "title":"Name",
            "maxLength":60,
            "type":"string",
            "description":"Location to which the supplier ships the goods or services.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "ShipToLocationCode"
                ]
            },
            "x-queryable":true
        },
        "ShipToLocationCode":{
            "maxLength":255,
            "type":"string",
            "description":"The user-entered ship to location code that helps to uniquely identify a ship to location.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "InternalShipToLocationCode"
                ]
            },
            "x-queryable":true
        },
        "SupplierItem":{
            "maxLength":300,
            "type":"string",
            "description":"Supplier item number from the purchase order schedule line.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "PoLineId1"
                ]
            },
            "x-queryable":true
        },
        "TaxClassification":{
            "title":"Tax Classification",
            "maxLength":30,
            "type":"string",
            "description":"Tax classification code used for tax calculation.",
            "nullable":true,
            "x-queryable":true
        },
        "TaxControlAmount":{
            "title":"Tax Control Amount",
            "type":"number",
            "description":"Amount used to ensure that the calculated tax matches the tax amount on the physical document.",
            "nullable":true,
            "x-queryable":true
        },
        "TaxRateName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the tax rate associated with the invoice line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TransactionBusinessCategory":{
            "maxLength":255,
            "type":"string",
            "description":"Transaction category assigned to the invoice line for tax calculation purposes.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "TransactionBusinessCategoryCodePath":{
            "title":"Transaction Business Category",
            "maxLength":240,
            "type":"string",
            "description":"Hierarchy path of the transaction business category code used for tax calculation.",
            "nullable":true,
            "x-queryable":true
        },
        "UOM":{
            "maxLength":25,
            "type":"string",
            "description":"Unit of measure used for the invoiced quantity.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "UnitPrice":{
            "title":"Unit Price",
            "type":"number",
            "description":"Unit price of the good or service.",
            "nullable":true,
            "x-queryable":true
        },
        "UserDefinedFiscalClassification":{
            "maxLength":240,
            "type":"string",
            "description":"Classification used for tax requirements that can't be defined using existing fiscal classification types.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "UserDefinedFiscalClassificationCode":{
            "title":"User-Defined Fiscal Classification",
            "maxLength":240,
            "type":"string",
            "description":"Code that identifies the user-defined fiscal classification used for tax calculation.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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"
    }
}

Links

calculateTax

Operation: /fscmRestApi/resources/11.13.18.05/payablesInvoicesInSupplierPortal/action/calculateTax

Calculates taxes for the invoice based on the invoice details and tax configuration.

cancelInvoice

Operation: /fscmRestApi/resources/11.13.18.05/payablesInvoicesInSupplierPortal/action/cancelInvoice

Cancels an invoice. When you cancel an invoice, all invoice amounts are set to zero, and the invoice can't be edited or submitted for processing.

cancelLine

Operation: /fscmRestApi/resources/11.13.18.05/payablesInvoicesInSupplierPortal/action/cancelLine

Cancels an invoice line. When you cancel an invoice line, the line amount is set to zero, and the invoice line can't be edited. If the invoice line is matched to a purchase order, the billed quantity on the purchase order is adjusted by the canceled line quantity.

submitInvoice

Operation: /fscmRestApi/resources/11.13.18.05/payablesInvoicesInSupplierPortal/action/submitInvoice

Submits the invoice for processing. If the submission is successful, the invoice is processed according to the applicable invoice validation and approval rules.

Back to Top