Get a fiscal document
get
/fscmRestApi/resources/11.13.18.05/brazilianFiscalDocuments/{DocumentRelationId}
Request
Path Parameters
-
DocumentRelationId(required): integer(int64)
The unique identifier of the fiscal document detail.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
-
Metadata-Context:
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
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : brazilianFiscalDocuments-item-response
Type:
Show Source
object
-
CancelReason: string
Title:
Cancellation Reason
Maximum Length:240
Reason provided by the user for setting the transaction status as cancelled. -
DocumentNumber: integer
(int64)
Title:
Fiscal Document Number
The unique number that is assigned to a document, such as fiscal document number or tax invoice number. -
DocumentRelationId: integer
(int64)
The unique identifier of the fiscal document detail.
-
FiscalDocumentDate: string
(date)
Title:
Fiscal Document Date
The date when the transaction occurred. -
FiscalDocumentKey: string
Title:
Fiscal Document Key
Maximum Length:50
The unique identifier of a fiscal document for the tax authority system. The value is derived by concatenation of the fiscal document number and other fiscal document information. -
InvoiceVerificationCode: string
Title:
Verification Code
Maximum Length:255
Verification code of the fiscal document for a service invoice. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ProcessedDateTime: string
(date-time)
Title:
Processed Date and Time
Date and time when a fiscal document was processed by the tax authority. -
ProtocolNumber: integer
(int64)
Title:
Protocol Number
The unique identifier of transactions of authorization, cancelation, and void related to a fiscal document. This number is generated by the tax authority. -
Status: string
Title:
Status
Maximum Length:30
Fiscal document status associated with the transaction, such as IN PROCESS, SENT, FINALIZED, ERROR, DENIED, or VOID. -
TaxAuthorityDocumentNumber: integer
(int64)
Title:
Tax Authority Document Number
Certificate number provided by the municipality on payment of taxes. -
TaxSettlementDate: string
(date)
Title:
Tax Settlement Date
Date of certificate provided by the municipality on payment of taxes. -
TemporaryServiceDocumentNumber: number
Title:
Temporary Service Document Number
Number of provisional receipt for services sent to the city tax authority. -
VoidDate: string
(date)
Title:
Canceled Date
Date when the transaction is cancelled or marked as void. -
VoidReason: string
Title:
Void Reason
Maximum Length:240
Reason provided by the user for setting the transaction status as void.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Examples
The following example shows how to retrieve a fiscal document by submitting a GET request on the REST resource using cURL.
curl -i -u "<username>:<password>" -H "Content-Type: application/json" -X GET https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/brazilianFiscalDocuments/100100054557417
Example Response Body
The following example shows the contents of the response body in JSON format:
{ "Status": "VALIDATION_ERROR", "FiscalDocumentKey": "TEMPID-0", "FiscalDocumentDate": "2017-07-25", "DocumentNumber": 0, "VoidReason": null, "VoidDate": null, "TaxAuthorityDocumentNumber": null, "InvoiceVerificationCode": null, "TemporaryServiceDocumentNumber": null, "ProtocolNumber": null, "ProcessedDateTime": null, "TaxSettlementDate": null, "CancelReason": null, "DocumentRelationId": 100100054557417, "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/brazilianFiscalDocuments/100100054557417", "name": "brazilianFiscalDocuments", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/brazilianFiscalDocuments/100100054557417", "name": "brazilianFiscalDocuments", "kind": "item" } ] }