Jump to

• Request
• Response

Update a set of ReceivableOptions data

patch

/fscmRestApi/resources/11.13.18.05/publicSectorReceivableOptions/{AgencyId}

Request

Path Parameters

• AgencyId(required): integer(int32)
  The unique identifier of the agency associated with the receivable options.

  Default Value: 1

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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• BuName: string
  Title: Receivables Business Unit

  Maximum Length: 240

  Name of the business unit that is configured to process receivable transactions.
• CustCmTrxTypeId: integer (int64)
  The unique identifier for the Fusion AR transaction type for credit memo.
• CustCmTrxTypeName: string
  Title: Credit Memo Transaction Type

  Maximum Length: 20

  Name of the credit memo transaction type.
• CustTrxTypeId: integer (int64)
  The unique identifier for the Fusion AR transaction type for invoice.
• CustTrxTypeName: string
  Title: Invoice Transaction Type

  Maximum Length: 20

  Name of the invoice transaction type.
• EnabledFlag: string
  Title: Enabled

  Maximum Length: 1

  Indicates whether the ERP Receivables integration is enabled.
• InvoiceSystem: string
  Title: Receivables System

  Maximum Length: 20

  The system that will generate the invoice.
• MemoLineId: integer (int64)
  The unique identifier for the memo line that is used to derive the revenue account.
• MemoLineName: string
  Title: Memo Line Name

  Maximum Length: 50

  Name of the memo line.
• OnaccountReceivableActivity: string
  Title: On Account Receivable Activity Name

  Maximum Length: 50

  The Receivable activity name that is used on receipts created for payments on account.
• OrgId: integer (int64)
  Title: Organization ID

  The unique identifier for the business unit associated with the invoice.
• ProfileClassId: integer (int64)
  Title: Profile Class ID

  The unique identifier for the customer profile class.
• ProfileClassName: string
  Maximum Length: 30

  Name of the customer profile class.
• ReceivableActivityName: string
  Title: Receivable Activity Name

  Maximum Length: 50

  The unique identifier for the receivable activity name.
• RefundReceivableActivity: string
  Title: Refund Receivable Activity

  Maximum Length: 50

  The Receivable activity name that is used on receipts created for refunds.
• SetName: string
  Maximum Length: 80

  Name of the reference data set value used within the context of the transaction setups that are retrieved through various reference resources.
• StartDate: string (date)
  The cutoff date for the Oracle Receivable Receipts ESS job used to filter the payment records.
• TermId: integer (int64)
  The unique identifier for the payment term.
• TermName: string
  Title: Payment Term

  Maximum Length: 15

  Name of the payment term.

{
    "type":"object",
    "properties":{
        "CustTrxTypeId":{
            "type":"integer",
            "description":"The unique identifier for the Fusion AR transaction type for invoice.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "OnaccountReceivableActivity":{
            "title":"On Account Receivable Activity Name",
            "maxLength":50,
            "type":"string",
            "description":"The Receivable activity name that is used on receipts created for payments on account.",
            "nullable":true
        },
        "BuName":{
            "title":"Receivables Business Unit",
            "maxLength":240,
            "type":"string",
            "description":"Name of the business unit that is configured to process receivable transactions.",
            "nullable":true
        },
        "SetName":{
            "maxLength":80,
            "type":"string",
            "description":"Name of the reference data set value used within the context of the transaction setups that are retrieved through various reference resources.",
            "nullable":true
        },
        "InvoiceSystem":{
            "title":"Receivables System",
            "maxLength":20,
            "type":"string",
            "description":"The system that will generate the invoice.",
            "nullable":false
        },
        "ProfileClassName":{
            "maxLength":30,
            "type":"string",
            "description":"Name of the customer profile class.",
            "nullable":true
        },
        "CustCmTrxTypeId":{
            "type":"integer",
            "description":"The unique identifier for the Fusion AR transaction type for credit memo.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "RefundReceivableActivity":{
            "title":"Refund Receivable Activity",
            "maxLength":50,
            "type":"string",
            "description":"The Receivable activity name that is used on receipts created for refunds.",
            "nullable":true
        },
        "StartDate":{
            "type":"string",
            "description":"The cutoff date for the Oracle Receivable Receipts ESS job used to filter the payment records.",
            "format":"date",
            "nullable":true
        },
        "OrgId":{
            "title":"Organization ID",
            "type":"integer",
            "description":"The unique identifier for the business unit associated with the invoice.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "TermName":{
            "title":"Payment Term",
            "maxLength":15,
            "type":"string",
            "description":"Name of the payment term.",
            "nullable":true
        },
        "MemoLineName":{
            "title":"Memo Line Name",
            "maxLength":50,
            "type":"string",
            "description":"Name of the memo line.",
            "nullable":true
        },
        "CustTrxTypeName":{
            "title":"Invoice Transaction Type",
            "maxLength":20,
            "type":"string",
            "description":"Name of the invoice transaction type.",
            "nullable":true
        },
        "ReceivableActivityName":{
            "title":"Receivable Activity Name",
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier for the receivable activity name.",
            "nullable":true
        },
        "ProfileClassId":{
            "title":"Profile Class ID",
            "type":"integer",
            "description":"The unique identifier for the customer profile class.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "CustCmTrxTypeName":{
            "title":"Credit Memo Transaction Type",
            "maxLength":20,
            "type":"string",
            "description":"Name of the credit memo transaction type.",
            "nullable":true
        },
        "TermId":{
            "type":"integer",
            "description":"The unique identifier for the payment term.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the ERP Receivables integration is enabled.",
            "nullable":false
        },
        "MemoLineId":{
            "type":"integer",
            "description":"The unique identifier for the memo line that is used to derive the revenue account.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context(required):
  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(required):
  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 : publicSectorReceivableOptions-item-response

Type: object

Show Source

• AgencyId: integer (int32)
  Read Only: true

  Default Value: 1

  The unique identifier of the agency associated with the receivable options.
• BuName: string
  Title: Receivables Business Unit

  Maximum Length: 240

  Name of the business unit that is configured to process receivable transactions.
• CustCmTrxTypeId: integer (int64)
  The unique identifier for the Fusion AR transaction type for credit memo.
• CustCmTrxTypeName: string
  Title: Credit Memo Transaction Type

  Maximum Length: 20

  Name of the credit memo transaction type.
• CustTrxTypeId: integer (int64)
  The unique identifier for the Fusion AR transaction type for invoice.
• CustTrxTypeName: string
  Title: Invoice Transaction Type

  Maximum Length: 20

  Name of the invoice transaction type.
• EnabledFlag: string
  Title: Enabled

  Maximum Length: 1

  Indicates whether the ERP Receivables integration is enabled.
• InvoiceSystem: string
  Title: Receivables System

  Maximum Length: 20

  The system that will generate the invoice.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MemoLineId: integer (int64)
  The unique identifier for the memo line that is used to derive the revenue account.
• MemoLineName: string
  Title: Memo Line Name

  Maximum Length: 50

  Name of the memo line.
• OnaccountReceivableActivity: string
  Title: On Account Receivable Activity Name

  Maximum Length: 50

  The Receivable activity name that is used on receipts created for payments on account.
• OrgId: integer (int64)
  Title: Organization ID

  The unique identifier for the business unit associated with the invoice.
• ProfileClassId: integer (int64)
  Title: Profile Class ID

  The unique identifier for the customer profile class.
• ProfileClassName: string
  Maximum Length: 30

  Name of the customer profile class.
• ReceivableActivityName: string
  Title: Receivable Activity Name

  Maximum Length: 50

  The unique identifier for the receivable activity name.
• RefundReceivableActivity: string
  Title: Refund Receivable Activity

  Maximum Length: 50

  The Receivable activity name that is used on receipts created for refunds.
• SetName: string
  Maximum Length: 80

  Name of the reference data set value used within the context of the transaction setups that are retrieved through various reference resources.
• StartDate: string (date)
  The cutoff date for the Oracle Receivable Receipts ESS job used to filter the payment records.
• TermId: integer (int64)
  The unique identifier for the payment term.
• TermName: string
  Title: Payment Term

  Maximum Length: 15

  Name of the payment term.

{
    "type":"object",
    "properties":{
        "AgencyId":{
            "type":"integer",
            "description":"The unique identifier of the agency associated with the receivable options.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "default":1,
            "x-hints":{
                "precision":8
            },
            "x-queryable":true
        },
        "CustTrxTypeId":{
            "type":"integer",
            "description":"The unique identifier for the Fusion AR transaction type for invoice.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OnaccountReceivableActivity":{
            "title":"On Account Receivable Activity Name",
            "maxLength":50,
            "type":"string",
            "description":"The Receivable activity name that is used on receipts created for payments on account.",
            "nullable":true,
            "x-queryable":true
        },
        "BuName":{
            "title":"Receivables Business Unit",
            "maxLength":240,
            "type":"string",
            "description":"Name of the business unit that is configured to process receivable transactions.",
            "nullable":true,
            "x-queryable":true
        },
        "SetName":{
            "maxLength":80,
            "type":"string",
            "description":"Name of the reference data set value used within the context of the transaction setups that are retrieved through various reference resources.",
            "nullable":true,
            "x-queryable":true
        },
        "InvoiceSystem":{
            "title":"Receivables System",
            "maxLength":20,
            "type":"string",
            "description":"The system that will generate the invoice.",
            "nullable":false,
            "x-queryable":true
        },
        "ProfileClassName":{
            "maxLength":30,
            "type":"string",
            "description":"Name of the customer profile class.",
            "nullable":true,
            "x-queryable":true
        },
        "CustCmTrxTypeId":{
            "type":"integer",
            "description":"The unique identifier for the Fusion AR transaction type for credit memo.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RefundReceivableActivity":{
            "title":"Refund Receivable Activity",
            "maxLength":50,
            "type":"string",
            "description":"The Receivable activity name that is used on receipts created for refunds.",
            "nullable":true,
            "x-queryable":true
        },
        "StartDate":{
            "type":"string",
            "description":"The cutoff date for the Oracle Receivable Receipts ESS job used to filter the payment records.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "OrgId":{
            "title":"Organization ID",
            "type":"integer",
            "description":"The unique identifier for the business unit associated with the invoice.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TermName":{
            "title":"Payment Term",
            "maxLength":15,
            "type":"string",
            "description":"Name of the payment term.",
            "nullable":true,
            "x-queryable":true
        },
        "MemoLineName":{
            "title":"Memo Line Name",
            "maxLength":50,
            "type":"string",
            "description":"Name of the memo line.",
            "nullable":true,
            "x-queryable":true
        },
        "CustTrxTypeName":{
            "title":"Invoice Transaction Type",
            "maxLength":20,
            "type":"string",
            "description":"Name of the invoice transaction type.",
            "nullable":true,
            "x-queryable":true
        },
        "ReceivableActivityName":{
            "title":"Receivable Activity Name",
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier for the receivable activity name.",
            "nullable":true,
            "x-queryable":true
        },
        "ProfileClassId":{
            "title":"Profile Class ID",
            "type":"integer",
            "description":"The unique identifier for the customer profile class.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CustCmTrxTypeName":{
            "title":"Credit Memo Transaction Type",
            "maxLength":20,
            "type":"string",
            "description":"Name of the credit memo transaction type.",
            "nullable":true,
            "x-queryable":true
        },
        "TermId":{
            "type":"integer",
            "description":"The unique identifier for the payment term.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the ERP Receivables integration is enabled.",
            "nullable":false,
            "x-queryable":true
        },
        "MemoLineId":{
            "type":"integer",
            "description":"The unique identifier for the memo line that is used to derive the revenue account.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

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

Nested Schema : properties

Type: object

Show Source

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

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

Back to Top