Listagem dos Documentos Fiscais do Afiliado

Lista documentos fiscais do afiliado 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/affiliate/fiscal-documents

Query params

startDateRequired

datetime

Data de início (máximo 5 meses antes da data final)

endDateRequired

datetime

Data de término (máximo 5 meses após a data de início)

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].document.fileStatus

string

Status do Arquivo enviado no documento

items[n].document.taxBase

number

Taxa base enviada no documento

items[n].document.basePercent

number

Percentual base enviado no documento

items[n].document.taxValue

object

Valor da taxa enviada no documento

items[n].document.taxValue.currency

string

Moeda

items[n].document.taxValue.value

number

Valor

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.telNullable

string

Telefone do cliente

items[n].client.tel2Nullable

string

Telefone 2 do cliente

items[n].client.cell

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

Status codes

Status	Descrição
200	Success

Exemplos

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