Arquivei API
The base URI for production requests is https://api.arquivei.com.br
You can test our API in a sandbox environment, in this case the base URI is https://sandbox-api.arquivei.com.br
nfe
Operations on NFe
Fetch XMLs of received NFes
GET
/v1/nfe/received
This endpoint is responsible for fetching XMLs of NFes using the custom filter: (OR (= processed false) (_not_exists processed)). Since our API is generic, this custom filter indicates that you want to fetch only the XMLs that were processed as false or the ones that were not processed at all. The call above is url encoded, and thas how it must be made.
Example:
GET /nfe/received?filter=(= processed false)&access_key[]=44charkey&limit=50
Parameters
limit
Type
integer
In
query
The maximum amount of XMLs that will be returned
cursor
Type
integer
In
query
The cursor position which the search will start from. This value is received after a successfull request on the body of the response as next.
access_key
Type
array[string]
In
query
Filter by a list of access_key. Example using this filter = v1/nfe/received?access_key[]=44charKey
cnpj
Type
array[string]
In
query
Filter by a list of cnpjs. Example using this filter = v1/nfe/received?cnpj[]=34174654000153
filter
Type
string
In
query
Filter by presence or value of custom info using Arquivei's filter language
created_at[from]
Type
string
In
query
Filter by created_at dates. This field is required when field created_at[to] is used. Example using = /v1/nfe/received?created_at[from]=2019-09-12 15:30:25&created_at[to]=2019-09-15 15:30:25. Can use date and time or just date.
created_at[to]
Type
string
In
query
Filter by created_at dates. This field is required when field created_at[from] is used. Example using = /v1/nfe/received?created_at[from]=2019-09-12 15:30:25&created_at[to]=now. Different from field created_at[from] this field accepts the value now. can use date and time or just date.
Responses
Headers
X-RateLimit-Limit
integer
The number of allowed requests in the current period
X-RateLimit-Remaining
integer
The number of remaining requests in the current period
Successful fetch
{
"status": {
"code": 0,
"message": "string"
},
"data": [
{
"access_key": "string",
"xml": "string"
}
],
"page": {
"next": "string",
"previous": "string"
},
"count": 0,
"signature": "string"
}
