Jump to

• Request
• Response

Create a fee item memo line

post

/fscmRestApi/resources/11.13.18.05/publicSectorFeeItemMemoLines

Request

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.
• Upsert-Mode:
  When set to true, the server will perform an Upsert operation instead of a Create. In an Upsert operation the server attempts to find an existing resource that matches the payload. If found, the server updates the existing resource instead of creating a new one. If not found, or when set to false (the default), a Create is performed.

Supported Media Types

• application/json

Request Body - application/json ()

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

Root Schema : schema

Type: object

Show Source

• AllRecordType: string
  Title: All Record Types

  Maximum Length: 1

  Indicates whether the memo line applies to all record types.
• Classification: string
  Maximum Length: 3

  Identifies the type of transaction.
• FeeItemId: string
  Title: Fee Item ID

  Maximum Length: 30

  The unique identifier assigned to a fee item.
• MemoLineId: integer (int64)
  The unique memo line idenifier that is used to derive the revenue account.
• MemoLineName: string
  Maximum Length: 50

  Name of the memo line that is used to derive the revenue account.
• ReceivableActivityName: string
  Maximum Length: 50

  Unique Identifier for Receivable activity name.
• RecordType: string
  Maximum Length: 50

  Identifies a permit type or a code violation subtype.
• TransactionOrigin: string
  Maximum Length: 30

  Source application that originated the transaction.

{
    "type":"object",
    "properties":{
        "FeeItemId":{
            "title":"Fee Item ID",
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier assigned to a fee item.",
            "nullable":false
        },
        "MemoLineName":{
            "maxLength":50,
            "type":"string",
            "description":"Name of the memo line that is used to derive the revenue account.",
            "nullable":true
        },
        "RecordType":{
            "maxLength":50,
            "type":"string",
            "description":"Identifies a permit type or a code violation subtype.",
            "nullable":false
        },
        "ReceivableActivityName":{
            "maxLength":50,
            "type":"string",
            "description":"Unique Identifier for Receivable activity name.",
            "nullable":false
        },
        "Classification":{
            "maxLength":3,
            "type":"string",
            "description":"Identifies the type of transaction.",
            "nullable":false
        },
        "TransactionOrigin":{
            "maxLength":30,
            "type":"string",
            "description":"Source application that originated the transaction.",
            "nullable":false
        },
        "AllRecordType":{
            "title":"All Record Types",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the memo line applies to all record types.",
            "nullable":false
        },
        "MemoLineId":{
            "type":"integer",
            "description":"The unique memo line idenifier 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 : publicSectorFeeItemMemoLines-item-response

Type: object

Show Source

• AgencyId: integer (int32)
  Read Only: true

  Default Value: 1

  The unique identifier of the agency associated with the fee item and memo line identifier mapping.
• AllRecordType: string
  Title: All Record Types

  Maximum Length: 1

  Indicates whether the memo line applies to all record types.
• Classification: string
  Maximum Length: 3

  Identifies the type of transaction.
• FeeItemId: string
  Title: Fee Item ID

  Maximum Length: 30

  The unique identifier assigned to a fee item.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MemoLineId: integer (int64)
  The unique memo line idenifier that is used to derive the revenue account.
• MemoLineName: string
  Maximum Length: 50

  Name of the memo line that is used to derive the revenue account.
• ReceivableActivityName: string
  Maximum Length: 50

  Unique Identifier for Receivable activity name.
• RecordType: string
  Maximum Length: 50

  Identifies a permit type or a code violation subtype.
• TransactionOrigin: string
  Maximum Length: 30

  Source application that originated the transaction.

{
    "type":"object",
    "properties":{
        "FeeItemId":{
            "title":"Fee Item ID",
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier assigned to a fee item.",
            "nullable":false,
            "x-queryable":true
        },
        "MemoLineName":{
            "maxLength":50,
            "type":"string",
            "description":"Name of the memo line that is used to derive the revenue account.",
            "nullable":true,
            "x-queryable":true
        },
        "AgencyId":{
            "type":"integer",
            "description":"The unique identifier of the agency associated with the fee item and memo line identifier mapping.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "default":1,
            "x-hints":{
                "precision":8
            },
            "x-queryable":true
        },
        "RecordType":{
            "maxLength":50,
            "type":"string",
            "description":"Identifies a permit type or a code violation subtype.",
            "nullable":false,
            "x-queryable":true
        },
        "ReceivableActivityName":{
            "maxLength":50,
            "type":"string",
            "description":"Unique Identifier for Receivable activity name.",
            "nullable":false,
            "x-queryable":true
        },
        "Classification":{
            "maxLength":3,
            "type":"string",
            "description":"Identifies the type of transaction.",
            "nullable":false,
            "x-queryable":true
        },
        "TransactionOrigin":{
            "maxLength":30,
            "type":"string",
            "description":"Source application that originated the transaction.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AllRecordType":{
            "title":"All Record Types",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the memo line applies to all record types.",
            "nullable":false,
            "x-queryable":true
        },
        "MemoLineId":{
            "type":"integer",
            "description":"The unique memo line idenifier 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