forked from eGestor/documentacao-api
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathapiary.apib
8209 lines (6563 loc) · 247 KB
/
apiary.apib
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
quasFORMAT: 1A
# eGestor API
O [eGestor](https://www.egestor.com.br) disponibiliza uma API REST que permite o acesso aos contatos, produtos e vendas do sistema.
As dúvidas e solicitações, relacionadas ao acesso da API, devem ser enviadas para o e-mail [email protected].
Recursos disponíveis para acesso via API:
* [**Contatos**](#reference/recursos/contatos)
* [**Categoria de produtos**](#reference/recursos/categorias)
* [**Produtos**](#reference/recursos/produtos)
* [**Ajuste de estoque**](#reference/recursos/ajuste-de-estoque)
* [**Serviços**](#reference/recursos/servicos)
* [**Disponíveis**](#reference/recursos/disponiveis)
* [**Formas de pagamento**](#reference/recursos/formas-de-pagamento)
* [**Plano de contas**](#reference/recursos/plano-de-contas)
* [**Grupo de tributos**](#reference/recursos/grupo-de-tributos)
* [**Recebimentos**](#reference/recursos/recebimentos)
* [**Pagamentos**](#reference/recursos/pagamentos)
* [**Compras**](#reference/recursos/compras)
* [**Vendas**](#reference/recursos/vendas)
* [**Boletos**](#reference/recursos/boletos)
* [**Relatórios**](#reference/recursos/relatorios)
* [**NFSe**](#reference/recursos/nfse)
* [**NFe**](#reference/recursos/nfe)
* [**Disco virtual**](#reference/recursos/disco-virtual)
* [**Usuários**](#reference/recursos/usuarios)
* [**Webhooks**](#reference/recursos/webhooks)
# Biblioteca
Integre seu sistema de forma rápida e fácil utilizando nossa [biblioteca para PHP](https://github.com/eGestor/egestor-sdk-php).
## Métodos
Requisições para a API devem seguir os padrões:
| Método | Descrição |
|---|---|
| `GET` | Retorna informações de um ou mais registros. |
| `POST` | Utilizado para criar um novo registro. |
| `PUT` | Atualiza dados de um registro ou altera sua situação. |
| `DELETE` | Remove um registro do sistema. |
## Respostas
| Código | Descrição |
|---|---|
| `200` | Requisição executada com sucesso (success).|
| `400` | Erros de validação ou os campos informados não existem no sistema.|
| `401` | Dados de acesso inválidos.|
| `404` | Registro pesquisado não encontrado (Not found).|
| `405` | Método não implementado.|
| `410` | Registro pesquisado foi apagado do sistema e não esta mais disponível.|
| `422` | Dados informados estão fora do escopo definido para o campo.|
| `429` | Número máximo de requisições atingido. (*aguarde alguns segundos e tente novamente*)|
## Limites (Throttling)
Existe o limite de `60` requisições por minuto por aplicação+usuário.
Você pode acompanhar esses limites nos `headers`: `X-RateLimit-Limit`, `X-RateLimit-Remaining` enviados em todas as respostas da API.
Ações de `listar` exibem `50` registros por página. Não é possível alterar este número.
Por questões de segurança, todas as requisições devem ser feitas através do protocolo `HTTPS`.
## Listar
As ações de `listar` permitem o envio dos seguintes parâmetros:
| Parâmetro | Descrição |
|---|---|
| `filtro` | Filtra dados pelo valor informado. |
| `page` | Informa qual página deve ser retornada. |
# Group Autenticação - OAuth
Nossa API utiliza [OAuth2](https://oauth.net/2/) como forma de autenticação/autorização.
## Solicitando tokens de acesso [/oauth/access_token]
### Utilizando personal_token [POST]
O `personal_token` é do formato JWT e contém informações da aplicação e do cliente (usuário). Este é o tipo de token recomendado para utilização em sistemas de e-Commerce e sites integrados ao eGestor.
Os dados desse token podem ser obtidos diretamente no eGestor, na aba `Configurações -> Aplicativos conectados`.
#### Dados para envio no POST
| Parâmetro | Descrição |
|---|---|
| `grant_type` | Informar: `personal` |
| `personal_token` | Token JWT com informações da aplicação cliente. |
+ Request (application/json)
+ Body
{
"grant_type": "personal"
"personal_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhcHAiOiIzNDhlNTM4MzQ2M2Y3MzZjMGExZTJhNTFmNjYwZjA5NCIsInN1YmRvbWluaW8iOiJleGVtcGxvIiwiY2xpZW50IjoiMTU0ZDZlZGQ4YmQzMDEwYzQ4NjBkN2E5Yzk1NzNmYmVmZTUyNGRlZiJ9.JJNs0bFtGOtwyJy_r-eefsvkd387M_x7zpucE1m4WIw",
}
+ Response 200 (application/json)
+ Body
{
"access_token": "[access_token]",
"token_type": "Bearer",
"expires_in": 900,
"refresh_token": "[refresh_token]"
}
### Utilizando refresh_token [POST]
Utilize o último `refresh_token` recebido para solicitar um novo `access_token`. Após utilizado o `refresh_token`, este será invalidado e um novo será fornecido em conjunto com o `access_token`.
#### Dados para envio no POST
| Parâmetro | Descrição |
|---|---|
| `grant_type` | Informar: `refresh_token` |
| `client_id` | Código de identificação da aplicação no sistema. |
| `client_secret` | `client_secret` da aplicação no sistema. |
| `redirect_uri` | Url de redirecionamento informada na configuração da aplicação. |
| `refresh_token` | Último refresh_token recebido. |
+ Request (application/json)
+ Body
{
"refresh_token": "qkUb1vx8yBmySV6dq7mPR",
"client_id": "4Lbr9ubFDFPo8pz1Z",
"client_secret": "4Lbr9ubFDFPo",
"redirect_uri": "urn:ietf:wg:oauth:2.0:oob",
"grant_type": "refresh_token"
}
+ Response 200 (application/json)
+ Body
{
"access_token": "[access_token]",
"token_type": "Bearer",
"expires_in": 900,
"refresh_token": "[refresh_token]"
}
### Utilizando o código de acesso [POST]
Utilizando o `code` enviado pelo servidor de autorização, envie um POST com seus dados para receber um `access_token`.
O `access_token` é válido por 15 minutos. Utilize o `refresh_token` para solicitar um novo `access_token`, para não solicitar ao usuário suas credenciais (login e senha) novamente.
| Parâmetro | Descrição |
|---|---|
| `grant_type` | Informar: `authorization_code` |
| `client_id` | Código de identificação da aplicação no sistema. |
| `client_secret` | `client_secret` da aplicação no sistema. |
| `redirect_uri` | Url de redirecionamento informada na configuração da aplicação. |
| `code` | Código recebido pela autorização do usuário. |
+ Request (application/json)
+ Body
{
"code": "1rbUURjcp1KErn7Jgx7d",
"client_id": "e70654d7f568d0",
"client_secret": "156762a28c007a64ff",
"redirect_uri": "urn:ietf:wg:oauth:2.0:oob:auto",
"grant_type": "authorization_code"
}
+ Response 200 (application/json)
+ Body
{
"access_token": "[access_token]",
"token_type": "Bearer",
"expires_in": 900,
"refresh_token": "[refresh_token]",
"personal_token": "[token_string]"
}
# Group Recursos
# Contatos [/contatos]
Os contatos podem ser clientes, fornecedores e transportadoras.
### Listar (List) [GET /contatos{?filtro,endereco,telefone,email,clienteFinal,indIE,IE,IM,suframa,obs,fields,orderBy}]
+ Parameters
+ filtro (string, optional) - Busca a string informada nos campos: nome, fantasia, código, contato, email, telefone e tags.
+ endereco (string, optional) - Busca a string informada no endereço do contato (rua, cep, bairro, cidade e estado)
+ telefone (string, optional) - Busca o valor informado no campo "Telefones" do contato
+ email (string, optional) - Busca o valor informado no campo "E-mails" do contato
+ clienteFinal (number, optional) - Filtrar por cliente final. Valores possíveis:
* 1 - Sim
* 2 - Não
+ indIE (number, optional) - Filtrar por indicador de IE. Valores possíveis:
* 1 - Contribuinte
* 2 - Isento de IE
* 9 - Não contribuinte
+ IE (string, optional) - Filtra por inscrição estadual
+ IM (string, optional) - Filtra por inscrição municipal
+ suframa (string, optional) - Filtra pelo código SUFRAMA
+ obs (string, optional) - Busca a string informada nas observações do contato
+ fields (string, optional) - Permite definir quais os campos serão retornados pela api. Informe separado por vírgula. Valores possíveis:
* codigo, nome, fantasia, nomeParaContato, cpfcnpj, tipo, dtNasc, dtCad, emails, fones, logradouro, numero, complemento, bairro, cep, cidade, uf, clienteFinal, indicadorIE, inscricaoMunicipal, inscricaoEstadual, obs, tags
* ex: &fields=nome,fantasia
* Padrão: codigo, nome, tipo, emails, fones, cidade, uf, clienteFinal, tags
+ orderBy (string, optional) - Permite definir a ordenação da listagem. Informe o campo e a forma de ordenação (ascendente ou descendente) separados por vírgula. Só é possível definir uma ordenação por requisição. Valores possíveis:
* codigo, tipo, nome, fantasia, nomeParaContato, cpfcnpj, clienteFinal, indicadorIE, inscricaoEstadual, inscricaoMunicipal, suframa, emails, cidade
* ex: &orderBy=nome,desc
* ex: &orderBy=fantasia,asc
+ Request (application/json)
+ Headers
Authorization: Bearer [access_token]
+ Response 200 (application/json)
{
"total": 1,
"per_page": 50,
"current_page": 1,
"last_page": 4,
"next_page_url": null,
"prev_page_url": null,
"from": 1,
"to": 50,
"data": [
{
"codigo": "1",
"tipo": ["cliente", "fornecedor"],
"nome": "Nome do contato",
"emails": [],
"fones": [],
"clienteFinal": false,
"tags": [],
"cidade": "Nome da cidade",
"uf": "UF"
}
]
}
+ Response 401 (application/json)
{
"errCode": 401,
"errMsg": "Não foi possível acessar o sistema. Verifique seu \"access_token\".",
"errObs": "access_denied",
"errFields": null,
"errUrl": "/v1/contatos"
}
### Novo (Create) [POST]
+ Attributes (object)
+ nome: nome do contato (string, required) - limite 60 caracteres
+ fantasia (string, optional) - limite de 60 caracteres
+ tipo (array, required) - Tipo
+ cliente
+ fornecedor
+ transportadora
+ nomeParaContato (string, optional) - limite de 60 caracteres
+ cpfcnpj (string, optional)
+ dtNasc (string, optional) - formato: YYYY-MM-DD
+ emails (array)
+ fones (array)
+ cep (number, optional)
+ logradouro (string, optional)
+ numero (string, optional)
+ complemento (string, optional)
+ bairro (string, optional)
+ cidade (string, optional)
+ codIBGE (string, optional)
+ uf (string, optional)
+ pais (string, optional)
+ clienteFinal (optional)
+ indicadorIE (enum[number], optional)
+ Members
+ 1 - Contribuinte
+ 2 - Isento de IE
+ 9 - Não contribuinte
+ inscricaoMunicipal (string, optional)
+ inscricaoEstadual (string, optional)
+ inscricaoEstadualST (string, optional)
+ suframa (string, optional)
+ obs (string, optional)
+ tags (array, optional)
+ cepEntrega (number, optional)
+ cpfCnpjEntrega (number, optional)
+ logradouroEntrega (string, optional)
+ numeroEntrega (number, optional)
+ complementoEntrega (string, optional)
+ bairroEntrega (string, optional)
+ codIBGEEntrega (number, optional)
+ ufEntrega (string, optional)
+ pontoRefEntrega (string, optional)
+ Request (application/json)
+ Headers
Authorization: Bearer [access_token]
+ Body
{
"nome": "Kaya Labadie",
"fantasia": "",
"nomeParaContato": "Elfrieda Labadie",
"cpfcnpj": "83294489654",
"tipo": [
"cliente"
],
"dtNasc": "1992-02-13",
"emails": [
],
"fones": [],
"cep": 4320040,
"logradouro": "Rua Exemplo lado ímpar",
"numero": "999",
"complemento": "",
"bairro": "",
"codIBGE": "355030",
"uf": "SP",
"pais": "",
"clienteFinal": true,
"indicadorIE": 1,
"inscricaoMunicipal": "",
"inscricaoEstadual": "",
"inscricaoEstadualST": "",
"cpfCnpjEntrega": "",
"logradouroEntrega": "",
"numeroEntrega": "",
"complementoEntrega": "",
"bairroEntrega": "",
"codIBGEEntrega": "",
"cidadeEntrega": "",
"ufEntrega": "",
"cepEntrega": "",
"pontoRefEntrega": ""
"suframa": "",
"obs": "",
"tags": []
}
+ Response 200 (application/json)
+ Headers
X-RateLimit-Limit: 60
X-RateLimit-Remaining: 59
+ Body
{
"codigo": 1,
"nome": "Nome do contato"
}
### Detalhar (Read) [GET /contatos/{codigo}]
+ Parameters
+ codigo (required, number, `1`) ... Código do contato
+ Request (application/json)
+ Headers
Authorization: Bearer [access_token]
+ Response 200 (application/json)
Todos os dados do contato
+ Headers
X-RateLimit-Limit: 60
X-RateLimit-Remaining: 58
+ Body
{
"codigo": "1",
"tipo": ["cliente", "fornecedor", "transportadora"],
"nome": "Nome do novo contato",
"fantasia": "",
"nomeParaContato": "",
"cpfcnpj": "",
"clienteFinal": true,
"indicadorIE": 9,
"inscricaoEstadual": "",
"inscricaoEstadualST": "",
"inscricaoMunicipal": "",
"suframa": "",
"emails": [],
"logradouro": "",
"numero": "",
"complemento": "",
"bairro": "",
"cidade": "",
"codIBGE": "",
"uf": "",
"cep": "",
"pais": "",
"fones": [],
"tags": [],
"obs": "",
"dtNasc": "1990-05-12",
"dtCad": "2017-01-15 11:20:15",
"cpfCnpjEntrega": "",
"logradouroEntrega": "",
"numeroEntrega": 0,
"complementoEntrega": "",
"bairroEntrega": "",
"codIBGEEntrega": "0",
"cidadeEntrega": "",
"ufEntrega": "",
"cepEntrega": 0,
"pontoRefEntrega": ""
}
+ Response 404 (application/json)
Quando registro não for encontrado.
+ Headers
X-RateLimit-Limit: 60
X-RateLimit-Remaining: 59
+ Body
{
"errCode": 404,
"errMsg": "Nenhum registro com código 1 econtrado",
"errObs": null,
"errFields": null
}
+ Response 410 (application/json)
Quando registro foi apagado do sistema, o código de retorno é 410.
+ Headers
X-RateLimit-Limit: 60
X-RateLimit-Remaining: 59
+ Body
{
"errCode": 410,
"errMsg": "Registro com código 1 não existe.",
"errObs": null,
"errFields": null
}
### Editar (Update) [PUT /contatos/{codigo}]
+ Request (application/json)
+ Headers
Authorization: Bearer [access_token]
+ Body
{
"nome": "Exemplo Company LTDA",
"fantasia": "",
"nomeParaContato": "Elfrieda",
"cpfcnpj": "83294489654",
"tipo": [
"cliente"
],
"dtNasc": "1992-02-13",
"emails": [
],
"fones": [],
"cep": 4320040,
"logradouro": "Rua Exemplo lado ímpar",
"numero": "999",
"complemento": "",
"bairro": "",
"codIBGE": "355030",
"uf": "SP",
"pais": "",
"clienteFinal": true,
"indicadorIE": 1,
"inscricaoMunicipal": "",
"inscricaoEstadual": "",
"inscricaoEstadualST": "",
"cpfCnpjEntrega": "",
"logradouroEntrega": "",
"numeroEntrega": "",
"complementoEntrega": "",
"bairroEntrega": "",
"codIBGEEntrega": "",
"cidadeEntrega": "",
"ufEntrega": "",
"cepEntrega": "",
"pontoRefEntrega": "",
"suframa": "",
"obs": "",
"tags": []
}
+ Response 200 (application/json)
Todos os dados do contato
+ Headers
X-RateLimit-Limit: 60
X-RateLimit-Remaining: 58
+ Body
{
"codigo": "1",
"tipo": ["cliente", "fornecedor", "transportadora"],
"nome": "Nome do novo contato",
"fantasia": "",
"nomeParaContato": "",
"cpfcnpj": "",
"clienteFinal": true,
"indicadorIE": 9,
"inscricaoEstadual": "",
"inscricaoEstadualST": "",
"inscricaoMunicipal": "",
"suframa": "",
"emails": [],
"logradouro": "",
"numero": "",
"complemento": "",
"bairro": "",
"cidade": "",
"codIBGE": "",
"uf": "",
"cep": "",
"pais": "",
"fones": [],
"tags": [],
"obs": "",
"dtNasc": "1990-05-12",
"dtCad": "2017-01-15 11:20:15",
"cpfCnpjEntrega": "",
"logradouroEntrega": "",
"numeroEntrega": 0,
"complementoEntrega": "",
"bairroEntrega": "",
"codIBGEEntrega": "0",
"cidadeEntrega": "",
"ufEntrega": "",
"cepEntrega": 0,
"pontoRefEntrega": ""
}
### Remover (Delete) [DELETE /contatos/{codigo}]
+ Request (application/json)
+ Headers
Authorization: Bearer [access_token]
+ Response 200 (application/json)
+ Headers
X-RateLimit-Limit: 60
X-RateLimit-Remaining: 59
+ Body
{
"code": "200",
"msg": "Contato com código 317 excluído com sucesso!",
"obs": null,
"fields": null
}
# Categorias de produtos [/categorias]
As categorias são utilizadas para agrupar produtos, podendo filtrar posteriormente por produtos de determinada categoria.
### Listar (List) [GET]
+ Request (application/json)
+ Headers
Authorization: Bearer [access_token]
+ Response 200 (application/json)
{
"total": 1,
"per_page": 50,
"current_page": 1,
"last_page": 1,
"next_page_url": null,
"prev_page_url": null,
"from": 1,
"to": 50,
"data": [
{
"codigo": "1",
"nome": "Material de escritório"
}
]
}
+ Response 401 (application/json)
{
"errCode": 401,
"errMsg": "Não foi possível acessar o sistema. Verifique seu \"access_token\".",
"errObs": "access_denied",
"errFields": null,
"errUrl": "/v1/categorias"
}
### Novo (Create) [POST]
+ Attributes (object)
+ nome (string, required)
+ Request (application/json)
+ Headers
Authorization: Bearer [access_token]
+ Body
{
"nome": "Fios e arames"
}
+ Response 200 (application/json)
+ Headers
X-RateLimit-Limit: 60
X-RateLimit-Remaining: 59
+ Body
{
"codigo": 2,
"nome": "Fios e arames"
}
### Detalhar (Read) [GET /categorias/{codigo}]
+ Parameters
+ codigo (required, number, `1`) ... Código da categoria
+ Request (application/json)
+ Headers
Authorization: Bearer [access_token]
+ Response 200 (application/json)
Todos os dados do categoria
+ Headers
X-RateLimit-Limit: 60
X-RateLimit-Remaining: 58
+ Body
{
"codigo": "1",
"nome": "Material de escritório"
}
+ Response 404 (application/json)
Quando registro não for encontrado.
+ Headers
X-RateLimit-Limit: 60
X-RateLimit-Remaining: 59
+ Body
{
"errCode": 404,
"errMsg": "Nenhum registro com código 1 encontrado",
"errObs": null,
"errFields": null
}
+ Response 410 (application/json)
Quando registro foi apagado do sistema, o código de retorno é 410.
+ Headers
X-RateLimit-Limit: 60
X-RateLimit-Remaining: 59
+ Body
{
"errCode": 410,
"errMsg": "Registro com código 1 não existe.",
"errObs": null,
"errFields": null
}
### Editar (Update) [PUT /categorias/{codigo}]
+ Request (application/json)
+ Headers
Authorization: Bearer [access_token]
+ Body
{
"nome": "Materiais de escritório"
}
+ Response 200 (application/json)
Todos os dados do categoria
+ Headers
X-RateLimit-Limit: 60
X-RateLimit-Remaining: 58
+ Body
{
"codigo": "1",
"nome": "Materiais de escritório"
}
### Remover (Delete) [DELETE /categorias/{codigo}]
+ Request (application/json)
+ Headers
Authorization: Bearer [access_token]
+ Response 200 (application/json)
+ Headers
X-RateLimit-Limit: 60
X-RateLimit-Remaining: 59
+ Body
{
"code": "200",
"msg": "Categoria com código 1 excluído com sucesso!",
"obs": null,
"fields": null
}
# Produtos [/produtos]
Produtos são utilizados nas vendas e controle de estoque.
### Listar (List) [GET /produtos{?filtro,codCategoria,controlarEstoque,tipoUso,arquivado,anotInternas,Norig,INCM,codConfigTrib,IcProd,updatedBefore,updatedAfter,fields,orderBy}]
+ Parameters
+ filtro (optional) - Busca a string informada nos campos: código do produto, código próprio e nome do produto.
+ codCategoria (optional, integer) - Código da categoria do produto.
+ controlarEstoque (optional, integer) - Filtra por produtos que controlam/não controlam estoque. Valores possíveis:
* 0 - Não controla estoque
* 1 - Controla estoque
+ tipoUso (number, optional) - Tipo de uso do produto
* 0 - Mercadoria para revenda
* 1 - Matéria-prima
* 2 - Embalagem
* 3 - Produtos em processo
* 4 - Produto final (Produção)
+ arquivado (boolean, optional) - Filtra apenas por produtos arquivados
+ Norig (optional, integer) - Origem do produto. Valores possíveis:
* 0 - Nacional, exceto as indicadas nos códigos de 3, 4, 5 e 8',
* 1 - Estrangeira, importação direta, exceto a indicada no código 6',
* 2 - Estrangeira, adquirida no mercado interno, exceto a indicada no código 7',
* 3 - Nacional, mercadoria ou bem com Conteúdo de Importação maior que 40% e menor ou igual a 70%',
* 4 - Nacional, produção em conformidade com processos básicos que tratam as legisl. dos Ajustes',
* 5 - Nacional, mercadoria ou bem com Conteúdo de Importação inferior ou igual a 40%',
* 6 - Estrangeira, importação direta, sem similar nacional, constante na lista da CAMEX e gás natural',
* 7 - Estrangeira, adquir. merc. interno, sem similar nacional, na lista da CAMEX e gás natural',
* 8 - Nacional, mercadoria ou bem com Conteúdo de Importação superior a 70%'
+ INCM (optional, integer) - NCM dos produtos
+ codConfigTrib (optional, integer) - Código do grupo de tributos vinculado.
+ IcProd (optional, string) - Código interno do produto
+ anotInternas (optional, string) - Filtro baseado nas observações internas do produto
+ updatedBefore (optional, string) - Lista apenas produtos que sofreram alterações antes da data informada. Formato "YYYY-MM-DD HH:MM:SS"
+ updatedAfter (optional, string) - Lista apenas produtos que sofreram alterações após a data informada. Formato "YYYY-MM-DD HH:MM:SS"
+ fields (optional) - Permite definir quais os campos serão retornados pela api. Informe separado por vírgula.
* ex: &fields=descricao,codigoProprio
+ orderBy (optional) - Permite definir a ordenação da listagem. Informe o campo e a forma de ordenação (ascendente ou descendente) separados por vírgula. Só é possível definir uma ordenação por requisição. Valores possíveis:
* codigo, codCategoria, descricao, codigoProprio, estoque, estoqueMinimo, controlarEstoque, margemLucro, precoCusto, precoVenda, origemFiscal, unidadeTributada, refEanGtin, ncm, excecaoIPI, codigoCEST, pesoBruto, pesoLiquido, anotacoesNFE, anotacoesInternas, tags, dtCad
* ex: &orderBy=margemLucro,desc
* ex: &orderBy=descricao,asc
+ Request (application/json)
+ Headers
Authorization: Bearer [access_token]
+ Response 200 (application/json)
{
"total": 1,
"per_page": 50,
"current_page": 1,
"last_page": 4,
"next_page_url": null,
"prev_page_url": null,
"from": 1,
"to": 50,
"data": [
{
"codigo": 1,
"descricao": "Caneca Preta",
"codigoProprio": "",
"estoque": 60,
"estoqueMinimo": 10,
"controlarEstoque": false,
"margemLucro": 0,
"precoCusto": 100,
"precoVenda": 200,
"origemFiscal": 0,
"unidadeTributada": "UN",
"refEanGtin": "",
"ncm": "",
"excecaoIPI": 1,
"codigoCEST": "",
"pesoBruto": 0,
"pesoLiquido": 0,
"codigoGrupoTributos": 1,
"anotacoesNFE": "",
"anotacoesInternas": "",
"tags": [ 'café', 'utilidades' ],
"dtCad": "2017-03-10 14:10:37",
"codCategoria": 0,
"updatedAt": "2019-09-20 16:56:39"
}
]
}
### Novo (Create) [POST]
+ Request (application/json)
+ Headers
Authorization: Bearer [access_token]
+ Body
{
"descricao": "Novo produto",
"codigoProprio": "001",
"codCategoria": 1,
"estoque": 100,
"estoqueMinimo": 0,
"controlarEstoque": true,
"margemLucro": 0.00,
"precoCusto": 5.00,
"precoVenda": 10.37,
"origemFiscal": 0,
"unidadeTributada": "UN",
"refEanGtin": "",
"ncm": "",
"codigoCEST": "0107400",
"excecaoIPI": 7,
"codigoGrupoTributos": 0,
"anotacoesNFE": "",
"anotacoesInternas": "",
"pesoBruto": 0,
"pesoLiquido": 0,
"tags": ['exemplo', 'modelo']
}
+ Response 200 (application/json)
+ Headers
X-RateLimit-Limit: 60
X-RateLimit-Remaining: 59
+ Body
{
"codigo": 1,
"descricao": "Novo produto"
}
### Detalhar (Read) [GET /produtos/{codigo}]
+ Request (application/json)
+ Headers
Authorization: Bearer [access_token]
+ Parameters
+ codigo (required, number, `1`) ... Código do contato
+ Response 200 (application/json)
+ Headers
X-RateLimit-Limit: 60
X-RateLimit-Remaining: 58
+ Body
{
"codigo": "1",
"descricao": "Novo produto",
"codigoProprio": "",
"codCategoria": 1,
"estoque": 100,
"estoqueMinimo": 0,
"controlarEstoque": true,
"margemLucro": 0.00,
"precoCusto": 0.0000,
"precoVenda": 0.0000,
"origemFiscal": 0,
"unidadeTributada": "UN",
"refEanGtin": "",
"ncm": "",
"codigoCEST": "",
"excecaoIPI": "",
"codigoGrupoTributos": 0,
"anotacoesNFE": "",
"anotacoesInternas": "",
"pesoBruto": "0.000",
"pesoLiquido": "0.000",
"tags": [],
"dtCad": "2017-05-24 17:32:18",
"codCategoria": 0,
"updatedAt": "2019-10-30 14:55:13"
}
+ Response 410 (application/json)
Quando o registro foi apagado do sistema.
+ Body
{
"errCode": 410,
"errMsg": "Registro com código 1 não existe.",
"errObs": null,
"errFields": null
}
+ Response 404 (application/json)
Quando o registro não foi encontrado.
+ Body
{
"errCode": 404,
"errMsg": "Nenhum registro com código 1 econtrado",
"errObs": null,
"errFields": null
}
### Editar (Update) [PUT /produtos/{codigo}]
+ Request (application/json)
+ Headers
Authorization: Bearer [access_token]
+ Parameters
+ codigo (required, number, `1`) ... Código do contato