Jump to

• Request
• Response

Update an invoice form

patch

/fscmRestApi/resources/11.13.18.05/publicSectorInvoiceForms/{publicSectorInvoiceFormsUniqID}

Request

Supported Media Types

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

Path Parameters

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

Body ()

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

Root Schema : publicSectorInvoiceForms-item

Type: object

Show Source

• AgencyId(optional): integer(int64)
  The unique identifer of the agency receiving an incoming customer payment. This is usually the name of a city or county.
• CreatedBy(optional): string
  Title: Created By

  Maximum Length: 64

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

  The date and time that the agency was created.
• Description(optional): string
  Maximum Length: 100

  The description of the invoice form.
• InvoiceFormId(optional): string
  Maximum Length: 20

  The unique identifier of the invoice format assigned to a bill type.
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

  The last date and time that the agency was updated.
• LastUpdatedBy(optional): string
  Title: Last Updated By

  Maximum Length: 64

  The user who last updated the agency.
• links(optional): array Items
  Title: Items

  Link Relations

{
    "properties":{
        "AgencyId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifer of the agency receiving an incoming customer payment. This is usually the name of a city or county."
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the agency.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time that the agency was created.",
            "title":"Creation Date"
        },
        "Description":{
            "maxLength":100,
            "type":"string",
            "description":"The description of the invoice form."
        },
        "InvoiceFormId":{
            "maxLength":20,
            "type":"string",
            "description":"The unique identifier of the invoice format assigned to a bill type."
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The last date and time that the agency was updated.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the agency.",
            "title":"Last Updated By"
        },
        "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 : publicSectorInvoiceForms-item

Type: object

Show Source

• AgencyId(optional): integer(int64)
  The unique identifer of the agency receiving an incoming customer payment. This is usually the name of a city or county.
• CreatedBy(optional): string
  Title: Created By

  Maximum Length: 64

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

  The date and time that the agency was created.
• Description(optional): string
  Maximum Length: 100

  The description of the invoice form.
• InvoiceFormId(optional): string
  Maximum Length: 20

  The unique identifier of the invoice format assigned to a bill type.
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

  The last date and time that the agency was updated.
• LastUpdatedBy(optional): string
  Title: Last Updated By

  Maximum Length: 64

  The user who last updated the agency.
• links(optional): array Items
  Title: Items

  Link Relations

{
    "properties":{
        "AgencyId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifer of the agency receiving an incoming customer payment. This is usually the name of a city or county."
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the agency.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time that the agency was created.",
            "title":"Creation Date"
        },
        "Description":{
            "maxLength":100,
            "type":"string",
            "description":"The description of the invoice form."
        },
        "InvoiceFormId":{
            "maxLength":20,
            "type":"string",
            "description":"The unique identifier of the invoice format assigned to a bill type."
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The last date and time that the agency was updated.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the agency.",
            "title":"Last Updated By"
        },
        "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