Jump to

• Request
• Response
• Examples

Get one document

get

/fscmRestApi/resources/11.13.18.05/inboundFiscalDocuments/{DocumentId}

Request

Path Parameters

• DocumentId(required): integer(int64)
  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 : inboundFiscalDocuments-item-response

Type: object

Show Source

• AccessKey: string
  Title: Access Key

  Maximum Length: 64
• AcknowledgedDate: string (date)
  Title: Acknowledged Date
• ASNNumber: string
  Title: ASN Number

  Maximum Length: 80
• AssociationId: integer (int64)
  Title: Association ID
• BilltoBusinessUnit: string
  Title: Bill-to BU

  Read Only: true

  Maximum Length: 240
• BilltoBusinessUnitId: integer (int64)
  Title: Bill-to BU ID
• ConsumptionAdviceNumber: string
  Title: Consumption Advice Number

  Maximum Length: 80
• CurrencyCode: string
  Title: Currency Code

  Maximum Length: 30

  Default Value: BRL
• CurrencyName: string
  Title: Currency Name

  Read Only: true

  Maximum Length: 80
• DocumentId: integer (int64)
  Title: Document ID
• DocumentNumber: string
  Title: Document Number

  Maximum Length: 30
• DocumentType: string
  Title: Document Type

  Maximum Length: 255
• DocumentTypeCode: string
  Title: Document Type Code

  Maximum Length: 30
• fiscalDocumentLines: array fiscalDocumentLines
• FiscalFlow: string
  Title: Fiscal Flow

  Read Only: true

  Maximum Length: 80
• IssueDate: string (date)
  Title: Issue Date
• IssuerLegalEntityName: string
  Title: Issuer Name

  Read Only: true

  Maximum Length: 240
• IssuerLocationId: integer (int64)
  Title: Issuer Location ID
• IssuerPartyId: integer (int64)
  Title: Issuer Party ID
• IssuerTaxId: integer (int64)
  Title: Issuer Tax ID
• LETypeIssuerAddress: string
  Title: Issuer Address

  Read Only: true

  Maximum Length: 3852
• LETypeIssuerTaxpayerNumber: string
  Title: Issuer Taxpayer ID

  Read Only: true

  Maximum Length: 14
• LETypeReceiverAddress: string
  Title: Receiver Address

  Read Only: true

  Maximum Length: 3852
• LETypeReceiverTaxpayerNumber: string
  Title: Receiver Taxpayer ID

  Read Only: true

  Maximum Length: 14
• LETypeShipfromAddress: string
  Title: Ship-from Address

  Read Only: true

  Maximum Length: 3852
• LETypeShipfromTaxpayerNumber: string
  Title: Ship-from Taxpayer ID

  Read Only: true

  Maximum Length: 14
• LETypeShiptoAddress: string
  Title: Ship-to Address

  Read Only: true

  Maximum Length: 3852
• LETypeShiptoTaxpayerNumber: string
  Title: Ship-to Taxpayer ID

  Read Only: true

  Maximum Length: 14
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ParentDocumentId: integer (int64)
  Title: Parent Document ID
• ParentDocumentNumber: string
  Title: Parent Document Number

  Maximum Length: 255
• PartyTypeIssuerAddress: string
  Title: Issuer Address

  Read Only: true

  Maximum Length: 2658
• PartyTypeIssuerName: string
  Title: Issuer Name

  Read Only: true

  Maximum Length: 360
• PartyTypeIssuerTaxpayerNumber: string
  Title: Issuer Taxpayer ID

  Read Only: true

  Maximum Length: 14
• PartyTypeReceiverAddress: string
  Title: Receiver Address

  Read Only: true

  Maximum Length: 2658
• PartyTypeReceiverName: string
  Title: Receiver Name

  Read Only: true

  Maximum Length: 360
• PartyTypeReceiverTaxpayerNumber: string
  Title: Receiver Taxpayer ID

  Read Only: true

  Maximum Length: 14
• PartyTypeShipfromAddress: string
  Title: Ship-from Address

  Read Only: true

  Maximum Length: 2658
• PartyTypeShipfromName: string
  Title: Ship-from Name

  Read Only: true

  Maximum Length: 360
• PartyTypeShipfromTaxpayerNumber: string
  Title: Ship-from Taxpayer ID

  Read Only: true

  Maximum Length: 14
• PartyTypeShiptoAddress: string
  Title: Ship-to Address

  Read Only: true

  Maximum Length: 2658
• PartyTypeShiptoName: string
  Title: Ship-to Name

  Read Only: true

  Maximum Length: 360
• PartyTypeShiptoTaxpayerNumber: string
  Title: Ship-to Taxpayer ID

  Read Only: true

  Maximum Length: 14
• Reason: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80
• ReasonCode: string
  Maximum Length: 30
• ReceiverLegalEntityName: string
  Title: Receiver Name

  Read Only: true

  Maximum Length: 240
• ReceiverLocationId: integer (int64)
  Title: Receiver Location ID
• ReceiverPartyId: integer (int64)
  Title: Receiver Party ID
• ReceiverTaxId: integer (int64)
  Title: Receiver Tax ID
• Series: string
  Title: Series

  Maximum Length: 10
• ShipfromLegalEntityName: string
  Title: Ship-from Name

  Read Only: true

  Maximum Length: 240
• ShipfromLocationId: integer (int64)
  Title: Ship-from Location ID
• ShipfromPartyId: integer (int64)
  Title: Ship-from Party ID
• ShipfromTaxId: integer (int64)
  Title: Ship-from Tax ID
• ShiptoLegalEntityName: string
  Title: Ship-to Name

  Read Only: true

  Maximum Length: 240
• ShiptoLocationId: integer (int64)
  Title: Ship-to Location ID
• ShiptoPartyId: integer (int64)
  Title: Ship-to Party ID
• ShiptoTaxId: integer (int64)
  Title: Ship-to Tax ID
• SoldtoLegalEntity: string
  Title: Sold-to Legal Entity

  Read Only: true

  Maximum Length: 240
• SoldtoLegalEntityId: integer (int64)
  Title: Sold-to Legal Entity ID
• SourceDocumentType: string
  Title: Source Document Type

  Maximum Length: 255
• SourceDocumentTypeCode: string
  Title: Source Document Type Code

  Maximum Length: 30
• SourceReferenceDocumentHeaderId: integer (int64)
• Status: string
  Title: Status

  Maximum Length: 255
• StatusCode: string
  Title: Status Code

  Maximum Length: 30

  Default Value: NEW
• SubSeries: string
  Title: Subseries

  Maximum Length: 10
• TotalAmount: number
  Title: Total Amount
• Usage: string
  Read Only: true

  Maximum Length: 30

{
    "type":"object",
    "properties":{
        "ASNNumber":{
            "title":"ASN Number",
            "maxLength":80,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "AccessKey":{
            "title":"Access Key",
            "maxLength":64,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "AcknowledgedDate":{
            "title":"Acknowledged Date",
            "type":"string",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "AssociationId":{
            "title":"Association ID",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "BilltoBusinessUnit":{
            "title":"Bill-to BU",
            "maxLength":240,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "BilltoBusinessUnitId":{
            "title":"Bill-to BU ID",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ConsumptionAdviceNumber":{
            "title":"Consumption Advice Number",
            "maxLength":80,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency Code",
            "maxLength":30,
            "type":"string",
            "nullable":false,
            "default":"BRL",
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CurrencyName":{
            "title":"Currency Name",
            "maxLength":80,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "DocumentId":{
            "title":"Document ID",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "DocumentNumber":{
            "title":"Document Number",
            "maxLength":30,
            "type":"string",
            "nullable":false,
            "x-queryable":true
        },
        "DocumentType":{
            "title":"Document Type",
            "maxLength":255,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "DocumentTypeCode":{
            "title":"Document Type Code",
            "maxLength":30,
            "type":"string",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "FiscalFlow":{
            "title":"Fiscal Flow",
            "maxLength":80,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "IssueDate":{
            "title":"Issue Date",
            "type":"string",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "IssuerLegalEntityName":{
            "title":"Issuer Name",
            "maxLength":240,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "IssuerLocationId":{
            "title":"Issuer Location ID",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "IssuerPartyId":{
            "title":"Issuer Party ID",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "IssuerTaxId":{
            "title":"Issuer Tax ID",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "LETypeIssuerAddress":{
            "title":"Issuer Address",
            "maxLength":3852,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LETypeIssuerTaxpayerNumber":{
            "title":"Issuer Taxpayer ID",
            "maxLength":14,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "AssociationCode"
                ]
            }
        },
        "LETypeReceiverAddress":{
            "title":"Receiver Address",
            "maxLength":3852,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LETypeReceiverTaxpayerNumber":{
            "title":"Receiver Taxpayer ID",
            "maxLength":14,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "AssociationCode"
                ]
            }
        },
        "LETypeShipfromAddress":{
            "title":"Ship-from Address",
            "maxLength":3852,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LETypeShipfromTaxpayerNumber":{
            "title":"Ship-from Taxpayer ID",
            "maxLength":14,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "AssociationCode"
                ]
            }
        },
        "LETypeShiptoAddress":{
            "title":"Ship-to Address",
            "maxLength":3852,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LETypeShiptoTaxpayerNumber":{
            "title":"Ship-to Taxpayer ID",
            "maxLength":14,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "AssociationCode"
                ]
            }
        },
        "ParentDocumentId":{
            "title":"Parent Document ID",
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "precision":18
            }
        },
        "ParentDocumentNumber":{
            "title":"Parent Document Number",
            "maxLength":255,
            "type":"string",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "PartyTypeIssuerAddress":{
            "title":"Issuer Address",
            "maxLength":2658,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PartyTypeIssuerName":{
            "title":"Issuer Name",
            "maxLength":360,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "PartyTypeIssuerTaxpayerNumber":{
            "title":"Issuer Taxpayer ID",
            "maxLength":14,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "AssociationCode",
                    "BilltoBusinessUnitId"
                ]
            }
        },
        "PartyTypeReceiverAddress":{
            "title":"Receiver Address",
            "maxLength":2658,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PartyTypeReceiverName":{
            "title":"Receiver Name",
            "maxLength":360,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "PartyTypeReceiverTaxpayerNumber":{
            "title":"Receiver Taxpayer ID",
            "maxLength":14,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "AssociationCode"
                ]
            }
        },
        "PartyTypeShipfromAddress":{
            "title":"Ship-from Address",
            "maxLength":2658,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PartyTypeShipfromName":{
            "title":"Ship-from Name",
            "maxLength":360,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "PartyTypeShipfromTaxpayerNumber":{
            "title":"Ship-from Taxpayer ID",
            "maxLength":14,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "AssociationCode"
                ]
            }
        },
        "PartyTypeShiptoAddress":{
            "title":"Ship-to Address",
            "maxLength":2658,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PartyTypeShiptoName":{
            "title":"Ship-to Name",
            "maxLength":360,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "PartyTypeShiptoTaxpayerNumber":{
            "title":"Ship-to Taxpayer ID",
            "maxLength":14,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "AssociationCode"
                ]
            }
        },
        "Reason":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ReasonCode":{
            "maxLength":30,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ReceiverLegalEntityName":{
            "title":"Receiver Name",
            "maxLength":240,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ReceiverLocationId":{
            "title":"Receiver Location ID",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ReceiverPartyId":{
            "title":"Receiver Party ID",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ReceiverTaxId":{
            "title":"Receiver Tax ID",
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "Series":{
            "title":"Series",
            "maxLength":10,
            "type":"string",
            "nullable":true,
            "x-queryable":false
        },
        "ShipfromLegalEntityName":{
            "title":"Ship-from Name",
            "maxLength":240,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ShipfromLocationId":{
            "title":"Ship-from Location ID",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ShipfromPartyId":{
            "title":"Ship-from Party ID",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ShipfromTaxId":{
            "title":"Ship-from Tax ID",
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ShiptoLegalEntityName":{
            "title":"Ship-to Name",
            "maxLength":240,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ShiptoLocationId":{
            "title":"Ship-to Location ID",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ShiptoPartyId":{
            "title":"Ship-to Party ID",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ShiptoTaxId":{
            "title":"Ship-to Tax ID",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "SoldtoLegalEntity":{
            "title":"Sold-to Legal Entity",
            "maxLength":240,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "SoldtoLegalEntityId":{
            "title":"Sold-to Legal Entity ID",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "SourceDocumentType":{
            "title":"Source Document Type",
            "maxLength":255,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SourceDocumentTypeCode":{
            "title":"Source Document Type Code",
            "maxLength":30,
            "type":"string",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SourceReferenceDocumentHeaderId":{
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Status":{
            "title":"Status",
            "maxLength":255,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "StatusCode":{
            "title":"Status Code",
            "maxLength":30,
            "type":"string",
            "nullable":false,
            "default":"NEW",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SubSeries":{
            "title":"Subseries",
            "maxLength":10,
            "type":"string",
            "nullable":true,
            "x-queryable":false
        },
        "TotalAmount":{
            "title":"Total Amount",
            "type":"number",
            "nullable":false,
            "x-queryable":false
        },
        "Usage":{
            "maxLength":30,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "fiscalDocumentLines":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/inboundFiscalDocuments-fiscalDocumentLines-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : fiscalDocumentLines

Type: array

Show Source

• Array of: object inboundFiscalDocuments-fiscalDocumentLines-item-response

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/inboundFiscalDocuments-fiscalDocumentLines-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 : inboundFiscalDocuments-fiscalDocumentLines-item-response

Type: object

Show Source

• Amount: number
  Title: Amount

  Read Only: true
• ChargesAmount: number
  Title: Charges

  Read Only: true
• DocumentId: integer (int64)
  Title: Document ID

  Read Only: true
• ExternalItem: string
  Title: External Item

  Read Only: true

  Maximum Length: 300
• ExternalItemDescription: string
  Title: Description

  Read Only: true

  Maximum Length: 250
• FciControlNumber: string
  Title: FCI Number

  Read Only: true

  Maximum Length: 36
• fiscalDocumentSchedules: array fiscalDocumentSchedules
• InventoryItemDescription: string
  Title: Item Description

  Read Only: true
• InventoryItemId: integer (int64)
  Title: Item ID

  Read Only: true
• InventoryItemNumber: string
  Title: Item Code

  Read Only: true

  Maximum Length: 80
• LineId: integer (int64)
  Title: Document Line ID

  Read Only: true
• LineNumber: number
  Title: Line Number

  Read Only: true
• LineSourceDocumentType: string
  Title: Source Document Type

  Read Only: true

  Maximum Length: 255
• LineSourceDocumentTypeCode: string
  Title: Source Document Type Code

  Read Only: true

  Maximum Length: 30
• LineStatus: string
  Title: Status Code

  Read Only: true

  Maximum Length: 30

  Default Value: NEW
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PhysicalReceiptDate: string (date)
  Title: Physical Receipt Date

  Read Only: true
• PhysicalReceiptQuantity: number
  Title: Delivered Quantity
• Price: number
  Title: Unit Price

  Read Only: true
• Quantity: number
  Title: Quantity

  Read Only: true
• SecondaryQuantity: number
  Title: Secondary Quantity
• SecondaryUOMCode: string
  Title: Secondary UOM

  Read Only: true

  Maximum Length: 30
• SecondaryUOMName: string
  Title: Secondary UOM

  Read Only: true

  Maximum Length: 25
• SourceDocumentBUId: integer (int64)
  Title: Source Document BU ID

  Read Only: true
• SourceDocumentBUName: string
  Title: Source Document BU

  Read Only: true

  Maximum Length: 255
• Status: string
  Title: Status

  Maximum Length: 30
• Type: string
  Title: Line Type

  Read Only: true

  Maximum Length: 255
• TypeCode: string
  Title: Type Code

  Read Only: true

  Maximum Length: 30
• UOMCode: string
  Title: UOM Code

  Read Only: true

  Maximum Length: 30
• UOMName: string
  Title: UOM Name

  Read Only: true

  Maximum Length: 25

{
    "type":"object",
    "properties":{
        "Amount":{
            "title":"Amount",
            "type":"number",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ChargesAmount":{
            "title":"Charges",
            "type":"number",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "DocumentId":{
            "title":"Document ID",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ExternalItem":{
            "title":"External Item",
            "maxLength":300,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ExternalItemDescription":{
            "title":"Description",
            "maxLength":250,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FciControlNumber":{
            "title":"FCI Number",
            "maxLength":36,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InventoryItemDescription":{
            "title":"Item Description",
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "InventoryItemId":{
            "title":"Item ID",
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "InventoryItemNumber":{
            "title":"Item Code",
            "maxLength":80,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LineId":{
            "title":"Document Line ID",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "LineNumber":{
            "title":"Line Number",
            "type":"number",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "LineSourceDocumentType":{
            "title":"Source Document Type",
            "maxLength":255,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LineSourceDocumentTypeCode":{
            "title":"Source Document Type Code",
            "maxLength":30,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LineStatus":{
            "title":"Status Code",
            "maxLength":30,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "default":"NEW",
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PhysicalReceiptDate":{
            "title":"Physical Receipt Date",
            "type":"string",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PhysicalReceiptQuantity":{
            "title":"Delivered Quantity",
            "type":"number",
            "nullable":true,
            "x-queryable":false
        },
        "Price":{
            "title":"Unit Price",
            "type":"number",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "Quantity":{
            "title":"Quantity",
            "type":"number",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "SecondaryQuantity":{
            "title":"Secondary Quantity",
            "type":"number",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "PhysicalReceiptQuantity"
                ]
            }
        },
        "SecondaryUOMCode":{
            "title":"Secondary UOM",
            "maxLength":30,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SecondaryUOMName":{
            "title":"Secondary UOM",
            "maxLength":25,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"edit"
            },
            "x-queryable":true
        },
        "SourceDocumentBUId":{
            "title":"Source Document BU ID",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SourceDocumentBUName":{
            "title":"Source Document BU",
            "maxLength":255,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "Status":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "nullable":true,
            "x-queryable":false
        },
        "Type":{
            "title":"Line Type",
            "maxLength":255,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TypeCode":{
            "title":"Type Code",
            "maxLength":30,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "UOMCode":{
            "title":"UOM Code",
            "maxLength":30,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "UOMName":{
            "title":"UOM Name",
            "maxLength":25,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "fiscalDocumentSchedules":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/inboundFiscalDocuments-fiscalDocumentLines-fiscalDocumentSchedules-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : fiscalDocumentSchedules

Type: array

Show Source

• Array of: object inboundFiscalDocuments-fiscalDocumentLines-fiscalDocumentSchedules-item-response

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/inboundFiscalDocuments-fiscalDocumentLines-fiscalDocumentSchedules-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 : inboundFiscalDocuments-fiscalDocumentLines-fiscalDocumentSchedules-item-response

Type: object

Show Source

• AllocatedQuantity: number
  Title: Allocated Quantity
• AllocatedQuantityInFiscalDocumentLineUOM: number
  Title: Allocated Quantity
• AllocatedQuantityInSecondaryUOM: number
  Title: Secondary Quantity
• ASNLineNumber: string
  Title: ASN Line Number

  Maximum Length: 80
• ConsumptionAdviceLine: string
  Title: Consumption Advice Line Number

  Maximum Length: 80
• DocumentId: integer (int64)
  Title: Document ID
• ItemDescription: string
  Title: Description

  Read Only: true

  Maximum Length: 240
• LineId: integer (int64)
  Title: Document Line ID
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• POLineNumber: number
  Title: PO Line Number

  Read Only: true
• PONumber: string
  Title: PO Number

  Read Only: true

  Maximum Length: 30
• POScheduleNumber: number
  Title: PO Schedule Number

  Read Only: true
• PricingUOMCode: string
  Title: Pricing UOM

  Read Only: true

  Maximum Length: 3
• PricingUOMName: string
  Title: Pricing UOM

  Read Only: true

  Maximum Length: 255
• PromisedDate: string (date-time)
  Title: Promised Delivery Date

  Read Only: true
• ReceiptLineNumber: integer
  Title: Receipt Line
• ReceiptNumber: string
  Title: Receipt Number

  Maximum Length: 30
• SalesReturnOrderLine: string
  Title: Sales Return Order Line

  Maximum Length: 30
• SalesReturnOrderNumber: string
  Title: Sales Return Order Number

  Maximum Length: 30
• SalesReturnOrderSchedule: string
  Title: Sales Return Order Schedule

  Maximum Length: 30
• ScheduleId: integer (int64)
  Title: Schedule ID
• ScheduleNumber: number
  Title: Schedule Number
• SecondaryUOMCode: string
  Title: Secondary UOM

  Maximum Length: 30
• SecondaryUOMName: string
  Title: Secondary UOM

  Read Only: true

  Maximum Length: 25
• ShipmentLine: string
  Title: Shipment Line

  Maximum Length: 30
• ShipmentNumber: string
  Title: Shipment Number

  Maximum Length: 30
• SourceDocumentCurrencyCode: string
  Title: Source Document Currency Code

  Maximum Length: 30
• SourceDocumentCurrencyName: string
  Title: Source Document Currency

  Read Only: true

  Maximum Length: 255
• SourceDocumentId: integer (int64)
  Title: Source Document ID
• SourceDocumentLineId: integer (int64)
  Title: Source Document Line ID
• SourceDocumentPrice: number
  Title: Source Document Price
• SourceDocumentScheduleId: integer (int64)
  Title: Source Document Schedule ID
• SourceDocumentType: string
  Title: Source Document Type

  Read Only: true

  Maximum Length: 255
• SourceDocumentTypeCode: string
  Title: Source Document Type Code

  Maximum Length: 30

  Default Value: PURCHASE_ORDER
• SourceDocumentUOMCode: string
  Title: Source Document UOM Code

  Maximum Length: 30
• SourceDocumentUOMName: string
  Title: Source Document UOM

  Read Only: true

  Maximum Length: 255
• SourceReferenceDocumentLineId: integer (int64)
• SupplierItem: string
  Title: Supplier Item

  Read Only: true

  Maximum Length: 300

{
    "type":"object",
    "properties":{
        "ASNLineNumber":{
            "title":"ASN Line Number",
            "maxLength":80,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "AllocatedQuantity":{
            "title":"Allocated Quantity",
            "type":"number",
            "nullable":false,
            "x-queryable":true
        },
        "AllocatedQuantityInFiscalDocumentLineUOM":{
            "title":"Allocated Quantity",
            "type":"number",
            "nullable":true,
            "x-queryable":true
        },
        "AllocatedQuantityInSecondaryUOM":{
            "title":"Secondary Quantity",
            "type":"number",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "SecondaryUOMCode"
                ]
            },
            "x-queryable":true
        },
        "ConsumptionAdviceLine":{
            "title":"Consumption Advice Line Number",
            "maxLength":80,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "DocumentId":{
            "title":"Document ID",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ItemDescription":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LineId":{
            "title":"Document Line ID",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "POLineNumber":{
            "title":"PO Line Number",
            "type":"number",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "PONumber":{
            "title":"PO Number",
            "maxLength":30,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "POScheduleNumber":{
            "title":"PO Schedule Number",
            "type":"number",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "PricingUOMCode":{
            "title":"Pricing UOM",
            "maxLength":3,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PricingUOMName":{
            "title":"Pricing UOM",
            "maxLength":255,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PromisedDate":{
            "title":"Promised Delivery Date",
            "type":"string",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReceiptLineNumber":{
            "title":"Receipt Line",
            "type":"integer",
            "nullable":true,
            "x-queryable":true
        },
        "ReceiptNumber":{
            "title":"Receipt Number",
            "maxLength":30,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "SalesReturnOrderLine":{
            "title":"Sales Return Order Line",
            "maxLength":30,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "SalesReturnOrderNumber":{
            "title":"Sales Return Order Number",
            "maxLength":30,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "SalesReturnOrderSchedule":{
            "title":"Sales Return Order Schedule",
            "maxLength":30,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "ScheduleId":{
            "title":"Schedule ID",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ScheduleNumber":{
            "title":"Schedule Number",
            "type":"number",
            "nullable":true,
            "x-queryable":true
        },
        "SecondaryUOMCode":{
            "title":"Secondary UOM",
            "maxLength":30,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "SecondaryUOMName":{
            "title":"Secondary UOM",
            "maxLength":25,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"edit"
            },
            "x-queryable":true
        },
        "ShipmentLine":{
            "title":"Shipment Line",
            "maxLength":30,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "ShipmentNumber":{
            "title":"Shipment Number",
            "maxLength":30,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "SourceDocumentCurrencyCode":{
            "title":"Source Document Currency Code",
            "maxLength":30,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "SourceDocumentCurrencyName":{
            "title":"Source Document Currency",
            "maxLength":255,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceDocumentId":{
            "title":"Source Document ID",
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SourceDocumentLineId":{
            "title":"Source Document Line ID",
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SourceDocumentPrice":{
            "title":"Source Document Price",
            "type":"number",
            "nullable":true,
            "x-queryable":true
        },
        "SourceDocumentScheduleId":{
            "title":"Source Document Schedule ID",
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SourceDocumentType":{
            "title":"Source Document Type",
            "maxLength":255,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceDocumentTypeCode":{
            "title":"Source Document Type Code",
            "maxLength":30,
            "type":"string",
            "nullable":false,
            "default":"PURCHASE_ORDER",
            "x-queryable":true
        },
        "SourceDocumentUOMCode":{
            "title":"Source Document UOM Code",
            "maxLength":30,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "SourceDocumentUOMName":{
            "title":"Source Document UOM",
            "maxLength":255,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceReferenceDocumentLineId":{
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SupplierItem":{
            "title":"Supplier Item",
            "maxLength":300,
            "type":"string",
            "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

cancelFiscalDocument

Operation: /fscmRestApi/resources/11.13.18.05/inboundFiscalDocuments/{DocumentId}/action/cancelFiscalDocument

Parameters:

• DocumentId: $request.path.DocumentId

fiscalDocumentLines

Operation: /fscmRestApi/resources/11.13.18.05/inboundFiscalDocuments/{DocumentId}/child/fiscalDocumentLines

Parameters:

• DocumentId: $request.path.DocumentId

rejectFiscalDocument

Operation: /fscmRestApi/resources/11.13.18.05/inboundFiscalDocuments/{DocumentId}/action/rejectFiscalDocument

Parameters:

• DocumentId: $request.path.DocumentId

Back to Top

Examples

This example describes how to get one document.

Example 1 cURL Command

Use the following cURL command to submit a request on the REST resourceto get one document by fiscal document header identifier:

curl -u username:password "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100178959504"

Example 1 Response Body

The following shows an example of the response body in JSON format.

{
	"DocumentId": 300100178959504,
	"DocumentNumber": "310810420191",
	"AccessKey": "310810420191",
	"StatusCode": "CAPTURED",
	"Status": "Captured",
	"AssociationId": 100100077234663,
	"FiscalFlow": "Consignment Remittance",
	"ParentDocumentId": null,
	"ParentDocumentNumber": null,
	"CurrencyCode": "BRL",
	"CurrencyName": "Brazilian Real",
	"BilltoBusinessUnitId": 300100052386093,
	"BilltoBusinessUnit": "Vision Brazil",
	"SoldtoLegalEntityId": 1036,
	"SoldtoLegalEntity": "Vision Brazil",
	"IssuerLocationId": 300100093494041,
	"PartyTypeIssuerAddress": "Example Co. BR",
	"LETypeIssuerAddress": null,
	"IssuerPartyId": 300100093494032,
	"PartyTypeIssuerName": "Marcopolo",
	"IssuerLegalEntityName": null,
	"IssuerTaxId": 300100166512700,
	"PartyTypeIssuerTaxpayerNumber": "88611835000129",
	"LETypeIssuerTaxpayerNumber": null,
	"IssueDate": "2019-04-10",
	"AcknowledgedDate": "2019-04-10",
	"ReceiverLocationId": 23897,
	"PartyTypeReceiverAddress": null,
	"LETypeReceiverAddress": "Example 1 Co. BR",
	"ReceiverPartyId": 1036,
	"PartyTypeReceiverName": null,
	"ReceiverLegalEntityName": "Vision Brazil",
	"ReceiverTaxId": 12055,
	"PartyTypeReceiverTaxpayerNumber": null,
	"LETypeReceiverTaxpayerNumber": "65100200000161",
	"ShipfromLocationId": 300100093494041,
	"PartyTypeShipfromAddress": "Example Co. BR",
	"LETypeShipfromAddress": null,
	"ShipfromPartyId": 300100093494032,
	"PartyTypeShipfromName": "Marcopolo",
	"ShipfromLegalEntityName": null,
	"ShipfromTaxId": 300100166512700,
	"PartyTypeShipfromTaxpayerNumber": "88611835000129",
	"LETypeShipfromTaxpayerNumber": null,
	"ShiptoLocationId": 23897,
	"PartyTypeShiptoAddress": null,
	"LETypeShiptoAddress": "Example 1 Co. BR",
	"ShiptoPartyId": 1036,
	"PartyTypeShiptoName": null,
	"ShiptoLegalEntityName": "Vision Brazil",
	"ShiptoTaxId": 12055,
	"PartyTypeShiptoTaxpayerNumber": null,
	"LETypeShiptoTaxpayerNumber": "65100200000161",
	"Series": "1",
	"SubSeries": null,
	"TotalAmount": 532,
	"DocumentTypeCode": "REMITTANCE",
	"DocumentType": "Remittance",
	"SourceDocumentTypeCode": "PURCHASE_ORDER",
	"SourceDocumentType": "Purchase order",
	"Usage": "MATERIAL",
	"links": [
	{
		"rel": "self",
		"href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100178959504",
		"name": "inboundFiscalDocuments",
		"kind": "item",
		"properties": {
			"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000678"
		}
	},
	{
		"rel": "canonical",
		"href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100178959504",
		"name": "inboundFiscalDocuments",
		"kind": "item"
	},
	{
		"rel": "child",
		"href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100178959504/child/fiscalDocumentLines",
		"name": "fiscalDocumentLines",
		"kind": "collection"
	}
	]
}

Example 2 cURL Command

Use the following cURL command to submit a request on the REST resourceto get one document by fiscal document number:

curl -u username:password "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments?q=DocumentNumber=310810420191"

Example 2 Response Body

The following shows an example of the response body in JSON format.

{
	"items": [
	{
		"DocumentId": 300100178959504,
		"DocumentNumber": "310810420191",
		"AccessKey": "310810420191",
		"StatusCode": "CAPTURED",
		"Status": "Captured",
		"AssociationId": 100100077234663,
		"FiscalFlow": "Consignment Remittance",
		"ParentDocumentId": null,
		"ParentDocumentNumber": null,
		"CurrencyCode": "BRL",
		"CurrencyName": "Brazilian Real",
		"BilltoBusinessUnitId": 300100052386093,
		"BilltoBusinessUnit": "Vision Brazil",
		"SoldtoLegalEntityId": 1036,
		"SoldtoLegalEntity": "Vision Brazil",
		"IssuerLocationId": 300100093494041,
		"PartyTypeIssuerAddress": "Example Co. BR",
		"LETypeIssuerAddress": null,
		"IssuerPartyId": 300100093494032,
		"PartyTypeIssuerName": "Marcopolo",
		"IssuerLegalEntityName": null,
		"IssuerTaxId": 300100166512700,
		"PartyTypeIssuerTaxpayerNumber": "88611835000129",
		"LETypeIssuerTaxpayerNumber": null,
		"IssueDate": "2019-04-10",
		"AcknowledgedDate": "2019-04-10",
		"ReceiverLocationId": 23897,
		"PartyTypeReceiverAddress": null,
		"LETypeReceiverAddress": "Example 1 Co. BR",
		"ReceiverPartyId": 1036,
		"PartyTypeReceiverName": null,
		"ReceiverLegalEntityName": "Vision Brazil",
		"ReceiverTaxId": 12055,
		"PartyTypeReceiverTaxpayerNumber": null,
		"LETypeReceiverTaxpayerNumber": "65100200000161",
		"ShipfromLocationId": 300100093494041,
		"PartyTypeShipfromAddress": "Example Co. BR",
		"LETypeShipfromAddress": null,
		"ShipfromPartyId": 300100093494032,
		"PartyTypeShipfromName": "Marcopolo",
		"ShipfromLegalEntityName": null,
		"ShipfromTaxId": 300100166512700,
		"PartyTypeShipfromTaxpayerNumber": "88611835000129",
		"LETypeShipfromTaxpayerNumber": null,
		"ShiptoLocationId": 23897,
		"PartyTypeShiptoAddress": null,
		"LETypeShiptoAddress": "Example 1 Co. BR",
		"ShiptoPartyId": 1036,
		"PartyTypeShiptoName": null,
		"ShiptoLegalEntityName": "Vision Brazil",
		"ShiptoTaxId": 12055,
		"PartyTypeShiptoTaxpayerNumber": null,
		"LETypeShiptoTaxpayerNumber": "65100200000161",
		"Series": "1",
		"SubSeries": null,
		"TotalAmount": 532,
		"DocumentTypeCode": "REMITTANCE",
		"DocumentType": "Remittance",
		"SourceDocumentTypeCode": "PURCHASE_ORDER",
		"SourceDocumentType": "Purchase order",
		"Usage": "MATERIAL",
		"links": [
		{
			"rel": "self",
			"href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100178959504",
			"name": "inboundFiscalDocuments",
			"kind": "item",
			"properties": {
				"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000678"
			}
		},
		{
			"rel": "canonical",
			"href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100178959504",
			"name": "inboundFiscalDocuments",
			"kind": "item"
		},
		{
			"rel": "child",
			"href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100178959504/child/fiscalDocumentLines",
			"name": "fiscalDocumentLines",
			"kind": "collection"
		}
		]
	}
	],
	"count": 1,
	"hasMore": false,
	"limit": 25,
	"offset": 0,
	"links": [
	{
		"rel": "self",
		"href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments",
		"name": "inboundFiscalDocuments",
		"kind": "collection"
	}
	]
}

Example 3 cURL Command

Use the following cURL command to submit a request on the REST resourceto get one document by access key:

curl -u username:password "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments?q=AccessKey=310810420191"

Example 3 Response Body

The following shows an example of the response body in JSON format.

{
	"items": [
	{
		"DocumentId": 300100178959504,
		"DocumentNumber": "310810420191",
		"AccessKey": "310810420191",
		"StatusCode": "CAPTURED",
		"Status": "Captured",
		"AssociationId": 100100077234663,
		"FiscalFlow": "Consignment Remittance",
		"ParentDocumentId": null,
		"ParentDocumentNumber": null,
		"CurrencyCode": "BRL",
		"CurrencyName": "Brazilian Real",
		"BilltoBusinessUnitId": 300100052386093,
		"BilltoBusinessUnit": "Vision Brazil",
		"SoldtoLegalEntityId": 1036,
		"SoldtoLegalEntity": "Vision Brazil",
		"IssuerLocationId": 300100093494041,
		"PartyTypeIssuerAddress": "Example Co. BR",
		"LETypeIssuerAddress": null,
		"IssuerPartyId": 300100093494032,
		"PartyTypeIssuerName": "Marcopolo",
		"IssuerLegalEntityName": null,
		"IssuerTaxId": 300100166512700,
		"PartyTypeIssuerTaxpayerNumber": "88611835000129",
		"LETypeIssuerTaxpayerNumber": null,
		"IssueDate": "2019-04-10",
		"AcknowledgedDate": "2019-04-10",
		"ReceiverLocationId": 23897,
		"PartyTypeReceiverAddress": null,
		"LETypeReceiverAddress": "Example 1 Co. BR",
		"ReceiverPartyId": 1036,
		"PartyTypeReceiverName": null,
		"ReceiverLegalEntityName": "Vision Brazil",
		"ReceiverTaxId": 12055,
		"PartyTypeReceiverTaxpayerNumber": null,
		"LETypeReceiverTaxpayerNumber": "65100200000161",
		"ShipfromLocationId": 300100093494041,
		"PartyTypeShipfromAddress": "Example Co. BR",
		"LETypeShipfromAddress": null,
		"ShipfromPartyId": 300100093494032,
		"PartyTypeShipfromName": "Marcopolo",
		"ShipfromLegalEntityName": null,
		"ShipfromTaxId": 300100166512700,
		"PartyTypeShipfromTaxpayerNumber": "88611835000129",
		"LETypeShipfromTaxpayerNumber": null,
		"ShiptoLocationId": 23897,
		"PartyTypeShiptoAddress": null,
		"LETypeShiptoAddress": "Example 1 Co. BR",
		"ShiptoPartyId": 1036,
		"PartyTypeShiptoName": null,
		"ShiptoLegalEntityName": "Vision Brazil",
		"ShiptoTaxId": 12055,
		"PartyTypeShiptoTaxpayerNumber": null,
		"LETypeShiptoTaxpayerNumber": "65100200000161",
		"Series": "1",
		"SubSeries": null,
		"TotalAmount": 532,
		"DocumentTypeCode": "REMITTANCE",
		"DocumentType": "Remittance",
		"SourceDocumentTypeCode": "PURCHASE_ORDER",
		"SourceDocumentType": "Purchase order",
		"Usage": "MATERIAL",
		"links": [
		{
			"rel": "self",
			"href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100178959504",
			"name": "inboundFiscalDocuments",
			"kind": "item",
			"properties": {
				"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000678"
			}
		},
		{
			"rel": "canonical",
			"href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100178959504",
			"name": "inboundFiscalDocuments",
			"kind": "item"
		},
		{
			"rel": "child",
			"href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100178959504/child/fiscalDocumentLines",
			"name": "fiscalDocumentLines",
			"kind": "collection"
		}
		]
	}
	],
	"count": 1,
	"hasMore": false,
	"limit": 25,
	"offset": 0,
	"links": [
	{
		"rel": "self",
		"href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments",
		"name": "inboundFiscalDocuments",
		"kind": "collection"
	}
	]
}

Back to Top