Get one document
/fscmRestApi/resources/11.13.18.05/inboundFiscalDocuments/{DocumentId}
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 -
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
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:
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.
object-
AccessKey: string
Title:
Access KeyMaximum Length:64Number that identifies the access key of the referenced inbound fiscal document. -
AcknowledgedDate: string
(date)
Title:
Acknowledged DateDate when the receipt of the fiscal document is acknowledged. -
ASNNumber: string
Title:
ASN NumberMaximum Length:80Advanced shipment notice number associated with the drop ship seller flow. -
AssociationId: integer
(int64)
Title:
Association IDValue that uniquely associates the inbound fiscal document with a fiscal document process or type. -
BilltoBusinessUnit: string
Title:
Bill-to BURead Only:trueMaximum Length:240Name of the business unit that is receiving the fiscal documents. -
BilltoBusinessUnitId: integer
(int64)
Title:
Bill-to BU IDValue that uniquely identifies the bill to business unit. -
ConsumptionAdviceNumber: string
Title:
Consumption Advice NumberMaximum Length:80Consumption advice reference number associated with the consigned fiscal flow. -
CurrencyCode: string
Title:
Currency CodeMaximum Length:30Default Value:BRLCode that identifies the currency of the amount. -
CurrencyName: string
Title:
Currency NameRead Only:trueMaximum Length:80Name of the currency of the fiscal document. -
DocumentId: integer
(int64)
Title:
Document IDValue that uniquely identifies the inbound fiscal document. -
DocumentNumber: string
Title:
Document NumberMaximum Length:30Number that identifies the inbound fiscal document. -
DocumentType: string
Title:
Document TypeMaximum Length:255Type of the fiscal document sent by supplier or party. -
DocumentTypeCode: string
Title:
Document Type CodeMaximum Length:30Code 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 LinesThe 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 FlowRead Only:trueMaximum Length:80Name of the fiscal flow that defines the business flow for a fiscal document. -
IssueDate: string
(date)
Title:
Issue DateDate when the fiscal document is issued. -
IssuerLegalEntityName: string
Title:
Issuer NameRead Only:trueMaximum Length:240Name of the issuer of the fiscal document. -
IssuerLocationId: integer
(int64)
Title:
Issuer Location IDValue that uniquely identifies the company site location that creates the fiscal document. -
IssuerPartyId: integer
(int64)
Title:
Issuer Party IDValue that uniquely identifies the company that creates the fiscal document. -
IssuerTaxId: integer
(int64)
Title:
Issuer Tax IDValue that uniquely identifies the tax of the company that creates the fiscal document. -
LETypeIssuerAddress: string
Title:
Issuer AddressRead Only:trueMaximum Length:3852Address of the company that creates the fiscal document. -
LETypeIssuerTaxpayerNumber: string
Title:
Issuer Taxpayer IDRead Only:trueMaximum Length:14Number that identifies the tax payer who is the issuer of the fiscal document. -
LETypeReceiverAddress: string
Title:
Receiver AddressRead Only:trueMaximum Length:3852Address of receiver of the fiscal document. -
LETypeReceiverTaxpayerNumber: string
Title:
Receiver Taxpayer IDRead Only:trueMaximum Length:14Number that identifies the tax payer who is the receiver of the fiscal document. -
LETypeShipfromAddress: string
Title:
Ship-from AddressRead Only:trueMaximum Length:3852Address of the party from where the goods are being shipped. -
LETypeShipfromTaxpayerNumber: string
Title:
Ship-from Taxpayer IDRead Only:trueMaximum Length:14Number that identifies the taxpayer of the ship-from location of the goods or service. -
LETypeShiptoAddress: string
Title:
Ship-to AddressRead Only:trueMaximum Length:3852Address of the party to where the goods are being shipped. -
LETypeShiptoTaxpayerNumber: string
Title:
Ship-to Taxpayer IDRead Only:trueMaximum Length:14Number that identifies the taxpayer of the party to whom the goods are being shipped. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
ParentDocumentId: integer
(int64)
Title:
Parent Document IDValue that uniquely identifies the parent fiscal document header. -
ParentDocumentNumber: string
Title:
Parent Document NumberMaximum Length:255Number that identifies the referenced fiscal document. -
PartyTypeIssuerAddress: string
Title:
Issuer AddressRead Only:trueMaximum Length:2658Address of the company that creates the fiscal document. -
PartyTypeIssuerName: string
Title:
Issuer NameRead Only:trueMaximum Length:360Name of the issuer of the fiscal document. -
PartyTypeIssuerTaxpayerNumber: string
Title:
Issuer Taxpayer IDRead Only:trueMaximum Length:14Number that identifies the tax payer who is the issuer of the fiscal document. -
PartyTypeReceiverAddress: string
Title:
Receiver AddressRead Only:trueMaximum Length:2658Address of receiver of the fiscal document. -
PartyTypeReceiverName: string
Title:
Receiver NameRead Only:trueMaximum Length:360Name of the receiver of goods. -
PartyTypeReceiverTaxpayerNumber: string
Title:
Receiver Taxpayer IDRead Only:trueMaximum Length:14Number that identifies the tax payer who is the receiver of the fiscal document. -
PartyTypeShipfromAddress: string
Title:
Ship-from AddressRead Only:trueMaximum Length:2658Address of the party from where the goods are being shipped. -
PartyTypeShipfromName: string
Title:
Ship-from NameRead Only:trueMaximum Length:360Name of the party from whom the goods are being shipped. -
PartyTypeShipfromTaxpayerNumber: string
Title:
Ship-from Taxpayer IDRead Only:trueMaximum Length:14Number that identifies the taxpayer of the ship-from location of the goods or service. -
PartyTypeShiptoAddress: string
Title:
Ship-to AddressRead Only:trueMaximum Length:2658Address of the party to where the goods are being shipped. -
PartyTypeShiptoName: string
Title:
Ship-to NameRead Only:trueMaximum Length:360Name of the party to whom the goods are being shipped. -
PartyTypeShiptoTaxpayerNumber: string
Title:
Ship-to Taxpayer IDRead Only:trueMaximum Length:14Number that identifies the taxpayer of the party to whom the goods are being shipped. -
ReceiverLegalEntityName: string
Title:
Receiver NameRead Only:trueMaximum Length:240Name of the receiver of items. -
ReceiverLocationId: integer
(int64)
Title:
Receiver Location IDValue that uniquely identifies the company site location that receives the fiscal document. -
ReceiverPartyId: integer
(int64)
Title:
Receiver Party IDValue that uniquely identifies the company that receives the fiscal document. -
ReceiverTaxId: integer
(int64)
Title:
Receiver Tax IDValue that uniquely identifies the tax of the company that creates the fiscal document. -
Series: string
Title:
SeriesMaximum Length:10Series of the fiscal document. -
ShipfromLegalEntityName: string
Title:
Ship-from NameRead Only:trueMaximum Length:240Name of the party from whom the goods are being shipped. -
ShipfromLocationId: integer
(int64)
Title:
Ship-from Location IDValue that uniquely identifies the company site location that ships the goods. -
ShipfromPartyId: integer
(int64)
Title:
Ship-from Party IDValue that uniquely identifies the company that ships the goods. -
ShipfromTaxId: integer
(int64)
Title:
Ship-from Tax IDValue that uniquely identifies the tax of the third party from whom the goods are being shipped. -
ShiptoLegalEntityName: string
Title:
Ship-to NameRead Only:trueMaximum Length:240Name of the party to whom the goods are being shipped. -
ShiptoLocationId: integer
(int64)
Title:
Ship-to Location IDValue that uniquely identifies the company site location that receives the goods. -
ShiptoPartyId: integer
(int64)
Title:
Ship-to Party IDValue that uniquely identifies the company that receives the goods. -
ShiptoTaxId: integer
(int64)
Title:
Ship-to Tax IDValue that uniquely identifies the taxpayer of the third-party to whom the goods are being shipped. -
SoldtoLegalEntity: string
Title:
Sold-to Legal EntityRead Only:trueMaximum Length:240Legal entity that pays for the goods. -
SoldtoLegalEntityId: integer
(int64)
Title:
Sold-to Legal Entity IDValue 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 TypeMaximum Length:255Type of the source fiscal document. -
SourceDocumentTypeCode: string
Title:
Source Document Type CodeMaximum Length:30Code 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:
StatusMaximum Length:255Status of the inbound fiscal document. -
StatusCode: string
Title:
Status CodeMaximum Length:30Default Value:NEWCode that identifies the status of the inbound fiscal document. -
SubSeries: string
Title:
SubseriesMaximum Length:10Subseries of the fiscal document. -
TotalAmount: number
Title:
Total AmountAmount on the fiscal document header. -
Usage: string
Read Only:
trueMaximum Length:30Code that distinguishes the fiscal document usage.
arrayFiscal Document LinesarrayLinksobject-
Amount: number
Title:
AmountRead Only:trueAmount on the fiscal document item line. -
ChargesAmount: number
Title:
ChargesRead Only:trueUnit price of goods or services. -
DocumentId: integer
(int64)
Title:
Document IDRead Only:trueValue that uniquely identifies the inbound fiscal document. -
ExternalItem: string
Title:
External ItemRead Only:trueMaximum Length:300Indicates the name of the item given on the fiscal document sent by the issuer. -
ExternalItemDescription: string
Title:
DescriptionRead Only:trueMaximum Length:250Indicates the description of the item given on the fiscal document sent by the issuer. -
FciControlNumber: string
Title:
FCI NumberRead Only:trueMaximum Length:36Displays 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 SchedulesThe Fiscal Document Schedules resource gets the schedule information of the fiscal document. -
InventoryItemDescription: string
Title:
Item DescriptionRead Only:trueDescription of the item on the fiscal document line. -
InventoryItemId: integer
(int64)
Title:
Item IDRead Only:trueValue that uniquely identifies the item. -
InventoryItemNumber: string
Title:
Item CodeRead Only:trueMaximum Length:80Number that identifies the item on the fiscal document line. -
LineId: integer
(int64)
Title:
Document Line IDRead Only:trueValue that uniquely identifies the fiscal document line. -
LineNumber: number
Title:
Line NumberRead Only:trueNumber that identifies the line of the fiscal document item. -
LineSourceDocumentType: string
Title:
Source Document TypeRead Only:trueMaximum Length:255Type of the fiscal document sent by supplier or party. -
LineSourceDocumentTypeCode: string
Title:
Source Document Type CodeRead Only:trueMaximum Length:30Code that identifies the document type that acts as source for the fiscal document that is captured or created. -
LineStatus: string
Title:
Status CodeRead Only:trueMaximum Length:30Default Value:NEWStatus of the item line. This value is generated by the application. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
PhysicalReceiptDate: string
(date)
Title:
Physical Receipt DateRead Only:trueDate when goods or service are physically received. -
PhysicalReceiptQuantity: number
Title:
Delivered QuantityQuantity that was physically received. -
Price: number
Title:
Unit PriceRead Only:trueUnit price of goods or services. -
Quantity: number
Title:
QuantityRead Only:trueQuantity on the fiscal document line. -
SecondaryQuantity: number
Title:
Secondary QuantityIndicates the quantity in the secondary unit of measure for a dual-UOM-controlled item. -
SecondaryUOMCode: string
Title:
Secondary UOMRead Only:trueMaximum Length:30Indicates the UOM code of the alternative unit of measure that's allowed to quantify a dual-UOM-controlled item. -
SecondaryUOMName: string
Title:
Secondary UOMRead Only:trueMaximum Length:25Indicates the alternative unit of measure that's allowed to quantify a dual-UOM-controlled item. -
SourceDocumentBUId: integer
(int64)
Title:
Source Document BU IDRead Only:trueValue that uniquely identifies the source document business unit. -
SourceDocumentBUName: string
Title:
Source Document BURead Only:trueMaximum Length:255Name of the business unit for the source document. Valid values are Procurement BU, Requisition BU, or Receivable BU. -
Status: string
Title:
StatusMaximum Length:30Status of the fiscal document line. -
Type: string
Title:
Line TypeRead Only:trueMaximum Length:255Type of line on the fiscal document. -
TypeCode: string
Title:
Type CodeRead Only:trueMaximum Length:30Code that identifies the type of line on the fiscal document. -
UOMCode: string
Title:
UOM CodeRead Only:trueMaximum Length:30Code that identifies the unit of measure of the item quantity that was physically received. -
UOMName: string
Title:
UOM NameRead Only:trueMaximum Length:25Name of the base unit of measure to be used where allocation basis is quantity, weight, or volume.
arrayFiscal Document SchedulesarrayLinksobject-
AllocatedQuantity: number
Title:
Allocated QuantityAllocated quantity on the fiscal document schedule. -
AllocatedQuantityInFiscalDocumentLineUOM: number
Title:
Allocated QuantitySource document quantity allocated on a fiscal document schedule in the fiscal document unit of measure of the item line. -
AllocatedQuantityInSecondaryUOM: number
Title:
Secondary QuantitySource document quantity allocated on a fiscal document schedule in the secondary unit of measure of the item. -
ASNLineNumber: string
Title:
ASN Line NumberMaximum Length:80Advanced shipment notice line associated with the drop ship seller flow. -
ConsumptionAdviceLine: string
Title:
Consumption Advice Line NumberMaximum Length:80Consumption advice line number associated with the consigned fiscal flow. -
DocumentId: integer
(int64)
Title:
Document IDValue that uniquely identifies the inbound fiscal document. -
ItemDescription: string
Title:
DescriptionRead Only:trueMaximum Length:240Indicates the description of the item. -
LineId: integer
(int64)
Title:
Document Line IDValue that uniquely identifies the fiscal document line. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
POLineNumber: number
Title:
PO Line NumberRead Only:trueNumber that identifies the line of the purchase order. -
PONumber: string
Title:
PO NumberRead Only:trueMaximum Length:30Number that identifies the purchase order. -
POScheduleNumber: number
Title:
PO Schedule NumberRead Only:trueNumber that identifies the schedule of the purchase order. -
PricingUOMCode: string
Title:
Pricing UOMRead Only:trueMaximum Length:3Indicates the UOM code in which the price of the item in the source document is shown. -
PricingUOMName: string
Title:
Pricing UOMRead Only:trueMaximum Length:255Indicates the unit of measure in which the price of the item in the source document is shown. -
PromisedDate: string
(date-time)
Title:
Promised Delivery DateRead Only:trueDate when the materials are promised to be delivered. -
ReceiptLineNumber: integer
Title:
Receipt LineLine number of the physical receipt. -
ReceiptNumber: string
Title:
Receipt NumberMaximum Length:30Number that identifies the purchase order receipt. -
SalesReturnOrderLine: string
Title:
Sales Return Order LineMaximum Length:30Number that identifies the line of a return order. -
SalesReturnOrderNumber: string
Title:
Sales Return Order NumberMaximum Length:30Number that identifies the return order. -
SalesReturnOrderSchedule: string
Title:
Sales Return Order ScheduleMaximum Length:30Number that identifies the schedule of a return order. -
ScheduleId: integer
(int64)
Title:
Schedule IDValue that uniquely identifies the fiscal document schedule. -
ScheduleNumber: number
Title:
Schedule NumberNumber that identifies the schedule of the fiscal document item line. -
SecondaryUOMCode: string
Title:
Secondary UOMMaximum Length:30Indicates the UOM code of the alternative unit of measure that's allowed to quantify a dual-UOM-controlled item. -
SecondaryUOMName: string
Title:
Secondary UOMRead Only:trueMaximum Length:25Indicates the alternative unit of measure that's allowed to quantify a dual-UOM-controlled item. -
ShipmentLine: string
Title:
Shipment LineMaximum Length:30Number that identifies the line of a shipment. -
ShipmentNumber: string
Title:
Shipment NumberMaximum Length:30Number that identifies the shipment. -
SourceDocumentCurrencyCode: string
Title:
Source Document Currency CodeMaximum Length:30Code that identifies the currency of the source document. -
SourceDocumentCurrencyName: string
Title:
Source Document CurrencyRead Only:trueMaximum Length:255Name of the currency of the item that is taken from the source document. -
SourceDocumentId: integer
(int64)
Title:
Source Document IDValue that uniquely identifies the source document of the schedule. -
SourceDocumentLineId: integer
(int64)
Title:
Source Document Line IDValue that uniquely identifies the source document line of the schedule. -
SourceDocumentPrice: number
Title:
Source Document PricePrice of the item that is taken from the source document. -
SourceDocumentScheduleId: integer
(int64)
Title:
Source Document Schedule IDValue that uniquely identifies the source document schedule of the schedule. -
SourceDocumentType: string
Title:
Source Document TypeRead Only:trueMaximum Length:255Type of document for which the fiscal document is captured or created. -
SourceDocumentTypeCode: string
Title:
Source Document Type CodeMaximum Length:30Default Value:PURCHASE_ORDERCode that identifies the document type that acts as source for the fiscal document that is captured or created. -
SourceDocumentUOMCode: string
Title:
Source Document UOM CodeMaximum Length:30Code that identifies the unit of measure of the source document. -
SourceDocumentUOMName: string
Title:
Source Document UOMRead Only:trueMaximum Length:255Name 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 ItemRead Only:trueMaximum Length:300Indicates the supplier's identification number or code for the goods ordered on the source document order line.
arrayLinksobject-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed 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.
- fiscalDocumentLines
-
Operation: /fscmRestApi/resources/11.13.18.05/inboundFiscalDocuments/{DocumentId}/child/fiscalDocumentLinesParameters:
- DocumentId:
$request.path.DocumentId
The Fiscal Document Lines resource gets the fiscal document lines information. It also allows update of delivered quantity to confirm item deliveries. - DocumentId:
Examples
This example describes how to get one document.
Example 1 cURL Command
Use the following cURL command to submit a request on the REST resourceto get one document by fiscal document header identifier:
curl -u username:password "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100178959504"
Example 1 Response Body
The following shows an example of the response body in JSON format.
{
"DocumentId": 300100178959504,
"DocumentNumber": "310810420191",
"AccessKey": "310810420191",
"StatusCode": "CAPTURED",
"Status": "Captured",
"AssociationId": 100100077234663,
"FiscalFlow": "Consignment Remittance",
"ParentDocumentId": null,
"ParentDocumentNumber": null,
"CurrencyCode": "BRL",
"CurrencyName": "Brazilian Real",
"BilltoBusinessUnitId": 300100052386093,
"BilltoBusinessUnit": "Vision Brazil",
"SoldtoLegalEntityId": 1036,
"SoldtoLegalEntity": "Vision Brazil",
"IssuerLocationId": 300100093494041,
"PartyTypeIssuerAddress": "Example Co. BR",
"LETypeIssuerAddress": null,
"IssuerPartyId": 300100093494032,
"PartyTypeIssuerName": "Marcopolo",
"IssuerLegalEntityName": null,
"IssuerTaxId": 300100166512700,
"PartyTypeIssuerTaxpayerNumber": "88611835000129",
"LETypeIssuerTaxpayerNumber": null,
"IssueDate": "2019-04-10",
"AcknowledgedDate": "2019-04-10",
"ReceiverLocationId": 23897,
"PartyTypeReceiverAddress": null,
"LETypeReceiverAddress": "Example 1 Co. BR",
"ReceiverPartyId": 1036,
"PartyTypeReceiverName": null,
"ReceiverLegalEntityName": "Vision Brazil",
"ReceiverTaxId": 12055,
"PartyTypeReceiverTaxpayerNumber": null,
"LETypeReceiverTaxpayerNumber": "65100200000161",
"ShipfromLocationId": 300100093494041,
"PartyTypeShipfromAddress": "Example Co. BR",
"LETypeShipfromAddress": null,
"ShipfromPartyId": 300100093494032,
"PartyTypeShipfromName": "Marcopolo",
"ShipfromLegalEntityName": null,
"ShipfromTaxId": 300100166512700,
"PartyTypeShipfromTaxpayerNumber": "88611835000129",
"LETypeShipfromTaxpayerNumber": null,
"ShiptoLocationId": 23897,
"PartyTypeShiptoAddress": null,
"LETypeShiptoAddress": "Example 1 Co. BR",
"ShiptoPartyId": 1036,
"PartyTypeShiptoName": null,
"ShiptoLegalEntityName": "Vision Brazil",
"ShiptoTaxId": 12055,
"PartyTypeShiptoTaxpayerNumber": null,
"LETypeShiptoTaxpayerNumber": "65100200000161",
"Series": "1",
"SubSeries": null,
"TotalAmount": 532,
"DocumentTypeCode": "REMITTANCE",
"DocumentType": "Remittance",
"SourceDocumentTypeCode": "PURCHASE_ORDER",
"SourceDocumentType": "Purchase order",
"Usage": "MATERIAL",
"links": [
{
"rel": "self",
"href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100178959504",
"name": "inboundFiscalDocuments",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000678"
}
},
{
"rel": "canonical",
"href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100178959504",
"name": "inboundFiscalDocuments",
"kind": "item"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100178959504/child/fiscalDocumentLines",
"name": "fiscalDocumentLines",
"kind": "collection"
}
]
}Example 2 cURL Command
Use the following cURL command to submit a request on the REST resourceto get one document by fiscal document number:
curl -u username:password "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments?q=DocumentNumber=310810420191"
Example 2 Response Body
The following shows an example of the response body in JSON format.
{
"items": [
{
"DocumentId": 300100178959504,
"DocumentNumber": "310810420191",
"AccessKey": "310810420191",
"StatusCode": "CAPTURED",
"Status": "Captured",
"AssociationId": 100100077234663,
"FiscalFlow": "Consignment Remittance",
"ParentDocumentId": null,
"ParentDocumentNumber": null,
"CurrencyCode": "BRL",
"CurrencyName": "Brazilian Real",
"BilltoBusinessUnitId": 300100052386093,
"BilltoBusinessUnit": "Vision Brazil",
"SoldtoLegalEntityId": 1036,
"SoldtoLegalEntity": "Vision Brazil",
"IssuerLocationId": 300100093494041,
"PartyTypeIssuerAddress": "Example Co. BR",
"LETypeIssuerAddress": null,
"IssuerPartyId": 300100093494032,
"PartyTypeIssuerName": "Marcopolo",
"IssuerLegalEntityName": null,
"IssuerTaxId": 300100166512700,
"PartyTypeIssuerTaxpayerNumber": "88611835000129",
"LETypeIssuerTaxpayerNumber": null,
"IssueDate": "2019-04-10",
"AcknowledgedDate": "2019-04-10",
"ReceiverLocationId": 23897,
"PartyTypeReceiverAddress": null,
"LETypeReceiverAddress": "Example 1 Co. BR",
"ReceiverPartyId": 1036,
"PartyTypeReceiverName": null,
"ReceiverLegalEntityName": "Vision Brazil",
"ReceiverTaxId": 12055,
"PartyTypeReceiverTaxpayerNumber": null,
"LETypeReceiverTaxpayerNumber": "65100200000161",
"ShipfromLocationId": 300100093494041,
"PartyTypeShipfromAddress": "Example Co. BR",
"LETypeShipfromAddress": null,
"ShipfromPartyId": 300100093494032,
"PartyTypeShipfromName": "Marcopolo",
"ShipfromLegalEntityName": null,
"ShipfromTaxId": 300100166512700,
"PartyTypeShipfromTaxpayerNumber": "88611835000129",
"LETypeShipfromTaxpayerNumber": null,
"ShiptoLocationId": 23897,
"PartyTypeShiptoAddress": null,
"LETypeShiptoAddress": "Example 1 Co. BR",
"ShiptoPartyId": 1036,
"PartyTypeShiptoName": null,
"ShiptoLegalEntityName": "Vision Brazil",
"ShiptoTaxId": 12055,
"PartyTypeShiptoTaxpayerNumber": null,
"LETypeShiptoTaxpayerNumber": "65100200000161",
"Series": "1",
"SubSeries": null,
"TotalAmount": 532,
"DocumentTypeCode": "REMITTANCE",
"DocumentType": "Remittance",
"SourceDocumentTypeCode": "PURCHASE_ORDER",
"SourceDocumentType": "Purchase order",
"Usage": "MATERIAL",
"links": [
{
"rel": "self",
"href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100178959504",
"name": "inboundFiscalDocuments",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000678"
}
},
{
"rel": "canonical",
"href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100178959504",
"name": "inboundFiscalDocuments",
"kind": "item"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100178959504/child/fiscalDocumentLines",
"name": "fiscalDocumentLines",
"kind": "collection"
}
]
}
],
"count": 1,
"hasMore": false,
"limit": 25,
"offset": 0,
"links": [
{
"rel": "self",
"href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments",
"name": "inboundFiscalDocuments",
"kind": "collection"
}
]
}Example 3 cURL Command
Use the following cURL command to submit a request on the REST resourceto get one document by access key:
curl -u username:password "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments?q=AccessKey=310810420191"
Example 3 Response Body
The following shows an example of the response body in JSON format.
{
"items": [
{
"DocumentId": 300100178959504,
"DocumentNumber": "310810420191",
"AccessKey": "310810420191",
"StatusCode": "CAPTURED",
"Status": "Captured",
"AssociationId": 100100077234663,
"FiscalFlow": "Consignment Remittance",
"ParentDocumentId": null,
"ParentDocumentNumber": null,
"CurrencyCode": "BRL",
"CurrencyName": "Brazilian Real",
"BilltoBusinessUnitId": 300100052386093,
"BilltoBusinessUnit": "Vision Brazil",
"SoldtoLegalEntityId": 1036,
"SoldtoLegalEntity": "Vision Brazil",
"IssuerLocationId": 300100093494041,
"PartyTypeIssuerAddress": "Example Co. BR",
"LETypeIssuerAddress": null,
"IssuerPartyId": 300100093494032,
"PartyTypeIssuerName": "Marcopolo",
"IssuerLegalEntityName": null,
"IssuerTaxId": 300100166512700,
"PartyTypeIssuerTaxpayerNumber": "88611835000129",
"LETypeIssuerTaxpayerNumber": null,
"IssueDate": "2019-04-10",
"AcknowledgedDate": "2019-04-10",
"ReceiverLocationId": 23897,
"PartyTypeReceiverAddress": null,
"LETypeReceiverAddress": "Example 1 Co. BR",
"ReceiverPartyId": 1036,
"PartyTypeReceiverName": null,
"ReceiverLegalEntityName": "Vision Brazil",
"ReceiverTaxId": 12055,
"PartyTypeReceiverTaxpayerNumber": null,
"LETypeReceiverTaxpayerNumber": "65100200000161",
"ShipfromLocationId": 300100093494041,
"PartyTypeShipfromAddress": "Example Co. BR",
"LETypeShipfromAddress": null,
"ShipfromPartyId": 300100093494032,
"PartyTypeShipfromName": "Marcopolo",
"ShipfromLegalEntityName": null,
"ShipfromTaxId": 300100166512700,
"PartyTypeShipfromTaxpayerNumber": "88611835000129",
"LETypeShipfromTaxpayerNumber": null,
"ShiptoLocationId": 23897,
"PartyTypeShiptoAddress": null,
"LETypeShiptoAddress": "Example 1 Co. BR",
"ShiptoPartyId": 1036,
"PartyTypeShiptoName": null,
"ShiptoLegalEntityName": "Vision Brazil",
"ShiptoTaxId": 12055,
"PartyTypeShiptoTaxpayerNumber": null,
"LETypeShiptoTaxpayerNumber": "65100200000161",
"Series": "1",
"SubSeries": null,
"TotalAmount": 532,
"DocumentTypeCode": "REMITTANCE",
"DocumentType": "Remittance",
"SourceDocumentTypeCode": "PURCHASE_ORDER",
"SourceDocumentType": "Purchase order",
"Usage": "MATERIAL",
"links": [
{
"rel": "self",
"href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100178959504",
"name": "inboundFiscalDocuments",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000678"
}
},
{
"rel": "canonical",
"href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100178959504",
"name": "inboundFiscalDocuments",
"kind": "item"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100178959504/child/fiscalDocumentLines",
"name": "fiscalDocumentLines",
"kind": "collection"
}
]
}
],
"count": 1,
"hasMore": false,
"limit": 25,
"offset": 0,
"links": [
{
"rel": "self",
"href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments",
"name": "inboundFiscalDocuments",
"kind": "collection"
}
]
}