Get records of Intrastat transactions.

get

/fscmRestApi/resources/11.13.18.05/intrastatTransactions

Request

Query Parameters
  • 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).
  • 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
  • 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 Finds intrastat transaction by primary key.
      Finder Variables
      • MovementId; integer; Value that uniquely identifies the record by movementId.
  • 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.
  • 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
  • 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.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • 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
  • 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; Value that identifies the adjusted statistical value.
    • AffiliationReferenceCode; string; Value that identifies the affiliation reference code.
    • AlternateQuantity; number; Value that identifies alternate quantity.
    • AlternateUOM; string; Value that identifies the alternate UOM.
    • AlternateUOMCode; string; Value that identifies the alternate UOM code.
    • AutomaticCreation; string; Value that identifies the automatic creation of an Intrastat transaction.
    • CSACode; string; Value that uniquely identifies the classification and description of goods for an Intrastat transaction.
    • CategoryId; integer; Value that uniquely identifies the category.
    • CategorySetId; integer; Value that uniquely identifies the category set.
    • Comments; string; Value that identifies comments.
    • CommodityCode; string; Value that identifies commodity code.
    • CommodityDescription; string; Value that identifies commodity description.
    • ContainerTypeCode; string; Value that identifies container type code.
    • CurrencyCode; string; Value that identifies currency code.
    • CurrencyConversionDate; string; Value that identifies currency conversion date.
    • CurrencyConversionRate; number; Value that identifies currency conversion rate.
    • CurrencyConversionType; string; Value that identifies currency conversion type.
    • DeliveryTermsCode; string; Value that identifies delivery terms code.
    • DestinationPostalCode; string; Value that identifies destination postal code.
    • DestinationRegionCode; string; Value that identifies destination region code.
    • DestinationTerritory; string; Value that identifies destination territory.
    • DestinationTerritoryCode; string; Value that identifies destination territory code.
    • DispatchTerritory; string; Value that identifies dispatch territory.
    • DispatchTerritoryCode; string; Value that identifies dispatch territory code.
    • DocumentLineNumber; string; Value that identifies document line number.
    • DocumentNumber; string; Value that identifies document number.
    • DocumentSourceType; string; Value that identifies document source type.
    • DocumentUnitPrice; number; Value that identifies document unit price
    • EstablishmentId; integer; Value that uniquely identifies establishment identifier.
    • ExceptionsCount; integer; Value that identifies exceptions count
    • FiscalRegimeCode; string; Value that identifies fiscal regime code
    • FlowIndicatorCode; string; Value that identifies flow indicator code
    • FreightCharges; number; Value that identifies freight charges
    • FreightFactor; number; Value that identifies freight factor.
    • FromOrganizationId; integer; Value that uniquely identifies the organization.
    • GeographyId; integer; Value that uniquely identifies the geography.
    • InventoryItemId; integer; Value that uniquely identifies the inventory item.
    • InvoiceBatchId; integer; Value that uniquely identifies the invoice batch.
    • InvoiceBatchName; string; Value that identifies the invoice batch name.
    • InvoiceCurrencyCode; string; Value that identifies the invoice currency code.
    • InvoiceDateReference; string; Value that identifies the invoice date reference.
    • InvoiceId; integer; Value that uniquely identifies the invoice number.
    • InvoiceLineId; integer; Value that uniquely identifies the invoice line.
    • InvoiceLineNumber; string; Value that identifies the invoice line number.
    • InvoiceNeeded; string; Value that identifies if the invoice is needed.
    • InvoiceNumber; string; Value that identifies the invoice number.
    • InvoiceQuantity; number; Value that identifies invoice quantity.
    • InvoiceQuantityUOM; string; Value that identifies invoice quantity UOM.
    • InvoiceQuantityUOMCode; string; Value that identifies invoice quantity UOM code.
    • InvoiceUnitPrice; number; Value that identifies invoice unit price.
    • InvoiceValue; number; Value that identifies invoice value.
    • InvoiceValueInReportingCurrency; number; Value that identifies invoice value in reporting currency.
    • ItemCode; string; Value that identifies the item.
    • ItemCost; number; Value that identifies item cost.
    • ItemDescription; string; Value that identifies item description.
    • LegalEntityId; integer; Value that uniquely identifies the legal entity.
    • LegalEntityName; string; Value that identifies legal entity name.
    • LruName; string; Value that identifies legal reporting unit.
    • MovementId; integer; Value that uniquely identifies the movement number.
    • MovementStatus; string; Value that identifies movement status.
    • MovementStatusMeaning; string; Value that identifies the status for the movement.
    • MovementType; string; Value that identifies movement type.
    • ObjectVersionNumber; integer; Value that identifies the object version number.
    • OilReferenceCode; string; Value that identifies the oil reference code.
    • OrganizationId; integer; Value that uniquely identifies the organization.
    • OriginPostalCode; string; Value that identifies the origin postal code.
    • OriginRegionCode; string; Value that identifies the origin region code.
    • OriginTerritory; string; Value that identifies the origin territory.
    • OriginTerritoryCode; string; Value that identifies the origin territory code.
    • OriginalTransactionDate; string; Value that identifies the original transaction date.
    • OutsideProcessValue; number; Value that identifies the value of the outside process.
    • ParentMovementId; integer; Value that uniquely identifies the parent movement.
    • PeriodName; string; Value that identifies the period name.
    • Port; string; Value that identifies the port.
    • PreferenceCode; string; Value that identifies the preference code.
    • ReportDate; string; Value that identifies the report date.
    • ReportReference; string; Value that identifies the report reference.
    • ReportingCurrencyCode; string; Value that identifies the reporting currency code.
    • SetOfBooksPeriod; string; Value that identifies the period corresponding to a set of book.
    • StatisticalCode; string; Value that identifies the statistical code.
    • StatisticalValue; number; Value that identifies the statistical value.
    • SupplyReferenceCode; string; Value that identifies the supply reference code.
    • TaricCode; string; Value that identifies the TARIC code.
    • TerritoryCode; string; Value that identifies the territory code.
    • TerritoryName; string; Value that identifies the territory name.
    • ToLocationId; number; Value that uniquely identifies the location associated with the destination organization.
    • ToOrganizationId; integer; Value that uniquely identifies the destination organization.
    • TotalWeight; number; Value that identifies the total weight.
    • TotalWeightUOM; string; Value that identifies the total weight UOM.
    • TotalWeightUOMCode; string; Value that identifies total weight UOM code.
    • TradingPartnerId; integer; Value that uniquely identifies the trading partner.
    • TradingPartnerName; string; Value that identifies the trading partner.
    • TradingPartnerNumber; string; Value that identifies the trading partner number.
    • TradingPartnerPartyId; number; Value that uniquely identifies the trading partner party.
    • TradingPartnerSiteId; integer; Value that uniquely identifies trading partner site.
    • TradingPartnerSiteName; string; Value that identifies trading partner site name.
    • TradingPartnerSitePartyId; string; Value that uniquely identifies trading partner site.
    • TradingPartnerType; string; Value that identifies trading partner type.
    • TradingPartnerTypeMeaning; string; Value that identifies the type of trading partner.
    • TradingPartnerVATNumber; string; Value that identifies the trading partner VAT number.
    • TransactionDate; string; Value that identifies the transaction date.
    • TransactionDateHigh; string; Value that identifies the to transaction date to search for Intrastat transactions.
    • TransactionDateLow; string; Value that identifies the from transaction date to search for Intrastat transactions.
    • TransactionNatureCode; string; Value that identifies the nature of transaction code.
    • TransactionQuantity; number; Value that identifies the transaction quantity.
    • TransactionQuantityUOM; string; Value that identifies transaction quantity UOM.
    • TransactionQuantityUOMCode; string; Value that identifies transaction quantity UOM code.
    • TransactionValue; number; Value that identifies the transaction value.
    • TransportModeCode; string; Value that identifies the transport mode.
    • TransportModeDescription; string; Value that identifies the type of transport mode.
    • TriangulationCountry; string; Value that identifies the triangulation country for an Intrastat transaction.
    • TriangulationCountryCode; string; Value that identifies the triangulation country.
    • UnitWeight; number; Value that identifies the unit weight.
    • VATRegistrationNumber; string; Value that identifies the VAT registration number corresponding to a trading partner for an Intrastat transaction.
  • 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
  • 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".
  • 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 Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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 : intrastatTransactions
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : intrastatTransactions-item-response
Type: object
Show Source
Nested Schema : JMF Intrastat Exceptions
Type: array
Title: JMF Intrastat Exceptions
Provides exceptions associated to Intrastat transactions.
Show Source
Nested Schema : intrastatTransactions-JmfInExceptions-item-response
Type: object
Show Source
Back to Top