Jump to

• Request
• Response

Update a set of ReceivableOptions data

patch

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

Request

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Path Parameters

• AgencyId: integer
  The unique identifier of the agency associated with the receivable options.

Body ()

The following table describes the body parameters in the request for this task.

Root Schema : publicSectorReceivableOptions-item

Type: object

Show Source

• AgencyId(optional): integer(int32)
  The unique identifier of the agency associated with the receivable options.
• BuName(optional): string
  Maximum Length: 240

  Name of the business unit that is configured to process receivable transactions.
• CustCmTrxTypeId(optional): integer(int64)
  The unique identifier for the Fusion AR transaction type for credit memo.
• CustCmTrxTypeName(optional): string
  Maximum Length: 20

  Name of the credit memo transaction type.
• CustTrxTypeId(optional): integer(int64)
  The unique identifier for the Fusion AR transaction type for invoice.
• CustTrxTypeName(optional): string
  Maximum Length: 20

  Name of the invoice transaction type.
• EnabledFlag(optional): string
  Maximum Length: 1

  Indicates whether the ERP Receivables integration is enabled.
• InvoiceSystem(optional): string
  Maximum Length: 20

  The system that will generate the invoice.
• links(optional): array Items
  Title: Items

  Link Relations
• MemoLineId(optional): integer(int64)
  The unique identifier for the memo line that is used to derive the revenue account.
• MemoLineName(optional): string
  Maximum Length: 50

  Name of the memo line.
• OnaccountReceivableActivity(optional): string
  Maximum Length: 50

  The Receivable activity name that is used on receipts created for payments on account.
• OrgId(optional): integer(int64)
  The unique identifier for the business unit associated with the invoice.
• ProfileClassId(optional): integer(int64)
  The unique identifier for the customer profile class.
• ProfileClassName(optional): string
  Maximum Length: 30

  Name of the customer profile class.
• ReceivableActivityName(optional): string
  Maximum Length: 50

  The unique identifier for the receivable activity name.
• RefundReceivableActivity(optional): string
  Maximum Length: 50

  The Receivable activity name that is used on receipts created for refunds.
• SetName(optional): 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.
• TermId(optional): integer(int64)
  The unique identifier for the payment term.
• TermName(optional): string
  Maximum Length: 15

  Name of the payment term.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The unique identifier of the agency associated with the receivable options."
        },
        "BuName":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the business unit that is configured to process receivable transactions."
        },
        "CustCmTrxTypeId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for the Fusion AR transaction type for credit memo."
        },
        "CustCmTrxTypeName":{
            "maxLength":20,
            "type":"string",
            "description":"Name of the credit memo transaction type."
        },
        "CustTrxTypeId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for the Fusion AR transaction type for invoice."
        },
        "CustTrxTypeName":{
            "maxLength":20,
            "type":"string",
            "description":"Name of the invoice transaction type."
        },
        "EnabledFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the ERP Receivables integration is enabled."
        },
        "InvoiceSystem":{
            "maxLength":20,
            "type":"string",
            "description":"The system that will generate the invoice."
        },
        "MemoLineId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for the memo line that is used to derive the revenue account."
        },
        "MemoLineName":{
            "maxLength":50,
            "type":"string",
            "description":"Name of the memo line."
        },
        "OnaccountReceivableActivity":{
            "maxLength":50,
            "type":"string",
            "description":"The Receivable activity name that is used on receipts created for payments on account."
        },
        "OrgId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for the business unit associated with the invoice."
        },
        "ProfileClassId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for the customer profile class."
        },
        "ProfileClassName":{
            "maxLength":30,
            "type":"string",
            "description":"Name of the customer profile class."
        },
        "ReceivableActivityName":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier for the receivable activity name."
        },
        "RefundReceivableActivity":{
            "maxLength":50,
            "type":"string",
            "description":"The Receivable activity name that is used on receipts created for refunds."
        },
        "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."
        },
        "TermId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for the payment term."
        },
        "TermName":{
            "maxLength":15,
            "type":"string",
            "description":"Name of the payment term."
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : link

Type: object

Show Source

• href(optional): string
  Title: hyperlink reference

  The URI to the related resource.
• rel(optional): string
  Title: relation

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

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Back to Top

Response

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : publicSectorReceivableOptions-item

Type: object

Show Source

• AgencyId(optional): integer(int32)
  The unique identifier of the agency associated with the receivable options.
• BuName(optional): string
  Maximum Length: 240

  Name of the business unit that is configured to process receivable transactions.
• CustCmTrxTypeId(optional): integer(int64)
  The unique identifier for the Fusion AR transaction type for credit memo.
• CustCmTrxTypeName(optional): string
  Maximum Length: 20

  Name of the credit memo transaction type.
• CustTrxTypeId(optional): integer(int64)
  The unique identifier for the Fusion AR transaction type for invoice.
• CustTrxTypeName(optional): string
  Maximum Length: 20

  Name of the invoice transaction type.
• EnabledFlag(optional): string
  Maximum Length: 1

  Indicates whether the ERP Receivables integration is enabled.
• InvoiceSystem(optional): string
  Maximum Length: 20

  The system that will generate the invoice.
• links(optional): array Items
  Title: Items

  Link Relations
• MemoLineId(optional): integer(int64)
  The unique identifier for the memo line that is used to derive the revenue account.
• MemoLineName(optional): string
  Maximum Length: 50

  Name of the memo line.
• OnaccountReceivableActivity(optional): string
  Maximum Length: 50

  The Receivable activity name that is used on receipts created for payments on account.
• OrgId(optional): integer(int64)
  The unique identifier for the business unit associated with the invoice.
• ProfileClassId(optional): integer(int64)
  The unique identifier for the customer profile class.
• ProfileClassName(optional): string
  Maximum Length: 30

  Name of the customer profile class.
• ReceivableActivityName(optional): string
  Maximum Length: 50

  The unique identifier for the receivable activity name.
• RefundReceivableActivity(optional): string
  Maximum Length: 50

  The Receivable activity name that is used on receipts created for refunds.
• SetName(optional): 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.
• TermId(optional): integer(int64)
  The unique identifier for the payment term.
• TermName(optional): string
  Maximum Length: 15

  Name of the payment term.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The unique identifier of the agency associated with the receivable options."
        },
        "BuName":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the business unit that is configured to process receivable transactions."
        },
        "CustCmTrxTypeId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for the Fusion AR transaction type for credit memo."
        },
        "CustCmTrxTypeName":{
            "maxLength":20,
            "type":"string",
            "description":"Name of the credit memo transaction type."
        },
        "CustTrxTypeId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for the Fusion AR transaction type for invoice."
        },
        "CustTrxTypeName":{
            "maxLength":20,
            "type":"string",
            "description":"Name of the invoice transaction type."
        },
        "EnabledFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the ERP Receivables integration is enabled."
        },
        "InvoiceSystem":{
            "maxLength":20,
            "type":"string",
            "description":"The system that will generate the invoice."
        },
        "MemoLineId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for the memo line that is used to derive the revenue account."
        },
        "MemoLineName":{
            "maxLength":50,
            "type":"string",
            "description":"Name of the memo line."
        },
        "OnaccountReceivableActivity":{
            "maxLength":50,
            "type":"string",
            "description":"The Receivable activity name that is used on receipts created for payments on account."
        },
        "OrgId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for the business unit associated with the invoice."
        },
        "ProfileClassId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for the customer profile class."
        },
        "ProfileClassName":{
            "maxLength":30,
            "type":"string",
            "description":"Name of the customer profile class."
        },
        "ReceivableActivityName":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier for the receivable activity name."
        },
        "RefundReceivableActivity":{
            "maxLength":50,
            "type":"string",
            "description":"The Receivable activity name that is used on receipts created for refunds."
        },
        "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."
        },
        "TermId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for the payment term."
        },
        "TermName":{
            "maxLength":15,
            "type":"string",
            "description":"Name of the payment term."
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : link

Type: object

Show Source

• href(optional): string
  Title: hyperlink reference

  The URI to the related resource.
• rel(optional): string
  Title: relation

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

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Back to Top