Jump to

• Request
• Response
• Examples

Get all documents

get

/fscmRestApi/resources/11.13.18.05/inboundFiscalDocuments

Request

Query Parameters

• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• finder: string
  Used as a predefined finder to search the collection.
  
  Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables:
  
  

  • PrimaryKey: Finds fiscal documents according to the primary key of fiscal document headers.
    Finder Variables:
    • DocumentId; integer; Value that uniquely identifies the inbound fiscal document.
  • PurchaseOrderBased: Finds fiscal documents according to the Purchase Order source document type.
    Finder Variables:
    • bindIncludeCaptured; string; Contains one of the following values: Y or N. If Y, then the captured documents are part of the result. If N, then the captured documents aren't part of the result. The default value is Y.
  • ReturnMaterialOrderBased: Finds fiscal documents according to the Return Material Authorisation source document type.
    Finder Variables:
  • TransferOrderBased: Finds fiscal documents according to the Internal Requisition source document type.
    Finder Variables:
  • findByBilltoBusinessUnit: Finds fiscal documents according to the search parameters.
    Finder Variables:
    • bindAccessKey; string; Number that identifies the access key of the fiscal document.
    • bindBillToBusinessUnit; string; Name of the bill to business unit of the fiscal document.
    • bindDocumentNumber; string; Number that identifies the fiscal document.
    • bindIncludeCaptured; string; Contains one of the following values: Y or N. If Y, then the captured documents are part of the result. If N, then the captured documents aren't part of the result. The default value is Y.
    • bindInventoryItemNumber; string; Value that identifies the item of a fiscal document line.
    • bindIssuer; string; Name of the issuer of the fiscal document.
    • bindLineSourceDocumentType; string; Type of source of the fiscal document line.
    • bindPOLineNumber; string; Number that identifies the line of source document.
    • bindPONumber; string; Number that identifies the source document.
    • bindPOScheduleNumber; string; Number that identifies the schedule of the source document.
    • bindReceiptNumber; string; Number that identifies the receipt of the fiscal document schedule.
    • bindSalesReturnOrderLine; string; Number that identifies the line of a return order.
    • bindSalesReturnOrderNumber; string; Number that identifies the return order.
    • bindSalesReturnOrderSchedule; string; Number that identifies the schedule of a return order.
    • bindScheduleSourceDocumentType; string; Type of source of the fiscal document schedule.
    • bindShipmentLine; string; Number that identifies the line of a shipment.
    • bindShipmentNumber; string; Number that identifies the shipment.
    • bindSourceDocumentBU; string; Name of the source document business unit of a fiscal document line.
    • bindSourceDocumentType; string; Type of source of the fiscal document.
    • bindStatusCode; string; Code that identifies the status of the inbound fiscal document.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • ASNNumber; string; Advanced shipment notice number associated with the drop ship seller flow.
  • AccessKey; string; Number that identifies the access key of the referenced inbound fiscal document.
  • ConsumptionAdviceNumber; string; Consumption advice reference number associated with the consigned fiscal flow.
  • DocumentId; integer; Value that uniquely identifies the inbound fiscal document.
  • DocumentNumber; string; Number that identifies the inbound fiscal document.
  • DocumentType; string; Type of the fiscal document sent by supplier or party.
  • DocumentTypeCode; string; Code that identifies the type of fiscal document that is sent by the supplier or party for capturing and processing to indicate the business flow it covers.
  • FiscalFlow; string; Name of the fiscal flow that defines the business flow for a fiscal document.
  • IssueDate; string; Date when the fiscal document is issued.
  • SourceDocumentType; string; Type of the source fiscal document.
  • SourceDocumentTypeCode; string; Code that identifies the document type that acts as source for the fiscal document that is captured or created.
  • SourceReferenceDocumentHeaderId; integer; Value that uniquely identifies the reference source document.
  • Status; string; Status of the inbound fiscal document.
  • StatusCode; string; Code that identifies the status of the inbound fiscal document.
  • Usage; string; Code that distinguishes the fiscal document usage.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

Header Parameters

• Metadata-Context:
  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.

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

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/inboundFiscalDocuments-item-response"
            }
        }
    },
    "x-hints":{
        "subgroup":"InventoryManagement",
        "usage":"BusinessObject",
        "group":"SCM"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object inboundFiscalDocuments-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/inboundFiscalDocuments-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-item-response

Type: object

Show Source

• AccessKey: string
  Title: Access Key

  Maximum Length: 64

  Number that identifies the access key of the referenced inbound fiscal document.
• AcknowledgedDate: string (date)
  Title: Acknowledged Date

  Date when the receipt of the fiscal document is acknowledged.
• ASNNumber: string
  Title: ASN Number

  Maximum Length: 80

  Advanced shipment notice number associated with the drop ship seller flow.
• AssociationId: integer (int64)
  Title: Association ID

  Value that uniquely associates the inbound fiscal document with a fiscal document process or type.
• BilltoBusinessUnit: string
  Title: Bill-to BU

  Read Only: true

  Maximum Length: 240

  Name of the business unit that is receiving the fiscal documents.
• BilltoBusinessUnitId: integer (int64)
  Title: Bill-to BU ID

  Value that uniquely identifies the bill to business unit.
• ConsumptionAdviceNumber: string
  Title: Consumption Advice Number

  Maximum Length: 80

  Consumption advice reference number associated with the consigned fiscal flow.
• CurrencyCode: string
  Title: Currency Code

  Maximum Length: 30

  Default Value: BRL

  Code that identifies the currency of the amount.
• CurrencyName: string
  Title: Currency Name

  Read Only: true

  Maximum Length: 80

  Name of the currency of the fiscal document.
• DocumentId: integer (int64)
  Title: Document ID

  Value that uniquely identifies the inbound fiscal document.
• DocumentNumber: string
  Title: Document Number

  Maximum Length: 30

  Number that identifies the inbound fiscal document.
• DocumentType: string
  Title: Document Type

  Maximum Length: 255

  Type of the fiscal document sent by supplier or party.
• DocumentTypeCode: string
  Title: Document Type Code

  Maximum Length: 30

  Code that identifies the type of fiscal document that is sent by the supplier or party for capturing and processing to indicate the business flow it covers.
• fiscalDocumentLines: array Fiscal Document Lines
  Title: Fiscal Document Lines

  The Fiscal Document Lines resource gets the fiscal document lines information. It also allows update of delivered quantity to confirm item deliveries.
• FiscalFlow: string
  Title: Fiscal Flow

  Read Only: true

  Maximum Length: 80

  Name of the fiscal flow that defines the business flow for a fiscal document.
• IssueDate: string (date)
  Title: Issue Date

  Date when the fiscal document is issued.
• IssuerLegalEntityName: string
  Title: Issuer Name

  Read Only: true

  Maximum Length: 240

  Name of the issuer of the fiscal document.
• IssuerLocationId: integer (int64)
  Title: Issuer Location ID

  Value that uniquely identifies the company site location that creates the fiscal document.
• IssuerPartyId: integer (int64)
  Title: Issuer Party ID

  Value that uniquely identifies the company that creates the fiscal document.
• IssuerTaxId: integer (int64)
  Title: Issuer Tax ID

  Value that uniquely identifies the tax of the company that creates the fiscal document.
• LETypeIssuerAddress: string
  Title: Issuer Address

  Read Only: true

  Maximum Length: 3852

  Address of the company that creates the fiscal document.
• LETypeIssuerTaxpayerNumber: string
  Title: Issuer Taxpayer ID

  Read Only: true

  Maximum Length: 14

  Number that identifies the tax payer who is the issuer of the fiscal document.
• LETypeReceiverAddress: string
  Title: Receiver Address

  Read Only: true

  Maximum Length: 3852

  Address of receiver of the fiscal document.
• LETypeReceiverTaxpayerNumber: string
  Title: Receiver Taxpayer ID

  Read Only: true

  Maximum Length: 14

  Number that identifies the tax payer who is the receiver of the fiscal document.
• LETypeShipfromAddress: string
  Title: Ship-from Address

  Read Only: true

  Maximum Length: 3852

  Address of the party from where the goods are being shipped.
• LETypeShipfromTaxpayerNumber: string
  Title: Ship-from Taxpayer ID

  Read Only: true

  Maximum Length: 14

  Number that identifies the taxpayer of the ship-from location of the goods or service.
• LETypeShiptoAddress: string
  Title: Ship-to Address

  Read Only: true

  Maximum Length: 3852

  Address of the party to where the goods are being shipped.
• LETypeShiptoTaxpayerNumber: string
  Title: Ship-to Taxpayer ID

  Read Only: true

  Maximum Length: 14

  Number that identifies the taxpayer of the party to whom the goods are being shipped.
• links: array Links
  Title: Links

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

  Value that uniquely identifies the parent fiscal document header.
• ParentDocumentNumber: string
  Title: Parent Document Number

  Maximum Length: 255

  Number that identifies the referenced fiscal document.
• PartyTypeIssuerAddress: string
  Title: Issuer Address

  Read Only: true

  Maximum Length: 2658

  Address of the company that creates the fiscal document.
• PartyTypeIssuerName: string
  Title: Issuer Name

  Read Only: true

  Maximum Length: 360

  Name of the issuer of the fiscal document.
• PartyTypeIssuerTaxpayerNumber: string
  Title: Issuer Taxpayer ID

  Read Only: true

  Maximum Length: 14

  Number that identifies the tax payer who is the issuer of the fiscal document.
• PartyTypeReceiverAddress: string
  Title: Receiver Address

  Read Only: true

  Maximum Length: 2658

  Address of receiver of the fiscal document.
• PartyTypeReceiverName: string
  Title: Receiver Name

  Read Only: true

  Maximum Length: 360

  Name of the receiver of goods.
• PartyTypeReceiverTaxpayerNumber: string
  Title: Receiver Taxpayer ID

  Read Only: true

  Maximum Length: 14

  Number that identifies the tax payer who is the receiver of the fiscal document.
• PartyTypeShipfromAddress: string
  Title: Ship-from Address

  Read Only: true

  Maximum Length: 2658

  Address of the party from where the goods are being shipped.
• PartyTypeShipfromName: string
  Title: Ship-from Name

  Read Only: true

  Maximum Length: 360

  Name of the party from whom the goods are being shipped.
• PartyTypeShipfromTaxpayerNumber: string
  Title: Ship-from Taxpayer ID

  Read Only: true

  Maximum Length: 14

  Number that identifies the taxpayer of the ship-from location of the goods or service.
• PartyTypeShiptoAddress: string
  Title: Ship-to Address

  Read Only: true

  Maximum Length: 2658

  Address of the party to where the goods are being shipped.
• PartyTypeShiptoName: string
  Title: Ship-to Name

  Read Only: true

  Maximum Length: 360

  Name of the party to whom the goods are being shipped.
• PartyTypeShiptoTaxpayerNumber: string
  Title: Ship-to Taxpayer ID

  Read Only: true

  Maximum Length: 14

  Number that identifies the taxpayer of the party to whom the goods are being shipped.
• ReceiverLegalEntityName: string
  Title: Receiver Name

  Read Only: true

  Maximum Length: 240

  Name of the receiver of items.
• ReceiverLocationId: integer (int64)
  Title: Receiver Location ID

  Value that uniquely identifies the company site location that receives the fiscal document.
• ReceiverPartyId: integer (int64)
  Title: Receiver Party ID

  Value that uniquely identifies the company that receives the fiscal document.
• ReceiverTaxId: integer (int64)
  Title: Receiver Tax ID

  Value that uniquely identifies the tax of the company that creates the fiscal document.
• Series: string
  Title: Series

  Maximum Length: 10

  Series of the fiscal document.
• ShipfromLegalEntityName: string
  Title: Ship-from Name

  Read Only: true

  Maximum Length: 240

  Name of the party from whom the goods are being shipped.
• ShipfromLocationId: integer (int64)
  Title: Ship-from Location ID

  Value that uniquely identifies the company site location that ships the goods.
• ShipfromPartyId: integer (int64)
  Title: Ship-from Party ID

  Value that uniquely identifies the company that ships the goods.
• ShipfromTaxId: integer (int64)
  Title: Ship-from Tax ID

  Value that uniquely identifies the tax of the third party from whom the goods are being shipped.
• ShiptoLegalEntityName: string
  Title: Ship-to Name

  Read Only: true

  Maximum Length: 240

  Name of the party to whom the goods are being shipped.
• ShiptoLocationId: integer (int64)
  Title: Ship-to Location ID

  Value that uniquely identifies the company site location that receives the goods.
• ShiptoPartyId: integer (int64)
  Title: Ship-to Party ID

  Value that uniquely identifies the company that receives the goods.
• ShiptoTaxId: integer (int64)
  Title: Ship-to Tax ID

  Value that uniquely identifies the taxpayer of the third-party to whom the goods are being shipped.
• SoldtoLegalEntity: string
  Title: Sold-to Legal Entity

  Read Only: true

  Maximum Length: 240

  Legal entity that pays for the goods.
• SoldtoLegalEntityId: integer (int64)
  Title: Sold-to Legal Entity ID

  Value that uniquely identifies the sold to legal entity. This attribute indicates the party that is financially responsible for the purchases.
• SourceDocumentType: string
  Title: Source Document Type

  Maximum Length: 255

  Type of the source fiscal document.
• SourceDocumentTypeCode: string
  Title: Source Document Type Code

  Maximum Length: 30

  Code that identifies the document type that acts as source for the fiscal document that is captured or created.
• SourceReferenceDocumentHeaderId: integer (int64)
  Value that uniquely identifies the reference source document.
• Status: string
  Title: Status

  Maximum Length: 255

  Status of the inbound fiscal document.
• StatusCode: string
  Title: Status Code

  Maximum Length: 30

  Default Value: NEW

  Code that identifies the status of the inbound fiscal document.
• SubSeries: string
  Title: Subseries

  Maximum Length: 10

  Subseries of the fiscal document.
• TotalAmount: number
  Title: Total Amount

  Amount on the fiscal document header.
• Usage: string
  Read Only: true

  Maximum Length: 30

  Code that distinguishes the fiscal document usage.

{
    "type":"object",
    "properties":{
        "ShipfromTaxId":{
            "title":"Ship-from Tax ID",
            "type":"integer",
            "description":"Value that uniquely identifies the tax of the third party from whom the goods are being shipped.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "ASNNumber":{
            "title":"ASN Number",
            "maxLength":"80",
            "type":"string",
            "description":"Advanced shipment notice number associated with the drop ship seller flow.",
            "nullable":true,
            "x-queryable":true
        },
        "LETypeShipfromTaxpayerNumber":{
            "title":"Ship-from Taxpayer ID",
            "maxLength":"14",
            "type":"string",
            "description":"Number that identifies the taxpayer of the ship-from location of the goods or service.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "AssociationCode"
                ]
            }
        },
        "BilltoBusinessUnit":{
            "title":"Bill-to BU",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the business unit that is receiving the fiscal documents.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "LETypeIssuerTaxpayerNumber":{
            "title":"Issuer Taxpayer ID",
            "maxLength":"14",
            "type":"string",
            "description":"Number that identifies the tax payer who is the issuer of the fiscal document.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "AssociationCode"
                ]
            }
        },
        "ShiptoLegalEntityName":{
            "title":"Ship-to Name",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the party to whom the goods are being shipped.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "BilltoBusinessUnitId":{
            "title":"Bill-to BU ID",
            "type":"integer",
            "description":"Value that uniquely identifies the bill to business unit.",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "PartyTypeIssuerAddress":{
            "title":"Issuer Address",
            "maxLength":"2658",
            "type":"string",
            "description":"Address of the company that creates the fiscal document.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "DocumentId":{
            "title":"Document ID",
            "type":"integer",
            "description":"Value that uniquely identifies the inbound fiscal document.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "LETypeShiptoTaxpayerNumber":{
            "title":"Ship-to Taxpayer ID",
            "maxLength":"14",
            "type":"string",
            "description":"Number that identifies the taxpayer of the party to whom the goods are being shipped.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "AssociationCode"
                ]
            }
        },
        "StatusCode":{
            "title":"Status Code",
            "maxLength":"30",
            "type":"string",
            "description":"Code that identifies the status of the inbound fiscal document.",
            "nullable":false,
            "default":"NEW",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PartyTypeReceiverTaxpayerNumber":{
            "title":"Receiver Taxpayer ID",
            "maxLength":"14",
            "type":"string",
            "description":"Number that identifies the tax payer who is the receiver of the fiscal document.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "AssociationCode"
                ]
            }
        },
        "CurrencyCode":{
            "title":"Currency Code",
            "maxLength":"30",
            "type":"string",
            "description":"Code that identifies the currency of the amount.",
            "nullable":false,
            "default":"BRL",
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ParentDocumentNumber":{
            "title":"Parent Document Number",
            "maxLength":"255",
            "type":"string",
            "description":"Number that identifies the referenced fiscal document.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "ShiptoTaxId":{
            "title":"Ship-to Tax ID",
            "type":"integer",
            "description":"Value that uniquely identifies the taxpayer of the third-party to whom the goods are being shipped.",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "SubSeries":{
            "title":"Subseries",
            "maxLength":"10",
            "type":"string",
            "description":"Subseries of the fiscal document.",
            "nullable":true,
            "x-queryable":false
        },
        "SourceDocumentType":{
            "title":"Source Document Type",
            "maxLength":"255",
            "type":"string",
            "description":"Type of the source fiscal document.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "IssuerLegalEntityName":{
            "title":"Issuer Name",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the issuer of the fiscal document.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "Status":{
            "title":"Status",
            "maxLength":"255",
            "type":"string",
            "description":"Status of the inbound fiscal document.",
            "nullable":true,
            "x-queryable":true
        },
        "ShipfromLocationId":{
            "title":"Ship-from Location ID",
            "type":"integer",
            "description":"Value that uniquely identifies the company site location that ships the goods.",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "ReceiverLocationId":{
            "title":"Receiver Location ID",
            "type":"integer",
            "description":"Value that uniquely identifies the company site location that receives the fiscal document.",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "SourceReferenceDocumentHeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the reference source document.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PartyTypeShiptoName":{
            "title":"Ship-to Name",
            "maxLength":"360",
            "type":"string",
            "description":"Name of the party to whom the goods are being shipped.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "PartyTypeReceiverName":{
            "title":"Receiver Name",
            "maxLength":"360",
            "type":"string",
            "description":"Name of the receiver of goods.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "PartyTypeShiptoTaxpayerNumber":{
            "title":"Ship-to Taxpayer ID",
            "maxLength":"14",
            "type":"string",
            "description":"Number that identifies the taxpayer of the party to whom the goods are being shipped.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "AssociationCode"
                ]
            }
        },
        "fiscalDocumentLines":{
            "title":"Fiscal Document Lines",
            "type":"array",
            "description":"The Fiscal Document Lines resource gets the fiscal document lines information. It also allows update of delivered quantity to confirm item deliveries.",
            "items":{
                "$ref":"#/components/schemas/inboundFiscalDocuments-fiscalDocumentLines-item-response"
            }
        },
        "ShipfromPartyId":{
            "title":"Ship-from Party ID",
            "type":"integer",
            "description":"Value that uniquely identifies the company that ships the goods.",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "SourceDocumentTypeCode":{
            "title":"Source Document Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"Code that identifies the document type that acts as source for the fiscal document that is captured or created.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PartyTypeShipfromTaxpayerNumber":{
            "title":"Ship-from Taxpayer ID",
            "maxLength":"14",
            "type":"string",
            "description":"Number that identifies the taxpayer of the ship-from location of the goods or service.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "AssociationCode"
                ]
            }
        },
        "LETypeShiptoAddress":{
            "title":"Ship-to Address",
            "maxLength":"3852",
            "type":"string",
            "description":"Address of the party to where the goods are being shipped.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "IssuerPartyId":{
            "title":"Issuer Party ID",
            "type":"integer",
            "description":"Value that uniquely identifies the company that creates the fiscal document.",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "LETypeReceiverAddress":{
            "title":"Receiver Address",
            "maxLength":"3852",
            "type":"string",
            "description":"Address of receiver of the fiscal document.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "IssuerLocationId":{
            "title":"Issuer Location ID",
            "type":"integer",
            "description":"Value that uniquely identifies the company site location that creates the fiscal document.",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "ConsumptionAdviceNumber":{
            "title":"Consumption Advice Number",
            "maxLength":"80",
            "type":"string",
            "description":"Consumption advice reference number associated with the consigned fiscal flow.",
            "nullable":true,
            "x-queryable":true
        },
        "FiscalFlow":{
            "title":"Fiscal Flow",
            "maxLength":"80",
            "type":"string",
            "description":"Name of the fiscal flow that defines the business flow for a fiscal document.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "SoldtoLegalEntity":{
            "title":"Sold-to Legal Entity",
            "maxLength":"240",
            "type":"string",
            "description":"Legal entity that pays for the goods.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "LETypeReceiverTaxpayerNumber":{
            "title":"Receiver Taxpayer ID",
            "maxLength":"14",
            "type":"string",
            "description":"Number that identifies the tax payer who is the receiver of the fiscal document.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "AssociationCode"
                ]
            }
        },
        "ReceiverLegalEntityName":{
            "title":"Receiver Name",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the receiver of items.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "LETypeIssuerAddress":{
            "title":"Issuer Address",
            "maxLength":"3852",
            "type":"string",
            "description":"Address of the company that creates the fiscal document.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PartyTypeIssuerTaxpayerNumber":{
            "title":"Issuer Taxpayer ID",
            "maxLength":"14",
            "type":"string",
            "description":"Number that identifies the tax payer who is the issuer of the fiscal document.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "AssociationCode",
                    "BilltoBusinessUnitId"
                ]
            }
        },
        "IssuerTaxId":{
            "title":"Issuer Tax ID",
            "type":"integer",
            "description":"Value that uniquely identifies the tax of the company that creates the fiscal document.",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "PartyTypeShiptoAddress":{
            "title":"Ship-to Address",
            "maxLength":"2658",
            "type":"string",
            "description":"Address of the party to where the goods are being shipped.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PartyTypeShipfromAddress":{
            "title":"Ship-from Address",
            "maxLength":"2658",
            "type":"string",
            "description":"Address of the party from where the goods are being shipped.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PartyTypeIssuerName":{
            "title":"Issuer Name",
            "maxLength":"360",
            "type":"string",
            "description":"Name of the issuer of the fiscal document.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ReceiverTaxId":{
            "title":"Receiver Tax ID",
            "type":"integer",
            "description":"Value that uniquely identifies the tax of the company that creates the fiscal document.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "DocumentTypeCode":{
            "title":"Document Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"Code that identifies the type of fiscal document that is sent by the supplier or party for capturing and processing to indicate the business flow it covers.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AccessKey":{
            "title":"Access Key",
            "maxLength":"64",
            "type":"string",
            "description":"Number that identifies the access key of the referenced inbound fiscal document.",
            "nullable":true,
            "x-queryable":true
        },
        "PartyTypeShipfromName":{
            "title":"Ship-from Name",
            "maxLength":"360",
            "type":"string",
            "description":"Name of the party from whom the goods are being shipped.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ShipfromLegalEntityName":{
            "title":"Ship-from Name",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the party from whom the goods are being shipped.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "Usage":{
            "maxLength":"30",
            "type":"string",
            "description":"Code that distinguishes the fiscal document usage.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ParentDocumentId":{
            "title":"Parent Document ID",
            "type":"integer",
            "description":"Value that uniquely identifies the parent fiscal document header.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "precision":"18"
            }
        },
        "ShiptoPartyId":{
            "title":"Ship-to Party ID",
            "type":"integer",
            "description":"Value that uniquely identifies the company that receives the goods.",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "PartyTypeReceiverAddress":{
            "title":"Receiver Address",
            "maxLength":"2658",
            "type":"string",
            "description":"Address of receiver of the fiscal document.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "IssueDate":{
            "title":"Issue Date",
            "type":"string",
            "description":"Date when the fiscal document is issued.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "DocumentType":{
            "title":"Document Type",
            "maxLength":"255",
            "type":"string",
            "description":"Type of the fiscal document sent by supplier or party.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "TotalAmount":{
            "title":"Total Amount",
            "type":"number",
            "description":"Amount on the fiscal document header.",
            "nullable":false,
            "x-queryable":false
        },
        "DocumentNumber":{
            "title":"Document Number",
            "maxLength":"30",
            "type":"string",
            "description":"Number that identifies the inbound fiscal document.",
            "nullable":false,
            "x-queryable":true
        },
        "CurrencyName":{
            "title":"Currency Name",
            "maxLength":"80",
            "type":"string",
            "description":"Name of the currency of the fiscal document.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "AcknowledgedDate":{
            "title":"Acknowledged Date",
            "type":"string",
            "description":"Date when the receipt of the fiscal document is acknowledged.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "Series":{
            "title":"Series",
            "maxLength":"10",
            "type":"string",
            "description":"Series of the fiscal document.",
            "nullable":true,
            "x-queryable":false
        },
        "SoldtoLegalEntityId":{
            "title":"Sold-to Legal Entity ID",
            "type":"integer",
            "description":"Value that uniquely identifies the sold to legal entity. This attribute indicates the party that is financially responsible for the purchases.",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "AssociationId":{
            "title":"Association ID",
            "type":"integer",
            "description":"Value that uniquely associates the inbound fiscal document with a fiscal document process or type.",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "ShiptoLocationId":{
            "title":"Ship-to Location ID",
            "type":"integer",
            "description":"Value that uniquely identifies the company site location that receives the goods.",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "LETypeShipfromAddress":{
            "title":"Ship-from Address",
            "maxLength":"3852",
            "type":"string",
            "description":"Address of the party from where the goods are being shipped.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ReceiverPartyId":{
            "title":"Receiver Party ID",
            "type":"integer",
            "description":"Value that uniquely identifies the company that receives the fiscal document.",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        }
    }
}

Nested Schema : Fiscal Document Lines

Type: array

Title: Fiscal Document Lines

The Fiscal Document Lines resource gets the fiscal document lines information. It also allows update of delivered quantity to confirm item deliveries.

Show Source

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

{
    "title":"Fiscal Document Lines",
    "type":"array",
    "description":"The Fiscal Document Lines resource gets the fiscal document lines information. It also allows update of delivered quantity to confirm item deliveries.",
    "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

  Amount on the fiscal document item line.
• ChargesAmount: number
  Title: Charges

  Read Only: true

  Unit price of goods or services.
• DocumentId: integer (int64)
  Title: Document ID

  Read Only: true

  Value that uniquely identifies the inbound fiscal document.
• ExternalItem: string
  Title: External Item

  Read Only: true

  Maximum Length: 300

  Indicates the name of the item given on the fiscal document sent by the issuer.
• ExternalItemDescription: string
  Title: Description

  Read Only: true

  Maximum Length: 250

  Indicates the description of the item given on the fiscal document sent by the issuer.
• FciControlNumber: string
  Title: FCI Number

  Read Only: true

  Maximum Length: 36

  Displays the FCI Number for imported products that are subject to industrial processing on the fiscal document line.
• fiscalDocumentSchedules: array Fiscal Document Schedules
  Title: Fiscal Document Schedules

  The Fiscal Document Schedules resource gets the schedule information of the fiscal document.
• InventoryItemDescription: string
  Title: Item Description

  Read Only: true

  Description of the item on the fiscal document line.
• InventoryItemId: integer (int64)
  Title: Item ID

  Read Only: true

  Value that uniquely identifies the item.
• InventoryItemNumber: string
  Title: Item Code

  Read Only: true

  Maximum Length: 80

  Number that identifies the item on the fiscal document line.
• LineId: integer (int64)
  Title: Document Line ID

  Read Only: true

  Value that uniquely identifies the fiscal document line.
• LineNumber: number
  Title: Line Number

  Read Only: true

  Number that identifies the line of the fiscal document item.
• LineSourceDocumentType: string
  Title: Source Document Type

  Read Only: true

  Maximum Length: 255

  Type of the fiscal document sent by supplier or party.
• LineSourceDocumentTypeCode: string
  Title: Source Document Type Code

  Read Only: true

  Maximum Length: 30

  Code that identifies the document type that acts as source for the fiscal document that is captured or created.
• LineStatus: string
  Title: Status Code

  Read Only: true

  Maximum Length: 30

  Default Value: NEW

  Status of the item line. This value is generated by the application.
• links: array Links
  Title: Links

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

  Read Only: true

  Date when goods or service are physically received.
• PhysicalReceiptQuantity: number
  Title: Delivered Quantity

  Quantity that was physically received.
• Price: number
  Title: Unit Price

  Read Only: true

  Unit price of goods or services.
• Quantity: number
  Title: Quantity

  Read Only: true

  Quantity on the fiscal document line.
• SecondaryQuantity: number
  Title: Secondary Quantity

  Indicates the quantity in the secondary unit of measure for a dual-UOM-controlled item.
• SecondaryUOMCode: string
  Title: Secondary UOM

  Read Only: true

  Maximum Length: 30

  Indicates the UOM code of the alternative unit of measure that's allowed to quantify a dual-UOM-controlled item.
• SecondaryUOMName: string
  Title: Secondary UOM

  Read Only: true

  Maximum Length: 25

  Indicates the alternative unit of measure that's allowed to quantify a dual-UOM-controlled item.
• SourceDocumentBUId: integer (int64)
  Title: Source Document BU ID

  Read Only: true

  Value that uniquely identifies the source document business unit.
• SourceDocumentBUName: string
  Title: Source Document BU

  Read Only: true

  Maximum Length: 255

  Name of the business unit for the source document. Valid values are Procurement BU, Requisition BU, or Receivable BU.
• Status: string
  Title: Status

  Maximum Length: 30

  Status of the fiscal document line.
• Type: string
  Title: Line Type

  Read Only: true

  Maximum Length: 255

  Type of line on the fiscal document.
• TypeCode: string
  Title: Type Code

  Read Only: true

  Maximum Length: 30

  Code that identifies the type of line on the fiscal document.
• UOMCode: string
  Title: UOM Code

  Read Only: true

  Maximum Length: 30

  Code that identifies the unit of measure of the item quantity that was physically received.
• UOMName: string
  Title: UOM Name

  Read Only: true

  Maximum Length: 25

  Name of the base unit of measure to be used where allocation basis is quantity, weight, or volume.

{
    "type":"object",
    "properties":{
        "DocumentId":{
            "title":"Document ID",
            "type":"integer",
            "description":"Value that uniquely identifies the inbound fiscal document.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PhysicalReceiptDate":{
            "title":"Physical Receipt Date",
            "type":"string",
            "description":"Date when goods or service are physically received.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LineNumber":{
            "title":"Line Number",
            "type":"number",
            "description":"Number that identifies the line of the fiscal document item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "LineSourceDocumentTypeCode":{
            "title":"Source Document Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"Code that identifies the document type that acts as source for the fiscal document that is captured or created.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LineStatus":{
            "title":"Status Code",
            "maxLength":"30",
            "type":"string",
            "description":"Status of the item line. This value is generated by the application.",
            "nullable":true,
            "readOnly":true,
            "default":"NEW",
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ExternalItemDescription":{
            "title":"Description",
            "maxLength":"250",
            "type":"string",
            "description":"Indicates the description of the item given on the fiscal document sent by the issuer.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InventoryItemDescription":{
            "title":"Item Description",
            "type":"string",
            "description":"Description of the item on the fiscal document line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "SourceDocumentBUName":{
            "title":"Source Document BU",
            "maxLength":"255",
            "type":"string",
            "description":"Name of the business unit for the source document. Valid values are Procurement BU, Requisition BU, or Receivable BU.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "SecondaryUOMCode":{
            "title":"Secondary UOM",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the UOM code of the alternative unit of measure that's allowed to quantify a dual-UOM-controlled item.",
            "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"
            }
        },
        "LineSourceDocumentType":{
            "title":"Source Document Type",
            "maxLength":"255",
            "type":"string",
            "description":"Type of the fiscal document sent by supplier or party.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UOMCode":{
            "title":"UOM Code",
            "maxLength":"30",
            "type":"string",
            "description":"Code that identifies the unit of measure of the item quantity that was physically received.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "InventoryItemNumber":{
            "title":"Item Code",
            "maxLength":"80",
            "type":"string",
            "description":"Number that identifies the item on the fiscal document line.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Status":{
            "title":"Status",
            "maxLength":"30",
            "type":"string",
            "description":"Status of the fiscal document line.",
            "nullable":true,
            "x-queryable":false
        },
        "fiscalDocumentSchedules":{
            "title":"Fiscal Document Schedules",
            "type":"array",
            "description":"The Fiscal Document Schedules resource gets the schedule information of the fiscal document.",
            "items":{
                "$ref":"#/components/schemas/inboundFiscalDocuments-fiscalDocumentLines-fiscalDocumentSchedules-item-response"
            }
        },
        "LineId":{
            "title":"Document Line ID",
            "type":"integer",
            "description":"Value that uniquely identifies the fiscal document line.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "TypeCode":{
            "title":"Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"Code that identifies the type of line on the fiscal document.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "InventoryItemId":{
            "title":"Item ID",
            "type":"integer",
            "description":"Value that uniquely identifies the item.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Amount":{
            "title":"Amount",
            "type":"number",
            "description":"Amount on the fiscal document item line.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "PhysicalReceiptQuantity":{
            "title":"Delivered Quantity",
            "type":"number",
            "description":"Quantity that was physically received.",
            "nullable":true,
            "x-queryable":false
        },
        "Quantity":{
            "title":"Quantity",
            "type":"number",
            "description":"Quantity on the fiscal document line.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ChargesAmount":{
            "title":"Charges",
            "type":"number",
            "description":"Unit price of goods or services.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "Type":{
            "title":"Line Type",
            "maxLength":"255",
            "type":"string",
            "description":"Type of line on the fiscal document.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SecondaryUOMName":{
            "title":"Secondary UOM",
            "maxLength":"25",
            "type":"string",
            "description":"Indicates the alternative unit of measure that's allowed to quantify a dual-UOM-controlled item.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"edit"
            },
            "x-queryable":true
        },
        "SecondaryQuantity":{
            "title":"Secondary Quantity",
            "type":"number",
            "description":"Indicates the quantity in the secondary unit of measure for a dual-UOM-controlled item.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "PhysicalReceiptQuantity"
                ]
            }
        },
        "ExternalItem":{
            "title":"External Item",
            "maxLength":"300",
            "type":"string",
            "description":"Indicates the name of the item given on the fiscal document sent by the issuer.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Price":{
            "title":"Unit Price",
            "type":"number",
            "description":"Unit price of goods or services.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "FciControlNumber":{
            "title":"FCI Number",
            "maxLength":"36",
            "type":"string",
            "description":"Displays the FCI Number for imported products that are subject to industrial processing on the fiscal document line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceDocumentBUId":{
            "title":"Source Document BU ID",
            "type":"integer",
            "description":"Value that uniquely identifies the source document business unit.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "UOMName":{
            "title":"UOM Name",
            "maxLength":"25",
            "type":"string",
            "description":"Name of the base unit of measure to be used where allocation basis is quantity, weight, or volume.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        }
    }
}

Nested Schema : Fiscal Document Schedules

Type: array

Title: Fiscal Document Schedules

The Fiscal Document Schedules resource gets the schedule information of the fiscal document.

Show Source

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

{
    "title":"Fiscal Document Schedules",
    "type":"array",
    "description":"The Fiscal Document Schedules resource gets the schedule information of the fiscal document.",
    "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

  Allocated quantity on the fiscal document schedule.
• AllocatedQuantityInFiscalDocumentLineUOM: number
  Title: Allocated Quantity

  Source document quantity allocated on a fiscal document schedule in the fiscal document unit of measure of the item line.
• AllocatedQuantityInSecondaryUOM: number
  Title: Secondary Quantity

  Source document quantity allocated on a fiscal document schedule in the secondary unit of measure of the item.
• ASNLineNumber: string
  Title: ASN Line Number

  Maximum Length: 80

  Advanced shipment notice line associated with the drop ship seller flow.
• ConsumptionAdviceLine: string
  Title: Consumption Advice Line Number

  Maximum Length: 80

  Consumption advice line number associated with the consigned fiscal flow.
• DocumentId: integer (int64)
  Title: Document ID

  Value that uniquely identifies the inbound fiscal document.
• ItemDescription: string
  Title: Description

  Read Only: true

  Maximum Length: 240

  Indicates the description of the item.
• LineId: integer (int64)
  Title: Document Line ID

  Value that uniquely identifies the fiscal document line.
• links: array Links
  Title: Links

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

  Read Only: true

  Number that identifies the line of the purchase order.
• PONumber: string
  Title: PO Number

  Read Only: true

  Maximum Length: 30

  Number that identifies the purchase order.
• POScheduleNumber: number
  Title: PO Schedule Number

  Read Only: true

  Number that identifies the schedule of the purchase order.
• PricingUOMCode: string
  Title: Pricing UOM

  Read Only: true

  Maximum Length: 3

  Indicates the UOM code in which the price of the item in the source document is shown.
• PricingUOMName: string
  Title: Pricing UOM

  Read Only: true

  Maximum Length: 255

  Indicates the unit of measure in which the price of the item in the source document is shown.
• PromisedDate: string (date-time)
  Title: Promised Delivery Date

  Read Only: true

  Date when the materials are promised to be delivered.
• ReceiptLineNumber: integer
  Title: Receipt Line

  Line number of the physical receipt.
• ReceiptNumber: string
  Title: Receipt Number

  Maximum Length: 30

  Number that identifies the purchase order receipt.
• SalesReturnOrderLine: string
  Title: Sales Return Order Line

  Maximum Length: 30

  Number that identifies the line of a return order.
• SalesReturnOrderNumber: string
  Title: Sales Return Order Number

  Maximum Length: 30

  Number that identifies the return order.
• SalesReturnOrderSchedule: string
  Title: Sales Return Order Schedule

  Maximum Length: 30

  Number that identifies the schedule of a return order.
• ScheduleId: integer (int64)
  Title: Schedule ID

  Value that uniquely identifies the fiscal document schedule.
• ScheduleNumber: number
  Title: Schedule Number

  Number that identifies the schedule of the fiscal document item line.
• SecondaryUOMCode: string
  Title: Secondary UOM

  Maximum Length: 30

  Indicates the UOM code of the alternative unit of measure that's allowed to quantify a dual-UOM-controlled item.
• SecondaryUOMName: string
  Title: Secondary UOM

  Read Only: true

  Maximum Length: 25

  Indicates the alternative unit of measure that's allowed to quantify a dual-UOM-controlled item.
• ShipmentLine: string
  Title: Shipment Line

  Maximum Length: 30

  Number that identifies the line of a shipment.
• ShipmentNumber: string
  Title: Shipment Number

  Maximum Length: 30

  Number that identifies the shipment.
• SourceDocumentCurrencyCode: string
  Title: Source Document Currency Code

  Maximum Length: 30

  Code that identifies the currency of the source document.
• SourceDocumentCurrencyName: string
  Title: Source Document Currency

  Read Only: true

  Maximum Length: 255

  Name of the currency of the item that is taken from the source document.
• SourceDocumentId: integer (int64)
  Title: Source Document ID

  Value that uniquely identifies the source document of the schedule.
• SourceDocumentLineId: integer (int64)
  Title: Source Document Line ID

  Value that uniquely identifies the source document line of the schedule.
• SourceDocumentPrice: number
  Title: Source Document Price

  Price of the item that is taken from the source document.
• SourceDocumentScheduleId: integer (int64)
  Title: Source Document Schedule ID

  Value that uniquely identifies the source document schedule of the schedule.
• SourceDocumentType: string
  Title: Source Document Type

  Read Only: true

  Maximum Length: 255

  Type of document for which the fiscal document is captured or created.
• SourceDocumentTypeCode: string
  Title: Source Document Type Code

  Maximum Length: 30

  Default Value: PURCHASE_ORDER

  Code that identifies the document type that acts as source for the fiscal document that is captured or created.
• SourceDocumentUOMCode: string
  Title: Source Document UOM Code

  Maximum Length: 30

  Code that identifies the unit of measure of the source document.
• SourceDocumentUOMName: string
  Title: Source Document UOM

  Read Only: true

  Maximum Length: 255

  Name of the unit of measure of the source document.
• SourceReferenceDocumentLineId: integer (int64)
  Value that uniquely identifies the reference source document line.
• SupplierItem: string
  Title: Supplier Item

  Read Only: true

  Maximum Length: 300

  Indicates the supplier's identification number or code for the goods ordered on the source document order line.

{
    "type":"object",
    "properties":{
        "PONumber":{
            "title":"PO Number",
            "maxLength":"30",
            "type":"string",
            "description":"Number that identifies the purchase order.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "PricingUOMName":{
            "title":"Pricing UOM",
            "maxLength":"255",
            "type":"string",
            "description":"Indicates the unit of measure in which the price of the item in the source document is shown.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceDocumentCurrencyCode":{
            "title":"Source Document Currency Code",
            "maxLength":"30",
            "type":"string",
            "description":"Code that identifies the currency of the source document.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceDocumentUOMCode":{
            "title":"Source Document UOM Code",
            "maxLength":"30",
            "type":"string",
            "description":"Code that identifies the unit of measure of the source document.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "ShipmentNumber":{
            "title":"Shipment Number",
            "maxLength":"30",
            "type":"string",
            "description":"Number that identifies the shipment.",
            "nullable":true,
            "x-queryable":true
        },
        "DocumentId":{
            "title":"Document ID",
            "type":"integer",
            "description":"Value that uniquely identifies the inbound fiscal document.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ShipmentLine":{
            "title":"Shipment Line",
            "maxLength":"30",
            "type":"string",
            "description":"Number that identifies the line of a shipment.",
            "nullable":true,
            "x-queryable":true
        },
        "ItemDescription":{
            "title":"Description",
            "maxLength":"240",
            "type":"string",
            "description":"Indicates the description of the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PromisedDate":{
            "title":"Promised Delivery Date",
            "type":"string",
            "description":"Date when the materials are promised to be delivered.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceDocumentPrice":{
            "title":"Source Document Price",
            "type":"number",
            "description":"Price of the item that is taken from the source document.",
            "nullable":true,
            "x-queryable":true
        },
        "ReceiptLineNumber":{
            "title":"Receipt Line",
            "type":"integer",
            "description":"Line number of the physical receipt.",
            "nullable":true,
            "x-queryable":true
        },
        "POScheduleNumber":{
            "title":"PO Schedule Number",
            "type":"number",
            "description":"Number that identifies the schedule of the purchase order.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "AllocatedQuantityInFiscalDocumentLineUOM":{
            "title":"Allocated Quantity",
            "type":"number",
            "description":"Source document quantity allocated on a fiscal document schedule in the fiscal document unit of measure of the item line.",
            "nullable":true,
            "x-queryable":true
        },
        "ConsumptionAdviceLine":{
            "title":"Consumption Advice Line Number",
            "maxLength":"80",
            "type":"string",
            "description":"Consumption advice line number associated with the consigned fiscal flow.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceDocumentType":{
            "title":"Source Document Type",
            "maxLength":"255",
            "type":"string",
            "description":"Type of document for which the fiscal document is captured or created.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SecondaryUOMCode":{
            "title":"Secondary UOM",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the UOM code of the alternative unit of measure that's allowed to quantify a dual-UOM-controlled item.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SourceDocumentLineId":{
            "title":"Source Document Line ID",
            "type":"integer",
            "description":"Value that uniquely identifies the source document line of the schedule.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ReceiptNumber":{
            "title":"Receipt Number",
            "maxLength":"30",
            "type":"string",
            "description":"Number that identifies the purchase order receipt.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceDocumentId":{
            "title":"Source Document ID",
            "type":"integer",
            "description":"Value that uniquely identifies the source document of the schedule.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AllocatedQuantityInSecondaryUOM":{
            "title":"Secondary Quantity",
            "type":"number",
            "description":"Source document quantity allocated on a fiscal document schedule in the secondary unit of measure of the item.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "SecondaryUOMCode"
                ]
            },
            "x-queryable":true
        },
        "ScheduleNumber":{
            "title":"Schedule Number",
            "type":"number",
            "description":"Number that identifies the schedule of the fiscal document item line.",
            "nullable":true,
            "x-queryable":true
        },
        "LineId":{
            "title":"Document Line ID",
            "type":"integer",
            "description":"Value that uniquely identifies the fiscal document line.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ASNLineNumber":{
            "title":"ASN Line Number",
            "maxLength":"80",
            "type":"string",
            "description":"Advanced shipment notice line associated with the drop ship seller flow.",
            "nullable":true,
            "x-queryable":true
        },
        "AllocatedQuantity":{
            "title":"Allocated Quantity",
            "type":"number",
            "description":"Allocated quantity on the fiscal document schedule.",
            "nullable":false,
            "x-queryable":true
        },
        "PricingUOMCode":{
            "title":"Pricing UOM",
            "maxLength":"3",
            "type":"string",
            "description":"Indicates the UOM code in which the price of the item in the source document is shown.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceDocumentCurrencyName":{
            "title":"Source Document Currency",
            "maxLength":"255",
            "type":"string",
            "description":"Name of the currency of the item that is taken from the source document.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ScheduleId":{
            "title":"Schedule ID",
            "type":"integer",
            "description":"Value that uniquely identifies the fiscal document schedule.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "SourceReferenceDocumentLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the reference source document line.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SourceDocumentScheduleId":{
            "title":"Source Document Schedule ID",
            "type":"integer",
            "description":"Value that uniquely identifies the source document schedule of the schedule.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SecondaryUOMName":{
            "title":"Secondary UOM",
            "maxLength":"25",
            "type":"string",
            "description":"Indicates the alternative unit of measure that's allowed to quantify a dual-UOM-controlled item.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"edit"
            },
            "x-queryable":true
        },
        "SourceDocumentTypeCode":{
            "title":"Source Document Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"Code that identifies the document type that acts as source for the fiscal document that is captured or created.",
            "nullable":false,
            "default":"PURCHASE_ORDER",
            "x-queryable":true
        },
        "SalesReturnOrderLine":{
            "title":"Sales Return Order Line",
            "maxLength":"30",
            "type":"string",
            "description":"Number that identifies the line of a return order.",
            "nullable":true,
            "x-queryable":true
        },
        "POLineNumber":{
            "title":"PO Line Number",
            "type":"number",
            "description":"Number that identifies the line of the purchase order.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "SalesReturnOrderSchedule":{
            "title":"Sales Return Order Schedule",
            "maxLength":"30",
            "type":"string",
            "description":"Number that identifies the schedule of a return order.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceDocumentUOMName":{
            "title":"Source Document UOM",
            "maxLength":"255",
            "type":"string",
            "description":"Name of the unit of measure of the source document.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SalesReturnOrderNumber":{
            "title":"Sales Return Order Number",
            "maxLength":"30",
            "type":"string",
            "description":"Number that identifies the return order.",
            "nullable":true,
            "x-queryable":true
        },
        "SupplierItem":{
            "title":"Supplier Item",
            "maxLength":"300",
            "type":"string",
            "description":"Indicates the supplier's identification number or code for the goods ordered on the source document order line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

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."
        }
    }
}

Back to Top

Examples

This example describes how to get all documents.

Example 1 cURL Command

Use the following cURL command to submit a request on the REST resource to get all documents:

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

Example 1 Response Body

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

{
	"items": [
	{
		"DocumentId": 300100179185418,
		"DocumentNumber": "310815420192",
		"AccessKey": "310815420192",
		"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-15",
		"AcknowledgedDate": "2019-04-15",
		"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/300100179185418",
			"name": "inboundFiscalDocuments",
			"kind": "item",
			"properties": {
				"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000678"
			}
		},
		{
			"rel": "canonical",
			"href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100179185418",
			"name": "inboundFiscalDocuments",
			"kind": "item"
		},
		{
			"rel": "child",
			"href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100179185418/child/fiscalDocumentLines",
			"name": "fiscalDocumentLines",
			"kind": "collection"
		}
		]
	},
	{
		"DocumentId": 300100207960873,
		"DocumentNumber": "9307122091657",
		"AccessKey": "9307122091657",
		"StatusCode": "CAPTURED",
		"Status": "Captured",
		"AssociationId": 100100077234675,
		"FiscalFlow": "Drop Ship Seller",
		"ParentDocumentId": null,
		"ParentDocumentNumber": null,
		"CurrencyCode": "BRL",
		"CurrencyName": "Brazilian Real",
		"BilltoBusinessUnitId": 300100052386093,
		"BilltoBusinessUnit": "Vision Brazil",
		"SoldtoLegalEntityId": 1036,
		"SoldtoLegalEntity": "Vision Brazil",
		"IssuerLocationId": 300100122946343,
		"PartyTypeIssuerAddress": "Example Co. BR",
		"LETypeIssuerAddress": null,
		"IssuerPartyId": 300100122946333,
		"PartyTypeIssuerName": "FD3_Supplier_CMF",
		"IssuerLegalEntityName": null,
		"IssuerTaxId": 300100172479212,
		"PartyTypeIssuerTaxpayerNumber": "12345987654321",
		"LETypeIssuerTaxpayerNumber": null,
		"IssueDate": "2020-07-09",
		"AcknowledgedDate": "2020-07-09",
		"ReceiverLocationId": 23897,
		"PartyTypeReceiverAddress": null,
		"LETypeReceiverAddress": "Example 1 Co. BR",
		"ReceiverPartyId": 1036,
		"PartyTypeReceiverName": null,
		"ReceiverLegalEntityName": "Vision Brazil",
		"ReceiverTaxId": 12055,
		"PartyTypeReceiverTaxpayerNumber": null,
		"LETypeReceiverTaxpayerNumber": "65100200000161",
		"ShipfromLocationId": 300100122946343,
		"PartyTypeShipfromAddress": "Example Co. BR",
		"LETypeShipfromAddress": null,
		"ShipfromPartyId": 300100122946333,
		"PartyTypeShipfromName": "FD3_Supplier_CMF",
		"ShipfromLegalEntityName": null,
		"ShipfromTaxId": 300100172479212,
		"PartyTypeShipfromTaxpayerNumber": "12345987654321",
		"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": 122.25,
		"DocumentTypeCode": "SALES",
		"DocumentType": "Sales",
		"SourceDocumentTypeCode": "PURCHASE_ORDER",
		"SourceDocumentType": "Purchase order",
		"Usage": "MATERIAL",
		"links": [
		{
			"rel": "self",
			"href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100207960873",
			"name": "inboundFiscalDocuments",
			"kind": "item",
			"properties": {
				"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000378"
			}
		},
		{
			"rel": "canonical",
			"href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100207960873",
			"name": "inboundFiscalDocuments",
			"kind": "item"
		},
		{
			"rel": "child",
			"href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100207960873/child/fiscalDocumentLines",
			"name": "fiscalDocumentLines",
			"kind": "collection"
		}
		]
	},
	{
		"DocumentId": 300100276252123,
		"DocumentNumber": "94080120112444",
		"AccessKey": "94080120112444",
		"StatusCode": "CAPTURED",
		"Status": "Captured",
		"AssociationId": 100100077234676,
		"FiscalFlow": "Drop Ship Seller Complementary",
		"ParentDocumentId": 300100276247980,
		"ParentDocumentNumber": "93080120112444",
		"CurrencyCode": "BRL",
		"CurrencyName": "Brazilian Real",
		"BilltoBusinessUnitId": 300100052386093,
		"BilltoBusinessUnit": "Vision Brazil",
		"SoldtoLegalEntityId": 1036,
		"SoldtoLegalEntity": "Vision Brazil",
		"IssuerLocationId": 300100122946343,
		"PartyTypeIssuerAddress": "Example Co. BR",
		"LETypeIssuerAddress": null,
		"IssuerPartyId": 300100122946333,
		"PartyTypeIssuerName": "FD3_Supplier_CMF",
		"IssuerLegalEntityName": null,
		"IssuerTaxId": 300100172479212,
		"PartyTypeIssuerTaxpayerNumber": "12345987654321",
		"LETypeIssuerTaxpayerNumber": null,
		"IssueDate": "2020-07-29",
		"AcknowledgedDate": "2020-07-29",
		"ReceiverLocationId": 23897,
		"PartyTypeReceiverAddress": null,
		"LETypeReceiverAddress": "Example 1 Co. BR",
		"ReceiverPartyId": 1036,
		"PartyTypeReceiverName": null,
		"ReceiverLegalEntityName": "Vision Brazil",
		"ReceiverTaxId": 12055,
		"PartyTypeReceiverTaxpayerNumber": null,
		"LETypeReceiverTaxpayerNumber": "65100200000161",
		"ShipfromLocationId": 300100122946343,
		"PartyTypeShipfromAddress": "Example Co. BR",
		"LETypeShipfromAddress": null,
		"ShipfromPartyId": 300100122946333,
		"PartyTypeShipfromName": "FD3_Supplier_CMF",
		"ShipfromLegalEntityName": null,
		"ShipfromTaxId": 300100172479212,
		"PartyTypeShipfromTaxpayerNumber": "12345987654321",
		"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": 12,
		"DocumentTypeCode": "CMP_SALES",
		"DocumentType": "Complementary sales",
		"SourceDocumentTypeCode": "REFERENCED_FISCAL_DOCUMENT",
		"SourceDocumentType": "Referenced fiscal document",
		"Usage": "MATERIAL",
		"links": [
		{
			"rel": "self",
			"href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100276252123",
			"name": "inboundFiscalDocuments",
			"kind": "item",
			"properties": {
				"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
			}
		},
		{
			"rel": "canonical",
			"href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100276252123",
			"name": "inboundFiscalDocuments",
			"kind": "item"
		},
		{
			"rel": "child",
			"href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100276252123/child/fiscalDocumentLines",
			"name": "fiscalDocumentLines",
			"kind": "collection"
		}
		]
	},
	{
		"DocumentId": 300100259783939,
		"DocumentNumber": "94071820122516",
		"AccessKey": "94071820122516",
		"StatusCode": "CAPTURED",
		"Status": "Captured",
		"AssociationId": 100100077234676,
		"FiscalFlow": "Drop Ship Seller Complementary",
		"ParentDocumentId": 300100259783711,
		"ParentDocumentNumber": "93071820122516",
		"CurrencyCode": "BRL",
		"CurrencyName": "Brazilian Real",
		"BilltoBusinessUnitId": 300100052386093,
		"BilltoBusinessUnit": "Vision Brazil",
		"SoldtoLegalEntityId": 1036,
		"SoldtoLegalEntity": "Vision Brazil",
		"IssuerLocationId": 300100122946343,
		"PartyTypeIssuerAddress": "Example Co. BR",
		"LETypeIssuerAddress": null,
		"IssuerPartyId": 300100122946333,
		"PartyTypeIssuerName": "FD3_Supplier_CMF",
		"IssuerLegalEntityName": null,
		"IssuerTaxId": 300100172479212,
		"PartyTypeIssuerTaxpayerNumber": "12345987654321",
		"LETypeIssuerTaxpayerNumber": null,
		"IssueDate": "2020-07-15",
		"AcknowledgedDate": "2020-07-15",
		"ReceiverLocationId": 23897,
		"PartyTypeReceiverAddress": null,
		"LETypeReceiverAddress": "Example 1 Co. BR",
		"ReceiverPartyId": 1036,
		"PartyTypeReceiverName": null,
		"ReceiverLegalEntityName": "Vision Brazil",
		"ReceiverTaxId": 12055,
		"PartyTypeReceiverTaxpayerNumber": null,
		"LETypeReceiverTaxpayerNumber": "65100200000161",
		"ShipfromLocationId": 300100122946343,
		"PartyTypeShipfromAddress": "Example Co. BR",
		"LETypeShipfromAddress": null,
		"ShipfromPartyId": 300100122946333,
		"PartyTypeShipfromName": "FD3_Supplier_CMF",
		"ShipfromLegalEntityName": null,
		"ShipfromTaxId": 300100172479212,
		"PartyTypeShipfromTaxpayerNumber": "12345987654321",
		"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": 12,
		"DocumentTypeCode": "CMP_SALES",
		"DocumentType": "Complementary sales",
		"SourceDocumentTypeCode": "REFERENCED_FISCAL_DOCUMENT",
		"SourceDocumentType": "Referenced fiscal document",
		"Usage": "MATERIAL",
		"links": [
		{
			"rel": "self",
			"href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100259783939",
			"name": "inboundFiscalDocuments",
			"kind": "item",
			"properties": {
				"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
			}
		},
		{
			"rel": "canonical",
			"href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100259783939",
			"name": "inboundFiscalDocuments",
			"kind": "item"
		},
		{
			"rel": "child",
			"href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100259783939/child/fiscalDocumentLines",
			"name": "fiscalDocumentLines",
			"kind": "collection"
		}
		]
	},
	{
		"DocumentId": 300100268170506,
		"DocumentNumber": "9407252092943",
		"AccessKey": "9407252092943",
		"StatusCode": "CAPTURED",
		"Status": "Captured",
		"AssociationId": 100100077234676,
		"FiscalFlow": "Drop Ship Seller Complementary",
		"ParentDocumentId": 300100268170062,
		"ParentDocumentNumber": "9307252092943",
		"CurrencyCode": "BRL",
		"CurrencyName": "Brazilian Real",
		"BilltoBusinessUnitId": 300100052386093,
		"BilltoBusinessUnit": "Vision Brazil",
		"SoldtoLegalEntityId": 1036,
		"SoldtoLegalEntity": "Vision Brazil",
		"IssuerLocationId": 300100122946343,
		"PartyTypeIssuerAddress": "Example Co. BR",
		"LETypeIssuerAddress": null,
		"IssuerPartyId": 300100122946333,
		"PartyTypeIssuerName": "FD3_Supplier_CMF",
		"IssuerLegalEntityName": null,
		"IssuerTaxId": 300100172479212,
		"PartyTypeIssuerTaxpayerNumber": "12345987654321",
		"LETypeIssuerTaxpayerNumber": null,
		"IssueDate": "2020-07-22",
		"AcknowledgedDate": "2020-07-22",
		"ReceiverLocationId": 23897,
		"PartyTypeReceiverAddress": null,
		"LETypeReceiverAddress": "Example 1 Co. BR",
		"ReceiverPartyId": 1036,
		"PartyTypeReceiverName": null,
		"ReceiverLegalEntityName": "Vision Brazil",
		"ReceiverTaxId": 12055,
		"PartyTypeReceiverTaxpayerNumber": null,
		"LETypeReceiverTaxpayerNumber": "65100200000161",
		"ShipfromLocationId": 300100122946343,
		"PartyTypeShipfromAddress": "Example Co. BR",
		"LETypeShipfromAddress": null,
		"ShipfromPartyId": 300100122946333,
		"PartyTypeShipfromName": "FD3_Supplier_CMF",
		"ShipfromLegalEntityName": null,
		"ShipfromTaxId": 300100172479212,
		"PartyTypeShipfromTaxpayerNumber": "12345987654321",
		"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": 12,
		"DocumentTypeCode": "CMP_SALES",
		"DocumentType": "Complementary sales",
		"SourceDocumentTypeCode": "REFERENCED_FISCAL_DOCUMENT",
		"SourceDocumentType": "Referenced fiscal document",
		"Usage": "MATERIAL",
		"links": [
		{
			"rel": "self",
			"href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100268170506",
			"name": "inboundFiscalDocuments",
			"kind": "item",
			"properties": {
				"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
			}
		},
		{
			"rel": "canonical",
			"href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100268170506",
			"name": "inboundFiscalDocuments",
			"kind": "item"
		},
		{
			"rel": "child",
			"href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100268170506/child/fiscalDocumentLines",
			"name": "fiscalDocumentLines",
			"kind": "collection"
		}
		]
	}
	],
	"count": 5,
	"hasMore": true,
	"limit": 25,
	"offset": 0,
	"links": [
	{
		"rel": "self",
		"href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments",
		"name": "inboundFiscalDocuments",
		"kind": "collection"
	}
	]
}

Example 2 cURL Command

Use the following cURL command to submit a request on the REST resource to get all documents in a bill to business unit:

curl -u username:password "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments?finder=findByBilltoBusinessUnit;bindBillToBusinessUnit=Vision Brazil"

Example 2 Response Body

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

{
	"items": [
	{
		"DocumentId": 300100118468902,
		"DocumentNumber": "2507210701",
		"AccessKey": "nfe2507210701",
		"StatusCode": "CAPTURED",
		"Status": "Captured",
		"AssociationId": 300100110481037,
		"FiscalFlow": "Standard",
		"ParentDocumentId": null,
		"ParentDocumentNumber": null,
		"CurrencyCode": "BRL",
		"CurrencyName": "Brazilian Real",
		"BilltoBusinessUnitId": 300100052386093,
		"BilltoBusinessUnit": "Vision Brazil",
		"SoldtoLegalEntityId": 1036,
		"SoldtoLegalEntity": "Vision Brazil",
		"IssuerLocationId": 300100093494458,
		"PartyTypeIssuerAddress": "1234, Street 1, New Avenue, , SAO PAULO, SP, BR, 1234",
		"LETypeIssuerAddress": null,
		"IssuerPartyId": 300100093494411,
		"PartyTypeIssuerName": "Importing Brazil Demo",
		"IssuerLegalEntityName": null,
		"IssuerTaxId": 300100093494500,
		"PartyTypeIssuerTaxpayerNumber": "12345678912345",
		"LETypeIssuerTaxpayerNumber": null,
		"IssueDate": "2017-07-21",
		"AcknowledgedDate": "2017-07-25",
		"ReceiverLocationId": 23897,
		"PartyTypeReceiverAddress": null,
		"LETypeReceiverAddress": "Example 1 Co. BR",
		"ReceiverPartyId": 1036,
		"PartyTypeReceiverName": null,
		"ReceiverLegalEntityName": "Vision Brazil",
		"ReceiverTaxId": 12055,
		"PartyTypeReceiverTaxpayerNumber": null,
		"LETypeReceiverTaxpayerNumber": "65100200000161",
		"ShipfromLocationId": 300100093494458,
		"PartyTypeShipfromAddress": "1234, Street 1, New Avenue, , SAO PAULO, SP, BR, 1234",
		"LETypeShipfromAddress": null,
		"ShipfromPartyId": 300100093494411,
		"PartyTypeShipfromName": "Importing Brazil Demo",
		"ShipfromLegalEntityName": null,
		"ShipfromTaxId": 300100093494500,
		"PartyTypeShipfromTaxpayerNumber": "12345678912345",
		"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": "A1",
		"SubSeries": null,
		"TotalAmount": 2000,
		"DocumentTypeCode": "SALES_REMIT",
		"DocumentType": "Sales with remittance",
		"SourceDocumentTypeCode": "PURCHASE_ORDER",
		"SourceDocumentType": "Purchase order",
		"Usage": "MATERIAL/SERVICE",
		"links": [
		{
			"rel": "self",
			"href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100118468902",
			"name": "inboundFiscalDocuments",
			"kind": "item",
			"properties": {
				"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000D78"
			}
		},
		{
			"rel": "canonical",
			"href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100118468902",
			"name": "inboundFiscalDocuments",
			"kind": "item"
		},
		{
			"rel": "child",
			"href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100118468902/child/fiscalDocumentLines",
			"name": "fiscalDocumentLines",
			"kind": "collection"
		}
		]
	},
	{
		"DocumentId": 300100123926847,
		"DocumentNumber": "987987987005",
		"AccessKey": "987987987005",
		"StatusCode": "NEEDS_REVALIDATION",
		"Status": "Needs revalidation",
		"AssociationId": 300100110481037,
		"FiscalFlow": "Standard",
		"ParentDocumentId": null,
		"ParentDocumentNumber": null,
		"CurrencyCode": "BRL",
		"CurrencyName": "Brazilian Real",
		"BilltoBusinessUnitId": 300100052386093,
		"BilltoBusinessUnit": "Vision Brazil",
		"SoldtoLegalEntityId": 1036,
		"SoldtoLegalEntity": "Vision Brazil",
		"IssuerLocationId": 300100093494041,
		"PartyTypeIssuerAddress": null,
		"LETypeIssuerAddress": null,
		"IssuerPartyId": 300100093494032,
		"PartyTypeIssuerName": null,
		"IssuerLegalEntityName": null,
		"IssuerTaxId": 300100093494060,
		"PartyTypeIssuerTaxpayerNumber": null,
		"LETypeIssuerTaxpayerNumber": null,
		"IssueDate": "2017-09-25",
		"AcknowledgedDate": "2017-09-25",
		"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": null,
		"LETypeShipfromAddress": null,
		"ShipfromPartyId": 300100093494032,
		"PartyTypeShipfromName": null,
		"ShipfromLegalEntityName": null,
		"ShipfromTaxId": 300100093494060,
		"PartyTypeShipfromTaxpayerNumber": null,
		"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": "1",
		"TotalAmount": 100,
		"DocumentTypeCode": "SALES_REMIT",
		"DocumentType": "Sales with remittance",
		"SourceDocumentTypeCode": "PURCHASE_ORDER",
		"SourceDocumentType": "Purchase order",
		"Usage": "MATERIAL/SERVICE",
		"links": [
		{
			"rel": "self",
			"href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100123926847",
			"name": "inboundFiscalDocuments",
			"kind": "item",
			"properties": {
				"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000478"
			}
		},
		{
			"rel": "canonical",
			"href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100123926847",
			"name": "inboundFiscalDocuments",
			"kind": "item"
		},
		{
			"rel": "child",
			"href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100123926847/child/fiscalDocumentLines",
			"name": "fiscalDocumentLines",
			"kind": "collection"
		}
		]
	},
	{
		"DocumentId": 300100166952295,
		"DocumentNumber": "203060618004746",
		"AccessKey": "060618004746",
		"StatusCode": "CAPTURED",
		"Status": "Captured",
		"AssociationId": 300100110481037,
		"FiscalFlow": "Standard",
		"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": "2018-06-06",
		"AcknowledgedDate": "2018-06-06",
		"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": 100,
		"DocumentTypeCode": "SALES_REMIT",
		"DocumentType": "Sales with remittance",
		"SourceDocumentTypeCode": "PURCHASE_ORDER",
		"SourceDocumentType": "Purchase order",
		"Usage": "MATERIAL/SERVICE",
		"links": [
		{
			"rel": "self",
			"href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100166952295",
			"name": "inboundFiscalDocuments",
			"kind": "item",
			"properties": {
				"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000778"
			}
		},
		{
			"rel": "canonical",
			"href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100166952295",
			"name": "inboundFiscalDocuments",
			"kind": "item"
		},
		{
			"rel": "child",
			"href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100166952295/child/fiscalDocumentLines",
			"name": "fiscalDocumentLines",
			"kind": "collection"
		}
		]
	},
	{
		"DocumentId": 300100171421860,
		"DocumentNumber": "3108111020182",
		"AccessKey": "3108111020182",
		"StatusCode": "NEEDS_REVALIDATION",
		"Status": "Needs revalidation",
		"AssociationId": 100100077234691,
		"FiscalFlow": "Purchased Material Import",
		"ParentDocumentId": null,
		"ParentDocumentNumber": null,
		"CurrencyCode": "BRL",
		"CurrencyName": "Brazilian Real",
		"BilltoBusinessUnitId": 300100052386093,
		"BilltoBusinessUnit": "Vision Brazil",
		"SoldtoLegalEntityId": 1036,
		"SoldtoLegalEntity": "Vision Brazil",
		"IssuerLocationId": 23897,
		"PartyTypeIssuerAddress": null,
		"LETypeIssuerAddress": "Example 1 Co. BR",
		"IssuerPartyId": 1036,
		"PartyTypeIssuerName": null,
		"IssuerLegalEntityName": "Vision Brazil",
		"IssuerTaxId": 12055,
		"PartyTypeIssuerTaxpayerNumber": null,
		"LETypeIssuerTaxpayerNumber": "65100200000161",
		"IssueDate": "2018-10-11",
		"AcknowledgedDate": "2018-10-11",
		"ReceiverLocationId": 300100151423471,
		"PartyTypeReceiverAddress": "Post Street, 611, , Princeton-By-The-Sea, CA, US, 94101",
		"LETypeReceiverAddress": null,
		"ReceiverPartyId": 300100151423461,
		"PartyTypeReceiverName": "Brazil-USA Supplier",
		"ReceiverLegalEntityName": null,
		"ReceiverTaxId": null,
		"PartyTypeReceiverTaxpayerNumber": null,
		"LETypeReceiverTaxpayerNumber": null,
		"ShipfromLocationId": 300100151423471,
		"PartyTypeShipfromAddress": "Post Street, 611, , Princeton-By-The-Sea, CA, US, 94101",
		"LETypeShipfromAddress": null,
		"ShipfromPartyId": 300100151423461,
		"PartyTypeShipfromName": "Brazil-USA Supplier",
		"ShipfromLegalEntityName": null,
		"ShipfromTaxId": null,
		"PartyTypeShipfromTaxpayerNumber": null,
		"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": 100,
		"DocumentTypeCode": "REMITTANCE",
		"DocumentType": "Remittance",
		"SourceDocumentTypeCode": "PURCHASE_ORDER",
		"SourceDocumentType": "Purchase order",
		"Usage": "MATERIAL",
		"links": [
		{
			"rel": "self",
			"href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100171421860",
			"name": "inboundFiscalDocuments",
			"kind": "item",
			"properties": {
				"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000378"
			}
		},
		{
			"rel": "canonical",
			"href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100171421860",
			"name": "inboundFiscalDocuments",
			"kind": "item"
		},
		{
			"rel": "child",
			"href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100171421860/child/fiscalDocumentLines",
			"name": "fiscalDocumentLines",
			"kind": "collection"
		}
		]
	},
	{
		"DocumentId": 300100183355534,
		"DocumentNumber": "102091219083114",
		"AccessKey": "102091219083114",
		"StatusCode": "NEEDS_REVALIDATION",
		"Status": "Needs revalidation",
		"AssociationId": 300100110481037,
		"FiscalFlow": "Standard",
		"ParentDocumentId": null,
		"ParentDocumentNumber": null,
		"CurrencyCode": "BRL",
		"CurrencyName": "Brazilian Real",
		"BilltoBusinessUnitId": 300100052386093,
		"BilltoBusinessUnit": "Vision Brazil",
		"SoldtoLegalEntityId": 1036,
		"SoldtoLegalEntity": "Vision Brazil",
		"IssuerLocationId": 300100093494458,
		"PartyTypeIssuerAddress": "1234, Street 1, New Avenue, , SAO PAULO, SP, BR, 1234",
		"LETypeIssuerAddress": null,
		"IssuerPartyId": 300100093494411,
		"PartyTypeIssuerName": "Importing Brazil Demo",
		"IssuerLegalEntityName": null,
		"IssuerTaxId": 300100093494500,
		"PartyTypeIssuerTaxpayerNumber": "12345678912345",
		"LETypeIssuerTaxpayerNumber": null,
		"IssueDate": "2019-09-12",
		"AcknowledgedDate": "2019-09-12",
		"ReceiverLocationId": 23897,
		"PartyTypeReceiverAddress": null,
		"LETypeReceiverAddress": "Example 1 Co. BR",
		"ReceiverPartyId": 1036,
		"PartyTypeReceiverName": null,
		"ReceiverLegalEntityName": "Vision Brazil",
		"ReceiverTaxId": 12055,
		"PartyTypeReceiverTaxpayerNumber": null,
		"LETypeReceiverTaxpayerNumber": "65100200000161",
		"ShipfromLocationId": 300100093494458,
		"PartyTypeShipfromAddress": "1234, Street 1, New Avenue, , SAO PAULO, SP, BR, 1234",
		"LETypeShipfromAddress": null,
		"ShipfromPartyId": 300100093494411,
		"PartyTypeShipfromName": "Importing Brazil Demo",
		"ShipfromLegalEntityName": null,
		"ShipfromTaxId": 300100093494500,
		"PartyTypeShipfromTaxpayerNumber": "12345678912345",
		"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": 10,
		"DocumentTypeCode": "SALES_REMIT",
		"DocumentType": "Sales with remittance",
		"SourceDocumentTypeCode": "PURCHASE_ORDER",
		"SourceDocumentType": "Purchase order",
		"Usage": "MATERIAL/SERVICE",
		"links": [
		{
			"rel": "self",
			"href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100183355534",
			"name": "inboundFiscalDocuments",
			"kind": "item",
			"properties": {
				"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000378"
			}
		},
		{
			"rel": "canonical",
			"href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100183355534",
			"name": "inboundFiscalDocuments",
			"kind": "item"
		},
		{
			"rel": "child",
			"href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100183355534/child/fiscalDocumentLines",
			"name": "fiscalDocumentLines",
			"kind": "collection"
		}
		]
	}
	],
	"count": 5,
	"hasMore": true,
	"limit": 5,
	"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 resource to get all documents not in the Captured status in a bill to business unit:

curl -u username:password "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments?finder=findByBilltoBusinessUnit;bindBillToBusinessUnit=Vision Brazil,bindIncludeCaptured=N"

Example 3 Response Body

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

{
	"items": [
	{
		"DocumentId": 300100123926847,
		"DocumentNumber": "987987987005",
		"AccessKey": "987987987005",
		"StatusCode": "NEEDS_REVALIDATION",
		"Status": "Needs revalidation",
		"AssociationId": 300100110481037,
		"FiscalFlow": "Standard",
		"ParentDocumentId": null,
		"ParentDocumentNumber": null,
		"CurrencyCode": "BRL",
		"CurrencyName": "Brazilian Real",
		"BilltoBusinessUnitId": 300100052386093,
		"BilltoBusinessUnit": "Vision Brazil",
		"SoldtoLegalEntityId": 1036,
		"SoldtoLegalEntity": "Vision Brazil",
		"IssuerLocationId": 300100093494041,
		"PartyTypeIssuerAddress": null,
		"LETypeIssuerAddress": null,
		"IssuerPartyId": 300100093494032,
		"PartyTypeIssuerName": null,
		"IssuerLegalEntityName": null,
		"IssuerTaxId": 300100093494060,
		"PartyTypeIssuerTaxpayerNumber": null,
		"LETypeIssuerTaxpayerNumber": null,
		"IssueDate": "2017-09-25",
		"AcknowledgedDate": "2017-09-25",
		"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": null,
		"LETypeShipfromAddress": null,
		"ShipfromPartyId": 300100093494032,
		"PartyTypeShipfromName": null,
		"ShipfromLegalEntityName": null,
		"ShipfromTaxId": 300100093494060,
		"PartyTypeShipfromTaxpayerNumber": null,
		"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": "1",
		"TotalAmount": 100,
		"DocumentTypeCode": "SALES_REMIT",
		"DocumentType": "Sales with remittance",
		"SourceDocumentTypeCode": "PURCHASE_ORDER",
		"SourceDocumentType": "Purchase order",
		"Usage": "MATERIAL/SERVICE",
		"links": [
		{
			"rel": "self",
			"href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100123926847",
			"name": "inboundFiscalDocuments",
			"kind": "item",
			"properties": {
				"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000478"
			}
		},
		{
			"rel": "canonical",
			"href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100123926847",
			"name": "inboundFiscalDocuments",
			"kind": "item"
		},
		{
			"rel": "child",
			"href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100123926847/child/fiscalDocumentLines",
			"name": "fiscalDocumentLines",
			"kind": "collection"
		}
		]
	},
	{
		"DocumentId": 300100171421860,
		"DocumentNumber": "3108111020182",
		"AccessKey": "3108111020182",
		"StatusCode": "NEEDS_REVALIDATION",
		"Status": "Needs revalidation",
		"AssociationId": 100100077234691,
		"FiscalFlow": "Purchased Material Import",
		"ParentDocumentId": null,
		"ParentDocumentNumber": null,
		"CurrencyCode": "BRL",
		"CurrencyName": "Brazilian Real",
		"BilltoBusinessUnitId": 300100052386093,
		"BilltoBusinessUnit": "Vision Brazil",
		"SoldtoLegalEntityId": 1036,
		"SoldtoLegalEntity": "Vision Brazil",
		"IssuerLocationId": 23897,
		"PartyTypeIssuerAddress": null,
		"LETypeIssuerAddress": "Example 1 Co. BR",
		"IssuerPartyId": 1036,
		"PartyTypeIssuerName": null,
		"IssuerLegalEntityName": "Vision Brazil",
		"IssuerTaxId": 12055,
		"PartyTypeIssuerTaxpayerNumber": null,
		"LETypeIssuerTaxpayerNumber": "65100200000161",
		"IssueDate": "2018-10-11",
		"AcknowledgedDate": "2018-10-11",
		"ReceiverLocationId": 300100151423471,
		"PartyTypeReceiverAddress": "Post Street, 611, , Princeton-By-The-Sea, CA, US, 94101",
		"LETypeReceiverAddress": null,
		"ReceiverPartyId": 300100151423461,
		"PartyTypeReceiverName": "Brazil-USA Supplier",
		"ReceiverLegalEntityName": null,
		"ReceiverTaxId": null,
		"PartyTypeReceiverTaxpayerNumber": null,
		"LETypeReceiverTaxpayerNumber": null,
		"ShipfromLocationId": 300100151423471,
		"PartyTypeShipfromAddress": "Post Street, 611, , Princeton-By-The-Sea, CA, US, 94101",
		"LETypeShipfromAddress": null,
		"ShipfromPartyId": 300100151423461,
		"PartyTypeShipfromName": "Brazil-USA Supplier",
		"ShipfromLegalEntityName": null,
		"ShipfromTaxId": null,
		"PartyTypeShipfromTaxpayerNumber": null,
		"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": 100,
		"DocumentTypeCode": "REMITTANCE",
		"DocumentType": "Remittance",
		"SourceDocumentTypeCode": "PURCHASE_ORDER",
		"SourceDocumentType": "Purchase order",
		"Usage": "MATERIAL",
		"links": [
		{
			"rel": "self",
			"href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100171421860",
			"name": "inboundFiscalDocuments",
			"kind": "item",
			"properties": {
				"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000378"
			}
		},
		{
			"rel": "canonical",
			"href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100171421860",
			"name": "inboundFiscalDocuments",
			"kind": "item"
		},
		{
			"rel": "child",
			"href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100171421860/child/fiscalDocumentLines",
			"name": "fiscalDocumentLines",
			"kind": "collection"
		}
		]
	},
	{
		"DocumentId": 300100183355534,
		"DocumentNumber": "102091219083114",
		"AccessKey": "102091219083114",
		"StatusCode": "NEEDS_REVALIDATION",
		"Status": "Needs revalidation",
		"AssociationId": 300100110481037,
		"FiscalFlow": "Standard",
		"ParentDocumentId": null,
		"ParentDocumentNumber": null,
		"CurrencyCode": "BRL",
		"CurrencyName": "Brazilian Real",
		"BilltoBusinessUnitId": 300100052386093,
		"BilltoBusinessUnit": "Vision Brazil",
		"SoldtoLegalEntityId": 1036,
		"SoldtoLegalEntity": "Vision Brazil",
		"IssuerLocationId": 300100093494458,
		"PartyTypeIssuerAddress": "1234, Street 1, New Avenue, , SAO PAULO, SP, BR, 1234",
		"LETypeIssuerAddress": null,
		"IssuerPartyId": 300100093494411,
		"PartyTypeIssuerName": "Importing Brazil Demo",
		"IssuerLegalEntityName": null,
		"IssuerTaxId": 300100093494500,
		"PartyTypeIssuerTaxpayerNumber": "12345678912345",
		"LETypeIssuerTaxpayerNumber": null,
		"IssueDate": "2019-09-12",
		"AcknowledgedDate": "2019-09-12",
		"ReceiverLocationId": 23897,
		"PartyTypeReceiverAddress": null,
		"LETypeReceiverAddress": "Example 1 Co. BR",
		"ReceiverPartyId": 1036,
		"PartyTypeReceiverName": null,
		"ReceiverLegalEntityName": "Vision Brazil",
		"ReceiverTaxId": 12055,
		"PartyTypeReceiverTaxpayerNumber": null,
		"LETypeReceiverTaxpayerNumber": "65100200000161",
		"ShipfromLocationId": 300100093494458,
		"PartyTypeShipfromAddress": "1234, Street 1, New Avenue, , SAO PAULO, SP, BR, 1234",
		"LETypeShipfromAddress": null,
		"ShipfromPartyId": 300100093494411,
		"PartyTypeShipfromName": "Importing Brazil Demo",
		"ShipfromLegalEntityName": null,
		"ShipfromTaxId": 300100093494500,
		"PartyTypeShipfromTaxpayerNumber": "12345678912345",
		"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": 10,
		"DocumentTypeCode": "SALES_REMIT",
		"DocumentType": "Sales with remittance",
		"SourceDocumentTypeCode": "PURCHASE_ORDER",
		"SourceDocumentType": "Purchase order",
		"Usage": "MATERIAL/SERVICE",
		"links": [
		{
			"rel": "self",
			"href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100183355534",
			"name": "inboundFiscalDocuments",
			"kind": "item",
			"properties": {
				"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000378"
			}
		},
		{
			"rel": "canonical",
			"href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100183355534",
			"name": "inboundFiscalDocuments",
			"kind": "item"
		},
		{
			"rel": "child",
			"href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100183355534/child/fiscalDocumentLines",
			"name": "fiscalDocumentLines",
			"kind": "collection"
		}
		]
	},
	{
		"DocumentId": 300100118468403,
		"DocumentNumber": "25072017",
		"AccessKey": "nfe25072017",
		"StatusCode": "PRE_VALIDATED",
		"Status": "Completed Prevalidation",
		"AssociationId": 300100110481037,
		"FiscalFlow": "Standard",
		"ParentDocumentId": null,
		"ParentDocumentNumber": null,
		"CurrencyCode": "BRL",
		"CurrencyName": "Brazilian Real",
		"BilltoBusinessUnitId": 300100052386093,
		"BilltoBusinessUnit": "Vision Brazil",
		"SoldtoLegalEntityId": 1036,
		"SoldtoLegalEntity": "Vision Brazil",
		"IssuerLocationId": 300100093494458,
		"PartyTypeIssuerAddress": "1234, Street 1, New Avenue, , SAO PAULO, SP, BR, 1234",
		"LETypeIssuerAddress": null,
		"IssuerPartyId": 300100093494411,
		"PartyTypeIssuerName": "Importing Brazil Demo",
		"IssuerLegalEntityName": null,
		"IssuerTaxId": 300100093494500,
		"PartyTypeIssuerTaxpayerNumber": "12345678912345",
		"LETypeIssuerTaxpayerNumber": null,
		"IssueDate": "2017-07-21",
		"AcknowledgedDate": "2017-07-25",
		"ReceiverLocationId": 23897,
		"PartyTypeReceiverAddress": null,
		"LETypeReceiverAddress": "Example 1 Co. BR",
		"ReceiverPartyId": 1036,
		"PartyTypeReceiverName": null,
		"ReceiverLegalEntityName": "Vision Brazil",
		"ReceiverTaxId": 12055,
		"PartyTypeReceiverTaxpayerNumber": null,
		"LETypeReceiverTaxpayerNumber": "65100200000161",
		"ShipfromLocationId": 300100093494458,
		"PartyTypeShipfromAddress": "1234, Street 1, New Avenue, , SAO PAULO, SP, BR, 1234",
		"LETypeShipfromAddress": null,
		"ShipfromPartyId": 300100093494411,
		"PartyTypeShipfromName": "Importing Brazil Demo",
		"ShipfromLegalEntityName": null,
		"ShipfromTaxId": 300100093494500,
		"PartyTypeShipfromTaxpayerNumber": "12345678912345",
		"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": "A1",
		"SubSeries": null,
		"TotalAmount": 2000,
		"DocumentTypeCode": "SALES_REMIT",
		"DocumentType": "Sales with remittance",
		"SourceDocumentTypeCode": "PURCHASE_ORDER",
		"SourceDocumentType": "Purchase order",
		"Usage": "MATERIAL/SERVICE",
		"links": [
		{
			"rel": "self",
			"href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100118468403",
			"name": "inboundFiscalDocuments",
			"kind": "item",
			"properties": {
				"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000F78"
			}
		},
		{
			"rel": "canonical",
			"href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100118468403",
			"name": "inboundFiscalDocuments",
			"kind": "item"
		},
		{
			"rel": "child",
			"href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100118468403/child/fiscalDocumentLines",
			"name": "fiscalDocumentLines",
			"kind": "collection"
		}
		]
	},
	{
		"DocumentId": 300100123926569,
		"DocumentNumber": "310825920172",
		"AccessKey": "310825920172",
		"StatusCode": "NEEDS_REVALIDATION",
		"Status": "Needs revalidation",
		"AssociationId": 300100110481037,
		"FiscalFlow": "Standard",
		"ParentDocumentId": null,
		"ParentDocumentNumber": null,
		"CurrencyCode": "BRL",
		"CurrencyName": "Brazilian Real",
		"BilltoBusinessUnitId": 300100052386093,
		"BilltoBusinessUnit": "Vision Brazil",
		"SoldtoLegalEntityId": 1036,
		"SoldtoLegalEntity": "Vision Brazil",
		"IssuerLocationId": 300100093494041,
		"PartyTypeIssuerAddress": null,
		"LETypeIssuerAddress": null,
		"IssuerPartyId": 300100093494032,
		"PartyTypeIssuerName": null,
		"IssuerLegalEntityName": null,
		"IssuerTaxId": 300100093494060,
		"PartyTypeIssuerTaxpayerNumber": null,
		"LETypeIssuerTaxpayerNumber": null,
		"IssueDate": "2017-09-25",
		"AcknowledgedDate": "2017-09-25",
		"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": null,
		"LETypeShipfromAddress": null,
		"ShipfromPartyId": 300100093494032,
		"PartyTypeShipfromName": null,
		"ShipfromLegalEntityName": null,
		"ShipfromTaxId": 300100093494060,
		"PartyTypeShipfromTaxpayerNumber": null,
		"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": 100,
		"DocumentTypeCode": "SALES_REMIT",
		"DocumentType": "Sales with remittance",
		"SourceDocumentTypeCode": "PURCHASE_ORDER",
		"SourceDocumentType": "Purchase order",
		"Usage": "MATERIAL/SERVICE",
		"links": [
		{
			"rel": "self",
			"href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100123926569",
			"name": "inboundFiscalDocuments",
			"kind": "item",
			"properties": {
				"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000378"
			}
		},
		{
			"rel": "canonical",
			"href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100123926569",
			"name": "inboundFiscalDocuments",
			"kind": "item"
		},
		{
			"rel": "child",
			"href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100123926569/child/fiscalDocumentLines",
			"name": "fiscalDocumentLines",
			"kind": "collection"
		}
		]
	}
	],
	"count": 5,
	"hasMore": true,
	"limit": 5,
	"offset": 0,
	"links": [
	{
		"rel": "self",
		"href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments",
		"name": "inboundFiscalDocuments",
		"kind": "collection"
	}
	]
}

Example 4 cURL Command

Use the following cURL command to submit a request on the REST resource to get all documents including documents in the Captured status in a bill to business unit:

curl -u username:password "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments?finder=findByBilltoBusinessUnit;bindBillToBusinessUnit=Vision Brazil,bindIncludeCaptured=Y"

Example 4 Response Body

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

{
	"items": [
	{
		"DocumentId": 300100118468902,
		"DocumentNumber": "2507210701",
		"AccessKey": "nfe2507210701",
		"StatusCode": "CAPTURED",
		"Status": "Captured",
		"AssociationId": 300100110481037,
		"FiscalFlow": "Standard",
		"ParentDocumentId": null,
		"ParentDocumentNumber": null,
		"CurrencyCode": "BRL",
		"CurrencyName": "Brazilian Real",
		"BilltoBusinessUnitId": 300100052386093,
		"BilltoBusinessUnit": "Vision Brazil",
		"SoldtoLegalEntityId": 1036,
		"SoldtoLegalEntity": "Vision Brazil",
		"IssuerLocationId": 300100093494458,
		"PartyTypeIssuerAddress": "1234, Street 1, New Avenue, , SAO PAULO, SP, BR, 1234",
		"LETypeIssuerAddress": null,
		"IssuerPartyId": 300100093494411,
		"PartyTypeIssuerName": "Importing Brazil Demo",
		"IssuerLegalEntityName": null,
		"IssuerTaxId": 300100093494500,
		"PartyTypeIssuerTaxpayerNumber": "12345678912345",
		"LETypeIssuerTaxpayerNumber": null,
		"IssueDate": "2017-07-21",
		"AcknowledgedDate": "2017-07-25",
		"ReceiverLocationId": 23897,
		"PartyTypeReceiverAddress": null,
		"LETypeReceiverAddress": "Example 1 Co. BR",
		"ReceiverPartyId": 1036,
		"PartyTypeReceiverName": null,
		"ReceiverLegalEntityName": "Vision Brazil",
		"ReceiverTaxId": 12055,
		"PartyTypeReceiverTaxpayerNumber": null,
		"LETypeReceiverTaxpayerNumber": "65100200000161",
		"ShipfromLocationId": 300100093494458,
		"PartyTypeShipfromAddress": "1234, Street 1, New Avenue, , SAO PAULO, SP, BR, 1234",
		"LETypeShipfromAddress": null,
		"ShipfromPartyId": 300100093494411,
		"PartyTypeShipfromName": "Importing Brazil Demo",
		"ShipfromLegalEntityName": null,
		"ShipfromTaxId": 300100093494500,
		"PartyTypeShipfromTaxpayerNumber": "12345678912345",
		"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": "A1",
		"SubSeries": null,
		"TotalAmount": 2000,
		"DocumentTypeCode": "SALES_REMIT",
		"DocumentType": "Sales with remittance",
		"SourceDocumentTypeCode": "PURCHASE_ORDER",
		"SourceDocumentType": "Purchase order",
		"Usage": "MATERIAL/SERVICE",
		"links": [
		{
			"rel": "self",
			"href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100118468902",
			"name": "inboundFiscalDocuments",
			"kind": "item",
			"properties": {
				"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000D78"
			}
		},
		{
			"rel": "canonical",
			"href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100118468902",
			"name": "inboundFiscalDocuments",
			"kind": "item"
		},
		{
			"rel": "child",
			"href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100118468902/child/fiscalDocumentLines",
			"name": "fiscalDocumentLines",
			"kind": "collection"
		}
		]
	},
	{
		"DocumentId": 300100123926847,
		"DocumentNumber": "987987987005",
		"AccessKey": "987987987005",
		"StatusCode": "NEEDS_REVALIDATION",
		"Status": "Needs revalidation",
		"AssociationId": 300100110481037,
		"FiscalFlow": "Standard",
		"ParentDocumentId": null,
		"ParentDocumentNumber": null,
		"CurrencyCode": "BRL",
		"CurrencyName": "Brazilian Real",
		"BilltoBusinessUnitId": 300100052386093,
		"BilltoBusinessUnit": "Vision Brazil",
		"SoldtoLegalEntityId": 1036,
		"SoldtoLegalEntity": "Vision Brazil",
		"IssuerLocationId": 300100093494041,
		"PartyTypeIssuerAddress": null,
		"LETypeIssuerAddress": null,
		"IssuerPartyId": 300100093494032,
		"PartyTypeIssuerName": null,
		"IssuerLegalEntityName": null,
		"IssuerTaxId": 300100093494060,
		"PartyTypeIssuerTaxpayerNumber": null,
		"LETypeIssuerTaxpayerNumber": null,
		"IssueDate": "2017-09-25",
		"AcknowledgedDate": "2017-09-25",
		"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": null,
		"LETypeShipfromAddress": null,
		"ShipfromPartyId": 300100093494032,
		"PartyTypeShipfromName": null,
		"ShipfromLegalEntityName": null,
		"ShipfromTaxId": 300100093494060,
		"PartyTypeShipfromTaxpayerNumber": null,
		"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": "1",
		"TotalAmount": 100,
		"DocumentTypeCode": "SALES_REMIT",
		"DocumentType": "Sales with remittance",
		"SourceDocumentTypeCode": "PURCHASE_ORDER",
		"SourceDocumentType": "Purchase order",
		"Usage": "MATERIAL/SERVICE",
		"links": [
		{
			"rel": "self",
			"href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100123926847",
			"name": "inboundFiscalDocuments",
			"kind": "item",
			"properties": {
				"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000478"
			}
		},
		{
			"rel": "canonical",
			"href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100123926847",
			"name": "inboundFiscalDocuments",
			"kind": "item"
		},
		{
			"rel": "child",
			"href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100123926847/child/fiscalDocumentLines",
			"name": "fiscalDocumentLines",
			"kind": "collection"
		}
		]
	},
	{
		"DocumentId": 300100166952295,
		"DocumentNumber": "203060618004746",
		"AccessKey": "060618004746",
		"StatusCode": "CAPTURED",
		"Status": "Captured",
		"AssociationId": 300100110481037,
		"FiscalFlow": "Standard",
		"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": "2018-06-06",
		"AcknowledgedDate": "2018-06-06",
		"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": 100,
		"DocumentTypeCode": "SALES_REMIT",
		"DocumentType": "Sales with remittance",
		"SourceDocumentTypeCode": "PURCHASE_ORDER",
		"SourceDocumentType": "Purchase order",
		"Usage": "MATERIAL/SERVICE",
		"links": [
		{
			"rel": "self",
			"href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100166952295",
			"name": "inboundFiscalDocuments",
			"kind": "item",
			"properties": {
				"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000778"
			}
		},
		{
			"rel": "canonical",
			"href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100166952295",
			"name": "inboundFiscalDocuments",
			"kind": "item"
		},
		{
			"rel": "child",
			"href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100166952295/child/fiscalDocumentLines",
			"name": "fiscalDocumentLines",
			"kind": "collection"
		}
		]
	},
	{
		"DocumentId": 300100171421860,
		"DocumentNumber": "3108111020182",
		"AccessKey": "3108111020182",
		"StatusCode": "NEEDS_REVALIDATION",
		"Status": "Needs revalidation",
		"AssociationId": 100100077234691,
		"FiscalFlow": "Purchased Material Import",
		"ParentDocumentId": null,
		"ParentDocumentNumber": null,
		"CurrencyCode": "BRL",
		"CurrencyName": "Brazilian Real",
		"BilltoBusinessUnitId": 300100052386093,
		"BilltoBusinessUnit": "Vision Brazil",
		"SoldtoLegalEntityId": 1036,
		"SoldtoLegalEntity": "Vision Brazil",
		"IssuerLocationId": 23897,
		"PartyTypeIssuerAddress": null,
		"LETypeIssuerAddress": "Example 1 Co. BR",
		"IssuerPartyId": 1036,
		"PartyTypeIssuerName": null,
		"IssuerLegalEntityName": "Vision Brazil",
		"IssuerTaxId": 12055,
		"PartyTypeIssuerTaxpayerNumber": null,
		"LETypeIssuerTaxpayerNumber": "65100200000161",
		"IssueDate": "2018-10-11",
		"AcknowledgedDate": "2018-10-11",
		"ReceiverLocationId": 300100151423471,
		"PartyTypeReceiverAddress": "Post Street, 611, , Princeton-By-The-Sea, CA, US, 94101",
		"LETypeReceiverAddress": null,
		"ReceiverPartyId": 300100151423461,
		"PartyTypeReceiverName": "Brazil-USA Supplier",
		"ReceiverLegalEntityName": null,
		"ReceiverTaxId": null,
		"PartyTypeReceiverTaxpayerNumber": null,
		"LETypeReceiverTaxpayerNumber": null,
		"ShipfromLocationId": 300100151423471,
		"PartyTypeShipfromAddress": "Post Street, 611, , Princeton-By-The-Sea, CA, US, 94101",
		"LETypeShipfromAddress": null,
		"ShipfromPartyId": 300100151423461,
		"PartyTypeShipfromName": "Brazil-USA Supplier",
		"ShipfromLegalEntityName": null,
		"ShipfromTaxId": null,
		"PartyTypeShipfromTaxpayerNumber": null,
		"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": 100,
		"DocumentTypeCode": "REMITTANCE",
		"DocumentType": "Remittance",
		"SourceDocumentTypeCode": "PURCHASE_ORDER",
		"SourceDocumentType": "Purchase order",
		"Usage": "MATERIAL",
		"links": [
		{
			"rel": "self",
			"href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100171421860",
			"name": "inboundFiscalDocuments",
			"kind": "item",
			"properties": {
				"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000378"
			}
		},
		{
			"rel": "canonical",
			"href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100171421860",
			"name": "inboundFiscalDocuments",
			"kind": "item"
		},
		{
			"rel": "child",
			"href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100171421860/child/fiscalDocumentLines",
			"name": "fiscalDocumentLines",
			"kind": "collection"
		}
		]
	},
	{
		"DocumentId": 300100183355534,
		"DocumentNumber": "102091219083114",
		"AccessKey": "102091219083114",
		"StatusCode": "NEEDS_REVALIDATION",
		"Status": "Needs revalidation",
		"AssociationId": 300100110481037,
		"FiscalFlow": "Standard",
		"ParentDocumentId": null,
		"ParentDocumentNumber": null,
		"CurrencyCode": "BRL",
		"CurrencyName": "Brazilian Real",
		"BilltoBusinessUnitId": 300100052386093,
		"BilltoBusinessUnit": "Vision Brazil",
		"SoldtoLegalEntityId": 1036,
		"SoldtoLegalEntity": "Vision Brazil",
		"IssuerLocationId": 300100093494458,
		"PartyTypeIssuerAddress": "1234, Street 1, New Avenue, , SAO PAULO, SP, BR, 1234",
		"LETypeIssuerAddress": null,
		"IssuerPartyId": 300100093494411,
		"PartyTypeIssuerName": "Importing Brazil Demo",
		"IssuerLegalEntityName": null,
		"IssuerTaxId": 300100093494500,
		"PartyTypeIssuerTaxpayerNumber": "12345678912345",
		"LETypeIssuerTaxpayerNumber": null,
		"IssueDate": "2019-09-12",
		"AcknowledgedDate": "2019-09-12",
		"ReceiverLocationId": 23897,
		"PartyTypeReceiverAddress": null,
		"LETypeReceiverAddress": "Example 1 Co. BR",
		"ReceiverPartyId": 1036,
		"PartyTypeReceiverName": null,
		"ReceiverLegalEntityName": "Vision Brazil",
		"ReceiverTaxId": 12055,
		"PartyTypeReceiverTaxpayerNumber": null,
		"LETypeReceiverTaxpayerNumber": "65100200000161",
		"ShipfromLocationId": 300100093494458,
		"PartyTypeShipfromAddress": "1234, Street 1, New Avenue, , SAO PAULO, SP, BR, 1234",
		"LETypeShipfromAddress": null,
		"ShipfromPartyId": 300100093494411,
		"PartyTypeShipfromName": "Importing Brazil Demo",
		"ShipfromLegalEntityName": null,
		"ShipfromTaxId": 300100093494500,
		"PartyTypeShipfromTaxpayerNumber": "12345678912345",
		"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": 10,
		"DocumentTypeCode": "SALES_REMIT",
		"DocumentType": "Sales with remittance",
		"SourceDocumentTypeCode": "PURCHASE_ORDER",
		"SourceDocumentType": "Purchase order",
		"Usage": "MATERIAL/SERVICE",
		"links": [
		{
			"rel": "self",
			"href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100183355534",
			"name": "inboundFiscalDocuments",
			"kind": "item",
			"properties": {
				"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000378"
			}
		},
		{
			"rel": "canonical",
			"href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100183355534",
			"name": "inboundFiscalDocuments",
			"kind": "item"
		},
		{
			"rel": "child",
			"href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100183355534/child/fiscalDocumentLines",
			"name": "fiscalDocumentLines",
			"kind": "collection"
		}
		]
	}
	],
	"count": 5,
	"hasMore": true,
	"limit": 5,
	"offset": 0,
	"links": [
	{
		"rel": "self",
		"href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments",
		"name": "inboundFiscalDocuments",
		"kind": "collection"
	}
	]
}

Example 5 cURL Command

Use the following cURL command to submit a request on the REST resource to get all documents by a specific fiscal document issuer in a bill to business unit:

curl -u username:password "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments?finder=findByBilltoBusinessUnit;bindBillToBusinessUnit=Vision Brazil,bindIssuer=Importing Brazil Demo"

Example 5 Response Body

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

{
	"items": [
	{
		"DocumentId": 300100118468902,
		"DocumentNumber": "2507210701",
		"AccessKey": "nfe2507210701",
		"StatusCode": "CAPTURED",
		"Status": "Captured",
		"AssociationId": 300100110481037,
		"FiscalFlow": "Standard",
		"ParentDocumentId": null,
		"ParentDocumentNumber": null,
		"CurrencyCode": "BRL",
		"CurrencyName": "Brazilian Real",
		"BilltoBusinessUnitId": 300100052386093,
		"BilltoBusinessUnit": "Vision Brazil",
		"SoldtoLegalEntityId": 1036,
		"SoldtoLegalEntity": "Vision Brazil",
		"IssuerLocationId": 300100093494458,
		"PartyTypeIssuerAddress": "1234, Street 1, New Avenue, , SAO PAULO, SP, BR, 1234",
		"LETypeIssuerAddress": null,
		"IssuerPartyId": 300100093494411,
		"PartyTypeIssuerName": "Importing Brazil Demo",
		"IssuerLegalEntityName": null,
		"IssuerTaxId": 300100093494500,
		"PartyTypeIssuerTaxpayerNumber": "12345678912345",
		"LETypeIssuerTaxpayerNumber": null,
		"IssueDate": "2017-07-21",
		"AcknowledgedDate": "2017-07-25",
		"ReceiverLocationId": 23897,
		"PartyTypeReceiverAddress": null,
		"LETypeReceiverAddress": "Example 1 Co. BR",
		"ReceiverPartyId": 1036,
		"PartyTypeReceiverName": null,
		"ReceiverLegalEntityName": "Vision Brazil",
		"ReceiverTaxId": 12055,
		"PartyTypeReceiverTaxpayerNumber": null,
		"LETypeReceiverTaxpayerNumber": "65100200000161",
		"ShipfromLocationId": 300100093494458,
		"PartyTypeShipfromAddress": "1234, Street 1, New Avenue, , SAO PAULO, SP, BR, 1234",
		"LETypeShipfromAddress": null,
		"ShipfromPartyId": 300100093494411,
		"PartyTypeShipfromName": "Importing Brazil Demo",
		"ShipfromLegalEntityName": null,
		"ShipfromTaxId": 300100093494500,
		"PartyTypeShipfromTaxpayerNumber": "12345678912345",
		"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": "A1",
		"SubSeries": null,
		"TotalAmount": 2000,
		"DocumentTypeCode": "SALES_REMIT",
		"DocumentType": "Sales with remittance",
		"SourceDocumentTypeCode": "PURCHASE_ORDER",
		"SourceDocumentType": "Purchase order",
		"Usage": "MATERIAL/SERVICE",
		"links": [
		{
			"rel": "self",
			"href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100118468902",
			"name": "inboundFiscalDocuments",
			"kind": "item",
			"properties": {
				"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000D78"
			}
		},
		{
			"rel": "canonical",
			"href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100118468902",
			"name": "inboundFiscalDocuments",
			"kind": "item"
		},
		{
			"rel": "child",
			"href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100118468902/child/fiscalDocumentLines",
			"name": "fiscalDocumentLines",
			"kind": "collection"
		}
		]
	},
	{
		"DocumentId": 300100183355534,
		"DocumentNumber": "102091219083114",
		"AccessKey": "102091219083114",
		"StatusCode": "NEEDS_REVALIDATION",
		"Status": "Needs revalidation",
		"AssociationId": 300100110481037,
		"FiscalFlow": "Standard",
		"ParentDocumentId": null,
		"ParentDocumentNumber": null,
		"CurrencyCode": "BRL",
		"CurrencyName": "Brazilian Real",
		"BilltoBusinessUnitId": 300100052386093,
		"BilltoBusinessUnit": "Vision Brazil",
		"SoldtoLegalEntityId": 1036,
		"SoldtoLegalEntity": "Vision Brazil",
		"IssuerLocationId": 300100093494458,
		"PartyTypeIssuerAddress": "1234, Street 1, New Avenue, , SAO PAULO, SP, BR, 1234",
		"LETypeIssuerAddress": null,
		"IssuerPartyId": 300100093494411,
		"PartyTypeIssuerName": "Importing Brazil Demo",
		"IssuerLegalEntityName": null,
		"IssuerTaxId": 300100093494500,
		"PartyTypeIssuerTaxpayerNumber": "12345678912345",
		"LETypeIssuerTaxpayerNumber": null,
		"IssueDate": "2019-09-12",
		"AcknowledgedDate": "2019-09-12",
		"ReceiverLocationId": 23897,
		"PartyTypeReceiverAddress": null,
		"LETypeReceiverAddress": "Example 1 Co. BR",
		"ReceiverPartyId": 1036,
		"PartyTypeReceiverName": null,
		"ReceiverLegalEntityName": "Vision Brazil",
		"ReceiverTaxId": 12055,
		"PartyTypeReceiverTaxpayerNumber": null,
		"LETypeReceiverTaxpayerNumber": "65100200000161",
		"ShipfromLocationId": 300100093494458,
		"PartyTypeShipfromAddress": "1234, Street 1, New Avenue, , SAO PAULO, SP, BR, 1234",
		"LETypeShipfromAddress": null,
		"ShipfromPartyId": 300100093494411,
		"PartyTypeShipfromName": "Importing Brazil Demo",
		"ShipfromLegalEntityName": null,
		"ShipfromTaxId": 300100093494500,
		"PartyTypeShipfromTaxpayerNumber": "12345678912345",
		"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": 10,
		"DocumentTypeCode": "SALES_REMIT",
		"DocumentType": "Sales with remittance",
		"SourceDocumentTypeCode": "PURCHASE_ORDER",
		"SourceDocumentType": "Purchase order",
		"Usage": "MATERIAL/SERVICE",
		"links": [
		{
			"rel": "self",
			"href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100183355534",
			"name": "inboundFiscalDocuments",
			"kind": "item",
			"properties": {
				"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000378"
			}
		},
		{
			"rel": "canonical",
			"href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100183355534",
			"name": "inboundFiscalDocuments",
			"kind": "item"
		},
		{
			"rel": "child",
			"href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100183355534/child/fiscalDocumentLines",
			"name": "fiscalDocumentLines",
			"kind": "collection"
		}
		]
	},
	{
		"DocumentId": 300100118468403,
		"DocumentNumber": "25072017",
		"AccessKey": "nfe25072017",
		"StatusCode": "PRE_VALIDATED",
		"Status": "Completed Prevalidation",
		"AssociationId": 300100110481037,
		"FiscalFlow": "Standard",
		"ParentDocumentId": null,
		"ParentDocumentNumber": null,
		"CurrencyCode": "BRL",
		"CurrencyName": "Brazilian Real",
		"BilltoBusinessUnitId": 300100052386093,
		"BilltoBusinessUnit": "Vision Brazil",
		"SoldtoLegalEntityId": 1036,
		"SoldtoLegalEntity": "Vision Brazil",
		"IssuerLocationId": 300100093494458,
		"PartyTypeIssuerAddress": "1234, Street 1, New Avenue, , SAO PAULO, SP, BR, 1234",
		"LETypeIssuerAddress": null,
		"IssuerPartyId": 300100093494411,
		"PartyTypeIssuerName": "Importing Brazil Demo",
		"IssuerLegalEntityName": null,
		"IssuerTaxId": 300100093494500,
		"PartyTypeIssuerTaxpayerNumber": "12345678912345",
		"LETypeIssuerTaxpayerNumber": null,
		"IssueDate": "2017-07-21",
		"AcknowledgedDate": "2017-07-25",
		"ReceiverLocationId": 23897,
		"PartyTypeReceiverAddress": null,
		"LETypeReceiverAddress": "Example 1 Co. BR",
		"ReceiverPartyId": 1036,
		"PartyTypeReceiverName": null,
		"ReceiverLegalEntityName": "Vision Brazil",
		"ReceiverTaxId": 12055,
		"PartyTypeReceiverTaxpayerNumber": null,
		"LETypeReceiverTaxpayerNumber": "65100200000161",
		"ShipfromLocationId": 300100093494458,
		"PartyTypeShipfromAddress": "1234, Street 1, New Avenue, , SAO PAULO, SP, BR, 1234",
		"LETypeShipfromAddress": null,
		"ShipfromPartyId": 300100093494411,
		"PartyTypeShipfromName": "Importing Brazil Demo",
		"ShipfromLegalEntityName": null,
		"ShipfromTaxId": 300100093494500,
		"PartyTypeShipfromTaxpayerNumber": "12345678912345",
		"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": "A1",
		"SubSeries": null,
		"TotalAmount": 2000,
		"DocumentTypeCode": "SALES_REMIT",
		"DocumentType": "Sales with remittance",
		"SourceDocumentTypeCode": "PURCHASE_ORDER",
		"SourceDocumentType": "Purchase order",
		"Usage": "MATERIAL/SERVICE",
		"links": [
		{
			"rel": "self",
			"href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100118468403",
			"name": "inboundFiscalDocuments",
			"kind": "item",
			"properties": {
				"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000F78"
			}
		},
		{
			"rel": "canonical",
			"href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100118468403",
			"name": "inboundFiscalDocuments",
			"kind": "item"
		},
		{
			"rel": "child",
			"href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100118468403/child/fiscalDocumentLines",
			"name": "fiscalDocumentLines",
			"kind": "collection"
		}
		]
	},
	{
		"DocumentId": 300100167090206,
		"DocumentNumber": "102060518232439",
		"AccessKey": "102060518232439",
		"StatusCode": "NEEDS_REVALIDATION",
		"Status": "Needs revalidation",
		"AssociationId": 300100110481037,
		"FiscalFlow": "Standard",
		"ParentDocumentId": null,
		"ParentDocumentNumber": null,
		"CurrencyCode": "BRL",
		"CurrencyName": "Brazilian Real",
		"BilltoBusinessUnitId": 300100052386093,
		"BilltoBusinessUnit": "Vision Brazil",
		"SoldtoLegalEntityId": 1036,
		"SoldtoLegalEntity": "Vision Brazil",
		"IssuerLocationId": 300100093494458,
		"PartyTypeIssuerAddress": "1234, Street 1, New Avenue, , SAO PAULO, SP, BR, 1234",
		"LETypeIssuerAddress": null,
		"IssuerPartyId": 300100093494411,
		"PartyTypeIssuerName": "Importing Brazil Demo",
		"IssuerLegalEntityName": null,
		"IssuerTaxId": 300100093494500,
		"PartyTypeIssuerTaxpayerNumber": "12345678912345",
		"LETypeIssuerTaxpayerNumber": null,
		"IssueDate": "2018-06-06",
		"AcknowledgedDate": "2018-06-06",
		"ReceiverLocationId": 23897,
		"PartyTypeReceiverAddress": null,
		"LETypeReceiverAddress": "Example 1 Co. BR",
		"ReceiverPartyId": 1036,
		"PartyTypeReceiverName": null,
		"ReceiverLegalEntityName": "Vision Brazil",
		"ReceiverTaxId": 12055,
		"PartyTypeReceiverTaxpayerNumber": null,
		"LETypeReceiverTaxpayerNumber": "65100200000161",
		"ShipfromLocationId": 300100093494458,
		"PartyTypeShipfromAddress": "1234, Street 1, New Avenue, , SAO PAULO, SP, BR, 1234",
		"LETypeShipfromAddress": null,
		"ShipfromPartyId": 300100093494411,
		"PartyTypeShipfromName": "Importing Brazil Demo",
		"ShipfromLegalEntityName": null,
		"ShipfromTaxId": 300100093494500,
		"PartyTypeShipfromTaxpayerNumber": "12345678912345",
		"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": 10,
		"DocumentTypeCode": "SALES_REMIT",
		"DocumentType": "Sales with remittance",
		"SourceDocumentTypeCode": "PURCHASE_ORDER",
		"SourceDocumentType": "Purchase order",
		"Usage": "MATERIAL/SERVICE",
		"links": [
		{
			"rel": "self",
			"href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100167090206",
			"name": "inboundFiscalDocuments",
			"kind": "item",
			"properties": {
				"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000378"
			}
		},
		{
			"rel": "canonical",
			"href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100167090206",
			"name": "inboundFiscalDocuments",
			"kind": "item"
		},
		{
			"rel": "child",
			"href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100167090206/child/fiscalDocumentLines",
			"name": "fiscalDocumentLines",
			"kind": "collection"
		}
		]
	},
	{
		"DocumentId": 300100111992543,
		"DocumentNumber": "101072117043233",
		"AccessKey": "101072117043233",
		"StatusCode": "NEEDS_REVALIDATION",
		"Status": "Needs revalidation",
		"AssociationId": 300100110481037,
		"FiscalFlow": "Standard",
		"ParentDocumentId": null,
		"ParentDocumentNumber": null,
		"CurrencyCode": "BRL",
		"CurrencyName": "Brazilian Real",
		"BilltoBusinessUnitId": 300100052386093,
		"BilltoBusinessUnit": "Vision Brazil",
		"SoldtoLegalEntityId": 1036,
		"SoldtoLegalEntity": "Vision Brazil",
		"IssuerLocationId": 300100093494458,
		"PartyTypeIssuerAddress": "1234, Street 1, New Avenue, , SAO PAULO, SP, BR, 1234",
		"LETypeIssuerAddress": null,
		"IssuerPartyId": 300100093494411,
		"PartyTypeIssuerName": "Importing Brazil Demo",
		"IssuerLegalEntityName": null,
		"IssuerTaxId": 300100093494500,
		"PartyTypeIssuerTaxpayerNumber": "12345678912345",
		"LETypeIssuerTaxpayerNumber": null,
		"IssueDate": "2016-07-28",
		"AcknowledgedDate": "2017-07-21",
		"ReceiverLocationId": 23897,
		"PartyTypeReceiverAddress": null,
		"LETypeReceiverAddress": "Example 1 Co. BR",
		"ReceiverPartyId": 1036,
		"PartyTypeReceiverName": null,
		"ReceiverLegalEntityName": "Vision Brazil",
		"ReceiverTaxId": 12055,
		"PartyTypeReceiverTaxpayerNumber": null,
		"LETypeReceiverTaxpayerNumber": "65100200000161",
		"ShipfromLocationId": 300100093494458,
		"PartyTypeShipfromAddress": "1234, Street 1, New Avenue, , SAO PAULO, SP, BR, 1234",
		"LETypeShipfromAddress": null,
		"ShipfromPartyId": 300100093494411,
		"PartyTypeShipfromName": "Importing Brazil Demo",
		"ShipfromLegalEntityName": null,
		"ShipfromTaxId": 300100093494500,
		"PartyTypeShipfromTaxpayerNumber": "12345678912345",
		"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": 10,
		"DocumentTypeCode": "SALES_REMIT",
		"DocumentType": "Sales with remittance",
		"SourceDocumentTypeCode": "PURCHASE_ORDER",
		"SourceDocumentType": "Purchase order",
		"Usage": "MATERIAL/SERVICE",
		"links": [
		{
			"rel": "self",
			"href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100111992543",
			"name": "inboundFiscalDocuments",
			"kind": "item",
			"properties": {
				"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000378"
			}
		},
		{
			"rel": "canonical",
			"href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100111992543",
			"name": "inboundFiscalDocuments",
			"kind": "item"
		},
		{
			"rel": "child",
			"href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100111992543/child/fiscalDocumentLines",
			"name": "fiscalDocumentLines",
			"kind": "collection"
		}
		]
	}
	],
	"count": 5,
	"hasMore": true,
	"limit": 5,
	"offset": 0,
	"links": [
	{
		"rel": "self",
		"href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments",
		"name": "inboundFiscalDocuments",
		"kind": "collection"
	}
	]
}

Example 6 cURL Command

Use the following cURL command to submit a request on the REST resource to get fiscal document line by providing a specific receipt number in a bill to business unit:

curl -u username:password "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments?finder=findByBilltoBusinessUnit;bindBillToBusinessUnit=Vision Brazil,bindReceiptNumber=4039&expand=fiscalDocumentLines"

Example 6 Response Body

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

{
	"items": [
	{
		"DocumentId": 300100179185418,
		"DocumentNumber": "310815420192",
		"AccessKey": "310815420192",
		"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-15",
		"AcknowledgedDate": "2019-04-15",
		"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",
		"fiscalDocumentLines": [
		{
			"DocumentId": 300100179185418,
			"LineId": 300100179185419,
			"LineNumber": 1,
			"LineSourceDocumentTypeCode": "PURCHASE_ORDER",
			"LineSourceDocumentType": "Purchase order",
			"SourceDocumentBUId": 300100052386093,
			"SourceDocumentBUName": "Vision Brazil",
			"InventoryItemId": 300100068025061,
			"InventoryItemNumber": "BR01",
			"InventoryItemDescription": "Brazil Cement",
			"TypeCode": "GOODS",
			"Type": "Goods",
			"Quantity": 5,
			"PhysicalReceiptQuantity": 5,
			"PhysicalReceiptDate": "2019-04-15",
			"UOMCode": "BOX",
			"UOMName": "BOX",
			"Price": 100,
			"Amount": 500,
			"ChargesAmount": 7,
			"links": [
			{
				"rel": "self",
				"href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100179185418/child/fiscalDocumentLines/300100179185419",
				"name": "fiscalDocumentLines",
				"kind": "item",
				"properties": {
					"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000378"
				}
			},
			{
				"rel": "canonical",
				"href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100179185418/child/fiscalDocumentLines/300100179185419",
				"name": "fiscalDocumentLines",
				"kind": "item"
			},
			{
				"rel": "parent",
				"href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100179185418",
				"name": "inboundFiscalDocuments",
				"kind": "item"
			},
			{
				"rel": "child",
				"href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100179185418/child/fiscalDocumentLines/300100179185419/child/fiscalDocumentSchedules",
				"name": "fiscalDocumentSchedules",
				"kind": "collection"
			}
			]
		}
		],
		"links": [
		{
			"rel": "self",
			"href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100179185418",
			"name": "inboundFiscalDocuments",
			"kind": "item",
			"properties": {
				"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000678"
			}
		},
		{
			"rel": "canonical",
			"href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100179185418",
			"name": "inboundFiscalDocuments",
			"kind": "item"
		},
		{
			"rel": "child",
			"href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100179185418/child/fiscalDocumentLines",
			"name": "fiscalDocumentLines",
			"kind": "collection"
		}
		]
	},
	{
		"DocumentId": 300100273193493,
		"DocumentNumber": "310830720203",
		"AccessKey": "310830720203",
		"StatusCode": "CAPTURED",
		"Status": "Captured",
		"AssociationId": 100100077234670,
		"FiscalFlow": "Consignment Sales",
		"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": "2018-05-02",
		"AcknowledgedDate": "2018-05-02",
		"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": 347,
		"DocumentTypeCode": "SALES",
		"DocumentType": "Sales",
		"SourceDocumentTypeCode": "PURCHASE_ORDER",
		"SourceDocumentType": "Purchase order",
		"Usage": "MATERIAL",
		"fiscalDocumentLines": [
		{
			"DocumentId": 300100273193493,
			"LineId": 300100273193494,
			"LineNumber": 1,
			"LineSourceDocumentTypeCode": "PURCHASE_ORDER",
			"LineSourceDocumentType": "Purchase order",
			"SourceDocumentBUId": 300100052386093,
			"SourceDocumentBUName": "Vision Brazil",
			"InventoryItemId": 300100068025061,
			"InventoryItemNumber": "BR01",
			"InventoryItemDescription": "Brazil Cement",
			"TypeCode": "GOODS",
			"Type": "Goods",
			"Quantity": 5,
			"PhysicalReceiptQuantity": 5,
			"PhysicalReceiptDate": null,
			"UOMCode": "BOX",
			"UOMName": "BOX",
			"Price": 200,
			"Amount": 1000,
			"ChargesAmount": 67,
			"links": [
			{
				"rel": "self",
				"href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100273193493/child/fiscalDocumentLines/300100273193494",
				"name": "fiscalDocumentLines",
				"kind": "item",
				"properties": {
					"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000478"
				}
			},
			{
				"rel": "canonical",
				"href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100273193493/child/fiscalDocumentLines/300100273193494",
				"name": "fiscalDocumentLines",
				"kind": "item"
			},
			{
				"rel": "parent",
				"href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100273193493",
				"name": "inboundFiscalDocuments",
				"kind": "item"
			},
			{
				"rel": "child",
				"href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100273193493/child/fiscalDocumentLines/300100273193494/child/fiscalDocumentSchedules",
				"name": "fiscalDocumentSchedules",
				"kind": "collection"
			}
			]
		}
		],
		"links": [
		{
			"rel": "self",
			"href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100273193493",
			"name": "inboundFiscalDocuments",
			"kind": "item",
			"properties": {
				"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000578"
			}
		},
		{
			"rel": "canonical",
			"href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100273193493",
			"name": "inboundFiscalDocuments",
			"kind": "item"
		},
		{
			"rel": "child",
			"href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100273193493/child/fiscalDocumentLines",
			"name": "fiscalDocumentLines",
			"kind": "collection"
		}
		]
	}
	],
	"count": 2,
	"hasMore": false,
	"limit": 3,
	"offset": 0,
	"links": [
	{
		"rel": "self",
		"href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments",
		"name": "inboundFiscalDocuments",
		"kind": "collection"
	}
	]
}

Back to Top