Jump to

• Request
• Response

Update a set of receivable options data

patch

/fscmRestApi/resources/11.13.18.05/publicSectorReceivableOptions/{AgencyId}

Request

Path Parameters

• AgencyId(required): integer(int32)
  The unique identifier of the agency associated with the receivable options.

  Default Value: 1

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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• BuName: string
  Title: Receivables Business Unit

  Maximum Length: 240

  Name of the business unit that is configured to process receivable transactions.
• CustCmTrxTypeId: integer (int64)
  The unique identifier for the Fusion AR transaction type for credit memo.
• CustCmTrxTypeName: string
  Title: Credit Memo Transaction Type

  Maximum Length: 20

  Name of the credit memo transaction type.
• CustDmTrxTypeId: integer (int64)
  Unique identifier of the transaction type for debit memo.
• CustDmTrxTypeName: string
  Title: Debit Memo Transaction Type

  Maximum Length: 20

  Name of the debit memo transaction type.
• CustTrxTypeId: integer (int64)
  The unique identifier for the Fusion AR transaction type for invoice.
• CustTrxTypeName: string
  Title: Invoice Transaction Type

  Maximum Length: 20

  Name of the invoice transaction type.
• DispDupsPubFlag: string
  Maximum Length: 1

  Display potential matches when a public user submits new billing information.
• DispThrsholdPub: integer (int32)
  Title: Public User Display Threshold

  Display potential matches on or above the threshold to public.
• DuplicateCheckOption: string
  Maximum Length: 30

  Configuration to resolve potential matches when agency staff submit new billing information.
• EnabledFlag: string
  Title: Enabled

  Maximum Length: 1

  Indicates whether the ERP Receivables integration is enabled.
• InvoiceCeFlag: string
  Maximum Length: 1

  The invoice code violations mark.
• InvoiceLicFlag: string
  Maximum Length: 1

  The invoice business licenses mark.
• InvoicePaidFeeFlag: string
  Maximum Length: 1

  The invoice paid fee mark.
• InvoicePmtFlag: string
  Maximum Length: 1

  The invoice permits mark.
• InvoicePnzFlag: string
  Maximum Length: 1

  The invoice planning and zoning mark.
• InvoiceSystem: string
  Title: Receivables System

  Maximum Length: 20

  The system that will generate the invoice.
• MemoLineId: integer (int64)
  The unique identifier for the memo line that is used to derive the revenue account.
• MemoLineName: string
  Title: Memo Line Name

  Maximum Length: 50

  Name of the memo line.
• OnaccountReceivableActivity: string
  Title: On Account Receivable Activity Name

  Maximum Length: 50

  The Receivable activity name that is used on receipts created for payments on account.
• OrgId: integer (int64)
  Title: Organization ID

  The unique identifier for the business unit associated with the invoice.
• ProfileClassId: integer (int64)
  Title: Profile Class ID

  The unique identifier for the customer profile class.
• ProfileClassName: string
  Title: Profile Class Name

  Maximum Length: 30

  Name of the customer profile class.
• ReceivableActivityName: string
  Title: Receivable Activity Name

  Maximum Length: 50

  The unique identifier for the receivable activity name.
• RefundReceivableActivity: string
  Title: Refund Receivable Activity

  Maximum Length: 50

  The Receivable activity name that is used on receipts created for refunds.
• SetName: string
  Title: Set Name

  Maximum Length: 80

  Name of the reference data set.
• StartDate: string (date)
  The cutoff date for the Oracle Receivable Receipts ESS job used to filter the payment records.
• TermId: integer (int64)
  The unique identifier for the payment term.
• TermName: string
  Title: Payment Term

  Maximum Length: 15

  Name of the payment term.
• TransactionSourceId: integer (int64)
  Identifier of the transaction source used to create invoices in receivables.
• TransactionSourceName: string
  Title: Transaction Source Name

  Maximum Length: 50

  The transaction source used to create invoices in receivables.

{
    "type":"object",
    "properties":{
        "BuName":{
            "title":"Receivables Business Unit",
            "maxLength":240,
            "type":"string",
            "description":"Name of the business unit that is configured to process receivable transactions.",
            "nullable":true
        },
        "CustCmTrxTypeId":{
            "type":"integer",
            "description":"The unique identifier for the Fusion AR transaction type for credit memo.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "CustCmTrxTypeName":{
            "title":"Credit Memo Transaction Type",
            "maxLength":20,
            "type":"string",
            "description":"Name of the credit memo transaction type.",
            "nullable":true
        },
        "CustDmTrxTypeId":{
            "type":"integer",
            "description":"Unique identifier of the transaction type for debit memo.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "CustDmTrxTypeName":{
            "title":"Debit Memo Transaction Type",
            "maxLength":20,
            "type":"string",
            "description":"Name of the debit memo transaction type.",
            "nullable":true
        },
        "CustTrxTypeId":{
            "type":"integer",
            "description":"The unique identifier for the Fusion AR transaction type for invoice.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "CustTrxTypeName":{
            "title":"Invoice Transaction Type",
            "maxLength":20,
            "type":"string",
            "description":"Name of the invoice transaction type.",
            "nullable":true
        },
        "DispDupsPubFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Display potential matches when a public user submits new billing information.",
            "nullable":false
        },
        "DispThrsholdPub":{
            "title":"Public User Display Threshold",
            "type":"integer",
            "description":"Display potential matches on or above the threshold to public.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":3
            }
        },
        "DuplicateCheckOption":{
            "maxLength":30,
            "type":"string",
            "description":"Configuration to resolve potential matches when agency staff submit new billing information.",
            "nullable":false
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the ERP Receivables integration is enabled.",
            "nullable":false
        },
        "InvoiceCeFlag":{
            "maxLength":1,
            "type":"string",
            "description":"The invoice code violations mark.",
            "nullable":false
        },
        "InvoiceLicFlag":{
            "maxLength":1,
            "type":"string",
            "description":"The invoice business licenses mark.",
            "nullable":false
        },
        "InvoicePaidFeeFlag":{
            "maxLength":1,
            "type":"string",
            "description":"The invoice paid fee mark.",
            "nullable":false
        },
        "InvoicePmtFlag":{
            "maxLength":1,
            "type":"string",
            "description":"The invoice permits mark.",
            "nullable":false
        },
        "InvoicePnzFlag":{
            "maxLength":1,
            "type":"string",
            "description":"The invoice planning and zoning mark.",
            "nullable":false
        },
        "InvoiceSystem":{
            "title":"Receivables System",
            "maxLength":20,
            "type":"string",
            "description":"The system that will generate the invoice.",
            "nullable":false
        },
        "MemoLineId":{
            "type":"integer",
            "description":"The unique identifier for the memo line that is used to derive the revenue account.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "MemoLineName":{
            "title":"Memo Line Name",
            "maxLength":50,
            "type":"string",
            "description":"Name of the memo line.",
            "nullable":true
        },
        "OnaccountReceivableActivity":{
            "title":"On Account Receivable Activity Name",
            "maxLength":50,
            "type":"string",
            "description":"The Receivable activity name that is used on receipts created for payments on account.",
            "nullable":true
        },
        "OrgId":{
            "title":"Organization ID",
            "type":"integer",
            "description":"The unique identifier for the business unit associated with the invoice.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ProfileClassId":{
            "title":"Profile Class ID",
            "type":"integer",
            "description":"The unique identifier for the customer profile class.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ProfileClassName":{
            "title":"Profile Class Name",
            "maxLength":30,
            "type":"string",
            "description":"Name of the customer profile class.",
            "nullable":true
        },
        "ReceivableActivityName":{
            "title":"Receivable Activity Name",
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier for the receivable activity name.",
            "nullable":true
        },
        "RefundReceivableActivity":{
            "title":"Refund Receivable Activity",
            "maxLength":50,
            "type":"string",
            "description":"The Receivable activity name that is used on receipts created for refunds.",
            "nullable":true
        },
        "SetName":{
            "title":"Set Name",
            "maxLength":80,
            "type":"string",
            "description":"Name of the reference data set.",
            "nullable":true
        },
        "StartDate":{
            "type":"string",
            "description":"The cutoff date for the Oracle Receivable Receipts ESS job used to filter the payment records.",
            "format":"date",
            "nullable":true
        },
        "TermId":{
            "type":"integer",
            "description":"The unique identifier for the payment term.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "TermName":{
            "title":"Payment Term",
            "maxLength":15,
            "type":"string",
            "description":"Name of the payment term.",
            "nullable":true
        },
        "TransactionSourceId":{
            "type":"integer",
            "description":"Identifier of the transaction source used to create invoices in receivables.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "TransactionSourceName":{
            "title":"Transaction Source Name",
            "maxLength":50,
            "type":"string",
            "description":"The transaction source used to create invoices in receivables.",
            "nullable":true
        }
    }
}

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

Type: object

Show Source

• AgencyId: integer (int32)
  Read Only: true

  Default Value: 1

  The unique identifier of the agency associated with the receivable options.
• BuName: string
  Title: Receivables Business Unit

  Maximum Length: 240

  Name of the business unit that is configured to process receivable transactions.
• CustCmTrxTypeId: integer (int64)
  The unique identifier for the Fusion AR transaction type for credit memo.
• CustCmTrxTypeName: string
  Title: Credit Memo Transaction Type

  Maximum Length: 20

  Name of the credit memo transaction type.
• CustDmTrxTypeId: integer (int64)
  Unique identifier of the transaction type for debit memo.
• CustDmTrxTypeName: string
  Title: Debit Memo Transaction Type

  Maximum Length: 20

  Name of the debit memo transaction type.
• CustTrxTypeId: integer (int64)
  The unique identifier for the Fusion AR transaction type for invoice.
• CustTrxTypeName: string
  Title: Invoice Transaction Type

  Maximum Length: 20

  Name of the invoice transaction type.
• DispDupsPubFlag: string
  Maximum Length: 1

  Display potential matches when a public user submits new billing information.
• DispDupsPubFlagDescr: string
  Title: Display Duplicates Public User Mark

  Read Only: true

  Maximum Length: 80

  Describes the display duplicates to public mark.
• DispThrsholdPub: integer (int32)
  Title: Public User Display Threshold

  Display potential matches on or above the threshold to public.
• DuplicateCheckOption: string
  Maximum Length: 30

  Configuration to resolve potential matches when agency staff submit new billing information.
• DuplicateCheckOptionDescr: string
  Title: Duplicate Check Option

  Read Only: true

  Maximum Length: 80

  Describe the duplicate check option.
• EnabledFlag: string
  Title: Enabled

  Maximum Length: 1

  Indicates whether the ERP Receivables integration is enabled.
• InvoiceCeFlag: string
  Maximum Length: 1

  The invoice code violations mark.
• InvoiceCeFlagDescr: string
  Title: Invoice Code Violation Fees Mark

  Read Only: true

  Maximum Length: 80

  Describes the invoice code violations mark.
• InvoiceLicFlag: string
  Maximum Length: 1

  The invoice business licenses mark.
• InvoiceLicFlagDescr: string
  Title: Invoice Business License Fees Mark

  Read Only: true

  Maximum Length: 80

  Describes the invoice business licenses mark.
• InvoicePaidFeeFlag: string
  Maximum Length: 1

  The invoice paid fee mark.
• InvoicePaidFeeFlagDescr: string
  Title: Invoice Paid Fee Mark

  Read Only: true

  Maximum Length: 80

  Describes the invoice paid fee mark.
• InvoicePermitFlagDescr: string
  Title: Invoice Permit Fee Mark

  Read Only: true

  Maximum Length: 80

  Describes the invoice permits mark.
• InvoicePmtFlag: string
  Maximum Length: 1

  The invoice permits mark.
• InvoicePnzFlag: string
  Maximum Length: 1

  The invoice planning and zoning mark.
• InvoicePnzFlagDescr: string
  Title: Invoice Planning and Zoning Fees Mark

  Read Only: true

  Maximum Length: 80

  Describes the invoice planning and zoning mark.
• InvoiceSystem: string
  Title: Receivables System

  Maximum Length: 20

  The system that will generate the invoice.
• InvoiceSystemDescr: string
  Read Only: true

  Maximum Length: 80

  Describes the invoice system.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MemoLineId: integer (int64)
  The unique identifier for the memo line that is used to derive the revenue account.
• MemoLineName: string
  Title: Memo Line Name

  Maximum Length: 50

  Name of the memo line.
• OnaccountReceivableActivity: string
  Title: On Account Receivable Activity Name

  Maximum Length: 50

  The Receivable activity name that is used on receipts created for payments on account.
• OrgId: integer (int64)
  Title: Organization ID

  The unique identifier for the business unit associated with the invoice.
• ProfileClassId: integer (int64)
  Title: Profile Class ID

  The unique identifier for the customer profile class.
• ProfileClassName: string
  Title: Profile Class Name

  Maximum Length: 30

  Name of the customer profile class.
• ReceivableActivityName: string
  Title: Receivable Activity Name

  Maximum Length: 50

  The unique identifier for the receivable activity name.
• RefundReceivableActivity: string
  Title: Refund Receivable Activity

  Maximum Length: 50

  The Receivable activity name that is used on receipts created for refunds.
• SetName: string
  Title: Set Name

  Maximum Length: 80

  Name of the reference data set.
• StartDate: string (date)
  The cutoff date for the Oracle Receivable Receipts ESS job used to filter the payment records.
• TermId: integer (int64)
  The unique identifier for the payment term.
• TermName: string
  Title: Payment Term

  Maximum Length: 15

  Name of the payment term.
• TransactionSourceId: integer (int64)
  Identifier of the transaction source used to create invoices in receivables.
• TransactionSourceName: string
  Title: Transaction Source Name

  Maximum Length: 50

  The transaction source used to create invoices in receivables.

{
    "type":"object",
    "properties":{
        "AgencyId":{
            "type":"integer",
            "description":"The unique identifier of the agency associated with the receivable options.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "default":1,
            "x-hints":{
                "precision":8
            },
            "x-queryable":true
        },
        "BuName":{
            "title":"Receivables Business Unit",
            "maxLength":240,
            "type":"string",
            "description":"Name of the business unit that is configured to process receivable transactions.",
            "nullable":true,
            "x-queryable":true
        },
        "CustCmTrxTypeId":{
            "type":"integer",
            "description":"The unique identifier for the Fusion AR transaction type for credit memo.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CustCmTrxTypeName":{
            "title":"Credit Memo Transaction Type",
            "maxLength":20,
            "type":"string",
            "description":"Name of the credit memo transaction type.",
            "nullable":true,
            "x-queryable":true
        },
        "CustDmTrxTypeId":{
            "type":"integer",
            "description":"Unique identifier of the transaction type for debit memo.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CustDmTrxTypeName":{
            "title":"Debit Memo Transaction Type",
            "maxLength":20,
            "type":"string",
            "description":"Name of the debit memo transaction type.",
            "nullable":true,
            "x-queryable":true
        },
        "CustTrxTypeId":{
            "type":"integer",
            "description":"The unique identifier for the Fusion AR transaction type for invoice.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CustTrxTypeName":{
            "title":"Invoice Transaction Type",
            "maxLength":20,
            "type":"string",
            "description":"Name of the invoice transaction type.",
            "nullable":true,
            "x-queryable":true
        },
        "DispDupsPubFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Display potential matches when a public user submits new billing information.",
            "nullable":false,
            "x-queryable":true
        },
        "DispDupsPubFlagDescr":{
            "title":"Display Duplicates Public User Mark",
            "maxLength":80,
            "type":"string",
            "description":"Describes the display duplicates to public mark.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DispThrsholdPub":{
            "title":"Public User Display Threshold",
            "type":"integer",
            "description":"Display potential matches on or above the threshold to public.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":3
            },
            "x-queryable":true
        },
        "DuplicateCheckOption":{
            "maxLength":30,
            "type":"string",
            "description":"Configuration to resolve potential matches when agency staff submit new billing information.",
            "nullable":false,
            "x-queryable":true
        },
        "DuplicateCheckOptionDescr":{
            "title":"Duplicate Check Option",
            "maxLength":80,
            "type":"string",
            "description":"Describe the duplicate check option.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the ERP Receivables integration is enabled.",
            "nullable":false,
            "x-queryable":true
        },
        "InvoiceCeFlag":{
            "maxLength":1,
            "type":"string",
            "description":"The invoice code violations mark.",
            "nullable":false,
            "x-queryable":true
        },
        "InvoiceCeFlagDescr":{
            "title":"Invoice Code Violation Fees Mark",
            "maxLength":80,
            "type":"string",
            "description":"Describes the invoice code violations mark.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "InvoiceLicFlag":{
            "maxLength":1,
            "type":"string",
            "description":"The invoice business licenses mark.",
            "nullable":false,
            "x-queryable":true
        },
        "InvoiceLicFlagDescr":{
            "title":"Invoice Business License Fees Mark",
            "maxLength":80,
            "type":"string",
            "description":"Describes the invoice business licenses mark.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "InvoicePaidFeeFlag":{
            "maxLength":1,
            "type":"string",
            "description":"The invoice paid fee mark.",
            "nullable":false,
            "x-queryable":true
        },
        "InvoicePaidFeeFlagDescr":{
            "title":"Invoice Paid Fee Mark",
            "maxLength":80,
            "type":"string",
            "description":"Describes the invoice paid fee mark.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "InvoicePermitFlagDescr":{
            "title":"Invoice Permit Fee Mark",
            "maxLength":80,
            "type":"string",
            "description":"Describes the invoice permits mark.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "InvoicePmtFlag":{
            "maxLength":1,
            "type":"string",
            "description":"The invoice permits mark.",
            "nullable":false,
            "x-queryable":true
        },
        "InvoicePnzFlag":{
            "maxLength":1,
            "type":"string",
            "description":"The invoice planning and zoning mark.",
            "nullable":false,
            "x-queryable":true
        },
        "InvoicePnzFlagDescr":{
            "title":"Invoice Planning and Zoning Fees Mark",
            "maxLength":80,
            "type":"string",
            "description":"Describes the invoice planning and zoning mark.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "InvoiceSystem":{
            "title":"Receivables System",
            "maxLength":20,
            "type":"string",
            "description":"The system that will generate the invoice.",
            "nullable":false,
            "x-queryable":true
        },
        "InvoiceSystemDescr":{
            "maxLength":80,
            "type":"string",
            "description":"Describes the invoice system.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MemoLineId":{
            "type":"integer",
            "description":"The unique identifier for the memo line that is used to derive the revenue account.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "MemoLineName":{
            "title":"Memo Line Name",
            "maxLength":50,
            "type":"string",
            "description":"Name of the memo line.",
            "nullable":true,
            "x-queryable":true
        },
        "OnaccountReceivableActivity":{
            "title":"On Account Receivable Activity Name",
            "maxLength":50,
            "type":"string",
            "description":"The Receivable activity name that is used on receipts created for payments on account.",
            "nullable":true,
            "x-queryable":true
        },
        "OrgId":{
            "title":"Organization ID",
            "type":"integer",
            "description":"The unique identifier for the business unit associated with the invoice.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ProfileClassId":{
            "title":"Profile Class ID",
            "type":"integer",
            "description":"The unique identifier for the customer profile class.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ProfileClassName":{
            "title":"Profile Class Name",
            "maxLength":30,
            "type":"string",
            "description":"Name of the customer profile class.",
            "nullable":true,
            "x-queryable":true
        },
        "ReceivableActivityName":{
            "title":"Receivable Activity Name",
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier for the receivable activity name.",
            "nullable":true,
            "x-queryable":true
        },
        "RefundReceivableActivity":{
            "title":"Refund Receivable Activity",
            "maxLength":50,
            "type":"string",
            "description":"The Receivable activity name that is used on receipts created for refunds.",
            "nullable":true,
            "x-queryable":true
        },
        "SetName":{
            "title":"Set Name",
            "maxLength":80,
            "type":"string",
            "description":"Name of the reference data set.",
            "nullable":true,
            "x-queryable":true
        },
        "StartDate":{
            "type":"string",
            "description":"The cutoff date for the Oracle Receivable Receipts ESS job used to filter the payment records.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "TermId":{
            "type":"integer",
            "description":"The unique identifier for the payment term.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TermName":{
            "title":"Payment Term",
            "maxLength":15,
            "type":"string",
            "description":"Name of the payment term.",
            "nullable":true,
            "x-queryable":true
        },
        "TransactionSourceId":{
            "type":"integer",
            "description":"Identifier of the transaction source used to create invoices in receivables.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TransactionSourceName":{
            "title":"Transaction Source Name",
            "maxLength":50,
            "type":"string",
            "description":"The transaction source used to create invoices in receivables.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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