Create a receivables invoice distribution
post
/fscmRestApi/resources/11.13.18.05/receivablesInvoices/{CustomerTransactionId}/child/receivablesInvoiceDistributions
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
Root Schema : schema
Type:
Show Source
object
-
AccountClass: string
Title:
Account Class
Maximum Length:80
The account class of the distribution. Valid values are Revenue, Receivable, Freight, and Tax. -
AccountCombination: string
Title:
Account Combination
The account code combination for the distribution. -
AccountedAmount: number
Title:
Accounted Amount
The amount of the distribution in the ledger currency. -
Amount: number
Title:
Amount
The amount of the distribution in the invoice currency. -
Comments: string
Title:
Comments
Maximum Length:240
The user-defined comments about the distribution. -
DetailedTaxLineNumber: integer
Title:
Detailed Tax Line Number
The number of the tax line of an invoice line associated with the distribution. -
DistributionId: integer
(int64)
Title:
Distribution ID
The unique identifier of the invoice distribution. -
InvoiceLineNumber: integer
Title:
Invoice Line Number
The number of the invoice line associated with the distribution. -
Percent: number
Title:
Percent
The percentage of the line amount mapped to this distribution. -
receivablesInvoiceDistributionDFF: array
Receivables Invoice Distribution Descriptive Flexfields
Title:
Receivables Invoice Distribution Descriptive Flexfields
The receivables invoice distributions descriptive flexfields resource is used to create and get descriptive flexfield values associated with an invoice distribution.
Nested Schema : Receivables Invoice Distribution Descriptive Flexfields
Type:
array
Title:
Receivables Invoice Distribution Descriptive Flexfields
The receivables invoice distributions descriptive flexfields resource is used to create and get descriptive flexfield values associated with an invoice distribution.
Show Source
Nested Schema : schema
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
The invoice distribution descriptive flexfield context segment. -
__FLEX_Context_DisplayValue: string
Title:
Context Value
The invoice distribution descriptive flexfield context segment displayed value. -
CustTrxLineGlDistId: integer
(int64)
The unique identifier of the invoice distribution.
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 : receivablesInvoices-receivablesInvoiceDistributions-item-response
Type:
Show Source
object
-
AccountClass: string
Title:
Account Class
Maximum Length:80
The account class of the distribution. Valid values are Revenue, Receivable, Freight, and Tax. -
AccountCombination: string
Title:
Account Combination
The account code combination for the distribution. -
AccountedAmount: number
Title:
Accounted Amount
The amount of the distribution in the ledger currency. -
Amount: number
Title:
Amount
The amount of the distribution in the invoice currency. -
Comments: string
Title:
Comments
Maximum Length:240
The user-defined comments about the distribution. -
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 and time the record was created. -
DetailedTaxLineNumber: integer
Title:
Detailed Tax Line Number
The number of the tax line of an invoice line associated with the distribution. -
DistributionId: integer
(int64)
Title:
Distribution ID
The unique identifier of the invoice distribution. -
InvoiceLineNumber: integer
Title:
Invoice Line Number
The number of the invoice line associated with the distribution. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
The date and time the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
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
Title:
Percent
The percentage of the line amount mapped to this distribution. -
receivablesInvoiceDistributionDFF: array
Receivables Invoice Distribution Descriptive Flexfields
Title:
Receivables Invoice Distribution Descriptive Flexfields
The receivables invoice distributions descriptive flexfields resource is used to create and get descriptive flexfield values associated with an invoice distribution.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Receivables Invoice Distribution Descriptive Flexfields
Type:
array
Title:
Receivables Invoice Distribution Descriptive Flexfields
The receivables invoice distributions descriptive flexfields resource is used to create and get descriptive flexfield values associated with an invoice distribution.
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 : receivablesInvoices-receivablesInvoiceDistributions-receivablesInvoiceDistributionDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
The invoice distribution descriptive flexfield context segment. -
__FLEX_Context_DisplayValue: string
Title:
Context Value
The invoice distribution descriptive flexfield context segment displayed value. -
CustTrxLineGlDistId: integer
(int64)
The unique identifier of the invoice distribution.
-
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
- receivablesInvoiceDistributionDFF
-
Parameters:
- CustomerTransactionId:
$request.path.CustomerTransactionId
- DistributionId:
$request.path.DistributionId
The receivables invoice distributions descriptive flexfields resource is used to create and get descriptive flexfield values associated with an invoice distribution. - CustomerTransactionId: