Jump to

• Request
• Response

Create a fee item memo line

post

/fscmRestApi/resources/11.13.18.05/publicSectorFeeItemMemoLines

Request

Header Parameters

• Metadata-Context: string
  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: string
  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: string
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

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

  Identifier of classification to which the mapping applies.
• CustCmTrxTypeId: integer (int64)
  Title: Credit Memo Transaction Type

  Unique identifier of the transaction type for credit memo.
• CustCmTrxTypeName: string
  Maximum Length: 20

  Name of the credit memo transaction type.
• CustDmTrxTypeId: integer (int64)
  Title: Debit Memo Transaction Type

  Unique identifier of the transaction type for debit memo.
• CustDmTrxTypeName: string
  Maximum Length: 20

  Name of the debit memo transaction type.
• CustTrxTypeId: integer (int64)
  Title: Invoice Transaction Type

  Unique identifier of the transaction type for invoice.
• CustTrxTypeName: string
  Maximum Length: 20

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

  Maximum Length: 30

  Identifier of fee item to which the mapping applies.
• MemoLineId: integer (int64)
  Unique identifier of memo line that is used to derive the revenue account.
• MemoLineName: string
  Maximum Length: 50

  Name of 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

  Identifier of record type to which the mapping applies.
• SkipInvoiceFlag: string
  Maximum Length: 1

  Default Value: N

  Indicates whether the invoice can be skipped.
• TransactionOrigin: string
  Maximum Length: 30

  Source application that originated the transaction.

{
    "type":"object",
    "properties":{
        "CustTrxTypeId":{
            "title":"Invoice Transaction Type",
            "type":"integer",
            "description":"Unique identifier of the transaction type for invoice.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "TransactionOrigin":{
            "maxLength":30,
            "type":"string",
            "description":"Source application that originated the transaction.",
            "nullable":false
        },
        "CustCmTrxTypeId":{
            "title":"Credit Memo Transaction Type",
            "type":"integer",
            "description":"Unique identifier of the transaction type for credit memo.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "FeeItemId":{
            "title":"Fee Item ID",
            "maxLength":30,
            "type":"string",
            "description":"Identifier of fee item to which the mapping applies.",
            "nullable":false
        },
        "MemoLineName":{
            "maxLength":50,
            "type":"string",
            "description":"Name of memo line that is used to derive the revenue account.",
            "nullable":true
        },
        "CustTrxTypeName":{
            "maxLength":20,
            "type":"string",
            "description":"Name of the invoice transaction type.",
            "nullable":true
        },
        "RecordType":{
            "maxLength":50,
            "type":"string",
            "description":"Identifier of record type to which the mapping applies.",
            "nullable":false
        },
        "SkipInvoiceFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the invoice can be skipped.",
            "nullable":true,
            "default":"N"
        },
        "ReceivableActivityName":{
            "maxLength":50,
            "type":"string",
            "description":"Unique Identifier for Receivable activity name.",
            "nullable":true
        },
        "Classification":{
            "maxLength":3,
            "type":"string",
            "description":"Identifier of classification to which the mapping applies.",
            "nullable":false
        },
        "CustDmTrxTypeId":{
            "title":"Debit Memo Transaction Type",
            "type":"integer",
            "description":"Unique identifier of the transaction type for debit memo.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "CustDmTrxTypeName":{
            "maxLength":20,
            "type":"string",
            "description":"Name of the debit memo transaction type.",
            "nullable":true
        },
        "CustCmTrxTypeName":{
            "maxLength":20,
            "type":"string",
            "description":"Name of the credit memo transaction type.",
            "nullable":true
        },
        "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":"Unique identifier of memo line 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:
  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 : 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.
• AllRecordTypeDescr: string
  Read Only: true

  Maximum Length: 80

  Descriptive value of all the record type mark.
• Classification: string
  Maximum Length: 3

  Identifier of classification to which the mapping applies.
• ClassificationDescr: string
  Read Only: true

  Maximum Length: 80

  Name of the classification to which the mapping is applicable.
• CustCmTrxTypeId: integer (int64)
  Title: Credit Memo Transaction Type

  Unique identifier of the transaction type for credit memo.
• CustCmTrxTypeName: string
  Maximum Length: 20

  Name of the credit memo transaction type.
• CustDmTrxTypeId: integer (int64)
  Title: Debit Memo Transaction Type

  Unique identifier of the transaction type for debit memo.
• CustDmTrxTypeName: string
  Maximum Length: 20

  Name of the debit memo transaction type.
• CustTrxTypeId: integer (int64)
  Title: Invoice Transaction Type

  Unique identifier of the transaction type for invoice.
• CustTrxTypeName: string
  Maximum Length: 20

  Name of the invoice transaction type.
• FeeItemDescr: string
  Read Only: true

  Maximum Length: 50

  Name of the fee item to which the mapping is applicable.
• FeeItemId: string
  Title: Fee Item ID

  Maximum Length: 30

  Identifier of fee item to which the mapping applies.
• IssueSubtypeDescr: string
  Read Only: true

  Maximum Length: 100

  Name of the issue sub type to which the mapping is applicable.
• links: array Links
  Title: Links

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

  Name of 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

  Identifier of record type to which the mapping applies.
• RecordTypeDescr: string
  Read Only: true

  Maximum Length: 100

  Name of the record type to which the mapping is applicable.
• SkipInvoiceFlag: string
  Maximum Length: 1

  Default Value: N

  Indicates whether the invoice can be skipped.
• SkipInvoiceFlagDescr: string
  Title: Skip Invoice Mark

  Read Only: true

  Maximum Length: 80

  Descriptive value of the skip invoice mark.
• TransactionOrigin: string
  Maximum Length: 30

  Source application that originated the transaction.

{
    "type":"object",
    "properties":{
        "ClassificationDescr":{
            "maxLength":80,
            "type":"string",
            "description":"Name of the classification to which the mapping is applicable.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "IssueSubtypeDescr":{
            "maxLength":100,
            "type":"string",
            "description":"Name of the issue sub type to which the mapping is applicable.",
            "nullable":false,
            "readOnly":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
        },
        "CustTrxTypeId":{
            "title":"Invoice Transaction Type",
            "type":"integer",
            "description":"Unique identifier of the transaction type for invoice.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TransactionOrigin":{
            "maxLength":30,
            "type":"string",
            "description":"Source application that originated the transaction.",
            "nullable":false,
            "x-queryable":true
        },
        "SkipInvoiceFlagDescr":{
            "title":"Skip Invoice Mark",
            "maxLength":80,
            "type":"string",
            "description":"Descriptive value of the skip invoice mark.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CustCmTrxTypeId":{
            "title":"Credit Memo Transaction Type",
            "type":"integer",
            "description":"Unique identifier of the transaction type for credit memo.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RecordTypeDescr":{
            "maxLength":100,
            "type":"string",
            "description":"Name of the record type to which the mapping is applicable.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AllRecordTypeDescr":{
            "maxLength":80,
            "type":"string",
            "description":"Descriptive value of all the record type mark.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FeeItemId":{
            "title":"Fee Item ID",
            "maxLength":30,
            "type":"string",
            "description":"Identifier of fee item to which the mapping applies.",
            "nullable":false,
            "x-queryable":true
        },
        "MemoLineName":{
            "maxLength":50,
            "type":"string",
            "description":"Name of memo line that is used to derive the revenue account.",
            "nullable":true,
            "x-queryable":true
        },
        "CustTrxTypeName":{
            "maxLength":20,
            "type":"string",
            "description":"Name of the invoice transaction type.",
            "nullable":true,
            "x-queryable":true
        },
        "RecordType":{
            "maxLength":50,
            "type":"string",
            "description":"Identifier of record type to which the mapping applies.",
            "nullable":false,
            "x-queryable":true
        },
        "SkipInvoiceFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the invoice can be skipped.",
            "nullable":true,
            "default":"N",
            "x-queryable":true
        },
        "ReceivableActivityName":{
            "maxLength":50,
            "type":"string",
            "description":"Unique Identifier for Receivable activity name.",
            "nullable":true,
            "x-queryable":true
        },
        "Classification":{
            "maxLength":3,
            "type":"string",
            "description":"Identifier of classification to which the mapping applies.",
            "nullable":false,
            "x-queryable":true
        },
        "CustDmTrxTypeId":{
            "title":"Debit Memo Transaction Type",
            "type":"integer",
            "description":"Unique identifier of the transaction type for debit memo.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CustDmTrxTypeName":{
            "maxLength":20,
            "type":"string",
            "description":"Name of the debit memo transaction 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"
            }
        },
        "CustCmTrxTypeName":{
            "maxLength":20,
            "type":"string",
            "description":"Name of the credit memo transaction type.",
            "nullable":true,
            "x-queryable":true
        },
        "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
        },
        "FeeItemDescr":{
            "maxLength":50,
            "type":"string",
            "description":"Name of the fee item to which the mapping is applicable.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MemoLineId":{
            "type":"integer",
            "description":"Unique identifier of memo line 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