Create a note
post
/fscmRestApi/resources/11.13.18.05/receivablesCreditMemos/{CustomerTransactionId}/child/notes
Request
Path Parameters
-
CustomerTransactionId(required): integer(int64)
The unique identifier of the credit memo.
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
Root Schema : schema
Type:
Show Source
object
-
ContactRelationshipId: integer
(int64)
Title:
Contact Relationship ID
The relationship ID populated when the note is associated with a contact. -
CorpCurrencyCode: string
Title:
Corporate Currency Code
Maximum Length:15
The corporate currency code for extensibility. -
CreatorPartyId: integer
(int64)
Title:
Creator Party ID
The unique identifier of the party. -
CurcyConvRateType: string
Title:
Currency Conversion Rate Type
Maximum Length:30
The currency conversion rate type for extensibility. -
CurrencyCode: string
Title:
Currency
Maximum Length:15
The currency code for extensibility. -
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 column which stores the actual note text. -
NoteTypeCode: string
Title:
Type
Maximum Length:30
The note type code for categorization of note. -
ParentNoteId: integer
(int64)
Title:
Parent Note ID
The unique identifier of the note. This is the primary key of the notes table. -
SourceObjectCode: string
Title:
Related Object Type
Maximum Length:30
This is the source object code for the source object as defined in OBJECTS Metadata. -
SourceObjectId: string
Title:
Related Object
Maximum Length:64
The unique identifier of the parent source object associated to the note. -
VisibilityCode: string
Title:
Private
Maximum Length:30
Default Value:INTERNAL
The attribute to specify the visibility level of the note. It indicates whether the note is internal, external, or private.
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.
Root Schema : receivablesCreditMemos-notes-item-response
Type:
Show Source
object
-
ContactRelationshipId: integer
(int64)
Title:
Contact Relationship ID
The relationship ID populated when the note is associated with a contact. -
CorpCurrencyCode: string
Title:
Corporate Currency Code
Maximum Length:15
The corporate currency code for extensibility. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the record was created. -
CreatorPartyId: integer
(int64)
Title:
Creator Party ID
The unique identifier of the party. -
CurcyConvRateType: string
Title:
Currency Conversion Rate Type
Maximum Length:30
The currency conversion rate type for extensibility. -
CurrencyCode: string
Title:
Currency
Maximum Length:15
The currency code for extensibility. -
DeleteFlag: boolean
Title:
Delete Indicator
Read Only:true
Indicates whether the user has access to delete the note. -
EmailAddress: string
Title:
Primary Email
Read Only:true
Maximum Length:320
The email address of the user who created the note. -
FormattedAddress: string
Title:
Primary Address
Read Only:true
The address of the user who created the note. -
FormattedPhoneNumber: string
Title:
Primary Phone
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 record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The unique identifier of the note. This is the primary key of the notes table. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login of the user who last updated the record. -
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. This is the primary key of the notes table. -
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 column which stores the actual note text. -
NoteTypeCode: string
Title:
Type
Maximum Length:30
The note type code for categorization of note. -
ParentNoteId: integer
(int64)
Title:
Parent Note ID
The unique identifier of the note. This is the primary key of the notes table. -
PartyId: integer
(int64)
Title:
Party ID
Read Only:true
The unique identifier of the party. -
PartyName: string
Title:
Author
Read Only:true
Maximum Length:360
The name of the party. -
SourceObjectCode: string
Title:
Related Object Type
Maximum Length:30
This is the source object code for the source object as defined in OBJECTS Metadata. -
SourceObjectId: string
Title:
Related Object
Maximum Length:64
The unique identifier of the parent source object associated to the note. -
UpdateFlag: boolean
Title:
Update Indicator
Read Only:true
Indicates whether the user can update the note. -
VisibilityCode: string
Title:
Private
Maximum Length:30
Default Value:INTERNAL
The attribute to specify the visibility level of the note. It indicates whether the note is internal, external, or private.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Links
- NoteSourceTypeVA
-
Operation: /crmRestApi/resources/11.13.18.05/noteTypesParameters:
- finder:
NoteTypeFinder%3BBindSourceObjectCode%3D{SourceObjectCode}
The following properties are defined on the LOV link relation:- Source Attribute: NoteTypeCode; Target Attribute: MappedLookupCode
- Display Attribute: Meaning
- finder:
- NoteVisibilityLookupVA
-
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
- finder:
- RatedCurrenciesVA
-
The following properties are defined on the LOV link relation:
- Source Attribute: CurrencyCode; Target Attribute: CurrencyCode
- Display Attribute: CurrencyCode