Jump to

• Request
• Response

Get a record of Intrastat transactions.

get

/fscmRestApi/resources/11.13.18.05/intrastatTransactions/{MovementId}

Request

Path Parameters

• MovementId(required): integer
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• 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
• 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
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

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 Top

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.

Body ()

Root Schema : intrastatTransactions-item-response

Type: object

Show Source

• AdjustedStatisticalValue: number
  Title: Adjusted Statistical Value

  Value that identifies the adjusted statistical value.
• AffiliationReferenceCode: string
  Title: Affiliation Reference

  Maximum Length: 30

  Value that identifies the affiliation reference code.
• AlternateQuantity: number
  Title: Supplementary Quantity

  Value that identifies alternate quantity.
• AlternateUOM: string
  Read Only: true

  Maximum Length: 255

  Value that identifies the alternate UOM.
• AlternateUOMCode: string
  Title: Supplementary UOM

  Maximum Length: 3

  Value that identifies the alternate UOM code.
• AutomaticCreation: string
  Maximum Length: 1

  Value that identifies the automatic creation of an Intrastat transaction.
• CategoryId: integer
  Value that uniquely identifies the category.
• CategorySetId: integer
  Value that uniquely identifies the category set.
• Comments: string
  Title: Comments

  Maximum Length: 240

  Value that identifies comments.
• CommodityCode: string
  Title: Commodity Code

  Maximum Length: 240

  Value that identifies commodity code.
• CommodityDescription: string
  Title: Commodity Description

  Maximum Length: 240

  Value that identifies commodity description.
• ContainerTypeCode: string
  Title: Transport Container

  Maximum Length: 30

  Value that identifies container type code.
• CSACode: string
  Maximum Length: 30

  Value that uniquely identifies the classification and description of goods for an Intrastat transaction.
• CurrencyCode: string
  Maximum Length: 15

  Value that identifies currency code.
• CurrencyConversionDate: string (date)
  Value that identifies currency conversion date.
• CurrencyConversionRate: number
  Value that identifies currency conversion rate.
• CurrencyConversionType: string
  Maximum Length: 30

  Value that identifies currency conversion type.
• DeliveryTermsCode: string
  Title: Freight Terms

  Maximum Length: 30

  Value that identifies delivery terms code.
• DestinationPostalCode: string
  Title: Destination Postal Code

  Read Only: true

  Maximum Length: 60

  Value that identifies destination postal code.
• DestinationRegionCode: string
  Title: Destination Region

  Maximum Length: 30

  Value that identifies destination region code.
• DestinationTerritory: string
  Read Only: true

  Maximum Length: 255

  Value that identifies destination territory.
• DestinationTerritoryCode: string
  Title: Destination Country

  Maximum Length: 2

  Value that identifies destination territory code.
• DispatchTerritory: string
  Read Only: true

  Maximum Length: 255

  Value that identifies dispatch territory.
• DispatchTerritoryCode: string
  Title: Country of Supply

  Maximum Length: 2

  Value that identifies dispatch territory code.
• DocumentLineNumber: string
  Title: Document Line Number

  Maximum Length: 20

  Value that identifies document line number.
• DocumentNumber: string
  Title: Document Number

  Maximum Length: 30

  Value that identifies document number.
• DocumentSourceType: string
  Title: Source Transaction

  Maximum Length: 30

  Value that identifies document source type.
• DocumentSourceTypeMeaning: string
  Read Only: true

  Maximum Length: 255

  Value that identifies document source type meaning
• DocumentUnitPrice: number
  Title: Unit Price

  Value that identifies document unit price
• EstablishmentId: integer
  Title: Legal Reporting Unit

  Value that uniquely identifies establishment identifier.
• ExceptionsCount: integer
  Value that identifies exceptions count
• FiscalRegimeCode: string
  Title: Fiscal Regime

  Maximum Length: 10

  Value that identifies fiscal regime code
• FlowIndicatorCode: string
  Title: Flow Indicator

  Maximum Length: 30

  Value that identifies flow indicator code
• FreightCharges: number
  Value that identifies freight charges
• FreightFactor: number
  Title: Freight Factor

  Value that identifies freight factor.
• FromOrganizationId: integer
  Value that uniquely identifies the organization.
• GeographyId: integer
  Title: Economic Zone

  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
  Title: Invoice Batch

  Maximum Length: 50

  Value that identifies the invoice batch name.
• InvoiceCurrencyCode: string
  Maximum Length: 15

  Value that identifies the invoice currency code.
• InvoiceDateReference: string (date)
  Title: Invoice Date

  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
  Title: Invoice Line

  Maximum Length: 30

  Value that identifies the invoice line number.
• InvoiceNeeded: string
  Maximum Length: 1

  Value that identifies if the invoice is needed.
• InvoiceNumber: string
  Title: Invoice

  Maximum Length: 50

  Value that identifies the invoice number.
• InvoiceQuantity: number
  Title: Invoice Quantity

  Value that identifies invoice quantity.
• InvoiceQuantityUOM: string
  Read Only: true

  Maximum Length: 255

  Value that identifies invoice quantity UOM.
• InvoiceQuantityUOMCode: string
  Maximum Length: 3

  Value that identifies invoice quantity UOM code.
• InvoiceUnitPrice: number
  Title: Unit Price

  Value that identifies invoice unit price.
• InvoiceValue: number
  Title: Invoice Value

  Value that identifies invoice value.
• InvoiceValueInReportingCurrency: number
  Value that identifies invoice value in reporting currency.
• ItemCode: string
  Maximum Length: 300

  Value that identifies the item.
• ItemCost: number
  Value that identifies item cost.
• ItemDescription: string
  Maximum Length: 240

  Value that identifies item description.
• ItemUnitWeight: number
  Value that identifies unit weight for the item.
• ItemWeightUOMCode: string
  Value that identifies item weight UOM code.
• JmfInExceptions: array JMF Intrastat Exceptions
  Title: JMF Intrastat Exceptions

  Provides exceptions associated to Intrastat transactions.
• LegalEntityId: integer
  Value that uniquely identifies the legal entity.
• LegalEntityName: string
  Maximum Length: 255

  Value that identifies legal entity name.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LruName: string
  Title: Legal Reporting Unit

  Maximum Length: 240

  Value that identifies legal reporting unit.
• MovementId: integer
  Title: Transaction

  Value that uniquely identifies the movement number.
• MovementStatus: string
  Title: Transaction Status

  Maximum Length: 1

  Default Value: O

  Value that identifies movement status.
• MovementStatusMeaning: string
  Maximum Length: 255

  Value that identifies the status for the movement.
• MovementType: string
  Title: Flow Type

  Maximum Length: 3

  Value that identifies movement type.
• MovementTypeMeaning: string
  Maximum Length: 255

  Value that identifies the type of movement.
• ObjectVersionNumber: integer (int32)
  Value that identifies the object version number.
• OilReferenceCode: string
  Title: Mineral Oil Reference

  Maximum Length: 30

  Value that identifies the oil reference code.
• OrganizationId: integer
  Value that uniquely identifies the organization.
• OrganizationName: string
  Value that identifies the organization name.
• OriginalTransactionDate: string (date)
  Value that identifies the original transaction date.
• OriginPostalCode: string
  Title: Origin Postal Code

  Read Only: true

  Maximum Length: 60

  Value that identifies the origin postal code.
• OriginRegionCode: string
  Title: Region of Origin

  Maximum Length: 30

  Value that identifies the origin region code.
• OriginTerritory: string
  Read Only: true

  Maximum Length: 255

  Value that identifies the origin territory.
• OriginTerritoryCode: string
  Title: Country of Origin

  Maximum Length: 2

  Value that identifies the origin territory code.
• OutsideProcessValue: number
  Value that identifies the value of the outside process.
• ParentMovementId: integer
  Title: Original Transaction

  Value that uniquely identifies the parent movement.
• PeriodName: string
  Title: Period

  Maximum Length: 15

  Value that identifies the period name.
• Port: string
  Maximum Length: 30

  Value that identifies the port.
• PreferenceCode: string
  Title: Preference

  Maximum Length: 30

  Value that identifies the preference code.
• ReportDate: string (date)
  Value that identifies the report date.
• ReportingCurrencyCode: string
  Title: Reporting Currency

  Maximum Length: 15

  Value that identifies the reporting currency code.
• ReportReference: string
  Maximum Length: 200

  Value that identifies the report reference.
• SetOfBooksPeriod: string
  Title: Invoice Period

  Maximum Length: 15

  Value that identifies the period corresponding to a set of book.
• StatisticalCode: string
  Title: Statistical Procedure

  Maximum Length: 10

  Value that identifies the statistical code.
• StatisticalValue: number
  Title: Statistical Value

  Value that identifies the statistical value.
• Status: string
  Read Only: true

  Value that identifies the status.
• SupplyReferenceCode: string
  Title: Supply Reference

  Maximum Length: 30

  Value that identifies the supply reference code.
• SuppUOMText: string
  Value that identifies the supplementary UOM.
• TaricCode: string
  Title: TARIC Code

  Maximum Length: 30

  Value that identifies the TARIC code.
• TerritoryCode: string
  Title: Country

  Maximum Length: 2

  Value that identifies the territory code.
• TerritoryName: string
  Title: Country

  Maximum Length: 80

  Value that identifies the territory name.
• ToLocationId: number
  Read Only: true

  Value that uniquely identifies the location associated with the destination organization.
• ToOrganizationId: integer
  Read Only: true

  Value that uniquely identifies the destination organization.
• TotalWeight: number
  Title: Net Mass

  Value that identifies the total weight.
• TotalWeightUOM: string
  Read Only: true

  Maximum Length: 255

  Value that identifies the total weight UOM.
• TotalWeightUOMCode: string
  Title: Weight UOM

  Maximum Length: 3

  Value that identifies total weight UOM code.
• TradingPartnerId: integer (int64)
  Value that uniquely identifies the trading partner.
• TradingPartnerName: string
  Title: Trading Partner

  Maximum Length: 360

  Value that identifies the trading partner.
• TradingPartnerNumber: string
  Title: Trading Partner Number

  Maximum Length: 20

  Value that identifies the trading partner number.
• TradingPartnerPartyId: number
  Value that uniquely identifies the trading partner party.
• TradingPartnerSiteCountry: string
  Value that identifies the country corresponding to the site for a trading partner.
• TradingPartnerSiteId: integer (int64)
  Value that uniquely identifies trading partner site.
• TradingPartnerSiteName: string
  Title: Trading Partner Site

  Maximum Length: 250

  Value that identifies trading partner site name.
• TradingPartnerSitePartyId: string
  Read Only: true

  Maximum Length: 20

  Value that uniquely identifies trading partner site.
• TradingPartnerType: string
  Title: Trading Partner Type

  Maximum Length: 1

  Value that identifies trading partner type.
• TradingPartnerTypeMeaning: string
  Read Only: true

  Maximum Length: 255

  Value that identifies the type of trading partner.
• TradingPartnerVATNumber: string
  Title: Trading Partner VAT

  Maximum Length: 150

  Value that identifies the trading partner VAT number.
• TransactionDate: string (date)
  Title: Transaction Date

  Value that identifies the transaction date.
• TransactionDateHigh: string (date)
  Title: Transaction Date

  Read Only: true

  Value that identifies the to transaction date to search for Intrastat transactions.
• TransactionDateLow: string (date)
  Title: Transaction Date

  Read Only: true

  Value that identifies the from transaction date to search for Intrastat transactions.
• TransactionNatureCode: string
  Title: Nature of Transaction Code

  Maximum Length: 10

  Value that identifies the nature of transaction code.
• TransactionQuantity: number
  Title: Quantity

  Value that identifies the transaction quantity.
• TransactionQuantityUOM: string
  Read Only: true

  Maximum Length: 255

  Value that identifies transaction quantity UOM.
• TransactionQuantityUOMCode: string
  Maximum Length: 3

  Value that identifies transaction quantity UOM code.
• TransactionUOMText: string
  Read Only: true

  Value that identifies transaction UOM name.
• TransactionValue: number
  Title: Transaction Amount

  Value that identifies the transaction value.
• TransportModeCode: string
  Maximum Length: 30

  Value that identifies the transport mode.
• TransportModeDescription: string
  Read Only: true

  Maximum Length: 240

  Value that identifies the type of transport mode.
• TriangulationCountry: string
  Read Only: true

  Maximum Length: 255

  Value that identifies the triangulation country for an Intrastat transaction.
• TriangulationCountryCode: string
  Title: Triangulation Country

  Maximum Length: 2

  Value that identifies the triangulation country.
• UnitWeight: number
  Title: Unit Weight

  Value that identifies the unit weight.
• VATRegistrationNumber: string
  Title: VAT Registration

  Maximum Length: 150

  Value that identifies the VAT registration number corresponding to a trading partner for an Intrastat transaction.
• WeightUOMText: string
  Read Only: true

  Value that identifies weight UOM name.

{
    "type":"object",
    "properties":{
        "AdjustedStatisticalValue":{
            "title":"Adjusted Statistical Value",
            "type":"number",
            "description":"Value that identifies the adjusted statistical value.",
            "nullable":true,
            "x-queryable":true
        },
        "AffiliationReferenceCode":{
            "title":"Affiliation Reference",
            "maxLength":30,
            "type":"string",
            "description":"Value that identifies the affiliation reference code.",
            "nullable":true,
            "x-queryable":true
        },
        "AlternateQuantity":{
            "title":"Supplementary Quantity",
            "type":"number",
            "description":"Value that identifies alternate quantity.",
            "nullable":true,
            "x-queryable":true
        },
        "AlternateUOM":{
            "maxLength":255,
            "type":"string",
            "description":"Value that identifies the alternate UOM.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AlternateUOMCode":{
            "title":"Supplementary UOM",
            "maxLength":3,
            "type":"string",
            "description":"Value that identifies the alternate UOM code.",
            "nullable":true,
            "x-queryable":true
        },
        "AutomaticCreation":{
            "maxLength":1,
            "type":"string",
            "description":"Value that identifies the automatic creation of an Intrastat transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "CSACode":{
            "maxLength":30,
            "type":"string",
            "description":"Value that uniquely identifies the classification and description of goods for an Intrastat transaction.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "CategoryId":{
            "type":"integer",
            "description":"Value that uniquely identifies the category.",
            "nullable":true,
            "x-queryable":true
        },
        "CategorySetId":{
            "type":"integer",
            "description":"Value that uniquely identifies the category set.",
            "nullable":true,
            "x-queryable":true
        },
        "Comments":{
            "title":"Comments",
            "maxLength":240,
            "type":"string",
            "description":"Value that identifies comments.",
            "nullable":true,
            "x-queryable":true
        },
        "CommodityCode":{
            "title":"Commodity Code",
            "maxLength":240,
            "type":"string",
            "description":"Value that identifies commodity code.",
            "nullable":true,
            "x-queryable":true
        },
        "CommodityDescription":{
            "title":"Commodity Description",
            "maxLength":240,
            "type":"string",
            "description":"Value that identifies commodity description.",
            "nullable":true,
            "x-queryable":true
        },
        "ContainerTypeCode":{
            "title":"Transport Container",
            "maxLength":30,
            "type":"string",
            "description":"Value that identifies container type code.",
            "nullable":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"Value that identifies currency code.",
            "nullable":true,
            "x-queryable":true
        },
        "CurrencyConversionDate":{
            "type":"string",
            "description":"Value that identifies currency conversion date.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "CurrencyConversionRate":{
            "type":"number",
            "description":"Value that identifies currency conversion rate.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "CurrencyConversionType":{
            "maxLength":30,
            "type":"string",
            "description":"Value that identifies currency conversion type.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "DeliveryTermsCode":{
            "title":"Freight Terms",
            "maxLength":30,
            "type":"string",
            "description":"Value that identifies delivery terms code.",
            "nullable":true,
            "x-queryable":true
        },
        "DestinationPostalCode":{
            "title":"Destination Postal Code",
            "maxLength":60,
            "type":"string",
            "description":"Value that identifies destination postal code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DestinationRegionCode":{
            "title":"Destination Region",
            "maxLength":30,
            "type":"string",
            "description":"Value that identifies destination region code.",
            "nullable":true,
            "x-queryable":true
        },
        "DestinationTerritory":{
            "maxLength":255,
            "type":"string",
            "description":"Value that identifies destination territory.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DestinationTerritoryCode":{
            "title":"Destination Country",
            "maxLength":2,
            "type":"string",
            "description":"Value that identifies destination territory code.",
            "nullable":true,
            "x-queryable":true
        },
        "DispatchTerritory":{
            "maxLength":255,
            "type":"string",
            "description":"Value that identifies dispatch territory.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DispatchTerritoryCode":{
            "title":"Country of Supply",
            "maxLength":2,
            "type":"string",
            "description":"Value that identifies dispatch territory code.",
            "nullable":true,
            "x-queryable":true
        },
        "DocumentLineNumber":{
            "title":"Document Line Number",
            "maxLength":20,
            "type":"string",
            "description":"Value that identifies document line number.",
            "nullable":true,
            "x-queryable":true
        },
        "DocumentNumber":{
            "title":"Document Number",
            "maxLength":30,
            "type":"string",
            "description":"Value that identifies document number.",
            "nullable":true,
            "x-queryable":true
        },
        "DocumentSourceType":{
            "title":"Source Transaction",
            "maxLength":30,
            "type":"string",
            "description":"Value that identifies document source type.",
            "nullable":true,
            "x-queryable":true
        },
        "DocumentSourceTypeMeaning":{
            "maxLength":255,
            "type":"string",
            "description":"Value that identifies document source type meaning",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "DocumentUnitPrice":{
            "title":"Unit Price",
            "type":"number",
            "description":"Value that identifies document unit price",
            "nullable":true,
            "x-queryable":true
        },
        "EstablishmentId":{
            "title":"Legal Reporting Unit",
            "type":"integer",
            "description":"Value that uniquely identifies establishment identifier.",
            "nullable":false,
            "x-queryable":true
        },
        "ExceptionsCount":{
            "type":"integer",
            "description":"Value that identifies exceptions count",
            "nullable":true,
            "x-queryable":true
        },
        "FiscalRegimeCode":{
            "title":"Fiscal Regime",
            "maxLength":10,
            "type":"string",
            "description":"Value that identifies fiscal regime code",
            "nullable":true,
            "x-queryable":true
        },
        "FlowIndicatorCode":{
            "title":"Flow Indicator",
            "maxLength":30,
            "type":"string",
            "description":"Value that identifies flow indicator code",
            "nullable":true,
            "x-queryable":true
        },
        "FreightCharges":{
            "type":"number",
            "description":"Value that identifies freight charges",
            "nullable":true,
            "x-queryable":true
        },
        "FreightFactor":{
            "title":"Freight Factor",
            "type":"number",
            "description":"Value that identifies freight factor.",
            "nullable":true,
            "x-queryable":true
        },
        "FromOrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the organization.",
            "nullable":true,
            "x-queryable":true
        },
        "GeographyId":{
            "title":"Economic Zone",
            "type":"integer",
            "description":"Value that uniquely identifies the geography.",
            "nullable":false,
            "x-queryable":true
        },
        "InventoryItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inventory item.",
            "nullable":true,
            "x-queryable":true
        },
        "InvoiceBatchId":{
            "type":"integer",
            "description":"Value that uniquely identifies the invoice batch.",
            "nullable":true,
            "x-queryable":true
        },
        "InvoiceBatchName":{
            "title":"Invoice Batch",
            "maxLength":50,
            "type":"string",
            "description":"Value that identifies the invoice batch name.",
            "nullable":true,
            "x-queryable":true
        },
        "InvoiceCurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"Value that identifies the invoice currency code.",
            "nullable":true,
            "x-queryable":true
        },
        "InvoiceDateReference":{
            "title":"Invoice Date",
            "type":"string",
            "description":"Value that identifies the invoice date reference.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "InvoiceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the invoice number.",
            "nullable":true,
            "x-queryable":true
        },
        "InvoiceLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the invoice line.",
            "nullable":true,
            "x-queryable":true
        },
        "InvoiceLineNumber":{
            "title":"Invoice Line",
            "maxLength":30,
            "type":"string",
            "description":"Value that identifies the invoice line number.",
            "nullable":true,
            "x-queryable":true
        },
        "InvoiceNeeded":{
            "maxLength":1,
            "type":"string",
            "description":"Value that identifies if the invoice is needed.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "InvoiceNumber":{
            "title":"Invoice",
            "maxLength":50,
            "type":"string",
            "description":"Value that identifies the invoice number.",
            "nullable":true,
            "x-queryable":true
        },
        "InvoiceQuantity":{
            "title":"Invoice Quantity",
            "type":"number",
            "description":"Value that identifies invoice quantity.",
            "nullable":true,
            "x-queryable":true
        },
        "InvoiceQuantityUOM":{
            "maxLength":255,
            "type":"string",
            "description":"Value that identifies invoice quantity UOM.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InvoiceQuantityUOMCode":{
            "maxLength":3,
            "type":"string",
            "description":"Value that identifies invoice quantity UOM code.",
            "nullable":true,
            "x-queryable":true
        },
        "InvoiceUnitPrice":{
            "title":"Unit Price",
            "type":"number",
            "description":"Value that identifies invoice unit price.",
            "nullable":true,
            "x-queryable":true
        },
        "InvoiceValue":{
            "title":"Invoice Value",
            "type":"number",
            "description":"Value that identifies invoice value.",
            "nullable":true,
            "x-queryable":true
        },
        "InvoiceValueInReportingCurrency":{
            "type":"number",
            "description":"Value that identifies invoice value in reporting currency.",
            "nullable":true,
            "x-queryable":true
        },
        "ItemCode":{
            "maxLength":300,
            "type":"string",
            "description":"Value that identifies the item.",
            "nullable":true,
            "x-queryable":true
        },
        "ItemCost":{
            "type":"number",
            "description":"Value that identifies item cost.",
            "nullable":true,
            "x-queryable":true
        },
        "ItemDescription":{
            "maxLength":240,
            "type":"string",
            "description":"Value that identifies item description.",
            "nullable":true,
            "x-queryable":true
        },
        "ItemUnitWeight":{
            "type":"number",
            "description":"Value that identifies unit weight for the item.",
            "nullable":true,
            "x-queryable":false
        },
        "ItemWeightUOMCode":{
            "type":"string",
            "description":"Value that identifies item weight UOM code.",
            "nullable":true,
            "x-queryable":false
        },
        "JmfInExceptions":{
            "title":"JMF Intrastat Exceptions",
            "type":"array",
            "description":"Provides exceptions associated to Intrastat transactions.",
            "items":{
                "$ref":"#/components/schemas/intrastatTransactions-JmfInExceptions-item-response"
            }
        },
        "LegalEntityId":{
            "type":"integer",
            "description":"Value that uniquely identifies the legal entity.",
            "nullable":true,
            "x-queryable":true
        },
        "LegalEntityName":{
            "maxLength":255,
            "type":"string",
            "description":"Value that identifies legal entity name.",
            "nullable":true,
            "x-queryable":true
        },
        "LruName":{
            "title":"Legal Reporting Unit",
            "maxLength":240,
            "type":"string",
            "description":"Value that identifies legal reporting unit.",
            "nullable":true,
            "x-queryable":true
        },
        "MovementId":{
            "title":"Transaction",
            "type":"integer",
            "description":"Value that uniquely identifies the movement number.",
            "nullable":false,
            "x-queryable":true
        },
        "MovementStatus":{
            "title":"Transaction Status",
            "maxLength":1,
            "type":"string",
            "description":"Value that identifies movement status.",
            "nullable":false,
            "default":"O",
            "x-queryable":true
        },
        "MovementStatusMeaning":{
            "maxLength":255,
            "type":"string",
            "description":"Value that identifies the status for the movement.",
            "nullable":true,
            "x-queryable":true
        },
        "MovementType":{
            "title":"Flow Type",
            "maxLength":3,
            "type":"string",
            "description":"Value that identifies movement type.",
            "nullable":false,
            "x-queryable":true
        },
        "MovementTypeMeaning":{
            "maxLength":255,
            "type":"string",
            "description":"Value that identifies the type of movement.",
            "nullable":true,
            "x-queryable":false
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Value that identifies the object version number.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":9
            },
            "x-queryable":true
        },
        "OilReferenceCode":{
            "title":"Mineral Oil Reference",
            "maxLength":30,
            "type":"string",
            "description":"Value that identifies the oil reference code.",
            "nullable":true,
            "x-queryable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the organization.",
            "nullable":true,
            "x-queryable":true
        },
        "OrganizationName":{
            "type":"string",
            "description":"Value that identifies the organization name.",
            "nullable":true,
            "x-queryable":false
        },
        "OriginPostalCode":{
            "title":"Origin Postal Code",
            "maxLength":60,
            "type":"string",
            "description":"Value that identifies the origin postal code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OriginRegionCode":{
            "title":"Region of Origin",
            "maxLength":30,
            "type":"string",
            "description":"Value that identifies the origin region code.",
            "nullable":true,
            "x-queryable":true
        },
        "OriginTerritory":{
            "maxLength":255,
            "type":"string",
            "description":"Value that identifies the origin territory.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OriginTerritoryCode":{
            "title":"Country of Origin",
            "maxLength":2,
            "type":"string",
            "description":"Value that identifies the origin territory code.",
            "nullable":true,
            "x-queryable":true
        },
        "OriginalTransactionDate":{
            "type":"string",
            "description":"Value that identifies the original transaction date.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "OutsideProcessValue":{
            "type":"number",
            "description":"Value that identifies the value of the outside process.",
            "nullable":true,
            "x-queryable":true
        },
        "ParentMovementId":{
            "title":"Original Transaction",
            "type":"integer",
            "description":"Value that uniquely identifies the parent movement.",
            "nullable":true,
            "x-queryable":true
        },
        "PeriodName":{
            "title":"Period",
            "maxLength":15,
            "type":"string",
            "description":"Value that identifies the period name.",
            "nullable":true,
            "x-queryable":true
        },
        "Port":{
            "maxLength":30,
            "type":"string",
            "description":"Value that identifies the port.",
            "nullable":true,
            "x-queryable":true
        },
        "PreferenceCode":{
            "title":"Preference",
            "maxLength":30,
            "type":"string",
            "description":"Value that identifies the preference code.",
            "nullable":true,
            "x-queryable":true
        },
        "ReportDate":{
            "type":"string",
            "description":"Value that identifies the report date.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "ReportReference":{
            "maxLength":200,
            "type":"string",
            "description":"Value that identifies the report reference.",
            "nullable":true,
            "x-queryable":true
        },
        "ReportingCurrencyCode":{
            "title":"Reporting Currency",
            "maxLength":15,
            "type":"string",
            "description":"Value that identifies the reporting currency code.",
            "nullable":true,
            "x-queryable":true
        },
        "SetOfBooksPeriod":{
            "title":"Invoice Period",
            "maxLength":15,
            "type":"string",
            "description":"Value that identifies the period corresponding to a set of book.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "StatisticalCode":{
            "title":"Statistical Procedure",
            "maxLength":10,
            "type":"string",
            "description":"Value that identifies the statistical code.",
            "nullable":true,
            "x-queryable":true
        },
        "StatisticalValue":{
            "title":"Statistical Value",
            "type":"number",
            "description":"Value that identifies the statistical value.",
            "nullable":true,
            "x-queryable":true
        },
        "Status":{
            "type":"string",
            "description":"Value that identifies the status.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "SuppUOMText":{
            "type":"string",
            "description":"Value that identifies the supplementary UOM.",
            "nullable":true,
            "x-queryable":false
        },
        "SupplyReferenceCode":{
            "title":"Supply Reference",
            "maxLength":30,
            "type":"string",
            "description":"Value that identifies the supply reference code.",
            "nullable":true,
            "x-queryable":true
        },
        "TaricCode":{
            "title":"TARIC Code",
            "maxLength":30,
            "type":"string",
            "description":"Value that identifies the TARIC code.",
            "nullable":true,
            "x-queryable":true
        },
        "TerritoryCode":{
            "title":"Country",
            "maxLength":2,
            "type":"string",
            "description":"Value that identifies the territory code.",
            "nullable":true,
            "x-queryable":true
        },
        "TerritoryName":{
            "title":"Country",
            "maxLength":80,
            "type":"string",
            "description":"Value that identifies the territory name.",
            "nullable":true,
            "x-queryable":true
        },
        "ToLocationId":{
            "type":"number",
            "description":"Value that uniquely identifies the location associated with the destination organization.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "ToOrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the destination organization.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "TotalWeight":{
            "title":"Net Mass",
            "type":"number",
            "description":"Value that identifies the total weight.",
            "nullable":true,
            "x-queryable":true
        },
        "TotalWeightUOM":{
            "maxLength":255,
            "type":"string",
            "description":"Value that identifies the total weight UOM.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TotalWeightUOMCode":{
            "title":"Weight UOM",
            "maxLength":3,
            "type":"string",
            "description":"Value that identifies total weight UOM code.",
            "nullable":true,
            "x-queryable":true
        },
        "TradingPartnerId":{
            "type":"integer",
            "description":"Value that uniquely identifies the trading partner.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TradingPartnerName":{
            "title":"Trading Partner",
            "maxLength":360,
            "type":"string",
            "description":"Value that identifies the trading partner.",
            "nullable":true,
            "x-queryable":true
        },
        "TradingPartnerNumber":{
            "title":"Trading Partner Number",
            "maxLength":20,
            "type":"string",
            "description":"Value that identifies the trading partner number.",
            "nullable":true,
            "x-queryable":true
        },
        "TradingPartnerPartyId":{
            "type":"number",
            "description":"Value that uniquely identifies the trading partner party.",
            "nullable":true,
            "x-queryable":true
        },
        "TradingPartnerSiteCountry":{
            "type":"string",
            "description":"Value that identifies the country corresponding to the site for a trading partner.",
            "nullable":true,
            "x-queryable":false
        },
        "TradingPartnerSiteId":{
            "type":"integer",
            "description":"Value that uniquely identifies trading partner site.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TradingPartnerSiteName":{
            "title":"Trading Partner Site",
            "maxLength":250,
            "type":"string",
            "description":"Value that identifies trading partner site name.",
            "nullable":true,
            "x-queryable":true
        },
        "TradingPartnerSitePartyId":{
            "maxLength":20,
            "type":"string",
            "description":"Value that uniquely identifies trading partner site.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "TradingPartnerType":{
            "title":"Trading Partner Type",
            "maxLength":1,
            "type":"string",
            "description":"Value that identifies trading partner type.",
            "nullable":true,
            "x-queryable":true
        },
        "TradingPartnerTypeMeaning":{
            "maxLength":255,
            "type":"string",
            "description":"Value that identifies the type of trading partner.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TradingPartnerVATNumber":{
            "title":"Trading Partner VAT",
            "maxLength":150,
            "type":"string",
            "description":"Value that identifies the trading partner VAT number.",
            "nullable":true,
            "x-queryable":true
        },
        "TransactionDate":{
            "title":"Transaction Date",
            "type":"string",
            "description":"Value that identifies the transaction date.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "TransactionDateHigh":{
            "title":"Transaction Date",
            "type":"string",
            "description":"Value that identifies the to transaction date to search for Intrastat transactions.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TransactionDateLow":{
            "title":"Transaction Date",
            "type":"string",
            "description":"Value that identifies the from transaction date to search for Intrastat transactions.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TransactionNatureCode":{
            "title":"Nature of Transaction Code",
            "maxLength":10,
            "type":"string",
            "description":"Value that identifies the nature of transaction code.",
            "nullable":true,
            "x-queryable":true
        },
        "TransactionQuantity":{
            "title":"Quantity",
            "type":"number",
            "description":"Value that identifies the transaction quantity.",
            "nullable":true,
            "x-queryable":true
        },
        "TransactionQuantityUOM":{
            "maxLength":255,
            "type":"string",
            "description":"Value that identifies transaction quantity UOM.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TransactionQuantityUOMCode":{
            "maxLength":3,
            "type":"string",
            "description":"Value that identifies transaction quantity UOM code.",
            "nullable":true,
            "x-queryable":true
        },
        "TransactionUOMText":{
            "type":"string",
            "description":"Value that identifies transaction UOM name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "TransactionValue":{
            "title":"Transaction Amount",
            "type":"number",
            "description":"Value that identifies the transaction value.",
            "nullable":true,
            "x-queryable":true
        },
        "TransportModeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Value that identifies the transport mode.",
            "nullable":true,
            "x-queryable":true
        },
        "TransportModeDescription":{
            "maxLength":240,
            "type":"string",
            "description":"Value that identifies the type of transport mode.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TriangulationCountry":{
            "maxLength":255,
            "type":"string",
            "description":"Value that identifies the triangulation country for an Intrastat transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TriangulationCountryCode":{
            "title":"Triangulation Country",
            "maxLength":2,
            "type":"string",
            "description":"Value that identifies the triangulation country.",
            "nullable":true,
            "x-queryable":true
        },
        "UnitWeight":{
            "title":"Unit Weight",
            "type":"number",
            "description":"Value that identifies the unit weight.",
            "nullable":true,
            "x-queryable":true
        },
        "VATRegistrationNumber":{
            "title":"VAT Registration",
            "maxLength":150,
            "type":"string",
            "description":"Value that identifies the VAT registration number corresponding to a trading partner for an Intrastat transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "WeightUOMText":{
            "type":"string",
            "description":"Value that identifies weight UOM name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : JMF Intrastat Exceptions

Type: array

Title: JMF Intrastat Exceptions

Provides exceptions associated to Intrastat transactions.

Show Source

• Array of: object intrastatTransactions-JmfInExceptions-item-response

{
    "title":"JMF Intrastat Exceptions",
    "type":"array",
    "description":"Provides exceptions associated to Intrastat transactions.",
    "items":{
        "$ref":"#/components/schemas/intrastatTransactions-JmfInExceptions-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : intrastatTransactions-JmfInExceptions-item-response

Type: object

Show Source

• ErrorDescription: string
  Read Only: true

  Maximum Length: 250

  Value that identifies error corresponding to an Intrastat transaction.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MovementId: number
  Read Only: true

  Value that uniquely identifies the movement number.

{
    "type":"object",
    "properties":{
        "ErrorDescription":{
            "maxLength":250,
            "type":"string",
            "description":"Value that identifies error corresponding to an Intrastat transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MovementId":{
            "type":"number",
            "description":"Value that uniquely identifies the movement number.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Links

JmfInExceptions

Operation: /fscmRestApi/resources/11.13.18.05/intrastatTransactions/{MovementId}/child/JmfInExceptions

Parameters:

• MovementId: $request.path.MovementId

Provides exceptions associated to Intrastat transactions.

Back to Top