Jump to

• Request
• Response

Update a bill type

patch

/fscmRestApi/resources/11.13.18.05/publicSectorBillTypes/{publicSectorBillTypesUniqID}

Request

Path Parameters

• publicSectorBillTypesUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- AgencyId and BillType ---for the Bill Types resource and used to uniquely identify an instance of Bill Types. The client should not generate the hash key value. Instead, the client should query on the Bill Types collection resource with a filter on the primary key values in order to navigate to a specific instance of Bill Types.
  
  For example: publicSectorBillTypes?q=AgencyId=<value1>;BillType=<value2>

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

• AgencyId: integer (int32)
  Default Value: 1

  The unique identifier of the agency receiving an incoming customer payment. This is usually the name of a city or county.
• Description: string
  Title: Description

  Maximum Length: 100

  Description of the bill type. Enables a business to store more information about the bill type.
• InvoiceFormId: string
  Title: Invoice Form

  Maximum Length: 20

  The unique identifier of the invoice format assigned to the bill type.
• InvoiceNumberId: string
  Title: Invoice Series

  Maximum Length: 20

  The unique identifier of the invoice number generation rule assigned to a bill type.

{
    "type":"object",
    "properties":{
        "InvoiceFormId":{
            "title":"Invoice Form",
            "maxLength":"20",
            "type":"string",
            "description":"The unique identifier of the invoice format assigned to the bill type.",
            "nullable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"100",
            "type":"string",
            "description":"Description of the bill type. Enables a business to store more information about the bill type.",
            "nullable":false
        },
        "AgencyId":{
            "type":"integer",
            "description":"The unique identifier of the agency receiving an incoming customer payment. This is usually the name of a city or county.",
            "format":"int32",
            "nullable":false,
            "default":"1",
            "x-hints":{
                "precision":"8"
            }
        },
        "InvoiceNumberId":{
            "title":"Invoice Series",
            "maxLength":"20",
            "type":"string",
            "description":"The unique identifier of the invoice number generation rule assigned to a bill type.",
            "nullable":false
        }
    }
}

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 : publicSectorBillTypes-item-response

Type: object

Show Source

• AgencyId: integer (int32)
  Default Value: 1

  The unique identifier of the agency receiving an incoming customer payment. This is usually the name of a city or county.
• BillType: string
  Title: Bill Type

  Maximum Length: 15

  The bill type. Used to classify invoices into groups of invoice documents that have similar characteristics. They are also used to assign sequence numbers to invoices.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

  The date and time that the agency was created.
• Description: string
  Title: Description

  Maximum Length: 100

  Description of the bill type. Enables a business to store more information about the bill type.
• InvoiceFormId: string
  Title: Invoice Form

  Maximum Length: 20

  The unique identifier of the invoice format assigned to the bill type.
• InvoiceNumberId: string
  Title: Invoice Series

  Maximum Length: 20

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

  Read Only: true

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

  Read Only: true

  Maximum Length: 64

  The user who last updated the agency.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the agency.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BillType":{
            "title":"Bill Type",
            "maxLength":"15",
            "type":"string",
            "description":"The bill type. Used to classify invoices into groups of invoice documents that have similar characteristics. They are also used to assign sequence numbers to invoices.",
            "nullable":false,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time that the agency was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the agency.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"100",
            "type":"string",
            "description":"Description of the bill type. Enables a business to store more information about the bill type.",
            "nullable":false,
            "x-queryable":true
        },
        "AgencyId":{
            "type":"integer",
            "description":"The unique identifier of the agency receiving an incoming customer payment. This is usually the name of a city or county.",
            "format":"int32",
            "nullable":false,
            "default":"1",
            "x-hints":{
                "precision":"8"
            },
            "x-queryable":true
        },
        "InvoiceNumberId":{
            "title":"Invoice Series",
            "maxLength":"20",
            "type":"string",
            "description":"The unique identifier of the invoice number generation rule assigned to a bill type.",
            "nullable":false,
            "x-queryable":true
        },
        "InvoiceFormId":{
            "title":"Invoice Form",
            "maxLength":"20",
            "type":"string",
            "description":"The unique identifier of the invoice format assigned to the bill type.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The last date and time that the agency was updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "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