Jump to

• Request
• Response

Create a receivables invoice note

post

/fscmRestApi/resources/11.13.18.05/receivablesInvoices/{CustomerTransactionId}/child/notes

Request

Path Parameters

• CustomerTransactionId(required): integer(int64)
  The unique identifier of the invoice.

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• ContactRelationshipId: integer (int64)
  Title: Contact Relationship ID

  The unique identifier of the relationship populated when the note is associated with a contact.
• CorpCurrencyCode: string
  Title: Corporate Currency Code

  Maximum Length: 15

  The corporate currency code of the note associated with the contact.
• CreatorPartyId: integer (int64)
  Title: Creator Party ID

  The unique identifier of the party who created the note.
• CurcyConvRateType: string
  Title: Currency Conversion Rate Type

  Maximum Length: 30

  The currency conversion rate type associated with the note.
• CurrencyCode: string
  Title: Currency

  Maximum Length: 15

  The currency code associated with the note.
• NoteNumber: string
  Maximum Length: 30

  The alternate unique identifier of the note. A user key that's system generated or from an external system.
• NoteTitle: string
  Title: Title

  Maximum Length: 500

  The title of the note entered by the user.
• NoteTxt: string (byte)
  Title: Note

  The text of the note on the invoice.
• NoteTypeCode: string
  Title: Type

  Maximum Length: 30

  The code for categorization of the note type. A list of valid values is defined in the lookup NoteSourceTypeVA.
• ParentNoteId: integer (int64)
  Title: Parent Note ID

  The unique identifier of the parent note.
• SourceObjectCode: string
  Title: Related Object Type

  Maximum Length: 30

  The code indicating the source object as defined in OBJECTS Metadata. Possible values are Activities, Opportunities, and Sales Business Plan.
• SourceObjectId: string
  Title: Related Object

  Maximum Length: 64

  The unique identifier of the source object as defined in OBJECTS Metadata. Examples are Activities and Opportunities.
• VisibilityCode: string
  Title: Private

  Maximum Length: 30

  Default Value: INTERNAL

  The visibility level of the note, such as Private, Internal, or External. A list of valid values is defined in the lookup NoteVisibilityLookupVA.

{
    "type":"object",
    "properties":{
        "CreatorPartyId":{
            "title":"Creator Party ID",
            "type":"integer",
            "description":"The unique identifier of the party who created the note.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "NoteTypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"The code for categorization of the note type. A list of valid values is defined in the lookup NoteSourceTypeVA.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "SourceObjectCode"
                ]
            }
        },
        "CurcyConvRateType":{
            "title":"Currency Conversion Rate Type",
            "maxLength":30,
            "type":"string",
            "description":"The currency conversion rate type associated with the note.",
            "nullable":true,
            "x-queryable":false
        },
        "VisibilityCode":{
            "title":"Private",
            "maxLength":30,
            "type":"string",
            "description":"The visibility level of the note, such as Private, Internal, or External. A list of valid values is defined in the lookup NoteVisibilityLookupVA.",
            "nullable":false,
            "default":"INTERNAL",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ContactRelationshipId":{
            "title":"Contact Relationship ID",
            "type":"integer",
            "description":"The unique identifier of the relationship populated when the note is associated with a contact.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":15,
            "type":"string",
            "description":"The currency code associated with the note.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "NoteNumber":{
            "maxLength":30,
            "type":"string",
            "description":"The alternate unique identifier of the note. A user key that's system generated or from an external system.",
            "nullable":true
        },
        "SourceObjectId":{
            "title":"Related Object",
            "maxLength":64,
            "type":"string",
            "description":"The unique identifier of the source object as defined in OBJECTS Metadata. Examples are Activities and Opportunities.",
            "nullable":false
        },
        "SourceObjectCode":{
            "title":"Related Object Type",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the source object as defined in OBJECTS Metadata. Possible values are Activities, Opportunities, and Sales Business Plan.",
            "nullable":false
        },
        "ParentNoteId":{
            "title":"Parent Note ID",
            "type":"integer",
            "description":"The unique identifier of the parent note.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "CorpCurrencyCode":{
            "title":"Corporate Currency Code",
            "maxLength":15,
            "type":"string",
            "description":"The corporate currency code of the note associated with the contact.",
            "nullable":true,
            "x-queryable":false
        },
        "NoteTxt":{
            "title":"Note",
            "type":"string",
            "description":"The text of the note on the invoice.",
            "format":"byte",
            "nullable":false,
            "x-hints":{
                "protectionKey":"NoteEO.NoteTxt",
                "protectionObjectTitle":"Note",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Note Text"
            }
        },
        "NoteTitle":{
            "title":"Title",
            "maxLength":500,
            "type":"string",
            "description":"The title of the note entered by the user.",
            "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 : receivablesInvoices-notes-item-response

Type: object

Show Source

• ContactRelationshipId: integer (int64)
  Title: Contact Relationship ID

  The unique identifier of the relationship populated when the note is associated with a contact.
• CorpCurrencyCode: string
  Title: Corporate Currency Code

  Maximum Length: 15

  The corporate currency code of the note associated with the contact.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

  The date when the note was created.
• CreatorPartyId: integer (int64)
  Title: Creator Party ID

  The unique identifier of the party who created the note.
• CurcyConvRateType: string
  Title: Currency Conversion Rate Type

  Maximum Length: 30

  The currency conversion rate type associated with the note.
• CurrencyCode: string
  Title: Currency

  Maximum Length: 15

  The currency code associated with the note.
• DeleteFlag: boolean
  Title: Delete Indicator

  Read Only: true

  The option used to indicate whether the note can be deleted.
• EmailAddress: string
  Read Only: true

  Maximum Length: 320

  The email address of the user who created the note.
• FormattedAddress: string
  Read Only: true

  The address of the user who created the note.
• FormattedPhoneNumber: string
  Read Only: true

  The phone number of the user who created the note.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  The date when the note was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the note.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the note.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• NoteId: integer (int64)
  Title: Note ID

  Read Only: true

  The unique identifier of the note.
• NoteNumber: string
  Maximum Length: 30

  The alternate unique identifier of the note. A user key that's system generated or from an external system.
• NoteTitle: string
  Title: Title

  Maximum Length: 500

  The title of the note entered by the user.
• NoteTxt: string (byte)
  Title: Note

  The text of the note on the invoice.
• NoteTypeCode: string
  Title: Type

  Maximum Length: 30

  The code for categorization of the note type. A list of valid values is defined in the lookup NoteSourceTypeVA.
• ParentNoteId: integer (int64)
  Title: Parent Note ID

  The unique identifier of the parent note.
• PartyId: integer (int64)
  Read Only: true

  The unique identifier of the party associated with the note.
• PartyName: string
  Title: Author

  Read Only: true

  Maximum Length: 360

  The name of the party associated with the note on the invoice.
• SourceObjectCode: string
  Title: Related Object Type

  Maximum Length: 30

  The code indicating the source object as defined in OBJECTS Metadata. Possible values are Activities, Opportunities, and Sales Business Plan.
• SourceObjectId: string
  Title: Related Object

  Maximum Length: 64

  The unique identifier of the source object as defined in OBJECTS Metadata. Examples are Activities and Opportunities.
• UpdateFlag: boolean
  Title: Update Indicator

  Read Only: true

  The option used to indicate whether the note can be updated.
• VisibilityCode: string
  Title: Private

  Maximum Length: 30

  Default Value: INTERNAL

  The visibility level of the note, such as Private, Internal, or External. A list of valid values is defined in the lookup NoteVisibilityLookupVA.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the note was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PartyName":{
            "title":"Author",
            "maxLength":360,
            "type":"string",
            "description":"The name of the party associated with the note on the invoice.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurcyConvRateType":{
            "title":"Currency Conversion Rate Type",
            "maxLength":30,
            "type":"string",
            "description":"The currency conversion rate type associated with the note.",
            "nullable":true,
            "x-queryable":false
        },
        "VisibilityCode":{
            "title":"Private",
            "maxLength":30,
            "type":"string",
            "description":"The visibility level of the note, such as Private, Internal, or External. A list of valid values is defined in the lookup NoteVisibilityLookupVA.",
            "nullable":false,
            "default":"INTERNAL",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ContactRelationshipId":{
            "title":"Contact Relationship ID",
            "type":"integer",
            "description":"The unique identifier of the relationship populated when the note is associated with a contact.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":15,
            "type":"string",
            "description":"The currency code associated with the note.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "UpdateFlag":{
            "title":"Update Indicator",
            "type":"boolean",
            "description":"The option used to indicate whether the note can be updated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "NoteNumber":{
            "maxLength":30,
            "type":"string",
            "description":"The alternate unique identifier of the note. A user key that's system generated or from an external system.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceObjectCode":{
            "title":"Related Object Type",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the source object as defined in OBJECTS Metadata. Possible values are Activities, Opportunities, and Sales Business Plan.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "FormattedPhoneNumber":{
            "type":"string",
            "description":"The phone number of the user who created the note.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CorpCurrencyCode":{
            "title":"Corporate Currency Code",
            "maxLength":15,
            "type":"string",
            "description":"The corporate currency code of the note associated with the contact.",
            "nullable":true,
            "x-queryable":false
        },
        "NoteTxt":{
            "title":"Note",
            "type":"string",
            "description":"The text of the note on the invoice.",
            "format":"byte",
            "nullable":false,
            "x-hints":{
                "protectionKey":"NoteEO.NoteTxt",
                "protectionObjectTitle":"Note",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Note Text"
            },
            "x-queryable":true
        },
        "NoteTitle":{
            "title":"Title",
            "maxLength":500,
            "type":"string",
            "description":"The title of the note entered by the user.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the note.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "NoteId":{
            "title":"Note ID",
            "type":"integer",
            "description":"The unique identifier of the note.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the note.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"date"
            },
            "x-queryable":true
        },
        "CreatorPartyId":{
            "title":"Creator Party ID",
            "type":"integer",
            "description":"The unique identifier of the party who created the note.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "FormattedAddress":{
            "type":"string",
            "description":"The address of the user who created the note.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "NoteTypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"The code for categorization of the note type. A list of valid values is defined in the lookup NoteSourceTypeVA.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "SourceObjectCode"
                ]
            },
            "x-queryable":true
        },
        "EmailAddress":{
            "maxLength":320,
            "type":"string",
            "description":"The email address of the user who created the note.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"EmailEO.EmailAddress",
                "protectionObjectTitle":"Email",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Email"
            },
            "x-queryable":true
        },
        "DeleteFlag":{
            "title":"Delete Indicator",
            "type":"boolean",
            "description":"The option used to indicate whether the note can be deleted.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "SourceObjectId":{
            "title":"Related Object",
            "maxLength":64,
            "type":"string",
            "description":"The unique identifier of the source object as defined in OBJECTS Metadata. Examples are Activities and Opportunities.",
            "nullable":false,
            "x-queryable":true
        },
        "PartyId":{
            "type":"integer",
            "description":"The unique identifier of the party associated with the note.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ParentNoteId":{
            "title":"Parent Note ID",
            "type":"integer",
            "description":"The unique identifier of the parent note.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when the note was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the note.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Links

NoteSourceTypeVA

Operation: /crmRestApi/resources/11.13.18.05/noteTypes

Parameters:

• finder: NoteTypeFinder%3BBindSourceObjectCode%3D{SourceObjectCode}

The following properties are defined on the LOV link relation:

• Source Attribute: NoteTypeCode; Target Attribute: MappedLookupCode
• Display Attribute: Meaning

NoteVisibilityLookupVA

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeFinder%3BBindLookupType%3DZMM_NOTE_VISIBILITY

The following properties are defined on the LOV link relation:

• Source Attribute: VisibilityCode; Target Attribute: LookupCode
• Display Attribute: Meaning

RatedCurrenciesVA

Operation: /crmRestApi/resources/11.13.18.05/ratedCurrencies

The following properties are defined on the LOV link relation:

• Source Attribute: CurrencyCode; Target Attribute: CurrencyCode
• Display Attribute: CurrencyCode

Back to Top