Listagem dos Documentos Fiscais do Comprador

Lista documentos fiscais do comprador com base em critérios como datas, status, venda e conteúdo, detalhando informações fiscais e do cliente.

Required scopes:myeduzz_financial_read
GET
https://api.eduzz.com/myeduzz/v1/financial/buyer/fiscal-documents

Query params

startDateRequired
datetime

Data de início

endDateRequired
datetime

Data de término

pageRequired
number

Página atual

itemsPerPageRequired
number

Número de itens por página

status
enum

Status do documento fiscal

new
pending
waitingDocument
canceled
processed
approved
fileGenerated
processing
deleted
name
string

Nome do cliente

email
string

Email do cliente

saleId
string

Id da venda

productId
string

Id do produto

documentId
string

Id do documento

Response params (200)

pages
number

Número de páginas

page
number

Página atual

itemsPerPage
number

Número máximo de itens por página

totalItems
number

Número total de itens

items
array of object

Itens dos documentos fiscais

items[n].document
object

Informações do documento fiscal

items[n].document.id
string

Id do documento fiscal

items[n].document.name
string

Nome do documento fiscal

items[n].document.status
string

Status do documento fiscal

items[n].document.type
string

Tipo do documento fiscal

items[n].document.baseValue
object

Valor base do documento fiscal

items[n].document.baseValue.currency
string

Moeda

items[n].document.baseValue.value
number

Valor

items[n].document.emissionDate
datetime

Data de emissão do documento fiscal

items[n].document.referenceDate
datetime

Data de referência do documento fiscal

items[n].document.processingDate
datetime

Data de processamento do documento fiscal

items[n].source
object

Informações da fonte

items[n].source.taxTypeNullable
string

Tipo de imposto da fonte

items[n].source.companyName
string

Nome da empresa de origem

items[n].source.document
string

Documento da fonte

items[n].source.ie
string

Inscrição estadual da fonte

items[n].source.imNullable
string

Inscrição municipal da fonte

items[n].source.email
string

Email da fonte

items[n].source.telNullable
string

Telefone da fonte

items[n].source.tel2
string

Telefone 2 da fonte

items[n].source.cellNullable
string

Celular da fonte

items[n].source.address
object

Informações de endereço da fonte

items[n].source.address.street
string

Rua da fonte

items[n].source.address.number
string

Número da rua da fonte

items[n].source.address.complement
string

Complemento da fonte

items[n].source.address.district
string

Bairro da fonte

items[n].source.address.zipCode
string

CEP da fonte

items[n].source.address.city
string

Cidade da fonte

items[n].source.address.uf
string

UF da fonte

items[n].destination
object

Informações do destino

items[n].destination.companyName
string

Nome da empresa de destino

items[n].destination.taxType
string

Tipo de imposto do destino

items[n].destination.taxId
string

Id do imposto do destino

items[n].destination.ie
string

Inscrição estadual do destino

items[n].destination.imNullable
string

Inscrição municipal do destino

items[n].destination.email
string

Email do destino

items[n].destination.telNullable
string

Telefone do destino

items[n].destination.tel2Nullable
string

Telefone 2 do destino

items[n].destination.cell
string

Celular do destino

items[n].destination.address
object

Informações de endereço do destino

items[n].destination.address.streetNullable
string

Rua do destino

items[n].destination.address.numberNullable
string

Número da rua do destino

items[n].destination.address.complementNullable
string

Complemento do destino

items[n].destination.address.districtNullable
string

Bairro do destino

items[n].destination.address.zipCode
string

CEP do destino

items[n].destination.address.countryForeignNullable
string

País estrangeiro do destino

items[n].destination.address.cityNullable
string

Cidade do destino

items[n].destination.address.ufNullable
string

UF do destino

items[n].destination.address.countryNullable
string

País do destino

items[n].sale
object

Informações da venda

items[n].sale.id
string

Id da venda

items[n].sale.paymentDate
datetime

Data do pagamento

items[n].sale.total
object

Total da Venda

items[n].sale.total.currency
string

Moeda

items[n].sale.total.value
number

Valor

items[n].client
object

Informações do cliente

items[n].client.id
string

Id do cliente

items[n].client.name
string

Nome do cliente

items[n].client.document
string

Documento do cliente

items[n].client.email
string

Email do cliente

items[n].client.telephoneNullable
string

Telefone do cliente

items[n].client.telephone2Nullable
string

Telefone 2 do cliente

items[n].client.cellphone
string

Celular do cliente

items[n].client.address
object

Informações de endereço do cliente

items[n].client.address.streetNullable
string

Rua do cliente

items[n].client.address.numberNullable
string

Número do endereço do cliente

items[n].client.address.complementNullable
string

Complemento do endereço do cliente

items[n].client.address.neighborhoodNullable
string

Bairro do cliente

items[n].client.address.zipCode
string

CEP do cliente

items[n].client.address.cityNullable
string

Cidade do cliente

items[n].client.address.stateNullable
string

Estado do cliente

items[n].product
object

Informações do produto

items[n].product.id
string

Id do produto

items[n].product.title
string

Título do produto

items[n].generatedByNewSystem
boolean

Gerado pelo novo sistema

Status codes

StatusDescrição
200Success
Swagger Logo

Exemplos

1curl --request GET \
2	--url 'https://api.eduzz.com/myeduzz/v1/financial/buyer/fiscal-documents' \
3	--header 'Accept: application/json' \
4	--header 'Content-Type: application/json' \
5	--header 'authorization: Bearer {{YOUR_ACCESS_TOKEN}}'
Response
1{
2  "pages": 1,
3  "page": 1,
4  "itemsPerPage": 10,
5  "totalItems": 2,
6  "items": [
7    {
8      "document": {
9        "id": "1234567",
10        "name": "Empresa Fictícia - 12345678901",
11        "status": "Pendente",
12        "type": "Alunos / Clientes",
13        "baseValue": {
14          "currency": "BRL",
15          "value": 100
16        },
17        "emissionDate": "2024-11-04T21:17:02.000Z",
18        "referenceDate": "2024-10-30T09:45:39.000Z",
19        "processingDate": "2024-12-04T21:17:02.000Z"
20      },
21      "source": {
22        "taxType": null,
23        "companyName": "Empresa Fictícia",
24        "document": "12345678000190",
25        "ie": "ISENTO",
26        "im": null,
27        "email": "empresa@ficticia.com",
28        "tel": null,
29        "tel2": "11987654321",
30        "cell": null,
31        "address": {
32          "street": "Rua Fictícia",
33          "number": "123",
34          "complement": "Sala 1",
35          "district": "Centro",
36          "zipCode": "12345678",
37          "city": "Cidade Fictícia",
38          "uf": "SP"
39        }
40      },
41      "destination": {
42        "companyName": "Cliente Fictício",
43        "taxType": "F",
44        "taxId": "12345678901",
45        "ie": "ISENTO",
46        "im": null,
47        "email": "cliente@ficticio.com",
48        "tel": null,
49        "tel2": null,
50        "cell": "+5511998765432",
51        "address": {
52          "street": "Rua 123",
53          "number": "2",
54          "complement": null,
55          "district": null,
56          "zipCode": "",
57          "countryForeign": null,
58          "city": "São Paulo",
59          "uf": null,
60          "country": null
61        }
62      },
63      "sale": {
64        "id": "7654321",
65        "paymentDate": "2024-10-30T09:45:39.000Z",
66        "total": {
67          "currency": "BRL",
68          "value": 100
69        }
70      },
71      "client": {
72        "id": "123456789",
73        "name": "Cliente Fictício",
74        "document": "12345678901",
75        "email": "cliente@ficticio.com",
76        "telephone": null,
77        "telephone2": null,
78        "cellphone": "+5511998765432",
79        "address": {
80          "street": "Rua 123",
81          "number": "2",
82          "complement": null,
83          "neighborhood": null,
84          "zipCode": "",
85          "city": "São Paulo",
86          "state": null
87        }
88      },
89      "product": {
90        "id": "9876543",
91        "title": "Conteúdo Fictício"
92      },
93      "generatedByNewSystem": true
94    },
95    {
96      "document": {
97        "id": "7654321",
98        "name": "Outro Cliente - 10987654321",
99        "status": "Novo",
100        "type": "Alunos / Clientes",
101        "baseValue": {
102          "currency": "BRL",
103          "value": 200
104        },
105        "emissionDate": "2024-11-04T21:16:10.000Z",
106        "referenceDate": "2024-10-30T09:02:25.000Z",
107        "processingDate": "2024-12-04T21:16:10.000Z"
108      },
109      "source": {
110        "taxType": null,
111        "companyName": "Empresa Fictícia",
112        "document": "12345678000190",
113        "ie": "ISENTO",
114        "im": null,
115        "email": "empresa@ficticia.com",
116        "tel": null,
117        "tel2": "11987654321",
118        "cell": null,
119        "address": {
120          "street": "Rua Fictícia",
121          "number": "123",
122          "complement": "Sala 1",
123          "district": "Centro",
124          "zipCode": "12345678",
125          "city": "Cidade Fictícia",
126          "uf": "SP"
127        }
128      },
129      "destination": {
130        "companyName": "Outro Cliente",
131        "taxType": "F",
132        "taxId": "10987654321",
133        "ie": "ISENTO",
134        "im": null,
135        "email": "outrocliente@ficticio.com",
136        "tel": null,
137        "tel2": null,
138        "cell": "+5511987654321",
139        "address": {
140          "street": "Rua 123",
141          "number": "2",
142          "complement": null,
143          "district": null,
144          "zipCode": "",
145          "countryForeign": null,
146          "city": "São Paulo",
147          "uf": null,
148          "country": null
149        }
150      },
151      "sale": {
152        "id": "1234567",
153        "paymentDate": "2024-10-30T09:02:25.000Z",
154        "total": {
155          "currency": "BRL",
156          "value": 200
157        }
158      },
159      "client": {
160        "id": "987654321",
161        "name": "Outro Cliente",
162        "document": "10987654321",
163        "email": "outrocliente@ficticio.com",
164        "telephone": null,
165        "telephone2": null,
166        "cellphone": "+5511987654321",
167        "address": {
168          "street": "Rua 123",
169          "number": "2",
170          "complement": null,
171          "neighborhood": null,
172          "zipCode": "",
173          "city": "São Paulo",
174          "state": null
175        }
176      },
177      "product": {
178        "id": "8765432",
179        "title": "Outro Conteúdo Fictício"
180      },
181      "generatedByNewSystem": true
182    }
183  ]
184}