API utilizada para realizar cadastro de pedidos e suas cobranças, e transmitir NF-e através do sistema Comex NF-e
\nPara se autenticar, passa adicionar o header X-Api-Key com seu token, que pode ser encontrado nas configurações do sistema (https://app.maino.com.br/configuracoes), na aba integrações.
![\"\"](\"https://i.imgur.com/DkHkwno.png\")
","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Introdução","slug":"introducao"},{"content":"Overview","slug":"overview"},{"content":"Autenticação","slug":"autenticacao"}],"owner":"3466640","collectionId":"34b757cb-22f8-4a76-b6f5-8bc71c5c975f","publishedId":"RWaDXWpn","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2020-03-06T17:41:21.000Z"},"item":[{"name":"Criação de pedidos","id":"4cb017f9-d86e-315a-d5da-1e95547498c4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-Api-Key","value":"Para cadastrar um pedido, é necessário realizar um POST de um JSON contendo a seguinte estrutura:
async igual a \"1\" o parâmetro url passa a ser obrigatório.numero: Número do pedido. Obrigatóriostatus: Status personalizado do pedido. Opcionalmodalidade_frete: Modalidade do frete do pedido. Eniar o código seguindo a tabela de modalidade de frete. Opcionalvalor_frete: Valor do frete do pedido. Opcionalvalor_outras_despesas: Valor das outras despesas do pedido. Opcionalvalor_seguro: Valor do seguro do pedido. Opcionalinformacoes_complementares: Informações complementares do pedido. Opcionalinformacoes_ao_fisco: Informações ao fisco do pedido. Opcionalquantidade_volumes: Quantidade de volumes do pedido. Opcionalespecie_volumes: Espécie de volumes do pedido. Opcionalnumeracao_volumes: Numeração dos volumes do pedido. Opcionalmarca_volumes: Marca dos volumes do pedido. Opcionalcfop: CFOP da nota fiscal gerada no pedido. Envie apenas se desejar sobrescrever os CFOPs automáticos para operações de venda. Opcionalnatureza_da_operacao: Natureza da operação da nota fiscal gerada no pedido. Opcionalcliente Obrigatóriosomente_busca: true ou false, nesse parâmetro define se somente busca o cliente ou se cria/altera. Opcionalcpf: CPF do cliente caso seja pessoa física. Obrigatóriocnpj: CNPJ do cliente caso seja pessoa jurídica. Obrigatórioindicador_ie: Indicador de IE do destinatário, conforme tabela abaixo. Caso não seja informada, o padrão é não-contribuintenome: Nome do cliente. Obrigatórioendereco: Endereço do cliente. Obrigatórionumero: Número do endereço do cliente. Obrigatóriocomplemento: Complemento do endereço do cliente. Obrigatóriobairro: Bairro do endereço do cliente. Obrigatóriomunicipio: Município do endereço do cliente. Obrigatórioemail: E-mail do cliente. Obrigatórioddd: DDD do telefone do cliente. Opcionaltelefone: Telefone do cliente. Opcionaltransportadora Opcionalsomente_busca: true ou false, nesse parâmetro define se somente busca a transportadora ou se cria/altera. Opcionalcpf: CPF da transportadora caso seja pessoa física. Obrigatóriocnpj: CNPJ da transportadora caso seja pessoa jurídica. Obrigatórionome: Nome da transportadora. Obrigatórioendereco: Endereço da transportadora. Obrigatórionumero: Número do endereço da transportadora. Obrigatóriocomplemento: Complemento do endereço da transportadora. Obrigatóriobairro: Bairro do endereço da transportadora. Obrigatóriomunicipio: Município do endereço da transportadora. Obrigatórioemail: E-mail da transportadora. Obrigatórioddd: DDD do telefone da transportadora. Opcionaltelefone: Telefone da transportadora. Opcionalendereco_de_entrega Opcionaloutro_cliente: true ou false, nesse parâmetro define se a entrega é será para uma empresa/pessoa diferente do cliente. Obrigatóriocpf: CPF da pessoa do endereço de entrega caso seja pessoa física. Opcionalcnpj: CNPJ da empresa do endereço de entrega caso seja pessoa jurídica. Opcionalnome: Nome da empresa/pessoa do endereço de entrega. Opcionalendereco: Endereço de entrega. Obrigatórionumero: Número do endereço de entrega. Obrigatóriocomplemento: Complemento do endereço de entrega. Obrigatóriobairro: Bairro do endereço de entrega. Obrigatóriomunicipio: Município do endereço de entrega. Obrigatóriooutro_cliente como true os parâmetros cpf, cnpj e nome passam a ser obrigatórios.representante_email: E-mail do representante já cadastrado no sistema. Opcionalitens (array) Obrigatóriocodigo: Código do produto. Obrigatóriodescricao: Descrição do produto. Obrigatóriopu: Preço unitário do produto. Obrigatórioquantidade: Quantidade do produto. Obrigatórioignora_controle_de_estoque: solicita a criação do produto e manutenção da quantidade em estoque. Opcionalunidade_de_medida: Unidade de medida do produto. Opcionalncm: NCM do produto. Opcionalp_ipi: Valor IPI do produto. Opcionalpu_entrada: Preço de entrada do produto. Opcionalorigem: Origem do produto. Opcionalcodigo_de_barras: Código de barras do produto. Opcionalinformacoes_complementares: Informações complementares do produto. Opcionalmva: Percentual de Margem de Valor Agregado para o produto, se existir. Opcionaltipo_mva: Tipo de MVA enviado. Pode ser original ou ajustada. Por padrão, é original. Opcionalignora_controle_de_estoque os parâmetros unidade_de_medida, ncm, p_ipi, pu_entrada e origem passam a ser obrigatórios.tags: Recebe um array de strings, como por exemplo: [\"Tag 1\", \"Tag 2\", \"Tag 3\"]. Opcionalcobranca Opcionalforma_pagamento: Forma de pagamento do pedido. Eniar o código seguindo a tabela de forma de pagamento. Obrigatórionumero_fatura: Número da fatura do pedido. Opcionaltipo_de_receita: Tipo de receita do pedido. Opcionalplano_de_conta: Código do plano de contas. Opcionalsufixo: Sufixo para acrescentar no título das parcelas. Opcionalparcelas (array) Obrigatóriovalor: Valor da parcela. Obrigatóriodata_vencimento: Data de vencimento da parcela. ObrigatórioA alteração do pedido recebe o mesmo payload da criação, com os mesmos campos obrigatórios. O objeto enviado como pedido substituirá o existente anteriormente. Os atributos async, transmite não são suportados neste endpoint.
Para criar a nota fiscal de um pedido, é necessário realizar um POST sem nenhum argumento (outro que o ID do pedido na URL)
O retorno será no formato seguinte, com status HTTP 201:
{\n \"nota_fiscal\": {\n \"id\": ID_DA_NOTA_FISCAL,\n \"chave_acesso\": CHAVE_DE_ACESSO_DA_NFE,\n \"status\": STATUS_DA_NOTA_FISCAL,\n \"danfe_url\": URL_DA_DANFE\n }\n}\nOs status possíveis da NF-e são:
\nCaso não seja possível criar uma nota fiscal, o retorno será uma lista de erros, com status HTTP 422:
{\n \"errors\": {\n \"base\": [\n \"O pedido já possui uma nota fiscal vinculada.\"\n ]\n }\n}\nPara transmitir a nota fiscal de um pedido, é necessário realizar um POST na rota documentada.
A transmissão é assíncrona e, por isso, é possível registrar um webhook para quando a NF-e for aceita.
\nEsta URL para webhook é enviada como um parâmetro na chamada POST.
\nSe não houver nenhum problema, o retorno terá apenas o cabeçalho com status HTTP 201
Caso não seja possível transmitir a nota fiscal, o retorno será uma lista de erros, com status HTTP 422:
{\n \"errors\": {\n [\n \"Uma transmissão para esta nota fiscal já está em execução\"\n ]\n }\n}\nPara visualizar a nota fiscal de um pedido, é necessário realizar um POST sem nenhum argumento (outro que o ID do pedido na URL)
O retorno será no formato seguinte, com status HTTP 200:
{\n \"nota_fiscal\": {\n \"id\": ID_DA_NOTA_FISCAL,\n \"chave_acesso\": CHAVE_DE_ACESSO_DA_NFE,\n \"status\": STATUS_DA_NOTA_FISCAL,\n \"danfe_url\": URL_DA_DANFE\n }\n}\nOs status possíveis da NF-e são:
\nPara excluir a nota fiscal de um pedido, é necessário realizar um DELETE sem nenhum argumento (outro que o ID do pedido na URL)
O retorno não terá corpo, com HTTP 204.
Caso não seja possível excluir a nota fiscal, o retorno será uma lista de erros, com status HTTP 422:
{\n \"errors\": {\n \"nota_fiscal\": [\n \"não pode ser excluída\"\n ]\n }\n}\nDe forma geral, o único motivo para uma NF-e não poder ser excluída é se ela já foi transmitida e está protocolada.
\n","urlObject":{"protocol":"https","path":["api","v2","pedidos",":id","nota_fiscal"],"host":["api","maino","com","br"],"query":[],"variable":[{"type":"string","value":"","key":"id"}]}},"response":[],"_postman_id":"da6033ca-386b-461b-a3b0-ace2a429b82a"}]}