Create a receivables credit memo distribution
post
/fscmRestApi/resources/11.13.18.05/receivablesCreditMemos/{CustomerTransactionId}/child/receivablesCreditMemoDistributions
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
-
AccountClass: string
Maximum Length:
255
The account class of the distribution. Valid values are Revenue, Receivable, Freight, and Tax. -
AccountCombination: string
Maximum Length:
255
The account code combination for the distribution. -
AccountedAmount: number
The amount of the distribution in the ledger currency.
-
Amount: number
The amount of the distribution in the credit memo currency.
-
Comments: string
Maximum Length:
240
The user-defined comments about the distribution. -
CreditMemoLineNumber: integer
The number of the credit memo line associated with the distribution.
-
DetailedTaxLineNumber: integer
The number of the tax line of a credit memo line associated with the distribution.
-
DistributionId: integer
(int64)
The unique identifier of the credit memo distribution.
-
Percent: number
The percentage of the line amount mapped to this distribution.
-
receivablesCreditMemoDistributionDFF: array
receivablesCreditMemoDistributionDFF
Nested Schema : schema
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
-
__FLEX_Context_DisplayValue: string
Title:
Context Value
-
CustTrxLineGlDistId: integer
(int64)
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-receivablesCreditMemoDistributions-item-response
Type:
Show Source
object
-
AccountClass: string
Maximum Length:
255
The account class of the distribution. Valid values are Revenue, Receivable, Freight, and Tax. -
AccountCombination: string
Maximum Length:
255
The account code combination for the distribution. -
AccountedAmount: number
The amount of the distribution in the ledger currency.
-
Amount: number
The amount of the distribution in the credit memo currency.
-
Comments: string
Maximum Length:
240
The user-defined comments about the distribution. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Read Only:
true
The date and time when the record was created. -
CreditMemoLineNumber: integer
The number of the credit memo line associated with the distribution.
-
DetailedTaxLineNumber: integer
The number of the tax line of a credit memo line associated with the distribution.
-
DistributionId: integer
(int64)
The unique identifier of the credit memo distribution.
-
LastUpdateDate: string
(date-time)
Read Only:
true
The date and time the record was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Percent: number
The percentage of the line amount mapped to this distribution.
-
receivablesCreditMemoDistributionDFF: array
receivablesCreditMemoDistributionDFF
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.
Nested Schema : receivablesCreditMemos-receivablesCreditMemoDistributions-receivablesCreditMemoDistributionDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
-
__FLEX_Context_DisplayValue: string
Title:
Context Value
-
CustTrxLineGlDistId: integer
(int64)
-
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- receivablesCreditMemoDistributionDFF
-
Parameters:
- CustomerTransactionId:
$request.path.CustomerTransactionId
- DistributionId:
$request.path.DistributionId
- CustomerTransactionId: