Skip to content

Commit 7bde21e

Browse files
Felipe-Alves-SampaioFelipe-Alves-Sampaio
authored
Documentação da API de condição de pagamento da linha RM Inclusão de "API" e "Schema" (#1164)
1 parent 4ce1e1e commit 7bde21e

File tree

2 files changed

+1188
-0
lines changed

2 files changed

+1188
-0
lines changed

‎jsonschema/apis/PaymentCondition_v1_0000.json

Lines changed: 371 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,371 @@
1+
{
2+
"openapi": "3.0.1",
3+
"servers": [
4+
{
5+
"description": "API para a entidade Condição de Pagamento (PaymentCondition) para produtos TOTVS",
6+
"url": "{{host}}/api/mov/v1",
7+
"variables": {
8+
"serverUrl": {
9+
"default": "localhost"
10+
},
11+
"serverHttpPort": {
12+
"default": "8052"
13+
}
14+
}
15+
}
16+
],
17+
"info": {
18+
"title": "Condição de Pagamento",
19+
"description": "API para a entidade Condição de Pagamento (PaymentCondition) para produtos TOTVS",
20+
"version": "1.00",
21+
"contact": {
22+
"name": "T-Talk",
23+
"url": "https://api.totvs.com.br",
24+
"email": "comiteintegracao@totvs.com.br"
25+
},
26+
"x-totvs": {
27+
"messageDocumentation": {
28+
"name": "Condição de Pagamento",
29+
"description": "Cadastro de Condição de Pagamento",
30+
"segment": "Backoffice"
31+
},
32+
"productInformation": [
33+
{
34+
"product": "RM",
35+
"contact": " tribecp.squad.estoquecontratos@totvs.com.br",
36+
"description": "Cadastro de Condição de Pagamento",
37+
"adapter": "MovPaymentConditionServer"
38+
}
39+
]
40+
}
41+
},
42+
"paths": {
43+
"/paymentcondition": {
44+
"get": {
45+
"tags": [
46+
"PaymentCondition"
47+
],
48+
"summary": "Retorna lista de Condições de pagamento",
49+
"description": "Retorna lista completa das condições de pagamento",
50+
"operationId": "getPaymentConditions",
51+
"x-totvs": {
52+
"productInformation": [
53+
{
54+
"product": "RM",
55+
"available": true,
56+
"note": "Este verbo esta disponível com todos os parametros",
57+
"minimalVersion": "12.1.31"
58+
}
59+
]
60+
},
61+
"parameters": [
62+
{
63+
"$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/apis/types/totvsApiTypesBase.json#/parameters/Authorization"
64+
},
65+
{
66+
"$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/apis/types/totvsApiTypesBase.json#/parameters/Order"
67+
},
68+
{
69+
"$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/apis/types/totvsApiTypesBase.json#/parameters/Page"
70+
},
71+
{
72+
"$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/apis/types/totvsApiTypesBase.json#/parameters/PageSize"
73+
},
74+
{
75+
"$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/apis/types/totvsApiTypesBase.json#/parameters/Fields"
76+
}
77+
],
78+
"responses": {
79+
"200": {
80+
"description": "Operação realizada com sucesso",
81+
"content": {
82+
"application/json": {
83+
"schema": {
84+
"$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/refs/heads/master/jsonschema/schemas/PaymentCondition_1_0000.json#/definitions/PagedPaymentConditions"
85+
}
86+
}
87+
}
88+
},
89+
"400": {
90+
"description": "Erro na listagem de Condições de Pagamento",
91+
"content": {
92+
"application/json": {
93+
"schema": {
94+
"$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/apis/types/totvsApiTypesBase.json#/definitions/ErrorModel"
95+
}
96+
}
97+
}
98+
},
99+
"404": {
100+
"description": "Registro não encontrado",
101+
"content": {
102+
"application/json": {
103+
"schema": {
104+
"$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/apis/types/totvsApiTypesBase.json#/definitions/ErrorModel"
105+
}
106+
}
107+
}
108+
}
109+
}
110+
},
111+
"post": {
112+
"tags": [
113+
"Condição de Pagamento"
114+
],
115+
"summary": "Inclui Condição de Pagamento",
116+
"description": "Inclui uma condição de pagamento conforme dados enviados na requisição.",
117+
"operationId": "postPaymentCondition",
118+
"x-totvs": {
119+
"productInformation": [
120+
{
121+
"product": "RM",
122+
"available": true,
123+
"note": "Este verbo esta disponivel com os parametros Authorization e Fields",
124+
"minimalVersion": "12.1.31"
125+
}
126+
]
127+
},
128+
"parameters": [
129+
{
130+
"$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/apis/types/totvsApiTypesBase.json#/parameters/Authorization"
131+
},
132+
{
133+
"$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/apis/types/totvsApiTypesBase.json#/parameters/Fields"
134+
}
135+
],
136+
"requestBody": {
137+
"content": {
138+
"application/json": {
139+
"schema": {
140+
"$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/refs/heads/master/jsonschema/schemas/PaymentCondition_1_0000.json#/definitions/PaymentConditionInfo"
141+
}
142+
}
143+
},
144+
"description": "Inclui uma Condição de Pagamento"
145+
},
146+
"responses": {
147+
"200": {
148+
"description": "Operação realizada com sucesso",
149+
"content": {
150+
"application/json": {
151+
"schema": {
152+
"$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/refs/heads/master/jsonschema/schemas/PaymentCondition_1_0000.json#/definitions/PaymentConditionInfo"
153+
}
154+
}
155+
}
156+
},
157+
"400": {
158+
"description": "Erro no momento da Inclusão",
159+
"content": {
160+
"application/json": {
161+
"schema": {
162+
"$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/apis/types/totvsApiTypesBase.json#/definitions/ErrorModel"
163+
}
164+
}
165+
}
166+
}
167+
}
168+
}
169+
},
170+
"/paymentcondition/{InternalId}": {
171+
"get": {
172+
"tags": [
173+
"Condição de Pagamento"
174+
],
175+
"summary": "Retorna a condição de pagamento pelo InternalId",
176+
"description": "Retorna a condição de pagamento pelo InternalId",
177+
"operationId": "getPaymentCondition",
178+
"x-totvs": {
179+
"productInformation": [
180+
{
181+
"product": "RM",
182+
"available": true,
183+
"note": "Este verbo está disponível com os parâmetros, Authorization, Fields e InternalId",
184+
"minimalVersion": "12.1.31"
185+
}
186+
]
187+
},
188+
"parameters": [
189+
{
190+
"$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/apis/types/totvsApiTypesBase.json#/parameters/Authorization"
191+
},
192+
{
193+
"$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/apis/types/totvsApiTypesBase.json#/parameters/Fields"
194+
},
195+
{
196+
"$ref": "#/components/parameters/InternalId"
197+
}
198+
],
199+
"responses": {
200+
"200": {
201+
"description": "Operação realizada com sucesso",
202+
"content": {
203+
"application/json": {
204+
"schema": {
205+
"$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/refs/heads/master/jsonschema/schemas/PaymentCondition_1_0000.json#/definitions/PaymentConditionInfo"
206+
}
207+
}
208+
}
209+
},
210+
"404": {
211+
"description": "Condição de Pagamento não localizada na base",
212+
"content": {
213+
"application/json": {
214+
"schema": {
215+
"$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/apis/types/totvsApiTypesBase.json#/definitions/ErrorModel"
216+
}
217+
}
218+
}
219+
}
220+
}
221+
},
222+
"put": {
223+
"tags": [
224+
"Condição de Pagamento"
225+
],
226+
"summary": "Altera uma condição de pagamento",
227+
"description": "Atualiza a condição de pagamento conforme dados enviados na requisição",
228+
"operationId": "putPaymentCondition",
229+
"x-totvs": {
230+
"productInformation": [
231+
{
232+
"product": "RM",
233+
"available": true,
234+
"note": "Este verbo esta disponivel com os parametros Authorization, Fields e InternalId",
235+
"minimalVersion": "12.1.31"
236+
}
237+
]
238+
},
239+
"parameters": [
240+
{
241+
"$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/apis/types/totvsApiTypesBase.json#/parameters/Authorization"
242+
},
243+
{
244+
"$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/apis/types/totvsApiTypesBase.json#/parameters/Fields"
245+
},
246+
{
247+
"$ref": "#/components/parameters/InternalId"
248+
}
249+
],
250+
"requestBody": {
251+
"content": {
252+
"application/json": {
253+
"schema": {
254+
"$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/refs/heads/master/jsonschema/schemas/PaymentCondition_1_0000.json#/definitions/PaymentConditionInfo"
255+
}
256+
}
257+
},
258+
"description": "Condição de pagamento a ser alterada"
259+
},
260+
"responses": {
261+
"200": {
262+
"description": "Operação realizada com sucesso",
263+
"content": {
264+
"application/json": {
265+
"schema": {
266+
"$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/refs/heads/master/jsonschema/schemas/PaymentCondition_1_0000.json#/definitions/PaymentConditionInfo"
267+
}
268+
}
269+
}
270+
},
271+
"400": {
272+
"description": "Erro no momento da alteração",
273+
"content": {
274+
"application/json": {
275+
"schema": {
276+
"$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/apis/types/totvsApiTypesBase.json#/definitions/ErrorModel"
277+
}
278+
}
279+
}
280+
},
281+
"404": {
282+
"description": "Condição de Pagamento não localizada na base",
283+
"content": {
284+
"application/json": {
285+
"schema": {
286+
"$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/apis/types/totvsApiTypesBase.json#/definitions/ErrorModel"
287+
}
288+
}
289+
}
290+
}
291+
}
292+
},
293+
"delete": {
294+
"tags": [
295+
"Condição de Pagamento"
296+
],
297+
"summary": "Exclui uma condição de pagamento",
298+
"description": "Exclui a condição de pagamento conforme dados enviados na requisição.",
299+
"operationId": "deletePaymentCondition",
300+
"x-totvs": {
301+
"productInformation": [
302+
{
303+
"product": "RM",
304+
"available": true,
305+
"note": "Este verbo esta disponivel com os parametros Authorization e InternalId",
306+
"minimalVersion": "12.1.31"
307+
}
308+
]
309+
},
310+
"parameters": [
311+
{
312+
"$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/apis/types/totvsApiTypesBase.json#/parameters/Authorization"
313+
},
314+
{
315+
"$ref": "#/components/parameters/InternalId"
316+
}
317+
],
318+
"responses": {
319+
"200": {
320+
"description": "Operação realizada com sucesso"
321+
},
322+
"400": {
323+
"description": "Erro no momento da exclusão",
324+
"content": {
325+
"application/json": {
326+
"schema": {
327+
"$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/apis/types/totvsApiTypesBase.json#/definitions/ErrorModel"
328+
}
329+
}
330+
}
331+
},
332+
"404": {
333+
"description": "Condição de pagamento não localizada na base",
334+
"content": {
335+
"application/json": {
336+
"schema": {
337+
"$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/apis/types/totvsApiTypesBase.json#/definitions/ErrorModel"
338+
}
339+
}
340+
}
341+
}
342+
}
343+
}
344+
}
345+
},
346+
"components": {
347+
"parameters": {
348+
"InternalId": {
349+
"name": "InternalId",
350+
"in": "path",
351+
"description": "Identificador único da condição de pagamento",
352+
"required": true,
353+
"schema": {
354+
"type": "string"
355+
},
356+
"x-totvs": {
357+
"productInformation": [
358+
{
359+
"product": "RM",
360+
"available": true,
361+
"note": "Informar os campos Coligada (TCPG.CODCOLIGADA) e Código da condição de pagamento (TCPG.CODCPG)",
362+
"example": "1|01",
363+
"minimalVersion": "12.1.31"
364+
}
365+
]
366+
}
367+
}
368+
},
369+
"schemas": {}
370+
}
371+
}

0 commit comments

Comments
 (0)