### Services API Endpoints Source: https://erp.tiny.com.br/public-api/v3/swagger/swagger Provides documentation for the /servicos API endpoints, including GET for listing and PUT for updating services. It details request parameters, response codes, and associated data schemas. ```APIDOC APIDOC: /servicos/{idServico}: get: tags: - Serviços operationId: ObterServicoPorIdAction parameters: - name: idServico in: path description: Identificador do serviço required: true schema: type: integer responses: "200": description: OK content: application/json: schema: $ref: "#/components/schemas/ServicosModelResponse" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/ErrorDTO" "404": description: Not Found "403": description: Forbidden "503": description: Service Unavailable "401": description: Unauthorized "500": description: Internal Server Error security: - bearerAuth: [] put: tags: - Serviços operationId: AtualizarServicoAction parameters: - name: idServico in: path description: Identificador do serviço required: true schema: type: integer requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/AtualizarServicoRequestModel" responses: "204": description: No Content "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/ErrorDTO" "404": description: Not Found "403": description: Forbidden "503": description: Service Unavailable "401": description: Unauthorized "500": description: Internal Server Error security: - bearerAuth: [] /servicos: get: tags: - Serviços operationId: ListarServicosAction parameters: - name: nome in: query description: Pesquisa pelo nome do serviço required: false schema: type: string - name: codigo in: query description: Pesquisa pelo código do serviço required: false schema: type: string - name: situacao in: query description: Pesquisa com base na situação informada\n- A - Ativo\n- I - Inativo\n- E - Excluido required: false schema: type: string ``` -------------------------------- ### Services API Endpoints Source: https://erp.tiny.com.br/public-api/v3/swagger/index Provides endpoints for retrieving, creating, updating, and transforming services. Includes methods for getting a single service by ID, listing all services, creating a new service, updating an existing service, and transforming a service into a product. ```APIDOC Serviços: ObterServicoAction: GET /servicos/{idServico} Retrieves a specific service by its ID. AtualizarServicoAction: PUT /servicos/{idServico} Updates an existing service identified by its ID. ListarServicosAction: GET /servicos Retrieves a list of all services. CriarServicoAction: POST /servicos Creates a new service. TransformarServicoEmProdutoAction: POST /servicos/{idServico}/transformar-produto Transforms a service into a product. ``` -------------------------------- ### API Schemas for ERP Tiny BR Public API v3 Source: https://erp.tiny.com.br/public-api/v3/swagger/swagger Defines the request and response schemas for various entities within the ERP Tiny BR Public API v3. This includes models for product details, purchase order items, fiscal notes, and payment installments. ```APIDOC ProdutoRequestModel: # Represents a product in a request. # Properties include details like ID, name, and unit of measure. OrdemCompraItemModelResponse: # Represents an item in a purchase order response. # Includes product details, quantity, price, and IPI. produto: $ref: "#/components/schemas/ProdutoResponseModel" gtin: type: "string" nullable: true quantidade: type: "number" format: "float" ipi: type: "number" format: "float" OrdemCompraNotaFiscalModelResponse: # Represents a fiscal note associated with a purchase order response. # Includes ID, number, issue date, value, and nature. id: type: "integer" numero: type: "string" dataEmissao: type: "string" valor: type: "string" natureza: type: "string" OrdemCompraParcelaModelRequest: # Represents a payment installment in a purchase order request. # Includes days, due date, value, accounting account, and payment method. dias: type: "integer" dataVencimento: type: "string" valor: type: "number" format: "float" contaContabil: $ref: "#/components/schemas/ContaContabilModel" meioPagamento: description: "\n- 1 - Dinheiro\n- 2 - Cheque\n- 3 - Cartao Credito\n- 4 - Cartao Debito\n- 5 - Credito Loja\n- 10 - Vale Alimentacao\n- 11 - Vale Refeicao\n- 12 - Vale Presente\n- 13 - Vale Combustivel\n- 14 - Duplicata Mercantil\n- 15 - Boleto\n- 16 - Deposito Bancario\n- 17 - Pix\n- 18 - Transferencia Bancaria Carteira Digital\n- 19 - Fidelidade Cashback Credito Virtual\n- 20 - Pix Estatico\n- 90 - Sem Pagamento\n- 99 - Outros" type: "string" enum: - 1 - 2 - 3 - 4 - 5 - 10 - 11 - 12 - 13 - 14 - 15 - 16 - 17 - 18 - 19 - 20 - 90 - 99 nullable: true x-enumDescriptions: - "Dinheiro" - "Cheque" - "Cartao Credito" - "Cartao Debito" - "Credito Loja" - "Vale Alimentacao" - "Vale Refeicao" - "Vale Presente" - "Vale Combustivel" - "Duplicata Mercantil" - "Boleto" - "Deposito Bancario" - "Pix" - "Transferencia Bancaria Carteira Digital" - "Fidelidade Cashback Credito Virtual" - "Pix Estatico" - "Sem Pagamento" - "Outros" ``` -------------------------------- ### Payment Installment Request Model Source: https://erp.tiny.com.br/public-api/v3/swagger/swagger Specifies the request model for payment installments within an order. ```APIDOC PagamentoParcelasRequestModel: parcelas: type: array items: $ref: "#/components/schemas/ParcelaModelRequest" nullable: true type: object ``` -------------------------------- ### API Documentation for Fiscal Notes Source: https://erp.tiny.com.br/public-api/v3/swagger/swagger This section provides comprehensive documentation for the fiscal notes (Notas) endpoints. It includes details on launching accounts, launching stock, and listing fiscal notes with query parameters. ```APIDOC POST /notas/{idNota}/lancar-contas operationId: LancarContasNotaFiscalAction tags: [Notas] description: Launches accounts for a given fiscal note. parameters: - name: idNota in: path description: Identificador da nota fiscal required: true schema: type: integer responses: 204: No Content 400: Bad Request (ErrorDTO schema) 404: Not Found 403: Forbidden 503: Service Unavailable 401: Unauthorized 500: Internal Server Error security: - bearerAuth: [] POST /notas/{idNota}/lancar-estoque operationId: LancarEstoqueNotaFiscalAction tags: [Notas] description: Launches stock for a given fiscal note. parameters: - name: idNota in: path description: Identificador da nota fiscal required: true schema: type: integer responses: 204: No Content 400: Bad Request (ErrorDTO schema) 404: Not Found 403: Forbidden 503: Service Unavailable 401: Unauthorized 500: Internal Server Error security: - bearerAuth: [] GET /notas operationId: ListarNotasFiscaisAction tags: [Notas] description: Lists fiscal notes with optional filtering by type. parameters: - name: tipo in: query description: Pesquisa por tipo de nota\n- E - Entrada\n- S - Saida required: false schema: enum: [E, S] x-enumDescriptions: - E - Entrada - S - Saida responses: 200: OK 400: Bad Request 401: Unauthorized 403: Forbidden 500: Internal Server Error security: - bearerAuth: [] ``` -------------------------------- ### Installment Model Source: https://erp.tiny.com.br/public-api/v3/swagger/swagger Represents a single installment for a payment, including the number of days until due and the due date. ```APIDOC ParcelaModel: dias: type: integer nullable: true data: type: string nullable: true ``` -------------------------------- ### API Documentation for Order and Product Management Source: https://erp.tiny.com.br/public-api/v3/swagger/swagger This section details the API endpoints for managing orders and products. It includes operations for launching stock for a specific order and updating the price of a product, along with their request/response structures and error handling. ```APIDOC POST /pedidos/{idPedido}/lancar-estoque Tags: Pedidos OperationId: LancarEstoquePedidoAction Parameters: - name: idPedido in: path description: Identificador do pedido required: true schema: { type: integer } Responses: 204: { description: No Content } 400: { description: Bad Request, content: { application/json: { schema: { $ref: '#/components/schemas/ErrorDTO' } } } } 404: { description: Not Found } 403: { description: Forbidden } 503: { description: Service Unavailable } 401: { description: Unauthorized } 500: { description: Internal Server Error } Security: - bearerAuth: [] PUT /produtos/{idProduto}/preco Tags: Produtos OperationId: AtualizarPrecoProdutoAction Parameters: - name: idProduto in: path description: Identificador do produto required: true schema: { type: integer } RequestBody: required: true content: application/json: schema: { $ref: '#/components/schemas/AtualizarPrecoProdutoRequestModel' } Responses: 200: { description: OK, content: { application/json: { schema: { $ref: '#/components/schemas/AtualizarPrecoProdutoResponseModel' } } } } 400: { description: Bad Request, content: { application/json: { schema: { $ref: '#/components/schemas/ErrorDTO' } } } } 404: { description: Not Found } 403: { description: Forbidden } 503: { description: Service Unavailable } 401: { description: Unauthorized } 500: { description: Internal Server Error } Security: - bearerAuth: [] ``` -------------------------------- ### Get and Update Receivables by ID Source: https://erp.tiny.com.br/public-api/v3/swagger/swagger Provides endpoints to retrieve and update a specific receivable using its ID. The GET method returns the receivable details, while the PUT method updates it with provided data. ```APIDOC GET /contas-receber/{idContaReceber} tags: - Contas a receber operationId: ObterContaReceberAction parameters: - name: idContaReceber in: path description: Identificador da conta receber required: true schema: type: integer responses: 200: description: OK content: application/json: schema: $ref: "#/components/schemas/ObterContaReceberResponseModel" 400: description: Bad Request content: application/json: schema: $ref: "#/components/schemas/ErrorDTO" 404: description: Not Found 403: description: Forbidden 503: description: Service Unavailable 401: description: Unauthorized 500: description: Internal Server Error security: - bearerAuth: [] PUT /contas-receber/{idContaReceber} tags: - Contas a receber operationId: AtualizarContaReceberAction parameters: - name: idContaReceber in: path description: Identificador da conta receber required: true schema: type: integer requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/AtualizarContaReceberRequestModel" responses: 200: description: OK 400: description: Bad Request content: application/json: schema: $ref: "#/components/schemas/ErrorDTO" 404: description: Not Found 403: description: Forbidden 503: description: Service Unavailable 401: description: Unauthorized 500: description: Internal Server Error security: - bearerAuth: [] ``` -------------------------------- ### Product Creation API Schema Source: https://erp.tiny.com.br/public-api/v3/swagger/swagger Defines the structure for creating a new product, including its core details, stock information, SEO, attachments, and variations. It references several other models for nested data. ```APIDOC CriarProdutoRequestModel: title: " " description: " " required: - tipo - descricao type: object allOf: - $ref: "#/components/schemas/ProdutoModel" - type: object properties: descricao: type: string nullable: true tipo: description: "\n- K - Kit\n- S - Simples\n- V - Com Variacoes\n- F - Fabricado\n- M - Materia Prima" type: string enum: - K - S - V - F - M nullable: true x-enumDescriptions: - "K - Kit" - "S - Simples" - "V - Com Variacoes" - "F - Fabricado" - "M - Materia Prima" estoque: $ref: "#/components/schemas/CriarProdutoEstoqueRequestModel" seo: $ref: "#/components/schemas/SeoProdutoRequestModel" anexos: type: array items: $ref: "#/components/schemas/AnexoRequestModel" grade: type: array items: type: string producao: $ref: "#/components/schemas/ProducaoProdutoRequestModel" kit: type: array items: $ref: "#/components/schemas/ProdutoKitRequestModel" variacoes: type: array items: $ref: "#/components/schemas/VariacaoProdutoRequestModel" CriarProdutoEstoqueRequestModel: title: " " description: " " type: object allOf: - $ref: "#/components/schemas/EstoqueProdutoRequestModel" - type: object properties: inicial: type: number format: float nullable: true CriarProdutoResponseModel: title: " " description: " " properties: id: type: integer codigo: type: string descricao: type: string type: object DimensoesProdutoRequestModel: title: " " ``` -------------------------------- ### Manage Note Markers API Endpoints Source: https://erp.tiny.com.br/public-api/v3/swagger/swagger Covers the GET and PUT endpoints for managing markers associated with fiscal notes. The GET endpoint retrieves markers for a given note ID, while the PUT endpoint updates them. Both require a note ID in the path and specify request/response schemas and security. ```APIDOC GET /notas/{idNota}/marcadores Tags: Notas OperationId: ObterMarcadoresNotaFiscalAction Parameters: - name: idNota in: path description: Identificador da nota fiscal required: true schema: type: integer Responses: 200: Description: OK Content: application/json: Schema: type: array items: $ref: "#/components/schemas/ObterMarcadorResponseModel" 400: Description: Bad Request Content: application/json: Schema: $ref: "#/components/schemas/ErrorDTO" 404: Description: Not Found 403: Description: Forbidden 503: Description: Service Unavailable 401: Description: Unauthorized 500: Description: Internal Server Error Security: - bearerAuth: [] PUT /notas/{idNota}/marcadores Tags: Notas OperationId: AtualizarMarcadoresNotaFiscalAction Parameters: - name: idNota in: path description: Identificador da nota fiscal required: true schema: type: integer RequestBody: required: true ``` -------------------------------- ### Product API Endpoints Source: https://erp.tiny.com.br/public-api/v3/swagger/swagger Provides documentation for the /produtos/{idProduto} and /produtos/{idProduto}/fabricado endpoints. Includes methods for retrieving and updating product information, with detailed parameter, response, and security specifications. ```APIDOC APIDOC: /produtos/{idProduto}: GET: tags: [Produtos] operationId: ObterProdutoAction parameters: - name: idProduto in: path required: true schema: type: integer responses: 200: description: OK content: application/json: schema: $ref: "#/components/schemas/ObterProdutoModelResponse" 400: description: Bad Request content: application/json: schema: $ref: "#/components/schemas/ErrorDTO" 404: description: Not Found 403: description: Forbidden 503: description: Service Unavailable 401: description: Unauthorized 500: description: Internal Server Error security: - bearerAuth: [] PUT: tags: [Produtos] operationId: AtualizarProdutoAction parameters: - name: idProduto in: path description: Identificador do produto required: true schema: type: integer requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/AtualizarProdutoRequestModel" responses: 204: description: No Content 400: description: Bad Request content: application/json: schema: $ref: "#/components/schemas/ErrorDTO" 404: description: Not Found 403: description: Forbidden 503: description: Service Unavailable 401: description: Unauthorized 500: description: Internal Server Error security: - bearerAuth: [] /produtos/{idProduto}/fabricado: GET: tags: [Produtos] operationId: ObterProdutoFabricadoAction responses: 200: description: OK content: application/json: schema: $ref: "#/components/schemas/ProducaoProdutoResponseModel" 400: description: Bad Request ``` -------------------------------- ### Get Nota Fiscal Link Source: https://erp.tiny.com.br/public-api/v3/swagger/swagger Retrieves the link for a specific Nota Fiscal by its ID. ```APIDOC GET /notas/{idNota}/link Parameters: - idNota (path, required): Identifier of the Nota Fiscal. - schema.type: integer Responses: - 200 OK: Returns the link for the Nota Fiscal. - content.application/json.schema: ObterLinkNotaFiscalModelResponse. - 400 Bad Request: Invalid request parameters. ``` -------------------------------- ### Obtain Product Schema Source: https://erp.tiny.com.br/public-api/v3/swagger/swagger Combines base product details with additional information like complementary description, product type, and situation. This schema provides a comprehensive view of a product. ```APIDOC ObterProdutoModelResponse: title: " " description: " " type: object allOf: - $ref: "#/components/schemas/ProdutoResponseModel" - properties: descricaoComplementar: string (nullable) tipo: description: "\n- K - Kit\n- S - Simples\n- V - Com Variacoes\n- F - Fabricado\n- M - Materia Prima" type: string enum: ["K", "S", "V", "F", "M"] nullable: true x-enumDescriptions: - "K - Kit" - "S - Simples" - "V - Com Variacoes" - "F - Fabricado" - "M - Materia Prima" situacao: description: "\n- A - Ativo\n- I - Inativo\n- E - Excluido" type: string enum: ["A", "I", "E"] nullable: true x-enumDescriptions: - "A - Ativo" - "I - Inativo" - "E - Excluido" ``` -------------------------------- ### Product Listing and Cost Models Source: https://erp.tiny.com.br/public-api/v3/swagger/swagger Defines the data structures for product listing responses and product cost details. ```APIDOC ListagemProdutoCustosResponseModel: Properties: data: string (nullable=true) saldoAtual: number (float, nullable=true) saldoAnterior: number (float, nullable=true) precoCusto: number (float, nullable=true) custoMedio: number (float, nullable=true) precoVenda: number (float, nullable=true) impostosRecuperaveis: number (float, nullable=true) ListagemProdutosResponseModel: Properties: id: integer sku: string descricao: string tipo: string ``` -------------------------------- ### Get Separation by ID Source: https://erp.tiny.com.br/public-api/v3/swagger/swagger Retrieves a specific separation by its ID. Returns detailed information about the separation. ```APIDOC GET /websites/erp_tiny_br_public-api_v3/separacao/{idSeparacao} Tags: - Separação OperationId: ObterSeparacaoAction Parameters: - name: idSeparacao in: path required: true schema: type: integer Responses: 200: description: OK content: application/json: schema: $ref: "#/components/schemas/ObterSeparacaoResponseModel" 400: description: Bad Request content: application/json: schema: $ref: "#/components/schemas/ErrorDTO" 404: description: Not Found 403: description: Forbidden 503: description: Service Unavailable 401: description: Unauthorized 500: description: Internal Server Error Security: - bearerAuth: [] ``` -------------------------------- ### Product Management API Endpoints Source: https://erp.tiny.com.br/public-api/v3/swagger/swagger This section details the API endpoints for managing products, including listing products with pagination and creating new products with variations. It outlines request methods, parameters, request bodies, and possible responses for each operation. ```APIDOC APIDOC: /produtos: get: tags: - Produtos summary: Listagem de produtos parameters: - name: offset in: query description: Offset da paginação required: false schema: type: integer default: 0 responses: '200': description: OK content: application/json: schema: type: object properties: itens: type: array items: $ref: "#/components/schemas/ListagemProdutosResponseModel" paginacao: $ref: "#/components/schemas/PaginatedResultModel" '400': description: Bad Request content: application/json: schema: $ref: "#/components/schemas/ErrorDTO" '404': description: Not Found '403': description: Forbidden '503': description: Service Unavailable '401': description: Unauthorized '500': description: Internal Server Error security: - bearerAuth: [] post: tags: - Produtos operationId: CriarProdutoAction requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/CriarProdutoRequestModel" responses: '200': description: OK content: application/json: schema: $ref: "#/components/schemas/CriarProdutoComVariacoesResponseModel" '400': description: Bad Request content: application/json: schema: $ref: "#/components/schemas/ErrorDTO" '404': description: Not Found '403': description: Forbidden '503': description: Service Unavailable '401': description: Unauthorized '500': description: Internal Server Error security: - bearerAuth: [] /produtos/{idProduto}/variacoes: post: tags: - Produtos operationId: CriarProdutoVariacaoAction parameters: - name: idProduto in: path required: true schema: type: string ``` -------------------------------- ### Get Service by ID Source: https://erp.tiny.com.br/public-api/v3/swagger/swagger Retrieves a specific service by its ID. Returns detailed information about the service. ```APIDOC GET /websites/erp_tiny_br_public-api_v3/servicos/{idServico} Tags: - Serviços OperationId: ObterServicoAction Parameters: - name: idServico in: path required: true schema: type: integer Responses: 200: description: OK content: application/json: schema: $ref: "#/components/schemas/ObterServicoResponseModel" 400: description: Bad Request content: application/json: schema: $ref: "#/components/schemas/ErrorDTO" 404: description: Not Found 403: description: Forbidden 503: description: Service Unavailable 401: description: Unauthorized 500: description: Internal Server Error Security: - bearerAuth: [] ``` -------------------------------- ### Product Schema Details Source: https://erp.tiny.com.br/public-api/v3/swagger/swagger Defines the structure for product information, including type, situation, creation/modification dates, unit, GTIN, and pricing. The 'tipo' field categorizes products as Kit, Simple, With Variations, Manufactured, or Raw Material. The 'situacao' field indicates the product's status: Active, Inactive, or Deleted. ```APIDOC ProdutoResponseModel: type: object properties: id: integer codigo: string nome: string tipo: description: "\n- K - Kit\n- S - Simples\n- V - Com Variacoes\n- F - Fabricado\n- M - Materia Prima" type: string enum: ["K", "S", "V", "F", "M"] x-enumDescriptions: - "K - Kit" - "S - Simples" - "V - Com Variacoes" - "F - Fabricado" - "M - Materia Prima" situacao: description: "\n- A - Ativo\n- I - Inativo\n- E - Excluido" type: string enum: ["A", "I", "E"] x-enumDescriptions: - "A - Ativo" - "I - Inativo" - "E - Excluido" dataCriacao: string (nullable) dataAlteracao: string (nullable) unidade: string gtin: string precos: #/components/schemas/PrecoProdutoResponseModel ``` -------------------------------- ### Get Account Payable by ID Source: https://erp.tiny.com.br/public-api/v3/swagger/swagger Retrieves a specific account payable by its ID. Requires authentication. ```APIDOC GET /contas-pagar/{idContaPagar} OperationId: ObterContaPagarAction Tags: Contas a pagar Parameters: - name: idContaPagar in: path required: true schema: type: integer Responses: 200: description: OK content: application/json: schema: $ref: "#/components/schemas/ObterContaPagarModelResponse" 400: description: Bad Request content: application/json: schema: $ref: "#/components/schemas/ErrorDTO" 404: description: Not Found 403: description: Forbidden 503: description: Service Unavailable 401: description: Unauthorized 500: description: Internal Server Error Security: - bearerAuth: [] ``` -------------------------------- ### Get Shipping Method by ID Source: https://erp.tiny.com.br/public-api/v3/swagger/swagger Retrieves the details of a specific shipping method using its unique identifier. ```APIDOC GET /formas-envio/{idFormaEnvio} Tags: - Logistica OperationId: ObterFormaEnvioAction Parameters: - name: "idFormaEnvio" in: path required: true schema: type: integer Responses: 200: description: OK content: application/json: schema: $ref: "#/components/schemas/ObterFormaEnvioResponseModel" 400: description: Bad Request content: application/json: schema: $ref: "#/components/schemas/ErrorDTO" ``` -------------------------------- ### Product Request and Response Models Source: https://erp.tiny.com.br/public-api/v3/swagger/swagger Defines the schemas for product data, including basic information, supplier details, and tax configurations. Covers both request and response formats for product entities. ```APIDOC ProdutoRequestModel: title: "" description: "" properties: id: type: integer nullable: true type: object ProdutoResponseModel: title: "" description: "" properties: id: type: integer nullable: true sku: type: string nullable: true descricao: type: string nullable: true type: object FornecedorProdutoRequestModel: title: "" description: "" properties: fornecedor: type: object properties: id: type: integer nullable: true produto: type: object properties: id: type: integer nullable: true fornecedores: type: array items: $ref: "#/components/schemas/FornecedorProdutoRequestModel" type: object ``` -------------------------------- ### Product SEO and Tagging Models Source: https://erp.tiny.com.br/public-api/v3/swagger/swagger Specifies the data structures for managing Search Engine Optimization (SEO) elements and product tags. Includes fields for titles, descriptions, keywords, video links, slugs, and tag identifiers. ```APIDOC SeoProdutoModelResponse: title: "" description: "" properties: titulo: type: string nullable: true descricao: type: string nullable: true keywords: type: array items: type: string nullable: true linkVideo: type: string nullable: true slug: type: string nullable: true type: object SeoProdutoRequestModel: title: "" description: "" properties: titulo: type: string nullable: true descricao: type: string nullable: true keywords: type: array items: type: string linkVideo: type: string nullable: true slug: type: string nullable: true type: object TagProdutoModelResponse: title: "" description: "" properties: id: type: integer nullable: true nome: type: string nullable: true type: object ``` -------------------------------- ### Order Payment Models Source: https://erp.tiny.com.br/public-api/v3/swagger/swagger Defines the request and response models for order payment details, including payment methods and installments. ```APIDOC ParcelaModelRequest: description: Request model for order installments. type: object allOf: - $ref: "#/components/schemas/ParcelaModel" - properties: formaPagamento: $ref: "#/components/schemas/FormaPagamentoRequestModel" meioPagamento: $ref: "#/components/schemas/MeioPagamentoRequestModel" type: object ParcelaModelResponse: description: Response model for order installments. type: object allOf: - $ref: "#/components/schemas/ParcelaModel" - properties: formaPagamento: $ref: "#/components/schemas/FormaPagamentoResponseModel" meioPagamento: $ref: "#/components/schemas/MeioPagamentoResponseModel" type: object AtualizarPedidoModelRequest: description: Request model for updating an order, including payment details. type: object allOf: - $ref: "#/components/schemas/BasePedidoModel" - properties: pagamento: $ref: "#/components/schemas/PagamentoParcelasRequestModel" type: object ``` -------------------------------- ### Payment Request Model Source: https://erp.tiny.com.br/public-api/v3/swagger/swagger Defines the request model for payment details, including payment method, payment means, and installments. ```APIDOC PagamentoRequestModel: formaPagamento: $ref: "#/components/schemas/FormaPagamentoRequestModel" meioPagamento: $ref: "#/components/schemas/MeioPagamentoRequestModel" parcelas: type: array items: $ref: "#/components/schemas/ParcelaModelRequest" nullable: true type: object ``` -------------------------------- ### API Documentation for Product and Variation Endpoints Source: https://erp.tiny.com.br/public-api/v3/swagger/swagger This section details the API endpoints for managing products and their variations within the ERP Tiny BR system. It includes details on request parameters, response codes, and security requirements. ```APIDOC APIDOC: Paths: /produtos/{idVariacao}: get: tags: - Variações operationId: ObterVariaçãoPorIdAction parameters: - name: idProduto in: path description: Identificador do produto required: true schema: type: integer - name: idVariacao in: path description: Identificador da variação required: true schema: type: integer responses: '204': description: No Content '400': description: Bad Request content: application/json: schema: $ref: "#/components/schemas/ErrorDTO" '404': description: Not Found '403': description: Forbidden '503': description: Service Unavailable '401': description: Unauthorized '500': description: Internal Server Error security: - bearerAuth: [] /produtos: get: tags: - Produtos operationId: ListarProdutosAction parameters: - name: nome in: query description: Pesquisa por nome parcial ou completo do produto required: false schema: type: string - name: codigo in: query description: Pesquisa pelo código do produto required: false schema: type: string - name: gtin in: query description: Pesquisa através do código GTIN do produto required: false schema: type: integer - name: situacao in: query description: Pesquisa com base na situação informada required: false schema: type: string - name: dataCriacao in: query description: Pesquisa através da data de criação do produto required: false schema: type: string example: "2023-01-01 10:00:00" - name: dataAlteracao in: query description: Pesquisa através da data de última alteração do produto required: false schema: type: string example: "2023-01-01 10:00:00" - name: limit in: query description: Limite da paginação required: false schema: type: integer default: 100 ``` -------------------------------- ### Get Account Payable Markers by ID Source: https://erp.tiny.com.br/public-api/v3/swagger/swagger Retrieves the markers associated with a specific account payable by its ID. Requires authentication. ```APIDOC GET /contas-pagar/{idContaPagar}/marcadores OperationId: ObterMarcadoresContaPagarAction Tags: Contas a pagar Parameters: - name: id in: path description: Identificador da Conta a Pagar required: true schema: type: integer Responses: 200: description: OK content: application/json: schema: type: array items: $ref: "#/components/schemas/ObterMarcadorResponseModel" 400: description: Bad Request content: application/json: schema: $ref: "#/components/schemas/ErrorDTO" 404: description: Not Found 403: description: Forbidden 503: description: Service Unavailable 401: description: Unauthorized 500: description: Internal Server Error Security: - bearerAuth: [] ``` -------------------------------- ### Purchase Order API Endpoints Source: https://erp.tiny.com.br/public-api/v3/swagger/swagger This section details the available API endpoints for managing purchase orders within the ERP Tiny BR system. It includes methods for creating, launching accounts, and launching stock for purchase orders, along with their request and response structures. ```APIDOC POST /ordem-compra Tags: Ordem de Compra OperationId: CriarOrdemCompraAction Request Body: content: application/json: schema: $ref: "#/components/schemas/CriarOrdemCompraModelRequest" Responses: 200: OK content: application/json: schema: $ref: "#/components/schemas/CriarOrdemCompraModelResponse" 400: Bad Request content: application/json: schema: $ref: "#/components/schemas/ErrorDTO" 404: Not Found 403: Forbidden 503: Service Unavailable 401: Unauthorized 500: Internal Server Error Security: - bearerAuth: [] POST /ordem-compra/{idOrdemCompra}/lancar-contas Tags: Ordem de Compra OperationId: LancarContasOrdemCompraAction Parameters: - name: idOrdemCompra in: path description: Identificador da ordem de compra required: true schema: type: integer Responses: 204: No Content 400: Bad Request content: application/json: schema: $ref: "#/components/schemas/ErrorDTO" 404: Not Found 403: Forbidden 503: Service Unavailable 401: Unauthorized 500: Internal Server Error Security: - bearerAuth: [] POST /ordem-compra/{idOrdemCompra}/lancar-estoque Tags: Ordem de Compra OperationId: LancarEstoqueOrdemCompraAction Parameters: - name: idOrdemCompra in: path description: Identificador da ordem de compra required: true schema: type: integer Request Body: required: true content: application/json: schema: $ref: "#/components/schemas/LancarEstoqueOrdemCompraRequestModel" Responses: 204: No Content 400: Bad Request content: application/json: schema: $ref: "#/components/schemas/ErrorDTO" ``` -------------------------------- ### Get Account Payable Receipts by ID Source: https://erp.tiny.com.br/public-api/v3/swagger/swagger Retrieves the receipts associated with a specific account payable by its ID. Requires authentication. ```APIDOC GET /contas-pagar/{idContaPagar}/recebimentos OperationId: ObterRecebimentosContaPagarAction Tags: Contas a pagar Parameters: - name: id in: path description: Identificador da Conta a Pagar required: true schema: type: integer ``` -------------------------------- ### Product Creation API Endpoint Source: https://erp.tiny.com.br/public-api/v3/swagger/swagger Defines the API endpoint for creating a product. It specifies the request body schema, including product identification and variation details, and outlines the possible responses, including success (200 OK) and various error conditions (400, 401, 403, 404, 500, 503). Authentication is handled via bearer token. ```APIDOC POST /produtos tags: - Produtos operationId: CriarProdutoAction parameters: - name: idProduto in: path required: true schema: type: integer requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/VariacaoProdutoRequestModel" responses: "200": description: OK content: application/json: schema: $ref: "#/components/schemas/CriarProdutoResponseModel" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/ErrorDTO" "404": description: Not Found "403": description: Forbidden "503": description: Service Unavailable "401": description: Unauthorized "500": description: Internal Server Error security: - bearerAuth: [] ``` === COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.