Jump to

• Request
• Response
• Examples

Get all fiscal documents

get

/fscmRestApi/resources/11.13.18.05/brazilianFiscalDocuments

Request

Query Parameters

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

  • FindByFiscalDocumentKey: Finds the fiscal document that matches the specified fiscal document access key.
    Finder Variables:
    • fiscalDocumentKey; string; The fiscal document access key that is the unique identifier of a fiscal document for the tax authority system.
  • PrimaryKey: Finds the fiscal document that matches the specified primary key.
    Finder Variables:
    • DocumentRelationId; integer; The unique identifier of the fiscal document detail.
• 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:
  

  • CancelReason; string; Reason provided by the user for setting the transaction status as cancelled.
  • DocumentNumber; integer; The unique number that is assigned to a document, such as fiscal document number or tax invoice number.
  • DocumentRelationId; integer; The unique identifier of the fiscal document detail.
  • FiscalDocumentDate; string; The date when the transaction occurred.
  • FiscalDocumentKey; string; 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; Verification code of the fiscal document for a service invoice.
  • ProcessedDateTime; string; Date and time when a fiscal document was processed by the tax authority.
  • ProtocolNumber; integer; 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; Fiscal document status associated with the transaction, such as IN PROCESS, SENT, FINALIZED, ERROR, DENIED, or VOID.
  • TaxAuthorityDocumentNumber; integer; Certificate number provided by the municipality on payment of taxes.
  • TaxSettlementDate; string; Date of certificate provided by the municipality on payment of taxes.
  • TemporaryServiceDocumentNumber; number; Number of provisional receipt for services sent to the city tax authority.
  • VoidDate; string; Date when the transaction is cancelled or marked as void.
  • VoidReason; string; Reason provided by the user for setting the transaction status as void.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : brazilianFiscalDocuments

Type: object

Show Source

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

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

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

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

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object brazilianFiscalDocuments-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/brazilianFiscalDocuments-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : brazilianFiscalDocuments-item-response

Type: object

Show Source

• 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: 30

  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.

{
    "type":"object",
    "properties":{
        "Status":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"Fiscal document status associated with the transaction, such as IN PROCESS, SENT, FINALIZED, ERROR, DENIED, or VOID.",
            "nullable":true,
            "x-queryable":true
        },
        "VoidDate":{
            "title":"Canceled Date",
            "type":"string",
            "description":"Date when the transaction is cancelled or marked as void.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "TaxAuthorityDocumentNumber":{
            "title":"Tax Authority Document Number",
            "type":"integer",
            "description":"Certificate number provided by the municipality on payment of taxes.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TemporaryServiceDocumentNumber":{
            "title":"Temporary Service Document Number",
            "type":"number",
            "description":"Number of provisional receipt for services sent to the city tax authority.",
            "nullable":true,
            "x-queryable":true
        },
        "DocumentNumber":{
            "title":"Fiscal Document Number",
            "type":"integer",
            "description":"The unique number that is assigned to a document, such as fiscal document number or tax invoice number.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DocumentRelationId":{
            "type":"integer",
            "description":"The unique identifier of the fiscal document detail.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "InvoiceVerificationCode":{
            "title":"Verification Code",
            "maxLength":30,
            "type":"string",
            "description":"Verification code of the fiscal document for a service invoice.",
            "nullable":true,
            "x-queryable":true
        },
        "FiscalDocumentDate":{
            "title":"Fiscal Document Date",
            "type":"string",
            "description":"The date when the transaction occurred.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "CancelReason":{
            "title":"Cancellation Reason",
            "maxLength":240,
            "type":"string",
            "description":"Reason provided by the user for setting the transaction status as cancelled.",
            "nullable":true,
            "x-queryable":true
        },
        "VoidReason":{
            "title":"Void Reason",
            "maxLength":240,
            "type":"string",
            "description":"Reason provided by the user for setting the transaction status as void.",
            "nullable":true,
            "x-queryable":true
        },
        "FiscalDocumentKey":{
            "title":"Fiscal Document Key",
            "maxLength":50,
            "type":"string",
            "description":"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.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "TaxSettlementDate":{
            "title":"Tax Settlement Date",
            "type":"string",
            "description":"Date of certificate provided by the municipality on payment of taxes.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ProtocolNumber":{
            "title":"Protocol Number",
            "type":"integer",
            "description":"The unique identifier of transactions of authorization, cancelation, and void related to a fiscal document. This number is generated by the tax authority.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ProcessedDateTime":{
            "title":"Processed Date and Time",
            "type":"string",
            "description":"Date and time when a fiscal document was processed by the tax authority.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top

Examples

The following example shows how to retrieve all the fiscal documents that match the specified fiscal document access key by submitting a GET request on the REST resource using cURL.

curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourcecollection+json" -X GET https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/brazilianFiscalDocuments?finder=FindByFiscalDocumentKey;fiscalDocumentKey=TEMPID-0

Example Response Body

The following example shows the contents of the response body in JSON format:

{
    "items": [
        {
            "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"
                }
            ]
        },
        ...
    ],
    "count": 25,
    "hasMore": true,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/brazilianFiscalDocuments",
            "name": "brazilianFiscalDocuments",
            "kind": "collection"
        }
    ]
}

Back to Top