Name of the demand source.
get
/fscmRestApi/resources/11.13.18.05/intrastatTransactions
Request
Query Parameters
-
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
finder: string
Used as a predefined finder to search the collection.
Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables- PrimaryKey Name of the demand source.
Finder Variables- MovementId; integer; Name of the demand source.
- PrimaryKey Name of the demand source.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- AdjustedStatisticalValue; number; Name of the demand source.
- AffiliationReferenceCode; string; Name of the demand source.
- AlternateQuantity; number; Name of the demand source.
- AlternateUOM; string; Name of the demand source.
- AlternateUOMCode; string; Name of the demand source.
- AutomaticCreation; string; Name of the demand source.
- CSACode; string; Name of the demand source.
- CategoryId; integer; Name of the demand source.
- CategorySetId; integer; Name of the demand source.
- Comments; string; Name of the demand source.
- CommodityCode; string; Name of the demand source.
- CommodityDescription; string; Name of the demand source.
- ContainerTypeCode; string; Name of the demand source.
- CurrencyCode; string; Name of the demand source.
- CurrencyConversionDate; string; Name of the demand source.
- CurrencyConversionRate; number; Name of the demand source.
- CurrencyConversionType; string; Name of the demand source.
- DeliveryTermsCode; string; Name of the demand source.
- DestinationPostalCode; string; Name of the demand source.
- DestinationRegionCode; string; Name of the demand source.
- DestinationTerritory; string; Name of the demand source.
- DestinationTerritoryCode; string; Name of the demand source.
- DispatchTerritory; string; Name of the demand source.
- DispatchTerritoryCode; string; Name of the demand source.
- DocumentLineNumber; string; Name of the demand source.
- DocumentNumber; string; Name of the demand source.
- DocumentSourceType; string; Name of the demand source.
- DocumentUnitPrice; number; Name of the demand source.
- EstablishmentId; integer; Name of the demand source.
- ExceptionsCount; integer; Name of the demand source.
- FiscalRegimeCode; string; Name of the demand source.
- FlowIndicatorCode; string; Name of the demand source.
- FreightCharges; number; Name of the demand source.
- FreightFactor; number; Name of the demand source.
- FromOrganizationId; integer; Name of the demand source.
- GeographyId; integer; Name of the demand source.
- InventoryItemId; integer; Name of the demand source.
- InvoiceBatchId; integer; Name of the demand source.
- InvoiceBatchName; string; Name of the demand source.
- InvoiceCurrencyCode; string; Name of the demand source.
- InvoiceDateReference; string; Name of the demand source.
- InvoiceId; integer; Name of the demand source.
- InvoiceLineId; integer; Name of the demand source.
- InvoiceLineNumber; string; Name of the demand source.
- InvoiceNeeded; string; Name of the demand source.
- InvoiceNumber; string; Name of the demand source.
- InvoiceQuantity; number; Name of the demand source.
- InvoiceQuantityUOM; string; Name of the demand source.
- InvoiceQuantityUOMCode; string; Name of the demand source.
- InvoiceUnitPrice; number; Name of the demand source.
- InvoiceValue; number; Name of the demand source.
- InvoiceValueInReportingCurrency; number; Name of the demand source.
- ItemCode; string; Name of the demand source.
- ItemCost; number; Name of the demand source.
- ItemDescription; string; Name of the demand source.
- LegalEntityId; integer; Name of the demand source.
- LegalEntityName; string; Name of the demand source.
- LruName; string; Name of the demand source.
- MovementId; integer; Name of the demand source.
- MovementStatus; string; Name of the demand source.
- MovementStatusMeaning; string; Name of the demand source.
- MovementType; string; Name of the demand source.
- ObjectVersionNumber; integer; Name of the demand source.
- OilReferenceCode; string; Name of the demand source.
- OrganizationId; integer; Name of the demand source.
- OriginPostalCode; string; Name of the demand source.
- OriginRegionCode; string; Name of the demand source.
- OriginTerritory; string; Name of the demand source.
- OriginTerritoryCode; string; Name of the demand source.
- OriginalTransactionDate; string; Name of the demand source.
- OutsideProcessValue; number; Name of the demand source.
- ParentMovementId; integer; Name of the demand source.
- PeriodName; string; Name of the demand source.
- Port; string; Name of the demand source.
- PreferenceCode; string; Name of the demand source.
- ReportDate; string; Name of the demand source.
- ReportReference; string; Name of the demand source.
- ReportingCurrencyCode; string; Name of the demand source.
- SetOfBooksPeriod; string; Name of the demand source.
- StatisticalCode; string; Name of the demand source.
- StatisticalValue; number; Name of the demand source.
- SupplyReferenceCode; string; Name of the demand source.
- TaricCode; string; Name of the demand source.
- TerritoryCode; string; Name of the demand source.
- TerritoryName; string; Name of the demand source.
- ToLocationId; number; Name of the demand source.
- ToOrganizationId; integer; Name of the demand source.
- TotalWeight; number; Name of the demand source.
- TotalWeightUOM; string; Name of the demand source.
- TotalWeightUOMCode; string; Name of the demand source.
- TradingPartnerId; integer; Name of the demand source.
- TradingPartnerName; string; Name of the demand source.
- TradingPartnerNumber; string; Name of the demand source.
- TradingPartnerPartyId; number; Name of the demand source.
- TradingPartnerSiteId; integer; Name of the demand source.
- TradingPartnerSiteName; string; Name of the demand source.
- TradingPartnerSitePartyId; string; Name of the demand source.
- TradingPartnerType; string; Name of the demand source.
- TradingPartnerTypeMeaning; string; Name of the demand source.
- TradingPartnerVATNumber; string; Name of the demand source.
- TransactionDate; string; Name of the demand source.
- TransactionDateHigh; string; Name of the demand source.
- TransactionDateLow; string; Name of the demand source.
- TransactionNatureCode; string; Name of the demand source.
- TransactionQuantity; number; Name of the demand source.
- TransactionQuantityUOM; string; Name of the demand source.
- TransactionQuantityUOMCode; string; Name of the demand source.
- TransactionValue; number; Name of the demand source.
- TransportModeCode; string; Name of the demand source.
- TransportModeDescription; string; Name of the demand source.
- TriangulationCountry; string; Name of the demand source.
- TriangulationCountryCode; string; Name of the demand source.
- UnitWeight; number; Name of the demand source.
- VATRegistrationNumber; string; Name of the demand source.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
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.
There's no request body for this operation.
Back to TopResponse
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 : intrastatTransactions
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : intrastatTransactions-item-response
Type:
Show Source
object
-
AdjustedStatisticalValue: number
Title:
Adjusted Statistical Value
Name of the demand source. -
AffiliationReferenceCode: string
Title:
Affiliation Reference
Maximum Length:30
Name of the demand source. -
AlternateQuantity: number
Title:
Supplementary Quantity
Name of the demand source. -
AlternateUOM: string
Read Only:
true
Maximum Length:255
Name of the demand source. -
AlternateUOMCode: string
Title:
Supplementary UOM
Maximum Length:3
Name of the demand source. -
AutomaticCreation: string
Maximum Length:
1
Name of the demand source. -
CategoryId: integer
Name of the demand source.
-
CategorySetId: integer
Name of the demand source.
-
Comments: string
Title:
Comments
Maximum Length:240
Name of the demand source. -
CommodityCode: string
Title:
Commodity Code
Maximum Length:240
Name of the demand source. -
CommodityDescription: string
Title:
Commodity Description
Read Only:true
Maximum Length:240
Name of the demand source. -
ContainerTypeCode: string
Title:
Transport Container
Maximum Length:30
Name of the demand source. -
CSACode: string
Maximum Length:
30
Name of the demand source. -
CurrencyCode: string
Maximum Length:
15
Name of the demand source. -
CurrencyConversionDate: string
(date)
Name of the demand source.
-
CurrencyConversionRate: number
Name of the demand source.
-
CurrencyConversionType: string
Maximum Length:
30
Name of the demand source. -
DeliveryTermsCode: string
Title:
Freight Terms
Maximum Length:30
Name of the demand source. -
DestinationPostalCode: string
Title:
Destination Postal Code
Read Only:true
Maximum Length:60
Name of the demand source. -
DestinationRegionCode: string
Title:
Destination Region
Maximum Length:30
Name of the demand source. -
DestinationTerritory: string
Read Only:
true
Maximum Length:255
Name of the demand source. -
DestinationTerritoryCode: string
Title:
Destination Country
Maximum Length:2
Name of the demand source. -
DispatchTerritory: string
Read Only:
true
Maximum Length:255
Name of the demand source. -
DispatchTerritoryCode: string
Title:
Country of Supply
Maximum Length:2
Name of the demand source. -
DocumentLineNumber: string
Title:
Document Line Number
Maximum Length:20
Name of the demand source. -
DocumentNumber: string
Title:
Document Number
Maximum Length:30
Name of the demand source. -
DocumentSourceType: string
Title:
Source Transaction
Maximum Length:30
Name of the demand source. -
DocumentSourceTypeMeaning: string
Read Only:
true
Maximum Length:255
Name of the demand source. -
DocumentUnitPrice: number
Title:
Unit Price
Name of the demand source. -
EstablishmentId: integer
Title:
Legal Reporting Unit
Name of the demand source. -
ExceptionsCount: integer
Name of the demand source.
-
FiscalRegimeCode: string
Title:
Fiscal Regime
Maximum Length:10
Name of the demand source. -
FlowIndicatorCode: string
Title:
Flow Indicator
Maximum Length:30
Name of the demand source. -
FreightCharges: number
Name of the demand source.
-
FreightFactor: number
Title:
Freight Factor
Name of the demand source. -
FromOrganizationId: integer
Name of the demand source.
-
GeographyId: integer
Title:
Economic Zone
Name of the demand source. -
InventoryItemId: integer
Name of the demand source.
-
InvoiceBatchId: integer
Name of the demand source.
-
InvoiceBatchName: string
Title:
Invoice Batch
Maximum Length:50
Name of the demand source. -
InvoiceCurrencyCode: string
Maximum Length:
15
Name of the demand source. -
InvoiceDateReference: string
(date)
Title:
Invoice Date
Name of the demand source. -
InvoiceId: integer
Name of the demand source.
-
InvoiceLineId: integer
Name of the demand source.
-
InvoiceLineNumber: string
Title:
Invoice Line
Maximum Length:30
Name of the demand source. -
InvoiceNeeded: string
Maximum Length:
1
Name of the demand source. -
InvoiceNumber: string
Title:
Invoice
Maximum Length:50
Name of the demand source. -
InvoiceQuantity: number
Title:
Invoice Quantity
Name of the demand source. -
InvoiceQuantityUOM: string
Read Only:
true
Maximum Length:255
Name of the demand source. -
InvoiceQuantityUOMCode: string
Maximum Length:
3
Name of the demand source. -
InvoiceUnitPrice: number
Title:
Unit Price
Name of the demand source. -
InvoiceValue: number
Title:
Invoice Value
Name of the demand source. -
InvoiceValueInReportingCurrency: number
Name of the demand source.
-
ItemCode: string
Maximum Length:
300
Name of the demand source. -
ItemCost: number
Name of the demand source.
-
ItemDescription: string
Maximum Length:
240
Name of the demand source. -
ItemUnitWeight: number
Name of the demand source.
-
ItemWeightUOMCode: string
Name of the demand source.
-
JmfInExceptions: array
Inventory Reservation Details
Title:
Inventory Reservation Details
Name of the demand source. -
LegalEntityId: integer
Name of the demand source.
-
LegalEntityName: string
Maximum Length:
255
Name of the demand source. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LruName: string
Title:
Legal Reporting Unit
Maximum Length:240
Name of the demand source. -
MovementId: integer
Title:
Transaction
Name of the demand source. -
MovementStatus: string
Title:
Transaction Status
Maximum Length:1
Default Value:O
Name of the demand source. -
MovementStatusMeaning: string
Maximum Length:
255
Name of the demand source. -
MovementType: string
Title:
Flow Type
Maximum Length:3
Name of the demand source. -
MovementTypeMeaning: string
Maximum Length:
255
Name of the demand source. -
ObjectVersionNumber: integer
(int32)
Name of the demand source.
-
OilReferenceCode: string
Title:
Mineral Oil Reference
Maximum Length:30
Name of the demand source. -
OrganizationId: integer
Name of the demand source.
-
OrganizationName: string
Name of the demand source.
-
OriginalTransactionDate: string
(date)
Name of the demand source.
-
OriginPostalCode: string
Title:
Origin Postal Code
Read Only:true
Maximum Length:60
Name of the demand source. -
OriginRegionCode: string
Title:
Region of Origin
Maximum Length:30
Name of the demand source. -
OriginTerritory: string
Read Only:
true
Maximum Length:255
Name of the demand source. -
OriginTerritoryCode: string
Title:
Country of Origin
Maximum Length:2
Name of the demand source. -
OutsideProcessValue: number
Name of the demand source.
-
ParentMovementId: integer
Title:
Original Transaction
Name of the demand source. -
PeriodName: string
Title:
Period
Maximum Length:15
Name of the demand source. -
Port: string
Maximum Length:
30
Name of the demand source. -
PreferenceCode: string
Title:
Preference
Maximum Length:30
Name of the demand source. -
ReportDate: string
(date)
Name of the demand source.
-
ReportingCurrencyCode: string
Title:
Reporting Currency
Maximum Length:15
Name of the demand source. -
ReportReference: string
Maximum Length:
200
Name of the demand source. -
SetOfBooksPeriod: string
Title:
Invoice Period
Maximum Length:15
Name of the demand source. -
StatisticalCode: string
Title:
Statistical Procedure
Maximum Length:10
Name of the demand source. -
StatisticalValue: number
Title:
Statistical Value
Name of the demand source. -
Status: string
Read Only:
true
Name of the demand source. -
SupplyReferenceCode: string
Title:
Supply Reference
Maximum Length:30
Name of the demand source. -
SuppUOMText: string
Name of the demand source.
-
TaricCode: string
Title:
TARIC Code
Maximum Length:30
Name of the demand source. -
TerritoryCode: string
Title:
Country
Maximum Length:2
Name of the demand source. -
TerritoryName: string
Title:
Country
Maximum Length:80
Name of the demand source. -
ToLocationId: number
Read Only:
true
Name of the demand source. -
ToOrganizationId: integer
Read Only:
true
Name of the demand source. -
TotalWeight: number
Title:
Net Mass
Name of the demand source. -
TotalWeightUOM: string
Read Only:
true
Maximum Length:255
Name of the demand source. -
TotalWeightUOMCode: string
Title:
Weight UOM
Maximum Length:3
Name of the demand source. -
TradingPartnerId: integer
(int64)
Name of the demand source.
-
TradingPartnerName: string
Title:
Trading Partner
Maximum Length:360
Name of the demand source. -
TradingPartnerNumber: string
Title:
Trading Partner Number
Maximum Length:20
Name of the demand source. -
TradingPartnerPartyId: number
Name of the demand source.
-
TradingPartnerSiteCountry: string
Name of the demand source.
-
TradingPartnerSiteId: integer
(int64)
Name of the demand source.
-
TradingPartnerSiteName: string
Title:
Trading Partner Site
Maximum Length:250
Name of the demand source. -
TradingPartnerSitePartyId: string
Read Only:
true
Maximum Length:20
Name of the demand source. -
TradingPartnerType: string
Title:
Trading Partner Type
Maximum Length:1
Name of the demand source. -
TradingPartnerTypeMeaning: string
Read Only:
true
Maximum Length:255
Name of the demand source. -
TradingPartnerVATNumber: string
Title:
Trading Partner VAT
Maximum Length:150
Name of the demand source. -
TransactionDate: string
(date)
Title:
Transaction Date
Name of the demand source. -
TransactionDateHigh: string
(date)
Title:
Transaction Date
Read Only:true
Name of the demand source. -
TransactionDateLow: string
(date)
Title:
Transaction Date
Read Only:true
Name of the demand source. -
TransactionNatureCode: string
Title:
Nature of Transaction Code
Maximum Length:10
Name of the demand source. -
TransactionQuantity: number
Title:
Quantity
Name of the demand source. -
TransactionQuantityUOM: string
Read Only:
true
Maximum Length:255
Name of the demand source. -
TransactionQuantityUOMCode: string
Maximum Length:
3
Name of the demand source. -
TransactionUOMText: string
Read Only:
true
Name of the demand source. -
TransactionValue: number
Title:
Transaction Amount
Name of the demand source. -
TransportModeCode: string
Maximum Length:
30
Name of the demand source. -
TransportModeDescription: string
Read Only:
true
Maximum Length:240
Name of the demand source. -
TriangulationCountry: string
Read Only:
true
Maximum Length:255
Name of the demand source. -
TriangulationCountryCode: string
Title:
Triangulation Country
Maximum Length:2
Name of the demand source. -
UnitWeight: number
Title:
Unit Weight
Name of the demand source. -
VATRegistrationNumber: string
Title:
VAT Registration
Maximum Length:150
Name of the demand source. -
WeightUOMText: string
Read Only:
true
Name of the demand source.
Nested Schema : Inventory Reservation Details
Type:
array
Title:
Inventory Reservation Details
Name of the demand source.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : intrastatTransactions-JmfInExceptions-item-response
Type:
Show Source
object
-
ErrorDescription: string
Read Only:
true
Maximum Length:250
Name of the demand source. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MovementId: number
Read Only:
true
Name of the demand source.
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
- ignoreResetTransactions
-
Name of the demand source.
- massEditTransactions
-
Name of the demand source.
- massValidateTransactions
- recalculateValues
-
Get one Intrastat parameter