Get all lines
/fscmRestApi/resources/11.13.18.05/inboundFiscalDocuments/{DocumentId}/child/fiscalDocumentLines
Request
-
DocumentId(required): integer(int64)
Value that uniquely identifies the inbound fiscal document.
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
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 document lines according to the primary key of fiscal document lines.
Finder Variables:- LineId; integer; Value that uniquely identifies the fiscal document line.
- findByInventoryItem: Finds fiscal document lines according to the search parameters.
Finder Variables:- bindInventoryItemNumber; string; Value that identifies the item of a fiscal document line.
- 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.
- PrimaryKey: Finds fiscal document lines according to the primary key of fiscal document lines.
-
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:- DocumentId; integer; Value that uniquely identifies the inbound fiscal document.
- ExternalItem; string; Indicates the name of the item given on the fiscal document sent by the issuer.
- ExternalItemDescription; string; Indicates the description of the item given on the fiscal document sent by the issuer.
- FciControlNumber; string; Displays the FCI Number for imported products that are subject to industrial processing on the fiscal document line.
- InventoryItemId; integer; Value that uniquely identifies the item.
- InventoryItemNumber; string; Number that identifies the item on the fiscal document line.
- LineId; integer; Value that uniquely identifies the fiscal document line.
- LineSourceDocumentType; string; Type of the fiscal document sent by supplier or party.
- LineSourceDocumentTypeCode; string; Code that identifies the document type that acts as source for the fiscal document that is captured or created.
- SecondaryUOMCode; string; Indicates the UOM code of the alternative unit of measure that's allowed to quantify a dual-UOM-controlled item.
- SecondaryUOMName; string; Indicates the alternative unit of measure that's allowed to quantify a dual-UOM-controlled item.
- SourceDocumentBUId; integer; Value that uniquely identifies the source document business unit.
- SourceDocumentBUName; string; Name of the business unit for the source document. Valid values are Procurement BU, Requisition BU, or Receivable BU.
- Type; string; Type of line on the fiscal document.
-
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".
-
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 TopResponse
- application/json
Default Response
-
Metadata-Context(required):
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(required):
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.
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
array
Links
object
-
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.
array
Fiscal Document Schedules
array
Links
object
-
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.
array
Links
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Examples
This example describes how to get all lines.
Example 1 cURL Command
Use the following cURL command to submit a request on the REST resource to get all lines by providing a fiscal document number:
curl -u username:password "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments?q=DocumentNumber=310810420191&expand=fiscalDocumentLines"
Example 1 Response Body
The following shows an example of the response body in JSON format.
{ "items": [ { "DocumentId": 300100178959504, "DocumentNumber": "310810420191", "AccessKey": "310810420191", "StatusCode": "CAPTURED", "Status": "Captured", "AssociationId": 100100077234663, "FiscalFlow": "Consignment Remittance", "ParentDocumentId": null, "ParentDocumentNumber": null, "CurrencyCode": "BRL", "CurrencyName": "Brazilian Real", "BilltoBusinessUnitId": 300100052386093, "BilltoBusinessUnit": "Vision Brazil", "SoldtoLegalEntityId": 1036, "SoldtoLegalEntity": "Vision Brazil", "IssuerLocationId": 300100093494041, "PartyTypeIssuerAddress": "Example Co. BR", "LETypeIssuerAddress": null, "IssuerPartyId": 300100093494032, "PartyTypeIssuerName": "Marcopolo", "IssuerLegalEntityName": null, "IssuerTaxId": 300100166512700, "PartyTypeIssuerTaxpayerNumber": "88611835000129", "LETypeIssuerTaxpayerNumber": null, "IssueDate": "2019-04-10", "AcknowledgedDate": "2019-04-10", "ReceiverLocationId": 23897, "PartyTypeReceiverAddress": null, "LETypeReceiverAddress": "Example 1 Co. BR", "ReceiverPartyId": 1036, "PartyTypeReceiverName": null, "ReceiverLegalEntityName": "Vision Brazil", "ReceiverTaxId": 12055, "PartyTypeReceiverTaxpayerNumber": null, "LETypeReceiverTaxpayerNumber": "65100200000161", "ShipfromLocationId": 300100093494041, "PartyTypeShipfromAddress": "Example Co. BR", "LETypeShipfromAddress": null, "ShipfromPartyId": 300100093494032, "PartyTypeShipfromName": "Marcopolo", "ShipfromLegalEntityName": null, "ShipfromTaxId": 300100166512700, "PartyTypeShipfromTaxpayerNumber": "88611835000129", "LETypeShipfromTaxpayerNumber": null, "ShiptoLocationId": 23897, "PartyTypeShiptoAddress": null, "LETypeShiptoAddress": "Example 1 Co. BR", "ShiptoPartyId": 1036, "PartyTypeShiptoName": null, "ShiptoLegalEntityName": "Vision Brazil", "ShiptoTaxId": 12055, "PartyTypeShiptoTaxpayerNumber": null, "LETypeShiptoTaxpayerNumber": "65100200000161", "Series": "1", "SubSeries": null, "TotalAmount": 532, "DocumentTypeCode": "REMITTANCE", "DocumentType": "Remittance", "SourceDocumentTypeCode": "PURCHASE_ORDER", "SourceDocumentType": "Purchase order", "Usage": "MATERIAL", "fiscalDocumentLines": [ { "DocumentId": 300100178959504, "LineId": 300100178959505, "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-10", "UOMCode": "BOX", "UOMName": "BOX", "Price": 100, "Amount": 500, "ChargesAmount": 7, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100178959504/child/fiscalDocumentLines/300100178959505", "name": "fiscalDocumentLines", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000378" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100178959504/child/fiscalDocumentLines/300100178959505", "name": "fiscalDocumentLines", "kind": "item" }, { "rel": "parent", "href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100178959504", "name": "inboundFiscalDocuments", "kind": "item" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100178959504/child/fiscalDocumentLines/300100178959505/child/fiscalDocumentSchedules", "name": "fiscalDocumentSchedules", "kind": "collection" } ] } ], "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100178959504", "name": "inboundFiscalDocuments", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000678" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100178959504", "name": "inboundFiscalDocuments", "kind": "item" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100178959504/child/fiscalDocumentLines", "name": "fiscalDocumentLines", "kind": "collection" } ] } ], "count": 1, "hasMore": false, "limit": 25, "offset": 0, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments", "name": "inboundFiscalDocuments", "kind": "collection" } ] }
Example 2 cURL Command
Use the following cURL command to submit a request on the REST resource to get all lines by providing the inventory item in a bill to business unit:
curl -u username:password "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments?finder=findByBilltoBusinessUnit;bindBillToBusinessUnit=Vision Brazil,bindInventoryItemNumber=BR01&expand=fiscalDocumentLines"
Example 2 Response Body
The following shows an example of the response body in JSON format.
{ "items": [ { "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", "fiscalDocumentLines": [ { "DocumentId": 300100166952295, "LineId": 300100166952297, "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": 1, "PhysicalReceiptQuantity": 1, "PhysicalReceiptDate": "2018-06-06", "UOMCode": "BOX", "UOMName": "BOX", "Price": 10, "Amount": 10, "ChargesAmount": 0.8, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100166952295/child/fiscalDocumentLines/300100166952297", "name": "fiscalDocumentLines", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000378" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100166952295/child/fiscalDocumentLines/300100166952297", "name": "fiscalDocumentLines", "kind": "item" }, { "rel": "parent", "href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100166952295", "name": "inboundFiscalDocuments", "kind": "item" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100166952295/child/fiscalDocumentLines/300100166952297/child/fiscalDocumentSchedules", "name": "fiscalDocumentSchedules", "kind": "collection" } ] }, { "DocumentId": 300100166952295, "LineId": 300100166952299, "LineNumber": 2, "LineSourceDocumentTypeCode": "PURCHASE_ORDER", "LineSourceDocumentType": "Purchase order", "SourceDocumentBUId": 300100052386093, "SourceDocumentBUName": "Vision Brazil", "InventoryItemId": 300100068025063, "InventoryItemNumber": "BR02", "InventoryItemDescription": "Brazil Purchased Item 02", "TypeCode": "GOODS", "Type": "Goods", "Quantity": 2, "PhysicalReceiptQuantity": 2, "PhysicalReceiptDate": "2018-06-06", "UOMCode": "BOX", "UOMName": "BOX", "Price": 20, "Amount": 40, "ChargesAmount": 3.2, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100166952295/child/fiscalDocumentLines/300100166952299", "name": "fiscalDocumentLines", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000378" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100166952295/child/fiscalDocumentLines/300100166952299", "name": "fiscalDocumentLines", "kind": "item" }, { "rel": "parent", "href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100166952295", "name": "inboundFiscalDocuments", "kind": "item" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100166952295/child/fiscalDocumentLines/300100166952299/child/fiscalDocumentSchedules", "name": "fiscalDocumentSchedules", "kind": "collection" } ] } ], "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": "Example Co. BR", "LETypeReceiverAddress": null, "ReceiverPartyId": 300100151423461, "PartyTypeReceiverName": "Brazil-USA Supplier", "ReceiverLegalEntityName": null, "ReceiverTaxId": null, "PartyTypeReceiverTaxpayerNumber": null, "LETypeReceiverTaxpayerNumber": null, "ShipfromLocationId": 300100151423471, "PartyTypeShipfromAddress": "Example Co. BR", "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", "fiscalDocumentLines": [ { "DocumentId": 300100171421860, "LineId": 300100171421862, "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": 1, "PhysicalReceiptQuantity": null, "PhysicalReceiptDate": "2018-10-11", "UOMCode": "BOX", "UOMName": "BOX", "Price": 100, "Amount": 100, "ChargesAmount": 0, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100171421860/child/fiscalDocumentLines/300100171421862", "name": "fiscalDocumentLines", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100171421860/child/fiscalDocumentLines/300100171421862", "name": "fiscalDocumentLines", "kind": "item" }, { "rel": "parent", "href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100171421860", "name": "inboundFiscalDocuments", "kind": "item" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100171421860/child/fiscalDocumentLines/300100171421862/child/fiscalDocumentSchedules", "name": "fiscalDocumentSchedules", "kind": "collection" } ] } ], "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": 300100113814719, "DocumentNumber": "204072417024225", "AccessKey": "072417024225", "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": null, "LETypeIssuerAddress": null, "IssuerPartyId": 300100093494032, "PartyTypeIssuerName": null, "IssuerLegalEntityName": null, "IssuerTaxId": 300100093494060, "PartyTypeIssuerTaxpayerNumber": null, "LETypeIssuerTaxpayerNumber": null, "IssueDate": "2017-07-24", "AcknowledgedDate": "2017-07-24", "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", "fiscalDocumentLines": [ { "DocumentId": 300100113814719, "LineId": 300100113814806, "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": 1, "PhysicalReceiptQuantity": 1, "PhysicalReceiptDate": "2017-07-24", "UOMCode": "BOX", "UOMName": "BOX", "Price": 10, "Amount": 10, "ChargesAmount": 0.8, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100113814719/child/fiscalDocumentLines/300100113814806", "name": "fiscalDocumentLines", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000378" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100113814719/child/fiscalDocumentLines/300100113814806", "name": "fiscalDocumentLines", "kind": "item" }, { "rel": "parent", "href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100113814719", "name": "inboundFiscalDocuments", "kind": "item" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100113814719/child/fiscalDocumentLines/300100113814806/child/fiscalDocumentSchedules", "name": "fiscalDocumentSchedules", "kind": "collection" } ] }, { "DocumentId": 300100113814719, "LineId": 300100113814840, "LineNumber": 2, "LineSourceDocumentTypeCode": "PURCHASE_ORDER", "LineSourceDocumentType": "Purchase order", "SourceDocumentBUId": 300100052386093, "SourceDocumentBUName": "Vision Brazil", "InventoryItemId": 300100068025063, "InventoryItemNumber": "BR02", "InventoryItemDescription": "Brazil Purchased Item 02", "TypeCode": "GOODS", "Type": "Goods", "Quantity": 2, "PhysicalReceiptQuantity": 2, "PhysicalReceiptDate": "2017-07-24", "UOMCode": "BOX", "UOMName": "BOX", "Price": 20, "Amount": 40, "ChargesAmount": 3.2, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100113814719/child/fiscalDocumentLines/300100113814840", "name": "fiscalDocumentLines", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000378" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100113814719/child/fiscalDocumentLines/300100113814840", "name": "fiscalDocumentLines", "kind": "item" }, { "rel": "parent", "href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100113814719", "name": "inboundFiscalDocuments", "kind": "item" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100113814719/child/fiscalDocumentLines/300100113814840/child/fiscalDocumentSchedules", "name": "fiscalDocumentSchedules", "kind": "collection" } ] } ], "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100113814719", "name": "inboundFiscalDocuments", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000778" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100113814719", "name": "inboundFiscalDocuments", "kind": "item" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100113814719/child/fiscalDocumentLines", "name": "fiscalDocumentLines", "kind": "collection" } ] } ], "count": 3, "hasMore": true, "limit": 3, "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 lines by providing the fiscal document issuer and inventory item in a bill to business unit:
curl -u username:password "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments?finder=findByBilltoBusinessUnit;bindBillToBusinessUnit=Vision Brazil,bindIssuer=Marcopolo,bindInventoryItemNumber=BR01&expand=fiscalDocumentLines"
Example 3 Response Body
The following shows an example of the response body in JSON format.
{ "items": [ { "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", "fiscalDocumentLines": [ { "DocumentId": 300100166952295, "LineId": 300100166952297, "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": 1, "PhysicalReceiptQuantity": 1, "PhysicalReceiptDate": "2018-06-06", "UOMCode": "BOX", "UOMName": "BOX", "Price": 10, "Amount": 10, "ChargesAmount": 0.8, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100166952295/child/fiscalDocumentLines/300100166952297", "name": "fiscalDocumentLines", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000378" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100166952295/child/fiscalDocumentLines/300100166952297", "name": "fiscalDocumentLines", "kind": "item" }, { "rel": "parent", "href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100166952295", "name": "inboundFiscalDocuments", "kind": "item" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100166952295/child/fiscalDocumentLines/300100166952297/child/fiscalDocumentSchedules", "name": "fiscalDocumentSchedules", "kind": "collection" } ] }, { "DocumentId": 300100166952295, "LineId": 300100166952299, "LineNumber": 2, "LineSourceDocumentTypeCode": "PURCHASE_ORDER", "LineSourceDocumentType": "Purchase order", "SourceDocumentBUId": 300100052386093, "SourceDocumentBUName": "Vision Brazil", "InventoryItemId": 300100068025063, "InventoryItemNumber": "BR02", "InventoryItemDescription": "Brazil Purchased Item 02", "TypeCode": "GOODS", "Type": "Goods", "Quantity": 2, "PhysicalReceiptQuantity": 2, "PhysicalReceiptDate": "2018-06-06", "UOMCode": "BOX", "UOMName": "BOX", "Price": 20, "Amount": 40, "ChargesAmount": 3.2, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100166952295/child/fiscalDocumentLines/300100166952299", "name": "fiscalDocumentLines", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000378" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100166952295/child/fiscalDocumentLines/300100166952299", "name": "fiscalDocumentLines", "kind": "item" }, { "rel": "parent", "href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100166952295", "name": "inboundFiscalDocuments", "kind": "item" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100166952295/child/fiscalDocumentLines/300100166952299/child/fiscalDocumentSchedules", "name": "fiscalDocumentSchedules", "kind": "collection" } ] } ], "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": 300100171239464, "DocumentNumber": "310831020182", "AccessKey": "310831020182", "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": "2018-10-03", "AcknowledgedDate": "2018-10-03", "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": 122, "DocumentTypeCode": "REMITTANCE", "DocumentType": "Remittance", "SourceDocumentTypeCode": "PURCHASE_ORDER", "SourceDocumentType": "Purchase order", "Usage": "MATERIAL", "fiscalDocumentLines": [ { "DocumentId": 300100171239464, "LineId": 300100171239467, "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": 1, "PhysicalReceiptQuantity": 1, "PhysicalReceiptDate": "2018-10-03", "UOMCode": "BOX", "UOMName": "BOX", "Price": 100, "Amount": 100, "ChargesAmount": 17, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100171239464/child/fiscalDocumentLines/300100171239467", "name": "fiscalDocumentLines", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000378" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100171239464/child/fiscalDocumentLines/300100171239467", "name": "fiscalDocumentLines", "kind": "item" }, { "rel": "parent", "href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100171239464", "name": "inboundFiscalDocuments", "kind": "item" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100171239464/child/fiscalDocumentLines/300100171239467/child/fiscalDocumentSchedules", "name": "fiscalDocumentSchedules", "kind": "collection" } ] } ], "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100171239464", "name": "inboundFiscalDocuments", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000678" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100171239464", "name": "inboundFiscalDocuments", "kind": "item" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100171239464/child/fiscalDocumentLines", "name": "fiscalDocumentLines", "kind": "collection" } ] }, { "DocumentId": 300100167049043, "DocumentNumber": "208060618003601", "AccessKey": "060618003601", "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": 10, "DocumentTypeCode": "SALES_REMIT", "DocumentType": "Sales with remittance", "SourceDocumentTypeCode": "PURCHASE_ORDER", "SourceDocumentType": "Purchase order", "Usage": "MATERIAL/SERVICE", "fiscalDocumentLines": [ { "DocumentId": 300100167049043, "LineId": 300100167049045, "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": 1, "PhysicalReceiptQuantity": 1, "PhysicalReceiptDate": "2018-06-06", "UOMCode": "BOX", "UOMName": "BOX", "Price": 10, "Amount": 10, "ChargesAmount": 0, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100167049043/child/fiscalDocumentLines/300100167049045", "name": "fiscalDocumentLines", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000378" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100167049043/child/fiscalDocumentLines/300100167049045", "name": "fiscalDocumentLines", "kind": "item" }, { "rel": "parent", "href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100167049043", "name": "inboundFiscalDocuments", "kind": "item" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100167049043/child/fiscalDocumentLines/300100167049045/child/fiscalDocumentSchedules", "name": "fiscalDocumentSchedules", "kind": "collection" } ] } ], "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100167049043", "name": "inboundFiscalDocuments", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000378" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100167049043", "name": "inboundFiscalDocuments", "kind": "item" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100167049043/child/fiscalDocumentLines", "name": "fiscalDocumentLines", "kind": "collection" } ] } ], "count": 3, "hasMore": true, "limit": 3, "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 lines by providing a specific purchase order number, purchase order line number, purchase order schedule number, and a receipt number in a bill to business unit:
curl -u username:password "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments?finder=findByBilltoBusinessUnit;bindBillToBusinessUnit=Vision Brazil,bindPONumber=66,bindPOLineNumber=1,bindPOScheduleNumber=1,bindReceiptNumber=4039&expand=fiscalDocumentLines"
Example 4 Response Body
The following shows an example of the response body in JSON format.
{ "items": [ { "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 Co. BR", "ReceiverPartyId": 1036, "PartyTypeReceiverName": null, "ReceiverLegalEntityName": "Vision Brazil", "ReceiverTaxId": 12055, "PartyTypeReceiverTaxpayerNumber": null, "LETypeReceiverTaxpayerNumber": "65100200000161", "ShipfromLocationId": 300100093494041, "PartyTypeShipfromAddress": "Example 1 Co. BR", "LETypeShipfromAddress": null, "ShipfromPartyId": 300100093494032, "PartyTypeShipfromName": "Marcopolo", "ShipfromLegalEntityName": null, "ShipfromTaxId": 300100166512700, "PartyTypeShipfromTaxpayerNumber": "88611835000129", "LETypeShipfromTaxpayerNumber": null, "ShiptoLocationId": 23897, "PartyTypeShiptoAddress": null, "LETypeShiptoAddress": "Example 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" } ] }, { "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 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" } ] } ], "count": 2, "hasMore": false, "limit": 3, "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 fiscal document lines by providing a specific purchase order number, purchase order line number and purchase order schedule number in a bill to business unit:
curl -u username:password "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments?finder=findByBilltoBusinessUnit;bindBillToBusinessUnit=Vision Brazil,bindPONumber=66,bindPOLineNumber=1,bindPOScheduleNumber=1&expand=fiscalDocumentLines"
Example 5 Response Body
The following shows an example of the response body in JSON format.
{ "items": [ { "DocumentId": 300100178959504, "DocumentNumber": "310810420191", "AccessKey": "310810420191", "StatusCode": "CAPTURED", "Status": "Captured", "AssociationId": 100100077234663, "FiscalFlow": "Consignment Remittance", "ParentDocumentId": null, "ParentDocumentNumber": null, "CurrencyCode": "BRL", "CurrencyName": "Brazilian Real", "BilltoBusinessUnitId": 300100052386093, "BilltoBusinessUnit": "Vision Brazil", "SoldtoLegalEntityId": 1036, "SoldtoLegalEntity": "Vision Brazil", "IssuerLocationId": 300100093494041, "PartyTypeIssuerAddress": "Example Co. BR", "LETypeIssuerAddress": null, "IssuerPartyId": 300100093494032, "PartyTypeIssuerName": "Marcopolo", "IssuerLegalEntityName": null, "IssuerTaxId": 300100166512700, "PartyTypeIssuerTaxpayerNumber": "88611835000129", "LETypeIssuerTaxpayerNumber": null, "IssueDate": "2019-04-10", "AcknowledgedDate": "2019-04-10", "ReceiverLocationId": 23897, "PartyTypeReceiverAddress": null, "LETypeReceiverAddress": "Example 1 Co. BR", "ReceiverPartyId": 1036, "PartyTypeReceiverName": null, "ReceiverLegalEntityName": "Vision Brazil", "ReceiverTaxId": 12055, "PartyTypeReceiverTaxpayerNumber": null, "LETypeReceiverTaxpayerNumber": "65100200000161", "ShipfromLocationId": 300100093494041, "PartyTypeShipfromAddress": "Example Co. BR", "LETypeShipfromAddress": null, "ShipfromPartyId": 300100093494032, "PartyTypeShipfromName": "Marcopolo", "ShipfromLegalEntityName": null, "ShipfromTaxId": 300100166512700, "PartyTypeShipfromTaxpayerNumber": "88611835000129", "LETypeShipfromTaxpayerNumber": null, "ShiptoLocationId": 23897, "PartyTypeShiptoAddress": null, "LETypeShiptoAddress": "Example 1 Co. BR", "ShiptoPartyId": 1036, "PartyTypeShiptoName": null, "ShiptoLegalEntityName": "Vision Brazil", "ShiptoTaxId": 12055, "PartyTypeShiptoTaxpayerNumber": null, "LETypeShiptoTaxpayerNumber": "65100200000161", "Series": "1", "SubSeries": null, "TotalAmount": 532, "DocumentTypeCode": "REMITTANCE", "DocumentType": "Remittance", "SourceDocumentTypeCode": "PURCHASE_ORDER", "SourceDocumentType": "Purchase order", "Usage": "MATERIAL", "fiscalDocumentLines": [ { "DocumentId": 300100178959504, "LineId": 300100178959505, "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-10", "UOMCode": "BOX", "UOMName": "BOX", "Price": 100, "Amount": 500, "ChargesAmount": 7, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100178959504/child/fiscalDocumentLines/300100178959505", "name": "fiscalDocumentLines", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000378" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100178959504/child/fiscalDocumentLines/300100178959505", "name": "fiscalDocumentLines", "kind": "item" }, { "rel": "parent", "href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100178959504", "name": "inboundFiscalDocuments", "kind": "item" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100178959504/child/fiscalDocumentLines/300100178959505/child/fiscalDocumentSchedules", "name": "fiscalDocumentSchedules", "kind": "collection" } ] } ], "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100178959504", "name": "inboundFiscalDocuments", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000678" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100178959504", "name": "inboundFiscalDocuments", "kind": "item" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100178959504/child/fiscalDocumentLines", "name": "fiscalDocumentLines", "kind": "collection" } ] }, { "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": 300100171239464, "DocumentNumber": "310831020182", "AccessKey": "310831020182", "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": "2018-10-03", "AcknowledgedDate": "2018-10-03", "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": 122, "DocumentTypeCode": "REMITTANCE", "DocumentType": "Remittance", "SourceDocumentTypeCode": "PURCHASE_ORDER", "SourceDocumentType": "Purchase order", "Usage": "MATERIAL", "fiscalDocumentLines": [ { "DocumentId": 300100171239464, "LineId": 300100171239467, "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": 1, "PhysicalReceiptQuantity": 1, "PhysicalReceiptDate": "2018-10-03", "UOMCode": "BOX", "UOMName": "BOX", "Price": 100, "Amount": 100, "ChargesAmount": 17, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100171239464/child/fiscalDocumentLines/300100171239467", "name": "fiscalDocumentLines", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000378" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100171239464/child/fiscalDocumentLines/300100171239467", "name": "fiscalDocumentLines", "kind": "item" }, { "rel": "parent", "href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100171239464", "name": "inboundFiscalDocuments", "kind": "item" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100171239464/child/fiscalDocumentLines/300100171239467/child/fiscalDocumentSchedules", "name": "fiscalDocumentSchedules", "kind": "collection" } ] } ], "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100171239464", "name": "inboundFiscalDocuments", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000678" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100171239464", "name": "inboundFiscalDocuments", "kind": "item" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100171239464/child/fiscalDocumentLines", "name": "fiscalDocumentLines", "kind": "collection" } ] } ], "count": 3, "hasMore": true, "limit": 3, "offset": 0, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments", "name": "inboundFiscalDocuments", "kind": "collection" } ] }