Jump to

• Request
• Response

Update a set of receipt options data

patch

/fscmRestApi/resources/11.13.18.05/publicSectorERPReceiptOptions/{publicSectorERPReceiptOptionsUniqID}

Request

Supported Media Types

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

Path Parameters

• publicSectorERPReceiptOptionsUniqID: integer
  This is the hash key of the attributes which make up the composite key--- AgencyId, InvoiceSystem and PaymentMethodCode ---for the ERP Receipt Options resource and used to uniquely identify an instance of ERP Receipt Options. The client should not generate the hash key value. Instead, the client should query on the ERP Receipt Options collection resource with a filter on the primary key values in order to navigate to a specific instance of ERP Receipt Options.
  
  For example: publicSectorERPReceiptOptions?q=AgencyId=<value1>;InvoiceSystem=<value2>;PaymentMethodCode=<value3>

Body ()

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

Root Schema : publicSectorERPReceiptOptions-item

Type: object

Show Source

• AgencyId(optional): integer(int32)
  Unique identifier of the agency associated with the receivable options.
• InvoiceSystem(optional): string
  Maximum Length: 20

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

  Link Relations
• PaymentMethodCode(optional): string
  Maximum Length: 30

  Code to Identify Payment Method
• ReceiptMethodName(optional): string
  Maximum Length: 30

  Receipt method name to derive gl account.
• RemittanceAccountName(optional): string
  Maximum Length: 360

  Name of Remittance Account.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"Unique identifier of the agency associated with the receivable options."
        },
        "InvoiceSystem":{
            "maxLength":20,
            "type":"string",
            "description":"The system that will generate the invoice."
        },
        "PaymentMethodCode":{
            "maxLength":30,
            "type":"string",
            "description":"Code to Identify Payment Method"
        },
        "ReceiptMethodName":{
            "maxLength":30,
            "type":"string",
            "description":"Receipt method name to derive gl account."
        },
        "RemittanceAccountName":{
            "maxLength":360,
            "type":"string",
            "description":"Name of Remittance Account."
        },
        "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 : publicSectorERPReceiptOptions-item

Type: object

Show Source

• AgencyId(optional): integer(int32)
  Unique identifier of the agency associated with the receivable options.
• InvoiceSystem(optional): string
  Maximum Length: 20

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

  Link Relations
• PaymentMethodCode(optional): string
  Maximum Length: 30

  Code to Identify Payment Method
• ReceiptMethodName(optional): string
  Maximum Length: 30

  Receipt method name to derive gl account.
• RemittanceAccountName(optional): string
  Maximum Length: 360

  Name of Remittance Account.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"Unique identifier of the agency associated with the receivable options."
        },
        "InvoiceSystem":{
            "maxLength":20,
            "type":"string",
            "description":"The system that will generate the invoice."
        },
        "PaymentMethodCode":{
            "maxLength":30,
            "type":"string",
            "description":"Code to Identify Payment Method"
        },
        "ReceiptMethodName":{
            "maxLength":30,
            "type":"string",
            "description":"Receipt method name to derive gl account."
        },
        "RemittanceAccountName":{
            "maxLength":360,
            "type":"string",
            "description":"Name of Remittance Account."
        },
        "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