Jump to

• Request
• Response

Create a set of case citations

post

/fscmRestApi/resources/11.13.18.05/publicSectorCitations

Request

Supported Media Types

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

Body ()

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

Root Schema : publicSectorCitations-item

Type: object

Show Source

• AgencyId(optional): integer(int32)
  Title: Agency ID

  The agency identifier of the case citation.
• CaseComplianceDueDate(optional): string(date)
  The compliance due date of the case associated with the citation.
• CaseId(optional): string
  Title: Case ID

  Maximum Length: 50

  The unique identifier of the case.
• CaseKey(optional): integer(int64)
  The unique identifier of the case.
• CaseNoticeKey(optional): integer(int64)
  The unique identifier of the case notice for the case citation.
• CaseNoticePuid(optional): string
  The public unique identifier of the migrated case notice record.
• CasePuid(optional): string
  Maximum Length: 480

  The public unique identifier of the migrated case record.
• CitationId(optional): string
  Title: Citation ID

  Maximum Length: 50

  The unique identifier of the case citation.
• CitationKey(optional): integer(int64)
  The unique identifier of the case citation.
• CitationPuid(optional): string
  Maximum Length: 480

  The public unique identifier of the migrated citation record.
• CodeViolation(optional): string
  Indicates the total number of code violations linked to the citation.
• Comments(optional): string
  Title: Comments

  Maximum Length: 1000

  The comments entered for the case citation.
• CreatedByName(optional): string
  Title: Created By

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

  The date and time when the row was created.
• Description(optional): string
  Title: Description

  Maximum Length: 1000

  The description of the case citation.
• DueDate(optional): string(date)
  Title: Due Date

  The due date for the case citation.
• FeeRecordKey(optional): integer(int64)
  The unique identifier of the case fee record for the case citation.
• FeeRecordPuid(optional): string
  The public unique identifier of the migrated case fee record.
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

  The date and time when the row was last updated.
• LastUpdatedByName(optional): string
  Title: Last Updated By

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

  Link Relations
• PayCitation(optional): array Citation Payments
  Title: Citation Payments

  The citation payment resource is used to view a citation payment. Case citations are used in Code Enforcement cases.
• PaymentDate(optional): string(date-time)
  The date when the citation fee was paid.

{
    "type":"object",
    "properties":{
        "AgencyId":{
            "title":"Agency ID",
            "description":"The agency identifier of the case citation.",
            "type":"integer",
            "format":"int32"
        },
        "CaseComplianceDueDate":{
            "description":"The compliance due date of the case associated with the citation.",
            "type":"string",
            "format":"date"
        },
        "CaseId":{
            "title":"Case ID",
            "description":"The unique identifier of the case.",
            "type":"string",
            "maxLength":50
        },
        "CaseKey":{
            "description":"The unique identifier of the case.",
            "type":"integer",
            "format":"int64"
        },
        "CaseNoticeKey":{
            "description":"The unique identifier of the case notice for the case citation.",
            "type":"integer",
            "format":"int64"
        },
        "CaseNoticePuid":{
            "description":"The public unique identifier of the migrated case notice record.",
            "type":"string"
        },
        "CasePuid":{
            "description":"The public unique identifier of the migrated case record.",
            "type":"string",
            "maxLength":480
        },
        "CitationId":{
            "title":"Citation ID",
            "description":"The unique identifier of the case citation.",
            "type":"string",
            "maxLength":50
        },
        "CitationKey":{
            "description":"The unique identifier of the case citation.",
            "type":"integer",
            "format":"int64"
        },
        "CitationPuid":{
            "description":"The public unique identifier of the migrated citation record.",
            "type":"string",
            "maxLength":480
        },
        "CodeViolation":{
            "description":"Indicates the total number of code violations linked to the citation.",
            "type":"string"
        },
        "Comments":{
            "title":"Comments",
            "description":"The comments entered for the case citation.",
            "type":"string",
            "maxLength":1000
        },
        "CreatedByName":{
            "title":"Created By",
            "description":"The name of the user who created the row.",
            "type":"string"
        },
        "CreationDate":{
            "title":"Creation Date",
            "description":"The date and time when the row was created.",
            "type":"string",
            "format":"date-time"
        },
        "Description":{
            "title":"Description",
            "description":"The description of the case citation.",
            "type":"string",
            "maxLength":1000
        },
        "DueDate":{
            "title":"Due Date",
            "description":"The due date for the case citation.",
            "type":"string",
            "format":"date"
        },
        "FeeRecordKey":{
            "description":"The unique identifier of the case fee record for the case citation.",
            "type":"integer",
            "format":"int64"
        },
        "FeeRecordPuid":{
            "description":"The public unique identifier of the migrated case fee record.",
            "type":"string"
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "description":"The date and time when the row was last updated.",
            "type":"string",
            "format":"date-time"
        },
        "LastUpdatedByName":{
            "title":"Last Updated By",
            "description":"The name of the user who last updated the row.",
            "type":"string"
        },
        "PayCitation":{
            "title":"Citation Payments",
            "description":"The citation payment resource is used to view a citation payment. Case citations are used in Code Enforcement cases.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/publicSectorCitations-PayCitation-item"
            }
        },
        "PaymentDate":{
            "description":"The date when the citation fee was paid.",
            "type":"string",
            "format":"date-time"
        },
        "links":{
            "title":"Items",
            "description":"Link Relations",
            "type":"array",
            "items":{
                "$ref":"#/definitions/link"
            }
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

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

Nested Schema : Citation Payments

Type: array

Title: Citation Payments

The citation payment resource is used to view a citation payment. Case citations are used in Code Enforcement cases.

Show Source

• Array of: object publicSectorCitations-PayCitation-item

{
    "title":"Citation Payments",
    "description":"The citation payment resource is used to view a citation payment. Case citations are used in Code Enforcement cases.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/publicSectorCitations-PayCitation-item"
    }
}

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.

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

Nested Schema : publicSectorCitations-PayCitation-item

Type: object

Show Source

• AgencyId(optional): integer(int32)
  Title: Agency ID

  The agency identifier of the case citation.
• CaseId(optional): string
  Maximum Length: 255

  The unique identifier of the case.
• CaseKey(optional): integer(int64)
  The unique identifier of the case.
• CaseStatus(optional): string
  Maximum Length: 30

  The status of the case associated with the citation.
• CaseSubmitDate(optional): string(date-time)
  The date on which the case was submitted.
• CitationDueDate(optional): string(date)
  Title: Due Date

  The due date of case associated with the citation.
• CitationId(optional): string
  Title: Citation ID

  Maximum Length: 50

  The unique identifier of the case citation.
• CitationKey(optional): integer(int64)
  The unique identifier of the case citation.
• CreationDate(optional): string(date-time)
  Title: Creation Date

  The date and time when the row was created.
• CurrencyCode(optional): string
  Maximum Length: 3

  The currency code of the citation fee amount.
• DueDate(optional): string(date)
  The due date for the case citation.
• FeeRecordKey(optional): integer(int64)
  The unique identifier of the case fee record for the case citation.
• FeeRecords(optional): array Fee Records
  Title: Fee Records

  The fee records resource is used to view fee records associated with a citation.
• FeeStatus(optional): string
  Maximum Length: 15

  The fee status of the case citation.
• IssueSubtype(optional): string
  Maximum Length: 100

  The subtype of the issue that belongs to the case.
• links(optional): array Items
  Title: Items

  Link Relations
• PaymentReferenceId(optional): string
  Maximum Length: 50

  The unique identifier of the payment reference for the paid amount.
• TotalFeeAmount(optional): number
  The total fee amount for the case citation.
• TotalFeeAmountDue(optional): number
  Title: Total Due

  The total fee amount due for the case associated with the citation.
• TotalFeeAmountPaymentInProgress(optional): number
  Title: Payment in Progress

  The total fee amount for the case associated with the citation for which the payment is in progress.

{
    "type":"object",
    "properties":{
        "AgencyId":{
            "title":"Agency ID",
            "description":"The agency identifier of the case citation.",
            "type":"integer",
            "format":"int32"
        },
        "CaseId":{
            "description":"The unique identifier of the case.",
            "type":"string",
            "maxLength":255
        },
        "CaseKey":{
            "description":"The unique identifier of the case.",
            "type":"integer",
            "format":"int64"
        },
        "CaseStatus":{
            "description":"The status of the case associated with the citation.",
            "type":"string",
            "maxLength":30
        },
        "CaseSubmitDate":{
            "description":"The date on which the case was submitted.",
            "type":"string",
            "format":"date-time"
        },
        "CitationDueDate":{
            "title":"Due Date",
            "description":"The due date of case associated with the citation.",
            "type":"string",
            "format":"date"
        },
        "CitationId":{
            "title":"Citation ID",
            "description":"The unique identifier of the case citation.",
            "type":"string",
            "maxLength":50
        },
        "CitationKey":{
            "description":"The unique identifier of the case citation.",
            "type":"integer",
            "format":"int64"
        },
        "CreationDate":{
            "title":"Creation Date",
            "description":"The date and time when the row was created.",
            "type":"string",
            "format":"date-time"
        },
        "CurrencyCode":{
            "description":"The currency code of the citation fee amount.",
            "type":"string",
            "maxLength":3
        },
        "DueDate":{
            "description":"The due date for the case citation.",
            "type":"string",
            "format":"date"
        },
        "FeeRecordKey":{
            "description":"The unique identifier of the case fee record for the case citation.",
            "type":"integer",
            "format":"int64"
        },
        "FeeRecords":{
            "title":"Fee Records",
            "description":"The fee records resource is used to view fee records associated with a citation.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/publicSectorCitations-PayCitation-FeeRecords-item"
            }
        },
        "FeeStatus":{
            "description":"The fee status of the case citation.",
            "type":"string",
            "maxLength":15
        },
        "IssueSubtype":{
            "description":"The subtype of the issue that belongs to the case.",
            "type":"string",
            "maxLength":100
        },
        "PaymentReferenceId":{
            "description":"The unique identifier of the payment reference for the paid amount.",
            "type":"string",
            "maxLength":50
        },
        "TotalFeeAmount":{
            "description":"The total fee amount for the case citation.",
            "type":"number"
        },
        "TotalFeeAmountDue":{
            "title":"Total Due",
            "description":"The total fee amount due for the case associated with the citation.",
            "type":"number"
        },
        "TotalFeeAmountPaymentInProgress":{
            "title":"Payment in Progress",
            "description":"The total fee amount for the case associated with the citation for which the payment is in progress.",
            "type":"number"
        },
        "links":{
            "title":"Items",
            "description":"Link Relations",
            "type":"array",
            "items":{
                "$ref":"#/definitions/link"
            }
        }
    }
}

Nested Schema : Fee Records

Type: array

Title: Fee Records

The fee records resource is used to view fee records associated with a citation.

Show Source

• Array of: object publicSectorCitations-PayCitation-FeeRecords-item

{
    "title":"Fee Records",
    "description":"The fee records resource is used to view fee records associated with a citation.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/publicSectorCitations-PayCitation-FeeRecords-item"
    }
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

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

Nested Schema : publicSectorCitations-PayCitation-FeeRecords-item

Type: object

Show Source

• CitationKey(optional): integer(int64)
  The unique identifier of the case associated with the citation.
• CurrencyCode(optional): string
  Maximum Length: 3

  The currency code of the fee record.
• DueDate(optional): string(date)
  The due date of the fee record.
• FeeAmount(optional): number
  The amount of the fee record.
• FeeQuantity(optional): number
  The quantity of the fee record.
• FeeRecordKey(optional): integer(int64)
  The unique identifier of the fee record.
• FeeStatus(optional): string
  Maximum Length: 15

  The status of the fee record.
• links(optional): array Items
  Title: Items

  Link Relations
• ParentFeeRecordKey(optional): integer(int64)
  The parent fee record identifier of the fee record.

{
    "type":"object",
    "properties":{
        "CitationKey":{
            "description":"The unique identifier of the case associated with the citation.",
            "type":"integer",
            "format":"int64"
        },
        "CurrencyCode":{
            "description":"The currency code of the fee record.",
            "type":"string",
            "maxLength":3
        },
        "DueDate":{
            "description":"The due date of the fee record.",
            "type":"string",
            "format":"date"
        },
        "FeeAmount":{
            "description":"The amount of the fee record.",
            "type":"number"
        },
        "FeeQuantity":{
            "description":"The quantity of the fee record.",
            "type":"number"
        },
        "FeeRecordKey":{
            "description":"The unique identifier of the fee record.",
            "type":"integer",
            "format":"int64"
        },
        "FeeStatus":{
            "description":"The status of the fee record.",
            "type":"string",
            "maxLength":15
        },
        "ParentFeeRecordKey":{
            "description":"The parent fee record identifier of the fee record.",
            "type":"integer",
            "format":"int64"
        },
        "links":{
            "title":"Items",
            "description":"Link Relations",
            "type":"array",
            "items":{
                "$ref":"#/definitions/link"
            }
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

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

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 : publicSectorCitations-item

Type: object

Show Source

• AgencyId(optional): integer(int32)
  Title: Agency ID

  The agency identifier of the case citation.
• CaseComplianceDueDate(optional): string(date)
  The compliance due date of the case associated with the citation.
• CaseId(optional): string
  Title: Case ID

  Maximum Length: 50

  The unique identifier of the case.
• CaseKey(optional): integer(int64)
  The unique identifier of the case.
• CaseNoticeKey(optional): integer(int64)
  The unique identifier of the case notice for the case citation.
• CaseNoticePuid(optional): string
  The public unique identifier of the migrated case notice record.
• CasePuid(optional): string
  Maximum Length: 480

  The public unique identifier of the migrated case record.
• CitationId(optional): string
  Title: Citation ID

  Maximum Length: 50

  The unique identifier of the case citation.
• CitationKey(optional): integer(int64)
  The unique identifier of the case citation.
• CitationPuid(optional): string
  Maximum Length: 480

  The public unique identifier of the migrated citation record.
• CodeViolation(optional): string
  Indicates the total number of code violations linked to the citation.
• Comments(optional): string
  Title: Comments

  Maximum Length: 1000

  The comments entered for the case citation.
• CreatedByName(optional): string
  Title: Created By

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

  The date and time when the row was created.
• Description(optional): string
  Title: Description

  Maximum Length: 1000

  The description of the case citation.
• DueDate(optional): string(date)
  Title: Due Date

  The due date for the case citation.
• FeeRecordKey(optional): integer(int64)
  The unique identifier of the case fee record for the case citation.
• FeeRecordPuid(optional): string
  The public unique identifier of the migrated case fee record.
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

  The date and time when the row was last updated.
• LastUpdatedByName(optional): string
  Title: Last Updated By

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

  Link Relations
• PayCitation(optional): array Citation Payments
  Title: Citation Payments

  The citation payment resource is used to view a citation payment. Case citations are used in Code Enforcement cases.
• PaymentDate(optional): string(date-time)
  The date when the citation fee was paid.

{
    "type":"object",
    "properties":{
        "AgencyId":{
            "title":"Agency ID",
            "description":"The agency identifier of the case citation.",
            "type":"integer",
            "format":"int32"
        },
        "CaseComplianceDueDate":{
            "description":"The compliance due date of the case associated with the citation.",
            "type":"string",
            "format":"date"
        },
        "CaseId":{
            "title":"Case ID",
            "description":"The unique identifier of the case.",
            "type":"string",
            "maxLength":50
        },
        "CaseKey":{
            "description":"The unique identifier of the case.",
            "type":"integer",
            "format":"int64"
        },
        "CaseNoticeKey":{
            "description":"The unique identifier of the case notice for the case citation.",
            "type":"integer",
            "format":"int64"
        },
        "CaseNoticePuid":{
            "description":"The public unique identifier of the migrated case notice record.",
            "type":"string"
        },
        "CasePuid":{
            "description":"The public unique identifier of the migrated case record.",
            "type":"string",
            "maxLength":480
        },
        "CitationId":{
            "title":"Citation ID",
            "description":"The unique identifier of the case citation.",
            "type":"string",
            "maxLength":50
        },
        "CitationKey":{
            "description":"The unique identifier of the case citation.",
            "type":"integer",
            "format":"int64"
        },
        "CitationPuid":{
            "description":"The public unique identifier of the migrated citation record.",
            "type":"string",
            "maxLength":480
        },
        "CodeViolation":{
            "description":"Indicates the total number of code violations linked to the citation.",
            "type":"string"
        },
        "Comments":{
            "title":"Comments",
            "description":"The comments entered for the case citation.",
            "type":"string",
            "maxLength":1000
        },
        "CreatedByName":{
            "title":"Created By",
            "description":"The name of the user who created the row.",
            "type":"string"
        },
        "CreationDate":{
            "title":"Creation Date",
            "description":"The date and time when the row was created.",
            "type":"string",
            "format":"date-time"
        },
        "Description":{
            "title":"Description",
            "description":"The description of the case citation.",
            "type":"string",
            "maxLength":1000
        },
        "DueDate":{
            "title":"Due Date",
            "description":"The due date for the case citation.",
            "type":"string",
            "format":"date"
        },
        "FeeRecordKey":{
            "description":"The unique identifier of the case fee record for the case citation.",
            "type":"integer",
            "format":"int64"
        },
        "FeeRecordPuid":{
            "description":"The public unique identifier of the migrated case fee record.",
            "type":"string"
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "description":"The date and time when the row was last updated.",
            "type":"string",
            "format":"date-time"
        },
        "LastUpdatedByName":{
            "title":"Last Updated By",
            "description":"The name of the user who last updated the row.",
            "type":"string"
        },
        "PayCitation":{
            "title":"Citation Payments",
            "description":"The citation payment resource is used to view a citation payment. Case citations are used in Code Enforcement cases.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/publicSectorCitations-PayCitation-item"
            }
        },
        "PaymentDate":{
            "description":"The date when the citation fee was paid.",
            "type":"string",
            "format":"date-time"
        },
        "links":{
            "title":"Items",
            "description":"Link Relations",
            "type":"array",
            "items":{
                "$ref":"#/definitions/link"
            }
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

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

Nested Schema : Citation Payments

Type: array

Title: Citation Payments

The citation payment resource is used to view a citation payment. Case citations are used in Code Enforcement cases.

Show Source

• Array of: object publicSectorCitations-PayCitation-item

{
    "title":"Citation Payments",
    "description":"The citation payment resource is used to view a citation payment. Case citations are used in Code Enforcement cases.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/publicSectorCitations-PayCitation-item"
    }
}

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.

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

Nested Schema : publicSectorCitations-PayCitation-item

Type: object

Show Source

• AgencyId(optional): integer(int32)
  Title: Agency ID

  The agency identifier of the case citation.
• CaseId(optional): string
  Maximum Length: 255

  The unique identifier of the case.
• CaseKey(optional): integer(int64)
  The unique identifier of the case.
• CaseStatus(optional): string
  Maximum Length: 30

  The status of the case associated with the citation.
• CaseSubmitDate(optional): string(date-time)
  The date on which the case was submitted.
• CitationDueDate(optional): string(date)
  Title: Due Date

  The due date of case associated with the citation.
• CitationId(optional): string
  Title: Citation ID

  Maximum Length: 50

  The unique identifier of the case citation.
• CitationKey(optional): integer(int64)
  The unique identifier of the case citation.
• CreationDate(optional): string(date-time)
  Title: Creation Date

  The date and time when the row was created.
• CurrencyCode(optional): string
  Maximum Length: 3

  The currency code of the citation fee amount.
• DueDate(optional): string(date)
  The due date for the case citation.
• FeeRecordKey(optional): integer(int64)
  The unique identifier of the case fee record for the case citation.
• FeeRecords(optional): array Fee Records
  Title: Fee Records

  The fee records resource is used to view fee records associated with a citation.
• FeeStatus(optional): string
  Maximum Length: 15

  The fee status of the case citation.
• IssueSubtype(optional): string
  Maximum Length: 100

  The subtype of the issue that belongs to the case.
• links(optional): array Items
  Title: Items

  Link Relations
• PaymentReferenceId(optional): string
  Maximum Length: 50

  The unique identifier of the payment reference for the paid amount.
• TotalFeeAmount(optional): number
  The total fee amount for the case citation.
• TotalFeeAmountDue(optional): number
  Title: Total Due

  The total fee amount due for the case associated with the citation.
• TotalFeeAmountPaymentInProgress(optional): number
  Title: Payment in Progress

  The total fee amount for the case associated with the citation for which the payment is in progress.

{
    "type":"object",
    "properties":{
        "AgencyId":{
            "title":"Agency ID",
            "description":"The agency identifier of the case citation.",
            "type":"integer",
            "format":"int32"
        },
        "CaseId":{
            "description":"The unique identifier of the case.",
            "type":"string",
            "maxLength":255
        },
        "CaseKey":{
            "description":"The unique identifier of the case.",
            "type":"integer",
            "format":"int64"
        },
        "CaseStatus":{
            "description":"The status of the case associated with the citation.",
            "type":"string",
            "maxLength":30
        },
        "CaseSubmitDate":{
            "description":"The date on which the case was submitted.",
            "type":"string",
            "format":"date-time"
        },
        "CitationDueDate":{
            "title":"Due Date",
            "description":"The due date of case associated with the citation.",
            "type":"string",
            "format":"date"
        },
        "CitationId":{
            "title":"Citation ID",
            "description":"The unique identifier of the case citation.",
            "type":"string",
            "maxLength":50
        },
        "CitationKey":{
            "description":"The unique identifier of the case citation.",
            "type":"integer",
            "format":"int64"
        },
        "CreationDate":{
            "title":"Creation Date",
            "description":"The date and time when the row was created.",
            "type":"string",
            "format":"date-time"
        },
        "CurrencyCode":{
            "description":"The currency code of the citation fee amount.",
            "type":"string",
            "maxLength":3
        },
        "DueDate":{
            "description":"The due date for the case citation.",
            "type":"string",
            "format":"date"
        },
        "FeeRecordKey":{
            "description":"The unique identifier of the case fee record for the case citation.",
            "type":"integer",
            "format":"int64"
        },
        "FeeRecords":{
            "title":"Fee Records",
            "description":"The fee records resource is used to view fee records associated with a citation.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/publicSectorCitations-PayCitation-FeeRecords-item"
            }
        },
        "FeeStatus":{
            "description":"The fee status of the case citation.",
            "type":"string",
            "maxLength":15
        },
        "IssueSubtype":{
            "description":"The subtype of the issue that belongs to the case.",
            "type":"string",
            "maxLength":100
        },
        "PaymentReferenceId":{
            "description":"The unique identifier of the payment reference for the paid amount.",
            "type":"string",
            "maxLength":50
        },
        "TotalFeeAmount":{
            "description":"The total fee amount for the case citation.",
            "type":"number"
        },
        "TotalFeeAmountDue":{
            "title":"Total Due",
            "description":"The total fee amount due for the case associated with the citation.",
            "type":"number"
        },
        "TotalFeeAmountPaymentInProgress":{
            "title":"Payment in Progress",
            "description":"The total fee amount for the case associated with the citation for which the payment is in progress.",
            "type":"number"
        },
        "links":{
            "title":"Items",
            "description":"Link Relations",
            "type":"array",
            "items":{
                "$ref":"#/definitions/link"
            }
        }
    }
}

Nested Schema : Fee Records

Type: array

Title: Fee Records

The fee records resource is used to view fee records associated with a citation.

Show Source

• Array of: object publicSectorCitations-PayCitation-FeeRecords-item

{
    "title":"Fee Records",
    "description":"The fee records resource is used to view fee records associated with a citation.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/publicSectorCitations-PayCitation-FeeRecords-item"
    }
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

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

Nested Schema : publicSectorCitations-PayCitation-FeeRecords-item

Type: object

Show Source

• CitationKey(optional): integer(int64)
  The unique identifier of the case associated with the citation.
• CurrencyCode(optional): string
  Maximum Length: 3

  The currency code of the fee record.
• DueDate(optional): string(date)
  The due date of the fee record.
• FeeAmount(optional): number
  The amount of the fee record.
• FeeQuantity(optional): number
  The quantity of the fee record.
• FeeRecordKey(optional): integer(int64)
  The unique identifier of the fee record.
• FeeStatus(optional): string
  Maximum Length: 15

  The status of the fee record.
• links(optional): array Items
  Title: Items

  Link Relations
• ParentFeeRecordKey(optional): integer(int64)
  The parent fee record identifier of the fee record.

{
    "type":"object",
    "properties":{
        "CitationKey":{
            "description":"The unique identifier of the case associated with the citation.",
            "type":"integer",
            "format":"int64"
        },
        "CurrencyCode":{
            "description":"The currency code of the fee record.",
            "type":"string",
            "maxLength":3
        },
        "DueDate":{
            "description":"The due date of the fee record.",
            "type":"string",
            "format":"date"
        },
        "FeeAmount":{
            "description":"The amount of the fee record.",
            "type":"number"
        },
        "FeeQuantity":{
            "description":"The quantity of the fee record.",
            "type":"number"
        },
        "FeeRecordKey":{
            "description":"The unique identifier of the fee record.",
            "type":"integer",
            "format":"int64"
        },
        "FeeStatus":{
            "description":"The status of the fee record.",
            "type":"string",
            "maxLength":15
        },
        "ParentFeeRecordKey":{
            "description":"The parent fee record identifier of the fee record.",
            "type":"integer",
            "format":"int64"
        },
        "links":{
            "title":"Items",
            "description":"Link Relations",
            "type":"array",
            "items":{
                "$ref":"#/definitions/link"
            }
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

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

Back to Top